ruby_version_reader 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78c1f3b88afaaf0f0db9269eeb7cb732f203b412
+  data.tar.gz: 5e0249a48e804eea1bec2193faa345e12b5326ec
+SHA512:
+  metadata.gz: 79b94c053902dbe9fbf7327c02b50e4b91f41e94a968ee508f698ba1fd95452343418592942217994379fba14a2526e3de2fa8aceb1ff467f9c786a07ed1c005
+  data.tar.gz: 303d4ac392a8c34ea5058398bdc15f5c90c24b259ed754aa7884953b88d6ac42a0eb296415e8028783abf5b2ec870df75a785a84f0bcfe43eb8a316f977c7b61

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+pkg

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+
+rvm:
+#- ruby-head (travis error)
+- 2.1.0
+- 2.0.0
+- 1.9.3
+- 1.9.2
+- 1.8.7
+- ree
+- jruby
+- jruby-19mode
+- jruby-18mode
+- rbx

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change Log
+
+## 0.1.0 - 2014-12-03
+### Added
+- Initial Release with tested rvm support

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+platform :rbx do
+  gem 'rubysl-date'
+  gem 'rubysl-singleton'
+end
+

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    ruby_version_reader (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    json (1.8.1)
+    rake (10.4.1)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.2)
+    rubygems-tasks (0.2.4)
+    rubysl-date (2.0.8)
+    rubysl-singleton (2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0)
+  rake (~> 10.1)
+  rdoc (~> 3.0)
+  rspec (~> 2.4)
+  ruby_version_reader!
+  rubygems-tasks (~> 0.2)
+  rubysl-date
+  rubysl-singleton

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Marcos Wright-Kuhns
+
+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.rdoc

@@ -0,0 +1,50 @@
+= RubyVersionReader
+
+Provides a +RubyVersionReader+ to simplify reading of +.ruby-version+ and +.ruby-gemset+ files in your programs.
+
+== Setup
+
+On your command-line:
+
+    $ gem install ruby_version_reader
+
+In Ruby:
+
+    require 'ruby_version_reader'
+
+== Usage
+
+    # Initialize your reader
+    reader = RubyVersionReader.new
+
+    # The current base path where .ruby-version files are being looked for
+    reader.path
+
+    # Access .ruby-version and .ruby-gemset data
+    reader.to_s #=> 'ruby-1.8.7-p249@rvr_gemset'
+    reader.full_version #=> '1.8.7-p249'
+    reader.gemset #=> 'rvr_gemset'
+
+    # Check for the main version with a Float
+    reader.is? 2.1
+
+    # Use strings for exacter checking
+    reader.is.above '1.9.2-p330'
+    reader.is.at_least '2.0.0' # or exactly, below, at_most
+
+    # You can use the common comparison operators
+    reader >= '1.8.7'
+    reader.between? '1.8.7', '1.9.2'
+
+    # Misc Accessors
+    reader.engine #=> 'ruby'
+    reader.major # => 1
+    reader.minor # => 8
+    reader.tiny  # => 7
+    reader.patchlevel # => 249
+
+== Credit
+
+Basic RubyVersionReader comparison logic from https://github.com/janlelis/ruby_version which originated from the zucker gem.
+
+Copyright (c) 2014 Marcos Wright-Kuhns. MIT License.

data/Rakefile

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  warn e.message
+  warn "Run `gem install bundler` to install Bundler."
+  exit -1
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn "Run `bundle install` to install missing gems."
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.title = "ruby_version"
+end
+task :doc => :rdoc
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :test    => :spec
+task :default => :spec

data/lib/ruby_version_reader.rb

