classy_enum 1.3.1 → 1.3.2

data/.travis.yml

@@ -1,3 +1,4 @@
 rvm:
   - 1.8.7
   - 1.9.2
+  - 1.9.3

data/README.textile

@@ -149,6 +149,26 @@ In the above example, high priority alarms are only emailed if the owning alarm
 @alarm.send_email? # => false
 </pre>
 
+h2. Serializing as JSON
+
+By default, the enum will be serialized as a string representing the value:
+
+<pre>
+@alarm = Alarm.create(:priority => :high, :enabled => true)
+@alarm.to_json.should == "{\"alarm\":{\"priority\":\"high\"}}"
+</pre>
+
+This behavior can be overridden by using the @:serialize_as_json => true@ option in your ActiveRecord model:
+
+<pre>
+class Alarm < ActiveRecord::Base
+  classy_enum_attr :priority, :serialize_as_json => true
+end
+
+@alarm = Alarm.create(:priority => :high, :enabled => true)
+@alarm.to_json.should == "{\"alarm\":{\"priority\":{}}}"
+</pre>
+
 h2. Special Cases
 
 What if your enum class name is not the same as your model's attribute name? No problem! Just use a second arugment in @classy_enum_attr@ to declare the attribute name. In this case, the model's attribute is called *alarm_priority*.

data/VERSION

@@ -1 +1 @@
-1.3.1
+1.3.2

data/classy_enum.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{classy_enum}
-  s.version = "1.3.1"
+  s.version = "1.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = [%q{Peter Brown}]
-  s.date = %q{2011-10-28}
+  s.date = %q{2011-11-12}
   s.description = %q{A utility that adds class based enum functionality to ActiveRecord attributes}
   s.email = %q{github@lette.us}
   s.extra_rdoc_files = [

data/lib/classy_enum/attributes.rb

@@ -25,6 +25,7 @@ module ClassyEnum
       enum = options[:enum] || attribute
       allow_blank = options[:allow_blank] || false
       allow_nil = options[:allow_nil] || false
+      serialize_as_json = options[:serialize_as_json] || false
 
       klass = enum.to_s.camelize.constantize
 
@@ -36,7 +37,7 @@ module ClassyEnum
 
         # Define getter method that returns a ClassyEnum instance
         define_method attribute do
-          klass.build(super(), self)
+          klass.build(super(), :owner => self, :serialize_as_json => serialize_as_json)
         end
 
         # Define setter method that accepts either string or symbol for member

data/lib/classy_enum/class_methods.rb

@@ -26,15 +26,12 @@ module ClassyEnum
           @index = index + 1
           @option = option
 
+          attr_accessor :owner, :serialize_as_json
+
           # Use ActiveModel::AttributeMethods to define attribute? methods
           attribute_method_suffix '?'
           define_attribute_methods enums
 
-          def initialize
-            @to_s = self.class.instance_variable_get('@option').to_s
-            @index = self.class.instance_variable_get('@index')
-          end
-
         end
 
         klass_name = "#{self}#{option.to_s.camelize}"
@@ -51,12 +48,13 @@ module ClassyEnum
     #  end
     #
     #  Priority.build(:low) # => PriorityLow.new
-    def build(option, owner = nil)
-      return option if option.blank?
-      return TypeError.new("Valid #{self} options are #{self.valid_options}") unless self::OPTIONS.include? option.to_sym
+    def build(value, options={})
+      return value if value.blank?
+      return TypeError.new("Valid #{self} options are #{self.valid_options}") unless self::OPTIONS.include? value.to_sym
 
-      object = Object.const_get("#{self}#{option.to_s.camelize}").new
-      object.instance_variable_set(:@owner,owner) unless owner.nil?
+      object = Object.const_get("#{self}#{value.to_s.camelize}").new
+      object.owner = options[:owner]
+      object.serialize_as_json = options[:serialize_as_json]
       object
     end
 

data/lib/classy_enum/instance_methods.rb

@@ -12,7 +12,7 @@ module ClassyEnum
     #  @priority = PriorityMedium.new
     #  @priority.index # => 2
     def index
-      @index
+      self.class.instance_variable_get('@index')
     end
 
     alias :to_i :index
@@ -28,7 +28,7 @@ module ClassyEnum
     #  @priority = PriorityLow.new
     #  @priority.to_s # => 'low'
     def to_s
-      @to_s
+      self.class.instance_variable_get('@option').to_s
     end
 
     # Returns a Symbol corresponding to a string representation of element,
@@ -43,7 +43,7 @@ module ClassyEnum
     #  @priority = PriorityLow.new
     #  @priority.to_sym # => :low
     def to_sym
-      @to_s.to_sym
+      to_s.to_sym
     end
 
     # Returns string representing enum in Rails titleize format
@@ -57,7 +57,7 @@ module ClassyEnum
     #  @priority = Priority.build(:really_high)
     #  @priority.name # => "Really High"
     def name
-      @to_s.titleize
+      to_s.titleize
     end
 
     # Sort an array of elements based on the order they are defined
@@ -76,7 +76,7 @@ module ClassyEnum
     #  priorities.max # => @high
     #  priorities.min # => @low
     def <=> other
-      @index <=> other.index
+      index <=> other.index
     end
 
     # Used by ActiveRecord::PredicateBuilder when building from a hash
@@ -92,8 +92,10 @@ module ClassyEnum
 
     # Overrides as_json to remove owner reference recursion issues
     def as_json(options=nil)
+      return to_s unless serialize_as_json
       json = super(options)
       json.delete('owner')
+      json.delete('serialize_as_json')
       json
     end
 

data/spec/classy_enum_owner_reference_spec.rb

@@ -15,9 +15,15 @@ class Cat < ActiveRecord::Base
   delegate :breed_color, :to => :breed
 end
 
+class OtherCat < ActiveRecord::Base
+  classy_enum_attr :breed, :enum => :cat_breed, :serialize_as_json => true
+  attr_accessor :color
+  delegate :breed_color, :to => :breed
+end
+
 describe Cat do
   let(:abyssian) { Cat.new(:breed => :abyssian, :color => 'black') }
-  let(:persian) { Cat.new(:breed => :persian, :color => 'white') }
+  let(:persian) { OtherCat.new(:breed => :persian, :color => 'white') }
 
   it 'should delegate breed color to breed with an ownership reference' do
     abyssian.breed_color { should eql('black Abyssian') }
@@ -25,8 +31,11 @@ describe Cat do
   end
 
   it 'should correctly serialize without the owner reference' do
-    abyssian.to_json.should == "{\"cat\":{\"breed\":{\"to_s\":\"abyssian\",\"index\":1}}}"
-    persian.to_json.should == "{\"cat\":{\"breed\":{\"to_s\":\"persian\",\"index\":4}}}"
+    abyssian.to_json.should == "{\"cat\":{\"breed\":\"abyssian\"}}"
+  end
+
+  it 'should convert the enum to a string when serializing' do
+    persian.to_json.should == "{\"other_cat\":{\"breed\":{}}}"
   end
 
 end

data/spec/spec_helper.rb

@@ -43,6 +43,10 @@ ActiveRecord::Schema.define(:version => 1) do
   create_table :cats, :force => true do |t|
     t.string :breed
   end
+
+  create_table :other_cats, :force => true do |t|
+    t.string :breed
+  end
 end
 
 class Breed < ClassyEnum::Base

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: classy_enum
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-28 00:00:00.000000000Z
+date: 2011-11-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70107427721740 !ruby/object:Gem::Requirement
+  requirement: &70109521646960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70107427721740
+  version_requirements: *70109521646960
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70107427721140 !ruby/object:Gem::Requirement
+  requirement: &70109521646460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.6.2
   type: :development
   prerelease: false
-  version_requirements: *70107427721140
+  version_requirements: *70109521646460
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70107427720540 !ruby/object:Gem::Requirement
+  requirement: &70109521645440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.6.1
   type: :development
   prerelease: false
-  version_requirements: *70107427720540
+  version_requirements: *70109521645440
 - !ruby/object:Gem::Dependency
   name: formtastic
-  requirement: &70107427719940 !ruby/object:Gem::Requirement
+  requirement: &70109521644780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.2.4
   type: :development
   prerelease: false
-  version_requirements: *70107427719940
+  version_requirements: *70109521644780
 - !ruby/object:Gem::Dependency
   name: sqlite3-ruby
-  requirement: &70107427719340 !ruby/object:Gem::Requirement
+  requirement: &70109521644180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70107427719340
+  version_requirements: *70109521644180
 description: A utility that adds class based enum functionality to ActiveRecord attributes
 email: github@lette.us
 executables: []
@@ -114,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3596092072518778020
+      hash: -4456031736000763211
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: