versions.rb 0.1.1 → 1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 046f37b7141e3bbca1436bcfdaf16a0be79c721c
-  data.tar.gz: 16f3cc8ed2e379a9cf154cc6add663bc4788060f
+  metadata.gz: 3fac1013f437cd729493033b888daa6876e4240e
+  data.tar.gz: 7565ddf6130285ba36e2d527e604a213907afcee
 SHA512:
-  metadata.gz: bee3c591304e503f4ab60cbccfedbbf1d73214cebde7126be572bc5e9ec13ea73ab533bbc56232a321c92ece808a7d4226440d7b0a69c1f74b0d972408be389a
-  data.tar.gz: c5170793897cd54cb037df8cd197ac8dd4abf8121737dbe44464ae7efb76be42dbfd806f11c6da80df065e54c2e8c9b5024f409acb9f09cd908ad11fe3bd2d85
+  metadata.gz: cb9fe45414b32700606c4eae1e6a2881722a7cf54d7b276ec516a75a71db93cbdc3a9c57681d121547428a8201a27278b4ee2e5bd0f15a32188845b4a2cb3ffb
+  data.tar.gz: 7836b77b3f8281022134c507d544ce08adfc31142a34f74ef14f6c531b6c5e992eaf197647169482297a91b91758073efd987350ca9df043dcfccfe80207d6f4

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+.rvmrc

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - ruby-head
+  - jruby-head
+jdk:
+  - openjdk7
+  - oraclejdk7
+  - openjdk6
+script: rspec
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head

data/Gemfile

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

data/README.md

