version_guard 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e466bebc6133be19c8093f5b9aba44d13443131f
+  data.tar.gz: 7298f61f14158299c951971150d66273910b9e99
+SHA512:
+  metadata.gz: d482518642a866fb3c4fd1a45265d494c02e3a2236f5575816cd80bffd9b36d1ac29bba1b21c99a9080eac2d3934c91ec97ba4054cd455f0bbfa50fef36aa075
+  data.tar.gz: 3849c7bdbc3387a1fe4e1d93fabdf65319cf5fda826d5a52bfc99c90ccec9f9763c73febf50026f537e9e9187eb67c216e8acaf41646b866405f8e1503cbfbf9

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/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kenn Ejima
+
+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,51 @@
+# VersionGuard
+
+[![Build Status](https://travis-ci.org/kenn/version_guard.png)](https://travis-ci.org/kenn/version_guard)
+
+A gem-style version checker for Ruby.
+
+```ruby
+VersionGuard.check '2.13.0', '>= 2.2' # => true
+```
+
+VersionGuard has two methods: `abort` and `check`. While `abort` terminates the process if the version requirement is not satisfied, `check` just returns true / false so that you can choose what to do with the failed version.
+
+For instance, suppose you have the following lines in `config/initializers/patches.rb` for a Rails app:
+
+```ruby
+VersionGuard.abort 'ActiveRecord::VERSION::STRING', '3.2.9'
+# Monkey patches for ActiveRecord 3.2.9...
+```
+
+The ruby process terminates immediately with a warning message if the version is not 3.2.9. That way, you can prevent the monkey patch from conflicting with the newer versions of ActiveRecord.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'version_guard'
+```
+
+## Usage
+
+Since VersionGuard uses `Gem::Version` and `Gem::Version::Requirement` internally, any kind of the funky version comparisons that you use with `Gemfile` are supported.
+
+The first argument can be either a version string like `"1.2.3"` or a name that can be converted to the constant that holds the version string. For most gems, it should be something like `GemName::VERSION`.
+
+```ruby
+# As a simple version comparator
+VersionGuard.check '2.13.0', '~> 2.2'
+
+# For mobile app backend
+if VersionGuard.check request.headers['x-ios-app-version'], '< 1.2.1'
+  # Send message "Your mobile app is too old, upgrade now!"
+end
+
+# For capistrano with RVM, in deploy.rb
+require 'version_guard'
+VersionGuard.abort ENV['rvm_version'].split(/\s/).first, '>= 1.18.5'
+
+# Multiple version requirements are supported
+VersionGuard.abort 'MyGem::VERSION', ['> 0.9.0', '< 1.1.0']
+```

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/test*.rb'
+end
+task :default => :test

data/lib/version_guard/version.rb

@@ -0,0 +1,3 @@
+module VersionGuard
+  VERSION = '1.0.0'
+end

data/lib/version_guard.rb

@@ -0,0 +1,64 @@
+require 'version_guard/version'
+
+module VersionGuard
+  class << self
+    def abort(target, requirement, options = {})
+      Checker.new(target, requirement, options).abort_if_fail
+    end
+
+    def check(target, requirement, options = {})
+      Checker.new(target, requirement, options).check
+    end
+  end
+
+  class Checker
+    def initialize(target, requirement, options = {})
+      if target.nil? or requirement.nil? or target.empty? or requirement.empty?
+        raise Error, 'target and requirement cannot be nil'
+      end
+
+      @requirement = requirement
+      @options = options
+
+      @version = begin
+        Gem::Version.new(target) # raise ArgumentError unless target is like '1.2.3'
+        target
+      rescue ArgumentError
+        # constantize string like 'ActiveRecord::VERSION::STRING'
+        names = target.split('::')
+        names.shift if names.empty? || names.first.empty? # Normalize ::TOPLEVEL
+        @options[:name] ||= names.first
+        constant = Object
+        names.each do |name|
+          constant = constant.const_defined?(name) ? constant.const_get(name) : constant.const_missing(name)
+        end
+        constant
+      end
+    end
+
+    def check
+      requirements = @requirement.is_a?(Array) ? @requirement : [@requirement]
+      Gem::Version::Requirement.new(requirements).satisfied_by?(Gem::Version.new(@version))
+    end
+
+    def abort_if_fail
+      if check
+        puts "#{message_base} passed" if @options[:verbose]
+      else
+        trace = caller.find{|i| i !~ /version_checker\.rb/ }
+        filename, lineno = trace.split(':')[0..1]
+        abort "#{message_base} failed - check line #{lineno} in #{filename}"
+      end
+    end
+
+    def message_base
+      if @options[:name]
+        "Version check for #{@options[:name]} (#{@version.inspect} with #{@requirement.inspect})"
+      else
+        "Version check #{@version.inspect} with #{@requirement.inspect}"
+      end
+    end
+  end
+
+  Error = Class.new(StandardError)
+end

data/test/test_version_guard.rb

@@ -0,0 +1,51 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'version_guard'
+
+class TestVersionGuard < MiniTest::Unit::TestCase
+  VERSION = '1.2.3'
+
+  def test_true
+    assert_equal true, VersionGuard.check('1', '1')
+    assert_equal true, VersionGuard.check('1', '= 1')
+    assert_equal true, VersionGuard.check('1', '>= 1')
+    assert_equal true, VersionGuard.check('1', '~> 1')
+    assert_equal true, VersionGuard.check('2', '> 1')
+    assert_equal true, VersionGuard.check('1.0', '>= 1.0')
+    assert_equal true, VersionGuard.check('1.0.0', '>= 0')
+    assert_equal true, VersionGuard.check('1.0.1', '~> 1.0.0')
+    assert_equal true, VersionGuard.check('1.0.0', '< 2.0.0')
+    assert_equal true, VersionGuard.check('1.0.0', ['> 0.9.0', '< 1.1.0'])
+  end
+
+  def test_false
+    assert_equal false, VersionGuard.check('1', '2')
+    assert_equal false, VersionGuard.check('1', '= 2')
+    assert_equal false, VersionGuard.check('1', '>= 2')
+    assert_equal false, VersionGuard.check('1', '~> 2')
+    assert_equal false, VersionGuard.check('2', '> 2')
+    assert_equal false, VersionGuard.check('1.0', '>= 1.1')
+    assert_equal false, VersionGuard.check('1.0.0', '>= 1.0.1')
+    assert_equal false, VersionGuard.check('1.0.1', '~> 1.1')
+    assert_equal false, VersionGuard.check('1.0.0', '> 2.0.0')
+    assert_equal false, VersionGuard.check('1.0.0', ['> 1.0.1', '< 1.1.0'])
+  end
+
+  def test_constants
+    assert_equal true, VersionGuard.check('TestVersionGuard::VERSION', '> 1.0.0')
+    assert_equal false, VersionGuard.check('TestVersionGuard::VERSION', '> 2.0.0')
+    assert_raises(NameError) { VersionGuard.check('a', '> 1.0.0') }
+  end
+
+  def test_nil
+    assert_raises(VersionGuard::Error) { VersionGuard.check(nil, '1') }
+    assert_raises(VersionGuard::Error) { VersionGuard.check('1', nil) }
+    assert_raises(VersionGuard::Error) { VersionGuard.check(nil, nil) }
+  end
+
+  def test_empty_string
+    assert_raises(VersionGuard::Error) { VersionGuard.check('', '') }
+    assert_raises(VersionGuard::Error) { VersionGuard.check('', '1') }
+    assert_raises(VersionGuard::Error) { VersionGuard.check('1', '') }
+  end
+end

data/version_guard.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'version_guard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'version_guard'
+  spec.version       = VersionGuard::VERSION
+  spec.authors       = ['Kenn Ejima']
+  spec.email         = ['kenn.ejima@gmail.com']
+  spec.description   = %q{A gem-style version checker}
+  spec.summary       = %q{A gem-style version checker}
+  spec.homepage      = 'https://github.com/kenn/version_guard'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: version_guard
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kenn Ejima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem-style version checker
+email:
+- kenn.ejima@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/version_guard.rb
+- lib/version_guard/version.rb
+- test/test_version_guard.rb
+- version_guard.gemspec
+homepage: https://github.com/kenn/version_guard
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.2
+signing_key: 
+specification_version: 4
+summary: A gem-style version checker
+test_files:
+- test/test_version_guard.rb