faster_path 0.3.9 → 0.3.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a5d299440e18a99c763e17b085b7962bfca0f2555b0adf8eb053c77b2d8d282
-  data.tar.gz: fee3ac374b164a25d1af43e0e8cd36ea68f57421db38637b7275a504e38bb391
+  metadata.gz: 32af4c3fa17e05003792d14b3e8a34ce26fd206395f345fc58a13c8cc63b37b7
+  data.tar.gz: 7ec503bf0957f176fa5daa1d4910a67af9c3b06bb391e573586fcaadc1157a88
 SHA512:
-  metadata.gz: 79d7b3931800982e78cc7f00c2fd2281932a2ac3775784f5f9d5c59bf974cd41f30d2d03c6216ce210fdc1754659b714cda6c19cca84e39a464e2bb62f7afa9c
-  data.tar.gz: 1a5b56dff703996bdcf60838ad9881528e51867aa2e9c5d996ff9c28996fb1297e7dacc9380a42def9ff9358e87ac4576a2f7536d5c73b685332b73b9e687122
+  metadata.gz: ff3f4a219cb46f561eec9a2138d1282773ad2ceddcd0664202c2396202efbb1ecb2b8839347dd65bcf595faf93b6d6d6b85d6a912c18380b8ff10ccd878379ab
+  data.tar.gz: 27e3886927a1479b5d28e1b2a5d96cb5bb86c240b87664010b1be9d181afebf456476a43c1e7843f890b2af581ccd398dca91c3dd6f1021380e156402f2d90ab

data/Cargo.lock

