jeffp-enumerated_attribute 0.1.0 → 0.1.1

data/CHANGELOG.rdoc

@@ -1,6 +1,12 @@
 == master
 
-== 0.1.0 / 2009-07-09
+== 0.1.1 / 2009-07-09
+
+* Added enum_attr_reader and enum_attr_writer
+* Added option :nil=>true to allow attributes set to nil
+* Added #{attr_name}_nil? method for testing nil case
+
+== 0.1.0 / 2009-07-08
 
 * Added dynamic predicate method generation
 * Added options handling
@@ -8,4 +14,4 @@
 * Added enumeration accessor
 * Added accessor and enumeration value definition
 * Added simple attribute initialization
-* Added DSL for short-hand method definition
+* Added DSL for short-hand method definition

data/README.rdoc

@@ -82,7 +82,7 @@ demonstrated below using the Tractor class defined above:
   t.gear_previous                   # => :reverse
   t.gear_previous                   # => :over_drive
   
-The plugin has defined +gear+ and +gear=+ accessors for the attribute.  They can be used 
+The plugin has defined +gear+ and gear= accessors for the attribute.  They can be used 
 to set the attribute to one of the defined enumeration values.  Attempting to set the 
 attribute to something besides a defined enumeration value raises an ArgumentError.
 
@@ -99,7 +99,7 @@ of the enumeration array.  For example:
 ==== Using Attribute Predicates
 
 Attribute predicates are methods used to query the state of the attribute, 
-for instance, +gear_is_neutral?+ is a predicate method for the gear attribute.  
+for instance, gear_is_neutral? is a predicate method for the gear attribute.  
 The plugin will evaluate and respond to predicate methods
 for any attribute defined with it.  Predicate methods are not pre-generated.  By
 adhering to a specific format, the plugin can recognize attribute predicates

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/contrib/sshpublisher'
  
 spec = Gem::Specification.new do |s|
   s.name = 'enumerated_attribute'
-  s.version = '0.1.0'
+  s.version = '0.1.1'
   s.platform = Gem::Platform::RUBY
   s.description = 'A enumerated attribute accessor'
   s.summary = 'Defines enumerated attributes, initial state and dynamic state methods.'
@@ -28,8 +28,9 @@ require 'spec/rake/spectask'
 
 namespace :spec do
   desc "Run all specs"
-  Spec::Rake::SpecTask.new('test') do |t|
+  Spec::Rake::SpecTask.new(:test) do |t|
     t.spec_files = FileList['spec/**/*_spec.rb']
+    t.libs << 'lib' << 'spec'
     #t.spec_opts = ['--options', 'spec/spec.opts']
     t.rcov = false
     #t.rcov_dir = 'coverage'
@@ -37,6 +38,15 @@ namespace :spec do
   end
 end
 
+desc "Run test"
+Spec::Rake::SpecTask.new(:test) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.libs << 'lib' << 'spec'
+  #t.spec_opts = ['--options', 'spec/spec.opts']
+  t.rcov = false
+  #t.rcov_dir = 'coverage'
+  #t.rcov_opts = ['--exclude', "kernel,load-diff-lcs\.rb,instance_exec\.rb,lib/spec.rb,lib/spec/runner.rb,^spec/*,bin/spec,examples,/gems,/Library/Ruby,\.autotest,#{ENV['GEM_HOME']}"]
+end
 
 =begin
 desc "Test the #{spec.name} plugin."

data/lib/enumerated_attribute.rb

@@ -1,10 +1,25 @@
 module EnumeratedAttribute
 
 #todo: system wide constants
-#todo: allow nil
 #todo: setter_callback
 #todo: ArgumentError may need to use Errors for ActiveRecord
+#todo: test new chaining plays nice
 
+  def enum_attr_reader(*args, &block)
+    if args.length > 1
+      args << {} if args.length == 2
+      args[2][:writer] = false if args[2].kind_of?(Hash)
+    end
+    enumerated_attribute(*args, &block)
+  end
+  def enum_attr_writer(*args, &block)
+    if args.length > 1
+      args << {} if args.length == 2
+      args[2][:reader] = false if args[2].kind_of?(Hash)
+    end
+    enumerated_attribute(*args, &block)
+  end
+  
   def enumerated_attribute(*args, &block)
     return if args.empty?
     attr_name = args[0].to_s
@@ -35,13 +50,15 @@ module EnumeratedAttribute
     end
 
     #create accessors
-    attr_reader attr_sym
-    if enums.empty?
-      attr_writer attr_sym
-    else
-      enumerated_attr_writer attr_sym
+    attr_reader attr_sym unless (opts.key?(:reader) && !opts[:reader])
+    unless (opts.key?(:writer) && !opts[:writer])
+      if enums.empty?
+        attr_writer attr_sym 
+      else
+        enumerated_attr_writer(attr_sym, opts[:nil] || false)
+      end
     end
-
+    
     #define dynamic methods in method_missing
     class_eval <<-METHOD
       unless @missing_method_for_enumerated_attribute_defined
@@ -133,6 +150,9 @@ module EnumeratedAttribute
           index = z.index(@#{attr_name})
           @#{attr_name} = z[index > 0 ? index-1 : z.size-1]
         end
+        def #{attr_name}_nil?
+          @#{attr_name} == nil
+        end
       ENUM
     end
     
@@ -171,12 +191,16 @@ module EnumeratedAttribute
 
   private
   
-  def enumerated_attr_writer name
+  def enumerated_attr_writer name, allow_nil=false
     name = name.to_s
     class_eval <<-METHOD
-      def #{name}=(val)
+      def #{name}=(val)        
         val = val.to_sym if val.instance_of?(String)
-        raise(ArgumentError, "'" + val.to_s + "' is not an enumerated value for #{name} attribute", caller) unless @@enumerated_attribute_values[:#{name}].include?(val) 
+        unless (val == nil && #{allow_nil})
+          raise(ArgumentError, 
+            (val == nil ? "nil is not allowed on #{name} attribute, set :nil=>true option" : "'" + val.to_s + "' is not an enumeration value for #{name} attribute"), 
+            caller) unless @@enumerated_attribute_values[:#{name}].include?(val) 
+        end
         @#{name} = val
       end
     METHOD

data/spec/car_spec.rb

@@ -1,4 +1,4 @@
-require 'spec/car'
+require 'car'
 
 #used to test that method_missing chaining plays nice in inheritance situation
 

data/spec/tractor.rb

@@ -19,7 +19,7 @@ class Tractor
     downshift { self.driving? ? self.gear_previous : self.gear }
   end
   
-  enum_attr :plow, %w(^up down) do
+  enum_attr :plow, %w(^up down), :nil=>true do
     plowing? { self.gear_is_in_first? && self.plow == :down }
   end
   
@@ -34,5 +34,8 @@ class Tractor
     incrementor :side_light_up
     decrementor :side_light_down    
   end
+  
+  enum_attr_reader :temperature, %w(low med high)
+  enum_attr_writer :ignition, %w(^off activate)
     
 end

data/spec/tractor_spec.rb

@@ -1,7 +1,35 @@
-require 'spec/tractor'
+require 'tractor'
 
 describe "Tractor" do
+  it "should have getter but no setter for :temperature" do
+    Tractor.instance_methods.should_not include('temperature=')
+    Tractor.instance_methods.should include('temperature')
+  end
+  
+  it "should have setter but no getter for :ignition" do
+    Tractor.instance_methods.should_not include('ignition')
+    Tractor.instance_methods.should include('ignition=')
+  end
 
+  it "should be able to set :plow to nil" do
+    t=Tractor.new
+    lambda { t.plow = nil }.should_not raise_error(ArgumentError)
+  end
+  
+  it "should have method :plow_nil? that operates correctly" do
+    t=Tractor.new
+    t.plow.should_not be_nil
+    t.plow_nil?.should be_false
+    t.plow = nil
+    t.plow.should be_nil
+    t.plow_nil?.should be_true
+  end
+  
+  it "should raise ArgumentError when setting :gear to nil" do
+    t=Tractor.new
+    lambda{ t.gear = nil }.should raise_error(ArgumentError)
+  end
+  
   it "should have respond_to? method for :gear_is_in_neutral?" do
     t=Tractor.new
     t.respond_to?('gear_is_in_neutral?').should be_true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jeffp-enumerated_attribute
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Jeff Patmon