cliver 0.1.3 → 0.1.4

data/.travis.yml

@@ -4,8 +4,11 @@ script: "bundle exec rake spec"
 rvm:
   - 2.0.0
   - 1.9.3
-  - jruby-19mode # JRuby in 1.9 mode
+  - jruby-19mode
   - rbx-19mode
+  - 1.8.7
+  - jruby-18mode
+  - rbx-18mode
 branches:
   only:
     - develop

data/README.md

@@ -51,13 +51,23 @@ Cliver.assert('oddball', '~> 10.1.alpha') do |oddball_path|
 end
 ```
 
+And since some programs don't always spit out nice semver-friendly version
+numbers at all, a filter proc can be supplied to clean it up. Note how the
+filter is applied to both your requirements and the executable's output:
+
+```ruby
+Cliver.assert('built-thing', '~> 2013.4r8273',
+              filter: proc { |ver| ver.tr('r','.') })
+```
+
 Since `Cliver` uses `Gem::Requirement` for version comparrisons, it obeys all
 the same rules including pre-release semantics.
 
 ## Supported Platforms
 
 The goal is to have full support for all platforms running ruby >= 1.9.2,
-including rubinius and jruby implementations. Windows has support
+including rubinius and jruby implementations, as well as basic support for
+legacy ruby 1.8.7. Windows has support in the codebase,
 but is not available as a build target in [travis_ci][].
 
 ## See Also:

data/cliver.gemspec

@@ -4,6 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'cliver/version'
 
 Gem::Specification.new do |spec|
+  RUBY_18 = RUBY_VERSION[/\A1\.8\..*/]
   spec.name          = 'cliver'
   spec.version       = Cliver::VERSION
   spec.authors       = ['Ryan Biesemeyer']
@@ -22,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'ruby-appraiser-reek'
-  spec.add_development_dependency 'ruby-appraiser-rubocop'
+  spec.add_development_dependency 'ruby-appraiser-reek'    unless RUBY_18
+  spec.add_development_dependency 'ruby-appraiser-rubocop' unless RUBY_18
   spec.add_development_dependency 'yard'
 end

data/lib/cliver.rb

@@ -3,7 +3,7 @@ require 'cliver/version'
 require 'cliver/which'
 require 'cliver/assertion'
 require 'cliver/detector'
-require 'cliver/detector/default'
+require 'cliver/filter'
 
 # Cliver is tool for making dependency assertions against
 # command-line executables.
@@ -30,7 +30,7 @@ module Cliver
     false
   rescue Assertion::DependencyNotMet => error
     # Cliver::Assertion::VersionMismatch -> 'Version Mismatch'
-    reason = error.class.name.split('::').last.gsub(/(?<!\A)[A-Z]/, ' \\0')
+    reason = error.class.name.split(':').last.gsub(/([a-z])([A-Z])/, '\\1 \\2')
     "#{reason}: #{error.message}"
   end
 end

data/lib/cliver/assertion.rb

@@ -18,6 +18,9 @@ module Cliver
     # An exception that is raised when executable is not present
     DependencyNotFound = Class.new(DependencyNotMet)
 
+    # A pattern for extracting a {Gem::Version}-parsable version
+    PARSABLE_GEM_VERSION = /[0-9]+(.[0-9]+){0,4}(.[a-zA-Z0-9]+)?/.freeze
+
     # @overload initialize(executable, *requirements, options = {})
     # @param executable [String]
     # @param requirements [Array<String>, String] splat of strings
@@ -29,15 +32,20 @@ module Cliver
     #   alphanumeric pre-release suffix. See also
     #   {http://docs.rubygems.org/read/chapter/16 Specifying Versions}
     # @param options [Hash<Symbol,Object>]
-    # @option options [Cliver::Detector, #to_proc] :detector
+    # @option options [Cliver::Detector, #to_proc] :detector (Detector.new)
+    # @option options [#to_proc] :filter ({Cliver::Filter::IDENTITY})
     # @yieldparam [String] full path to executable
-    # @yieldreturn [String] Gem::Version-parsable string version
+    # @yieldreturn [String] containing a {Gem::Version}-parsable substring
     def initialize(executable, *args, &detector)
       options = args.last.kind_of?(Hash) ? args.pop : {}
+      @detector = detector || options.fetch(:detector) { Detector.new }
+      @filter = options.fetch(:filter, Filter::IDENTITY).extend(Filter)
 
       @executable = executable.dup.freeze
-      @requirement = Gem::Requirement.new(args) unless args.empty?
-      @detector = detector || options.fetch(:detector) { Detector.new }
+
+      unless args.empty?
+        @requirement = Gem::Requirement.new(@filter.requirements(args))
+      end
     end
 
     # @raise [DependencyVersionMismatch] if installed version does not match
@@ -64,7 +72,9 @@ module Cliver
       return nil unless executable_path
       return true unless @requirement
 
-      @detector.to_proc.call(executable_path).tap do |version|
+      version_string = @detector.to_proc.call(executable_path)
+      version_string &&= @filter.to_proc.call(version_string)
+      (version_string && version_string[PARSABLE_GEM_VERSION]).tap do |version|
         unless version
           raise ArgumentError,
                 "found #{@executable} at '#{executable_path}' " +

data/lib/cliver/detector.rb

@@ -2,39 +2,36 @@
 require 'shellwords'
 
 module Cliver
-  # The interface for Cliver::Detector classes.
-  # @see Cliver::Detector::Default for reference implementation
-  module Detector
-    # Forward to default implementation
-    # @see Cliver::Detector::Default
-    # @overload (see Cliver::Detector::Default#initialize)
-    # @param (see Cliver::Detector::Default#initialize)
-    # @raise (see Cliver::Detector::Default#initialize)
-    # @return (see Cliver::Detector::Default#initialize)
-    def self.new(*args, &block)
-      Default.new(*args, &block)
-    end
+  # Default implementation of the detector needed by Cliver::Assertion,
+  # which will take anything that #respond_to?(:to_proc)
+  class Detector < Struct.new(:command_arg, :version_pattern)
 
-    # @param executable_path [String] the executable to test
-    # @return [Array<String>]
-    def version_command(executable_path)
-      raise NotImplementedError
-    end
+    # Default pattern to use when searching {#version_command} output
+    DEFAULT_VERSION_PATTERN = /version [0-9][.0-9a-z]+/i.freeze
 
-    # @return [Regexp] - the pattern used against the output
-    #                    of the #version_command, which should
-    #                    typically be Gem::Version-parsable.
-    def version_pattern
-      raise NotImplementedError unless defined? super
-      super
+    # Default command argument to use against the executable to get
+    # version output
+    DEFAULT_COMMAND_ARG = '--version'.freeze
+
+    # Forgiving input, allows either argument if only one supplied.
+    #
+    # @overload initialize(command_arg)
+    # @overload initialize(version_pattern)
+    # @overload initialize(command_arg, version_pattern)
+    # @param command_arg [String]
+    # @param version_pattern [Regexp]
+    def initialize(*args)
+      command_arg = args.shift if args.first.kind_of?(String)
+      version_pattern = args.shift
+      super(command_arg, version_pattern)
     end
 
     # @param executable_path [String] - the path to the executable to test
-    # @return [String] - should be Gem::Version-parsable.
+    # @return [String] - should be contain {Gem::Version}-parsable
+    #                    version number.
     def detect_version(executable_path)
       output = `#{version_command(executable_path).shelljoin} 2>&1`
