faster_path 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 10c02bf82e54ff3ebcc604e71b9852f35f542441db897fbde1c7eb058d651b8c
-  data.tar.gz: 0d94052d4fc9087160d080af40f125e4cb7366a57cadabc2b3320a30ff17fa07
+  metadata.gz: 71e809651aa4aa3df08645c40f0d616e3f061648ddeeb0e29086e578003df395
+  data.tar.gz: ded1645695ee0ddfd84261e25be66ed6f96b5386f45e093ecb46c0a6301f8896
 SHA512:
-  metadata.gz: 321d28a6fef356c3cc7a02e22261642352ea92833b21d0f4e7687557867e338b4f5d700da52ce6fdafad3370f82bfd8d250da539a47498fb9c0578b767f344af
-  data.tar.gz: f786358285e41337ab1549d219d9f329f870f207f1ddc01a0500ded38340da48ae9fda6e9dc36622cebf03e480ff926d7a48cf2e592d4217ec7db2c23cedf581
+  metadata.gz: ad20f8a279a81ccff6ce068f7c778649d3f71b59576d625e82e4bd1713c78d44dd10eb859b96b925f14c44f64171449c2fd17b46710a53a8e238f75ec17b5195
+  data.tar.gz: 0f2135684d07b33503b4ef62b4f6a750b5648d3b450d8ad0a55f9bdd54853355b86ba9e3e2fd546eb24a9148d9eace955b3642ad9bfeba4ca55c52e8de262bce

data/README.md

