active_enum 0.7.1 → 0.8.0

data/CHANGELOG

@@ -0,0 +1,5 @@
+[0.8.0] : 2010-07-19
+- Added pluggable storage API
+- Added memory store as default storage
+- Added meta data storage per value has a hash
+- Added enum .meta method to access meta data

data/README.rdoc

@@ -167,31 +167,17 @@ Giving you the familiar enum methods
 
 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.
-Instructions for each are below.
+You just need to require the extension for the respective plugin in an initialiser:
 
-==== Formtastic
-
-In an initialiser:
+Formtastic:
 
   require 'active_enum/form_helpers/formtastic'
 
-Then declare the input for an enumerated attribute as the :enum type.
-
-  <% semantic_form_for(@person) do |f| %>
-    <%= f.input :sex, :as => :enum %>
-  <% end %>
-
-==== SimpleForm
-
-In an initialiser:
+Or, SimpleForm:
 
   require 'active_enum/form_helpers/simple_form'
 
-Then declare the input for an enumerated attribute as the :enum type.
-
-  <% simple_form_for(@person) do |f| %>
-    <%= f.input :sex, :as => :enum %>
-  <% end %>
+The input type will be automatically detected for enumerated attributes. You can override with the :as option as normal.
 
 
 == TODO

data/Rakefile

@@ -23,7 +23,7 @@ spec = Gem::Specification.new do |s|
 
   s.require_path = 'lib'
   s.autorequire = GEM_NAME
-  s.files = %w(MIT-LICENSE README.rdoc Rakefile) + Dir.glob("{lib,spec}/**/*")
+  s.files = %w(active_enum.gemspec MIT-LICENSE CHANGELOG README.rdoc Rakefile) + Dir.glob("{lib,spec}/**/*")
 end
 
 desc 'Default: run specs.'

data/active_enum.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{active_enum}
+  s.version = "0.8.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-07-19}
+  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.homepage = %q{http://github.com/adzap/active_enum}
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{active_enum}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Define enum classes in Rails and use them to enumerate ActiveRecord attributes}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/active_enum.rb

@@ -1,6 +1,7 @@
 require 'active_enum/base'
 require 'active_enum/extensions'
 require 'active_enum/acts_as_enum'
+require 'active_enum/storage/abstract_store'
 require 'active_enum/version'
 
 module ActiveEnum
@@ -10,6 +11,9 @@ module ActiveEnum
   mattr_accessor :use_name_as_value
   self.use_name_as_value = false
 
+  mattr_accessor :storage
+  self.storage = :memory
+
   class Configuration
     def enum(name, &block)
       class_name = name.to_s.camelize

data/lib/active_enum/base.rb

@@ -5,70 +5,69 @@ module ActiveEnum
   class Base
 
     class << self
+      attr_accessor :store
 
       def inherited(subclass)
         ActiveEnum.enum_classes << subclass
       end
 
-      # :name => 'Foo', implicit ID
       # :id => 1, :name => 'Foo'
+      # :name => 'Foo'
       # 1 => 'Foo'
       #
       def value(enum_value)
-        @values ||= []
-
-        id, name = id_and_name(enum_value)
-        check_duplicate(id, name)
-
-        @values << [id, name]
-				sort_values! unless @order == :as_defined
+        store.set *id_and_name_and_meta(enum_value)
       end
 
-      # order enum values using :asc or :desc
+      # Order enum values. Allowed values are :asc, :desc or :as_defined
       #
 			def order(order)
 				@order = order
 			end
 
       def all
-        @values || []
+        store.values
       end
 
       def ids
-        @values.map {|v| v[0] }
+        store.values.map {|v| v[0] }
       end
 
       def names
-        @values.map {|v| v[1] }
+        store.values.map {|v| v[1] }
       end
 
       def to_select
-				@values.map {|v| [v[1], v[0]] }
+				store.values.map {|v| [v[1], v[0]] }
       end
 
       def [](index)
         if index.is_a?(Fixnum)
-          row = lookup_by_id(index)
+          row = store.get_by_id(index)
           row[1] if row
         else
-          row = lookup_by_name(index)
+          row = store.get_by_name(index)
           row[0] if row
         end
       end
 
-      private
-
-      def lookup_by_id(index)
-        @values.assoc(index)
+      def meta(index)
+        row = if index.is_a?(Fixnum)
+          store.get_by_id(index)
+        else
+          store.get_by_name(index)
+        end
+        row[2] || {} if row
       end
 
-      def lookup_by_name(index)
-        @values.rassoc(index.to_s) || @values.rassoc(index.to_s.titleize)
-      end
+      private
 
-      def id_and_name(hash)
+      def id_and_name_and_meta(hash)
         if hash.has_key?(:id) || hash.has_key?(:name)
-          return (hash[:id] || next_id), hash[:name]
+          id   = hash.delete(:id) || next_id
+          name = hash.delete(:name)
+          meta = hash
+          return id, name, (meta.blank? ? nil : meta)
         elsif hash.keys.first.is_a?(Fixnum)
           return *Array(hash).first
         else
@@ -77,25 +76,16 @@ module ActiveEnum
       end
 
       def next_id
-        (ids.max || 0) + 1
+        ids.max.to_i + 1
       end
 
-      def check_duplicate(id, name)
-        if lookup_by_id(id)
-          raise ActiveEnum::DuplicateValue, "The id #{id} is already defined for #{self} enum."
-        elsif lookup_by_name(name)
-          raise ActiveEnum::DuplicateValue, "The name #{name} is already defined for #{self} enum."
-        end
+      def store
+        @store ||= storage_class.new(self, @order || :asc)
       end
 
-			def sort_values!
-				case (@order || :asc)
-				when :asc
-					@values.sort! {|a,b| a[0] <=> b[0] }
-				when :desc
-					@values.sort! {|a,b| b[0] <=> a[0] }
-				end
-			end
+      def storage_class
+        "ActiveEnum::Storage::#{ActiveEnum.storage.to_s.classify}Store".constantize
+      end
 
     end
 

data/lib/active_enum/storage/abstract_store.rb

@@ -0,0 +1,29 @@
+module ActiveEnum
+  module Storage
+    autoload :MemoryStore, "active_enum/storage/memory_store"
+
+    class NotImplemented < StandardError; end
+
+    class AbstractStore 
+      def initialize(enum_class, order)
+        @enum, @order = enum_class, order
+      end
+
+      def set(id, name, meta=nil)
+        raise NotImplemented
+      end
+
+      def get_by_id(id)
+        raise NotImplemented
+      end
+
+      def get_by_name(name)
+        raise NotImplemented
+      end
+
+      def values
+        raise NotImplemented
+      end
+    end
+  end
+end

data/lib/active_enum/storage/memory_store.rb

@@ -0,0 +1,39 @@
+module ActiveEnum
+  module Storage
+    class MemoryStore < AbstractStore
+      def set(id, name, meta=nil)
+        check_duplicate id, name
+        values << [id, name, meta].compact
+        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
+    end
+  end
+end

data/lib/active_enum/version.rb

@@ -1,3 +1,3 @@
 module ActiveEnum
-  VERSION = '0.7.1'
+  VERSION = '0.8.0'
 end

data/spec/active_enum/base_spec.rb

@@ -1,70 +1,106 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
 describe ActiveEnum::Base do
-  it 'should return empty array from :all method when no values defined' do
-    ActiveEnum.enum_classes = []
-    class NewEnum < ActiveEnum::Base
+
+  context ".store" do
+    it 'should load the storage class instance using the storage setting' do
+      ActiveEnum::Base.send(:store).should be_instance_of(ActiveEnum::Storage::MemoryStore)
     end
-    ActiveEnum.enum_classes.should == [NewEnum]
   end
 
-  it 'should return empty array from :all method when no values defined' do
-    define_enum.all.should == []
-  end
+  context ".enum_classes" do
+    it 'should return all enum classes defined use class definition' do
+      ActiveEnum.enum_classes = []
+      class NewEnum < ActiveEnum::Base; end
+      ActiveEnum.enum_classes.should == [NewEnum]
+    end
 
-  it 'should allow me to define a value with an id and name' do
-    enum = define_enum do
-      value :id => 1, :name => 'Name'
+    it 'should return all enum classes defined using define block' do
+      ActiveEnum.enum_classes = []
+      ActiveEnum.define do
+        enum(:bulk_new_enum) { }
+      end
+      ActiveEnum.enum_classes.should == [BulkNewEnum]
     end
-    enum.all.should == [[1,'Name']]
   end
 
-  it 'should allow me to define a value with a name only' do
-    enum = define_enum do
-      value :name => 'Name'
+  context ".all" do
+    it 'should return an empty array when no values defined' do
+      define_enum.all.should == []
     end
-    enum.all.should == [[1,'Name']]
   end
 
-  it 'should allow me to define a value as hash with id as key and name as value' do
-    enum = define_enum do
-      value 1 => 'Name'
+  context ".value" do
+    it 'should allow me to define a value with an id and name' do
+      enum = define_enum do
+        value :id => 1, :name => 'Name'
+      end
+      enum.all.should == [[1,'Name']]
     end
-    enum.all.should == [[1,'Name']]
-  end
 
-  it 'should increment value ids when defined without ids' do
-    enum = define_enum do
-      value :name => 'Name 1'
-      value :name => 'Name 2'
+    it 'should allow me to define a value with a name only' do
+      enum = define_enum do
+        value :name => 'Name'
+      end
+      enum.all.should == [[1,'Name']]
     end
-    enum.all.should == [[1,'Name 1'], [2, 'Name 2']]
-  end
 
-  it 'should raise error is the id is a duplicate' do
-    lambda do
-      define_enum do
-        value :id => 1, :name => 'Name 1'
-        value :id => 1, :name => 'Name 2'
+    it 'should allow me to define a value as hash with id as key and name as value' do
+      enum = define_enum do
+        value 1 => 'Name'
       end
-    end.should raise_error(ActiveEnum::DuplicateValue)
-  end
+      enum.all.should == [[1,'Name']]
+    end
 
-  it 'should raise error is the name is a duplicate' do
-    lambda do
-      define_enum do
-        value :id => 1, :name => 'Name'
-        value :id => 2, :name => 'Name'
+    it 'should allow to define meta data value with extra key value pairs' do
+      enum = define_enum do
+        value :id => 1, :name => 'Name', :description => 'extra'
       end
-    end.should raise_error(ActiveEnum::DuplicateValue)
+      enum.all.should == [[1,'Name',{:description => 'extra'}]]
+    end
+
+    it 'should increment value ids when defined without ids' do
+      enum = define_enum do
+        value :name => 'Name 1'
+        value :name => 'Name 2'
+      end
+      enum.all.should == [[1,'Name 1'], [2, 'Name 2']]
+    end
+
+    it 'should raise error if the id is a duplicate' do
+      lambda do
+        define_enum do
+          value :id => 1, :name => 'Name 1'
+          value :id => 1, :name => 'Name 2'
+        end
+      end.should raise_error(ActiveEnum::DuplicateValue)
+    end
+
+    it 'should raise error if the name is a duplicate' do
+      lambda do
+        define_enum do
+          value :id => 1, :name => 'Name'
+          value :id => 2, :name => 'Name'
+        end
+      end.should raise_error(ActiveEnum::DuplicateValue)
+    end
   end
 
-  it 'should return sorted values by id from :all' do
-    enum = define_enum do
-      value :id => 2, :name => 'Name 2'
-      value :id => 1, :name => 'Name 1'
+  context ".meta" do
+    it 'should return meta values hash for a given index value' do
+      enum = define_enum do
+        value :id => 1, :name => 'Name', :description => 'extra'
+      end
+      enum.meta(1).should == {:description => 'extra'}
     end
-    enum.all.first[0].should == 1
+
+    it 'should return empty hash for index with no meta defined' do
+      enum = define_enum do
+        value :id => 1, :name => 'Name'
+      end
+      enum.meta(1).should == {}
+    end
+
   end
 
   context "sorting" do
@@ -96,23 +132,27 @@ describe ActiveEnum::Base do
     end
   end
 
-  it 'should return array of ids' do
-    enum = define_enum do
-      value :id => 1, :name => 'Name 1'
-      value :id => 2, :name => 'Name 2'
+  context ".ids" do
+    it 'should return array of ids' do
+      enum = define_enum do
+        value :id => 1, :name => 'Name 1'
+        value :id => 2, :name => 'Name 2'
+      end
+      enum.ids.should == [1,2]
     end
-    enum.ids.should == [1,2]
   end
 
-  it 'should return array of names' do
-    enum = define_enum do
-      value :id => 1, :name => 'Name 1'
-      value :id => 2, :name => 'Name 2'
+  context ".names" do
+    it 'should return array of names' do
+      enum = define_enum do
+        value :id => 1, :name => 'Name 1'
+        value :id => 2, :name => 'Name 2'
+      end
+      enum.names.should == ['Name 1', 'Name 2']
     end
-    enum.names.should == ['Name 1', 'Name 2']
   end
 
-  describe "element reference method" do
+  context "element reference method" do
 
     it 'should return name when given an id' do
       enum = define_enum do
@@ -141,21 +181,23 @@ describe ActiveEnum::Base do
 
   end
 
-  it 'should return array for select helpers from to_select' do
-    enum = define_enum do
-      value :id => 1, :name => 'Name 1'
-      value :id => 2, :name => 'Name 2'
+  context ".to_select" do
+    it 'should return array for select helpers' do
+      enum = define_enum do
+        value :id => 1, :name => 'Name 1'
+        value :id => 2, :name => 'Name 2'
+      end
+      enum.to_select.should == [['Name 1',1], ['Name 2',2]]
     end
