cliver 0.0.1

data/.githooks/pre-commit/ruby-appraiser

@@ -0,0 +1,17 @@
+#!/bin/bash
+echo -e "\033[0;36mRuby Appraiser: running\033[0m"
+bundle exec ruby-appraiser --mode=staged reek rubocop
+result_code=$?
+if [ $result_code -gt "0" ]; then
+  echo -en "\033[0;31m" # RED
+  echo "[✘] Ruby Appraiser found newly-created defects and "
+  echo "    has blocked your commit."
+  echo "    Fix the defects and commit again."
+  echo "    To bypass, commit again with --no-verify."
+  echo -en "\033[0m" # RESET
+  exit $result_code
+else
+  echo -en "\033[0;32m" # GREEN
+  echo "[✔] Ruby Appraiser ok"
+  echo -en "\033[0m" #RESET
+fi

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+# encoding: utf-8
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cliver.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ryan Biesemeyer
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,45 @@
+# Cliver
+
+Sometimes Ruby apps shell out to command-line executables, but there is no
+standard way to ensure those underlying dependencies are met. Users usually
+find out via a nasty stack-trace and whatever wasn't captured on stderr.
+
+`Cliver` is a simple gem that provides an easy way to make assertions about
+command-line dependencies. Under the covers, it uses [rubygems/requirements][]
+so it supports the version requirements you're used to providing in your
+gemspec.
+
+## Usage
+
+```ruby
+Cliver.assert('subl')                      # no version requirements
+Cliver.assert('bzip2', '~> 1.0.6')         # one version requirement
+Cliver.assert('racc', '>= 1.0', '< 1.4.9') # many version requirements
+```
+
+If the executable can't be found on your path at all, a 
+`Cliver::Assertion::DependencyNotFound` exception is raised; if the version
+reached does not meet the requirements, a `Cliver::Assertion::VersionMismatch`
+exception is raised.
+
+## Advanced Usage:
+
+Some programs don't provide nice 'version 1.2.3' strings in their `--version`
+output; `Cliver` lets you provide your own matcher, whose first group is the
+string version.
+
+```ruby
+Cliver.assert('python', '~> 1.7', version_matcher: /Python ([0-9.]+)/)
+```
+
+Other programs don't provide a standard `--version`; `Cliver` allows you to
+provide your own arg:
+
+```ruby
+Cliver.assert('janky', '~> 10.1.alpha', version_arg: '--release-version')
+```
+
+It obeys all the same rules as `Gem::Requirement`, including pre-release
+semantics.
+
+[rubygems/requirements]: https://github.com/rubygems/rubygems/blob/master/lib/rubygems/requirement.rb

data/Rakefile

@@ -0,0 +1,8 @@
+# encoding: utf-8
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.verbose = true
+end

data/cliver.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cliver/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cliver'
+  spec.version       = Cliver::VERSION
+  spec.authors       = ['Ryan Biesemeyer']
+  spec.email         = ['ryan@yaauie.com']
+  spec.description   = 'Assertions for command-line dependencies'
+  spec.summary       = 'Cross-platform version constraints for cli tools'
+  spec.homepage      = 'https://www.github.com/yaauie/cliver'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  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'
+end

data/lib/cliver.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+require 'cliver/version'
+require 'cliver/assertion'
+
+module Cliver
+  # See Cliver::Assertion#assert
+  def self.assert(*args, &block)
+    Assertion.assert!(*args, &block)
+  end
+end

data/lib/cliver/assertion.rb

@@ -0,0 +1,63 @@
+# encoding: utf-8
+require 'open3'
+require 'rubygems/requirement'
+
+module Cliver
+  # The core of Cliver, Assertion is responsible for detecting the
+  # installed version of a binary and determining if it meets the requirements
+  class Assertion
+    VersionMismatch = Class.new(ArgumentError)
+    DependencyNotFound = Class.new(ArgumentError)
+
+    EXECUTABLE_PATTERN = /\A[a-z][a-zA-Z0-9\-_]*\z/.freeze
+
+    # Creates a new instance with the args and calls #assert.
+    # @see #assert
+    def self.assert!(*args)
+      new(*args).assert!
+    end
+
+    # @overload initialize(executable, *requirements, options = {})
+    # @param executable [String]
+    # @param requirements [Array<String>, String] splat of strings
+    #   whose elements follow the pattern
+    #     [<operator>] <version>
+    #   Where <operator> is optional (default '='') and in the set
+    #     '=', '!=', '>', '<', '>=', '<=', or '~>'
+    #   And <version> is dot-separated integers with optional
+    #   alphanumeric pre-release suffix
+    #   @see Gem::Requirement::new
+    # @param options [Hash<Symbol,Object>]
+    # @options options [#match] :version_matcher
+    # @options options [String] :version_arg
+    def initialize(executable, *args)
+      options = args.last.kind_of?(Hash) ? args.pop : {}
+      raise ArgumentError, 'executable' unless executable[EXECUTABLE_PATTERN]
+
+      @executable = executable.dup.freeze
+      @requirement = Gem::Requirement.new(args)
+      @version_arg = options.fetch(:version_arg, '--version')
+      @version_matcher = options.fetch(:version_matcher,
+                                       /version ([0-9][.0-9a-z]+)/i)
+    end
+
+    # @raise [VersionMismatch] if installed version does not match requirement
+    # @raise [DependencyNotFound] if no installed version on your path
+    def assert!
+      version = installed_version
+      version || raise(DependencyNotFound, "#{@executable} missing.")
+      unless @requirement.satisfied_by?(version)
+        raise VersionMismatch,
+              "got #{version}, expected #{@requirement}"
+      end
+    end
+
+    # @private
+    def installed_version
+      command = "which #{@executable} && #{@executable} #{@version_arg}"
+      command_out, _ = Open3.capture2e(command)
+      match = @version_matcher.match(command_out)
+      match && Gem::Version.new(match[1])
+    end
+  end
+end

