active_enum 0.6.1 → 0.6.2

data/README.rdoc

@@ -35,21 +35,28 @@ Beware that if you change the order of values defined in an enum which don't hav
 This could corrupt your data if the enum values have been stored in a model record, as they will no longer map to
 the original enum.
 
-You can also define the sort order of returned values
+Enum class usage
+
+  Sex[1]        # => 'Male'
+  Sex['Male']   # => 1
+  Sex[:male]    # => 1
+  Sex.to_select # => [['Male', 1], ['Female',2]] for select form helpers
+
+=== Ordering
+
+To define the sorting of returned values use the order method. Which is useful for to_select method.
 
   class Sex < ActiveEnum::Base
-    order :desc
+    order :asc
 
     value :id => 1, :name => 'Male'
     value :id => 2, :name => 'Female'
   end
 
-Enum class usage
+By default the order is ascending (:asc) but you can also choose descending (:desc) or in order of definition (:as_defined).
+The last option is useful when supplying id values but have a specific order needed to display them.
 
-  Sex[1]        # => 'Male'
-  Sex['Male']   # => 1
-  Sex[:male]    # => 1
-  Sex.to_select # => [['Male', 1], ['Female',2]] for select form helpers
+=== Enumerate model attributes
 
 Use the enum to enumerate an ActiveRecord model attribute
 
@@ -79,6 +86,8 @@ Multiple attributes with same enum
     enumerate :to, :from, :with => Sex
   end
 
+=== Attribute value lookup
+
 Access the enum values and the enum class using the attribute method with a symbol for the enum component you want
 
   user = User.new
@@ -89,6 +98,13 @@ Access the enum values and the enum class using the attribute method with a symb
   user.sex(:name)  # => 'Male'
   user.sex(:enum)  # => Sex
 
+You can set the default to return the enum name value for enumerated attribute
+
+  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
 
   user.sex?(:male)    # => true
@@ -96,14 +112,13 @@ You can check if the attribute value matches a particular enum value by passing
   user.sex?('Male')   # => true
   user.sex?('Female') # => false
 
-A convience method on the class is available to the enum class of any enumerated attribute
+=== Enum lookup
 
-  User.enum_for(:sex) # => Sex
+A convenience method on the class is available to the enum class of any enumerated attribute
 
-You can set the default to return the enum name value for enumerated attribute
+  User.enum_for(:sex) # => Sex
 
-  ActiveEnum.use_name_as_value = true
-  user.sex # => 'Male'
+=== Bulk definition
 
 Define enum classes in bulk without class files, in an initializer file for example.
 
@@ -125,6 +140,8 @@ Define enum classes in bulk without class files, in an initializer file for exam
 
 All defined enum classes are stored in ActiveEnum.enum_classes array if you need look them up or iterate over them.
 
+=== Model as enum or acts_as_enum
+
 You can make an existing model class behave like an enum class with acts_as_enum
 
   class User < ActiveRecord::Base

data/Rakefile

@@ -59,7 +59,7 @@ end
 
 desc "install the gem locally"
 task :install => [:package] do
