enum 0.1.1 → 1.0.0

data/.autotest

@@ -0,0 +1,23 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+# Autotest.add_hook :initialize do |at|
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2010-09-13
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/enum.rb
+test/test_enum.rb

data/README.txt

@@ -0,0 +1,76 @@
+= enum
+
+http://github.com/capnregex/enum
+
+== DESCRIPTION:
+
+A java like Enum class for ruby. 
+
+A while ago I was exploring Java, and came across the Enum class, which had
+some interesting functionality, and I decided that I would like something like
+it. 
+
+Conceptually if you just need a unique identifier you may be perfectly happy using a :symbol, and that would likely be a simpler way of having a controll flag. However, if you want to have a set of unique identifiers that you can address, iterate over, assign properties to, etc, then this may be something you would be interested in. 
+
+== FEATURES/PROBLEMS:
+
+Provide the java Enum idiom for Ruby. 
+
+For examples of use cases, see the examples in test.
+
+== SYNOPSIS:
+
+class PrimaryColors < Enum
+  enum %w(Red Yellow Blue)
+end
+
+class Colors < Enum
+  enum_field :code
+  enum do 
+    RED   '#ff0000'
+    GREEN '#00ff00'
+    BLUE  '#0000ff'
+  end
+end
+
+== REQUIREMENTS:
+
+ruby, rubygems
+
+== INSTALL:
+
+sudo gem install enum
+
+== DEVELOPERS:
+
+After checking out the source, run:
+
+  $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the RDoc.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010
+
+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/Rakefile

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.spec 'enum' do
+  developer('capnregex', 'capnregex@gmail.com')
+
+  # self.rubyforge_name = 'enumx' # if different than 'enum'
+end
+
+# vim: syntax=ruby

data/lib/enum.rb

@@ -1,25 +1,49 @@
 # Enum
 class Enum 
+  VERSION = '1.0.0'
+  include Comparable
 protected 
   def init *args
+    self.class.fields.each do |field|
+      instance_variable_set("@#{field}",args.shift)
+    end
+  end
+  def initialize *args, &block
+    @id = self.class.next_ordinal
+    sym = args.shift
+    @sym = sym.to_sym
+    @name = args.shift || sym.to_s
+    init(*args)
+    if block
+      instance_eval( &block )
+    end
   end
 public
-  attr_reader :id, :name
-  def initialize *args
-    @id = args.shift
-    @name = args.shift
-    init *args
+  attr_reader :id
+  alias ordinal id
+  def <=> other
+    if self.class == other.class
+      ordinal <=> other.ordinal
+    else
+      nil
+    end
   end
-  def to_sym;name;end
-  def to_s;name.to_s;end
+  def to_sym;@sym;end
+  def to_s;@name;end
+  alias name to_s
+  alias title to_s
   def to_i;@id;end
-  def inspect;"#{self.class}::#{name}##{id}";end
+  def to_f;@id.to_f;end
+  def inspect;"#{self.class}::#{to_sym}";end
   def save;end
   def save!;end
   class << self
     def values
       @values ||= []
     end
+    def fields
+      @fields ||= []
+    end
     alias all values
     def find id
       values[id]
@@ -29,19 +53,83 @@ public
 	yield value
       end
     end
+    def save
+    end
+    def save!
+    end
+    def next_ordinal
+      o = @next_ordinal ||= 0
+      @next_ordinal = o + step
+      o
+    end
   protected
-    def missing *args
-      name = args.first
-      value = new(values.length,*args)
-      values.push value
-      const_set(name,value)
-      value
+    def start_at i
+      @next_ordinal = i
+    end
+    def step_by n
+      @step = n
     end
-    def method_missing *args
-      missing *args
+    def enum_fields *fields
+      @fields = fields
+      send :attr_reader, *fields
+    end
+    def enum *args, &block
+      unless args.empty?
+	if args.length == 1 and ( arg = args.first ) and arg.kind_of? Array
+	  arg.each do |a|
+	    add_enum a
+	  end
+	else
+	  args.each do |arg|
+	    add_enum arg
+	  end
+	end
+      end
+      if block
+        Enumeration.new self, &block
+      end
+      nil
+    end
+    def step
+      @step ||= 1
+    end
+    def enum_sym arg
+      arg = arg.to_s.upcase
+      case arg
+      when /\s/ 
+        arg.gsub(/\s+/,'_').to_sym
+      else 
+	arg.to_sym
+      end
+    end
+    def add_enum *args, &block
+      c = args.shift
+      name = c.to_s
+      sym = enum_sym(c)
+      if const_defined? sym
+	const_get sym 
+      else
+	value = new(sym,name,*args,&block)
+	values.push value
+	const_set(sym,value)
+	value
+      end
+    end
+  end
+
+  # use the Enumeration class to constrain the scope of where the Enum definition can take place. 
+  class Enumeration
+    def initialize parent, *args, &block
+      @parent = parent
+      instance_eval(&block)
+    end
+  protected
+    def method_missing *args, &block
+      @parent.send :add_enum, *args, &block
     end
