dated_version 2008.07.0

data/Rakefile

@@ -0,0 +1,68 @@
+#!/usr/bin/env rake
+require 'rubygems'  unless defined?(Gem)
+require 'rake'      unless defined?(Rake)
+
+$:.unshift(File.expand_path(File.dirname(__FILE__) + '/lib'))
+$:.uniq!
+require 'dated_version'
+
+# TODO : make some actual rake tasks instead!
+def load_dated_version(file)
+  ver = Class.new.class_eval(File::read(file))
+  DatedVersion.new(ver::MAJOR, ver::MINOR, (ENV['TINY_VERSION'] || ver::TINY))
+rescue
+  DatedVersion.new(ENV['TINY_VERSION'])
+end
+
+Package = false # Build zips and tarballs?
+
+GSpec = Gem::Specification.new do |s|
+  s.name = 'dated_version'
+  s.summary = 'A simple to use version class based on a date and iterative tiny version.'
+  s.description = s.summary
+  s.author = 'James Tucker'
+  s.email = 'raggi@rubyforge.org'
+  s.homepage = 'http://github.com/raggi/dated_version'
+  s.rubyforge_project = nil
+
+  s.version = load_dated_version('lib/dated_version/version.rb').to_s
+
+  s.files = %w(Rakefile) + Dir.glob("{bin,docs,lib,spec,test,scripts,tasks}/**/*")
+
+  if s.has_rdoc = true
+    main_rdoc = "README" if test ?e, "README"
+    main_rdoc ||= "docs/README" if test ?e, "docs/README"
+    s.extra_rdoc_files = Dir.glob("docs/*")
+    s.rdoc_options.concat %W(
+      --title #{s.name}
+      --main #{main_rdoc}
+      --tab-width 2
+      --line-numbers
+      --inline-source
+      --charset utf-8
+    )
+  end
+
+  s.bindir = 'bin' if File.directory?('bin')
+  s.require_path = 'lib'
+
+  s.platform = Gem::Platform::RUBY
+  if runner = Dir['{spec,test}/runner'].first
+    s.test_file = runner
+  end
+end
+
+task :reversion do
+  v = load_dated_version('lib/dated_version/version.rb').succ
+  open('lib/dated_version/version.rb', 'w') do |f|
+    f.write v.to_ruby_code('DatedVersion', 'class')
+  end
+end
+
+task :release => [:test, :reversion, :gem]
+
+task :clean do
+  rm_f 'lib/dated_version/version.rb'
+end
+
+Dir.glob('tasks/**/*.rake').each { |r| Rake.application.add_import r }

data/docs/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2008 James Tucker
+
+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/docs/README

@@ -0,0 +1,64 @@
+= Dated Version
+
+Please see the DatedVersion class docs for full usage examples.
+
+== Summary
+
+A simple yet effective (and easy!) version class abstracted from dates.
+
+== Key features
+
+Really, see the class docs, but:
+* Simple to create, just make a new one.
+* Simple to adjust for tiny versions, just supply the tiny value to new.
+* Simple to create other versions, just supply strings or arrays with all or
+  partial field values.
+* Simple conversion to date, call #to_date.
+* Simple re-representation as a newgem/hoe style version, see #to_constant.
+* Simple string representation, and parsing.
+* Simply Comparable!
+* Simple, simple, simple, but just wide enough too :-)
+
+== Rationale
+
+These are thoughts! A date based version may not be for everyone.
+
+The idiom is, version numbers seem to be settling on a general three value 
+set, however this adds a few stresses to the developer:
+What defines a {major, minor, tiny} version? (the specific sense, for a 
+particular lib). It's totally undefined really.
+There are some standard hand-wavy definitions of these things, but they only 
+leave more 'in this case' questions. I regularly had issues with the answers 
+to these definitions. 
+
+When you're starting a project, and no real maintenance cycle is required (the 
+versions just go up), then there's no issue anyway, so early on, people don't 
+care.
+
+When you're doing maintenance work and refactor changes alter edge cases or
+trivial api changes create important semantic or stateful alterations, then 
+these versions become a real real pain. It becomes a religious or political 
+dispute as to minor vs major change and so on. About the only thing anyone 
+agrees on is that there should be a patchlevel, or 'maintenance level'.
+
+The idea here is, simplify the whole middle range. If you have a released 
+version that needs maintenance, you iterate tiny, the maintenance value. 
+Nothing more. Changes should never occur to the API unless it's absolutely 
+suitable, e.g. fix for documentation.
+
+Simple for the developer. Simple for the user.
+
+== Notes
+
+There is a to_constant function which provides a re-representation of the 
+DatedVersion as a three part MAJOR, MINOR, TINY set. The re-representation 
+tries to accomodate tiny and major with some level of sanity, by compacting
+the month and day into a year day. It is important to note that if used 
+consistently, this is a valid representation of the DatedVersion. If however 
+an attempt to compare the two representations is made, this will fail badly
+for many values.
+
+== TODO
+	refactor out from specs.
+	finish specs
+	add rake helpers

data/lib/basic_version.rb

@@ -0,0 +1,72 @@
+class BasicVersion
+  Fields = :major, :minor, :tiny
+  GlobString = (['*'] * Fields.size).join('.')
+  StringRexp = /#{(['(\d+)'] * Fields.size).join('\.')}/
+  attr_accessor(*Fields)
+
+  def initialize(*args)
+    if args.size == 1 && args.first.kind_of?(String) && md = StringRexp.match(args.first)
+      args = md.captures.map { |a| a.to_i }
+    end
+    case args.size
+    when 0
+      # no-op
+    when 1
+      self.tiny = args.first.to_i
+    when 3
+      self.major, self.minor, self.tiny = *args.map{|a| a.to_i }
+    else
+      raise ArgumentError
+    end
+    Fields.each_with_index do |f, i|
+      next unless self.send(f).nil?
+      self.send(:"#{f}=", 0)
+    end
+  end
+
+  def to_a
+    [self.major, self.minor, self.tiny]
+  end
+
+  def to_s
+    "%d.%d.%d" % to_a
+  end
+
+  def to_ruby_constants
+    <<-EORUBY
+    MAJOR = #{self.major}
+    MINOR = #{self.minor}
+    TINY = #{self.tiny}
+    STRING = #{to_s.inspect}
+    EORUBY
+  end
+  
+  def to_ruby_code(module_name = 'AppVersion', namespace_type = 'module')
+    <<-EORUBY
+#{namespace_type} #{module_name}
+  module VERSION
+    #{to_ruby_constants.strip}
+    self
+  end
+end
+    EORUBY
+  end
+
+  include Comparable
+
+  def succ
+    self.class.new(self.major, self.minor, self.tiny + 1)
+  end
+
+  def <=>(other)
+    v = 0
+    Fields.each do |f|
+      return v unless other.respond_to?(f)
+      v = self.send(f) <=> other.send(f)
+      return v unless v == 0
+    end
+    v
+  end
+end
+
+(require 'raggi/irb/drop'; dROP!(binding)) if __FILE__ == $0

data/lib/dated_version.rb

@@ -0,0 +1,20 @@
+# See DatedVersion.
+require 'date'
+require File.dirname(__FILE__) + '/basic_version.rb'
+# = Dated Version
+class DatedVersion < BasicVersion
+  alias year major
+  alias year= major=
+  alias month minor
+  alias month= minor=
+
+  def initialize(*args)
+    t = Time.now
+    self.year, self.month = t.year, t.month
+    super
+  end
+  
+  def to_s
+    "%04d.%02d.%d" % to_a
+  end
+end

data/spec/helper.rb

@@ -0,0 +1,14 @@
+# Disable test/unit and rspec from running, in case loaded by broken tools.
+Test::Unit.run = false if defined?(Test::Unit)
+Spec::run = false if defined?(Spec) && Spec::respond_to?(:run=)
+
+# Setup a nice testing environment
+$TESTING=true
+$:.push File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.uniq!
+%w[rubygems facon bacon].each { |r| require r }
+
+# Bacon doesn't do any automagic, so lets tell it to!
+Bacon.summary_on_exit
+
+require 'dated_version'

data/spec/runner

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+__DIR__ = File.dirname(__FILE__)
+__APP__ = File.expand_path(__DIR__ + '/../')
+
+puts
+Dir.chdir(__APP__) do
+  files = ARGV.empty? ? Dir.glob('{test,spec}/**/{test,spec}_*.rb') : ARGV
+  files.each { |f| require f }
+end

data/spec/spec_dated_version.rb