@@ -1,13 +1,7 @@
-[[package]]
-name = "array_tool"
-version = "1.0.3"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-
 [[package]]
 name = "faster_path"
 version = "0.0.1"
 dependencies = [
- "array_tool 1.0.3 (registry+https://github.com/rust-lang/crates.io-index)",
  "lazy_static 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)",
  "memchr 2.0.1 (registry+https://github.com/rust-lang/crates.io-index)",
  "ruby-sys 0.3.0 (git+https://github.com/danielpclark/ruby-sys?branch=playground)",
@@ -55,7 +49,6 @@ dependencies = [
 ]
 
 [metadata]
-"checksum array_tool 1.0.3 (registry+https://github.com/rust-lang/crates.io-index)" = "8f8cb5d814eb646a863c4f24978cff2880c4be96ad8cde2c0f0678732902e271"
 "checksum lazy_static 0.2.11 (registry+https://github.com/rust-lang/crates.io-index)" = "76f033c7ad61445c5b347c7382dd1237847eb1bce590fe50365dcb33d546be73"
 "checksum lazy_static 1.0.0 (registry+https://github.com/rust-lang/crates.io-index)" = "c8f31047daa365f19be14b47c29df4f7c3b581832407daabe6ae77397619237d"
 "checksum libc 0.2.39 (registry+https://github.com/rust-lang/crates.io-index)" = "f54263ad99207254cf58b5f701ecb432c717445ea2ee8af387334bdd1a03fdff"

data/Cargo.toml

@@ -18,6 +18,5 @@ crate-type = ["dylib"]
 [dependencies]
 ruby-sys = { git = "https://github.com/danielpclark/ruby-sys", branch = "playground" }
 ruru = { git = "https://github.com/danielpclark/ruru", branch = "playground" }
-array_tool = "1.0"
 lazy_static = "1.0"
 memchr = "2.0.1"

data/Gemfile

@@ -1,6 +1,7 @@
 source 'https://rubygems.org' do
   # Specify your gem's dependencies in faster_path.gemspec
   gemspec
+
   group :test do
     gem 'coveralls', require: false
   end

data/README.md

@@ -3,12 +3,11 @@
 [![TravisCI Build Status](https://travis-ci.org/danielpclark/faster_path.svg?branch=master)](https://travis-ci.org/danielpclark/faster_path)
 [![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)
 [![Latest Tag](https://img.shields.io/github/tag/danielpclark/faster_path.svg)](https://github.com/danielpclark/faster_path/tags)
-[![Commits Since Last Release](https://img.shields.io/github/commits-since/danielpclark/faster_path/v0.3.8.svg)](https://github.com/danielpclark/faster_path/pulse)
+[![Commits Since Last Release](https://img.shields.io/github/commits-since/danielpclark/faster_path/v0.3.10.svg)](https://github.com/danielpclark/faster_path/pulse)
 [![Binary Release](https://img.shields.io/github/release/danielpclark/faster_path.svg)](https://github.com/danielpclark/faster_path/releases)
 [![Coverage Status](https://coveralls.io/repos/github/danielpclark/faster_path/badge.svg?branch=master)](https://coveralls.io/github/danielpclark/faster_path?branch=master)
 [![Inline docs](http://inch-ci.org/github/danielpclark/faster_path.svg?branch=master)](http://inch-ci.org/github/danielpclark/faster_path)
 [![Code Triagers Badge](https://www.codetriage.com/danielpclark/faster_path/badges/users.svg)](https://www.codetriage.com/danielpclark/faster_path)
-[![Tweet This](https://raw.githubusercontent.com/danielpclark/faster_path/master/assets/tweet.png)](https://twitter.com/share?url=https%3A%2F%2Fgithub.com%2Fdanielpclark%2Ffaster_path&via=6ftdan&hashtags=Ruby&text=You%20could%20save%2015%25%20or%20more%20on%20website%20page%20load%20time%20by%20switching%20to%20the%20FasterPath%20gem.)
 
 #### This gem shaves off more than 30% of my Rails application page load time.
 
@@ -94,6 +93,18 @@ I've said this about Sprockets but this required two other gems to be updated as
 |sass 3.2.19|sass 5.0.4|
 |bootstrap-sass 3.3.4.1|bootstrap-sass 3.3.6|
 
+## Performance Specifics
+
+The headline for the amount for improvement on this library is specific to only the improvement made with the method `chop_basename`.  Just so you know; in my initial release I had a bug in which that method immediately returned nothing. Now the good thing about this is that it gave me some very valuable information.  First I found that all my Rails site tests still passed.  Second I found that all my assets no longer loaded in the website. And third, and most importantly, I found my Rails web pages loaded just more than 66% faster without the cost of time that `chop_basename` took.
+
+**That's right; the path handling for assets in your website \*consumes more than 2/3rds of your websites page load time.**
+
+So now we have some real numbers to work with  We can be generoues and use 66% as our margin of area to improve over _(for `chop_basename` specifically, not counting the benefit from improving the performance in other file path related methods)_.  That means we want to remove as much of that percentage from the overall systems page load time.  The original headline boasts over 33% performance improvement — that was when `chop_basename` was improved by just over 50%.  Now `chop_basename` is improved by 83.4%.  That alone should make your site run 55.044% faster now _(given your performance profile stats are similar to mine)_.
+
+## What Rails Versions Will This Apply To?
+
+As mentioned earlier Sprockets, which handles assets, changed away from using `Pathname` at all when moving from major version 2 to 3.  So if you're using Sprockets 3 or later you won't reap the biggest performance reqards from using this gem for now _(it's my goal to have this project become a core feature that Rails depends on and yes… that's a big ask)_.  That is unless you write you're own implementation to re-integrate the use of `Pathname` and `FasterPath` into your asset handling library.  For now just know that the Sprockets 2 series primarily works with Rails 4.1 and earlier.  It may work in later Rails versions but I have not investigated this.
+
 ## Status
 
 * Rust compilation is working
@@ -115,7 +126,7 @@ curl -sSf https://static.rust-lang.org/rustup.sh | sh
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'faster_path', '~> 0.3.8'
+gem 'faster_path', '~> 0.3.10'
 ```
 
 And then execute:
@@ -153,8 +164,8 @@ Current methods implemented:
 | `FasterPath.entries` | `Pathname#entries` | 41.0% |
 | `FasterPath.extname` | `File.extname` | 63.1% |
 | `FasterPath.has_trailing_separator?` | `Pathname#has_trailing_separator` | 88.9% |
-| `FasterPath.plus` | `Pathname#join` | 72.0% |
-| `FasterPath.plus` | `Pathname#plus` | 87.7% |
+| `FasterPath.plus` | `Pathname#join` | 79.1% |
+| `FasterPath.plus` | `Pathname#plus` | 94.7% |
 | `FasterPath.relative?` | `Pathname#relative?` | 92.6% |
 | `FasterPath.relative_path_from` | `Pathname#relative_path_from` | 93.3% |
 
@@ -205,8 +216,6 @@ Whenever feasible implement it in Rust.
 After checking out the repo, make sure you have Rust installed, then run `bundle`.
 Run `rake test` to run the tests, and `rake bench` for benchmarks.
 
-Learn and share performance tips on the [wiki](https://github.com/danielpclark/faster_path/wiki)!
-
 ### Building and running tests
 
 First, bundle the gem's development dependencies by running `bundle`.  Rust compilation is included in the current rake commands.

data/faster_path.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'bundler', '~> 1.12'
-  spec.add_dependency 'rake', '~> 12.0'
+  spec.add_dependency 'rake', '~> 12.3'
   spec.add_dependency 'thermite', '0.13.0'
   spec.add_development_dependency 'read_source', '~> 0.2.6'
   spec.add_development_dependency 'minitest', '~> 5.10'

data/lib/faster_path.rb

@@ -6,8 +6,13 @@ require 'fiddle'
 require 'fiddle/import'
 
 # FasterPath module behaves as a singleton object with the alternative method
-# implementations for Pathname, and some for File, available directly on it.
+# implementations for `Pathname`, and some for `File`, available directly on it.
 #
+# New projects are recommend to reference methods defined directly on `FasterPath`.
+# Existing websites may use the `FasterPath.sledgehammer_everything!` method to
+# directly injet the more performant implementations of path handling in to their
+# existing code ecosystem.  To do so you will need to
+# `require 'faster_path/optional/monkeypatches'` beforehand.
 module FasterPath
   FFI_LIBRARY = begin
     toplevel_dir = File.dirname(__dir__)

data/lib/faster_path/version.rb

@@ -1,3 +1,3 @@
 module FasterPath
-  VERSION = "0.3.9"
+  VERSION = "0.3.10"
 end

data/src/pathname.rs

@@ -9,7 +9,6 @@ use plus;
 use relative_path_from;
 use debug;
 use helpers::{TryFrom, to_str};
-use pathname_sys::null_byte_check;
 use path_parsing::{SEP, find_last_non_sep_pos};
 
 use ruru;
@@ -23,10 +22,11 @@ use ruru::{
   Class,
   VerifiedObject,
   Exception as Exc,
-  AnyException as Exception
+  AnyException as Exception,
 };
 use ruru::types::{Value, ValueType};
-use std::path::{MAIN_SEPARATOR,Path};
+use std::borrow::Cow;
+use std::path::{MAIN_SEPARATOR, Path};
 use std::fs;
 
 type MaybeArray = Result<ruru::Array, ruru::result::Error>;
@@ -45,31 +45,6 @@ impl Pathname {
     Pathname { value: instance.value() }
   }
 
-  pub fn new_checked(path: AnyObject) -> Result<Pathname, Exception> {
-    let pth: Value = if Class::from_existing("String").case_equals(&path) {
-      path.value()
-    } else if path.respond_to("to_path") {
-      path.send("to_path", None).value()
-    } else {
-      return Err(
-        Exception::new(
-          "ArgumentError",
-          Some("The type for the argument provided to Pathname.new was invalid.")
-        )
-      )
-    };
-
-    if null_byte_check(path.value()) {
-      return Err( Exception::new("ArgumentError", Some("pathname contains null byte")) )
-    }
-
-    // if it crashes then dup the path string here before assigning to @path
-    let mut instance = Class::from_existing("Pathname").allocate();
-    instance.instance_variable_set("@path", RString::from(pth).to_any_object());
-
-    Ok(Pathname { value: instance.value() })
-  }
-
   pub fn to_any_object(&self) -> AnyObject {
     AnyObject::from(self.value())
   }
@@ -77,7 +52,7 @@ impl Pathname {
 
 impl From<Value> for Pathname {
   fn from(value: Value) -> Self {
-    Pathname { value: value }
+    Pathname { value }
   }
 }
 
@@ -302,29 +277,15 @@ pub fn pn_has_trailing_separator(pth: MaybeString) -> Boolean {
 }
 
 pub fn pn_join(args: MaybeArray) -> AnyObject {
-  let mut args = args.unwrap();
-  let path_self = anyobject_to_string(args.shift()).unwrap();
-  let mut qty = args.length();
-  if qty <= 0 {
-    return Pathname::new(&path_self).to_any_object();
-  }
-
-  let mut result = String::new();
-
-  loop {
-    if qty == 0 { break; }
-
-    let item = args.pop();
-    result = plus::plus_paths(&anyobject_to_string(item).unwrap(), &result);
-    if result.as_bytes().get(0) == Some(&SEP) {
-      return Pathname::new(&result).to_any_object()
+  let paths = args.unwrap().into_iter().map(|arg| anyobject_to_string(arg).unwrap()).collect::<Vec<_>>();
+  let mut paths_iter = paths.iter().rev();
+  let mut result = Cow::Borrowed(paths_iter.next().unwrap().as_str());
+  for part in paths_iter {
+    result = plus::plus_paths(&part, result.as_ref());
+    if result.as_bytes().first() == Some(&SEP) {
+      break;
     }
-
-    qty -= 1;
   }
-
-  let result = plus::plus_paths(&path_self, &result);
-
   Pathname::new(&result).to_any_object()
 }
 

data/src/pathname_sys.rs

@@ -2,23 +2,9 @@ use ruru::{AnyObject, Array, Object, AnyException};
 use ruru::types::{Argc, Value, CallbackPtr};
 use ruru::util::str_to_cstring;
 extern crate ruby_sys;
-use self::ruby_sys::{class, util, vm, string};
+use self::ruby_sys::{class, util, vm};
 use ::pathname;
 extern crate memchr;
-use self::memchr::memchr;
-use std::slice;
-
-pub fn null_byte_check(value: Value) -> bool {
-  unsafe {
-    let str = string::rb_string_value_ptr(&value) as *const u8;
-
-    // `rb_str_len` is a ruby_sys specific thing.  Consider:
-    // extern { fn rb_str_strlen(value: Value) -> c_long } as isize
-    let len = string::rb_str_len(value) as usize;
-
-    memchr(b'\0', slice::from_raw_parts(str, len)).is_some()
-  }
-}
 
 pub fn raise(exception: AnyException) {
   unsafe { vm::rb_exc_raise(exception.value()); }

data/src/plus.rs

@@ -1,83 +1,80 @@
-extern crate array_tool;
-use std::path::Path;
+use std::borrow::Cow;
 use std::str;
+use std::path::MAIN_SEPARATOR;
+
 use chop_basename::chop_basename;
-use basename::basename;
-use dirname::dirname;
-use self::array_tool::vec::Shift;
-use std::ops::Index;
+use path_parsing::SEP;
 
-pub fn plus_paths(path1: &str, path2: &str) -> String {
-  let mut prefix2 = path2.to_string();
+pub fn plus_paths<'a>(path1: &'a str, path2: &str) -> Cow<'a, str> {
+  let mut prefix2 = path2;
   let mut index_list2: Vec<usize> = vec![];
-  let mut basename_list2: Vec<String> = vec![];
-
+  let mut basename_list2: Vec<&str> = vec![];
   loop {
-    match chop_basename(&prefix2.clone()[..]) {
-      None => { break },
+    match chop_basename(prefix2) {
+      None => { break; }
       Some((pfx2, basename2)) => {
-        prefix2 = pfx2.to_string();
-        index_list2.unshift(pfx2.len());
-        basename_list2.unshift(basename2.to_owned());
-      },
+        prefix2 = pfx2;
+        index_list2.push(pfx2.len());
+        basename_list2.push(basename2);
+      }
     }
   }
   if !prefix2.is_empty() {
-    return path2.to_string()
+    return path2.to_string().into();
   };
 
-  let mut prefix1 = path1.to_string();
-
+  let result_prefix: Cow<str>;
+  let mut prefix1 = path1;
   loop {
-    while !basename_list2.is_empty() && basename_list2.first().unwrap() == "." {
-      index_list2.shift();
-      basename_list2.shift();
-    }
-    match chop_basename(&prefix1.clone()[..]) {
-      None => { break },
+    let mut new_len = basename_list2.len() - count_trailing(".", &basename_list2);
+    index_list2.truncate(new_len);
+    basename_list2.truncate(new_len);
+    match chop_basename(prefix1) {
+      None => {
+        result_prefix = prefix1.into();
+        break;
+      }
       Some((pfx1, basename1)) => {
-        prefix1 = pfx1.to_string();
-        if basename1 == "." { continue };
-        if basename1 == ".." || basename_list2.is_empty() || basename_list2.first().unwrap() != ".." {
-          prefix1.push_str(&basename1);
-          break
-          }
+        prefix1 = pfx1;
+        if basename1 == "." { continue; };
+        if basename1 == ".." || basename_list2.last() != Some(&"..") {
+          result_prefix = [prefix1, basename1].concat().into();
+          break;
         }
+      }
+    }
+    if new_len > 0 {
+      new_len -= 1;
+      index_list2.truncate(new_len);
+      basename_list2.truncate(new_len);
     }
-    index_list2.shift();
-    basename_list2.shift();
   }
 
-  let result: String;
-
-  let mut r1 = if let Some((_,_)) = chop_basename(&prefix1[..]) {true} else {false};
-
-  if !r1 {
-    r1 = basename(&prefix1[..], "").contains("/");
-    if r1 {
-      while !basename_list2.is_empty() && basename_list2.first().unwrap() == ".." {
-        index_list2.shift();
-        basename_list2.shift();
-      }
-    }
+  if !result_prefix.is_empty() && result_prefix.as_bytes().iter().cloned().all(|b| b == SEP) {
+    let new_len = basename_list2.len() - count_trailing("..", &basename_list2);
+    index_list2.truncate(new_len);
+    basename_list2.truncate(new_len);
   }
-  if !basename_list2.is_empty() {
-    let suffix2 = path2.index(index_list2.first().unwrap().to_owned()..);
-    if r1 {
-      result = Path::new(&prefix1).join(Path::new(&suffix2)).to_str().unwrap().to_string();
-    } else {
-      prefix1.push_str(&suffix2);
-      result = prefix1.to_string();
+  if let Some(last_index2) = index_list2.last() {
+    let suffix = &path2[*last_index2..];
+    match (result_prefix.as_bytes().last(), suffix.as_bytes().first()) {
+      (Some(&SEP), Some(&SEP)) => [&result_prefix, &suffix[1..]].concat().into(),
+      (Some(&SEP), Some(_)) | (Some(_), Some(&SEP)) => [&result_prefix, suffix].concat().into(),
+      (None, Some(_)) => suffix.to_string().into(),
+      _ => format!("{}{}{}", result_prefix.as_ref(), MAIN_SEPARATOR, suffix).into(),
     }
   } else {
-    if r1 {
-      result = prefix1.to_string();
+    if result_prefix.is_empty() {
+      ".".into()
     } else {
-      result = dirname(&prefix1[..]).to_string();
+      result_prefix
     }
   }
+}
 
-  String::from(result)
+#[inline(always)]
+fn count_trailing(x: &str, xs: &Vec<&str>) -> usize {
+  xs.iter().rev().take_while(|&c| c == &x).count()
 }
 
 #[test]
@@ -90,6 +87,7 @@ fn it_will_plus_same_as_ruby() {
   assert_eq!("/b"     ,       plus_paths("a"  , "/b"));
 
   assert_eq!("/"      ,       plus_paths("/"  , ".."));
+  assert_eq!("////"   ,       plus_paths("////", ""));
   assert_eq!("."      ,       plus_paths("a"  , ".."));
   assert_eq!("a"      ,       plus_paths("a/b", ".."));
   assert_eq!("../.."  ,       plus_paths(".." , ".."));

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faster_path
 version: !ruby/object:Gem::Version
-  version: 0.3.9
+  version: 0.3.10
 platform: ruby
 authors:
 - Daniel P. Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-14 00:00:00.000000000 Z
+date: 2018-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: thermite
   requirement: !ruby/object:Gem::Requirement