-      ver = output.scan(version_pattern)
-      ver && ver.first
+      output[version_pattern]
     end
 
     # This is the interface that any detector must have.
@@ -44,5 +41,27 @@ module Cliver
     def to_proc
       method(:detect_version).to_proc
     end
+
+    # The pattern to match the version in {#version_command}'s output.
+    # Defaults to {DEFAULT_VERSION_PATTERN}
+    # @return [Regexp] - the pattern used against the output
+    #                    of the #version_command, which should
+    #                    contain a {Gem::Version}-parsable substring.
+    def version_pattern
+      super || DEFAULT_VERSION_PATTERN
+    end
+
+    # The argument to pass to the executable to get current version
+    # Defaults to {DEFAULT_COMMAND_ARG}
+    # @return [String]
+    def command_arg
+      super || DEFAULT_COMMAND_ARG
+    end
+
+    # @param executable_path [String] the executable to test
+    # @return [Array<String>]
+    def version_command(executable_path)
+      [executable_path, command_arg]
+    end
   end
 end

data/lib/cliver/filter.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Cliver
+  # A Namespace to hold filter procs
+  module Filter
+    # The identity filter returns its input unchanged.
+    IDENTITY = proc { |version| version }
+
+    def requirements(requirements)
+      requirements.map do |requirement|
+        req_parts = requirement.split(/\b(?=\d)/, 2)
+        version = req_parts.last
+        version.replace call(version)
+        req_parts.join
+      end
+    end
+  end
+end

data/lib/cliver/version.rb

@@ -2,5 +2,5 @@
 
 module Cliver
   # Cliver follows {http://semver.org SemVer}
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/lib/cliver/which.rb

@@ -7,10 +7,10 @@ module Cliver
   module Which
     case RbConfig::CONFIG['host_os']
     when /mswin|msys|mingw|cygwin|bccwin|wince|emc/
-      require_relative 'which/windows'
+      require 'cliver/which/windows'
       include Cliver::Which::Windows
     else
-      require_relative 'which/posix'
+      require 'cliver/which/posix'
       include Cliver::Which::Posix
     end
   end

data/spec/cliver/assertion_spec.rb

@@ -96,9 +96,23 @@ describe Cliver::Assertion do
       end
     end
     let(:detector_touches) { [] }
+    context 'ruby using filter' do
+      let(:requirement) { '~> 1.2.3p112' }
+      let(:executable) { 'ruby' }
+      let(:filter) { proc { |ver| ver.tr('p', '.') } }
+      let(:detector) { proc { '1.2.3p456' } }
+      let(:assertion) do
+        Cliver::Assertion.new(executable, requirement, :filter => filter,
+                                                       :detector => detector)
+      end
+      let(:installed_version) { assertion.installed_version }
+      subject { installed_version }
+
+      it { should eq '1.2.3.456' }
+    end
     context 'ruby with detector-block returned value' do
       let(:requirements) { ['~> 10.1.4'] }
-      let(:fake_version) { '10.1.5' }
+      let(:fake_version) { 'ruby 10.1.5' }
       let(:executable) { 'ruby' }
       let(:detector) do
         proc do |ruby|
@@ -116,7 +130,7 @@ describe Cliver::Assertion do
         end
       end
       context 'when block-return doesn\'t meet requirements' do
-        let(:fake_version) { '10.1.3' }
+        let(:fake_version) { '10.1433.32.alpha' }
         it 'should raise' do
           expect { assertion.assert! }.to raise_exception mismatch_exception
         end

data/spec/cliver/detector_spec.rb

@@ -2,11 +2,11 @@
 require 'cliver'
 
 describe Cliver::Detector do
-  let(:detector) { Cliver::Detector::Default.new(*args) }
+  let(:detector) { Cliver::Detector.new(*args) }
   let(:defaults) do
     {
-      version_pattern: Cliver::Detector::Default::DEFAULT_VERSION_PATTERN,
-      command_arg:     Cliver::Detector::Default::DEFAULT_COMMAND_ARG,
+      :version_pattern => Cliver::Detector::DEFAULT_VERSION_PATTERN,
+      :command_arg =>     Cliver::Detector::DEFAULT_COMMAND_ARG,
     }
   end
   let(:args) { [] }

data/spec/cliver_spec.rb

@@ -15,7 +15,7 @@ describe Cliver do
     end
     context 'when dependency is present, but wrong version' do
       let(:executable) { 'ruby' }
-      let(:requirements) { ['~>0.1.0'] }
+      let(:requirements) { ['~> 0.1.0'] }
       let(:detector) { proc { RUBY_VERSION.sub('p', '.') } }
       it { should_not be_false }
       it { should match 'Dependency Version Mismatch:' }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cliver
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-20 00:00:00.000000000 Z
+date: 2013-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,7 +126,7 @@ files:
 - lib/cliver.rb
 - lib/cliver/assertion.rb
 - lib/cliver/detector.rb
-- lib/cliver/detector/default.rb
+- lib/cliver/filter.rb
 - lib/cliver/version.rb
 - lib/cliver/which.rb
 - lib/cliver/which/posix.rb

data/lib/cliver/detector/default.rb

@@ -1,52 +0,0 @@
-# encoding: utf-8
-require 'open3'
-
-module Cliver
-  # Default implementation of Cliver::Detector
-  # Requires a command argument (default '--version')
-  # and a pattern-matcher Regexp with sensible default.
-  class Detector::Default < Struct.new(:command_arg, :version_pattern)
-    include Detector
-
-    # Default pattern to use when searching {#version_command} output
-    DEFAULT_VERSION_PATTERN = /(?<=version )[0-9][.0-9a-z]+/i.freeze
-
-    # Default command argument to use against the executable to get
-    # version output
-    DEFAULT_COMMAND_ARG = '--version'.freeze
-
-    # Forgiving input, allows either argument if only one supplied.
-    #
-    # @overload initialize(command_arg)
-    # @overload initialize(version_pattern)
-    # @overload initialize(command_arg, version_pattern)
-    # @param command_arg [String] ('--version')
-    # @param version_pattern [Regexp] (/(?<=version )[0-9][.0-9a-z]+/i)
-    def initialize(*args)
-      command_arg = args.shift if args.first.kind_of?(String)
-      version_pattern = args.shift
-      super(command_arg, version_pattern)
-    end
-
-    # The pattern to match the version in {#version_command}'s output.
-    # Defaults to {DEFAULT_VERSION_PATTERN}
-    # @overload (see Cliver::Detector#version_pattern)
-    # @return (see Cliver::Detector#version_pattern)
-    def version_pattern
-      super || DEFAULT_VERSION_PATTERN
-    end
-
-    # The argument to pass to the executable to get current version
-    # Defaults to {DEFAULT_COMMAND_ARG}
-    # @return [String]
-    def command_arg
-      super || DEFAULT_COMMAND_ARG
-    end
-
-    # @overload (see Cliver::Detector#version_command)
-    # @return (see Cliver::Detector#version_command)
-    def version_command(executable_path)
-      [executable_path, command_arg]
-    end
-  end
-end