active_enum 0.8.2 → 0.9.0

data/CHANGELOG

@@ -1,3 +1,8 @@
+[0.9.0] : 2010-08-11
+- Full ActiveModel support for enumerate extension. Use ActiveEnum.extend_classes array to indicate classes to extend.
+- Added generator for initializer config file with all settings.
+- Added setup block for config
+
 [0.8.2] : 2010-08-01
 - Fix method name clash of enum_for which is defined on Object
 - Refactor extension method definitions

data/README.rdoc

@@ -15,6 +15,10 @@ Put this in your Gemfile
 
   gem 'active_enum'
 
+Then generate the config initializer file
+
+  rails generate active_enum:install
+
 
 == Example
 
@@ -192,10 +196,7 @@ The input type will be automatically detected for enumerated attributes. You can
 
 
 == TODO
-* more docs
 * storage options of memory, database or yaml
 * use custom method name for the enumerated attribute
-* named_scopes
-* question methods for enum names e.g. user.male?
 
 Copyright (c) 2009 Adam Meehan, released under the MIT license

data/active_enum.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{active_enum}
-  s.version = "0.8.2"
+  s.version = "0.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam Meehan"]
   s.autorequire = %q{active_enum}
-  s.date = %q{2010-08-01}
+  s.date = %q{2010-08-11}
   s.description = %q{Define enum classes in Rails and use them to enumerate ActiveRecord attributes}
   s.email = %q{adam.meehan@gmail.com}
   s.extra_rdoc_files = ["README.rdoc"]
-  s.files = ["active_enum.gemspec", "MIT-LICENSE", "CHANGELOG", "README.rdoc", "Rakefile", "lib/active_enum", "lib/active_enum/acts_as_enum.rb", "lib/active_enum/base.rb", "lib/active_enum/extensions.rb", "lib/active_enum/form_helpers", "lib/active_enum/form_helpers/formtastic.rb", "lib/active_enum/form_helpers/simple_form.rb", "lib/active_enum/storage", "lib/active_enum/storage/abstract_store.rb", "lib/active_enum/storage/memory_store.rb", "lib/active_enum/version.rb", "lib/active_enum.rb", "lib/generators", "spec/active_enum", "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", "spec/active_enum/form_helpers/formtastic_spec.rb", "spec/active_enum/form_helpers/simple_form_spec.rb", "spec/active_enum/storage", "spec/active_enum/storage/memory_store_spec.rb", "spec/active_enum_spec.rb", "spec/schema.rb", "spec/spec_helper.rb"]
+  s.files = ["active_enum.gemspec", "MIT-LICENSE", "CHANGELOG", "README.rdoc", "Rakefile", "lib/active_enum", "lib/active_enum/acts_as_enum.rb", "lib/active_enum/base.rb", "lib/active_enum/extensions.rb", "lib/active_enum/form_helpers", "lib/active_enum/form_helpers/formtastic.rb", "lib/active_enum/form_helpers/simple_form.rb", "lib/active_enum/storage", "lib/active_enum/storage/abstract_store.rb", "lib/active_enum/storage/active_record_store.rb", "lib/active_enum/storage/memory_store.rb", "lib/active_enum/version.rb", "lib/active_enum.rb", "lib/generators", "lib/generators/active_enum", "lib/generators/active_enum/install_generator.rb", "lib/generators/active_enum/templates", "lib/generators/active_enum/templates/active_enum.rb", "spec/active_enum", "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", "spec/active_enum/form_helpers/formtastic_spec.rb", "spec/active_enum/form_helpers/simple_form_spec.rb", "spec/active_enum/storage", "spec/active_enum/storage/active_record_store_spec.rb", "spec/active_enum/storage/memory_store_spec.rb", "spec/active_enum_spec.rb", "spec/schema.rb", "spec/spec_helper.rb"]
   s.homepage = %q{http://github.com/adzap/active_enum}
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{active_enum}

data/lib/active_enum.rb

@@ -6,15 +6,28 @@ require 'active_enum/version'
 
 module ActiveEnum
   mattr_accessor :enum_classes
-  self.enum_classes = []
+  @@enum_classes = []
 
   mattr_accessor :use_name_as_value
-  self.use_name_as_value = false
+  @@use_name_as_value = false
 
   mattr_accessor :storage
-  self.storage = :memory
+  @@storage = :memory
 
-  class Configuration
+  mattr_accessor :extend_classes
+  @@extend_classes = []
+
+  def self.extend_classes=(klasses)
+    @@extend_classes = klasses
+    klasses.each {|klass| klass.send(:include, ActiveEnum::Extensions) }
+  end
+
+  # Setup method for plugin configuration
+  def self.setup
+    yield self
+  end
+
+  class EnumDefinitions
     def enum(name, &block)
       class_name = name.to_s.camelize
       eval("class #{class_name} < ActiveEnum::Base; end", TOPLEVEL_BINDING)
@@ -23,9 +36,10 @@ module ActiveEnum
     end
   end
 
+  # Define enums in bulk
   def self.define(&block)
     raise "Define requires block" unless block_given?
-    Configuration.new.instance_eval(&block)
+    EnumDefinitions.new.instance_eval(&block)
   end
 
 end

data/lib/active_enum/extensions.rb

@@ -2,11 +2,11 @@ module ActiveEnum
   class EnumNotFound < StandardError; end
 
   module Extensions
+    extend ActiveSupport::Concern
 
-    def self.included(base)
-      base.extend ClassMethods
-      base.class_inheritable_accessor :enumerated_attributes
-      base.enumerated_attributes = {}
+    included do
+      class_inheritable_accessor :enumerated_attributes
+      self.enumerated_attributes = {}
     end
 
     module ClassMethods
@@ -122,5 +122,3 @@ module ActiveEnum
 
   end
 end
-
-ActiveRecord::Base.send :include, ActiveEnum::Extensions

data/lib/active_enum/storage/active_record_store.rb

@@ -0,0 +1,64 @@
+module ActiveEnum
+  class Model < ActiveRecord::Base
+    set_table_name 'enums'
+    serialize :meta, Hash
+  end
+
+  module Storage
+    class ActiveRecordStore < AbstractStore
+      def initialize(enum_class, order)
+        super
+        @values = values_from_db
+      end
+
+      def set(id, name)
+        check_duplicate id, name
+        values << [id, name]
+        sort!
+      end
+
+      def get_by_id(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
+      end
+
+      def check_duplicate(id, name)
+        if get_by_id(id) || get_by_name(name)
+          raise ActiveEnum::DuplicateValue
+        end
+      end
+
+      def sort!
+        return if @order == :as_defined
+				case @order
+				when :asc
+					values.sort! {|a,b| a[0] <=> b[0] }
+				when :desc
+					values.sort! {|a,b| b[0] <=> a[0] }
+				end
+      end
+
+      def order_clause
+        @order_clause ||= case @order
+        when :asc
+          'enum_id ASC'
+        when :desc
+          'enum_id DESC'
+        else
+          'modified_at ASC'
+        end
+      end
+
+      def values_from_db
+        ActiveEnum::Model.all(:conditions => {:enum_type => @enum.to_s}, :order => order_clause).map {|r| [r.enum_id, r.name] }
+      end
+    end
+  end
+end

data/lib/active_enum/version.rb

@@ -1,3 +1,3 @@
 module ActiveEnum
-  VERSION = '0.8.2'
+  VERSION = '0.9.0'
 end

data/lib/generators/active_enum/install_generator.rb

@@ -0,0 +1,14 @@
+module ActiveEnum
+  module Generators
+    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'
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# Form helper integration
+# require 'active_enum/form_helpers/simple_form'
+# require 'active_enum/form_helpers/formtastic
+
+ActiveEnum.setup do |config|
+
+  # Extend classes to add enumerate method 
+  config.extend_classes = [ ActiveRecord::Base ]
+
+  # Return name string as value for attribute method
+  # config.use_name_as_value = false
+
+  # Storage of values
+  # config.storage = :memory
+
+end
+
+# ActiveEnum.define do
+# 
+#   enum(:enum_name) do
+#     value 1 => 'Name'
+#   end
+# 
+# end

data/spec/active_enum/storage/active_record_store_spec.rb

@@ -0,0 +1,133 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+require 'active_enum/storage/active_record_store'
+
+class TestARStoreEnum < ActiveEnum::Base; end
+class TestOtherAREnum < ActiveEnum::Base; end
+
+describe ActiveEnum::Storage::ActiveRecordStore do
+  attr_accessor :store
+
+  context '#set' do
+    it 'should store value of id and name' do
+      store.set 1, 'Name 1'
+      store.values.should == [[1, 'Name 1']]
+    end
+
+    it 'should raise error if duplicate id' do
+      lambda {
+        store.set 1, 'Name 1'
+        store.set 1, 'Other Name'
+      }.should raise_error(ActiveEnum::DuplicateValue)
+    end
+
+    it 'should raise error if duplicate name' do
+      lambda {
+        store.set 1, 'Name 1'
+        store.set 2, 'Name 1'
+      }.should raise_error(ActiveEnum::DuplicateValue)
+    end
+
+    it 'should raise error if duplicate name matches title-case name' do
+      lambda {
+        store.set 1, 'Name 1'
+        store.set 2, 'name 1'
+      }.should raise_error(ActiveEnum::DuplicateValue)
+    end
+
+    it 'should create a record for values' do
+      store.set 1, 'Name 1'
+      ActiveEnum::Model.count.should == 1
+      r = ActiveEnum::Model.first
+      r.enum_id.should == 1
+      r.name.should == 'Name 1'
+    end
+  end
+
+  context "#values" do
+    it 'should return array of stored values' do
+      store.set 1, 'Name 1'
+      store.values.should == [[1, 'Name 1']]
+    end
+
+    it 'should return values for set enum only' do
+      alt_store.set 1, 'Other Name 1'
+      store.set 1, 'Name 1'
+      store.values.should == [[1, 'Name 1']]
+    end
+  end
+
+  context "#get_by_id" do
+    it 'should return the value for a given id' do
+      store.set 1, 'Name 1'
+      store.get_by_id(1).should == [1, 'Name 1']
+    end
+
+    it 'should return nil when id not found' do
+      store.get_by_id(1).should be_nil
+    end
+
+    it 'should return value for correct enum' do
+      alt_store.set 1, 'Other Name 1'
+      store.set 1, 'Name 1'
+      store.get_by_id(1).should == [1, 'Name 1']
+    end
+  end
+
+  context "#get_by_name" do
+    it 'should return the value for a given name' do
+      store.set 1, 'Name 1'
+      store.get_by_name('Name 1').should == [1, 'Name 1']
+    end
+
+    it 'should return the value with title-cased name for a given lowercase name' do
+      store.set 1, 'Name 1'
+      store.get_by_name('name 1').should == [1, 'Name 1']
+    end
+
+    it 'should return nil when name not found' do
+      store.get_by_name('test name').should be_nil
+    end
+    
+    it 'should return value for correct enum' do
+      alt_store.set 1, 'Other Name 1'
+      store.set 1, 'Name 1'
+      store.get_by_name('Name 1').should == [1, 'Name 1']
+    end
+  end
+
+  context "sort!" do
+    it 'should sort values ascending when passed :asc' do
+      @order = :asc
+      store.set 2, 'Name 2'
+      store.set 1, 'Name 1'
+      store.values.should == [[1,'Name 1'], [2, 'Name 2']]
+    end
+
+    it 'should sort values descending when passed :desc' do
+      @order = :desc
+      store.set 1, 'Name 1'
+      store.set 2, 'Name 2'
+      store.values.should == [[2, 'Name 2'], [1,'Name 1']]
+    end
+
+    it 'should not sort values when passed :as_defined' do
+      @order = :as_defined
+      store.set 1, 'Name 1'
+      store.set 3, 'Name 3'
+      store.set 2, 'Name 2'
+      store.values.should == [[1,'Name 1'], [3,'Name 3'], [2, 'Name 2']]
+    end
+  end
+
+  after do
+    ActiveEnum::Model.delete_all
+  end
+
+  def store
+    @store ||= ActiveEnum::Storage::ActiveRecordStore.new(TestARStoreEnum, @order)
+  end
+
+  def alt_store
+    @alt_store ||= ActiveEnum::Storage::ActiveRecordStore.new(TestOtherAREnum, :asc)
+  end
+end

data/spec/active_enum_spec.rb

@@ -2,19 +2,44 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Bulk enum definitions" do
 
-  it 'should define enum constants using block' do
-    ActiveEnum.define do
-      enum(:foo) do
-        value :id => 1, :name => 'Foo 1'
-      end
+  context ".define" do
+    it 'should define enum constants using block' do
+      ActiveEnum.define do
+        enum(:foo) do
+          value :id => 1, :name => 'Foo 1'
+        end
 
-      enum(:bar) do
-        value :id => 1, :name => 'Bar 1'
+        enum(:bar) do
+          value :id => 1, :name => 'Bar 1'
+        end
       end
+      Foo.all.should == [[1,'Foo 1']]
+      Bar.all.should == [[1,'Bar 1']]
     end
+  end
 
-    Foo.all.should == [[1,'Foo 1']]
-    Bar.all.should == [[1,'Bar 1']]
+  context ".setup" do
+    before :all do
+      @original = ActiveEnum.use_name_as_value
+    end
+
+    it 'should pass module into block as configuration object' do
+      ActiveEnum.use_name_as_value.should be_false
+      ActiveEnum.setup {|config| config.use_name_as_value = true }
+      ActiveEnum.use_name_as_value.should be_true
+    end
+    
+    after :all do
+      ActiveEnum.use_name_as_value = @original
+    end
+  end
+
+  context ".extend_classes" do
+    it 'should add enumerate extensions to given classes' do
+      ActiveEnum.extend_classes = [ActiveRecord::Base, NotActiveRecord]
+      ActiveRecord::Base.should respond_to(:enumerate)
+      NotActiveRecord.should respond_to(:enumerate)
+    end
   end
 
   it 'should use the memory store by default' do

data/spec/schema.rb

@@ -12,4 +12,15 @@ ActiveRecord::Schema.define(:version => 1) do
     t.string :name
   end
 
+  create_table :enums, :force => true do |t|
+    t.integer :enum_id
+    t.string :name
+    t.string :enum_type
+    t.string :meta
+    t.datetime :modified_at
+  end
+  add_index :enums, [:enum_id, :enum_type], :unique => true
+  add_index :enums, [:name, :enum_type]
+  add_index :enums, [:modified_at, :enum_type]
+
 end

data/spec/spec_helper.rb

@@ -19,6 +19,8 @@ ActiveRecord::Migration.verbose = false
 ActiveRecord::Base.establish_connection({:adapter => 'sqlite3', :database => ':memory:'})
 ActiveRecord::Base.logger = Logger.new('/dev/null')
 
+ActiveEnum.extend_classes = [ActiveRecord::Base]
+
 require 'schema'
 
 class Person < ActiveRecord::Base; end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 8
-  - 2
-  version: 0.8.2
+  - 9
+  - 0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Adam Meehan
@@ -15,7 +15,7 @@ autorequire: active_enum
 bindir: bin
 cert_chain: []
 
-date: 2010-08-01 00:00:00 +10:00
+date: 2010-08-11 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -39,14 +39,18 @@ files:
 - lib/active_enum/form_helpers/formtastic.rb
 - lib/active_enum/form_helpers/simple_form.rb
 - lib/active_enum/storage/abstract_store.rb
+- lib/active_enum/storage/active_record_store.rb
 - lib/active_enum/storage/memory_store.rb
 - lib/active_enum/version.rb
 - lib/active_enum.rb
+- lib/generators/active_enum/install_generator.rb
+- lib/generators/active_enum/templates/active_enum.rb
 - 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/formtastic_spec.rb
 - spec/active_enum/form_helpers/simple_form_spec.rb
+- spec/active_enum/storage/active_record_store_spec.rb
 - spec/active_enum/storage/memory_store_spec.rb
 - spec/active_enum_spec.rb
 - spec/schema.rb