@@ -0,0 +1,59 @@
+require File.dirname(__FILE__) + '/helper'
+
+describe 'dated version' do
+
+  should 'default to today with tiny version 0' do
+    v = DatedVersion.new
+    t = Time.now
+    v.year.should.eql(t.year)
+    v.month.should.eql(t.month)
+    v.tiny.should.eql(0)
+  end
+
+  should 'allow for customised tiny versions' do
+    t = 12
+    v = DatedVersion.new(t)
+    v.tiny.should.eql(t)
+  end
+  
+  should 'parse strings as the first argument' do
+    str = 'v2008.7.1'
+    v = DatedVersion.new(str)
+    v.major.should.eql(2008)
+    v.minor.should.eql(7)
+    v.tiny.should.eql(1)
+  end
+
+  should 'implement to_a, in order year month tiny' do
+    t = Time.now
+    v = DatedVersion.new
+    v.to_a.should.eql([t.year, t.month, 0])
+  end
+
+  should 'allow full custom versions' do
+    year, month, tiny = 1, 2, 3
+    v = DatedVersion.new(year, month, tiny)
+    v.year.should.eql(year)
+    v.month.should.eql(month)
+    v.tiny.should.eql(tiny)
+  end
+
+  should 'present a padded string' do
+    year, month, tiny = 1, 2, 3
+    string = "0001.02.3"
+    v = DatedVersion.new(year, month, tiny)
+    v.to_s.should.eql(string)
+  end
+
+  should 'generate hoe like version code' do
+    year, month, tiny = 1, 2, 3
+    string = "0001.02.3"
+    v = DatedVersion.new(year, month, tiny)
+    mk = Class.new
+    mk.class_eval v.to_ruby_constants
+    mk::MAJOR.should.eql(year)
+    mk::MINOR.should.eql(month)
+    mk::TINY.should.eql(tiny)
+    mk::STRING.should.eql(string)
+  end
+end

data/tasks/raggi_rake_generic/autospec.rake

