jeffp-enumerated_attribute 0.2.2 → 0.2.3

data/README.rdoc

@@ -510,6 +510,10 @@ overwriting the plugin's methods.  The best approach is shown here:
     enum_attr temp:, %w(cold warm hot boiling)
   end
 
+==== ActiveRecord
+
+ActiveRecord's write_attribute and read_attribute methods do not support symbols for enumerated attributes.  
+
 
 == Testing
 

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/contrib/sshpublisher'
 
 spec = Gem::Specification.new do |s|
   s.name = 'enumerated_attribute'
-  s.version = '0.2.2'
+  s.version = '0.2.3'
   s.platform = Gem::Platform::RUBY
   s.description = 'Enumerated model attributes and view helpers'
   s.summary = 'Add enumerated attributes to your models and expose them in drop-down lists in your views'
@@ -37,6 +37,20 @@ namespace :spec do
 		#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
+	Spec::Rake::SpecTask.new(:sub) do |t|
+		t.spec_files = FileList['spec/inheritance_spec.rb']
+		t.libs << 'lib' << 'spec'
+		t.rcov = false
+		t.spec_opts = ['--options', 'spec/spec.opts']
+	end
+	Spec::Rake::SpecTask.new(:poro) do |t|
+		t.spec_files = FileList['spec/poro_spec.rb']
+		t.libs << 'lib' << 'spec'
+		t.rcov = false
+		t.spec_opts = ['--options', 'spec/spec.opts']
+	end
+=end	
   desc "Run ActiveRecord integration specs"
 	Spec::Rake::SpecTask.new(:active_record) do |t|
 		t.spec_files = FileList['spec/active_record/*_spec.rb']

data/lib/enumerated_attribute/attribute.rb

@@ -44,10 +44,25 @@ module EnumeratedAttribute
 				enums = enums.map{|v| (v =~ /^\^/ ? (initial_value ||= v[1, v.length-1].to_sym) : v.to_sym )}
 				
 				class_eval <<-ATTRIB
