versions.rb 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 78041bf2a4df73df1793b184202621848d58eb03
-  data.tar.gz: 378de3a0716626eb7a5bd0607e387bb5a7c0f4cb
+  metadata.gz: 046f37b7141e3bbca1436bcfdaf16a0be79c721c
+  data.tar.gz: 16f3cc8ed2e379a9cf154cc6add663bc4788060f
 SHA512:
-  metadata.gz: 444f3ef345bd9b74e6b02b9b4c71c0cc4a1ecae6fc497f5179e9548ea4ecc71fd4dd560f020f54d5735601029cac227b7825d87efc47fda42bb25a4365e3e179
-  data.tar.gz: 06ef5277923a34863ef55a03d8e66719fcf9047affd9dac124afed3fb1a9d317f31f6ae22caac473054100575250d334f53e230a7d38c130db8d0c1b6636e599
+  metadata.gz: bee3c591304e503f4ab60cbccfedbbf1d73214cebde7126be572bc5e9ec13ea73ab533bbc56232a321c92ece808a7d4226440d7b0a69c1f74b0d972408be389a
+  data.tar.gz: c5170793897cd54cb037df8cd197ac8dd4abf8121737dbe44464ae7efb76be42dbfd806f11c6da80df065e54c2e8c9b5024f409acb9f09cd908ad11fe3bd2d85

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Sean Callan.
+
+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/lib/versions.rb

@@ -1,6 +1,7 @@
-DEPENDENCIES = %w{versionable configurable file_helpers class_helpers}
-
-DEPENDENCIES.each { |d| require File.join(File.dirname(__FILE__), 'versions', "#{d}.rb") }
+require 'versions/versionable.rb'
+require 'versions/configurable.rb'
+require 'versions/file_helpers.rb'
+require 'versions/class_helpers.rb'
 
 class Versions
   extend Versionable
@@ -9,15 +10,31 @@ class Versions
   include FileHelpers
   include ClassHelpers
 
+  # 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)
   end
 
+  # Public: Sets the base directory for this instance
+  #
+  # path - path to the directory 
+  #
+  # Returns self
   def at(path)
     @path = path
     self
   end
 
+  # Public: Selects a version
+  #
+  # version - a version string
+  #
+  # Returns the versioned Class
+  # Raises VersionNotAvailableError
   def select(version)
     if file = mapped_versions[version]
       load_class(version, file)
@@ -26,26 +43,39 @@ class Versions
     end
   end
 
+  # Public: Whether a version is available or not
+  #
+  # version - a version string
+  #
+  # Returns a Boolean
   def available?(version)
     !!mapped_versions[version]
   end
 
+  # Public: Get the available versions
+  #
+  # Returns an Array of version strings
   def versions
     mapped_versions.keys.sort
   end
 
   protected
 
+  # Internal: Create a new instance
+  #
+  # mod - Symbol or String of the library name
+  #
+  # Returns a new instance
   def initialize(mod)
     @library_name = mod.to_s
   end
 
+  # Internal: An internal map of versions and their respective files,
+  # the Hash keys are version strings and files as value. 
+  #
+  # Returns a Hash
   def mapped_versions
     @file_version_mapping ||= map_file_versions
   end
-
-  def config
-    Versions.config
-  end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: versions.rb
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - doomspork
@@ -14,16 +14,16 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.12.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.12.6
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
@@ -66,13 +66,15 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.2
-description: Versions.rb provides a simple means to loading versioned libraries.
+description: Versions.rb provides a simple method for handling libraries that require
+  versioning.
 email: iamdoomspork@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - lib/versions.rb
+- LICENSE
 homepage: https://github.com/doomspork/versions.rb
 licenses:
 - MIT
@@ -85,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - '>='
@@ -96,6 +98,6 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Library versioning made simple.
+summary: Ruby class versioning made simple.
 test_files: []
 has_rdoc: