ar-enums 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76780917d22a19979bf55349df98c76f027b56f2
-  data.tar.gz: 684f4dd21c88e5afa078899e2fbd1b2a7c51e9a0
+  metadata.gz: 6c0a162df9f114bb7f98a9e3677f9c9f120410fa
+  data.tar.gz: 3b5e730a99f090bd33d8358ae7f0c956b56de9b7
 SHA512:
-  metadata.gz: f4008e4235652e4079b753a12f7c06cabbe0f415699ce6ed1af4ae9845b8f13065c8a08b8d159a2dbb0b1e27c81fcb97edac660a960698221ce37df18c7b62a9
-  data.tar.gz: 77fdae95b57878bf048128c3452cbdf7143b6547562c66d8498df7b3e752bda42fe41020449b4468ff976dff757ff4f3c6610578713cefb66e4c79c25b1f9fe8
+  metadata.gz: 0617d1dc6e15212c45ca6971755123e92f33221ce241369737b7f5cc800c087fe44e97b6e310f2c89fc137a4abf9d150c16f04604a7151adb5e9507b851da9e0
+  data.tar.gz: 0ff182905b261870a7b4f84fd86f5641894a9d1e1d3ee4f4262cb7606d8aa6db52377c85acd4a62d4bc4deaf13b12944889dd555c359445da80042b0d4ce641e

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile.lock

@@ -1,52 +1,82 @@
 PATH
   remote: .
   specs:
-    ar-enums (2.0.1)
+    ar-enums (2.0.2)
       activerecord (>= 3.1.0)
-      rake
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (4.1.4)
-      activesupport (= 4.1.4)
-      builder (~> 3.1)
-    activerecord (4.1.4)
-      activemodel (= 4.1.4)
-      activesupport (= 4.1.4)
-      arel (~> 5.0.0)
-    activesupport (4.1.4)
-      i18n (~> 0.6, >= 0.6.9)
-      json (~> 1.7, >= 1.7.7)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
       minitest (~> 5.1)
-      thread_safe (~> 0.1)
       tzinfo (~> 1.1)
-    arel (5.0.1.20140414130214)
-    builder (3.2.2)
-    diff-lcs (1.1.2)
-    guard (1.4.0)
-      listen (>= 0.4.2)
-      thor (>= 0.14.6)
-    guard-rspec (0.4.5)
-      guard (>= 0.4.0)
-    i18n (0.6.11)
-    json (1.8.1)
-    listen (0.5.3)
-    minitest (5.4.0)
+    arel (9.0.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    ffi (1.9.25)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
     rake (10.3.2)
-    rb-fsevent (0.9.3)
-    rspec (2.4.0)
-      rspec-core (~> 2.4.0)
-      rspec-expectations (~> 2.4.0)
-      rspec-mocks (~> 2.4.0)
-    rspec-core (2.4.0)
-    rspec-expectations (2.4.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.4.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
     sqlite3 (1.3.9)
-    thor (0.19.1)
-    thread_safe (0.3.4)
-    tzinfo (1.2.1)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
       thread_safe (~> 0.1)
 
 PLATFORMS
@@ -55,6 +85,9 @@ PLATFORMS
 DEPENDENCIES
   ar-enums!
   guard-rspec
-  rb-fsevent
+  rake
   rspec
   sqlite3 (>= 1.3.4)
+
+BUNDLED WITH
+   1.16.0

data/Guardfile

@@ -1,21 +1,5 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-guard 'rspec', :version => 2 do
+guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
   watch('spec/spec_helper.rb')  { "spec" }
-
-  # Rails example
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('spec/spec_helper.rb')                        { "spec" }
-  watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
-  # Capybara request specs
-  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
 end
-

data/README.md

@@ -0,0 +1,129 @@
+# ar-enums
+
+This is a simple solution for defining enumerations in your Rails models.
+
+[![Build Status](https://travis-ci.org/eeng/ar-enums.svg?branch=master)](https://travis-ci.org/eeng/ar-enums)
+
+## Description
+
+It provides two forms of enumerations:
+* Internal, i.e. defined within the owner of the enum, for the simple cases.
+* External, i.e. defined on it's own class, for the complex ones.
+
+In both cases the enum values are stored in-memory. Let's see some examples of both kinds.
+
+## Internal enumerations
+
+Can be defined in three flavours:
+
+### Array of values style
+
+This is the simplest and probably the most frecuent case:
+
+```ruby
+class TrafficLight < ActiveRecord::Base
+  enum :state, %w[red green yellow]
+end
+
+tl = TrafficLight.new(:state => :green)
+tl.state          # => #<TrafficLight::State @name="green", @id=2>
+tl.state_id       # => 2
+tl.state.green?   # => true
+```
+
+As you can see each enum value is an instance of a dinamically generated class (which inherits from ArEnums::Base) and has an ordinal value, id, autogenerated staring on 1.
+
+The enumerations array is accessed with a class method:
+
+```ruby
+TrafficLight.states  # => [#<TrafficLight::State @name="red", @id=1>, #<TrafficLight::State @name="green", @id=2>, ...]
+```
+
+By default when `#to_s` is called on a Enum instance it returns the name titleized, but this behaviour can be overrided. See Displaying Enums section below.
+
+### Array of hashes style
+
+This allows you to define new columns in the Enum value. If the :id is not specified is generated for you.
+
+```ruby
+class TrafficLight < ActiveRecord::Base
+  enum :state, [
+    { :name => :red, :stop_traffic => true, :rgb => 0xF00 },
+    { :name => :green, :stop_traffic => false, :rgb => 0x0F0 }
+  ]
+end
+
+tl = TrafficLight.new(:state => :green)
+tl.state_id              # => 2
+tl.state.stop_traffic    # => false
+tl.state.rgb             # => 0x0F0
+```
+
+### Block style
+
+```ruby
+class TrafficLight < ActiveRecord::Base
+  enum :state do
+    red :stop_traffic => true, :rgb => 0xF00
+    green :stop_traffic => false, :rgb => 0x0F0
+  end
+end
+```
+
+## External enumerations
+
+When you have shared enumerations or just don't want to clutter the owner model with enums definitions,
+the enumeration can be on it's own class, as the State enum in the following example:
+
+```ruby
+class TrafficLight < ActiveRecord::Base
+  enum :state
+end
+
+class State < ArEnums::Base
+  enumeration do
+    red :stop_traffic => true, :rgb => 0xF00, :desc => 'Rojo'
+    green :stop_traffic => false, :rgb => 0x0F0, :desc => 'Verde'
+  end
+end
+
+State[:red]         # => #<State @name="red", @id=1, ...>
+State[:red].to_s    # => "Rojo"
+```
+
+Note the block style sintax is exactly the same as in the internal enumerations. In fact any of the 3 styles mencioned above can be used on external enumerations.
+
+Also note the `#to_s` by default return the value of the `:desc` column. Of course you can override the `#to_s` method as usual.
+
+Then you can access the enumerations collection from both places:
+
+```ruby
+TrafficLight.states  # => [#<State @name="red", @id=1, ...>, #<State @name="green", @id=2, ...>]
+States.all           # => [#<State @name="red", @id=1, ...>, #<State @name="green", @id=2, ...>]
+```
+
+The `enum` method accept a `:class_method` option similar to the one in `belongs_to` and others to specify the class of the enum.
+
+## Displaying Enums
+
+In the array of values style the default is the name titleized but you can pass a `:label` options to override:
+
+```ruby
+class TrafficLight < ActiveRecord::Base
+  enum :state, %w[red green yellow], :label => :upcase
+end
+
+TrafficLight.states.map(&:to_s)   # => ["RED", "GREEN", "YELLOW"]
+```
+
+If you use the block o array of hashes sintax and add a `:desc` column it will be used as `#to_s`, unless a `:label` option is passed.
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.

data/Rakefile

@@ -4,4 +4,4 @@ Bundler::GemHelper.install_tasks
 
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new :spec
-task :default => :spec
+task default: :spec

data/ar_enums.gemspec

@@ -16,12 +16,10 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  
+
   s.add_development_dependency "rspec"
   s.add_development_dependency "guard-rspec"
-  s.add_development_dependency "rb-fsevent"
-  # s.add_development_dependency "ruby-debug19"
   s.add_development_dependency "sqlite3", ">= 1.3.4"
+  s.add_development_dependency "rake"
   s.add_dependency "activerecord", ">= 3.1.0"
-  s.add_dependency "rake"
 end

data/examples/internal_enums.rb

@@ -1,27 +1,25 @@
-require 'rubygems'
-require 'active_record'
 require 'ar-enums'
 
-ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
 load(File.dirname(__FILE__) + "/../spec/schema.rb")
 
 class TrafficLight < ActiveRecord::Base
   enum :state, %w[red green yellow]
 end
 
-tl = TrafficLight.new(:state => :green)
+tl = TrafficLight.new(state: :green)
 p tl.state      # => #<TrafficLight::State @name="green", @id=2>
-p tl.state_id   # => 2    
+p tl.state_id   # => 2
 p TrafficLight.states.map(&:to_s)
 
 # class TrafficLight < ActiveRecord::Base
 #   enum :state, [
-#     { :name => :red, :stop_traffic => true, :rgb => 0xF00 },
-#     { :name => :green, :stop_traffic => false, :rgb => 0x0F0 }
+#     { name: :red, stop_traffic: true, rgb: 0xF00 },
+#     { name: :green, stop_traffic: false, rgb: 0x0F0 }
 #   ]
 # end
-# 
-# tl = TrafficLight.new(:state => :green)
-# p tl.state_id       # => 2    
+#
+# tl = TrafficLight.new(state: :green)
+# p tl.state_id       # => 2
 # p tl.state.stop_traffic   # => false
 # p tl.state.rgb            # => 0x0F0

data/lib/ar_enums/version.rb

@@ -1,3 +1,3 @@
 module ArEnums
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 end

data/spec/ar_enums/base_spec.rb

@@ -4,7 +4,7 @@ describe "Enum" do
   it "should provide :to_sym method returning name as symbols" do
     ArEnums::Base.new(name: :green).to_sym.should == :green
   end
-  
+
   it "should store extra columns as a hash without the :enum_class that is passed from other classes" do
     ArEnums::Base.new(name: :green, factor: 1.5, enum_class: Class.new).extra_columns.should == { factor: 1.5 }
   end
@@ -17,30 +17,30 @@ describe "Enum" do
           green rgb: 0x0F0
           blue rgb: 0x00F
         end
-      end    
+      end
 
       define_model_class 'State', 'ArEnums::Base' do
         enumeration do
           on id: 80
           off id: 90
         end
-      end    
+      end
     end
-    
+
     it "should provide :all method to access the enums" do
       Color.all[0].should be_enum_with(name: 'red', rgb: 0xF00)
       Color.all[1].should be_enum_with(name: 'green', rgb: 0x0F0)
       State.all[0].should be_enum_with(name: 'on', id: 80)
       State.all[1].should be_enum_with(name: 'off', id: 90)
     end
-    
+
     it "should provide [] method to access the enums" do
       Color[:red].should be_enum_with(name: 'red')
       Color['green'].should be_enum_with(name: 'green')
       Color[2].should be_enum_with(name: 'green')
     end
   end
-  
+
   context "finders" do
     it "find_all_by_id" do
       Color.find_all_by_id([1, 2, 3, 4]).should == Color.all
@@ -48,7 +48,7 @@ describe "Enum" do
       Color.find_all_by_id([]).should == []
     end
   end
-  
+
   it "in? should check if == to any" do
     define_model_class 'Color', 'ArEnums::Base' do
       enumeration do
@@ -56,16 +56,16 @@ describe "Enum" do
         green rgb: 0x0F0
         blue rgb: 0x00F
       end
-    end    
-    
+    end
+
     Color[:red].should be_in :red, :blue
     Color[:red].should be_in :green, :red, :blue
     Color[:red].should be_in Color[:red]
     Color[:red].should_not be_in :blue
   end
-  
+
   it "should work with sets" do
-    Set.new([Color[:red]]).intersection(Set.new([Color[:red].dup])).should have(1).item
+    Set.new([Color[:red]]).intersection(Set.new([Color[:red].dup])).size.should == 1
   end
 
   it "should be sortable" do

data/spec/ar_enums/enum_definition_spec.rb

@@ -10,60 +10,60 @@ describe "Internal enumerations" do
   before do
     define_traffic_light :state, %w[red green yellow]
   end
-  
+
   context "getter and setter" do
     it "getter should return an Enum" do
-      TrafficLight.new(:state_id => 3).state.should be_enum_with(:id => 3, :name => 'yellow')
+      TrafficLight.new(state_id: 3).state.should be_enum_with(id: 3, name: 'yellow')
     end
 
     it "should store ordinal by default as foreign key" do
-      TrafficLight.new(:state => :green).state_id.should == 2
+      TrafficLight.new(state: :green).state_id.should == 2
     end
 
     it "should store nil if enum doesn't exists" do
-      TrafficLight.new(:state => :black).state_id.should be_nil
+      TrafficLight.new(state: :black).state_id.should be_nil
     end
 
     it "should allow to set enum with symbol" do
-      TrafficLight.new(:state => :red).state.should == :red
-      TrafficLight.new(:state => :green).state.should == :green
+      TrafficLight.new(state: :red).state.should == :red
+      TrafficLight.new(state: :green).state.should == :green
     end
 
     it "should allow to set enum with string" do
-      TrafficLight.new(:state => 'red').state.should == :red
-      TrafficLight.new(:state => 'green').state.should == :green
+      TrafficLight.new(state: 'red').state.should == :red
+      TrafficLight.new(state: 'green').state.should == :green
     end
 
     it "should allow to set enum with ordinal" do
-      TrafficLight.new(:state_id => 1).state.should == :red
-      TrafficLight.new(:state_id => 2).state.should == :green
-    end    
+      TrafficLight.new(state_id: 1).state.should == :red
+      TrafficLight.new(state_id: 2).state.should == :green
+    end
   end
-  
+
   context "options" do
     it "should pass the options to the factory" do
-      define_traffic_light :state, %w[green red], :label => :upcase
-      TrafficLight.new(:state => :green).state.to_s.should == 'GREEN'
-      TrafficLight.new(:state => :red).state.to_s.should == 'RED'
+      define_traffic_light :state, %w[green red], label: :upcase
+      TrafficLight.new(state: :green).state.to_s.should == 'GREEN'
+      TrafficLight.new(state: :red).state.to_s.should == 'RED'
     end
   end
-  
+
   context "question methods" do
     before do
       define_traffic_light :state, %w[green red]
     end
-    
+
     it "should provide question method" do
-      TrafficLight.new(:state => :green).state.should be_green
-      TrafficLight.new(:state => :green).state.should_not be_red
-      TrafficLight.new(:state => :red).state.should_not be_green
-      TrafficLight.new(:state => :red).state.should be_red
+      TrafficLight.new(state: :green).state.should be_green
+      TrafficLight.new(state: :green).state.should_not be_red
+      TrafficLight.new(state: :red).state.should_not be_green
+      TrafficLight.new(state: :red).state.should be_red
     end
-    
+
     it "should raise error if tested with inexistant enum" do
-      lambda { TrafficLight.new(:state => :green).state.blue? }.should raise_error(NameError)
+      lambda { TrafficLight.new(state: :green).state.blue? }.should raise_error(NameError)
     end
-    
+
     it "block style should also provide question method" do
       define_model_class 'TrafficLight' do
         enum :state do
@@ -71,11 +71,11 @@ describe "Internal enumerations" do
           red
         end
       end
-      TrafficLight.new(:state => :green).state.should be_green
-      TrafficLight.new(:state => :green).state.should_not be_red
+      TrafficLight.new(state: :green).state.should be_green
+      TrafficLight.new(state: :green).state.should_not be_red
     end
   end
-  
+
   it "should be instances of a new subclass of Enum" do
     TrafficLight.states.first.should be_a(TrafficLight::State)
   end
@@ -89,26 +89,26 @@ describe "External enumerations" do
         tx
       end
     end
-    
+
     define_model_class 'Country' do
       enum :state
     end
-    
+
     define_model_class 'TrafficLightState', 'ArEnums::Base' do
       enumeration do
-        green :rgb => 0x0F0
-        red :rgb => 0xF00
+        green rgb: 0x0F0
+        red rgb: 0xF00
       end
     end
-    
+
     define_model_class 'TrafficLight' do
-      enum :state, :class_name => 'TrafficLightState'
+      enum :state, class_name: 'TrafficLightState'
     end
   end
-  
+
   context "enums creation" do
     it "should allow to define enumerations on it's own class" do
-      TrafficLight.new(:state => :red).state.should be_enum_with(:name => 'red', :rgb => 0xF00, :id => 2)
+      TrafficLight.new(state: :red).state.should be_enum_with(name: 'red', rgb: 0xF00, id: 2)
     end
 
     it "should be posible to access all enums from withing the owner" do
@@ -118,34 +118,34 @@ describe "External enumerations" do
 
     it "should accept :class_name options to override de class of the external enum" do
       define_model_class 'TrafficLight' do
-        enum :state_on_weekdays, :class_name => 'TrafficLightState'
-        enum :state_on_weekends, :class_name => 'TrafficLightState'
+        enum :state_on_weekdays, class_name: 'TrafficLightState'
+        enum :state_on_weekends, class_name: 'TrafficLightState'
       end
       TrafficLight.state_on_weekdays.should equal(TrafficLightState.all)
       TrafficLight.state_on_weekends.should equal(TrafficLightState.all)
-    end    
-    
+    end
+
     it "external enums should be instances of the subclass of Enum" do
       TrafficLightState.all.each { |s| s.should be_a(TrafficLightState) }
     end
-    
+
     it "should be posible to define new methods in Enum subclass" do
       define_model_class 'State', 'ArEnums::Base' do
         enumeration do
-          green :factor => 1
-          red :factor => 2
+          green factor: 1
+          red factor: 2
         end
-        
+
         def double_factor() factor * 2 end
-      end    
+      end
       State.all.map(&:double_factor).should == [2, 4]
-    end 
-    
+    end
+
     it "should not define new constant form enum class" do
       define_model_class 'TrafficLight' do
-        enum :estado, :class_name => 'TrafficLightState'
+        enum :estado, class_name: 'TrafficLightState'
       end
-      expect { TrafficLight.const_get(:Estado) }.to raise_error NameError
-    end   
+      lambda { TrafficLight.const_get(:Estado) }.should raise_error NameError
+    end
   end
 end

data/spec/ar_enums/factory_spec.rb

@@ -7,7 +7,7 @@ describe "Enums creation styles" do
     add_option config, class_name: ArEnums::Base
     ArEnums::Factory.make_enums *config, &block
   end
-  
+
   context "array of values style" do
     it "should generate ids" do
       enums = make_enums %w[red green blue]
@@ -15,23 +15,23 @@ describe "Enums creation styles" do
       enums[1].should be_enum_with(id: 2, name: 'green')
       enums[2].should be_enum_with(id: 3, name: 'blue')
     end
-    
+
     it "default to_s should be name titleized" do
-      make_enums(%w[green red]).map(&:to_s).should == %w[Green Red]      
+      make_enums(%w[green red]).map(&:to_s).should == %w[Green Red]
     end
 
     it "should override default to_s" do
       make_enums(%w[green red], label: :upcase).map(&:to_s).should == %w[GREEN RED]
     end
   end
-  
+
   context "array of hashes style" do
     it "should accept ids if provided" do
       enums = make_enums [{ id: 20, name: :red }, { id: 10, name: :green }]
       enums[0].should be_enum_with(id: 20, name: 'red')
       enums[1].should be_enum_with(id: 10, name: 'green')
     end
-    
+
     it "should generate ids if not provided" do
       enums = make_enums [{ name: :red }, { name: :green }]
       enums[0].should be_enum_with(id: 1, name: 'red')
@@ -41,18 +41,18 @@ describe "Enums creation styles" do
     it "default to_s should be :desc column" do
       enums = make_enums [{ name: :red, desc: 'Rojo' }, { name: :green, desc: 'Verde' }]
       enums.map(&:to_s).should == %w[Rojo Verde]
-    end      
-    
+    end
+
     it ":label options can be a method to call on name" do
       enums = make_enums [{ name: :red }, { name: :green }], label: :upcase
       enums.map(&:to_s).should == %w[RED GREEN]
-    end   
-       
+    end
+
     it ":label option can be a enum column" do
       enums = make_enums [{ name: :red, title: 'Rojo' }, { name: :green, title: 'Verde' }], label: :title
       enums.map(&:to_s).should == %w[Rojo Verde]
-    end      
-    
+    end
+
     it "should accept extra columns" do
       enums = make_enums [
         { name: :red, factor: 1.5, stop_traffic: true },
@@ -62,7 +62,7 @@ describe "Enums creation styles" do
       enums.map(&:stop_traffic).should == [true, false]
     end
   end
-  
+
   context "block style" do
     it "can be created with a block" do
       enums = make_enums do
@@ -71,8 +71,8 @@ describe "Enums creation styles" do
       end
       enums[0].should be_enum_with(id: 1, name: 'red', rgb: 0xF00)
       enums[1].should be_enum_with(id: 2, name: 'green', rgb: 0x0F0)
-    end    
-    
+    end
+
     it "should accept :label option" do
       enums = make_enums label: :title do
         red title: 'Rojo'
@@ -80,7 +80,7 @@ describe "Enums creation styles" do
       end
       enums.map(&:to_s).should == %w[Rojo Verde]
     end
-    
+
     it "should accept extra columns" do
       enums = make_enums do
         red factor: 1.5

data/spec/spec_helper.rb

@@ -1,12 +1,15 @@
-require 'rspec'
 require 'ar-enums'
 
+ActiveRecord::Migration.verbose = false
+
 RSpec.configure do |config|
+  config.expect_with(:rspec) { |c| c.syntax = :should }
+
   config.before :suite do
-    ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+    ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: ":memory:")
     load(File.dirname(__FILE__) + "/schema.rb")
   end
-  
+
   def define_model_class(name = "TestClass", parent_class_name = "ActiveRecord::Base", &block)
   	ActiveSupport::Dependencies.send :remove_const, name rescue nil
   	eval("class #{name} < #{parent_class_name}; end", TOPLEVEL_BINDING)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar-enums
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors:
 - Emmanuel Nicolau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2018-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rb-fsevent
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.4
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +80,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - emmanicolau@gmail.com
@@ -101,15 +87,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".autotest"
 - ".gitignore"
-- ".rbenv-version"
 - ".rspec"
+- ".ruby-version"
 - Gemfile
 - Gemfile.lock
 - Guardfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - ar_enums.gemspec
 - autotest/discover.rb
@@ -147,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ar-enums
-rubygems_version: 2.4.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Provides a simple way for defining enumerations in ActiveRecord models

data/.autotest

@@ -1,2 +0,0 @@
-require 'autotest/growl'
-require 'autotest/fsevent'

data/.rbenv-version

@@ -1 +0,0 @@
-2.1.0

data/README.rdoc

@@ -1,122 +0,0 @@
-= ar-enums
-
-This is a simple solution for defining enumerations in your Rails models.
-
-== Description
-
-It provides two forms of enumerations: 
-* Internal, i.e. defined within the owner of the enum, for the simple cases.
-* External, i.e. defined on it's own class, for the complex ones.
-
-In both cases the enum values are stored in-memory. Let's see some examples of both kinds.
-
-== Internal enumerations
-
-Can be defined in three flavours:
-
-=== Array of values style
-
-This is the simplest and probably the most frecuent case:
-
-  class TrafficLight < ActiveRecord::Base
-    enum :state, %w[red green yellow]
-  end
-
-  tl = TrafficLight.new(:state => :green)
-  tl.state          # => #<TrafficLight::State @name="green", @id=2>
-  tl.state_id       # => 2
-  tl.state.green?   # => true    
-
-As you can see each enum value is an instance of a dinamically generated class (which inherits from ArEnums::Base) and has an ordinal value, id, autogenerated staring on 1.
-
-The enumerations array is accessed with a class method:
-
-  TrafficLight.states  # => [#<TrafficLight::State @name="red", @id=1>, #<TrafficLight::State @name="green", @id=2>, ...]
-  
-By default when <tt>#to_s</tt> is called on a Enum instance it returns the name titleized, but this behaviour can be overrided. See Displaying Enums section below.
-
-=== Array of hashes style
-
-This allows you to define new columns in the Enum value. If the :id is not specified is generated for you.
-
-  class TrafficLight < ActiveRecord::Base
-    enum :state, [
-      { :name => :red, :stop_traffic => true, :rgb => 0xF00 },
-      { :name => :green, :stop_traffic => false, :rgb => 0x0F0 }
-    ]
-  end
-
-  tl = TrafficLight.new(:state => :green)
-  tl.state_id              # => 2    
-  tl.state.stop_traffic    # => false
-  tl.state.rgb             # => 0x0F0
-
-=== Block style
-
-  class TrafficLight < ActiveRecord::Base
-    enum :state do
-      red :stop_traffic => true, :rgb => 0xF00
-      green :stop_traffic => false, :rgb => 0x0F0
-    end
-  end
-
-== External enumerations
-
-When you have shared enumerations or just don't want to clutter the owner model with enums definitions, 
-the enumeration can be on it's own class, as the State enum in the following example:
-
-  class TrafficLight < ActiveRecord::Base
-    enum :state
-  end
-  
-  class State < ArEnums::Base
-    enumeration do
-      red :stop_traffic => true, :rgb => 0xF00, :desc => 'Rojo'
-      green :stop_traffic => false, :rgb => 0x0F0, :desc => 'Verde'
-    end
-  end
-  
-  State[:red]         # => #<State @name="red", @id=1, ...>
-  State[:red].to_s    # => "Rojo"
-  
-Note the block style sintax is exactly the same as in the internal enumerations. In fact any of the 3 styles mencioned above can be used on external enumerations.
-
-Also note the <tt>#to_s</tt> by default return the value of the <tt>:desc</tt> column. Of course you can override the <tt>#to_s</tt> method as usual.
-  
-Then you can access the enumerations collection from both places:
-
-  TrafficLight.states  # => [#<State @name="red", @id=1, ...>, #<State @name="green", @id=2, ...>]
-  States.all           # => [#<State @name="red", @id=1, ...>, #<State @name="green", @id=2, ...>]
-
-The <tt>enum</tt> method accept a <tt>:class_method</tt> option similar to the one in <tt>belongs_to</tt> and others to specify the class of the enum. 
-
-== Displaying Enums
-
-In the array of values style the default is the name titleized but you can pass a <tt>:label</tt> options to override:
-
-  class TrafficLight < ActiveRecord::Base
-    enum :state, %w[red green yellow], :label => :upcase
-  end
-  
-  TrafficLight.states.map(&:to_s)   # => ["RED", "GREEN", "YELLOW"]
-
-If you use the block o array of hashes sintax and add a <tt>:desc</tt> column it will be used as <tt>#to_s</tt>, unless a <tt>:label</tt> option is passed.
-
-== TODO
-
-* Remove the dependency with ActiveRecord so it can be used outside Rails.
-* Allow to store enums in the database.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== Copyright
-
-Copyright (c) 2010 Emmanuel Nicolau. See LICENSE for details.