enumerated_attribute 0.2.7

data/lib/jeffp-enumerated_attribute.rb

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

data/spec/active_record/active_record_spec.rb

@@ -0,0 +1,363 @@
+require 'test_in_memory'
+require 'active_record'
+require 'enumerated_attribute'
+require 'race_car'
+
+describe "RaceCar" do
+
+	it "should have default labels for :gear attribute" do
+		labels_hash = {:reverse=>'Reverse', :neutral=>'Neutral', :first=>'First', :second=>'Second', :over_drive=>'Over drive'}
+		labels = ['Reverse', 'Neutral', 'First', 'Second', 'Over drive']
+		select_options = [['Reverse', 'reverse'], ['Neutral', 'neutral'], ['First', 'first'], ['Second', 'second'], ['Over drive', 'over_drive']]
+		r=RaceCar.new
+		r.gears.labels.should == labels
+		labels_hash.each do |k,v|
+			r.gears.label(k).should == v
+		end
+		r.gears.hash.should == labels_hash
+		r.gears.select_options.should == select_options
+	end
+	
+	it "should retrieve :gear enums through enums method" do
+		r=RaceCar.new
+		r.enums(:gear).should == r.gears
+	end
+
+	it "should return a Symbol type from reader methods" do
+		r=RaceCar.new
+		r.gear.should be_an_instance_of(Symbol)
+	end
+	
+	it "should increment and decrement :gear attribute correctly" do
+		r=RaceCar.new
+		r.gear = :neutral
+		r.gear_next.should == :first
+		r.gear_next.should == :second
+		r.gear_next.should == :over_drive
+		r.gear_next.should == :reverse
+		r.gear_next.should == :neutral
+		r.gear.should == :neutral
+		r.gear_previous.should == :reverse
+		r.gear_previous.should == :over_drive
+		r.gear_previous.should == :second
+		r.gear_previous
+		r.gear.should == :first
+	end
+	
+	it "should have dynamic predicate methods for :gear attribute" do
+		r=RaceCar.new
+		r.gear = :second
+		r.gear_is_in_second?.should be_true
+		r.gear_not_in_second?.should be_false
+		r.gear_is_nil?.should be_false
+		r.gear_is_not_nil?.should be_true
+	end
+	
+	it "should have working dynamic predicate methods on retrieved objects" do
+		r=RaceCar.new
+		r.gear = :second
+		r.save!
+		
+		s=RaceCar.find r.id
+		s.should_not be_nil
+		s.gear_is_in_second?.should be_true
+		s.gear_is_not_in_second?.should be_false
+		s.gear_is_nil?.should be_false
+		s.gear_is_not_nil?.should be_true
+	end
+	
+	it "should find record by enumerated column :gear attributes" do
+		r=RaceCar.new
+		r.gear = :second
+		r.name = 'special'
+		r.save!
+		
+		s=RaceCar.find_by_gear_and_name(:second, 'special')
+		s.should_not be_nil
+		s.id.should == r.id
+	end
+	
+	it "should initialize according to enumerated attribute definitions" do
+		r = RaceCar.new
+		r.gear.should == :neutral
+		r.choke.should == :none
+	end
+	
+	it "should create new instance using block" do
+		r = RaceCar.new do |r|
+			r.gear = :first
+			r.choke = :medium
+			r.lights = 'on'
+		end
+		r.gear.should == :first
+		r.lights.should == 'on'
+		r.choke.should == :medium
+	end
+	
+	it "should initialize using parameter hash with symbol keys" do
+		r=RaceCar.new(:name=>'FastFurious', :gear=>:second, :lights=>'on', :choke=>:medium)
+		r.gear.should == :second
+		r.lights.should == 'on'
+		r.choke.should == :medium
+	end
+	
+	it "should initialize using parameter hash with string keys" do
+		r=RaceCar.new({'name'=>'FastFurious', 'gear'=>'second', 'lights'=>'on', 'choke'=>'medium'})
+		r.gear.should == :second
+		r.lights.should == 'on'
+		r.choke.should == :medium
+	end
+	
+	
+	it "should convert non-column enumerated attributes from string to symbols" do
+		r=RaceCar.new
+		r.choke = 'medium'
+		r.choke.should == :medium
+		r.save!		
+	end
+	
+	it "should convert enumerated column attributes from string to symbols" do
+		r=RaceCar.new
+		r.gear = 'second'
+		r.gear.should == :second
+		r.save!
+
+		s=RaceCar.find r.id
+		s.gear.should == :second
+	end
+	
+	it "should not convert non-enumerated column attributes from string to symbols" do
+		r=RaceCar.new
+		r.lights = 'off'
+		r.lights.should == 'off'
+		r.save!
+		
+		s=RaceCar.find r.id
+		s.lights.should == 'off'
+	end	
+
+	it "should raise InvalidEnumeration when parametrically initialized with :gear=>:drive" do
+		r=RaceCar.new
+		lambda{ r.gear= :drive}.should raise_error(EnumeratedAttribute::InvalidEnumeration)
+	end
+	
+	it "should raise InvalidEnumeration when parametrically initialized with :choke=>:all" do
+		r=RaceCar.new
+		lambda{ r.choke= :all}.should raise_error(EnumeratedAttribute::InvalidEnumeration)
+	end
+	
+	it "should return non-column enumerated attributes from [] method" do
+		r = RaceCar.new
+		r[:choke].should == :none
+	end
+	
+	it "should return enumerated column attributes from [] method" do
+		r=RaceCar.new
+		r.gear = :neutral
+		r[:gear].should == :neutral
+	end
+	
+	it "should set non-column enumerated attributes with []= method" do
+		r=RaceCar.new
+		r[:choke] = :medium
+		r.choke.should == :medium
+	end
+	
+	it "should set enumerated column attriubtes with []= method" do
+		r=RaceCar.new
+		r[:gear] = :second
+		r.gear.should == :second
+	end
+	
+	it "should raise InvalidEnumeration when setting enumerated column attribute with []= method" do
+		r=RaceCar.new
+		lambda{ r[:gear]= :drive }.should raise_error(EnumeratedAttribute::InvalidEnumeration)
+	end
+	
+	it "should set and retrieve string for non-enumerated column attributes with []=" do
+		r=RaceCar.new
+		r[:lights] = 'on'
+		r.lights.should == 'on'
+		r[:lights].should == 'on'
+	end
+	
+	it "should set and retrieve symbol for non-enumerated column attributes with []=" do
+		r=RaceCar.new
+		r[:lights] = :on
+		r.lights.should == :on
+		r[:lights].should == :on
+	end
+
+	it "should raise InvalidEnumeration for invalid enum passed to attributes=" 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
+		r.gear = :first
+		r.save!
+		r.update_attribute(:gear, :second)
+		r.gear.should == :second
+		
+		s=RaceCar.find r.id
+		s.gear.should == :second
+	end
+	
+	it "should update_attribute for non-enumerated column attribute" do
+		r=RaceCar.new
+		r.lights = 'on'
+		r.save!
+		r.update_attribute(:lights, 'off')
+		r.lights.should == 'off'
+		
+		s=RaceCar.find r.id
+		s.lights.should == 'off'
+	end
+	
+	it "should update_attributes for both non- and enumerated column attributes" do
+		r=RaceCar.new
+		r.gear = :first
+		r.lights = 'off'
+		r.save!
+		r.update_attributes({:gear=>:second, :lights=>'on'})
+		s=RaceCar.find r.id
+		s.gear.should == :second
+		s.lights.should == 'on'
+		s.update_attributes({:gear=>'over_drive', :lights=>'off'})
+		t=RaceCar.find s.id
+		t.gear.should == :over_drive
+		t.lights.should == 'off'
+	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 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 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
+		r = RaceCar.new
+		r.name= 'Green Meanie'
+		r.save!
+		
+		s = RaceCar.find r.id
+		s.should_not be_nil
+		s.name.should == 'Green Meanie'
+	end
+	
+	it "should save and retrieve symbols for enumerated column attribute" do
+		r = RaceCar.new
+		r.gear = :over_drive
+		r.save!
+		
+		s = RaceCar.find r.id
+		#s.should_not be_nil
+		s.gear.should == :over_drive
+	end
+	
+	it "should not save values for non-column enumerated attributes" do
+		r=RaceCar.new
+		r.choke = :medium
+		r.save!
+		
+		s=RaceCar.find r.id
+		s.choke.should == :none
+	end
+	
+	it "should save string and retrieve string for non-enumerated column attributes" do
+		r =RaceCar.new
+		r.lights = 'on'
+		r.save!
+		
+		s = RaceCar.find r.id
+		s.lights.should == 'on'
+		s[:lights].should == 'on'
+	end
+	
+	it "should save symbol and retrieve string for non-enumerated column attributes" do
+		r =RaceCar.new
+		r.lights = :off
+		r.save!
+		
+		s = RaceCar.find r.id
+		s.lights.should == "--- :off\n"
+		s[:lights].should == "--- :off\n"
+	end
+	
+end