-    def const_missing *args
-      missing *args
+    def const_missing *args, &block
+      @parent.send :add_enum, *args, &block
     end
   end
+
 end

data/test/test_card.rb

@@ -0,0 +1,34 @@
+
+require "test/unit"
+require "card"
+
+class TestCard < Test::Unit::TestCase
+  def test_card_sanity
+    assert_equal Card::Rank::TEN.to_i, 10
+    assert_equal [Card::Suit::CLUBS, Card::Suit::DIAMONDS, Card::Suit::HEARTS,
+      Card::Suit::SPADES], Card::Suit.values
+    assert_equal [Card::Rank::DEUCE, Card::Rank::THREE, Card::Rank::FOUR,
+      Card::Rank::FIVE, Card::Rank::SIX, Card::Rank::SEVEN, Card::Rank::EIGHT,
+      Card::Rank::NINE, Card::Rank::TEN, Card::Rank::JACK, Card::Rank::QUEEN,
+      Card::Rank::KING, Card::Rank::ACE], Card::Rank.values
+    assert_equal [Card::DEUCE_OF_CLUBS, Card::THREE_OF_CLUBS,
+      Card::FOUR_OF_CLUBS, Card::FIVE_OF_CLUBS, Card::SIX_OF_CLUBS,
+      Card::SEVEN_OF_CLUBS, Card::EIGHT_OF_CLUBS, Card::NINE_OF_CLUBS,
+      Card::TEN_OF_CLUBS, Card::JACK_OF_CLUBS, Card::QUEEN_OF_CLUBS,
+      Card::KING_OF_CLUBS, Card::ACE_OF_CLUBS, Card::DEUCE_OF_DIAMONDS,
+      Card::THREE_OF_DIAMONDS, Card::FOUR_OF_DIAMONDS, Card::FIVE_OF_DIAMONDS,
+      Card::SIX_OF_DIAMONDS, Card::SEVEN_OF_DIAMONDS, Card::EIGHT_OF_DIAMONDS,
+      Card::NINE_OF_DIAMONDS, Card::TEN_OF_DIAMONDS, Card::JACK_OF_DIAMONDS,
+      Card::QUEEN_OF_DIAMONDS, Card::KING_OF_DIAMONDS, Card::ACE_OF_DIAMONDS,
+      Card::DEUCE_OF_HEARTS, Card::THREE_OF_HEARTS, Card::FOUR_OF_HEARTS,
+      Card::FIVE_OF_HEARTS, Card::SIX_OF_HEARTS, Card::SEVEN_OF_HEARTS,
+      Card::EIGHT_OF_HEARTS, Card::NINE_OF_HEARTS, Card::TEN_OF_HEARTS,
+      Card::JACK_OF_HEARTS, Card::QUEEN_OF_HEARTS, Card::KING_OF_HEARTS,
+      Card::ACE_OF_HEARTS, Card::DEUCE_OF_SPADES, Card::THREE_OF_SPADES,
+      Card::FOUR_OF_SPADES, Card::FIVE_OF_SPADES, Card::SIX_OF_SPADES,
+      Card::SEVEN_OF_SPADES, Card::EIGHT_OF_SPADES, Card::NINE_OF_SPADES,
+      Card::TEN_OF_SPADES, Card::JACK_OF_SPADES, Card::QUEEN_OF_SPADES,
+      Card::KING_OF_SPADES, Card::ACE_OF_SPADES], Card.values
+  end
+end
+

data/test/test_day.rb

@@ -0,0 +1,31 @@
+
+require "test/unit"
+require "day"
+
+class TestDay < Test::Unit::TestCase
+
+  def test_day_defined
+    assert Day
+  end
+
+  def tell_it_like_it_is day
+    case day
+    when Day::MONDAY then "Mondays are bad."
+    when Day::FRIDAY then "Fridays are better."
+    when Day::SATURDAY,Day::SUNDAY then "Weekends are best."
+    when Day then "Midweek days are soso."
+    else "Not a Day"
+    end
+  end
+
+  def test_day_case
+    assert_equal "Mondays are bad.", tell_it_like_it_is(Day::MONDAY)
+    assert_equal "Midweek days are soso.", tell_it_like_it_is(Day::WEDNESDAY)
+    assert_equal "Fridays are better.", tell_it_like_it_is(Day::FRIDAY)
+    assert_equal "Weekends are best.", tell_it_like_it_is(Day::SATURDAY)
+    assert_equal "Weekends are best.", tell_it_like_it_is(Day::SUNDAY)
+    assert_equal "Not a Day", tell_it_like_it_is(5)
+  end
+
+end
+