@@ -3,9 +3,9 @@
 [![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.6.svg)](https://github.com/danielpclark/faster_path/pulse)
+[![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)
 [![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)](https://coveralls.io/github/danielpclark/faster_path)
+[![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.)
@@ -115,7 +115,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.6'
+gem 'faster_path', '~> 0.3.8'
 ```
 
 And then execute:
@@ -129,7 +129,7 @@ Or install it yourself as:
 ## Visual Benchmarks
 
 Benchmarks in Faster Path now produce visual graph charts of performance improvements.
-When you run `rake bench` the graph art will be placed in `doc/graph/`.  Here's the performance
+When you run `export GRAPH=1; bundle && rake bench` the graph art will be placed in `doc/graph/`.  Here's the performance
 improvement result  for the `chop_basename` method.
 
 ![Visual Benchmark](https://raw.githubusercontent.com/danielpclark/faster_path/master/assets/chop_basename_benchmark.jpg "Visual Benchmark")
@@ -140,21 +140,23 @@ Current methods implemented:
 
 |FasterPath Rust Implementation|Ruby 2.5.0 Implementation|Time Shaved Off|
 |---|---|:---:|
-| `FasterPath.absolute?` | `Pathname#absolute?` | 91.9% |
-| `FasterPath.add_trailing_separator` | `Pathname#add_trailing_separator` | 31.2% |
-| `FasterPath.children` | `Pathname#children` | 13.2% |
-| `FasterPath.chop_basename` | `Pathname#chop_basename` | 54.5% |
-| `FasterPath.cleanpath_aggressive` | `Pathname#cleanpath_aggressive` | 73.8% |
-| `FasterPath.cleanpath_conservative` | `Pathname#cleanpath_conservative` | 70.7% |
-| `FasterPath.del_trailing_separator` | `Pathname#del_trailing_separator` | 80.6% |
-| `FasterPath.directory?` | `Pathname#directory?` | 11.3% |
-| `FasterPath.entries` | `Pathname#entries` | 8.4% |
-| `FasterPath.extname` | `File.extname` | 41.2% |
-| `FasterPath.has_trailing_separator?` | `Pathname#has_trailing_separator` | 67.6% |
-| `FasterPath.plus` | `Pathname#join` | 66.4% |
-| `FasterPath.plus` | `Pathname#plus` | 81.4% |
-| `FasterPath.relative?` | `Pathname#relative?` | 84.1% |
-| `FasterPath.relative_path_from` | `Pathname#relative_path_from` | 69.8% |
+| `FasterPath.absolute?` | `Pathname#absolute?` | 95.8% |
+| `FasterPath.add_trailing_separator` | `Pathname#add_trailing_separator` | 68.7% |
+| `FasterPath.basename` | `File.basename` | 49.4% |
+| `FasterPath.children` | `Pathname#children` | 39.2% |
+| `FasterPath.chop_basename` | `Pathname#chop_basename` | 76.6% |
+| `FasterPath.cleanpath_aggressive` | `Pathname#cleanpath_aggressive` | 78.2% |
+| `FasterPath.cleanpath_conservative` | `Pathname#cleanpath_conservative` | 74.1% |
+| `FasterPath.del_trailing_separator` | `Pathname#del_trailing_separator` | 87.7% |
+| `FasterPath.directory?` | `Pathname#directory?` | 16.8% |
+| `FasterPath.dirname` | `File.dirname` | 28.9% |
+| `FasterPath.entries` | `Pathname#entries` | 36.1% |
+| `FasterPath.extname` | `File.extname` | 66.2% |
+| `FasterPath.has_trailing_separator?` | `Pathname#has_trailing_separator` | 86.3% |
+| `FasterPath.plus` | `Pathname#join` | 67.9% |
+| `FasterPath.plus` | `Pathname#plus` | 86.6% |
+| `FasterPath.relative?` | `Pathname#relative?` | 87.2% |
+| `FasterPath.relative_path_from` | `Pathname#relative_path_from` | 74.0% |
 
 You may choose to use the methods directly, or scope change to rewrite behavior on the
 standard library with the included refinements, or even call a method to monkeypatch
@@ -176,17 +178,17 @@ FasterPath.sledgehammer_everything!
 
 ## Optional Rust implementations
 
-**These are stable, not performant, and not included in `File` by default.**
+**These are stable, not performant, and not included in `Pathname` by default.**
 
-These will **not** be included by default in monkey-patches.  Be cautious when using the `FasterPath::RefineFile` refinement.  To try them with monkeypatching use the environment flag of `WITH_REGRESSION`.  These methods are here to be improved upon.
+These will **not** be included by default in monkey-patches.  To try them with monkeypatching use the environment flag of `WITH_REGRESSION`.  These methods are here to be improved upon.
 
 |FasterPath Implementation|Ruby Implementation|
 |---|---|
-| `FasterPath.dirname` | `File.dirname` |
-| `FasterPath.basename` | `File.basename` |
+| `FasterPath.entries_compat` | `Pathname.entries` |
+| `FasterPath.children_compat` | `Pathname.children` |
 
 It's been my observation (and some others) that the Rust implementation of the C code for `File` has similar results but
-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.
+performance seems to vary based on CPU cache on possibly 64bit/32bit system environments.  These are not included by default when the monkey patch method `FasterPath.sledgehammer_everything!` is executed.
 
 ## Getting Started with Development
 

data/lib/faster_path.rb

@@ -21,9 +21,6 @@ module FasterPath
     private_class_method :basename
     private_class_method :children
     private_class_method :children_compat
-    private_class_method :chop_basename
-    private_class_method :entries
-    private_class_method :entries_compat
   end
 
   def self.rust_arch_bits
@@ -43,32 +40,11 @@ module FasterPath
   end
 
   def self.children(pth, with_directory=true)
-    result = Public.send(:children, pth, with_directory)
-    return result if result
-    raise Errno::NOENT, "No such file or directory @ dir_initialize - #{pth}"
+    Public.send(:children, pth, with_directory)
   end
 
   def self.children_compat(pth, with_directory=true)
-    result = Public.send(:children_compat, pth, with_directory)
-    return result if result
-    raise Errno::NOENT, "No such file or directory @ dir_initialize - #{pth}"
-  end
-
-  def self.chop_basename(pth)
-    result = Public.send(:chop_basename, pth)
-    result unless result.empty?
-  end
-
-  def self.entries(pth)
-    result = Public.send(:entries, pth)
-    return result if result
-    raise Errno::NOENT, "No such file or directory @ dir_initialize - #{pth}"
-  end
-
-  def self.entries_compat(pth)
-    result = Public.send(:entries_compat, pth)
-    return result if result
-    raise Errno::NOENT, "No such file or directory @ dir_initialize - #{pth}"
+    Public.send(:children_compat, pth, with_directory)
   end
 
   module Rust

data/lib/faster_path/optional/monkeypatches.rb

@@ -10,7 +10,7 @@ module FasterPath
           pth = pth.to_path if pth.respond_to? :to_path
           raise TypeError unless pth.is_a?(String) && ext.is_a?(String)
           FasterPath.basename(pth, ext)
-        end if !!ENV['WITH_REGRESSION']
+        end
 
         def self.extname(pth)
           pth = pth.to_path if pth.respond_to? :to_path
@@ -22,7 +22,7 @@ module FasterPath
           pth = pth.to_path if pth.respond_to? :to_path
           raise TypeError unless pth.is_a? String
           FasterPath.dirname(pth)
-        end if !!ENV['WITH_REGRESSION']
+        end
       end
     end
 

data/lib/faster_path/thermite_initialize.rb

@@ -1,4 +1,5 @@
 require 'rubygems'
+require 'rake/tasklib'
 require_relative './version'
 
 module Thermite
@@ -8,7 +9,7 @@ module Thermite
     end
   end
 
-  class Tasks
+  class Tasks < Rake::TaskLib
     def github_download_uri(_tag, version)
       "#{github_uri}/releases/download/v#{FasterPath::VERSION}/#{config.tarball_filename(version)}"
     end

data/lib/faster_path/version.rb

@@ -1,3 +1,3 @@
 module FasterPath
-  VERSION = "0.3.7"
+  VERSION = "0.3.8"
 end

data/src/basename.rs

@@ -1,26 +1,69 @@
 extern crate memchr;
-use self::memchr::memrchr;
-use path_parsing::{SEP, last_non_sep_i};
-
-pub fn basename<'a>(pth: &'a str, ext: &str) -> &'a str {
-  let name_end = (last_non_sep_i(pth) + 1) as usize;
-  // Known edge case, all '/'.
-  if !pth.is_empty() && name_end == 0 {
-    return &pth[..1];
+
+use path_parsing::{find_last_sep_pos, find_last_non_sep_pos, find_last_dot_pos};
+
+pub fn basename<'a>(path: &'a str, ext: &str) -> &'a str {
+  let bytes: &[u8] = path.as_bytes();
+  let mut left: usize = 0;
+  let mut right: usize = bytes.len();
+  if let Some(last_slash_pos) = find_last_sep_pos(bytes) {
+    if last_slash_pos == right - 1 {
+      if let Some(pos) = find_last_non_sep_pos(&bytes[..last_slash_pos]) {
+        right = pos + 1;
+      } else {
+        return "/";
+      }
+      if let Some(pos) = find_last_sep_pos(&bytes[..right]) {
+        left = pos + 1;
+      }
+    } else {
+      left = last_slash_pos + 1;
+    }
   }
-  let name_start = match memrchr(SEP, &pth.as_bytes()[..name_end]) {
-    Some(i) => i + 1,
-    _ => 0
-  };
-  let mut name = &pth[name_start..name_end];
-  if ext == ".*" {
-    if let Some(dot_i) = memrchr('.' as u8, name.as_bytes()) {
-      name = &name[..dot_i];
+  let ext_bytes = ext.as_bytes();
+  if ext_bytes == b".*" {
+    if let Some(dot_pos) = find_last_dot_pos(&bytes[left..right]) {
+      right = left + dot_pos;
     }
-  } else if name.ends_with(ext) {
-    name = &name[..name.len() - ext.len()];
-  };
-  name
+  } else if bytes[left..right].ends_with(ext_bytes) {
+    right -= ext_bytes.len();
+  }
+  &path[left..right]
+}
+
+#[test]
+fn absolute() {
+  assert_eq!(basename("/a/b///c", ""), "c");
+}
+
+#[test]
+fn trailing_slashes_absolute() {
+  assert_eq!(basename("/a/b///c//////", ""), "c");
+}
+
+#[test]
+fn relative() {
+  assert_eq!(basename("b///c", ""), "c");
+}
+
+#[test]
+fn trailing_slashes_relative() {
+  assert_eq!(basename("b/c//", ""), "c");
+}
+
+#[test]
+fn root() {
+  assert_eq!(basename("//c", ""), "c");
+}
+
+#[test]
+fn trailing_slashes_root() {
+  assert_eq!(basename("//c//", ""), "c");
+}
+
+#[test]
+fn trailing_slashes_relative_root() {
+  assert_eq!(basename("c//", ""), "c");
 }
 
 #[test]

data/src/chop_basename.rs

@@ -1,21 +1,14 @@
-use std::path::MAIN_SEPARATOR;
+use path_parsing::{find_last_non_sep_pos, find_last_sep_pos};
 use std::str;
 
 pub fn chop_basename<'a>(input: &'a str) -> Option<(&'a str, &'a str)> {
-  if input.is_empty() {
+  let bytes = input.as_bytes();
+  let len = find_last_non_sep_pos(&bytes)? + 1;
+  let base_start = find_last_sep_pos(&bytes[..len]).map_or(0, |pos| pos + 1);
+  if base_start == len {
     return None;
   }
-
-  let input = input.trim_right_matches(MAIN_SEPARATOR);
-  let end = input.rsplitn(2, MAIN_SEPARATOR).nth(0).unwrap().len();
-  let base = &input[input.len()-end..input.len()];
-  let directory = &input[0..input.len()-base.len()];
-
-  if directory.is_empty() && (base.is_empty() || base.chars().next().unwrap() == MAIN_SEPARATOR) {
-    return None
-  };
-
-  Some((directory, base))
+  Some((&input[0..base_start], &input[base_start..len]))
 }
 
 #[test]
@@ -27,5 +20,11 @@ fn it_chops_the_basename_and_dirname() {
   assert_eq!(chop_basename("asdf.txt"),   Some(("",      "asdf.txt")) );
   assert_eq!(chop_basename("asdf/"),      Some(("",          "asdf")) );
   assert_eq!(chop_basename("/asdf/"),     Some(("/",         "asdf")) );
+  assert_eq!(chop_basename("a///b"),      Some(("a///",         "b")) );
+  assert_eq!(chop_basename("a///b//"),    Some(("a///",         "b")) );
+  assert_eq!(chop_basename("/a///b//"),   Some(("/a///",        "b")) );
+  assert_eq!(chop_basename("/a///b//"),   Some(("/a///",        "b")) );
+
+  assert_eq!(chop_basename("./../..///.../..//"), Some(("./../..///.../", "..")));
 }
 

data/src/cleanpath_aggressive.rs

@@ -1,32 +1,24 @@
+use std::borrow::Cow;
 use prepend_prefix::prepend_prefix;
 use basename::basename;
 use chop_basename::chop_basename;
-extern crate array_tool;
-use self::array_tool::vec::Shift;
-use std::path::MAIN_SEPARATOR;
-
-pub fn cleanpath_aggressive(path: &str) -> String {
-  let sep = MAIN_SEPARATOR.to_string();
-  let mut names: Vec<String> = vec![];
-  let mut pre = path.to_string();
-  loop {
-    match chop_basename(&pre.clone()) {
-      Some((ref p, ref base)) => {
-        pre = p.to_string();
-        match base.as_ref() {
-          "." => {},
-          ".." => names.unshift(base.to_string()),
-          _ => {
-            if names.first() == Some(&"..".to_string()) {
-              names.shift();
-            } else {
-              names.unshift(base.to_string())
-            }
-          }
+use path_parsing::{SEP_STR, contains_sep};
 
+pub fn cleanpath_aggressive(path: &str) -> Cow<str> {
+  let mut names: Vec<&str> = vec![];
+  let mut prefix = path;
+  while let Some((ref p, ref base)) = chop_basename(&prefix) {
+    prefix = p;
+    match base.as_ref() {
+      "." => {}
+      ".." => names.push(base),
+      _ => {
+        if names.last() == Some(&"..") {
+          names.pop();
+        } else {
+          names.push(base);
         }
-      },
-      None => break,
+      }
     }
   }
   // // Windows Feature
@@ -35,16 +27,12 @@ pub fn cleanpath_aggressive(path: &str) -> String {
   // pre.tr!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
   // ```
   //
-  if basename(&pre, "").contains(&sep) {
-    loop {
-      if names.first() == Some(&"..".to_string()) {
-        let _ = names.shift();
-      } else {
-        break
-      }
-    }
+  if contains_sep(basename(&prefix, "").as_bytes()) {
+    let len = names.iter().rposition(|&c| c != "..").map_or(0, |pos| pos + 1);
+    names.truncate(len);
   }
-  prepend_prefix(&pre, &names.join(&sep)[..])
+  names.reverse();
+  prepend_prefix(&prefix, &names.join(&SEP_STR))
 }
 
 #[test]

data/src/cleanpath_conservative.rs

@@ -1,25 +1,18 @@
+use std::borrow::Cow;
+use std::path::MAIN_SEPARATOR;
 use prepend_prefix::prepend_prefix;
 use basename::basename;
 use dirname::dirname;
 use chop_basename::chop_basename;
-extern crate array_tool;
-use self::array_tool::vec::Shift;
-use std::path::MAIN_SEPARATOR;
+use path_parsing::{SEP_STR, contains_sep};
 
-pub fn cleanpath_conservative(path: &str) -> String {
-  let sep = MAIN_SEPARATOR.to_string();
-  let mut names: Vec<String> = vec![];
-  let mut pre = path.to_string();
-  loop {
-    match chop_basename(&pre.clone()) {
-      Some((ref p, ref base)) => {
-        pre = p.to_string();
-        match base.as_ref() {
-          "." => {},
-          _ => names.unshift(base.to_string()),
-        }
-      },
-      None => break,
+pub fn cleanpath_conservative(path: &str) -> Cow<str> {
+  let mut names: Vec<&str> = vec![];
+  let mut prefix = path;
+  while let Some((ref p, ref base)) = chop_basename(&prefix) {
+    prefix = p;
+    if base != &"." {
+      names.push(base);
     }
   }
   // // Windows Feature
@@ -28,33 +21,26 @@ pub fn cleanpath_conservative(path: &str) -> String {
   // pre.tr!(File::ALT_SEPARATOR, File::SEPARATOR) if File::ALT_SEPARATOR
   // ```
   //
-  if basename(&pre, "").contains(&sep) {
-    loop {
-      if names.first() == Some(&"..".to_string()) {
-        let _ = names.shift();
-      } else {
-        break
-      }
-    }
+  if contains_sep(basename(&prefix, "").as_bytes()) {
+    let len = names.iter().rposition(|&c| c != "..").map_or(0, |pos| pos + 1);
+    names.truncate(len);
   }
 
-  if names.is_empty() {
-    return dirname(&pre).to_string();
-  }
+  let last_name = match names.first() {
+    Some(&name) => name,
+    None => return dirname(&prefix).into(),
+  };
 
-  if names.last() != Some(&"..".to_string()) && basename(&path, "") == &".".to_string() {
-    names.push(".".to_string());
-  }
-
-  let result = prepend_prefix(&pre, &names.join(&sep)[..]);
-  let last = names.last();
-
-  if !(last == Some(&".".to_string()) || last == Some(&"..".to_string())) &&
-    chop_basename(path).map(|(a, b)| a.len() + b.len()).unwrap() < path.len() {
-    format!("{}{}", last.unwrap(), MAIN_SEPARATOR)
+  if last_name != ".." && basename(&path, "") == "." {
+    names.reverse();
+    names.push(".");
+  } else if last_name != "." && last_name != ".." &&
+      chop_basename(path).map(|(a, b)| a.len() + b.len()).unwrap() < path.len() {
+    return format!("{}{}", last_name, MAIN_SEPARATOR).into();
   } else {
-    result
+    names.reverse();
   }
+  prepend_prefix(&prefix, &names.join(&SEP_STR))
 }
 
 #[test]
@@ -97,11 +83,11 @@ fn it_conservatively_cleans_the_path() {
 // DOSISH_DRIVE_LETTER = File.dirname("A:") == "A:."
 // DOSISH_UNC = File.dirname("//") == "//"
 //
-// 
+//
 //   if DOSISH
 //     assert_eq!(cleanpath_conservative, 'c:/foo/bar', 'c:\\foo\\bar')
 //   end
-// 
+//
 //   if DOSISH_UNC
 //     assert_eq!(cleanpath_conservative, '//',     '//')
 //   else