semver_stringer 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/00notes.md

@@ -0,0 +1,5 @@
+# Notes
+
+Best practices for making gems: <http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices>
+
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in semverstringer.gemspec
+gemspec

data/README.md

@@ -0,0 +1,24 @@
+# SemverStringer #
+
+Gives you a little help with your [semver](http://semver.org/) strings. 
+
+## Usage
+
+		require 'semver_stringer'
+		
+		semver = SemverStringer::Semver.new
+		semver.to_s 	# => "0.0.1"
+
+		version_info = { 
+			:major=>2,  # integer, >= 0
+			:minor=>1,  # integer, >= 0
+			:patch=>13, # integer, >= 0
+			:pre=>["alpha", 1],  # string ([A-Za-z0-9-]*), integer >=0, or list of these
+			:build=>2134         # string ([A-Za-z0-9-]*), integer >=0, or list of these	
+		}
+		semver = SemverStringer::Semver.new version_info
+		semver.to_s 	# => "2.1.13-alpha.1+2134"
+
+## TODO
+
+* Comparison operators to implement the ordering as laid out in the semver spec.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/semver_stringer/semver.rb

@@ -0,0 +1,78 @@
+module SemverStringer
+	class Semver
+
+		def initialize(params={})
+			@major, @minor, @patch = get_version_numbers_from params
+			@build = get_build_string_from params
+			@pre = get_pre_string_from params
+		end
+
+		def to_s
+			version = "#{@major}.#{@minor}.#{@patch}"
+			version << "-#{@pre}" unless @pre == nil
+			version << "+#{@build}" unless @build == nil
+			version
+		end
+
+		private
+		def raise_if_invalid_version_number(hash, key)
+			if hash.has_key? key
+				raise ArgumentError.new("Positive integers only") if hash[key] < 0
+				raise ArgumentError.new("Integral numbers only") if ! hash[key].integer? 
+			end
+		end
+
+		private
+		def get_valid_version_number(hash, key) 
+			raise_if_invalid_version_number(hash, key)
+			(hash.has_key? key) ? hash[key] : 0
+		end
+
+		private
+		def get_version_numbers_from(params)
+			if (params.has_key? :major) || (params.has_key? :minor) || (params.has_key? :patch)
+				major = get_valid_version_number(params, :major)
+				minor = get_valid_version_number(params, :minor)
+				patch = get_valid_version_number(params, :patch)
+			else
+				major = minor = 0
+				patch = 1
+			end
+
+			[major, minor, patch]
+		end
+
+		private
+		def get_pre_string_from(params) 
+			return get_optional_string_from params, :pre
+		end
+
+		private
+		def get_build_string_from(params) 
+			return get_optional_string_from params, :build
+		end
+
+		private
+		def get_optional_string_from(params, type)
+			disallowed_chars = /[^0-9A-Za-z-]/
+
+			if params.has_key? type
+				identifiers = scalar_to_array params[type]
+					
+				identifiers.each do |param|
+					raise ArgumentError.new("Characters in #{type} ID are not allowed") if disallowed_chars.match param.to_s
+				end
+
+				return identifiers.join "."
+			else
+				return nil
+			end
+		end
+	
+		private 
+		def scalar_to_array(scalar)
+			(scalar.is_a? Array) ? scalar : Array.new(1, scalar)
+		end
+	end
+end
+

data/lib/semver_stringer/version.rb

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

data/lib/semver_stringer.rb

@@ -0,0 +1,6 @@
+require "semver_stringer/version"
+require "semver_stringer/semver"
+
+module SemverStringer
+  # Your code goes here...
+end

data/semver_stringer.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "semver_stringer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "semver_stringer"
+  s.version     = SemverStringer::VERSION
+  s.authors     = ["Ian Truslove"]
+  s.email       = ["ian.truslove@gmail.com"]
+  s.homepage    = "https://github.com/iantruslove/SemverStringer"
+  s.summary     = %q{Makes nice strings for your SemVer needs}
+  s.description = %q{See semver.org for the rules, or https://github.com/iantruslove/SemverStringer#readme for a little documentation.}
+
+#  s.rubyforge_project = "semverstringer"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+  
+  s.add_development_dependency "rspec", "~> 2.8"
+end

data/spec/semver_spec.rb

@@ -0,0 +1,106 @@
+require 'semver_stringer/semver'
+
+describe SemverStringer::Semver do
+	describe "parameterless construction" do
+		it "can be initialized with no parameters" do 
+			semver = SemverStringer::Semver.new 
+		end
+
+		it "will output a default version string of 0.0.1" do
+			semver = SemverStringer::Semver.new 
+			semver.to_s.should == "0.0.1"
+		end
+	end
+
+	describe "parameterized construction" do
+		it "can be constructed with integer parameter for major version" do
+			semver = SemverStringer::Semver.new :major => 1
+			semver.to_s.should == "1.0.0"
+		end
+
+		it "can be constructed with integer parameter for minor version" do
+			semver = SemverStringer::Semver.new :minor => 2
+			semver.to_s.should == "0.2.0"
+		end
+
+		it "can be constructed with integer parameter for patch version" do
+			semver = SemverStringer::Semver.new :patch => 23
+			semver.to_s.should == "0.0.23"
+		end
+
+		it "can be constructed with combinations of major, minor and patch versions" do
+			semver = SemverStringer::Semver.new :major=>2, :minor=>4, :patch=>20
+			semver.to_s.should == "2.4.20"
+		end
+	end
+
+	describe "invalid initialization values" do
+		it "should only allow positive version number components" do
+			lambda { SemverStringer::Semver.new :minor=>-1 }.should raise_error(ArgumentError)
+		end
+
+		it "should only allow numeric version number components" do
+			lambda { SemverStringer::Semver.new :minor=>"a" }.should raise_error(ArgumentError)
+		end
+
+		it "should only allow integral version number components" do
+			lambda { SemverStringer::Semver.new :minor=>1.2 }.should raise_error(ArgumentError)
+		end
+	end
+
+	describe "optional pre-release identifier" do
+		it "can take an integer pre-release identifier" do
+			semver = SemverStringer::Semver.new :pre=>1
+			semver.to_s.should == "0.0.1-1"
+		end
+
+		it "can take alphanumeric pre-release id" do
+			semver = SemverStringer::Semver.new :major=>2, :pre=>"alpha"
+			semver.to_s.should == "2.0.0-alpha"
+		end
+
+		it "can accept a list of pre-release identifiers" do
+			semver = SemverStringer::Semver.new :minor=>1, :pre=>["rc", 2, 20100401113022]
+			semver.to_s.should == "0.1.0-rc.2.20100401113022"
+		end
+
+		it "will not allow disallowed characters for the pre-relase id" do
+			lambda { SemverStringer::Semver.new :pre=>"period.is.forbidden" }.should raise_error(ArgumentError)
+			lambda { SemverStringer::Semver.new :pre=>"underscore_is_forbidden" }.should raise_error(ArgumentError)
+			lambda { SemverStringer::Semver.new :pre=>"special$chars@not*allowed!" }.should raise_error(ArgumentError)
+			lambda { SemverStringer::Semver.new :pre=>["or", "in", "arrays!!!"] }.should raise_error(ArgumentError)
+		end
+	end
+
+	describe "optional build identifier" do
+		it "can take an integer build id" do
+			semver = SemverStringer::Semver.new :major=>2, :build=>1234
+			semver.to_s.should == "2.0.0+1234"
+		end
+
+		it "can take alphanumeric build id" do
+			semver = SemverStringer::Semver.new :build=>"AaBb-123"
+			semver.to_s.should == "0.0.1+AaBb-123"
+		end
+
+		it "can accept a list of build identifiers" do
+			semver = SemverStringer::Semver.new :patch=>3, :build=>["build", 1, "aA", "2"]
+			semver.to_s.should == "0.0.3+build.1.aA.2"
+		end
+
+		it "will not allow disallowed characters" do
+			lambda { SemverStringer::Semver.new :build=>"period.is.forbidden" }.should raise_error(ArgumentError)
+			lambda { SemverStringer::Semver.new :build=>"underscore_is_forbidden" }.should raise_error(ArgumentError)
+			lambda { SemverStringer::Semver.new :build=>"special$chars@not*allowed!" }.should raise_error(ArgumentError)
+			lambda { SemverStringer::Semver.new :build=>["or", "in", "arrays!!!"] }.should raise_error(ArgumentError)
+		end
+	end
+
+	describe "the full semver kitchen sink" do
+		it "supports any combination of major, minor, patch, pre-release and build identifiers" do
+			options = { :major=>1, :minor=>2, :patch=>303, :pre=>"beta", :build=>["build",1234] }
+			semver = SemverStringer::Semver.new options
+			semver.to_s.should == "1.2.303-beta+build.1234"
+		end
+	end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: semver_stringer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Ian Truslove
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70208392024840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: *70208392024840
+description: See semver.org for the rules, or https://github.com/iantruslove/SemverStringer#readme
+  for a little documentation.
+email:
+- ian.truslove@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- 00notes.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/semver_stringer.rb
+- lib/semver_stringer/semver.rb
+- lib/semver_stringer/version.rb
+- semver_stringer.gemspec
+- spec/semver_spec.rb
+homepage: https://github.com/iantruslove/SemverStringer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Makes nice strings for your SemVer needs
+test_files:
+- spec/semver_spec.rb