data/lib/cliver/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Cliver
+  VERSION = '0.0.1'
+end

data/spec/cliver/assertion_spec.rb

@@ -0,0 +1,89 @@
+# encoding: utf-8
+require 'cliver/assertion'
+
+describe Cliver::Assertion do
+  let(:mismatch_exception) { Cliver::Assertion::VersionMismatch }
+  let(:missing_exception) { Cliver::Assertion::DependencyNotFound }
+  let(:requirements) { ['6.8'] }
+  let(:executable) { 'fubar' }
+  let(:assertion) { Cliver::Assertion.new(executable, *requirements) }
+
+  context 'when dependency found' do
+    before(:each) { assertion.stub(:installed_version) { version } }
+
+    # sampling of requirements; actual implementation
+    # is supplied by rubygems/requirement and well-tested there.
+    context '~>' do
+      let(:requirements) { ['~> 6.8'] }
+      context 'when version matches exactly' do
+        let(:version) { Gem::Version.new('6.8') }
+        it 'should not raise' do
+          expect { assertion.assert! }.to_not raise_exception
+        end
+      end
+      context 'when major matches, and minor too low' do
+        let(:version) { Gem::Version.new('6.7') }
+        it 'should raise' do
+          expect { assertion.assert! }.to raise_exception mismatch_exception
+        end
+      end
+      context 'when major matches, and minor bumped' do
+        let(:version) { Gem::Version.new('6.13') }
+        it 'should not raise' do
+          expect { assertion.assert! }.to_not raise_exception
+        end
+      end
+      context 'when major too high' do
+        let(:version) { Gem::Version.new('7.0') }
+        it 'should raise' do
+          expect { assertion.assert! }.to raise_exception mismatch_exception
+        end
+      end
+      context 'patch version present' do
+        let(:version) { Gem::Version.new('6.8.1') }
+        it 'should not raise' do
+          expect { assertion.assert! }.to_not raise_exception
+        end
+      end
+      context 'pre-release of version that matches' do
+        let(:version) { Gem::Version.new('6.8.a') }
+        it 'should raise' do
+          version.should be_prerelease
+          expect { assertion.assert! }.to raise_exception mismatch_exception
+        end
+      end
+    end
+
+    context 'multi [>=,<]' do
+      let(:requirements) { ['>= 1.1.4', '< 3.1'] }
+      context 'matches both' do
+        let(:version)  { Gem::Version.new('2.0') }
+        it 'should not raise' do
+          expect { assertion.assert! }.to_not raise_exception
+        end
+      end
+      context 'fails one' do
+        let(:version)  { Gem::Version.new('3.1') }
+        it 'should raise' do
+          expect { assertion.assert! }.to raise_exception mismatch_exception
+        end
+      end
+    end
+
+    context 'none' do
+      let(:requirements) { [] }
+      let(:version) { Gem::Version.new('3.1') }
+      it 'should not raise' do
+        expect { assertion.assert! }.to_not raise_exception
+      end
+    end
+  end
+
+  context 'when dependency not found' do
+    before(:each) { assertion.stub(:installed_version) { nil } }
+
+    it 'should raise' do
+      expect { assertion.assert! }.to raise_exception missing_exception
+    end
+  end
+end

data/spec/cliver_spec.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+require 'cliver'
+
+describe Cliver do
+  it { should respond_to :assert }
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: cliver
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Biesemeyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-appraiser-reek
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-appraiser-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Assertions for command-line dependencies
+email:
+- ryan@yaauie.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .githooks/pre-commit/ruby-appraiser
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cliver.gemspec
+- lib/cliver.rb
+- lib/cliver/assertion.rb
+- lib/cliver/version.rb
+- spec/cliver/assertion_spec.rb
+- spec/cliver_spec.rb
+homepage: https://www.github.com/yaauie/cliver
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Cross-platform version constraints for cli tools
+test_files:
+- spec/cliver/assertion_spec.rb
+- spec/cliver_spec.rb
+has_rdoc: