enumify 0.0.7 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afa463a12776e37c4f2051d7fe8b9a4d7e47aa91
-  data.tar.gz: be3ae8cae94d3b0ec6cf3a4d14e6253d5a1e8f10
+  metadata.gz: e186a8d9675c9e5b1959d6bda11d3883329a8b96
+  data.tar.gz: 122e5bdcb684221bb5c2d585fa7e79af75506e0e
 SHA512:
-  metadata.gz: 282293fed0da633d2f434c84eb3390e3bcb5a5f9bb07a4dc8e09dc4a9c60dfa65ef8191e4cf8045da4ad1a75b7dcef0fad2dd5da6caf4b9334130708b7ccb841
-  data.tar.gz: cd1e855fba1d4e1a51ce67394c519cb1f2e57464224807b02d17d608007a205658e5c6ac7266a55cfea9cf341bda413790940bdc364ff488fa769223a1c9b36c
+  metadata.gz: 9a728aa7bed29637d532075d31611d9224cb55c27fc467594eb4d4a15c632146401b1ea48d647198223c205e0ee5af729bb1a1bc124b6a24ef4f353bc0b2cde3
+  data.tar.gz: 674ca49a2f592cd96dcb5abe9d2d6a8129ae025d21d5ceeb66a108b3473722272792e61bbd40fceec74e4aec2d9c82ca0b8eb0af654be958ee3db76c9c455952

data/Gemfile

@@ -5,5 +5,11 @@ gem 'rubinius-developer_tools', :platforms => :rbx
 gem 'sqlite3', '1.3.8', :platforms => [:ruby, :rbx]
 gem 'activerecord-jdbcsqlite3-adapter', :platforms => :jruby
 
+group :development do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'terminal-notifier-guard'
+end
+
 # Specify your gem's dependencies in enumify.gemspec
 gemspec

data/Guardfile

@@ -0,0 +1,20 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_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('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end

data/Readme.md

@@ -12,7 +12,7 @@ gem 'enumify'
 
 ## How to use
 
-Just call the enum function in any ActiveRecord object, the function accepts the field name as the first variable and the possible values as an array
+Just call the `enum` function in any ActiveRecord object, the function accepts the field name as the first variable and the possible values as an array
 
 ```ruby
 class Event < ActiveRecord::Base
@@ -20,6 +20,19 @@ class Event < ActiveRecord::Base
 end
 ```
 
+## Rails 4.1+
+
+You can also instantiate a _Enumify_ enum by calling the `enumify` method instead of `enum`.  
+This is especially helpful when your app is running Rail 4.1 or better which has it's own built in enum (although not as good)
+
+```ruby
+class Event < ActiveRecord::Base
+    enumify :status, [:available, :canceled, :completed]
+end
+```
+  
+## Usage
+
 After that you get several autogenerated commands to use with the enum
 
 ```ruby
@@ -51,6 +64,20 @@ end
 Event.create! # Is valid and does not throw an exception.
 ```
 
+#### :prefix
+By default all enum values are available as scopes, bang and query methods based on the value. 
+You can add a prefix for the enum values in order to differentiate different enums on the same object. 
+
+```ruby
+class Event < ActiveRecord::Base
+    enum :status, [:available, :canceled, :completed], :prefix => true
+    enum :subtype, [:company, :personal], :prefix => 'type'
+end
+
+event.available?            # Not available anymore
+event.status_available?     # when prefix true
+event.type_company?         # you can set a specific name for your prefix
+```
 
 
 ## Callbacks

data/gemfiles/rails30.gemfile

@@ -2,10 +2,10 @@
 
 source "http://rubygems.org"
 
-gem "rubysl", "~> 2.0", :platforms=>:rbx
-gem "rubinius-developer_tools", :platforms=>:rbx
-gem "sqlite3", "1.3.8", :platforms=>[:ruby, :rbx]
-gem "activerecord-jdbcsqlite3-adapter", :platforms=>:jruby
+gem "rubysl", "~> 2.0", :platforms => :rbx
+gem "rubinius-developer_tools", :platforms => :rbx
+gem "sqlite3", "1.3.8", :platforms => [:ruby, :rbx]
+gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
 gem "activerecord", "~> 3.0.11"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/gemfiles/rails31.gemfile

@@ -2,10 +2,10 @@
 
 source "http://rubygems.org"
 
-gem "rubysl", "~> 2.0", :platforms=>:rbx
-gem "rubinius-developer_tools", :platforms=>:rbx
-gem "sqlite3", "1.3.8", :platforms=>[:ruby, :rbx]
-gem "activerecord-jdbcsqlite3-adapter", :platforms=>:jruby
+gem "rubysl", "~> 2.0", :platforms => :rbx
+gem "rubinius-developer_tools", :platforms => :rbx
+gem "sqlite3", "1.3.8", :platforms => [:ruby, :rbx]
+gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
 gem "activerecord", "~> 3.1.12"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/gemfiles/rails32.gemfile

@@ -2,10 +2,10 @@
 
 source "http://rubygems.org"
 
-gem "rubysl", "~> 2.0", :platforms=>:rbx
-gem "rubinius-developer_tools", :platforms=>:rbx
-gem "sqlite3", "1.3.8", :platforms=>[:ruby, :rbx]
-gem "activerecord-jdbcsqlite3-adapter", :platforms=>:jruby
+gem "rubysl", "~> 2.0", :platforms => :rbx
+gem "rubinius-developer_tools", :platforms => :rbx
+gem "sqlite3", "1.3.8", :platforms => [:ruby, :rbx]
+gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
 gem "activerecord", "~> 3.2.14"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/gemfiles/rails40.gemfile

@@ -2,10 +2,10 @@
 
 source "http://rubygems.org"
 
-gem "rubysl", "~> 2.0", :platforms=>:rbx
-gem "rubinius-developer_tools", :platforms=>:rbx
-gem "sqlite3", "1.3.8", :platforms=>[:ruby, :rbx]
-gem "activerecord-jdbcsqlite3-adapter", :platforms=>:jruby
+gem "rubysl", "~> 2.0", :platforms => :rbx
+gem "rubinius-developer_tools", :platforms => :rbx
+gem "sqlite3", "1.3.8", :platforms => [:ruby, :rbx]
+gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
 gem "activerecord", "~> 4.0.0"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/gemfiles/rails41.gemfile

@@ -2,10 +2,10 @@
 
 source "http://rubygems.org"
 
-gem "rubysl", "~> 2.0", :platforms=>:rbx
-gem "rubinius-developer_tools", :platforms=>:rbx
-gem "sqlite3", "1.3.8", :platforms=>[:ruby, :rbx]
-gem "activerecord-jdbcsqlite3-adapter", :platforms=>:jruby
+gem "rubysl", "~> 2.0", :platforms => :rbx
+gem "rubinius-developer_tools", :platforms => :rbx
+gem "sqlite3", "1.3.8", :platforms => [:ruby, :rbx]
+gem "activerecord-jdbcsqlite3-adapter", :platforms => :jruby
 gem "activerecord", "~> 4.1.0"
 
-gemspec :path=>"../"
+gemspec :path => "../"

data/lib/enumify/model.rb

@@ -1,62 +1,82 @@
 module Enumify
   module Model
-    def enum(parameter, vals=[], opts={})
 
-      validates_inclusion_of parameter, :in => vals, :allow_nil => !!opts[:allow_nil]
-
-      const_set("#{parameter.to_s.pluralize.upcase}", vals)
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
 
-      define_method "#{parameter.to_s}" do
-        attr = read_attribute(parameter)
-        (attr.nil? || attr.empty?) ? nil : attr.to_sym
-      end
+    module ClassMethods
+      def enumify(parameter, vals=[], opts={})
 
-      define_method "#{parameter.to_s}=" do |value|
-        send("_set_#{parameter.to_s}", value, false)
-      end
+        validates_inclusion_of parameter, :in => vals, :allow_nil => !!opts[:allow_nil]
+        paramater_string = parameter.to_s
 
-      self.class_eval do
+        prefix = ''
+        if opts[:prefix] == true
+          prefix = "#{paramater_string}_"
+        elsif opts[:prefix].present?
+          prefix = "#{opts[:prefix].to_s}_"
+        end
 
-        private
+        const_set("#{paramater_string.pluralize.upcase}", vals)
 
-        define_method "_set_#{parameter.to_s}" do |value, should_save|
+        define_method "#{paramater_string}" do
+          attr = read_attribute(parameter)
+          (attr.nil? || attr.empty?) ? nil : attr.to_sym
+        end
 
-          value = value and value.to_sym
-          old = read_attribute(parameter) ? read_attribute(parameter).to_sym : nil
-          return value if old == value
-          write_attribute(parameter, (value and value.to_s))
-          save if should_save
-          send("#{parameter.to_s}_changed", old, value) if respond_to?("#{parameter.to_s}_changed", true) and !old.nil?
-          return value
+        define_method "#{paramater_string}=" do |value|
+          send("_set_#{paramater_string}", value, false)
         end
 
-      end
+        self.class_eval do
 
-      vals.each do |val|
-        raise "Collision in enum values method #{val}" if respond_to?("#{val.to_s}?") or respond_to?("#{val.to_s}!") or respond_to?("#{val.to_s}")
+          private
 
-        define_method "#{val.to_s}?" do
-          send("#{parameter.to_s}") == val
-        end
+          define_method "_set_#{paramater_string}" do |value, should_save|
+
+            value = value and value.to_sym
+            old = read_attribute(parameter) ? read_attribute(parameter).to_sym : nil
+            return value if old == value
+            write_attribute(parameter, (value and value.to_s))
+            save if should_save
+            send("#{paramater_string}_changed", old, value) if respond_to?("#{paramater_string}_changed", true) and !old.nil?
+            return value
+          end
 
-        define_method "#{val.to_s}!" do
-          send("_set_#{parameter.to_s}", val, true)
         end
 
-        scope val.to_sym, lambda { where(parameter.to_sym => val.to_s) }
-      end
+        vals.each do |val|
+          attribute = prefix + val.to_s
+          query_method = "#{attribute}?"
+          bang_method = "#{attribute}!"
+
+          raise "Collision in enum values method #{attribute}" if respond_to?(query_method) or respond_to?(bang_method) or respond_to?(attribute)
+
+          define_method query_method do
+            send("#{paramater_string}") == val
+          end
 
-      # We want to first define all the "positive" scopes and only then define
-      # the "negation scopes", to make sure they don't override previous scopes
-      vals.each do |val|
-        # We need to prefix the field with the table name since if this scope will
-        # be used in a joined query with other models that have the same enum field then
-        # it will fail on ambiguous column name.
-        unless respond_to?("not_#{val}")
-          scope "not_#{val}", lambda { where("#{self.table_name}.#{parameter} != ?", val.to_s) }
+          define_method bang_method do
+            send("_set_#{paramater_string}", val, true)
+          end
+
+          scope attribute.to_sym, lambda { where(parameter.to_sym => val.to_s) }
         end
-      end
 
+        # We want to first define all the "positive" scopes and only then define
+        # the "negation scopes", to make sure they don't override previous scopes
+        vals.each do |val|
+          # We need to prefix the field with the table name since if this scope will
+          # be used in a joined query with other models that have the same enum field then
+          # it will fail on ambiguous column name.
+          negative_scope = "not_" + prefix + val.to_s
+          unless respond_to?(negative_scope)
+            scope negative_scope, lambda { where("#{self.table_name}.#{parameter} != ?", val.to_s) }
+          end
+        end
+      end
+      alias_method :enum, :enumify
     end
 
   end

data/lib/enumify/railtie.rb

@@ -1,8 +1,8 @@
-module UrlFormatter
+module Enumify
   class Railtie < Rails::Railtie
     initializer 'enumify.model' do
       ActiveSupport.on_load :active_record do
-        extend Enumify::Model
+        include Enumify::Model
       end
     end
   end

data/lib/enumify/version.rb

@@ -1,3 +1,3 @@
 module Enumify
-  VERSION = '0.0.7'
+  VERSION = '0.1.0'
 end

data/spec/enumify/enum_spec.rb

@@ -1,13 +1,13 @@
 require 'spec_helper'
 
 class Model < ActiveRecord::Base
-  extend Enumify::Model
+  include Enumify::Model
 
   enum :status, [:available, :canceled, :completed]
 end
 
 class OtherModel < ActiveRecord::Base
-  extend Enumify::Model
+  include Enumify::Model
 
   belongs_to :model
 
@@ -15,13 +15,9 @@ class OtherModel < ActiveRecord::Base
 end
 
 class ModelAllowingNil < ActiveRecord::Base
+  include Enumify::Model
   self.table_name = 'models'
-
-  extend Enumify::Model
-
-  belongs_to :model
-
-  enum :status, [:active, :expired, :not_expired], :allow_nil => true
+  enum :status, [:available, :canceled, :completed], :allow_nil => true
 end
 
 
@@ -50,7 +46,7 @@ describe :Enumify do
     describe "model allowing enum value to be nil" do
       subject { @obj_allowing_nil }
       it "should be valid" do
-        subject.should be_valid
+        expect(subject).to be_valid
       end
 
       it 'should not raise error when setting value to nil' do
@@ -58,21 +54,21 @@ describe :Enumify do
           subject.status = nil
         }.to_not raise_error
 
-        subject.status.should be_nil
+        expect(subject.status).to be_nil
       end
     end
 
     describe "model not allowing enum value to be nil" do
       subject { @obj_not_allowing_nil }
       it "should be invalid" do
-        subject.should be_invalid
+        expect(subject).to be_invalid
       end
 
       it 'should not raise error when setting value to nil' do
         expect {
           subject.status = nil
         }.to_not raise_error
-        subject.should be_invalid
+        expect(subject).to be_invalid
       end
     end
 
@@ -81,11 +77,11 @@ describe :Enumify do
   describe "short hand methods" do
     describe "question mark (?)" do
       it "should return true if value of enum equals a value" do
-        @obj.available?.should be_true
+        expect(@obj.available?).to be_truthy
       end
 
       it "should return false if value of enum is different " do
-        @obj.canceled?.should be_false
+        expect(@obj.canceled?).to be_falsey
       end
 
     end
@@ -93,13 +89,13 @@ describe :Enumify do
     describe "exclemation mark (!)" do
       it "should change the value of the enum to the methods value" do
         @obj.canceled!
-        @obj.status.should == :canceled
+        expect(@obj).to be_canceled
       end
 
       context 'trying to set the value to the same value' do
         before { @obj.available! }
         it 'should not save the object again' do
-          @obj.should_not_receive(:save)
+          expect(@obj).to_not receive(:save)
           @obj.available!
         end
       end
@@ -108,17 +104,19 @@ describe :Enumify do
 
     it "should have two shorthand methods for each possible value" do
       Model::STATUSES.each do |val|
-        @obj.respond_to?("#{val}?").should be_true
-        @obj.respond_to?("#{val}!").should be_true
+        expect(@obj.respond_to?("#{val}?")).to be_truthy
+        expect(@obj.respond_to?("#{val}!")).to be_truthy
       end
     end
   end
 
   describe "getting value" do
     it "should always return the enums value as a symbol" do
-      @obj.status.should == :available
-      @obj.status = "canceled"
-      @obj.status.should == :canceled
+      expect {
+        @obj.status = "canceled"
+      }.to change{
+        @obj.status
+      }.from(:available).to(:canceled)
     end
 
   end
@@ -126,43 +124,43 @@ describe :Enumify do
   describe "setting value" do
     it "should except values as symbol" do
       @obj.status = :canceled
-      @obj.canceled?.should be_true
+      expect(@obj).to be_canceled
     end
 
     it "should except values as string" do
       @obj.status = "canceled"
-      @obj.canceled?.should be_true
+      expect(@obj).to be_canceled
     end
   end
 
   describe "validations" do
+    let (:obj) { Model.new(:status => :available) }
+
     it "should not except a value outside the given list" do
-      @obj = Model.new(:status => :available)
-      @obj.status = :foobar
-      @obj.should_not be_valid
+      obj.status = :foobar
+      expect(obj).to_not be_valid
     end
 
     it "should except value in the list" do
-      @obj = Model.new(:status => :available)
-      @obj.status = :canceled
-      @obj.should be_valid
+      obj.status = :canceled
+      expect(obj).to be_valid
     end
   end
 
   describe "callbacks" do
     it "should receive a callback on change of value" do
-      @obj.should_receive(:status_changed).with(:available,:canceled)
+      expect(@obj).to receive(:status_changed).with(:available,:canceled)
       @obj.canceled!
     end
 
     it "should not receive a callback on initial value" do
       @obj = Model.new
-      @obj.should_not_receive(:status_changed).with(nil, :canceled)
+      expect(@obj).to_not receive(:status_changed)
       @obj.canceled!
       end
 
     it "should not receive a callback on value change to same" do
-      @obj.should_not_receive(:status_changed).with(:available, :available)
+      expect(@obj).to_not receive(:status_changed)
       @obj.available!
     end
 
@@ -170,38 +168,110 @@ describe :Enumify do
 
   describe "scopes" do
     it "should return objects with given value" do
-      Model.available.should == [@obj]
-      Model.canceled.should == [@canceled_obj]
+      expect(Model.available).to eq [@obj]
+      expect(Model.canceled).to eq [@canceled_obj]
     end
 
     it "should return objects with given value when joined with models who have the same enum field" do
-      OtherModel.joins(:model).active.should == [@active_obj]
+      expect(OtherModel.joins(:model).active).to eq [@active_obj]
     end
 
     describe "negation scopes" do
 
       it "should return objects that do not have the given value" do
-        Model.not_available.should include(@canceled_obj, @completed_obj)
+        expect(Model.not_available).to include(@canceled_obj, @completed_obj)
       end
 
       it "should return objects that do not have the given value when joined with models who have the same enum field" do
-        OtherModel.joins(:model).not_active.should include(@expired_obj, @not_expired_obj)
+        expect(OtherModel.joins(:model).not_active).to include(@expired_obj, @not_expired_obj)
       end
 
       it "should not override positive scopes" do
         # We want here to verify that the not_expired scope return only the models with
         # status == "not_expired" and not all the models with status != "expired",
         # since negation scopes should not override the "positive" scopes.
-        OtherModel.not_expired.should == [@not_expired_obj]
+        expect(OtherModel.not_expired).to eq [@not_expired_obj]
       end
 
     end
 
   end
 
-
   it "class should have a CONST that holds all the available options of the enum" do
-    Model::STATUSES.should == [:available, :canceled, :completed]
+    expect(Model::STATUSES).to eq [:available, :canceled, :completed]
+  end
+
+  describe 'prefix' do
+
+
+    context 'when prefix set to string' do
+
+      class ModelWithPrefix < ActiveRecord::Base
+        include Enumify::Model
+        self.table_name = 'models'
+        enum :status, [:available, :canceled, :completed], :prefix => 'foo'
+      end
+
+      subject { ModelWithPrefix.new(:status => :available) }
+      it 'does not allow access through unprefixed enum' do
+        expect(subject).to_not respond_to(:available?)
+      end
+
+      it 'allows access to the attributes when prefixed by that string' do
+        expect(subject).to respond_to(:foo_available?)
+      end
+
+      it 'has a scope available with the prefix' do
+        expect(ModelWithPrefix).to respond_to(:foo_available)
+      end
+
+      it 'has no scope for unprefixed methods' do
+        expect(ModelWithPrefix).to_not respond_to(:available)
+      end
+
+      it 'has a negative scope available with the prefix' do
+        expect(ModelWithPrefix).to respond_to(:not_foo_available)
+      end
+
+      it 'has no negative scope for unprefixed methods' do
+        expect(ModelWithPrefix).to_not respond_to(:not_available)
+      end
+    end
+
+    context 'when prefix set to true' do
+
+      class ModelWithPrefixTrue < ActiveRecord::Base
+        include Enumify::Model
+        self.table_name = 'models'
+        enum :status, [:available, :canceled, :completed], :prefix => true
+      end
+
+      subject { ModelWithPrefixTrue.new(:status => :available) }
+      it 'does not allow access through unprefixed enum' do
+        expect(subject).to_not respond_to(:available?)
+      end
+
+      it 'allows access to the attributes when prefixed by that string' do
+        expect(subject).to respond_to(:status_available?)
+      end
+
+      it 'has a scope available with the prefix' do
+        expect(ModelWithPrefixTrue).to respond_to(:status_available)
+      end
+
+      it 'has no scope for unprefixed methods' do
+        expect(ModelWithPrefixTrue).to_not respond_to(:available)
+      end
+
+      it 'has a negative scope available with the prefix' do
+        expect(ModelWithPrefixTrue).to respond_to(:not_status_available)
+      end
+
+      it 'has no negative scope for unprefixed methods' do
+        expect(ModelWithPrefixTrue).to_not respond_to(:not_available)
+      end
+    end
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enumify
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.1.0
 platform: ruby
 authors:
 - yon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-09 00:00:00.000000000 Z
+date: 2014-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -86,6 +86,7 @@ files:
 - Appraisals
 - CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE
 - Rakefile
 - Readme.md
@@ -121,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: enumify
-rubygems_version: 2.0.3
+rubygems_version: 2.4.0
 signing_key: 
 specification_version: 4
 summary: enumify adds an enum command to all ActiveRecord models which enables you