-					def self.enumerated_attributes; @@enumerated_attributes; end
-					def enums(attr); @@enumerated_attributes[attr.to_sym]; end
-					@@enumerated_attributes ||= {}
-					@@enumerated_attributes[:#{attr_name}] = AttributeDescriptor.new(:#{attr_name}, #{enums.inspect}, #{opts.inspect})
+					def self.enumerated_attributes(all=true)
+						return @enumerated_attributes unless all
+						return @all_enumerated_attributes_cache if @all_enumerated_attributes_cache
+						@all_enumerated_attributes_cache = @enumerated_attributes ?  @enumerated_attributes.dup : {}
+						klass = self.superclass
+						while (klass)
+							if (klass.respond_to?(:enumerated_attributes))
+								if (sub_enums = klass.enumerated_attributes)
+									@all_enumerated_attributes_cache = sub_enums.merge @all_enumerated_attributes_cache
+									break
+								end
+							end
+							klass = klass.superclass
+						end
+						@all_enumerated_attributes_cache
+					end
+					def enums(attr); self.class.enumerated_attributes[attr.to_sym]; end
+					@enumerated_attributes ||= {}
+					@enumerated_attributes[:#{attr_name}] = AttributeDescriptor.new(:#{attr_name}, #{enums.inspect}, #{opts.inspect})
 				ATTRIB
 				
 				#define_enumerated_attribute_[writer, reader] may be modified in a named Integrations module (see Integrations::ActiveRecord)
@@ -62,14 +77,14 @@ module EnumeratedAttribute
 						
 						def self.has_enumerated_attribute?(name)
 							return(false) if name.nil?
-							@@enumerated_attributes.key?(name.to_sym)
+							self.enumerated_attributes.key?(name.to_sym)
 						end
 						def self.enumerated_attribute_allows_nil?(name)
-							return(false) unless (descriptor = @@enumerated_attributes[name.to_sym])
+							return(false) unless (descriptor = self.enumerated_attributes[name.to_sym])
 							descriptor.allows_nil?
 						end
 						def self.enumerated_attribute_allows_value?(name, value)
-							return (false) unless (descriptor = @@enumerated_attributes[name.to_sym])
+							return (false) unless (descriptor = self.enumerated_attributes[name.to_sym])
 							return descriptor.allows_nil? if (value == nil || value == '')
 							descriptor.allows_value?(value)
 						end
@@ -103,8 +118,11 @@ module EnumeratedAttribute
 						end
 						
 						def initialize_enumerated_attributes(only_if_nil = false)
-							self.class.enumerated_attribute_initial_value_list.each do |k,v|
-								self.write_enumerated_attribute(k, v) unless (only_if_nil && read_enumerated_attribute(k) != nil)
+							#self.class.enumerated_attribute_initial_value_list.each do |k,v|
+							#	self.write_enumerated_attribute(k, v) unless (only_if_nil && read_enumerated_attribute(k) != nil)
+							#end
+							self.class.enumerated_attributes.each do |k,v|
+								self.write_enumerated_attribute(k, v.init_value) unless (only_if_nil && read_enumerated_attribute(k) != nil)
 							end
 						end
 
@@ -116,7 +134,7 @@ module EnumeratedAttribute
 							middle = meth_name.chop #remove the ?
 							
 							attr = nil
-							@@enumerated_attributes.keys.each do |name|
+							self.class.enumerated_attributes.keys.each do |name|
 								if middle.sub!(Regexp.new("^"+name.to_s), "")
 									attr = name; break
 								end
@@ -124,7 +142,7 @@ module EnumeratedAttribute
 							
 							value = nil
 							attr_sym = attr ? attr.to_sym : nil
-							if (descriptor = @@enumerated_attributes[attr_sym])
+							if (descriptor = self.class.enumerated_attributes[attr_sym])
 								descriptor.enums.each do |v|
 									if middle.sub!(Regexp.new(v.to_s+"$"), "")
 										value = v; break
@@ -132,7 +150,7 @@ module EnumeratedAttribute
 								end	
 							else
 								#search through enum values one at time and identify any ambiguities
-								@@enumerated_attributes.each do |attr_key,descriptor|
+								self.class.enumerated_attributes.each do |attr_key,descriptor|
 									descriptor.enums.each do|v|
 										if middle.match(v.to_s+"$")
 											raise(AmbiguousMethod, meth_name+" is ambiguous, use something like "+attr_sym.to_s+(middle[0,1]=='_'? '' : '_')+middle+"? or "+attr_key.to_s+(middle[0,1]=='_'? '' : '_')+middle+"?", caller) if attr_sym
@@ -172,7 +190,7 @@ module EnumeratedAttribute
 				#create state and action methods from block
 				initial_value = opts[:init] || initial_value  
 				if block_given?
-					m = EnumeratedAttribute::MethodDefinitionDSL.new(self, enumerated_attributes[attr_sym]) #attr_name, enums)
+					m = EnumeratedAttribute::MethodDefinitionDSL.new(self, self.enumerated_attributes(false)[attr_sym]) #attr_name, enums)
 					m.instance_eval(&block)
 					initial_value = m.initial_value || initial_value
 					plural_name = m.pluralized_name || plural_name
@@ -183,31 +201,33 @@ module EnumeratedAttribute
 				#define the enum values accessor
 				class_eval <<-ENUM
 					def #{plural_name}
-						@@enumerated_attributes[:#{attr_name}]
+						self.class.enumerated_attributes[:#{attr_name}]
 					end
 					def #{incrementor}
-						z = @@enumerated_attributes[:#{attr_name}].enums
+						z = self.class.enumerated_attributes[:#{attr_name}].enums
 						index = z.index(read_enumerated_attribute(:#{attr_name}))
 						write_enumerated_attribute(:#{attr_name}, z[index >= z.size-1 ? 0 : index+1])
 					end
 					def #{decrementor}
-						z = @@enumerated_attributes[:#{attr_name}].enums
+						z = self.class.enumerated_attributes[:#{attr_name}].enums
 						index = z.index(read_enumerated_attribute(:#{attr_name}))
 						write_enumerated_attribute(:#{attr_name}, z[index > 0 ? index-1 : z.size-1])
 					end
 				ENUM
 				
-				unless @enumerated_attribute_init
+				#unless defined?(@enumerated_attribute_init)
 					define_enumerated_attribute_new_method
-				end
-				@enumerated_attribute_init ||= {}		
-				if (initial_value = opts[:init] || initial_value)
-					@enumerated_attribute_init[attr_sym] = initial_value 
-				end
+				#end
+				#@enumerated_attribute_init ||= {}		
+				#if (initial_value = opts[:init] || initial_value)
+				#	@enumerated_attribute_init[attr_sym] = initial_value 
+				#end
 				class_eval do
-					class << self
-						def enumerated_attribute_initial_value_list; @enumerated_attribute_init; end
+					@enumerated_attributes ||={}
+					if (initial_value = opts[:init] || initial_value)
+						@enumerated_attributes[attr_sym].init_value = initial_value
 					end
+					#def self.enumerated_attribute_initial_value_list; @enumerated_attribute_init; end
 				end
 				
 				def self.define_enumerated_attribute_custom_method(symbol, attr_name, value, negated)

data/lib/enumerated_attribute/attribute/attribute_descriptor.rb

@@ -3,6 +3,7 @@ module EnumeratedAttribute
 	module Attribute
 		class AttributeDescriptor < Array		
 			attr_reader :name
+			attr_accessor :init_value
 			
 			def initialize(name, enums=[], opts={})
 				super enums
@@ -39,7 +40,7 @@ module EnumeratedAttribute
 				@labels_hash[enum_value.to_sym] = label_string
 			end
 			
-			private
+			protected
 			def reset_labels
 				@labels_array = nil
 				@select_options = nil

data/lib/enumerated_attribute/integrations/active_record.rb

@@ -50,9 +50,13 @@ module EnumeratedAttribute
 			end
 			
 			def attributes
-				super.map do |k,v|
-					self.class.has_enumerated_attribute?(k) ? @@enumerated_attributes[k].cast_enum_symbol(v) : v
+				atts = super
+				atts.each do |k,v|
+					if self.class.has_enumerated_attribute?(k)
+						atts[k] = v.to_sym if v
+					end
 				end
+				atts
 			end
 			
       def [](attr_name); read_enumerated_attribute(attr_name); end
@@ -73,9 +77,9 @@ module EnumeratedAttribute
 				
 				def instantiate(record)
 					object = super(record)
-					@enumerated_attribute_init.each do |k,v|
-						unless object.has_attribute?(k)
-							object.write_enumerated_attribute(k, v)
+					self.enumerated_attributes.each do |k,v|
+						unless object.has_attribute?(k) #only initialize the non-column enumerated attributes
+							object.write_enumerated_attribute(k, v.init_value)
 						end
 					end
 					object
@@ -84,14 +88,16 @@ module EnumeratedAttribute
 				def define_enumerated_attribute_new_method
 					class_eval <<-INITVAL
 						class << self
-							alias_method :new_without_enumerated_attribute, :new
-							def new(*args, &block)
-								result = new_without_enumerated_attribute(*args, &block)
-								params = (!args.empty? && args.first.instance_of?(Hash)) ? args.first : {}
-								params.each { |k, v| result.write_enumerated_attribute(k, v) }
-								result.initialize_enumerated_attributes(true)
-								yield result if block_given?
-								result
+							unless method_defined?(:new_without_enumerated_attribute)						
+								alias_method :new_without_enumerated_attribute, :new
+								def new(*args, &block)
+									result = new_without_enumerated_attribute(*args, &block)
+									params = (!args.empty? && args.first.instance_of?(Hash)) ? args.first : {}
+									params.each { |k, v| result.write_enumerated_attribute(k, v) }
+									result.initialize_enumerated_attributes(true)
+									yield result if block_given?
+									result
+								end
 							end
 						end
 					INITVAL

data/lib/enumerated_attribute/integrations/object.rb

@@ -27,12 +27,14 @@ module EnumeratedAttribute
 				def define_enumerated_attribute_new_method
 					class_eval <<-NEWMETH
 						class << self
-							alias_method :new_without_enumerated_attribute, :new
-							def new(*args, &block)
-								result = new_without_enumerated_attribute(*args)
-								result.initialize_enumerated_attributes
-								yield result if block_given?
-								result
+							unless method_defined?(:new_without_enumerated_attribute)
+								alias_method :new_without_enumerated_attribute, :new
+								def new(*args, &block)
+									result = new_without_enumerated_attribute(*args)
+									result.initialize_enumerated_attributes
+									yield result if block_given?
+									result
+								end
 							end
 						end
 					NEWMETH

data/lib/jeffp-enumerated_attribute.rb

@@ -0,0 +1 @@
+require 'enumerated_attribute'

data/spec/active_record/active_record_spec.rb

@@ -192,6 +192,42 @@ describe "RaceCar" do
 		r=RaceCar.new
 		lambda { r.attributes = {:lights=>'off', :gear =>:drive} }.should raise_error(EnumeratedAttribute::InvalidEnumeration)
 	end
+
+=begin
+	#do not write symbols to enumerated column attributes using write_attribute
+	#do not user read_attribute to read an enumerated column attribute
+	it "should write enumeration with write_attribute" do
+		r=RaceCar.new
+		r.write_attribute(:gear, :first)
+		r.gear.should == :first
+		r.save!
+		
+		s=RaceCar.find r.id
+		s.gear.should == :first
+		s.write_attribute(:gear, :second)
+		s.save!
+		
+		t=RaceCar.find s.id
+		t.gear.should == :second
+	end
+	
+	it "should raise error when setting enumerated column attribute to invalid enum using write_attribute" do
+		r=RaceCar.new
+		lambda { r.write_attribute(:gear, :yo) }.should raise_error
+	end	
+=end
+	
+	it "should retrieve symbols for enumerations from ActiveRecord :attributes method" do
+		r=RaceCar.new
+		r.gear = :second
+		r.choke = :medium
+		r.lights = 'on'
+		r.save!
+		
+		s = RaceCar.find(r.id)
+		s.attributes['gear'].should == :second
+		s.attributes['lights'].should == 'on'
+	end
 	
 	it "should update_attribute for enumerated column attribute" do
 		r=RaceCar.new
@@ -231,12 +267,48 @@ describe "RaceCar" do
 	end
 	
 	it "should provide symbol values for enumerated column attributes from the :attributes method" do
+		r=RaceCar.new
+		r.lights = 'on'
+		r.save!
+		
+		s=RaceCar.find r.id
+		s.attributes['gear'].should == :neutral
+	end
+	
+	it "should provide normal values for non-enumerated column attributes from the :attributes method"  do
+		r=RaceCar.new
+		r.lights = 'on'
+		r.save!
+		
+		s=RaceCar.find r.id
+		s.attributes['lights'].should == 'on'
 	end
 	
-	it "should provide normal values for non-enumerated column attributes from the :attributes method" do
+	it "should raise InvalidEnumeration when setting invalid enumertion value with :attributes= method" do
+		r=RaceCar.new
+		lambda { r.attributes = {:gear=>:yo, :lights=>'on'} }.should raise_error(EnumeratedAttribute::InvalidEnumeration)
 	end
 	
-	it "should raise ArgumentError when setting invalid enumertion value with :attributes= method" do
+	it "should not set init value for enumerated column attribute saved as nil" do
+		r=RaceCar.new
+		r.gear = nil
+		r.lights = 'on'
+		r.save!
+		
+		s=RaceCar.find r.id
+		s.gear.should == nil
+		s.lights.should == 'on'
+	end
+	
+	it "should not set init value for enumerated column attributes saved as value" do
+		r=RaceCar.new
+		r.gear = :second
+		r.lights = 'all'
+		r.save!
+		
+		s=RaceCar.find r.id
+		s.gear.should == :second
+		s.lights.should == 'all'
 	end
 
 	it "should save and retrieve its name" do

data/spec/active_record/inheritance_classes.rb

@@ -0,0 +1,19 @@
+require 'race_car'
+
+class SubRaceCar < RaceCar
+	set_table_name "race_cars"
+
+	enum_attr :extra, %w(^one two three four)
+end
+
+class SubRaceCar2 < RaceCar
+	set_table_name "race_cars"
+	
+end
+
+class SubRaceCar3 < RaceCar
+	set_table_name "race_cars"
+	
+	enum_attr :gear, %w(reverse neutral ^first second third over_drive)
+end
+

data/spec/active_record/inheritance_spec.rb

@@ -0,0 +1,60 @@
+require 'test_in_memory'
+require 'enumerated_attribute'
+require 'active_record'
+require 'inheritance_classes'
+
+def one_to_four; [:one, :two, :three, :four]; end
+def gear1; [:reverse, :neutral, :first, :second, :over_drive]; end
+def gear2; [:reverse, :neutral, :first, :second, :third, :over_drive]; end
+def choke; [:none, :medium, :full]; end
+
+describe "SubRaceCar" do
+	it "should have :gear init to :neutral" do
+		o=SubRaceCar.new
+		o.gear.should == :neutral
+		o.enums(:gear).should == gear1
+		o.gear_previous.should == :reverse
+	end
+	it "should have :choke init to :none" do
+		o=SubRaceCar.new
+		o.choke.should == :none
+		o.enums(:choke).should == choke
+		o.choke_previous.should == :full
+	end
+	it "should have :extra init to :one" do
+		o=SubRaceCar.new
+		o.extra.should == :one
+		o.enums(:extra).should == one_to_four
+		o.extra_previous.should == :four
+	end
+end
+
+describe "SubRaceCar2" do
+	it "should have :gear init to :neutral" do
+		o=SubRaceCar2.new
+		o.gear.should == :neutral
+		o.enums(:gear).should == gear1
+		o.gear_previous.should == :reverse
+	end
+	it "should have :choke init to :none" do
+		o=SubRaceCar2.new
+		o.choke.should == :none
+		o.enums(:choke).should == choke
+		o.choke_previous.should == :full
+	end
+end
+
+describe "SubRaceCar3" do
+	it "should have overridden :gear init to :first" do
+		o=SubRaceCar3.new
+		o.gear.should == :first
+		o.enums(:gear).should == gear2
+		o.gear_previous.should == :neutral
+	end
+	it "should have :choke init to :none" do
+		o=SubRaceCar3.new
+		o.choke.should == :none
+		o.enums(:choke).should == choke
+		o.choke_previous.should == :full
+	end
+end

data/spec/active_record/race_car.rb

@@ -8,3 +8,8 @@ end
 #choke = enumerated non-column attribute
 #lights = non-enumerated column attribute
 
+=begin
+	t.string :name
+	t.string :gear
+	t.string :lights
+=end

data/spec/cfg.rb

@@ -1,6 +1,7 @@
 #irb -r cfg ==> to work configure for working in IRB
-$: << '../lib'
+$:.unshift '../lib'
 require 'enumerated_attribute'
 require 'tractor'
 require 'car'
 require 'plural'
+require 'inheritance_classes'

data/spec/inheritance_classes.rb

@@ -0,0 +1,16 @@
+require 'enumerated_attribute'
+
+class Base
+	enum_attr :base1, %w(^one two three four)
+	enum_attr :inherited1, %w(^one two three four)
+	enum_attr :inherited2, %w(^one two three four)
+end
+
+class Sub < Base
+	enum_attr :sub1, %w(one ^two three four)
+	enum_attr :inherited1, %w(one ^two three four)
+	enum_attr :inherited2, %w(^five six seven eight)
+end
+
+class Sub2 < Base
+end

data/spec/inheritance_spec.rb

@@ -0,0 +1,80 @@
+require 'inheritance_classes'
+
+def one_to_four; [:one, :two, :three, :four]; end
+def five_to_eight; [:five, :six, :seven, :eight]; end
+
+describe "Base" do
+	it "should have :base1 init to :one" do
+		o=Base.new
+		o.base1.should == :one
+		o.enums(:base1).should == one_to_four
+		o.base1_previous.should == :four
+	end
+	it "should have :inherited1 init to :one" do
+		o=Base.new
+		o.inherited1.should == :one
+		o.enums(:inherited1).should == one_to_four
+		o.inherited1_previous.should == :four
+	end
+	it "should have :inherited2 init to :one" do
+		o=Base.new
+		o.inherited2.should == :one
+		o.enums(:inherited2).should == one_to_four
+		o.inherited2_previous.should == :four
+	end	
+end
+
+describe "Sub<Base" do
+	it "should instantiate an object" do
+		lambda { s=Sub.new }.should_not raise_error
+	end
+	it "should have :sub1 init to :two" do
+		o=Sub.new
+		o.sub1.should == :two
+		o.enums(:sub1).should == one_to_four
+		o.sub1_previous.should == :one
+	end
+	it "should have :base1 init to :one" do
+		o=Sub.new
+		o.base1.should == :one
+		o.enums(:base1).should == one_to_four
+		o.base1_previous.should == :four
+	end
+	it "should have :inherited1 init to :two" do
+		o=Sub.new
+		o.inherited1.should == :two
+		o.enums(:inherited1).should == one_to_four
+		o.inherited1_previous.should == :one
+	end
+	it "should have :inherited2 init to :five" do
+		o=Sub.new
+		o.inherited2.should == :five
+		o.enums(:inherited2).should == five_to_eight
+		o.inherited2_previous.should == :eight
+	end		
+end
+
+describe "Sub2<Base" do
+	it "should instantiate an object" do
+		lambda {s=Sub2.new}.should_not raise_error
+	end
+	it "should have :base1 init to :one" do
+		o=Sub2.new
+		o.base1.should == :one
+		o.enums(:base1).should == one_to_four
+		o.base1_previous.should == :four
+	end
+	it "should have :inherited1 init to :one" do
+		o=Sub2.new
+		o.inherited1.should == :one
+		o.enums(:inherited1).should == one_to_four
+		o.inherited1_previous.should == :four
+	end
+	it "should have :inherited2 init to :one" do
+		o=Sub2.new
+		o.inherited2.should == :one
+		o.enums(:inherited2).should == one_to_four
+		o.inherited2_previous.should == :four
+	end	
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jeffp-enumerated_attribute
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Jeff Patmon
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-07 00:00:00 -07:00
+date: 2009-08-08 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -35,16 +35,21 @@ files:
 - lib/enumerated_attribute/method_definition_dsl.rb
 - lib/enumerated_attribute/rails_helpers.rb
 - lib/enumerated_attribute.rb
+- lib/jeffp-enumerated_attribute.rb
 - spec/active_record
 - spec/active_record/active_record_spec.rb
 - spec/active_record/associations_spec.rb
 - spec/active_record/association_test_classes.rb
 - spec/active_record/cfg.rb
+- spec/active_record/inheritance_classes.rb
+- spec/active_record/inheritance_spec.rb
 - spec/active_record/race_car.rb
 - spec/active_record/single_table_inheritance_spec.rb
 - spec/active_record/test_in_memory.rb
 - spec/car.rb
 - spec/cfg.rb
+- spec/inheritance_classes.rb
+- spec/inheritance_spec.rb
 - spec/new_and_method_missing_spec.rb
 - spec/plural.rb
 - spec/poro_spec.rb
@@ -175,5 +180,6 @@ signing_key:
 specification_version: 3
 summary: Add enumerated attributes to your models and expose them in drop-down lists in your views
 test_files: 
+- spec/inheritance_spec.rb
 - spec/new_and_method_missing_spec.rb
 - spec/poro_spec.rb