data/spec/active_record/association_test_classes.rb

@@ -0,0 +1,40 @@
+
+class Company < ActiveRecord::Base
+	has_one :license
+	has_many :employees
+	has_many :contract_workers
+	has_many :contractors, :through=>:contract_workers
+	enum_attr :status, %w(s_corp c_corp llc), :nil=>true
+end
+class Employee < ActiveRecord::Base
+  belongs_to :company
+	enum_attr :status, %w(full_time part_time suspended), :nil=>true
+end
+class License < ActiveRecord::Base
+  belongs_to :company
+	enum_attr :status, %w(^current expired)
+end
+class Contractor < ActiveRecord::Base
+	has_many :contract_workers
+	has_many :companies, :through=>:contract_workers
+	enum_attr :status, %w(^available unavailable)
+end
+class ContractWorker < ActiveRecord::Base
+  belongs_to :company
+	belongs_to :contractor
+	enum_attr :status, %w(unfresh ^unfresh) #i don't know what to put here
+end
+
+#polymorphic
+class Comment < ActiveRecord::Base
+	belongs_to :document, :polymorphic=>true
+	enum_attr :status, %w(^unflagged flagged)
+end
+class Article < ActiveRecord::Base
+	has_one :comment, :as=>:document
+	enum_attr :status, %w(^unreviewed accepted)
+end
+class Image < ActiveRecord::Base
+	has_one :comment, :as=>:document
+	enum_attr :status, %w(^unreviewed accepted)
+end

data/spec/active_record/associations_spec.rb

@@ -0,0 +1,130 @@
+require 'test_in_memory'
+require 'enumerated_attribute'
+require 'active_record'
+require 'association_test_classes'
+
+module TestVariables
+	def company_name; 'Company A'; end
+end
+
+describe "Polymorphic associations" do
+	include TestVariables
+	
+	it "should retrieve enum'ed attribute for articles and images of a comment" do
+		c1 = Comment.new(:comment=>'i like it')
+		c1.document = Article.create!(:name=>'Birds of a Feather', :status=>:accepted)
+		c1.save!
+		c1.status.should == :unflagged
+		
+		c2 = Comment.new(:comment=>'i hate it', :status => :flagged)
+		c2.document = Image.create!(:name=>'Martian Landscape', :status=>:unreviewed)
+		c2.save!
+		c2.status.should == :flagged
+		
+		Comment.find(c1.id).document.status.should == :accepted
+		Comment.find(c2.id).document.status.should == :unreviewed
+
+	end
+	
+	it "should retrieve enum'ed attribute for comments on articles and images" do
+		a = Article.create!(:name=>'Swimming with Whales', :status=>:accepted)
+		a.create_comment(:comment=>'i like it', :status=>:unflagged)
+		a.save!
+		
+		i = Image.create!(:name=>'Mountain Climbing', :status=>:unreviewed)
+		i.comment = Comment.create!(:comment=>'i do not like it', :status=>:flagged)
+		i.save!
+		
+		Image.find(i.id).comment.status.should == :flagged
+		Article.find(a.id).comment.status.should == :unflagged
+		
+	end
+	
+end
+
+describe "Basic Associations" do
+	include TestVariables
+
+	it "should retrieve enum'ed status for its license" do
+		c = Company.new(:status=>:llc, :name=>company_name)
+		c.save!
+		c.create_license(:status=>:current)
+		
+		r = Company.find(c.id)
+		lic = r.license
+		r.status.should == :llc
+		lic.status.should == :current
+	end
+	
+	it "should retrieve enum'ed status for multiple employees" do
+		c=Company.new(:status=>:llc, :name=>company_name)
+		c.save!
+		c.employees.create!(:status=>:full_time, :name=>'edward')
+		c.employees.create!(:status=>:suspended, :name=>'tina')
+		
+		r=Company.find(c.id)
+		r.employees.find_by_name('edward').status.should == :full_time		
+		r.employees.find_by_name('tina').status.should == :suspended		
+		Employee.delete_all
+	end
+	
+	it "should retrieve enum'ed status for multiple contractors" do
+		c=Company.new(:status=>:llc, :name=>company_name)
+		c.save!
+		c1 = Contractor.new(:status=>:available, :name=>'john')
+		c2 = Contractor.new(:status=>:unavailable, :name=>'sally')
+		c.contractors << c1
+		c.contractors << c2
+		
+		r=Company.find(c.id)
+		r.contractors.find_by_name('sally').status.should == :unavailable
+		r.contractors.find_by_name('john').status.should == :available
+		Contractor.delete_all
+		ContractWorker.delete_all
+	end
+end
+
+describe "License" do
+	include TestVariables
+  it "should retrieve the status for the company" do
+		Company.delete_all
+		License.delete_all
+		lic = License.create!(:status=>:expired)
+		lic.company = Company.create!(:name=>company_name, :status=>:llc)
+		lic.save!
+		
+		License.find(lic.id).company.status.should == :llc
+	end
+end
+
+describe "Contractor" do
+	include TestVariables
+	it "should retrieve enum'ed status from multiple companies" do
+		Company.delete_all
+		Contractor.delete_all
+		ContractWorker.delete_all
+		c = Contractor.create!(:name=>'jack', :status=>:available)
+		
+		c1 = Company.create!(:name=>company_name, :status=>:s_corp)
+		c2 = Company.create!(:name=>'other company', :status=>:llc)
+		c.companies << c1 << c2
+		
+		j = Contractor.find(c.id)
+		j.companies.find_by_name('other company').status.should == :llc
+		j.companies.find_by_name(company_name).status.should == :s_corp		
+	end
+end
+
+describe "Employee" do
+	include TestVariables
+	it "should retrieve enum'ed status from the company" do
+		Company.delete_all
+		Employee.delete_all
+		e = Employee.create!(:name=>'juanita', :status=>:part_time)
+		e.company = Company.create!(:name=>company_name, :status=>:c_corp)
+		e.save!
+		
+		emp = Employee.find(e.id)
+		emp.company.status.should == :c_corp
+	end
+end