pkwde-renum 1.0.2

data/spec/renum_spec.rb

@@ -0,0 +1,109 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+enum :Status, [ :NOT_STARTED, :IN_PROGRESS, :COMPLETE ]
+
+module MyNamespace
+  enum :FooValue, %w( Bar Baz Bat )
+end
+
+enum :Color, [ :RED, :GREEN, :BLUE ] do
+  def abbr
+    name[0..0]
+  end
+end
+
+enum :Size do
+  Small("Really really tiny")
+  Medium("Sort of in the middle")
+  Large("Quite big")
+
+  attr_reader :description
+
+  def init description
+    @description = description
+  end
+end
+
+enum :HairColor do
+  BLONDE()
+  BRUNETTE()
+  RED()
+end
+
+describe "basic enum" do
+  
+  it "creates a class for the value type" do
+    Status.should be_an_instance_of(Class)
+  end
+  
+  it "makes each value an instance of the value type" do
+    Status::NOT_STARTED.should be_an_instance_of(Status)
+  end
+  
+  it "exposes array of values" do
+    Status.values.should == [Status::NOT_STARTED, Status::IN_PROGRESS, Status::COMPLETE]
+  end
+  
+  it "enumerates over values" do
+    Status.map {|s| s.name}.should == %w[NOT_STARTED IN_PROGRESS COMPLETE]
+  end
+  
+  it "indexes values" do
+    Status[2].should == Status::COMPLETE
+    Color[0].should == Color::RED
+  end
+  
+  it "provides index lookup on values" do
+    Status::IN_PROGRESS.index.should == 1
+    Color::GREEN.index.should == 1
+  end
+  
+  it "provides a reasonable to_s for values" do
+    Status::NOT_STARTED.to_s.should == "Status::NOT_STARTED"
+  end
+  
+  it "makes values comparable" do
+    Color::RED.should < Color::GREEN
+    Color::RED.should_not == Status::NOT_STARTED
+  end
+end
+
+describe "nested enum" do
+  it "is namespaced in the containing module or class" do
+    MyNamespace::FooValue::Bar.class.should == MyNamespace::FooValue
+  end
+end
+
+describe "enum with a block" do
+  it "can define additional instance methods" do
+    Color::RED.abbr.should == "R"
+  end
+end
+
+describe "enum with no values array and values declared in the block" do
+  it "provides an alternative means of declaring values where extra information can be provided for initialization" do
+    Size::Small.description.should == "Really really tiny"
+  end
+  
+  it "works the same as the basic form with respect to ordering" do
+    Size.values.should == [Size::Small, Size::Medium, Size::Large]
+  end
+  
+  it "responds as expected to arbitrary method calls, in spite of using method_missing for value definition" do
+    lambda { Size.ExtraLarge() }.should raise_error(NoMethodError)
+  end
+  
+  it "supprts there being no extra data and no init() method defined, if you don't need them" do
+    HairColor::BLONDE.name.should == "BLONDE"
+  end
+end
+
+# It was reported on my blog that <=> was causing segfaults.
+# I'd love to figure out why, but first I'd love to fix that. 
+describe "digging into this segfault/illegal instruction issue, renum" do
+  it "doesn't cause the ruby process to bomb!" do
+    Color::RED.should < Color::GREEN
+    Color::RED.should_not > Color::GREEN
+    Color::RED.should < Color::BLUE
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+if ENV['USE_GEM']
+  require 'rubygems'
+  require 'renum'
+else
+  require File.expand_path(File.dirname(__FILE__) + '/../lib/renum')
+end

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :install_gem, :spec_gem, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,26 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*_spec.rb']
+end
+
+task :spec_gem do
+  ENV['USE_GEM'] = 'y'
+  Rake::Task[:spec].invoke
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/website/index.html