@@ -0,0 +1,33 @@
+# Poor mans autotest, for when you absolutely positively, just need an autotest.
+# N.B. Uses a runner under test/ or spec/, so you can customize the runtime.
+# Thanks to manveru for this!
+desc "Run specs every time a file changes in lib or spec"
+task :autospec do
+  rb = Gem.ruby rescue nil
+  rb ||= (require 'rbconfig'; File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name']))
+  command = 'spec/runner' if test ?e, 'spec/runner'
+  command ||= 'test/runner' if test ?e, 'test/runner'
+  files = Dir.glob('{lib,spec,test}/**/*.rb')
+  mtimes = {}
+  sigtrap = proc { puts "\rDo that again, I dare you!"; trap(:INT){ exit 0 }; sleep 0.8; trap(:INT, &sigtrap) }
+  trap(:INT, &sigtrap)
+  system "#{rb} -I#{GSpec.require_path} #{command}"
+  while file = files.shift
+    begin
+      mtime = File.mtime(file)
+      mtimes[file] ||= mtime
+      if mtime > mtimes[file]
+        files = Dir.glob('{lib,spec,test}/**/*.rb') - [file] # refresh the file list.
+        puts
+        system "#{rb} -I#{GSpec.require_path} #{command} #{file}"
+        puts
+      end
+      mtimes[file] = mtime
+      files << file
+    rescue Exception
+      retry
+    end
+    # print "\rChecking: #{file.ljust((ENV['COLUMNS']||80)-11)}";$stdout.flush
+    sleep 0.2
+  end
+end

data/tasks/raggi_rake_generic/project.rake

@@ -0,0 +1,108 @@
+# 
+# = raggi's Rake Generic Tasks
+# 
+# A generic rake task set, supporting several forms of testing environment, 
+# gem installs, and so on. Rides on top of a gem specification, and rake 
+# built-ins.
+# 
+# You will need to define a GSpec method or object (constant scope) to pass 
+# back a gem specification for the project. Crufty rake tasks will be removed 
+# as you remove portions of the specification from your gemspec.
+# 
+# Suggestions, fixes and additions always welcome.
+# 
+
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/clean'
+
+module FileUtils
+  # If any of these methods ever clobber, try removing them.
+  # Hopefully they'll do something semantically similar.
+  abort "Err: #{__FILE__}:#{__LINE__} monkey patch windows? clobbers!" unless instance_methods.grep(/windows\?/).empty?
+  abort "Err: #{__FILE__}:#{__LINE__} monkey patch sudo clobbers!" unless instance_methods.grep(/sudo/).empty?
+  abort "Err: #{__FILE__}:#{__LINE__} monkey patch gem_cmd clobbers!" unless instance_methods.grep(/gem_cmd/).empty?
+  def windows?; RUBY_PLATFORM =~ /mswin|mingw/; end
+  def sudo(cmd)
+    if windows? || (require 'etc'; Etc.getpwuid.uid == 0)
+      sh cmd
+    else
+      sh "sudo #{cmd}"
+    end
+  end
+  def gem_cmd(action, name, *args)
+    rb = Gem.ruby rescue nil
+    rb ||= (require 'rbconfig'; File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name']))
+    sudo "#{rb} -r rubygems -e 'require %{rubygems/gem_runner}; Gem::GemRunner.new.run(%w{#{action} #{name} #{args.join(' ')}})'"
+  end
+end
+
+# Setup our packaging tasks, we're just jacking the builtins.
+Rake::GemPackageTask.new(GSpec) do |pkg|
+  pkg.need_tar, pkg.need_tar_gz, pkg.need_zip = true, true, true if Package
+  pkg.gem_spec = GSpec
+end
+Rake::Task[:clobber].enhance [:clobber_package]
+
+# Test tasks can be made up of spec files or test files, provided you require
+# the right stuff in your test / spec helpers.
+Rake::TestTask.new do |t|
+  t.libs = Array(GSpec.require_path || 'lib')
+  t.warning = true
+  t.pattern = '{spec,test}/**/*.rb'
+end
+
+# Use {test,spec}/runner for alternative spec framework runners & rubygems 
+# test runner file.
+if runner = Dir['{spec,test}/runner'].first
+  desc "Run tests using #{runner}"
+  task :spec do ruby runner end
+else
+  task :spec => :test # pass on to a generic test task!
+end
+
+# Only generate rdoc if the spec says so, again, jack the builtins.
+if GSpec.has_rdoc
+  Rake::RDocTask.new do |rd|
+    rd.title = GSpec.name
+    rd.rdoc_dir = 'rdoc'
+    rd.main = "README" if test ?e, "README"
+    rd.main ||= "docs/README" if test ?e, "docs/README"
+    rd.rdoc_files.include("lib/**/*.rb", *GSpec.extra_rdoc_files)
+  end
+  Rake::Task[:clobber].enhance [:clobber_rdoc]
+
+  desc 'Generate and open documentation'
+  task :docs => :rdoc do
+    case RUBY_PLATFORM
+    when /darwin/       ; sh 'open rdoc/index.html'
+    when /mswin|mingw/  ; sh 'start rdoc\index.html'
+    else 
+      sh 'firefox rdoc/index.html'
+    end
+  end
+end
+
+if GSpec.default_executable
+  desc "Run #{GSpec.default_executable}"
+  task :run do ruby File.join(GSpec.bindir, GSpec.default_executable) end
+end
+
+desc 'Install gem (and sudo if required)'
+task :install => :package do 
+  gem_cmd(:install, "pkg/#{GSpec.name}-#{GSpec.version}.gem")
+end
+
+desc 'Uninstall gem (and sudo if required)'
+task :uninstall do
+  gem_cmd(:uninstall, "#{GSpec.name}")
+end
+
+# Find an scm's store directory, if we do, make a task to commit to it only
+# after running all the tests (successfully).
+if scm = %w(git svn bzr hg).find { |d| File.directory? ".#{d}" }
+  desc "Run tests then commit to #{scm}"
+  task :commit => :test do sh "#{scm} commit" end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: dated_version
+version: !ruby/object:Gem::Version 
+  version: 2008.07.0
+platform: ruby
+authors: 
+- James Tucker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-31 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: A simple to use version class based on a date and iterative tiny version.
+email: raggi@rubyforge.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- docs/LICENSE
+- docs/README
+files: 
+- Rakefile
+- docs/LICENSE
+- docs/README
+- lib/basic_version.rb
+- lib/dated_version
+- lib/dated_version.rb
+- spec/helper.rb
+- spec/runner
+- spec/spec_dated_version.rb
+- tasks/raggi_rake_generic
+- tasks/raggi_rake_generic/autospec.rake
+- tasks/raggi_rake_generic/project.rake
+has_rdoc: true
+homepage: http://github.com/raggi/dated_version
+post_install_message: 
+rdoc_options: 
+- --title
+- dated_version
+- --main
+- docs/README
+- --tab-width
+- "2"
+- --line-numbers
+- --inline-source
+- --charset
+- utf-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A simple to use version class based on a date and iterative tiny version.
+test_files: 
+- spec/runner