-    enum.to_select.should == [['Name 1',1], ['Name 2',2]]
-  end
 
-  it 'should return array sorted using order setting from to_select' do
-    enum = define_enum() do
-			order :desc
-      value :id => 1, :name => 'Name 1'
-      value :id => 2, :name => 'Name 2'
+    it 'should return array sorted using order setting' do
+      enum = define_enum() do
+        order :desc
+        value :id => 1, :name => 'Name 1'
+        value :id => 2, :name => 'Name 2'
+      end
+      enum.to_select.should == [['Name 2',2], ['Name 1',1]]
     end
-    enum.to_select.should == [['Name 2',2], ['Name 1',1]]
   end
 
   def define_enum(&block)

data/spec/active_enum/storage/memory_store_spec.rb

@@ -0,0 +1,113 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+class TestMemoryStoreEnum < ActiveEnum::Base; end
+class TestOtherAREnum < ActiveEnum::Base; end
+
+describe ActiveEnum::Storage::MemoryStore do
+  attr_accessor :store
+
+  context '#set' do
+    it 'should store value of id and name' do
+      store.set 1, 'test name'
+      store.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.values.should == [[1, 'test name', {:description => 'meta'}]]
+    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
+  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, 'test name'
+      store.get_by_id(1).should == [1, 'test name']
+    end
+
+    it 'should return nil when id not found' do
+      store.get_by_id(1).should be_nil
+    end
+  end
+
+  context "#get_by_name" do
+    it 'should return the value for a given name' do
+      store.set 1, 'test name'
+      store.get_by_name('test name').should == [1, 'test name']
+    end
+
+    it 'should return the value with title-cased name for a given lowercase name' do
+      store.set 1, 'Test Name'
+      store.get_by_name('test name').should == [1, 'Test Name']
+    end
+
+    it 'should return nil when name not found' do
+      store.get_by_name('test name').should be_nil
+    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
+
+  def store
+    @store ||= ActiveEnum::Storage::MemoryStore.new(TestMemoryStoreEnum, @order)
+  end
+
+  def alt_store
+    @alt_store ||= ActiveEnum::Storage::MemoryStore.new(TestOtherAREnum, :asc)
+  end
+end

data/spec/active_enum_spec.rb

@@ -2,7 +2,7 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Bulk enum definitions" do
 
-  it 'define enum constants using block' do
+  it 'should define enum constants using block' do
     ActiveEnum.define do
       enum(:foo) do
         value :id => 1, :name => 'Foo 1'
@@ -17,4 +17,8 @@ describe "Bulk enum definitions" do
     Bar.all.should == [[1,'Bar 1']]
   end
 
+  it 'should use the memory store by default' do
+    ActiveEnum.storage.should == :memory
+  end
+
 end

data/spec/spec_helper.rb

@@ -3,15 +3,21 @@ $:.unshift(File.join(File.dirname(__FILE__), '..', 'spec'))
 
 require 'rubygems'
 require 'rspec/autorun'
-require 'rspec/rails'
 
 require 'active_record'
+require 'action_controller'
+require 'action_view'
+require 'action_mailer'
+
 require 'active_enum'
 
 RAILS_ROOT = File.dirname(__FILE__)
 
+require 'rspec/rails'
+
 ActiveRecord::Migration.verbose = false
 ActiveRecord::Base.establish_connection({:adapter => 'sqlite3', :database => ':memory:'})
+ActiveRecord::Base.logger = Logger.new('/dev/null')
 
 require 'schema'
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: active_enum
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 63
   prerelease: false
   segments: 
   - 0
-  - 7
-  - 1
-  version: 0.7.1
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Adam Meehan
@@ -15,7 +15,7 @@ autorequire: active_enum
 bindir: bin
 cert_chain: []
 
-date: 2010-07-02 00:00:00 +10:00
+date: 2010-07-19 00:00:00 +10:00
 default_executable: 
 dependencies: []
 
@@ -28,7 +28,9 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- active_enum.gemspec
 - MIT-LICENSE
+- CHANGELOG
 - README.rdoc
 - Rakefile
 - lib/active_enum/acts_as_enum.rb
@@ -36,6 +38,8 @@ files:
 - lib/active_enum/extensions.rb
 - 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/memory_store.rb
 - lib/active_enum/version.rb
 - lib/active_enum.rb
 - spec/active_enum/acts_as_enum_spec.rb
@@ -43,6 +47,7 @@ files:
 - 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/memory_store_spec.rb
 - spec/active_enum_spec.rb
 - spec/schema.rb
 - spec/spec_helper.rb