@@ -0,0 +1,63 @@
+# Versions.rb
+
+_"Ruby class versioning made simple."_
+
+[![Gem Version](https://badge.fury.io/rb/versions.rb.png)](https://rubygems.org/gems/versions.rb) [![Build Status](https://travis-ci.org/doomspork/versions.rb.png?branch=master)](https://travis-ci.org/doomspork/versions.rb) [![Code Climate](https://codeclimate.com/github/doomspork/versions.rb.png)](https://codeclimate.com/github/doomspork/versions.rb) [![Coverage Status](https://coveralls.io/repos/doomspork/versions.rb/badge.png?branch=master)](https://coveralls.io/r/doomspork/versions.rb)
+
+Ruby 1.9, 2.0, 2.1, and JRuby supported.
+
+## Quickstart
+
+Install it:
+
+`gem install versions.rb`
+
+Create a version (`lib/v1.0/awesome_feature.rb`):
+
+```ruby
+module V1_0
+  class AwesomeFeature
+    def foo
+      :bar
+    end
+  end
+end
+```
+
+Use it:
+
+```ruby
+VersionedFeature = Versions.for(:awesome_feature).select('1.0')
+feature          = VersionedFeature.new
+```
+
+## Configuration
+
+#### File locations
+By default Versions.rb will try to use a `lib/` directory within the project root, you can override this:
+
+```ruby
+Versions.config.base_dir = 'dir_path_of_your_choosing'
+```
+
+Alternatively you can override the `base_dir` for a single call as such:
+
+```ruby
+Versions.for(:awesome_feature).at('./other/location').select('1.0')
+```
+
+## Contributing
+
+Please make appropriate use of [Issues][issues] and [Pull Requests][pr]. All code should have accompanying tests.
+
+## Author/Contact
+
+Versions.rb is written and maintained by [@doomspork](https://github.com/doomspork)
+
+## License
+
+Versions.rb is made available under the [MIT][mit] license.
+
+[issues]: https://github.com/doomspork/versions.rb/issues
+[pr]: https://github.com/doomspork/versions.rb/pulls
+[mit]: LICENSE

data/lib/versionable.rb

@@ -0,0 +1,51 @@
+module Versionable
+  extend Forwardable
+
+  DEFAULT_PATH = File.join(File.dirname(__FILE__), '')
+
+  def_delegators :@versions, :versions, :available?, :select
+
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+    def instance_of!(version, *args)
+      version         = version.to_sym
+      versioned_class = loaded_versions[version]
+      instance        = versioned_class.new(*args)
+      instance.instance_variable_set(:@instance_version, version)
+      instance
+    end
+
+    def instance_of(version, *args)
+      begin
+        instance_of!(version, args)
+      rescue Versions::VersionNotAvailableError
+        nil
+      end
+    end
+
+    def versions_path(path)
+      @versions_path = path
+    end
+
+    private
+
+    def versions_directory
+      @versions_path || DEFAULT_PATH
+    end
+
+    def loaded_versions
+      @loaded_versions ||= Hash.new { |hash, key| hash[key] = versions_rb.select(key) }
+    end
+   
+    def versions_rb
+      @versions_rb ||= Versions.for(self.name).at(versions_directory)
+    end
+  end
+
+  def version
+    @instances_version
+  end
+end

data/lib/versions.rb

@@ -1,27 +1,29 @@
-require 'versions/versionable.rb'
+require 'versionable.rb'
 require 'versions/configurable.rb'
 require 'versions/file_helpers.rb'
 require 'versions/class_helpers.rb'
+require 'versions/string_helpers.rb'
+require 'versions/errors/version_not_available.rb'
 
 class Versions
-  extend Versionable
   extend Configurable
 
   include FileHelpers
   include ClassHelpers
+  include StringHelpers
 
   # Public: Sets up and returns a new instance
   #
   # mod - Symbol or String of the library name
   #
   # Returns an instance of Versions
-  def self.for(mod)
-    new(mod)
+  def self.for(library)
+    new(library)
   end
 
   # Public: Sets the base directory for this instance
   #
-  # path - path to the directory 
+  # path - path to the directory
   #
   # Returns self
   def at(path)
@@ -36,6 +38,7 @@ class Versions
   # Returns the versioned Class
   # Raises VersionNotAvailableError
   def select(version)
+    version = version.to_sym
     if file = mapped_versions[version]
       load_class(version, file)
     else
@@ -49,7 +52,7 @@ class Versions
   #
   # Returns a Boolean
   def available?(version)
-    !!mapped_versions[version]
+    !!mapped_versions[version.to_sym]
   end
 
   # Public: Get the available versions
@@ -63,15 +66,15 @@ class Versions
 
   # Internal: Create a new instance
   #
-  # mod - Symbol or String of the library name
+  # library - Symbol or String of the library name
   #
   # Returns a new instance
-  def initialize(mod)
-    @library_name = mod.to_s
+  def initialize(library)
+    @library_name = snake_case(library.to_s)
   end
 
   # Internal: An internal map of versions and their respective files,
-  # the Hash keys are version strings and files as value. 
+  # the Hash keys are version strings and files as value.
   #
   # Returns a Hash
   def mapped_versions

data/lib/versions/class_helpers.rb

@@ -0,0 +1,34 @@
+class Versions
+  module ClassHelpers
+    protected
+
+    # Internal: The ClassName of the Library
+    #
+    # Returns a String
+    def library_name
+      camel_case(@library_name)
+    end
+
+    # Internal: Get the fully qualified class name with version
+    #
+    # version - the version selected
+    #
+    # Returns a String
+    def versioned_class_name(version)
+      safe_version = version.to_s.gsub(/\./, '_')
+      "#{Versions.config.class_prefix}#{safe_version}::#{library_name}"
+    end
+
+    # Internal: Load and return the Class
+    #
+    # version - the selected version
+    # file    - the file path
+    #
+    # Returns a Class
+    def load_class(version, file)
+      require file
+      name = versioned_class_name(version)
+      name.split('::').inject(Object) { |obj, klz| obj.const_get(klz) }
+    end
+  end
+end

data/lib/versions/configurable.rb

@@ -0,0 +1,32 @@
+class Versions
+  module Configurable
+
+    # A simple configuration wrapper
+    class Config
+      attr_accessor :base_dir, :version_pattern, :class_prefix
+
+      # The default base directory path
+      BASE_DIR         = File.join(Dir.pwd, 'lib')
+      # The default filename pattern
+      VERSION_PATTERN  = /v(?:ersion)?[-_]?((\d+(?:\.\d+)*))/i
+      # The default class prefix
+      CLASS_PREFIX     = 'V'
+
+      # Public: Create a new instance with default values
+      #
+      # Returns a new instance
+      def initialize
+        self.base_dir         = BASE_DIR
+        self.version_pattern  = VERSION_PATTERN
+        self.class_prefix     = CLASS_PREFIX
+      end
+    end
+
+    # Public: Versions.rb configuration instance
+    #
+    # Returns an instance of Config
+    def config
+      @config ||= Config.new
+    end
+  end
+end

data/lib/versions/errors/version_not_available.rb

@@ -0,0 +1,4 @@
+class Versions
+  class VersionNotAvailableError < Exception
+  end
+end

data/lib/versions/file_helpers.rb

@@ -0,0 +1,31 @@
+class Versions
+  module FileHelpers
+    protected
+
+    # Internal: Parse a file path into a version string
+    #
+    # path - the file path to parse
+    #
+    # Returns a version String or nil
+    def parse_filepath(path)
+      (match = Versions.config.version_pattern.match(path)) ? match[1] : nil
+    end
+
+    # Internal: Create a map of versions and files
+    #
+    # Returns a Hash
+    def map_file_versions
+      file_path = File.join(path, '**', "#{@library_name}.rb")
+      files = Dir[file_path] || {}
+      files.inject({}) do |memo, path|
+        version_key = parse_filepath(path)
+        memo[version_key.to_sym] = path if version_key
+        memo
+      end
+    end
+
+    def path
+      @path ||= Versions.config.base_dir
+    end
+  end
+end

data/lib/versions/string_helpers.rb

@@ -0,0 +1,26 @@
+class Versions
+  module StringHelpers
+    # Internal: Make a String CamelCase
+    #
+    # str- to make CamelCase String
+    #
+    # Returns a String
+    def camel_case(str)
+      str.to_s.split(/[ _]/).map(&:capitalize).join('')
+    end
+
+    # Internal: Make a String snake_case 
+    # Implementation borrowed from ActiveSupport
+    #
+    # str - to make snake_case String
+    #
+    # Returns a String
+    def snake_case(str)
+      str.gsub(/::/, '/').
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+    end
+  end
+end

data/spec/fixtures/v1/sample_library.rb

@@ -0,0 +1,7 @@
+module V1
+  class SampleLibrary
+    def version
+      '1'
+    end
+  end
+end

data/spec/fixtures/v2.1/sample_library.rb

@@ -0,0 +1,14 @@
+module V2_1
+  class SampleLibrary
+    attr_accessor :one, :two
+
+    def initialize(one = 1, two = 2)
+      self.one = one
+      self.two = two
+    end
+
+    def version
+      '2.1'
+    end
+  end
+end

data/spec/fixtures/v3.2.1/sample_library.rb

@@ -0,0 +1,7 @@
+module V3_2_1
+  class SampleLibrary
+    def version
+      '3.2.1'
+    end
+  end
+end

data/spec/lib/versionable_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+class SampleLibrary
+  include Versionable
+
+  versions_path File.join(File.dirname(__FILE__), '..', 'fixtures')
+end
+
+describe Versionable do
+  subject { SampleLibrary }
+
+  describe '.instance_of!' do
+    context 'with available version' do
+      it 'will return the class' do
+        vers = subject.instance_of!('2.1')
+        expect(vers.version).to eql '2.1'
+        expect(vers).to instance_of V2_1::SampleLibrary
+      end
+
+      context 'with additional paramaters' do
+        it 'will pass them to the constructor' do
+          vers = subject.instance_of!('2.1', 0, 0)
+          expect(vers.one).to eql 0
+          expect(vers.two).to eql 0
+        end
+      end
+    end
+
+    context 'with missing version' do
+      it 'will be raise an error' do
+        expect { subject.instance_of!('4.2.0') }.to raise_error Versions::VersionNotAvailableError
+      end
+    end
+  end
+
+  describe '.instance_of' do
+    context 'with missing version' do
+      it 'will return nil' do
+        vers = subject.instance_of('4.2.0')
+        expect(vers).to be_nil
+      end
+    end
+  end
+
+end

data/spec/lib/versions_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe Versions do
+  subject { Versions.for(:sample_library) }
+
+  let(:fixture_path) { File.join(File.dirname(__FILE__), '..', 'fixtures') }
+
+  before { Versions.config.base_dir = fixture_path }
+
+  describe '#available?' do
+    context 'with existing version' do
+      it 'will be true' do
+        avail = subject.available? '1'
+        expect(avail).to be_truthy
+      end
+    end
+
+    context 'with missing version' do
+      it 'will be false' do
+        avail = subject.available? '4.2.0'
+        expect(avail).to be_falsey
+      end
+    end
+  end
+
+  describe '#versions' do
+    it 'returns an Array of available versions' do
+      vers = subject.versions
+      expect(vers.size).to eql 3
+    end
+  end
+
+  describe '#at' do
+    before { Versions.config.base_dir = nil }
+
+    it 'will override the base dir for this instance' do
+      vers = subject.at(fixture_path).versions
+      expect(vers.size).to eql 3
+    end
+  end
+
+  describe '#select' do
+    context 'with available version' do
+      it 'will return the class' do
+        vers = subject.select('2.1')
+        expect(vers).to eql V2_1::SampleLibrary
+      end
+    end
+
+    context 'with missing version' do
+      it 'will be raise an error' do
+        expect { subject.select('4.2.0') }.to raise_error
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'simplecov'
+require 'pry'
+
+ENV['RACK_ENV'] = 'test'
+
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter if defined?(Coveralls)
+
+# Configure code coverage reporting
+SimpleCov.start do
+  add_filter '/spec/'
+  coverage_dir 'docs/coverage'
+end
+
+require 'versions'
+
+Dir['./spec/support/**/*.rb'].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_framework = :rr
+end

data/versions.rb.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |s|
+  s.name        = 'versions.rb'
+  s.version     = '1.0' 
+  s.summary     = 'Support for versioned class definitions.'
+  s.description = 'Using simple namespacing Versions.rb lets you load versions of your code on-demand.'
+  s.authors     = ['Sean Callan']
+  s.email       = 'seancallan@gmail.com'
+  s.homepage    = 'https://github.com/doomspork/versions.rb'
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ['lib']
+
+  s.required_ruby_version = '> 1.9'
+
+  s.add_development_dependency 'bundler',     '~> 1.7'
+  s.add_development_dependency 'coveralls',   '~> 0.7' unless RUBY_PLATFORM =~ /java/
+  s.add_development_dependency 'pry',         '~> 0.10'
+  s.add_development_dependency 'rake',        '~> 10.0'
+  s.add_development_dependency 'rr',          '~> 1.1.2'
+  s.add_development_dependency 'rspec',       '~> 3.1'
+  s.add_development_dependency 'simplecov',   '~> 0.9'
+end

metadata

@@ -1,29 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: versions.rb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '1.0'
 platform: ruby
 authors:
-- doomspork
+- Sean Callan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-03 00:00:00.000000000 Z
+date: 2015-04-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.12.6
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.9.12.6
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
@@ -44,37 +86,54 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.2
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.2
-description: Versions.rb provides a simple method for handling libraries that require
-  versioning.
-email: iamdoomspork@gmail.com
+        version: '0.9'
+description: Using simple namespacing Versions.rb lets you load versions of your code
+  on-demand.
+email: seancallan@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/versions.rb
+- .gitignore
+- .travis.yml
+- Gemfile
 - LICENSE
+- README.md
+- lib/versionable.rb
+- lib/versions.rb
+- lib/versions/class_helpers.rb
+- lib/versions/configurable.rb
+- lib/versions/errors/version_not_available.rb
+- lib/versions/file_helpers.rb
+- lib/versions/string_helpers.rb
+- spec/fixtures/v1/sample_library.rb
+- spec/fixtures/v2.1/sample_library.rb
+- spec/fixtures/v3.2.1/sample_library.rb
+- spec/lib/versionable_spec.rb
+- spec/lib/versions_spec.rb
+- spec/spec_helper.rb
+- versions.rb.gemspec
 homepage: https://github.com/doomspork/versions.rb
 licenses:
 - MIT
@@ -85,9 +144,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -95,9 +154,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: Ruby class versioning made simple.
-test_files: []
+summary: Support for versioned class definitions.
+test_files:
+- spec/fixtures/v1/sample_library.rb
+- spec/fixtures/v2.1/sample_library.rb
+- spec/fixtures/v3.2.1/sample_library.rb
+- spec/lib/versionable_spec.rb
+- spec/lib/versions_spec.rb
+- spec/spec_helper.rb
 has_rdoc: