semver_stringer 0.1.0 → 0.1.1

data/.gitignore

@@ -2,3 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
+.yardoc/*
+doc/*

data/HISTORY.md

@@ -0,0 +1,7 @@
+## 0.1.1 (2012-02-29)
+
+* Added some Yard doc comments
+
+## 0.1.0 (2012-02-23)
+
+* First release

data/README.md

@@ -22,3 +22,4 @@ Gives you a little help with your [semver](http://semver.org/) strings.
 ## TODO
 
 * Comparison operators to implement the ordering as laid out in the semver spec.
+* Constructor taking string parameter for parsing and initialization

data/lib/semver_stringer/semver.rb

@@ -1,12 +1,26 @@
 module SemverStringer
 	class Semver
 
+    # Creates a new Semver instance.
+    #
+    # @param [Hash] params the options to create a message with.
+    # @option params [Integer] :major Major version number 
+    # @option params [Integer] :minor Minor version number
+    # @option params [Integer] :patch Patch version number
+    # @option params [String, Integer, Array<String, Integer>] :pre Pre-release identifier(s)
+    # @option params [String, Integer, Array<String, Integer>] :build Build number identifier(s)
 		def initialize(params={})
 			@major, @minor, @patch = get_version_numbers_from params
 			@build = get_build_string_from params
 			@pre = get_pre_string_from params
 		end
 
+    # Returns a string representation of the SemVer
+    #
+    # @example
+    #   SemverStringer::Semver.new(:major=>2, :pre=>"alpha").to_s  #=> "2.0.0-alpha"
+    #
+    # @return [String]
 		def to_s
 			version = "#{@major}.#{@minor}.#{@patch}"
 			version << "-#{@pre}" unless @pre == nil

data/lib/semver_stringer/version.rb

@@ -1,3 +1,3 @@
 module SemverStringer
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: semver_stringer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-24 00:00:00.000000000 Z
+date: 2012-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70208392024840 !ruby/object:Gem::Requirement
+  requirement: &70278852677040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *70208392024840
+  version_requirements: *70278852677040
 description: See semver.org for the rules, or https://github.com/iantruslove/SemverStringer#readme
   for a little documentation.
 email:
@@ -33,6 +33,7 @@ files:
 - .gitignore
 - 00notes.md
 - Gemfile
+- HISTORY.md
 - README.md
 - Rakefile
 - lib/semver_stringer.rb
@@ -66,3 +67,4 @@ specification_version: 3
 summary: Makes nice strings for your SemVer needs
 test_files:
 - spec/semver_spec.rb
+has_rdoc: