Skip to content

Commit 064454b

Browse files
committed
v0.3.1
1 parent 17b3804 commit 064454b

File tree

2 files changed

+10
-14
lines changed

2 files changed

+10
-14
lines changed

README.md

+9-13
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![TravisCI Build Status](https://travis-ci.org/danielpclark/faster_path.svg?branch=master)](https://travis-ci.org/danielpclark/faster_path)
44
[![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/10ul0gk3cwhlt2lj/branch/master?svg=true)](https://ci.appveyor.com/project/danielpclark/faster-path/branch/master)
55
[![Latest Tag](https://img.shields.io/github/tag/danielpclark/faster_path.svg)](https://github.com/danielpclark/faster_path/tags)
6-
[![Commits Since Last Release](https://img.shields.io/github/commits-since/danielpclark/faster_path/v0.2.6.svg)](https://github.com/danielpclark/faster_path/pulse)
6+
[![Commits Since Last Release](https://img.shields.io/github/commits-since/danielpclark/faster_path/v0.3.1.svg)](https://github.com/danielpclark/faster_path/pulse)
77
[![Binary Release](https://img.shields.io/github/release/danielpclark/faster_path.svg)](https://github.com/danielpclark/faster_path/releases)
88
[![Coverage Status](https://coveralls.io/repos/github/danielpclark/faster_path/badge.svg)](https://coveralls.io/github/danielpclark/faster_path)
99
[![Inline docs](http://inch-ci.org/github/danielpclark/faster_path.svg?branch=master)](http://inch-ci.org/github/danielpclark/faster_path)
@@ -55,7 +55,7 @@ Running `stackprof tmp/2016-06-09T00:42:10-04:00-stackprof-cpu-myapp.dump`. Exec
5555
108 (1.5%) 14 (0.2%) ActionView::Helpers::AssetUrlHelper#asset_path
5656
```
5757

58-
Here are some addtional stats. From Rails loading to my home page, these methods are called _(not directly, Rails & gems call them)_ this many times. And the home page has minimal content.
58+
Here are some additional stats. From Rails loading to my home page, these methods are called _(not directly, Rails & gems call them)_ this many times. And the home page has minimal content.
5959
```ruby
6060
Pathname#to_s called 29172 times.
6161
Pathname#<=> called 24963 times.
@@ -97,8 +97,10 @@ I've said this about Sprockets but this required two other gems to be updated as
9797
## Status
9898

9999
* Rust compilation is working
100-
* Methods are _most likely_ stable
101-
* Testers and developers are most welcome!
100+
* Methods are stable
101+
* Thoroughly tested
102+
* Testers and developers are most welcome
103+
* Windows & encoding support is underway!
102104

103105
## Installation
104106

@@ -113,7 +115,7 @@ curl -sSf https://static.rust-lang.org/rustup.sh | sh
113115
Add this line to your application's Gemfile:
114116

115117
```ruby
116-
gem 'faster_path', '~> 0.2.3'
118+
gem 'faster_path', '~> 0.3.1'
117119
```
118120

119121
And then execute:
@@ -184,7 +186,7 @@ These will **not** be included by default in monkey-patches. Be cautious when u
184186
| `FasterPath.basename` | `File.basename` |
185187

186188
It's been my observation (and some others) that the Rust implementation of the C code for `File` has similar results but
187-
performance seems to vary based on CPU cache on possibly 64bit/32bit system environmnets. When these methods were initially written, and somewhat simplistic, they were faster than the C implementations on `File`. After the implementations have been perfected to match the behavior in Ruby they don't perform as well and are therefore not included by default when the monkey patch method `FasterPath.sledgehammer_everything!` is executed. If you don't want to pass the `WITH_REGRESSION` environment variable you can put any turthy parameter on the monkey patch method to include it.
189+
performance seems to vary based on CPU cache on possibly 64bit/32bit system environments. When these methods were initially written, and somewhat simplistic, they were faster than the C implementations on `File`. After the implementations have been perfected to match the behavior in Ruby they don't perform as well and are therefore not included by default when the monkey patch method `FasterPath.sledgehammer_everything!` is executed.
188190

189191
## Getting Started with Development
190192

@@ -205,13 +207,7 @@ Learn and share performance tips on the [wiki](https://github.com/danielpclark/f
205207

206208
### Building and running tests
207209

208-
First, bundle the gem's development dependencies by running `bundle`.
209-
210-
Then, build the rust code:
211-
212-
```sh
213-
rake build_src
214-
```
210+
First, bundle the gem's development dependencies by running `bundle`. Rust compilation is included in the current rake commands.
215211

216212
FasterPath is tested with [The Ruby Spec Suite](https://github.com/ruby/spec) to ensure it is compatible with the
217213
native implementation, and also has its own test suite testing its monkey-patching and refinements functionality.

lib/faster_path/version.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
module FasterPath
2-
VERSION = "0.3.0"
2+
VERSION = "0.3.1"
33
end

0 commit comments

Comments
 (0)