active_enum 0.9.1 → 0.9.3

data/CHANGELOG

@@ -1,3 +1,11 @@
+[0.9.3] : 2011-07-31
+- Add Railtie for proper loading of ActiveRecord extensions.
+
+[0.9.2] : 2011-07-31
+- Deprecate :as_defined order in favour of :natural.
+- Allow storage options to passed to ActiveEnum.storage = :foo, :bar => true.
+- Also allow ActiveEnum.storage_options = { :bar => true }
+
 [0.9.1] : 2011-01-12
 - Fix SimpleForm helper for v1.3.0 with backwards compat.
 

data/README.rdoc

@@ -75,7 +75,7 @@ To define the sorting of returned values use the order method. Which is useful f
     value :id => 2, :name => 'Female'
   end
 
-By default the order is ascending (:asc) but you can also choose descending (:desc) or in order of definition (:as_defined).
+By default the order is ascending (:asc) but you can also choose descending (:desc) or in natural order of definition (:natural).
 The last option is useful when supplying id values but have a specific order needed to display them.
 
 === Enumerate model attributes

data/Rakefile

@@ -1,36 +1,11 @@
-require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
 require 'rake/rdoctask'
-require 'rake/gempackagetask'
-require 'rubygems/specification'
 require 'rspec/core/rake_task'
-require 'lib/active_enum/version'
-
-GEM_NAME = "active_enum"
-GEM_VERSION = ActiveEnum::VERSION
-
-spec = Gem::Specification.new do |s|
-  s.name = GEM_NAME
-  s.version = GEM_VERSION
-  s.platform = Gem::Platform::RUBY
-  s.rubyforge_project = "active_enum"
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["README.rdoc"]
-  s.summary = "Define enum classes in Rails and use them to enumerate ActiveRecord attributes"
-  s.description = s.summary
-  s.author = "Adam Meehan"
-  s.email = "adam.meehan@gmail.com"
-  s.homepage = "http://github.com/adzap/active_enum"
-  s.require_path = 'lib'
-  s.files = %w(active_enum.gemspec MIT-LICENSE CHANGELOG README.rdoc Rakefile) + Dir.glob("{lib,spec}/**/*")
-end
-
-desc 'Default: run specs.'
-task :default => :spec
 
 desc "Run specs"
-RSpec::Core::RakeTask.new do |t|
-  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
-end
+RSpec::Core::RakeTask.new(:spec)
 
 desc "Generate code coverage"
 RSpec::Core::RakeTask.new(:coverage) do |t|
@@ -47,18 +22,5 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-end
-
-desc "install the gem locally"
-task :install => [:package] do
-  sh %{gem install pkg/#{GEM_NAME}-#{GEM_VERSION}}
-end
-
-desc "create a gemspec file"
-task :make_spec do
-  File.open("#{GEM_NAME}.gemspec", "w") do |file|
-    file.puts spec.to_ruby
-  end
-end
+desc 'Default: run specs.'
+task :default => :spec

data/active_enum.gemspec

@@ -1,29 +1,20 @@
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "active_enum/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{active_enum}
-  s.version = "0.9.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Adam Meehan"]
-  s.date = %q{2011-01-12}
+  s.name        = "active_enum"
+  s.version     = ActiveEnum::VERSION
+  s.authors     = ["Adam Meehan"]
+  s.summary     = %q{Define enum classes in Rails and use them to enumerate ActiveRecord attributes}
   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", "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/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}
+  s.email       = %q{adam.meehan@gmail.com}
+  s.homepage    = %q{http://github.com/adzap/active_enum}
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.require_paths    = ["lib"]
+  s.files            = `git ls-files`.split("\n") - %w{ .gitignore .rspec Gemfile Gemfile.lock autotest/discover.rb }
+  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.extra_rdoc_files = ["README.rdoc", "CHANGELOG", "MIT-LICENSE"]
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-    else
-    end
-  else
-  end
+  s.add_runtime_dependency(%q<activesupport>, ["~> 3.0"])
 end

data/init.rb

@@ -0,0 +1 @@
+require 'active_enum'

data/lib/active_enum.rb

@@ -1,6 +1,5 @@
 require 'active_enum/base'
 require 'active_enum/extensions'
-require 'active_enum/acts_as_enum' if defined?(ActiveRecord)
 require 'active_enum/storage/abstract_store'
 
 module ActiveEnum
@@ -15,17 +14,21 @@ module ActiveEnum
   mattr_accessor :storage
   @@storage = :memory
 
-  mattr_accessor :extend_classes
-  @@extend_classes = [ defined?(ActiveRecord) && ActiveRecord::Base ].compact
+  mattr_accessor :storage_options
+  @@storage_options = {}
 
-  def self.extend_classes=(klasses)
-    @@extend_classes = klasses
-    klasses.each {|klass| klass.send(:include, ActiveEnum::Extensions) }
+  def storage=(*args)
+    @@storage_options = args.extract_options!
+    @@storage = args.first
   end
 
+  mattr_accessor :extend_classes
+  @@extend_classes = []
+
   # Setup method for plugin configuration
   def self.setup
     yield self
+    extend_classes!
   end
 
   class EnumDefinitions
@@ -43,4 +46,14 @@ module ActiveEnum
     EnumDefinitions.new.instance_eval(&block)
   end
 
+  def self.storage_class
+    @@storage_class ||= "ActiveEnum::Storage::#{storage.to_s.classify}Store".constantize
+  end
+
+  private
+
+  def self.extend_classes!
+    extend_classes.each {|klass| klass.send(:include, ActiveEnum::Extensions) }
+  end
+
 end

data/lib/active_enum/base.rb

@@ -23,9 +23,13 @@ module ActiveEnum
       end
 
       # Specify order enum values are returned. 
-      # Allowed values are :asc, :desc or :as_defined
+      # Allowed values are :asc, :desc or :natural
       #
       def order(order)
+        if order == :as_defined
+          ActiveSupport::Deprecation.warn("You are using the order :as_defined which has been deprecated. Use :natural.")
+          order = :natural
+        end
         @order = order
       end
 
@@ -90,11 +94,7 @@ module ActiveEnum
       end
 
       def store
-        @store ||= storage_class.new(self, @order || :asc)
-      end
-
-      def storage_class
-        "ActiveEnum::Storage::#{ActiveEnum.storage.to_s.classify}Store".constantize
+        @store ||= ActiveEnum.storage_class.new(self, @order || :asc, ActiveEnum.storage_options)
       end
 
     end

data/lib/active_enum/extensions.rb

@@ -22,38 +22,49 @@ module ActiveEnum
       #     enumerate :sex do
       #       value :id => 1, :name => 'Male'
       #     end
-			#
-			#     # Multiple attributes with same enum
+      #
+      #     # Multiple attributes with same enum
       #     enumerate :to, :from, :with => Sex
       #
       def enumerate(*attributes, &block)
         self.enumerated_attributes ||= {}
-				options = attributes.extract_options!
-				attributes.each do |attribute|
-					begin
-						if block_given?
-              enum_class_name = "#{self.name}::#{attribute.to_s.camelize}"
-              eval("class #{enum_class_name} < ActiveEnum::Base; end")
-						  enum = enum_class_name.constantize
-              enum.class_eval &block
-						else
-							enum = options[:with] || attribute.to_s.classify.constantize
-						end
-						attribute = attribute.to_sym
-						self.enumerated_attributes[attribute] = enum
-
-						define_active_enum_read_method(attribute)
-						define_active_enum_write_method(attribute)
-						define_active_enum_question_method(attribute)
-					rescue NameError => e
-						raise e unless e.message =~ /uninitialized constant/
-						raise ActiveEnum::EnumNotFound, "Enum class could not be found for attribute '#{attribute}' in class #{self}. Specify the enum class using the :with option."
-					end
-				end
+        options = attributes.extract_options!
+
+        attributes.each do |attribute|
+          begin
+            if block_given?
+              enum = define_implicit_enum_class_for_attribute(attribute, block)
+            else
+              enum = options[:with] || attribute.to_s.camelize.constantize
+            end
+
+            attribute = attribute.to_sym
+            enumerated_attributes[attribute] = enum
+
+            define_active_enum_methods_for_attribute(attribute)
+          rescue NameError => e
+            raise e unless e.message =~ /uninitialized constant/
+            raise ActiveEnum::EnumNotFound, "Enum class could not be found for attribute '#{attribute}' in class #{self}. Specify the enum class using the :with option."
+          end
+        end
       end
 
       def active_enum_for(attribute)
-        self.enumerated_attributes && self.enumerated_attributes[attribute.to_sym]
+        enumerated_attributes[attribute.to_sym]
+      end
+
+      def define_active_enum_methods_for_attribute(attribute)
+        define_active_enum_read_method(attribute)
+        define_active_enum_write_method(attribute)
+        define_active_enum_question_method(attribute)
+      end
+
+      def define_implicit_enum_class_for_attribute(attribute, block)
+        enum_class_name = "#{name}::#{attribute.to_s.camelize}"
+        eval("class #{enum_class_name} < ActiveEnum::Base; end")
+        enum = enum_class_name.constantize
+        enum.class_eval &block
+        enum
       end
 
       # Define read method to allow an argument for the enum component
@@ -118,7 +129,7 @@ module ActiveEnum
           if arg
             send(attribute) == self.class.active_enum_for(attribute)[arg]
           else
-            super
+            super()
           end
         end
       end

data/lib/active_enum/railtie.rb

@@ -0,0 +1,11 @@
+module ActiveEnum 
+  class Railtie < Rails::Railtie
+    initializer "active_enum.active_record_extensions" do
+      ActiveSupport.on_load(:active_record) do
+        require 'active_enum/acts_as_enum'
+
+        ActiveEnum.extend_orms = [ ActiveRecord::Base ]
+      end
+    end
+  end
+end

data/lib/active_enum/storage/abstract_store.rb

@@ -5,8 +5,8 @@ module ActiveEnum
     class NotImplemented < StandardError; end
 
     class AbstractStore 
-      def initialize(enum_class, order)
-        @enum, @order = enum_class, order
+      def initialize(enum_class, order, options={})
+        @enum, @order, @options = enum_class, order, options
       end
 
       def set(id, name, meta=nil)

data/lib/active_enum/storage/memory_store.rb

@@ -26,7 +26,7 @@ module ActiveEnum
       end
 
       def sort!
-        return if @order == :as_defined
+        return if @order == :natural
 
         case @order
         when :asc

data/lib/active_enum/version.rb

@@ -1,3 +1,3 @@
 module ActiveEnum
-  VERSION = '0.9.1'
+  VERSION = '0.9.3'
 end

data/spec/active_enum/base_spec.rb

@@ -131,7 +131,7 @@ describe ActiveEnum::Base do
 
     it 'should return sorted values by id using order setting' do
       enum = define_enum do
-        order :as_defined
+        order :natural
         value :id => 3, :name => 'Name 3'
         value :id => 1, :name => 'Name 1'
         value :id => 2, :name => 'Name 2'

data/spec/active_enum/storage/memory_store_spec.rb

@@ -94,8 +94,8 @@ describe ActiveEnum::Storage::MemoryStore do
       store.values.should == [[2, 'Name 2'], [1,'Name 1']]
     end
 
-    it 'should not sort values when passed :as_defined' do
-      @order = :as_defined
+    it 'should not sort values when passed :natural' do
+      @order = :natural
       store.set 1, 'Name 1'
       store.set 3, 'Name 3'
       store.set 2, 'Name 2'

data/spec/active_enum_spec.rb

@@ -34,9 +34,14 @@ describe ActiveEnum do
     end
   end
 
-  describe ".extend_classes" do
+  describe ".extend_classes!" do
     it 'should add enumerate extensions to given classes' do
-      ActiveRecord::Base.should respond_to(:enumerate)
+      ActiveEnum.extend_classes = [NotActiveRecord]
+
+      NotActiveRecord.should_not respond_to(:enumerate)
+
+      ActiveEnum.extend_classes!
+
       NotActiveRecord.should respond_to(:enumerate)
     end
   end

data/spec/spec_helper.rb

@@ -7,6 +7,7 @@ require 'action_view'
 require 'action_mailer'
 
 require 'active_enum'
+require 'active_enum/acts_as_enum'
 
 module Config
   class Application < Rails::Application
@@ -31,7 +32,8 @@ class NotActiveRecord
   attr_accessor :name
 end
 
-ActiveEnum.extend_classes = [ActiveRecord::Base, NotActiveRecord]
+ActiveEnum.extend_classes = [ActiveRecord::Base]
+ActiveEnum.extend_classes!
 
 module SpecHelper
   def reset_class(klass, &block)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: active_enum
 version: !ruby/object:Gem::Version 
-  hash: 57
-  prerelease: false
+  hash: 61
+  prerelease: 
   segments: 
   - 0
   - 9
-  - 1
-  version: 0.9.1
+  - 3
+  version: 0.9.3
 platform: ruby
 authors: 
 - Adam Meehan
@@ -15,10 +15,24 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-12 00:00:00 +11:00
+date: 2011-09-01 00:00:00 +10:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
 description: Define enum classes in Rails and use them to enumerate ActiveRecord attributes
 email: adam.meehan@gmail.com
 executables: []
@@ -27,21 +41,25 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
-files: 
-- active_enum.gemspec
+- CHANGELOG
 - MIT-LICENSE
+files: 
 - CHANGELOG
+- MIT-LICENSE
 - README.rdoc
 - Rakefile
+- active_enum.gemspec
+- init.rb
+- lib/active_enum.rb
 - lib/active_enum/acts_as_enum.rb
 - lib/active_enum/base.rb
 - lib/active_enum/extensions.rb
 - lib/active_enum/form_helpers/formtastic.rb
 - lib/active_enum/form_helpers/simple_form.rb
+- lib/active_enum/railtie.rb
 - 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/active_enum/install_generator.rb
 - lib/generators/active_enum/templates/active_enum.rb
 - spec/active_enum/acts_as_enum_spec.rb
@@ -82,10 +100,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: active_enum
-rubygems_version: 1.3.7
+rubyforge_project: 
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
 summary: Define enum classes in Rails and use them to enumerate ActiveRecord attributes
-test_files: []
-
+test_files: 
+- 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/memory_store_spec.rb
+- spec/active_enum_spec.rb
+- spec/schema.rb
+- spec/spec_helper.rb