@@ -0,0 +1,143 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      renum
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>renum</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/renum"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/renum" class="numbers">1.0.0</a>
+    </div>
+    <p>Renum provides a readable but terse enum facility for Ruby.  Enums are sometimes called object constants and are analogous to the type-safe enum pattern in Java, though obviously Ruby&#8217;s flexibility means there&#8217;s no such thing as type-safety.</p>
+
+
+	<h2>Installing</h2>
+
+
+	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">renum</span></pre></p>
+
+
+	<h2>Demonstration of usage</h2>
+
+
+	<p>Renum allows you to do things like this:</p>
+
+
+	<p><pre class='syntax'><span class="ident">enum</span> <span class="symbol">:Status</span><span class="punct">,</span> <span class="punct">%w(</span><span class="string"> NOT_STARTED IN_PROGRESS COMPLETE </span><span class="punct">)</span>
+
+<span class="ident">enum</span> <span class="symbol">:Size</span> <span class="keyword">do</span>
+  <span class="constant">Small</span><span class="punct">(&quot;</span><span class="string">Really really tiny</span><span class="punct">&quot;)</span>
+  <span class="constant">Medium</span><span class="punct">(&quot;</span><span class="string">Sort of in the middle</span><span class="punct">&quot;)</span>
+  <span class="constant">Large</span><span class="punct">(&quot;</span><span class="string">Quite big</span><span class="punct">&quot;)</span>
+
+  <span class="ident">attr_reader</span> <span class="symbol">:description</span>
+
+  <span class="keyword">def </span><span class="method">init</span> <span class="ident">description</span>
+    <span class="attribute">@description</span> <span class="punct">=</span> <span class="ident">description</span>
+  <span class="keyword">end</span>
+<span class="keyword">end</span>
+
+<span class="keyword">module </span><span class="module">MyNamespace</span>
+  <span class="ident">enum</span> <span class="symbol">:FooValue</span><span class="punct">,</span> <span class="punct">[</span> <span class="symbol">:Bar</span><span class="punct">,</span> <span class="symbol">:Baz</span><span class="punct">,</span> <span class="symbol">:Bat</span> <span class="punct">]</span>
+<span class="keyword">end</span></pre></p>
+
+
+	<p>Giving you something that satisfies this spec, plus a bit more:</p>
+
+
+	<p><pre class='syntax'><span class="ident">describe</span> <span class="punct">&quot;</span><span class="string">enum</span><span class="punct">&quot;</span> <span class="keyword">do</span>
+  
+  <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">creates a class for the value type</span><span class="punct">&quot;</span> <span class="keyword">do</span>
+    <span class="constant">Status</span><span class="punct">.</span><span class="ident">class</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">==</span> <span class="constant">Class</span>
+  <span class="keyword">end</span>
+  
+  <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">makes each value an instance of the value type</span><span class="punct">&quot;</span> <span class="keyword">do</span>
+    <span class="constant">Status</span><span class="punct">::</span><span class="constant">NOT_STARTED</span><span class="punct">.</span><span class="ident">class</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">==</span> <span class="constant">Status</span>
+  <span class="keyword">end</span>
+  
+  <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">exposes array of values</span><span class="punct">&quot;</span> <span class="keyword">do</span>
+    <span class="constant">Status</span><span class="punct">.</span><span class="ident">values</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">==</span> <span class="punct">[</span><span class="constant">Status</span><span class="punct">::</span><span class="constant">NOT_STARTED</span><span class="punct">,</span> <span class="constant">Status</span><span class="punct">::</span><span class="constant">IN_PROGRESS</span><span class="punct">,</span> <span class="constant">Status</span><span class="punct">::</span><span class="constant">COMPLETE</span><span class="punct">]</span>
+  <span class="keyword">end</span>
+
+  <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">provides an alternative means of declaring values where extra information can be provided for initialization</span><span class="punct">&quot;</span> <span class="keyword">do</span>
+    <span class="constant">Size</span><span class="punct">::</span><span class="constant">Small</span><span class="punct">.</span><span class="ident">description</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">==</span> <span class="punct">&quot;</span><span class="string">Really really tiny</span><span class="punct">&quot;</span>
+  <span class="keyword">end</span>
+  
+  <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">enumerates over values</span><span class="punct">&quot;</span> <span class="keyword">do</span>
+    <span class="constant">Status</span><span class="punct">.</span><span class="ident">map</span> <span class="punct">{|</span><span class="ident">s</span><span class="punct">|</span> <span class="ident">s</span><span class="punct">.</span><span class="ident">name</span><span class="punct">}.</span><span class="ident">should</span> <span class="punct">==</span> <span class="punct">%w[</span><span class="string">NOT_STARTED IN_PROGRESS COMPLETE</span><span class="punct">]</span>
+  <span class="keyword">end</span>
+  
+  <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">indexes values</span><span class="punct">&quot;</span> <span class="keyword">do</span>
+    <span class="constant">Status</span><span class="punct">[</span><span class="number">2</span><span class="punct">].</span><span class="ident">should</span> <span class="punct">==</span> <span class="constant">Status</span><span class="punct">::</span><span class="constant">COMPLETE</span>
+  <span class="keyword">end</span>
+  
+  <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">provides index lookup on values</span><span class="punct">&quot;</span> <span class="keyword">do</span>
+    <span class="constant">Status</span><span class="punct">::</span><span class="constant">IN_PROGRESS</span><span class="punct">.</span><span class="ident">index</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">==</span> <span class="number">1</span>
+  <span class="keyword">end</span>
+  
+  <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">provides a reasonable to_s for values</span><span class="punct">&quot;</span> <span class="keyword">do</span>
+    <span class="constant">Status</span><span class="punct">::</span><span class="constant">NOT_STARTED</span><span class="punct">.</span><span class="ident">to_s</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">==</span> <span class="punct">&quot;</span><span class="string">Status::NOT_STARTED</span><span class="punct">&quot;</span>
+  <span class="keyword">end</span>
+  
+  <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">makes values comparable</span><span class="punct">&quot;</span> <span class="keyword">do</span>
+    <span class="constant">Status</span><span class="punct">::</span><span class="constant">NOT_STARTED</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">&lt;</span> <span class="constant">Status</span><span class="punct">::</span><span class="constant">COMPLETE</span>
+  <span class="keyword">end</span>
+  
+  <span class="ident">it</span> <span class="punct">&quot;</span><span class="string">allows enums to be nested in other modules or classes</span><span class="punct">&quot;</span> <span class="keyword">do</span>
+    <span class="constant">MyNamespace</span><span class="punct">::</span><span class="constant">FooValue</span><span class="punct">::</span><span class="constant">Bar</span><span class="punct">.</span><span class="ident">class</span><span class="punct">.</span><span class="ident">should</span> <span class="punct">==</span> <span class="constant">MyNamespace</span><span class="punct">::</span><span class="constant">FooValue</span>
+  <span class="keyword">end</span>
+  
+<span class="keyword">end</span></pre></p>
+
+
+	<h2>License</h2>
+
+
+	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+
+
+	<h2>Contact</h2>
+
+
+	<p>Renum was created by John D. Hume. Comments are welcome. Send an email to duelin dot markers at gmail or <a href="http://elhumidor.blogspot.com/">contact me via my blog</a>.</p>
+    <p class="coda">
+      <a href="http://elhumidor.blogspot.com/">John D. Hume</a>, 25th January 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
+</script>
+<script type="text/javascript">
+_uacct = "UA-2039575-4";
+urchinTracker();
+</script>
+</body>
+</html>

data/website/index.txt

@@ -0,0 +1,84 @@
+h1. renum
+
+Renum provides a readable but terse enum facility for Ruby.  Enums are sometimes called object constants and are analogous to the type-safe enum pattern in Java, though obviously Ruby's flexibility means there's no such thing as type-safety.
+
+h2. Installing
+
+<pre syntax="ruby">sudo gem install renum</pre>
+
+h2. Demonstration of usage
+
+Renum allows you to do things like this:
+
+<pre syntax="ruby">enum :Status, %w( NOT_STARTED IN_PROGRESS COMPLETE )
+
+enum :Size do
+  Small("Really really tiny")
+  Medium("Sort of in the middle")
+  Large("Quite big")
+
+  attr_reader :description
+
+  def init description
+    @description = description
+  end
+end
+
+module MyNamespace
+  enum :FooValue, [ :Bar, :Baz, :Bat ]
+end</pre>
+
+Giving you something that satisfies this spec, plus a bit more:
+
+<pre syntax="ruby">describe "enum" do
+  
+  it "creates a class for the value type" do
+    Status.class.should == Class
+  end
+  
+  it "makes each value an instance of the value type" do
+    Status::NOT_STARTED.class.should == Status
+  end
+  
+  it "exposes array of values" do
+    Status.values.should == [Status::NOT_STARTED, Status::IN_PROGRESS, Status::COMPLETE]
+  end
+
+  it "provides an alternative means of declaring values where extra information can be provided for initialization" do
+    Size::Small.description.should == "Really really tiny"
+  end
+  
+  it "enumerates over values" do
+    Status.map {|s| s.name}.should == %w[NOT_STARTED IN_PROGRESS COMPLETE]
+  end
+  
+  it "indexes values" do
+    Status[2].should == Status::COMPLETE
+  end
+  
+  it "provides index lookup on values" do
+    Status::IN_PROGRESS.index.should == 1
+  end
+  
+  it "provides a reasonable to_s for values" do
+    Status::NOT_STARTED.to_s.should == "Status::NOT_STARTED"
+  end
+  
+  it "makes values comparable" do
+    Status::NOT_STARTED.should < Status::COMPLETE
+  end
+  
+  it "allows enums to be nested in other modules or classes" do
+    MyNamespace::FooValue::Bar.class.should == MyNamespace::FooValue
+  end
+  
+end</pre>
+
+h2. License
+
+This code is free to use under the terms of the MIT license. 
+
+h2. Contact
+
+Renum was created by John D. Hume. Comments are welcome. Send an email to duelin dot markers at gmail or "contact me via my blog":http://elhumidor.blogspot.com/.
+