@@ -0,0 +1,146 @@
+require 'date'
+require 'time'
+
+class RubyVersionReader
+  VERSION = '0.1.0'
+
+  attr_accessor :path, :environment_manager
+
+  def initialize(given_path, given_environment_manager = 'rvm')
+    given_path = './' if given_path.empty?
+    @path = File.expand_path(given_path)
+
+    @environment_manager = given_environment_manager
+  end
+
+  def to_s
+    return @to_s if @to_s
+
+    @to_s = "#{engine}-#{full_version}"
+    @to_s += "@#{gemset}" unless gemset.empty?
+
+    @to_s
+  end
+  alias inspect to_s
+
+  def gemset
+    read_ruby_gemset_file
+  end
+
+  def environment_manager_load_string
+    case environment_manager
+    when 'rvm'
+      "rvm use #{to_s}"
+    when 'rbenv'
+      "RBENV_VERSION=#{to_s}"
+    when 'chruby'
+      "chruby-exec #{to_s} --"
+    else
+      raise "Unsupported environment_manager: #{environment_manager.inspect}"
+    end
+  end
+
+  # comparable
+  def <=>(other)
+    value = case other
+      when Integer
+        major.to_i
+      when Float
+        full_version.to_f
+      when String
+        other_engine = extract_engine_from_string(other)
+
+        if engine == other_engine
+          other = extract_full_version_from_string(other)
+          full_version
+        else
+          return engine <=> other_engine
+        end
+      else
+        # A tiny bit of recursion
+        return self <=> other.to_s
+      end
+    value <=> other
+  end
+  include Comparable
+
+  # chaining for dsl-like language
+  def is?(other = nil)
+    if other
+      self == other
+    else
+      self
+    end
+  end
+  alias is is?
+
+  # aliases
+  alias below     <
+  alias below?    <
+  alias at_most   <=
+  alias at_most?  <=
+  alias above     >
+  alias above?    >
+  alias at_least  >=
+  alias at_least? >=
+  alias exactly   ==
+  alias exactly?  ==
+  def not(other)
+    self != other
+  end
+  alias not?     not
+  alias between between?
+
+  # accessors
+  def engine
+    @engine ||= extract_engine_from_string(read_ruby_version_file)
+  end
+
+  def full_version
+    @full_version ||= extract_full_version_from_string(read_ruby_version_file)
+  end
+
+  def major
+    full_version.to_i
+  end
+  alias main major
+
+  def minor
+    full_version.split('.')[1].to_i
+  end
+  alias mini minor
+
+  def tiny
+    full_version.split('.')[2].to_i
+  end
+  alias teeny tiny
+
+  def patchlevel
+    full_version.split('-')[1].to_s
+  end
+
+  private
+
+  def extract_engine_from_string(value)
+    value = value.gsub(/\-?#{Regexp.escape(extract_full_version_from_string(value))}/, '')
+    value.empty? ? 'ruby' : value
+  end
+
+  def extract_full_version_from_string(value)
+    value.gsub(/\A(\D+\-p?)?/, '')
+  end
+
+  def read_ruby_version_file
+    version_path = File.join(path, '.ruby-version')
+    File.exists?(version_path) ? read_and_strip(version_path) : ''
+  end
+
+  def read_ruby_gemset_file
+    gemset_path = File.join(path, '.ruby-gemset')
+    File.exists?(gemset_path) ? read_and_strip(gemset_path) : ''
+  end
+
+  def read_and_strip(file_path)
+    File.read(file_path).strip
+  end
+end

data/ruby_version_reader.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/ruby_version_reader', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "ruby_version_reader"
+  gem.version       = RubyVersionReader::VERSION
+  gem.summary       = 'Read .ruby-version and .ruby-gemset files.'
+  gem.description   = 'Provides a RubyVersionReader class to simplify reading the .ruby-version and .ruby-gemset files.'
+  gem.license       = "MIT"
+  gem.authors       = ["Marcos Wright-Kuhns"]
+  gem.email         = "marcos@wrightkuhns.com"
+  gem.homepage      = "https://github.com/metavida/ruby_version_reader"
+
+  gem.files         = Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency 'rake', '~> 10.1'
+  gem.add_development_dependency 'rdoc', '~> 3.0'
+  gem.add_development_dependency 'rspec', '~> 2.4'
+  gem.add_development_dependency 'rubygems-tasks', '~> 0.2'
+end

data/spec/ruby_version_reader_spec.rb

@@ -0,0 +1,84 @@
+require 'spec_helper'
+
+describe 'RubyVersionReader' do
+  before :all do
+    @remember_version = RUBY_VERSION
+    capture_stderr{ RUBY_VERSION = '1.8.7' }
+  end
+
+  it 'should display RUBY_VERSION if called directly (to_s)' do
+    RubyVersionReader.to_s.should == '1.8.7'
+  end
+
+  context 'with "is" method, with parameter' do
+    it 'should check for main version (1.8 or 1.9) when Float paramater is given' do
+      RubyVersionReader.is?( 1.8 ).should == true
+      RubyVersionReader.is?( 1.9 ).should == false
+    end
+
+    it 'should check with string comparison if parameter is not Float' do
+      RubyVersionReader.is?( '1.8' ).should == false
+    end
+  end
+
+  context 'with "is" method, without parameter, but method chaining' do
+    it 'should return a string for usage with comparison operators' do
+      (RubyVersionReader.is > '1.8.7').should == false
+      (RubyVersionReader <= '1.8.7').should == true
+      (RubyVersionReader.is.between? '1.8.6', '1.8.7').should == true
+    end
+
+    it 'should create some handy compare aliases' do
+      RubyVersionReader.is.above( '1.8.7' ).should == false
+      RubyVersionReader.is.at_least( '1.8.7' ).should == true
+      RubyVersionReader.is.exactly( '1.8.7' ).should == true
+    end
+
+    it 'also allows to check for the release dates' do
+      RubyVersionReader.is.older_than( Date.today ).should == true
+      RubyVersionReader.is.newer_than( '2000-01-01' ).should == true
+    end
+  end
+
+  it 'should define some accessors' do
+    RubyVersionReader.major.should == 1
+    RubyVersionReader.minor.should == 8
+    RubyVersionReader.tiny.should == 7
+    RubyVersionReader.patchlevel.should == RUBY_PATCHLEVEL
+    RubyVersionReader.description.should == RUBY_DESCRIPTION
+  end
+
+  context 'with "gemset" method' do
+    it 'should return an empty string by default' do
+      RubyVersionReader.gemset.should == ''
+    end
+
+    it 'should work with a .ruby-gemset file' do
+      path = '.ruby-gemset'
+      given_gemset_name = 'ruby_version_rspec_gemset'
+      begin
+        # Given
+        File.open(path, 'w') { |file| file << given_gemset_name + "\n\n" }
+
+        # When/Then
+        RubyVersionReader.gemset.should == given_gemset_name
+      ensure
+        File.delete(path)
+      end
+    end
+
+    it 'should work by calling `rvm info`' do
+      given_gemset_name = 'ruby_version_rspec_gemset'
+
+      Object.should_receive(:`) {
+        YAML.dump({ 'ruby-version@ruby-gemset' => { 'environment' => { 'gemset' => given_gemset_name } } })
+      }
+
+      puts RubyVersionReader.gemset#.should == given_gemset_name
+    end
+  end
+
+  after :all do
+    capture_stderr{ RUBY_VERSION = @remember_version }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'ruby_version_reader'
+
+require 'rspec'
+require 'stringio'
+
+def capture_stdout
+  capture = StringIO.new
+  restore, $stdout = $stdout, capture
+  yield
+  $stdout = restore
+  capture.string
+end
+
+def capture_stderr
+  capture = StringIO.new
+  restore, $stderr = $stderr, capture
+  yield
+  $stderr = restore
+  capture.string
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: ruby_version_reader
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcos Wright-Kuhns
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Provides a RubyVersionReader class to simplify reading the .ruby-version
+  and .ruby-gemset files.
+email: marcos@wrightkuhns.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/ruby_version_reader.rb
+- ruby_version_reader.gemspec
+- spec/ruby_version_reader_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/metavida/ruby_version_reader
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Read .ruby-version and .ruby-gemset files.
+test_files:
+- spec/ruby_version_reader_spec.rb
+- spec/spec_helper.rb