active_enum 0.9.7 → 0.9.8

data/README.rdoc

@@ -119,7 +119,7 @@ Access the enum values and the enum class using the attribute method with a symb
   user.sex(:id)     # => 1
   user.sex(:name)   # => 'Male'
   user.sex(:enum)   # => Sex
-  user.sex(:symbol) # => ♂. Can use any meta data key.
+  user.sex(:symbol) # => ♂  ( Can use any meta data key )
 
 You can set the default to return the enum name value for enumerated attribute
 
@@ -195,8 +195,57 @@ Or, SimpleForm:
 The input type will be automatically detected for enumerated attributes. You can override with the :as option as normal.
 
 
-== TODO
-* storage options of memory, database or yaml
-* use custom method name for the enumerated attribute
+== Storage Backends 
+
+The design allows pluggable backends to be used for stories and retrieving the enum values. At present there are two
+available, memory or I18n. To change the storage engine you alter the storage config value like so:
+
+  ActiveEnum.setup do |config|
+    config.storage = :i18n
+  end
+
+The memory store is default obviously just stores the values in memory.
+
+
+=== I18n Storage
+
+The I18n storage backend stores the ids and names is memory still, but retrieves the name text translation any call to
+the enum public methods. 
+
+To set up the locale file, run
+
+  rails g active_enum:locale
+
+This generates the YML locale template in your default language as configured in the application.rb.
+
+Here are some examples of defining enum translations
+ 
+   class Sex < ActiveEnum::Base
+     value 1 => 'male'
+     value 2 => 'female'
+   end
+ 
+becomes 
+
+  sex:
+    male: Male 
+    female: Female 
+
+For namesapced enums in a model
+
+  class Person < ActiveRecord::Base
+    enumerate :sex do
+      value 1 => 'male'
+      value 2 => 'female'
+    end
+  end
+
+nest the translations under the underscored model name
+  
+  person:
+    sex:
+      male: Male 
+      female: Female 
+
 
 Copyright (c) 2009 Adam Meehan, released under the MIT license

data/lib/active_enum.rb

@@ -1,10 +1,10 @@
 require 'active_enum/base'
 require 'active_enum/extensions'
 require 'active_enum/storage/abstract_store'
+require 'active_enum/version'
+require 'active_enum/railtie' if defined?(Rails)
 
 module ActiveEnum
-  autoload :VERSION, 'active_enum/version'
-
   mattr_accessor :enum_classes
   @@enum_classes = []
 

data/lib/active_enum/base.rb

@@ -49,7 +49,7 @@ module ActiveEnum
 
       # Return enum values in an array suitable to pass to a Rails form select helper.
       def to_select
-				store.values.map {|v| [v[1], v[0]] }
+        store.values.map {|v| [v[1], v[0]] }
       end
 
       # Access id or name value. Pass an id number to retrieve the name or
@@ -64,6 +64,10 @@ module ActiveEnum
         end
       end
 
+      def include?(value)
+        !self[value].nil?
+      end
+
       # Access any meta data defined for a given id or name. Returns a hash.
       def meta(index)
         row = if index.is_a?(Fixnum)

data/lib/active_enum/extensions.rb

@@ -83,7 +83,7 @@ module ActiveEnum
             value = super()
             return if value.nil? && arg.nil?
 
-            enum  = self.class.active_enum_for(:#{attribute})
+            enum = self.class.active_enum_for(:#{attribute})
             case arg
             when :id
               value if enum[value]
@@ -125,14 +125,15 @@ module ActiveEnum
       #   user.sex?(:male)
       #
       def define_active_enum_question_method(attribute)
-        define_method("#{attribute}?") do |*arg|
-          arg = arg.first
-          if arg
-            send(attribute) == self.class.active_enum_for(attribute)[arg]
-          else
-            super()
+        class_eval <<-DEF
+          def #{attribute}?(*args)
+            if args.first
+              #{attribute} == self.class.active_enum_for(:#{attribute})[args.first]
+            else
+              super()
+            end
           end
-        end
+        DEF
       end
 
     end

data/lib/active_enum/form_helpers/simple_form.rb

@@ -1,3 +1,5 @@
+require 'simple_form/version'
+
 module ActiveEnum
   module FormHelpers
     module SimpleForm
@@ -12,7 +14,7 @@ module ActiveEnum
 
       end
 
-      class EnumInput < ::SimpleForm::Inputs::CollectionInput
+      module InputExtension
 
         def initialize(*args)
           super
@@ -29,6 +31,16 @@ module ActiveEnum
   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
+  end
+end
+
 SimpleForm::FormBuilder.class_eval do
   include ActiveEnum::FormHelpers::SimpleForm::BuilderExtension
 

data/lib/active_enum/railtie.rb

@@ -4,7 +4,7 @@ module ActiveEnum
       ActiveSupport.on_load(:active_record) do
         require 'active_enum/acts_as_enum'
 
-        ActiveEnum.extend_orms = [ ActiveRecord::Base ]
+        ActiveEnum.extend_classes = [ ActiveRecord::Base ]
       end
     end
   end

data/lib/active_enum/storage/abstract_store.rb

@@ -1,6 +1,7 @@
 module ActiveEnum
   module Storage
     autoload :MemoryStore, "active_enum/storage/memory_store"
+    autoload :I18nStore, "active_enum/storage/i18n_store"
 
     class NotImplemented < StandardError; end
 
@@ -22,8 +23,15 @@ module ActiveEnum
       end
 
       def values
+        _values
+      end
+
+      private
+      
+      def _values
         raise NotImplemented
       end
+
     end
   end
 end

data/lib/active_enum/storage/i18n_store.rb

@@ -0,0 +1,36 @@
+require 'i18n'
+
+module ActiveEnum
+  module Storage
+    class I18nStore < MemoryStore
+      def get_by_id(id)
+        row = _values.assoc(id)
+        [ id, translate(row[1]) ] if row
+      end
+
+      def get_by_name(name)
+        row = _values.rassoc(name.to_s)
+        [ row[0], translate(row[1]) ] if row
+      end
+
+      def values
+        _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
+
+      def translate(key)
+        I18n.translate key, :scope => i18n_scope
+      end
+
+    end
+  end
+end

data/lib/active_enum/storage/memory_store.rb

@@ -1,22 +1,19 @@
 module ActiveEnum
   module Storage
     class MemoryStore < AbstractStore
+
       def set(id, name, meta=nil)
         check_duplicate id, name
-        values << [id, name, meta].compact
+        _values << [id, name.to_s, meta].compact
         sort!
       end
 
       def get_by_id(id)
-        values.assoc(id)
+        _values.assoc(id)
       end
 
       def get_by_name(name)
-        values.rassoc(name.to_s) || values.rassoc(name.to_s.titleize)
-      end
-
-      def values
-        @values ||= []
+        _values.rassoc(name.to_s) || _values.rassoc(name.to_s.titleize)
       end
 
       def check_duplicate(id, name)
@@ -26,15 +23,18 @@ module ActiveEnum
       end
 
       def sort!
-        return if @order == :natural
-
         case @order
         when :asc
-          values.sort! {|a,b| a[0] <=> b[0] }
+          _values.sort! { |a,b| a[0] <=> b[0] }
         when :desc
-          values.sort! {|a,b| b[0] <=> a[0] }
+          _values.sort! { |a,b| b[0] <=> a[0] }
         end
       end
+
+      def _values
+        @_values ||= []
+      end
+
     end
   end
 end

data/lib/active_enum/version.rb

@@ -1,3 +1,3 @@
 module ActiveEnum
-  VERSION = '0.9.7'
+  VERSION = '0.9.8'
 end

data/lib/generators/active_enum/install_generator.rb

@@ -3,10 +3,9 @@ module ActiveEnum
     class InstallGenerator < Rails::Generators::Base
       desc "Copy ActiveEnum default files"
       source_root File.expand_path('../templates', __FILE__)
-      class_option :template_engine
 
       def copy_initializers
-        copy_file 'active_enum.rb', 'config/initializers/active_enum.rb'
+        copy_file 'config.rb', 'config/initializers/active_enum.rb'
       end
 
     end

data/lib/generators/active_enum/locale_generator.rb

@@ -0,0 +1,21 @@
+module ActiveEnum
+  module Generators
+    class LocaleGenerator < Rails::Generators::Base
+      desc "Copy ActiveEnum locale file for I18n storage"
+      source_root File.expand_path('../templates', __FILE__)
+      class_option :lang, :type => :string, :default => 'en', :desc => "Language for locale file"
+
+      def copy_initializers
+        template 'locale.yml',  locale_full_path
+      end
+
+      def locale_filename
+        "active_enum.#{options[:lang]}.yml"
+      end
+
+      def locale_full_path
+        "config/locales/#{locale_filename}"
+      end
+    end
+  end
+end

data/lib/generators/active_enum/templates/{active_enum.rb → config.rb}

@@ -10,7 +10,7 @@ ActiveEnum.setup do |config|
   # Return name string as value for attribute method
   # config.use_name_as_value = false
 
-  # Storage of values
+  # Storage of values (:memory, :i18n)
   # config.storage = :memory
 
 end

data/lib/generators/active_enum/templates/locale.yml

@@ -0,0 +1,31 @@
+#{@lang}:
+  active_enum:
+
+    # Place enum translations for each name defined in the enum
+    # 
+    #   class Sex < ActiveEnum::Base
+    #     value 1 => 'male'
+    #     value 2 => 'female'
+    #   end
+    # 
+    # is defined as 
+    #
+    # sex:
+    #   male: Male 
+    #   female: Female 
+    #
+    # For namesapced enums in a model
+    #
+    #   class Person < ActiveRecord::Base
+    #     enumerate :sex do
+    #       value 1 => 'male'
+    #       value 2 => 'female'
+    #     end
+    #   end
+    #
+    # Nest the translations under the underscored model name
+    #  
+    # person:
+    #   sex:
+    #     male: Male 
+    #     female: Female 

data/spec/active_enum/base_spec.rb

@@ -76,21 +76,21 @@ describe ActiveEnum::Base do
     end
 
     it 'should raise error if the id is a duplicate' do
-      lambda do
+      expect {
         define_enum do
           value :id => 1, :name => 'Name 1'
           value :id => 1, :name => 'Name 2'
         end
-      end.should raise_error(ActiveEnum::DuplicateValue)
+      }.to raise_error(ActiveEnum::DuplicateValue)
     end
 
     it 'should raise error if the name is a duplicate' do
-      lambda do
+      expect {
         define_enum do
           value :id => 1, :name => 'Name'
           value :id => 2, :name => 'Name'
         end
-      end.should raise_error(ActiveEnum::DuplicateValue)
+      }.to raise_error(ActiveEnum::DuplicateValue)
     end
   end
 
@@ -161,32 +161,50 @@ describe ActiveEnum::Base do
   end
 
   context "element reference method" do
-
-    it 'should return name when given an id' do
-      enum = define_enum do
+    let(:enum) {
+      define_enum do
         value :id => 1, :name => 'Name 1'
         value :id => 2, :name => 'Name 2'
       end
+    }
+
+    it 'should return name when given an id' do
       enum[1].should == 'Name 1'
     end
 
     it 'should return id when given a name' do
-      enum = define_enum do
-        value :id => 1, :name => 'Name 1'
-        value :id => 2, :name => 'Name 2'
-      end
       enum['Name 1'].should == 1
     end
 
     it 'should return id when given a symbol of the name' do
-      enum = define_enum do
+      enum[:Name_1].should == 1
+      enum[:name_1].should == 1
+    end
+  end
+
+  describe ".include?" do
+    let(:enum) {
+      define_enum do
         value :id => 1, :name => 'Name 1'
         value :id => 2, :name => 'Name 2'
       end
-      enum[:Name_1].should == 1
-      enum[:name_1].should == 1
+    }
+
+    it "should return true if value is a fixnum and matches an id" do
+      enum.include?(1).should be_true
     end
 
+    it "should return false if value is a fixnum and does not match an id" do
+      enum.include?(3).should be_false
+    end
+
+    it "should return true if value is a string and matches a name" do
+      enum.include?('Name 1').should be_true
+    end
+
+    it "should return false if value is a string and does not match a name" do
+      enum.include?('No match').should be_false
+    end
   end
 
   describe ".to_select" do
@@ -199,7 +217,7 @@ describe ActiveEnum::Base do
     end
 
     it 'should return array sorted using order setting' do
-      enum = define_enum() do
+      enum = define_enum do
         order :desc
         value :id => 1, :name => 'Name 1'
         value :id => 2, :name => 'Name 2'

data/spec/active_enum/storage/i18n_store_spec.rb

@@ -0,0 +1,184 @@
+require "spec_helper"
+
+describe ActiveEnum::Storage::I18nStore do
+  class TestI18nStoreEnum < ActiveEnum::Base; end
+  
+  let(:enum_class) { TestI18nStoreEnum }
+  let(:enum_key) { enum_class.name.underscore }
+  let(:store) { ActiveEnum::Storage::I18nStore.new(enum_class, :asc) }
+
+  before(:all) do
+    @_default_store = ActiveEnum.storage
+    ActiveEnum.storage = :i18n
+  end
+
+  after(:all) do
+    ActiveEnum.storage = @_default_store
+  end
+
+  before do
+    @default_locale = I18n.locale
+  end
+
+  after do
+    I18n.locale = @default_locale
+  end
+
+  describe '#set' do
+    it 'should store value of id and name' do
+      store.set 1, 'test name'
+      store.send(:_values).should == [[1, 'test name']]
+    end
+
+    it 'should store value of id, name and meta hash' do
+      store.set 1, 'test name', :description => 'meta'
+      store.send(:_values).should == [[1, 'test name', {:description => 'meta'}]]
+    end
+
+    it 'should raise error if duplicate id' do
+      expect {
+        store.set 1, 'Name 1'
+        store.set 1, 'Other Name'
+      }.should raise_error(ActiveEnum::DuplicateValue)
+    end
+
+    it 'should raise error if duplicate name' do
+      expect {
+        store.set 1, 'Name 1'
+        store.set 2, 'Name 1'
+      }.should raise_error(ActiveEnum::DuplicateValue)
+    end
+
+    it 'should not raise error if duplicate name with alternate case matches' do
+      expect {
+        store.set 1, 'Name 1'
+        store.set 2, 'name 1'
+      }.should_not raise_error(ActiveEnum::DuplicateValue)
+    end
+  end
+
+  describe "#values" do
+    before do
+      I18n.backend.store_translations :en, :active_enum => { enum_key => { :thanks => 'Thanks' } }
+      I18n.backend.store_translations :fr, :active_enum => { enum_key => { :thanks => 'Merce' } }
+    end
+
+    it 'should return array of stored values for current locale' do
+      store.set 1, 'thanks'
+
+      I18n.locale = :en
+      store.values.should == [ [1, 'Thanks'] ]
+
+      I18n.locale = :fr
+      store.values.should == [ [1, 'Merce'] ]
+    end
+
+  end
+
+  describe "#get_by_id" do
+    before do
+      I18n.backend.store_translations :en, :active_enum => { enum_key => { 'test' => 'Testing' } }
+    end
+
+    it 'should return the value for a given id' do
+      I18n.locale = :en
+
+      store.set 1, 'test'
+      store.get_by_id(1).should == [1, 'Testing']
+    end
+
+    it 'should return nil when id not found' do
+      store.get_by_id(1).should be_nil
+    end
+  end
+
+  describe "#get_by_name" do
+    before do
+      I18n.backend.store_translations :en, :active_enum => { enum_key => { 'test' => 'Testing' } }
+    end
+
+    it 'should return the value for a given name' do
+      store.set 1, 'test'
+      store.get_by_name('test').should == [1, 'Testing']
+    end
+
+    it 'should return nil when name not found' do
+      store.get_by_name('test').should be_nil
+    end
+  end
+
+  describe "#sort!" do
+    before do
+      I18n.backend.store_translations :en, :active_enum => { enum_key => { 
+        'name1' => 'Name 1',
+        'name2' => 'Name 2',
+        'name3' => 'Name 3',
+      } }
+    end
+
+    it 'should sort values ascending when passed :asc' do
+      store = described_class.new(enum_class, :asc)
+
+      store.set 2, 'name2'
+      store.set 1, 'name1'
+      store.values.should == [[1,'Name 1'], [2, 'Name 2']]
+    end
+
+    it 'should sort values descending when passed :desc' do
+      store = described_class.new(enum_class, :desc)
+
+      store.set 1, 'name1'
+      store.set 2, 'name2'
+      store.values.should == [[2, 'Name 2'], [1,'Name 1']]
+    end
+
+    it 'should not sort values when passed :natural' do
+      store = described_class.new(enum_class, :natural)
+
+      store.set 1, 'name1'
+      store.set 3, 'name3'
+      store.set 2, 'name2'
+      store.values.should == [[1,'Name 1'], [3,'Name 3'], [2, 'Name 2']]
+    end
+  end
+
+  context "loaded from yaml locale" do
+    before do
+      I18n.load_path << File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'support', 'i18n.yml'))
+      I18n.reload!
+      I18n.locale = :en
+    end
+
+    context "for top level enum" do
+      class TopLevelEnum < ActiveEnum::Base; end
+      let(:enum_class) { TopLevelEnum }
+
+      it 'should return array values from yaml' do
+        store.set 1, 'things'
+        store.get_by_name('things').should eq [1, 'Generic things']
+      end
+
+      it 'should not load locale entry unless defined in enum' do
+        store.set 1, 'things'
+        store.get_by_name('not_found').should be_nil
+      end
+    end
+
+    context "for namespaced model enum" do
+      module Namespaced; class ModelEnum < ActiveEnum::Base; end; end
+      let(:enum_class) { Namespaced::ModelEnum }
+
+      it 'should return array values from yaml' do
+        store.set 1, 'things'
+        store.get_by_name('things').should eq [1, 'Model things']
+      end
+
+      it 'should not load locale entry unless defined in enum' do
+        store.set 1, 'things'
+        store.get_by_name('not_found').should be_nil
+      end
+    end
+
+  end
+
+end

data/spec/active_enum/storage/memory_store_spec.rb

@@ -1,11 +1,11 @@
 require "spec_helper"
 
-class TestMemoryStoreEnum < ActiveEnum::Base; end
-class TestOtherAREnum < ActiveEnum::Base; end
-
 describe ActiveEnum::Storage::MemoryStore do
   attr_accessor :store
 
+  class TestMemoryStoreEnum < ActiveEnum::Base; end
+  class TestOtherAREnum < ActiveEnum::Base; end
+
   describe '#set' do
     it 'should store value of id and name' do
       store.set 1, 'test name'

data/spec/support/i18n.yml

@@ -0,0 +1,10 @@
+en:
+  active_enum:
+    top_level_enum:
+      things: Generic things
+      not_found: Should not find this for top level
+
+    namespaced:
+      model_enum:
+        things: Model things
+        not_found: Should not find this for nested

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: active_enum
 version: !ruby/object:Gem::Version 
-  hash: 53
+  hash: 43
   prerelease: 
   segments: 
   - 0
   - 9
-  - 7
-  version: 0.9.7
+  - 8
+  version: 0.9.8
 platform: ruby
 authors: 
 - Adam Meehan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-12-11 00:00:00 +11:00
+date: 2012-07-02 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -59,19 +59,24 @@ files:
 - lib/active_enum/form_helpers/simple_form.rb
 - lib/active_enum/railtie.rb
 - lib/active_enum/storage/abstract_store.rb
+- lib/active_enum/storage/i18n_store.rb
 - lib/active_enum/storage/memory_store.rb
 - lib/active_enum/version.rb
 - lib/generators/active_enum/install_generator.rb
-- lib/generators/active_enum/templates/active_enum.rb
+- lib/generators/active_enum/locale_generator.rb
+- lib/generators/active_enum/templates/config.rb
+- lib/generators/active_enum/templates/locale.yml
 - spec/active_enum/acts_as_enum_spec.rb
 - spec/active_enum/base_spec.rb
 - spec/active_enum/extensions_spec.rb
 - spec/active_enum/form_helpers/formtastic2_spec.rb
 - spec/active_enum/form_helpers/formtastic_spec.rb
 - spec/active_enum/form_helpers/simple_form_spec.rb
+- spec/active_enum/storage/i18n_store_spec.rb
 - spec/active_enum/storage/memory_store_spec.rb
 - spec/active_enum_spec.rb
 - spec/spec_helper.rb
+- spec/support/i18n.yml
 - spec/support/schema.rb
 has_rdoc: true
 homepage: http://github.com/adzap/active_enum
@@ -114,7 +119,9 @@ test_files:
 - spec/active_enum/form_helpers/formtastic2_spec.rb
 - spec/active_enum/form_helpers/formtastic_spec.rb
 - spec/active_enum/form_helpers/simple_form_spec.rb
+- spec/active_enum/storage/i18n_store_spec.rb
 - spec/active_enum/storage/memory_store_spec.rb
 - spec/active_enum_spec.rb
 - spec/spec_helper.rb
+- spec/support/i18n.yml
 - spec/support/schema.rb