active_enum 0.9.12 → 1.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4aae7beff8dddf1e7a626ce7c6de2b35fa820f38
+  data.tar.gz: 3995d9471445a83cf36a771c5ef85c73ca63e54a
+SHA512:
+  metadata.gz: 1047ed7a0228ddb9b1969a5222e6b080cf3f7e8453cc4d635d5ee90cda8206446e4c5b7a178d5f1496ca00c0ec0dd236ae495b3269e60add8878c84bc8147343
+  data.tar.gz: 008696a99059da7b5a343502ec0a4639d6ffc009acbc2beb5ed80c8903c98afb249ad9ce9c9f0165734fc14870da2c8e808bbc21e6917755c8138d2ac00d7de6

data/.travis.yml

@@ -0,0 +1,8 @@
+env:
+  - "RAILS_VERSION=3.1.0"
+  - "RAILS_VERSION=3.2.0"
+  - "RAILS_VERSION=4.0.0"
+  - "RAILS_VERSION=master"
+rvm:
+  - 1.9.3
+  - 2.0.0

data/README.rdoc

@@ -7,13 +7,15 @@ Enum values are stored in memory at the moment but I plan to add database and po
 
 == Install
 
-From version 0.7 onwards this plugin will only have Rails 3 support. If you need Rails 2 compatibility, {check the 0.6 branch}[https://github.com/adzap/active_enum/tree/0.6].
+Supprots Ruby versions 2.0+.
+
+From gem version 1.0 onwards this plugin will only have Rails 4+ support. If you need Rails 3 compatibility, {check the 0.9 branch}[https://github.com/adzap/active_enum/tree/0.9].
 
   gem install active_enum 
 
 Put this in your Gemfile
 
-  gem 'active_enum'
+  gem 'active_enum', '~> 1.0.0.pre'
 
 Then generate the config initializer file
 
@@ -135,11 +137,17 @@ Access the enum values and the enum class using the attribute method with a symb
   user.sex(:enum)   # => Sex
   user.sex(:symbol) # => ♂  ( Can use any meta data key )
 
-You can set the default to return the enum name value for enumerated attribute
+You can set the default to return the enum name value for enumerated attributes
+
+  ActiveEnum.setup do |config|
+    config.use_name_as_value = true
+  end
+
+And now the name is returned for the regular attribute read method.
 
-  ActiveEnum.use_name_as_value = true
   user.sex # => 'Male'
 
+
 === Boolean check
 
 You can check if the attribute value matches a particular enum value by passing the enum value as an argument to the question method
@@ -155,6 +163,25 @@ A convenience method on the class is available to the enum class of any enumerat
 
   User.active_enum_for(:sex) # => Sex
 
+== Raise exception when value not found
+
+When a value if not found for a given id or name the default behaviour is to return nil. If you would like to raise an error use
+
+  ActiveEnum.setup do |config|
+    config.raise_on_not_found = true
+  end
+
+Then for the following examples
+  
+  Sex['Other']
+
+  # Or
+
+  Sex[3]
+
+will raise an ActiveEnum::NotFound exception.
+
+
 === Bulk definition
 
 Define enum classes in bulk without class files, in an initializer file for example.
@@ -194,19 +221,10 @@ Giving you the familiar enum methods
 
 === Form Helpers
 
-There is support for Formtastic[http://github.com/justinfrench/formtastic] and SimpleForm[http://github.com/plataformatec/simple_form]
-to make it easier to use the enum values as select options. The plugins have an almost identical API which is handy.
-You just need to require the extension for the respective plugin in an initialiser:
+There is support for SimpleForm[http://github.com/plataformatec/simple_form] version 3+.
+to make it easier to use the enum values as select options. 
 
-Formtastic 2.x:
-
-  require 'active_enum/form_helpers/formtastic2'
-
-Formtastic <2:
-
-  require 'active_enum/form_helpers/formtastic'
-
-Or, SimpleForm:
+In the initializer:
 
   require 'active_enum/form_helpers/simple_form'
 
@@ -266,4 +284,6 @@ nest the translations under the underscored model name
       female: Female 
 
 
+== License
+
 Copyright (c) 2009 Adam Meehan, released under the MIT license

data/Rakefile

@@ -1,7 +1,7 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
 
-require 'rake/rdoctask'
+require 'rdoc/task'
 require 'rspec/core/rake_task'
 
 desc "Run specs"

data/active_enum.gemspec

@@ -16,5 +16,5 @@ Gem::Specification.new do |s|
   s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.extra_rdoc_files = ["README.rdoc", "CHANGELOG", "MIT-LICENSE"]
 
-  s.add_runtime_dependency(%q<activesupport>, ["~> 3.0"])
+  s.add_runtime_dependency(%q<activesupport>, [">= 3.0"])
 end

data/lib/active_enum.rb

@@ -11,6 +11,9 @@ module ActiveEnum
   mattr_accessor :use_name_as_value
   @@use_name_as_value = false
 
+  mattr_accessor :raise_on_not_found
+  @@raise_on_not_found = false
+
   mattr_accessor :storage
   @@storage = :memory
 
@@ -27,10 +30,14 @@ module ActiveEnum
 
   # Setup method for plugin configuration
   def self.setup
-    yield self
+    yield config
     extend_classes!
   end
 
+  def self.config
+    self
+  end
+
   class EnumDefinitions
     def enum(name, &block)
       class_name = name.to_s.camelize

data/lib/active_enum/acts_as_enum.rb

@@ -7,9 +7,9 @@ module ActiveEnum
         extend ClassMethods
         class_attribute :active_enum_options
         self.active_enum_options = options.reverse_merge(:name_column => 'name')
-        scope :enum_values, select("#{primary_key}, #{active_enum_options[:name_column]}").
-                            where(active_enum_options[:conditions]).
-                            order("#{primary_key} #{active_enum_options[:order]}")
+        scope :enum_values, proc { select("#{primary_key}, #{active_enum_options[:name_column]}").
+                                   where(active_enum_options[:conditions]).
+                                   order("#{primary_key} #{active_enum_options[:order]}") }
       end
 
     end
@@ -45,7 +45,7 @@ module ActiveEnum
       end
 
       def lookup_by_name(index)
-        enum_values.where("#{active_enum_options[:name_column]} like ?", index.to_s).first
+        enum_values.where("#{active_enum_options[:name_column]} like lower(?)", index.to_s).first
       end
 
     end

data/lib/active_enum/base.rb

@@ -1,6 +1,7 @@
 module ActiveEnum
   class DuplicateValue < StandardError; end
   class InvalidValue < StandardError; end
+  class NotFound < StandardError; end
 
   class Base
 
@@ -37,6 +38,10 @@ module ActiveEnum
         store.values
       end
 
+      def each(&block)
+        all.each(&block)
+      end
+
       # Array of all enum id values
       def ids
         store.values.map {|v| v[0] }
@@ -55,15 +60,20 @@ module ActiveEnum
       # Access id or name value. Pass an id number to retrieve the name or
       # a symbol or string to retrieve the matching id.
       def get(index)
+        row = get_value(index)
+        return if row.nil?
+        index.is_a?(Fixnum) ? row[1] : row[0]
+      end
+      alias_method :[], :get
+
+      # Access value row array for a given id or name value.
+      def get_value(index)
         if index.is_a?(Fixnum)
-          row = store.get_by_id(index)
-          row[1] if row
+          store.get_by_id(index)
         else
-          row = store.get_by_name(index)
-          row[0] if row
-        end
+          store.get_by_name(index)
+        end || (ActiveEnum.raise_on_not_found ? raise(ActiveEnum::NotFound, "#{self} value for '#{index}' was not found") : nil)
       end
-      alias_method :[], :get
 
       def include?(value)
         !get(value).nil?
@@ -71,11 +81,7 @@ module ActiveEnum
 
       # Access any meta data defined for a given id or name. Returns a hash.
       def meta(index)
-        row = if index.is_a?(Fixnum)
-          store.get_by_id(index)
-        else
-          store.get_by_name(index)
-        end
+        row = get_value(index)
         row[2] || {} if row
       end
 

data/lib/active_enum/extensions.rb

@@ -80,10 +80,12 @@ module ActiveEnum
       def define_active_enum_read_method(attribute)
         class_eval <<-DEF
           def #{attribute}(arg=nil)
+            enum = self.class.active_enum_for(:#{attribute})
+            return enum if arg == :enum
+
             value = super()
-            return if value.nil? && arg.nil?
+            return if value.nil?
 
-            enum = self.class.active_enum_for(:#{attribute})
             case arg
             when nil
               #{ActiveEnum.use_name_as_value ? 'enum[value]' : 'value' }
@@ -91,8 +93,6 @@ module ActiveEnum
               value if enum[value]
             when :name
               enum[value]
-            when :enum
-              enum
             when Symbol
               (enum.meta(value) || {})[arg]
             end
@@ -127,7 +127,7 @@ module ActiveEnum
         class_eval <<-DEF
           def #{attribute}?(arg=nil)
             if arg
-              self.#{attribute} == self.class.active_enum_for(:#{attribute})[arg]
+              self.#{attribute}(:id) == self.class.active_enum_for(:#{attribute})[arg]
             else
               super()
             end

data/lib/active_enum/form_helpers/simple_form.rb

@@ -5,46 +5,27 @@ module ActiveEnum
     module SimpleForm
       module BuilderExtension
 
-        def default_input_type_with_active_enum(*args, &block)
-          return :enum if (args.last.is_a?(Hash) ? args.last[:as] : @options[:as]).nil? &&
-                          object.class.respond_to?(:active_enum_for) &&
-                          object.class.active_enum_for(args.first || @attribute_name)
-          default_input_type_without_active_enum(*args, &block)
-        end
-
-      end
-
-      module InputExtension
-
-        def initialize(*args)
+        def find_custom_type(attribute_name)
+          return :enum if object.class.active_enum_for(attribute_name) if object.class.respond_to?(:active_enum_for)
           super
-          raise "Attribute '#{attribute_name}' has no enum class" unless enum = object.class.active_enum_for(attribute_name)
-          if respond_to?(:input_options)
-            input_options[:collection] = enum.to_select
-          else
-            @builder.options[:collection] = enum.to_select
-          end
         end
-        
+
       end
     end
   end
 end
 
-if SimpleForm::VERSION < '2.0.0'
-  class ActiveEnum::FormHelpers::SimpleForm::EnumInput < ::SimpleForm::Inputs::CollectionInput
-    include ActiveEnum::FormHelpers::SimpleForm::InputExtension
-  end
-else
-  class ActiveEnum::FormHelpers::SimpleForm::EnumInput < ::SimpleForm::Inputs::CollectionSelectInput
-    include ActiveEnum::FormHelpers::SimpleForm::InputExtension
+class ActiveEnum::FormHelpers::SimpleForm::EnumInput < ::SimpleForm::Inputs::CollectionSelectInput
+  def initialize(*args)
+    super
+    raise "Attribute '#{attribute_name}' has no enum class" unless enum = object.class.active_enum_for(attribute_name)
+    input_options[:collection] = enum.to_select
   end
 end
 
 SimpleForm::FormBuilder.class_eval do
-  include ActiveEnum::FormHelpers::SimpleForm::BuilderExtension
+  prepend ActiveEnum::FormHelpers::SimpleForm::BuilderExtension
 
   map_type :enum, :to => ActiveEnum::FormHelpers::SimpleForm::EnumInput
   alias_method :collection_enum, :collection_select
-  alias_method_chain :default_input_type, :active_enum
 end

data/lib/active_enum/storage/abstract_store.rb

@@ -22,6 +22,14 @@ module ActiveEnum
         raise NotImplemented
       end
 
+      def check_duplicate(id, name)
+        if get_by_id(id) 
+          raise ActiveEnum::DuplicateValue, "#{@enum}: Duplicate id #{id}"
+        elsif get_by_name(name)
+          raise ActiveEnum::DuplicateValue, "#{@enum}: Duplicate name '#{name}'"
+        end
+      end
+
       def values
         _values
       end

data/lib/active_enum/storage/i18n_store.rb

@@ -17,12 +17,6 @@ module ActiveEnum
         _values.map { |(id, name)| get_by_id(id) }
       end
 
-      def check_duplicate(id, name)
-        if _values.assoc(id) || _values.rassoc(name.to_s)
-          raise ActiveEnum::DuplicateValue
-        end
-      end
-
       def i18n_scope
         @i18n_scope ||= [ :active_enum ] + @enum.name.split("::").map { |nesting| nesting.underscore.to_sym }
       end

data/lib/active_enum/storage/memory_store.rb

@@ -16,12 +16,6 @@ module ActiveEnum
         _values.rassoc(name.to_s) || _values.rassoc(name.to_s.titleize)
       end
 
-      def check_duplicate(id, name)
-        if get_by_id(id) || get_by_name(name)
-          raise ActiveEnum::DuplicateValue
-        end
-      end
-
       def sort!
         case @order
         when :asc

data/lib/active_enum/version.rb

@@ -1,3 +1,3 @@
 module ActiveEnum
-  VERSION = '0.9.12'
+  VERSION = '1.0.0.pre'
 end

data/lib/generators/active_enum/templates/config.rb

@@ -1,6 +1,5 @@
 # Form helper integration
-# require 'active_enum/form_helpers/formtastic'  # for Formtastic <2
-# require 'active_enum/form_helpers/formtastic2' # for Formtastic 2.x
+# require 'active_enum/form_helpers/simple_form' # for SimpleForm
 
 ActiveEnum.setup do |config|
 
@@ -10,6 +9,9 @@ ActiveEnum.setup do |config|
   # Return name string as value for attribute method
   # config.use_name_as_value = false
 
+  # Raise exception ActiveEnum::NotFound if enum value for a given id or name is not found
+  # config.raise_on_not_found = false
+
   # Storage of values (:memory, :i18n)
   # config.storage = :memory
 

data/spec/active_enum/acts_as_enum_spec.rb

@@ -13,36 +13,41 @@ describe ActiveEnum::ActsAsEnum do
     end
   end
 
+  class SortedPerson < ActiveRecord::Base
+    acts_as_enum :name_column => 'first_name', :order => :desc
+  end
+
   before(:all) do
     Person.create!(:first_name => 'Dave', :last_name => 'Smith')
     Person.create!(:first_name => 'John', :last_name => 'Doe')
+    SortedPerson.create!(:first_name => 'Dave', :last_name => 'Smith')
+    SortedPerson.create!(:first_name => 'John', :last_name => 'Doe')
   end
 
   it "should mixin enum class methods only when act_as_enum defined" do
-    TestPerson.extended_modules.should_not include(ActiveEnum::ActsAsEnum::ClassMethods)
+    expect(TestPerson.extended_modules).not_to include(ActiveEnum::ActsAsEnum::ClassMethods)
     TestPerson.acts_as_enum
-    TestPerson.extended_modules.should include(ActiveEnum::ActsAsEnum::ClassMethods)
+    expect(TestPerson.extended_modules).to include(ActiveEnum::ActsAsEnum::ClassMethods)
   end
 
   it "should return name column value when passing id to [] method" do
-    Person[1].should == 'Dave'
+    expect(Person[1]).to eq('Dave')
   end
 
   it "should return id column value when passing string name to [] method" do
-    Person['Dave'].should == 1
-    Person['dave'].should == 1
+    expect(Person['Dave']).to eq(1)
+    expect(Person['dave']).to eq(1)
   end
 
   it "should return id column value when passing symbol name to [] method" do
-    Person[:dave].should == 1
+    expect(Person[:dave]).to eq(1)
   end
 
   it "should return array for select helpers from to_select" do
-    Person.to_select.should == [['Dave', 1], ['John', 2]]
+    expect(Person.to_select).to eq([['Dave', 1], ['John', 2]])
   end
 
-  it "should return sorted array from order value for select helpers from to_select" do
-    Person.acts_as_enum :name_column => 'first_name', :order => :desc
-    Person.to_select.should == [['John', 2], ['Dave', 1]]
+  it "should return sorted array from order value for select helpers from to_select when an order is specified" do
+    expect(SortedPerson.to_select).to eq([['John', 2], ['Dave', 1]])
   end
 end