faster_path 0.1.10 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40367b49892754c5b9d83891289cc0ce30e757d6
-  data.tar.gz: 8a92f9a7796c946a873cfded321b529f1f8d57bf
+  metadata.gz: ff5facbf74ee4f0f136736a30ac47a525f6eb39b
+  data.tar.gz: 0a9ef741f3fce8b6786f2917fda4f43d2e81e185
 SHA512:
-  metadata.gz: 8dc854ddd64ba12ac79ff11e792bf5fc6723d3ea547056d474a344572e0608f0e0c0c0d688c39a70c50e5a636d36215d0906a952cd65f58402a7fc05d8f135c4
-  data.tar.gz: f0e6009a18eeeb0414836f3b13d4684db44839e466845b745c6b08440da63ad247be78acc7671ef53c07dc8c69237d0e964e81c3bd9bb9dd717ce17a65fd2184
+  metadata.gz: 1b2b36657e420010b1cf931bb6e0ba75299277689cd2f84ca0e04b1b8b2e8d02ca00ffc0f3a39b27f1ea1b8451082caf26fb3a158f54eea8119081c63c0bb30f
+  data.tar.gz: 111d7bf455b8db96f55f5f5b664d876ede2bb78b163e21672162a58c751c32d6328b2cb2340ffeaa1de561e3f114fd9417f93f9ffb147bd97ce1f24bfcb3dd91

data/Gemfile

@@ -1,11 +1,14 @@
 source 'https://rubygems.org' do
   # Specify your gem's dependencies in faster_path.gemspec
   gemspec
+  group :test do
+    gem 'coveralls', require: false
+  end
 end
 
 begin
 # https://github.com/ruby/spec dependencies
-eval_gemfile File.expand_path('spec/ruby_spec/Gemfile', File.dirname(__FILE__))
+  eval_gemfile File.expand_path('spec/ruby_spec/Gemfile', File.dirname(__FILE__))
 rescue
   `git submodule update --init`
   eval_gemfile File.expand_path('spec/ruby_spec/Gemfile', File.dirname(__FILE__))

data/README.md

@@ -1,8 +1,14 @@
 # FasterPath
 [![Gem Version](https://badge.fury.io/rb/faster_path.svg)](https://badge.fury.io/rb/faster_path)
-[![Build Status](https://travis-ci.org/danielpclark/faster_path.svg?branch=master)](https://travis-ci.org/danielpclark/faster_path)
+[![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.1.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)](https://coveralls.io/github/danielpclark/faster_path)
+[![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.)
-[New Wiki Up!](https://github.com/danielpclark/faster_path/wiki)
 
 #### This gem shaves off more than 30% of my Rails application page load time.
 
@@ -176,7 +182,7 @@ FasterPath.sledgehammer_everything!
 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 environmnets.
 
-**Developers for FasterPath:** Most of these need to be rewritten, please use `WITH_REGRESSION` in your testing.  You can see the resulting failures currently on TravisCI under "Allow Failures".
+**Developers for FasterPath:** Most of these need to be rewritten, please use `WITH_REGRESSION=true TEST_MONKEYPATCHES=true` in your testing.  You can see the resulting failures currently on TravisCI under "Allow Failures".
 
 ## Getting Started with Development
 

data/Rakefile

@@ -5,7 +5,7 @@ require 'fileutils'
 desc "Build Rust extension"
 task :build_src do
   puts "Building extension..."
-  system("cargo build --release")
+  sh "cargo build --release"
 end
 
 desc "Clean up Rust build"
@@ -16,9 +16,9 @@ task :clean_src do
     rm_rf(
       Dir.
       glob('target/release/*').
-      keep_if {|f|
+      keep_if do |f|
         !f[/\.(?:so|dll|dylib|deps)\z/]
-      }
+      end
   )
 end
 
@@ -27,13 +27,21 @@ task build_lib: [:build_src, :clean_src] do
   puts "Completed build!"
 end
 
+desc "Code Quality Check"
+task :lint do
+  puts
+  puts "Quality check starting..."
+  sh "rubocop"
+  puts
+end
+
 Rake::TestTask.new(minitest: :build_lib) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :test => :minitest do |t|
+task test: [:minitest, :lint] do |_t|
   exec 'mspec --format spec core/file/basename core/file/extname core/file/dirname library/pathname'
 end
 

data/ext/faster_path/extconf.rb

@@ -8,12 +8,12 @@ unless find_executable('cargo')
   puts
   puts "curl -sSf https://static.rust-lang.org/rustup.sh | sudo sh -s -- --channel=nightly"
   puts
-  END { puts "Exiting..."}
+  at_exit { puts "Exiting..."}
 end
 
 Dir.chdir(File.expand_path("../../", File.dirname(__FILE__))) do
-  %x(rake build_src)
-  %x(rake clean_src)
+  `rake build_src`
+  `rake clean_src`
 end
 
 create_makefile('faster_path/dummy')

data/faster_path.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = FasterPath::VERSION
   spec.authors       = ["Daniel P. Clark"]
   spec.email         = ["6ftdan@gmail.com"]
-  spec.summary       = %q{Reimplementation of Pathname for better performance}
-  spec.description   = %q{FasterPath is a reimplementation of Pathname for better performance.}
+  spec.summary       = 'Reimplementation of Pathname for better performance'
+  spec.description   = 'FasterPath is a reimplementation of Pathname for better performance.'
   spec.homepage      = "https://github.com/danielpclark/faster_path"
   spec.license       = "MIT OR Apache-2.0"
 
@@ -30,8 +30,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "method_source", "~> 0.8.2"
   spec.add_development_dependency "minitest", "~> 5.10"
   spec.add_development_dependency "minitest-reporters", "~> 1.1"
-  spec.add_development_dependency "color_pound_spec_reporter", "~> 0.0.5"
-  unless ENV['TRAVIS']
+  spec.add_development_dependency "color_pound_spec_reporter", "~> 0.0.9"
+  spec.add_development_dependency "rubocop", "~> 0.47"
+  unless ENV['CI']
     spec.add_development_dependency "stop_watch", "~> 0.1.0"
     spec.add_development_dependency "gruff", "~> 0.7.0"
   end

data/lib/faster_path.rb

@@ -1,6 +1,7 @@
 require "faster_path/version"
 require 'pathname'
 require "ffi"
+require 'faster_path/asset_resolution'
 
 module FasterPath
   def self.rust_arch_bits
@@ -35,8 +36,9 @@ module FasterPath
   # This implementation correctly handles blank strings just as Pathname had intended
   # to handle non-path strings.
   def self.chop_basename(pth)
-    d,b = [Rust.dirname_for_chop(pth), Rust.basename_for_chop(pth)]
-    [d,b] unless Rust.both_are_blank(d,b)
+    d = Rust.dirname_for_chop(pth)
+    b = Rust.basename_for_chop(pth)
+    [d, b] unless Rust.both_are_blank(d, b)
   end
 
   def self.blank?(str)
@@ -64,16 +66,15 @@ module FasterPath
   end
 
   # EXAMPLE
-  #def self.one_and_two
+  # def self.one_and_two
   #  Rust.one_and_two.to_a
-  #end
+  # end
 
-  private
   module Rust
     extend FFI::Library
     ffi_lib begin
       prefix = Gem.win_platform? ? "" : "lib"
-      "#{File.expand_path("../target/release/", File.dirname(__FILE__))}/#{prefix}faster_path.#{FFI::Platform::LIBSUFFIX}"
+      "#{File.expand_path("../target/release/", __dir__)}/#{prefix}faster_path.#{FFI::Platform::LIBSUFFIX}"
     end
 
     class FromRustArray < FFI::Struct
@@ -101,7 +102,7 @@ module FasterPath
     attach_function :entries, [ :string ], FromRustArray.by_value
 
     # EXAMPLE
-    #attach_function :one_and_two, [], FromRustArray.by_value
+    # attach_function :one_and_two, [], FromRustArray.by_value
   end
   private_constant :Rust
 end

data/lib/faster_path/asset_resolution.rb

@@ -0,0 +1,59 @@
+# This is a redundancy check for the rust compiled library needed for this gem.
+# If the asset is not available and we can't compile it from this code then FAIL
+# on require of 'faster_path' with a very clear message as to why."
+
+module FasterPath
+  module AssetResolution # BREAK IN CASE OF EMERGENCY ;-)
+    class << self
+      def verify!
+        return lib_file if file?
+
+        if rust?
+          compile!
+          raise "Rust failed to compile asset! The dynamic library for this package was not found." unless file?
+          return lib_file
+        end
+
+        raise "The dynamic library for this package was not found nor was Rust's cargo executable found. This package will not work without it!"
+      end
+
+      private
+
+      def compile!
+        require 'open3'
+        Dir.chdir(File.expand_path('../../', __dir__)) do
+          Open3.popen3("rake build_lib") do |stdin, stdout, stderr, wait_thr|
+            stdin.close
+
+            wait_thr && wait_thr.value.exitstatus
+            out = Thread.new { stdout.read }.value.strip
+            Thread.new { stderr.read }.value
+            out
+          end
+        end
+        File.exist? lib_file
+      end
+
+      def rust?
+        require 'mkmf'
+        MakeMakefile::Logging.instance_variable_set(:@log, File.open(File::NULL, 'w'))
+        MakeMakefile.instance_eval "undef :message; def message(*); end"
+        MakeMakefile.find_executable('cargo')
+      end
+
+      def file?
+        File.exist? lib_file
+      end
+
+      def lib_dir
+        File.expand_path("../../target/release/", __dir__)
+      end
+
+      def lib_file
+        prefix = Gem.win_platform? ? "" : "lib"
+        "#{lib_dir}/#{prefix}faster_path.#{FFI::Platform::LIBSUFFIX}"
+      end
+    end
+  end
+end
+FasterPath::AssetResolution.verify! unless ENV['TEST']

data/lib/faster_path/optional/monkeypatches.rb

@@ -1,53 +1,63 @@
 require 'pathname'
 
 module FasterPath
-  def self.sledgehammer_everything!
-    ::File.class_eval do
-      def self.basename(pth, ext = '')
-        FasterPath.basename(pth, ext)
-      end if ENV['WITH_REGRESSION']
-
-      def self.extname(pth)
-        FasterPath.extname(pth)
-      end if ENV['WITH_REGRESSION']
-
-      def self.dirname(pth)
-        FasterPath.dirname(pth)
+  module MonkeyPatches
+    def self._ruby_core_file!
+      ::File.class_eval do
+        def self.basename(pth, ext = '')
+          FasterPath.basename(pth, ext)
+        end
+
+        def self.extname(pth)
+          FasterPath.extname(pth)
+        end
+
+        def self.dirname(pth)
+          FasterPath.dirname(pth)
+        end
       end if ENV['WITH_REGRESSION']
     end
 
-    ::Pathname.class_eval do
-      def absolute?
-        FasterPath.absolute?(@path)
-      end
-
-      def directory?
-        FasterPath.directory?(@path)
-      end
-
-      def chop_basename(pth)
-        FasterPath.chop_basename(pth)
-      end
-      private :chop_basename
-
-      def relative?
-        FasterPath.relative?(@path)
-      end
-
-      def add_trailing_separator(pth)
-        FasterPath.add_trailing_separator(pth)
-      end
-      private :add_trailing_separator
-
-      def has_trailing_separator?(pth)
-        FasterPath.has_trailing_separator?(pth)
+    def self._ruby_library_pathname!
+      ::Pathname.class_eval do
+        def absolute?
+          FasterPath.absolute?(@path)
+        end
+
+        def directory?
+          FasterPath.directory?(@path)
+        end
+
+        def chop_basename(pth)
+          FasterPath.chop_basename(pth)
+        end
+        private :chop_basename
+
+        def relative?
+          FasterPath.relative?(@path)
+        end
+
+        def add_trailing_separator(pth)
+          FasterPath.add_trailing_separator(pth)
+        end
+        private :add_trailing_separator
+
+        def has_trailing_separator?(pth)
+          FasterPath.has_trailing_separator?(pth)
+        end
+        private :has_trailing_separator?
+
+        def entries
+          FasterPath.entries(@path)
+        end
       end
-      private :has_trailing_separator?
-
-      def entries
-        FasterPath.entries(@path)
-      end if ENV['WITH_REGRESSION']
     end
+  end
+  private_constant :MonkeyPatches
+
+  def self.sledgehammer_everything!
+    MonkeyPatches._ruby_core_file!
+    MonkeyPatches._ruby_library_pathname!
     "CAUTION: Monkey patching effects everything! Be very sure you want this!"
   end
 end

data/lib/faster_path/optional/refinements.rb

@@ -47,7 +47,7 @@ module FasterPath
 
       def entries
         FasterPath.entries(@path)
-      end if ENV['WITH_REGRESSION']
+      end
     end
   end
 end

data/lib/faster_path/version.rb

@@ -1,3 +1,3 @@
 module FasterPath
-  VERSION = "0.1.10"
+  VERSION = "0.1.11"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faster_path
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Daniel P. Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-25 00:00:00.000000000 Z
+date: 2017-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,14 +100,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.9
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.9
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
 - !ruby/object:Gem::Dependency
   name: stop_watch
   requirement: !ruby/object:Gem::Requirement
@@ -155,6 +169,7 @@ files:
 - ext/faster_path/extconf.rb
 - faster_path.gemspec
 - lib/faster_path.rb
+- lib/faster_path/asset_resolution.rb
 - lib/faster_path/optional/monkeypatches.rb
 - lib/faster_path/optional/refinements.rb
 - lib/faster_path/version.rb