data/test/test_deck.rb

@@ -0,0 +1,13 @@
+
+require "test/unit"
+require "card"
+require "deck"
+
+class TestDeck < Test::Unit::TestCase
+  def test_card_deck
+    deck = Deck.new.shuffle
+    assert_not_equal Card.values, deck.cards
+    assert_equal Card.values, deck.cards.sort
+  end
+end
+

data/test/test_enum.rb

@@ -0,0 +1,10 @@
+
+require "test/unit"
+require "enum"
+
+class TestEnum < Test::Unit::TestCase
+  def test_sanity
+    assert Enum
+  end
+end
+

data/test/test_family.rb

@@ -0,0 +1,94 @@
+
+require "test/unit"
+require "family"
+
+class TestEnum < Test::Unit::TestCase
+
+  def test_family_ids
+    assert_equal Family::MANUAL.id, 0
+    assert_equal Family::CHIRP.id, 1
+    assert_equal Family::CANNED.id, 2
+    assert_equal Family::PULSE.id, 3
+    assert_equal Family::LEARN.id, 4
+    assert_equal Family::STEP.id, 5
+    assert_equal Family::DISTANCE.id, 6
+    assert_equal Family::CALORIE.id, 7
+    assert_equal Family::HRSS.id, 8
+    assert_equal Family::TRAINER.id, 9
+    assert_equal Family::TEST.id, 10
+    assert_equal Family::DEMO.id, 11
+  end
+
+  def test_family_syms
+    assert_equal Family::MANUAL.to_sym, :MANUAL
+    assert_equal Family::CHIRP.to_sym, :CHIRP
+    assert_equal Family::CANNED.to_sym, :CANNED
+    assert_equal Family::PULSE.to_sym, :PULSE
+    assert_equal Family::LEARN.to_sym, :LEARN
+    assert_equal Family::STEP.to_sym, :STEP
+    assert_equal Family::DISTANCE.to_sym, :DISTANCE
+    assert_equal Family::CALORIE.to_sym, :CALORIE
+    assert_equal Family::HRSS.to_sym, :HRSS
+    assert_equal Family::TRAINER.to_sym, :TRAINER
+    assert_equal Family::TEST.to_sym, :TEST
+    assert_equal Family::DEMO.to_sym, :DEMO
+  end
+
+  def test_family_names
+    assert_equal Family::MANUAL.name, 'MANUAL'
+    assert_equal Family::CHIRP.name, 'CHIRP'
+    assert_equal Family::CANNED.name, 'CANNED'
+    assert_equal Family::PULSE.name, 'PULSE'
+    assert_equal Family::LEARN.name, 'LEARN'
+    assert_equal Family::STEP.name, 'STEP'
+    assert_equal Family::DISTANCE.name, 'DISTANCE'
+    assert_equal Family::CALORIE.name, 'CALORIE'
+    assert_equal Family::HRSS.name, 'HRSS'
+    assert_equal Family::TRAINER.name, 'TRAINER'
+    assert_equal Family::TEST.name, 'TEST'
+    assert_equal Family::DEMO.name, 'DEMO'
+  end
+
+  def test_family_ordinals
+    assert_equal Family::MANUAL.ordinal, 0
+    assert_equal Family::CHIRP.ordinal, 1
+    assert_equal Family::CANNED.ordinal, 2
+    assert_equal Family::PULSE.ordinal, 3
+    assert_equal Family::LEARN.ordinal, 4
+    assert_equal Family::STEP.ordinal, 5
+    assert_equal Family::DISTANCE.ordinal, 6
+    assert_equal Family::CALORIE.ordinal, 7
+    assert_equal Family::HRSS.ordinal, 8
+    assert_equal Family::TRAINER.ordinal, 9
+    assert_equal Family::TEST.ordinal, 10
+    assert_equal Family::DEMO.ordinal, 11
+  end
+
+  def test_family_description
+    assert_equal Family::MANUAL.description,  'Manual Workout, No Automation'
+    assert_equal Family::CHIRP.description,  'Audio Chirp workout'
+    assert_equal Family::CANNED.description,  'Builtin Speed / Incline workout at 1 minute incriments'
+    assert_equal Family::PULSE.description,  'Builtin Pulse workouts'
+    assert_equal Family::LEARN.description,  'Built in Custom Workout'
+    assert_equal Family::STEP.description,  'Step Counting Workout'
+    assert_equal Family::DISTANCE.description,  'Reach a Target Distance'
+    assert_equal Family::CALORIE.description,  'Reach a Target Calorie Count'
+    assert_equal Family::HRSS.description,  'Heart Rate Self Select'
+    assert_equal Family::TRAINER.description,  'Wpl1 Macro Segment workout'
+    assert_equal Family::TEST.description,  'A Fitness Test'
+    assert_equal Family::DEMO.description,  'Wpl1 Non Macro segment workout'
+  end
+
+  def test_family_values_equality
+    assert_equal Family.values, [ Family::MANUAL, Family::CHIRP,
+      Family::CANNED, Family::PULSE, Family::LEARN, Family::STEP,
+      Family::DISTANCE, Family::CALORIE, Family::HRSS, Family::TRAINER,
+      Family::TEST, Family::DEMO ]
+  end
+
+  def test_family_value_inequality
+    assert_not_equal Family::MANUAL, Family::CHIRP
+  end
+
+end
+

data/test/test_operation.rb

@@ -0,0 +1,24 @@
+
+require "test/unit"
+require "operation"
+
+class TestOperation < Test::Unit::TestCase
+
+  def test_sanity
+    assert Operation
+  end
+
+  def test_values
+    assert_equal [Operation::PLUS, Operation::MINUS, Operation::TIMES,
+      Operation::DIVIDE], Operation.values
+  end
+
+  def test_operations
+    assert_equal 3, Operation::PLUS.evaluate(1,2)
+    assert_equal 6, Operation::MINUS.evaluate(8,2)
+    assert_equal 6, Operation::TIMES.evaluate(3,2)
+    assert_equal 6, Operation::DIVIDE.evaluate(12,2)
+  end
+
+end
+

data/test/test_planet.rb

@@ -0,0 +1,19 @@
+
+require "test/unit"
+require "planet"
+
+class TestPlanet < Test::Unit::TestCase
+  def test_planet
+    mass = Planet::EARTH.mass_of 175
+    assert_in_delta  66.107583, Planet::MERCURY.surface_weight(mass), 0.000001
+    assert_in_delta 158.374842, Planet::VENUS.surface_weight(mass)  , 0.000001
+    assert_in_delta 175.000000, Planet::EARTH.surface_weight(mass)  , 0.000001
+    assert_in_delta  66.279007, Planet::MARS.surface_weight(mass)   , 0.000001
+    assert_in_delta 442.847567, Planet::JUPITER.surface_weight(mass), 0.000001
+    assert_in_delta 186.552719, Planet::SATURN.surface_weight(mass) , 0.000001
+    assert_in_delta 158.397260, Planet::URANUS.surface_weight(mass) , 0.000001
+    assert_in_delta 199.207413, Planet::NEPTUNE.surface_weight(mass), 0.000001
+  end
+end
+
+

metadata

@@ -1,46 +1,95 @@
 --- !ruby/object:Gem::Specification 
 name: enum
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
-  - 0
-  - 1
   - 1
-  version: 0.1.1
+  - 0
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
-- CapnRegex
+- capnregex
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-09-10 00:00:00 -06:00
+date: 2010-09-14 00:00:00 -06:00
 default_executable: 
-dependencies: []
-
-description: "     Java like enum functionality when you need more than a unique identifier. \n"
-email: capnregex@gmail.org
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 2
+        - 6
+        - 2
+        version: 2.6.2
+  type: :development
+  version_requirements: *id002
+description: |-
+  A java like Enum class for ruby. 
+  
+  A while ago I was exploring Java, and came across the Enum class, which had
+  some interesting functionality, and I decided that I would like something like
+  it. 
+  
+  Conceptually if you just need a unique identifier you may be perfectly happy using a :symbol, and that would likely be a simpler way of having a controll flag. However, if you want to have a set of unique identifiers that you can address, iterate over, assign properties to, etc, then this may be something you would be interested in.
+email: 
+- capnregex@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
 files: 
-- README
-- Changelog
-- LICENSE
-- test/foo.rb
-- init.rb
+- .autotest
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
 - lib/enum.rb
+- test/test_enum.rb
+- test/test_day.rb
+- test/test_planet.rb
+- test/test_operation.rb
+- test/test_family.rb
+- test/test_card.rb
+- test/test_deck.rb
 has_rdoc: true
 homepage: http://github.com/capnregex/enum
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main
+- README.txt
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -63,10 +112,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: enum
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: java like enum functionality.
-test_files: []
-
+summary: A java like Enum class for ruby
+test_files: 
+- test/test_day.rb
+- test/test_planet.rb
+- test/test_operation.rb
+- test/test_family.rb
+- test/test_card.rb
+- test/test_enum.rb
+- test/test_deck.rb

data/init.rb

@@ -1,2 +0,0 @@
-# Enum
-require 'enum'

data/test/foo.rb

@@ -1,11 +0,0 @@
-require 'enum'
-
-class Foo < Enum
-  FOO
-  BAR(1,2,3)
-  BLEEP
-end
-
-Foo::BUGGER(:off)
-
-puts Foo.values.inspect