-  sh %{sudo gem install pkg/#{GEM_NAME}-#{GEM_VERSION}}
+  sh %{gem install pkg/#{GEM_NAME}-#{GEM_VERSION}}
 end
 
 desc "create a gemspec file"

data/lib/active_enum.rb

@@ -10,6 +10,9 @@ module ActiveEnum
   mattr_accessor :use_name_as_value
   self.use_name_as_value = false
 
+  mattr_accessor :raise_error_for_not_defined
+  self.raise_error_for_not_defined = false
+
   class Configuration
     def enum(name, &block)
       class_name = name.to_s.camelize

data/lib/active_enum/base.rb

@@ -1,10 +1,11 @@
 module ActiveEnum
   class DuplicateValue < StandardError; end
+  class ValueNotDefined < StandardError; end
 
   class Base
 
     class << self
-      
+
       def inherited(subclass)
         ActiveEnum.enum_classes << subclass
       end
@@ -13,13 +14,13 @@ module ActiveEnum
       # :title => 'Foo'
       #
       def value(enum_value={})
-        @values ||= [] 
+        @values ||= []
 
         id = enum_value[:id] || next_id
         check_duplicate(id, enum_value[:name])
 
         @values << [id, enum_value[:name]]
-				sort_values!
+				sort_values! unless @order == :as_defined
       end
 
       # order enum values using :asc or :desc
@@ -47,9 +48,11 @@ module ActiveEnum
       def [](index)
         if index.is_a?(Fixnum)
           row = lookup_by_id(index)
+          raise(ActiveEnum::ValueNotDefined, "The id value #{index} is not defined for #{self} enum.") if row.nil? && ActiveEnum.raise_error_for_not_defined
           row[1] if row
         else
           row = lookup_by_name(index)
+          raise(ActiveEnum::ValueNotDefined, "The name value #{index} is not defined for #{self} enum.") if row.nil? && ActiveEnum.raise_error_for_not_defined
           row[0] if row
         end
       end
@@ -63,7 +66,7 @@ module ActiveEnum
       def lookup_by_name(index)
         @values.rassoc(index.to_s) || @values.rassoc(index.to_s.titleize)
       end
-      
+
       def next_id
         (ids.max || 0) + 1
       end

data/lib/active_enum/version.rb

@@ -1,3 +1,3 @@
 module ActiveEnum
-  VERSION = '0.6.1'
+  VERSION = '0.6.2'
 end

data/spec/active_enum/base_spec.rb

@@ -60,13 +60,33 @@ describe ActiveEnum::Base do
     enum.all.first[0].should == 1
   end
 
-  it 'should return sorted values by id using order setting from :all' do
-    enum = define_enum do
-			order :desc
-      value :id => 1, :name => 'Name 1'
-      value :id => 2, :name => 'Name 2'
+  context "sorting" do
+    it 'should return values ascending by default' do
+      enum = define_enum do
+        value :id => 2, :name => 'Name 2'
+        value :id => 1, :name => 'Name 1'
+      end
+      enum.all.should == [[1,'Name 1'], [2, 'Name 2']]
+    end
+
+    it 'should return sorted values by id using order setting' do
+      enum = define_enum do
+        order :desc
+        value :id => 1, :name => 'Name 1'
+        value :id => 2, :name => 'Name 2'
+      end
+      enum.all.should == [[2, 'Name 2'], [1,'Name 1']]
+    end
+
+    it 'should return sorted values by id using order setting' do
+      enum = define_enum do
+        order :as_defined
+        value :id => 3, :name => 'Name 3'
+        value :id => 1, :name => 'Name 1'
+        value :id => 2, :name => 'Name 2'
+      end
+      enum.all.should == [[3,'Name 3'], [1,'Name 1'], [2, 'Name 2']]
     end
-    enum.all.first[0].should == 2
   end
 
   it 'should return array of ids' do
@@ -112,6 +132,32 @@ describe ActiveEnum::Base do
       enum[:name_1].should == 1
     end
 
+    context "when raise_error_for_not_defined" do
+      before(:all) do
+        ActiveEnum.raise_error_for_not_defined = true
+      end
+
+      it 'should raise error when id value not defined' do
+        enum = define_enum do
+          value :id => 1, :name => 'Name 1'
+          value :id => 2, :name => 'Name 2'
+        end
+        lambda { enum[-1] }.should raise_exception(ActiveEnum::ValueNotDefined)
+      end
+
+      it 'should raise error when name value not defined' do
+        enum = define_enum do
+          value :id => 1, :name => 'Name 1'
+          value :id => 2, :name => 'Name 2'
+        end
+        lambda { enum['Name 3'] }.should raise_exception(ActiveEnum::ValueNotDefined)
+      end
+
+      after(:all) do
+        ActiveEnum.raise_error_for_not_defined = false
+      end
+    end
+
   end
 
   it 'should return array for select helpers from to_select' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: active_enum
 version: !ruby/object:Gem::Version 
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors: 
 - Adam Meehan
@@ -9,7 +9,7 @@ autorequire: active_enum
 bindir: bin
 cert_chain: []
 
-date: 2010-02-04 00:00:00 +11:00
+date: 2010-03-17 00:00:00 +11:00
 default_executable: 
 dependencies: []