enumerize 0.1.1 → 0.2.0

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 before_install:
-  - gem install bundler --pre
+  - gem install bundler
 rvm:
   - 1.9.2
   - 1.9.3

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 0.2.0 (March 29, 2012) ##
+
+### enhancements
+  * Ability to enumerize attributes in a module and then include it into classes (by [@lest](https://github.com/lest))
+  * Add error to a model when attribute value is not included in allowed list (by [@lest](https://github.com/lest))
+
+### bug fix
+  * Inheriting enumerized attributes (by [@cgunther](https://github.com/cgunther) and [@nashby](https://github.com/nashby))
+  * Don't cast nil to string (by [@jimryan](https://github.com/jimryan))
+
 ## 0.1.1 (March 6, 2012) ##
 
 ### bug fix

data/README.md

@@ -79,6 +79,12 @@ get attribute value:
 @user.sex_text # or @user.sex.text
 ```
 
+get all values for enumerized attribute:
+
+```ruby
+User.sex.values # or User.enumerized_attributes[:sex].values
+```
+
 use it with forms:
 
 ```erb
@@ -127,6 +133,23 @@ user.sex.male? #=> true
 user.sex.female? #=> false
 ```
 
+To make some attributes shared across different classes it's possible to define them in a separate module and then include it into classes:
+
+```ruby
+module PersonEnumerations
+  include Enumerize
+
+  enumerize :sex, :in => %w[male female]
+end
+
+class Person
+  include PersonEnumerations
+end
+
+class User
+  include PersonEnumerations
+end
+```
 
 
 ## Contributing

data/lib/enumerize.rb

@@ -3,18 +3,24 @@ require 'enumerize/version'
 
 module Enumerize
   autoload :Attribute,    'enumerize/attribute'
+  autoload :AttributeMap, 'enumerize/attribute_map'
   autoload :Value,        'enumerize/value'
   autoload :Base,         'enumerize/base'
   autoload :ActiveRecord, 'enumerize/activerecord'
+  autoload :ModuleAttributes, 'enumerize/module_attributes'
 
-  extend ActiveSupport::Concern
-
-  include Enumerize::Base
+  def self.included(base)
+    base.send :include, Enumerize::Base
+    if defined?(::ActiveRecord::Base) && base < ::ActiveRecord::Base
+      base.extend Enumerize::ActiveRecord
+    end
 
-  included do
-    if defined?(::ActiveRecord::Base) && self < ::ActiveRecord::Base
-      include Enumerize::ActiveRecord
+    if Module === base
+      base.extend Enumerize::Base::ClassMethods
+      base.extend Enumerize::ModuleAttributes
     end
+
+    super
   end
 
   begin

data/lib/enumerize/activerecord.rb

@@ -2,6 +2,6 @@ require 'active_support/concern'
 
 module Enumerize
   module ActiveRecord
-    extend ActiveSupport::Concern
+
   end
 end

data/lib/enumerize/attribute_map.rb

@@ -0,0 +1,36 @@
+module Enumerize
+  class AttributeMap
+    def initialize
+      @attributes = {}
+      @dependants = []
+    end
+
+    def [](name)
+      @attributes[name.to_s]
+    end
+
+    def <<(attr)
+      @attributes[attr.name.to_s] = attr
+      @dependants.each do |dependant|
+        dependant << attr
+      end
+    end
+
+    def each
+      @attributes.each_pair do |_name, attr|
+        yield attr
+      end
+    end
+
+    def empty?
+      @attributes.empty?
+    end
+
+    def add_dependant(dependant)
+      @dependants << dependant
+      each do |attr|
+        dependant << attr
+      end
+    end
+  end
+end

data/lib/enumerize/base.rb

@@ -4,48 +4,59 @@ module Enumerize
   module Base
     extend ActiveSupport::Concern
 
-    included do
-      @enumerized_attributes = {}
-      class << self
-        attr_reader :enumerized_attributes
-      end
-    end
-
     module ClassMethods
-      def enumerize(*args, &block)
-        attr = Attribute.new(self, *args, &block)
-        enumerized_attributes[attr.name] = attr
+      def enumerize(name, options={})
+        attr = Attribute.new(self, name, options)
+        enumerized_attributes << attr
 
         unless methods.include?(attr.name)
-          singleton_class.class_eval do
-            define_method(attr.name) { attr }
-          end
+          _enumerize_module._class_methods.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{attr.name}
+              enumerized_attributes[:#{attr.name}]
+            end
+          RUBY
         end
 
-        mod = Module.new
-
-        mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
-          def initialize(*, &_)
-            super
-            self.#{attr.name} = self.class.enumerized_attributes[:#{attr.name}].default_value if #{attr.name}.nil?
-          end
-        RUBY
+        _define_enumerize_attribute(attr)
 
-        _define_enumerize_attribute(mod, attr)
-
-        mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+        _enumerize_module.module_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{attr.name}_text
             #{attr.name} && #{attr.name}.text
           end
         RUBY
 
-        include mod
+        if respond_to?(:validates)
+          validates name, :inclusion => {:in => enumerized_attributes[name].values.map(&:to_s), :allow_nil => true, :allow_blank => true}
+        end
+      end
+
+      def enumerized_attributes
+        @enumerized_attributes ||= AttributeMap.new
+      end
+
+      def inherited(subclass)
+        enumerized_attributes.add_dependant subclass.enumerized_attributes
+        super
       end
 
       private
 
-      def _define_enumerize_attribute(mod, attr)
-        mod.module_eval <<-RUBY, __FILE__, __LINE__ + 1
+      def _enumerize_module
+        @_enumerize_module ||= begin
+          mod = Module.new do
+            @_class_methods = Module.new
+            class << self
+              attr_reader :_class_methods
+            end
+          end
+          include mod
+          extend mod._class_methods
+          mod
+        end
+      end
+
+      def _define_enumerize_attribute(attr)
+        _enumerize_module.module_eval <<-RUBY, __FILE__, __LINE__ + 1
           def #{attr.name}
             if respond_to?(:read_attribute, true)
               self.class.enumerized_attributes[:#{attr.name}].find_value(read_attribute(:#{attr.name}))
@@ -59,14 +70,40 @@ module Enumerize
           end
 
           def #{attr.name}=(new_value)
+            _enumerized_values_for_validation[:#{attr.name}] = new_value.nil? ? nil : new_value.to_s
+
+            allowed_value_or_nil = self.class.enumerized_attributes[:#{attr.name}].find_value(new_value)
+            allowed_value_or_nil = allowed_value_or_nil.to_s unless allowed_value_or_nil.nil?
+
             if respond_to?(:write_attribute, true)
-              write_attribute :#{attr.name}, self.class.enumerized_attributes[:#{attr.name}].find_value(new_value).to_s
+              write_attribute :#{attr.name}, allowed_value_or_nil
             else
-              @#{attr.name} = self.class.enumerized_attributes[:#{attr.name}].find_value(new_value).to_s
+              @#{attr.name} = allowed_value_or_nil
             end
           end
         RUBY
       end
     end
+
+    def initialize(*)
+      super
+      self.class.enumerized_attributes.each do |attr|
+        public_send("#{attr.name}=", attr.default_value) if public_send(attr.name).nil?
+      end
+    end
+
+    def read_attribute_for_validation(key)
+      if self.class.enumerized_attributes[key].instance_of?(Enumerize::Attribute) && _enumerized_values_for_validation.has_key?(key)
+        _enumerized_values_for_validation[key]
+      else
+        super
+      end
+    end
+
+    private
+
+    def _enumerized_values_for_validation
+      @_enumerized_values_for_validation ||= {}
+    end
   end
 end

data/lib/enumerize/module_attributes.rb

@@ -0,0 +1,11 @@
+module Enumerize
+  module ModuleAttributes
+    def included(base)
+      base.send :include, Enumerize
+      base.send :include, _enumerize_module
+      base.extend _enumerize_module._class_methods
+      enumerized_attributes.add_dependant base.enumerized_attributes
+      super
+    end
+  end
+end

data/lib/enumerize/version.rb

@@ -1,3 +1,3 @@
 module Enumerize
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/test/activerecord_test.rb

@@ -53,4 +53,27 @@ describe Enumerize::ActiveRecord do
     User.new.role.must_equal 'user'
     User.new.attributes['role'].must_equal 'user'
   end
+
+  it 'validates inclusion' do
+    user = User.new
+    user.role = 'wrong'
+    user.wont_be :valid?
+  end
+
+  it "uses persisted value for validation if it hasn't been set" do
+    user = User.create! :sex => :male
+    User.find(user).read_attribute_for_validation(:sex).must_equal 'male'
+  end
+
+  it 'is valid with empty string assigned' do
+    user = User.new
+    user.role = ''
+    user.must_be :valid?
+  end
+
+  it 'stores nil when empty string assigned' do
+    user = User.new
+    user.role = ''
+    user.read_attribute(:role).must_equal nil
+  end
 end

data/test/attribute_map_test.rb

@@ -0,0 +1,67 @@
+require 'test_helper'
+
+module Enumerize
+  class AttributeMapTest < MiniTest::Spec
+    subject { AttributeMap.new }
+
+    def make_attr(name)
+      Attribute.new(nil, name, :in => %[a b])
+    end
+
+    it 'empty when no attrs' do
+      subject.must_be_empty
+    end
+
+    it 'not empty when attr added' do
+      subject << make_attr(:a)
+      subject.wont_be_empty
+    end
+
+    it 'iterates over added attrs' do
+      attr_1 = make_attr(:a)
+      attr_2 = make_attr(:b)
+
+      subject << attr_1
+      subject << attr_2
+
+      count  = 0
+      actual = []
+
+      subject.each do |element|
+        count += 1
+        actual << element
+      end
+
+      count.must_equal 2
+      actual.must_equal [attr_1, attr_2]
+    end
+
+    it 'reads attribute by name' do
+      attr = make_attr(:a)
+      subject << attr
+      subject[:a].must_equal attr
+    end
+
+    it 'reads attribute by name using string' do
+      attr = make_attr(:a)
+      subject << attr
+      subject['a'].must_equal attr
+    end
+
+    it 'updates dependants' do
+      attr = make_attr(:a)
+      dependant = mock
+      dependant.expects(:<<).with(attr)
+      subject.add_dependant dependant
+      subject << attr
+    end
+
+    it 'adds attrs to dependant' do
+      attr = make_attr(:a)
+      subject << attr
+      dependant = AttributeMap.new
+      subject.add_dependant dependant
+      dependant[:a].must_equal attr
+    end
+  end
+end

data/test/base_test.rb

@@ -7,6 +7,10 @@ describe Enumerize::Base do
     end
   end
 
+  let(:subklass) do
+    Class.new(klass)
+  end
+
   let(:object) { klass.new }
 
   it 'returns nil when not set' do
@@ -81,7 +85,7 @@ describe Enumerize::Base do
   end
 
   it 'has enumerized attributes' do
-    klass.enumerized_attributes.must_equal({})
+    klass.enumerized_attributes.must_be_empty
     klass.enumerize(:foo, :in => %w[a b])
     klass.enumerized_attributes[:foo].must_be_instance_of Enumerize::Attribute
   end
@@ -91,4 +95,45 @@ describe Enumerize::Base do
     klass.enumerize(:name, :in => %w[a b], :default => 'a')
     klass.method(:name).must_equal method
   end
+
+  it "inherits enumerized attributes from a parent class" do
+    klass.enumerize(:foo, :in => %w[a b])
+    subklass.enumerized_attributes[:foo].must_be_instance_of Enumerize::Attribute
+  end
+
+  it "inherits enumerized attributes from a grandparent class" do
+    klass.enumerize(:foo, :in => %w[a b])
+    Class.new(subklass).enumerized_attributes[:foo].must_be_instance_of Enumerize::Attribute
+  end
+
+  it "doesn't add enumerized attributes to parent class" do
+    klass.enumerize(:foo, :in => %w[a b])
+    subklass.enumerize(:bar, :in => %w[c d])
+
+    klass.enumerized_attributes[:bar].must_equal nil
+  end
+
+  it 'adds new parent class attributes to subclass' do
+    subklass = Class.new(klass)
+    klass.enumerize :foo, :in => %w[a b]
+    subklass.enumerized_attributes[:foo].must_be_instance_of Enumerize::Attribute
+  end
+
+  it 'stores nil value' do
+    klass.enumerize(:foo, :in => [:a, :b])
+    object.foo = nil
+    object.instance_variable_get(:@foo).must_equal nil
+  end
+
+  it 'casts value to string for validation' do
+    klass.enumerize(:foo, :in => [:a, :b])
+    object.foo = :c
+    object.read_attribute_for_validation(:foo).must_equal 'c'
+  end
+
+  it "doesn't cast nil to string for validation" do
+    klass.enumerize(:foo, :in => [:a, :b])
+    object.foo = nil
+    object.read_attribute_for_validation(:foo).must_equal nil
+  end
 end

data/test/module_attributes_test.rb

@@ -0,0 +1,29 @@
+require 'test_helper'
+
+class ModuleAttributesSpec < MiniTest::Spec
+  it 'inherits attribute from the module' do
+    mod = Module.new do
+      include Enumerize
+      enumerize :sex, :in => %w[male female], :default => 'male'
+    end
+
+    klass = Class.new
+    klass.send :include, mod
+    klass.enumerized_attributes[:sex].must_be_instance_of Enumerize::Attribute
+    klass.new.sex.must_equal 'male'
+    klass.sex.must_be_instance_of Enumerize::Attribute
+  end
+
+  it 'uses new attributes from the module' do
+    mod = Module.new do
+      include Enumerize
+    end
+
+    klass = Class.new
+    klass.send :include, mod
+    mod.enumerize :sex, :in => %w[male female], :default => 'male'
+    klass.enumerized_attributes[:sex].must_be_instance_of Enumerize::Attribute
+    klass.new.sex.must_equal 'male'
+    klass.sex.must_be_instance_of Enumerize::Attribute
+  end
+end

data/test/mongoid_test.rb

@@ -53,4 +53,18 @@ describe Enumerize do
   it 'has default value' do
     model.new.role.must_equal 'user'
   end
+
+  it 'validates inclusion' do
+    user = model.new
+    user.role = 'wrong'
+    user.wont_be :valid?
+  end
+
+  it 'assigns value on loaded record' do
+    model.delete_all
+    model.create!(:sex => :male)
+    user = model.first
+    user.sex = :female
+    user.sex.must_equal 'female'
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enumerize
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-06 00:00:00.000000000 Z
+date: 2012-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &14589640 !ruby/object:Gem::Requirement
+  requirement: &6744160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 3.1.3
   type: :runtime
   prerelease: false
-  version_requirements: *14589640
+  version_requirements: *6744160
 description: Enumerated attributes with I18n and ActiveRecord/Mongoid support
 email: info@twinslash.com
 executables: []
@@ -40,15 +40,19 @@ files:
 - lib/enumerize.rb
 - lib/enumerize/activerecord.rb
 - lib/enumerize/attribute.rb
+- lib/enumerize/attribute_map.rb
 - lib/enumerize/base.rb
 - lib/enumerize/hooks/formtastic.rb
 - lib/enumerize/hooks/simple_form.rb
+- lib/enumerize/module_attributes.rb
 - lib/enumerize/value.rb
 - lib/enumerize/version.rb
 - test/activerecord_test.rb
+- test/attribute_map_test.rb
 - test/attribute_test.rb
 - test/base_test.rb
 - test/formtastic_test.rb
+- test/module_attributes_test.rb
 - test/mongoid_test.rb
 - test/simple_form_test.rb
 - test/support/mock_controller.rb
@@ -69,7 +73,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 25298246185228879
+      hash: -1144009341206974926
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -78,7 +82,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 25298246185228879
+      hash: -1144009341206974926
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.11
@@ -87,9 +91,11 @@ specification_version: 3
 summary: Enumerated attributes with I18n and ActiveRecord/Mongoid support
 test_files:
 - test/activerecord_test.rb
+- test/attribute_map_test.rb
 - test/attribute_test.rb
 - test/base_test.rb
 - test/formtastic_test.rb
+- test/module_attributes_test.rb
 - test/mongoid_test.rb
 - test/simple_form_test.rb
 - test/support/mock_controller.rb