simple_enum 2.0.0.rc2 → 2.0.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f8cd2d424c3387cd12f6c4a4e22873641f8fc1b
-  data.tar.gz: 0d1728690e77c485e5dc1770644248eda9e2ba50
+  metadata.gz: 22d1d0e212642ba9b9a282e1c4911521535f8ac9
+  data.tar.gz: ecad12d55b79a775755f98c4e814e2d2919b3fa5
 SHA512:
-  metadata.gz: 916b55125dbb05aee70240b765486b4410633aca3649552d3bbc53ab3c28bacf574de4b653bb52a4e0160649bcd0b3edbada87ce4fc2c0c237b0d7f7a7ff581d
-  data.tar.gz: 300f0e6a4916004ea5970b2716d46244d40c83c59ebe63851047cdc04b11137abe7e5b936d5a7ae71f6754fb1517c2888abe1260f5ff85de41208211189dcf73
+  metadata.gz: 22eee27ae766df5adcf4e6604a56db93673c56b2b7338c3dd4dc12bf22931a1e57872f25323cab5a5c44483ae61e9ab42912d770ece3c3fbf8a08d66c825df5e
+  data.tar.gz: 4299c17b1f7f1930040cdb7d6f2351de7854a4ca5963708b5302937699507a81f64c86387c636e003905bee0a8ff0bb8a52d5f0b43fbc5689e977399b8ff7d01

data/Gemfile

@@ -2,13 +2,10 @@ source "http://rubygems.org"
 
 gemspec
 
-# Fix at 1.9.x, because 1.10 errors on jruby
-gem 'mongo', '~> 1.9.0', :platform => :jruby
-
 # some development deps
-gem 'activerecord-jdbcsqlite3-adapter', :platform => :jruby
-gem 'sqlite3', :platform => :ruby
-gem 'bson_ext', :platform => :ruby
+gem 'activerecord-jdbcsqlite3-adapter', platform: :jruby
+gem 'sqlite3', platform: :ruby
+gem 'bson_ext', platform: :ruby
 
 # Code coverage on CI only
-gem "codeclimate-test-reporter", group: :test, require: nil
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/README.md

@@ -98,7 +98,7 @@ Accessing actual enum values is possible at the class level:
 ```ruby
 User.genders            # => #<SimpleEnum::Enum:0x0....>
 User.genders[:male]     # => 0
-User.female             # => #<ActiveRecord::Relation:0x0.....> (WHERE gender_cd = 1)
+User.females            # => #<ActiveRecord::Relation:0x0.....> (WHERE gender_cd = 1)
 ```
 
 ### Wait, there's more!
@@ -167,15 +167,15 @@ User.female             # => #<ActiveRecord::Relation:0x0.....> (WHERE gender_cd
   If an invalid value is assigned, the gender is set to `nil` by default.
 - If the shortcut methods (like `female?`, `female!` or `User.male`) conflict with something in your class, it's possible to
   define a prefix:
+  ```ruby
+  class User < ActiveRecord::Base
+    as_enum :gender, %w{male female}, prefix: true
+  end
 
-        class User < ActiveRecord::Base
-          as_enum :gender, %w{male female}, prefix: true
-        end
-
-        jane = User.new gender: :female
-        jane.gender_female? # => true
-        User.gender_female  # => <ActiveRecord::Relation...WHERE gender_cd = 1.>
-
+  jane = User.new gender: :female
+  jane.gender_female? # => true
+  User.gender_females  # => <ActiveRecord::Relation...WHERE gender_cd = 1.>
+  ```
   The `:prefix` option not only takes a boolean value as an argument, but instead can also be supplied a custom
   prefix, so with `prefix: 'foo'` all shortcut methods would look like: `foo_<symbol>`
 - To define which methods are generated it's possible to set `with:` option, by
@@ -225,7 +225,7 @@ as_enum :handle, [:new, :create, :update], :prefix => true
 Searching for certain values by using the finder methods:
 
 ```ruby
-User.female # => returns an ActiveRecord::Relation
+User.females # => returns an ActiveRecord::Relation
 ```
 
 Contributors

data/lib/simple_enum/attribute.rb

@@ -46,6 +46,7 @@ module SimpleEnum
       simple_enum_module.module_eval do
         define_method("#{accessor}")  { accessor.read(self) }
         define_method("#{accessor}=") { |value| accessor.write(self, value) }
+        define_method("#{accessor}?") { |value = nil| accessor.selected?(self, value) }
       end
     end
 
@@ -58,7 +59,6 @@ module SimpleEnum
 
     def generate_enum_attribute_methods_for(enum, accessor)
       simple_enum_module.module_eval do
-        define_method("#{accessor}?") { |value = nil| accessor.selected?(self, value) }
         enum.each_pair do |key, value|
           define_method("#{accessor.prefix}#{key}?") { accessor.selected?(self, key) }
           define_method("#{accessor.prefix}#{key}!") { accessor.write(self, key) }
@@ -70,7 +70,7 @@ module SimpleEnum
       return unless respond_to?(:scope)
 
       enum.each_pair do |key, value|
-        scope "#{accessor.prefix}#{key}", -> { where(accessor.source => value) }
+        scope "#{accessor.prefix}#{key.pluralize}", -> { where(accessor.source => value) }
       end
     end
   end

data/lib/simple_enum/enum.rb

@@ -30,6 +30,10 @@ module SimpleEnum
     end
     alias_method :each, :each_pair
 
+    def map(&block)
+      hash.map(&block)
+    end
+
     def keys
       hash.keys
     end

data/lib/simple_enum/mongoid.rb

@@ -15,12 +15,12 @@ module SimpleEnum
   #
   # When no field is requested:
   #
-  #   field :gender_cd, :type => Integer
-  #   as_enum :gender, [:female, :male], :field => false
+  #   field :gender_cd, type: Integer
+  #   as_enum :gender, [:female, :male], field: false
   #
   # or custom field options (like e.g. type want to be passed):
   #
-  #   as_enum :gender, [:female, :male], :field => { :type => Integer }
+  #   as_enum :gender, [:female, :male], field: { type: Integer }
   #
   module Mongoid
     def self.included(base)

data/lib/simple_enum/railtie.rb

@@ -0,0 +1,17 @@
+require 'simple_enum'
+
+module SimpleEnum
+  class Railtie < Rails::Railtie
+
+    initializer 'simple_enum.extend_active_record' do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send :extend, SimpleEnum::Attribute
+        ActiveRecord::Base.send :extend, SimpleEnum::Translation
+      end
+    end
+
+    initializer 'simple_enum.view_helpers' do
+      ActionView::Base.send :include, SimpleEnum::ViewHelpers
+    end
+  end
+end

data/lib/simple_enum/translation.rb

@@ -1,3 +1,5 @@
+require 'i18n'
+
 module SimpleEnum
   module Translation
     def human_enum_name(enum, key, options = {})
@@ -10,7 +12,7 @@ module SimpleEnum
       defaults << options.delete(:default) if options[:default]
       defaults << key.to_s.humanize
 
-      options.reverse_merge! :count => 1, :default => defaults
+      options.reverse_merge! count: 1, default: defaults
       I18n.translate(defaults.shift, options)
     end
   end

data/lib/simple_enum/version.rb

@@ -1,5 +1,5 @@
 module SimpleEnum
 
   # The current `SimpleEnum` version.
-  VERSION = "2.0.0.rc2"
+  VERSION = "2.0.0.rc3"
 end

data/lib/simple_enum/view_helpers.rb

@@ -0,0 +1,39 @@
+require 'i18n'
+
+module SimpleEnum
+  module ViewHelpers
+
+    # A helper to build forms with Rails' form builder, built to be used with
+    # f.select helper.
+    #
+    #    f.select :gender, enum_option_pairs(User, :gender), ...
+    #
+    # record - The model or Class with the enum
+    # enum - The Symbol with the name of the enum to create the options for
+    # encode_as_value - The Boolean which defines if either the key or the value
+    #                   should be used as value attribute for the option,
+    #                   defaults to using the key (i.e. false)
+    #
+    # FIXME: check if the name `enum_option_pairs` is actually good and clear
+    # enough...
+    #
+    # Returns an Array of pairs, like e.g. `[["Translated key", "key"], ...]`
+    def enum_option_pairs(record, enum, encode_as_value = false)
+      reader = enum.to_s.pluralize
+      record = record.class unless record.respond_to?(reader)
+
+      record.send(reader).map { |key, value|
+        name = record.human_enum_name(enum, key) if record.respond_to?(:human_enum_name)
+        name ||= translate_enum_key(enum, key)
+        [name, encode_as_value ? value : key]
+      }
+    end
+
+    private
+
+    def translate_enum_key(enum, key)
+      defaults = [:"enums.#{enum}.#{key}", key.to_s.humanize]
+      I18n.translate defaults.shift, default: defaults, count: 1
+    end
+  end
+end

data/lib/simple_enum.rb

@@ -13,6 +13,7 @@ require 'active_support'
 require 'simple_enum/version'
 require 'simple_enum/attribute'
 require 'simple_enum/translation'
+require 'simple_enum/view_helpers'
 
 # Base module which gets included in <tt>ActiveRecord::Base</tt>. See documentation
 # of +SimpleEnum::ClassMethods+ for more details.
@@ -37,8 +38,5 @@ module SimpleEnum
   end
 end
 
-# include in AR
-ActiveSupport.on_load(:active_record) do
-  ActiveRecord::Base.send(:extend, SimpleEnum::Attribute)
-  ActiveRecord::Base.send(:extend, SimpleEnum::Translation)
-end
+# Load rails support
+require 'simple_enum/railtie' if defined?(Rails)

data/spec/simple_enum/attribute_spec.rb

@@ -44,6 +44,13 @@ describe SimpleEnum::Attribute do
         subject.gender = :male
       end
     end
+
+    context '#gender?' do
+      it 'delegates to accessor' do
+        expect(accessor).to receive(:selected?).with(subject, nil) { nil }
+        expect(subject.gender?).to be_false
+      end
+    end
   end
 
   context 'generate_enum_dirty_methods_for' do
@@ -76,10 +83,6 @@ describe SimpleEnum::Attribute do
   context 'generate_enum_attribute_methods_for' do
     subject { klass.new }
 
-    it 'does not respond to #gender?' do
-      expect(subject).to_not respond_to(:gender?)
-    end
-
     it 'does not respond to #male? or #female?' do
       expect(subject).to_not respond_to(:male?)
       expect(subject).to_not respond_to(:female?)
@@ -167,13 +170,13 @@ describe SimpleEnum::Attribute do
       end
     end
 
-    context '.male' do
-      subject { klass.male }
+    context '.males' do
+      subject { klass.males }
       it_behaves_like 'returning a relation', 0
     end
 
-    context '.female' do
-      subject { klass.female }
+    context '.females' do
+      subject { klass.females }
       it_behaves_like 'returning a relation', 1
     end
 
@@ -182,13 +185,13 @@ describe SimpleEnum::Attribute do
         as_enum :gender, [:male, :female], with: [:scope], prefix: true
       }
 
-      context '.gender_male' do
-        subject { klass.gender_male }
+      context '.gender_males' do
+        subject { klass.gender_males }
         it_behaves_like 'returning a relation', 0
       end
 
-      context '.gender_female' do
-        subject { klass.gender_female }
+      context '.gender_females' do
+        subject { klass.gender_females }
         it_behaves_like 'returning a relation', 1
       end
     end
@@ -199,9 +202,9 @@ describe SimpleEnum::Attribute do
       }
       subject { klass_without_scope_method }
 
-      it 'does not add .male nor .female' do
-        expect(subject).to_not respond_to(:male)
-        expect(subject).to_not respond_to(:female)
+      it 'does not add .males nor .females' do
+        expect(subject).to_not respond_to(:males)
+        expect(subject).to_not respond_to(:females)
       end
     end
   end

data/spec/simple_enum/view_helpers_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe SimpleEnum::ViewHelpers, i18n: true do
+  let(:helper) {
+    Class.new do
+      include SimpleEnum::ViewHelpers
+    end.new
+  }
+
+  fake_model(:klass) do
+    as_enum :gender, %w{male female}
+  end
+
+  context '#enum_option_pairs' do
+    subject { helper.enum_option_pairs(klass, :gender) }
+
+    it 'returns an Array of Arrays when a model instance is passed in' do
+      expect(helper.enum_option_pairs(klass.new, :gender)).to eq [
+        ["Male", "male"], ["Female", "female"]
+      ]
+    end
+
+    it 'returns an Array of Array when the class is passed in' do
+      expect(subject).to eq [
+        ["Male", "male"], ["Female", "female"]
+      ]
+    end
+
+    it 'returns the value instead of the key when last argument is set to true' do
+      expect(helper.enum_option_pairs(klass, :gender, true)).to eq [
+        ["Male", 0], ["Female", 1]
+      ]
+    end
+
+    context 'with translation in enums.{...}' do
+      before {
+        store_translations :en, 'enums' => {
+          'gender' => { 'male' => 'Mr.', 'female' => 'Mrs.' }
+        }
+      }
+
+      it 'returns the translation as defined in the translations' do
+        expect(subject).to eq [
+          ["Mr.", "male"], ["Mrs.", "female"]
+        ]
+      end
+    end
+
+    context 'with .human_enum_name' do
+      before {
+        expect(klass).to receive(:human_enum_name).with(:gender, "male") { "Mr." }
+        expect(klass).to receive(:human_enum_name).with(:gender, "female") { "Mrs." }
+      }
+
+      it 'returns the translation as given #human_enum_name' do
+        expect(subject).to eq [
+          ["Mr.", "male"], ["Mrs.", "female"]
+        ]
+      end
+    end
+  end
+end

data/spec/support/active_record_support.rb

@@ -21,3 +21,7 @@ module ActiveRecordSupport
     end
   end
 end
+
+# Behave like the railtie.rb
+ActiveRecord::Base.send :extend, SimpleEnum::Attribute
+ActiveRecord::Base.send :extend, SimpleEnum::Translation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_enum
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc2
+  version: 2.0.0.rc3
 platform: ruby
 authors:
 - Lukas Westermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-08 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -101,8 +101,10 @@ files:
 - lib/simple_enum/enum.rb
 - lib/simple_enum/hasher.rb
 - lib/simple_enum/mongoid.rb
+- lib/simple_enum/railtie.rb
 - lib/simple_enum/translation.rb
 - lib/simple_enum/version.rb
+- lib/simple_enum/view_helpers.rb
 - simple_enum.gemspec
 - spec/simple_enum/accessors_spec.rb
 - spec/simple_enum/attribute_spec.rb
@@ -110,6 +112,7 @@ files:
 - spec/simple_enum/hasher_spec.rb
 - spec/simple_enum/mongoid_spec.rb
 - spec/simple_enum/translation_spec.rb
+- spec/simple_enum/view_helpers_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record_support.rb
 - spec/support/i18n_support.rb
@@ -146,6 +149,7 @@ test_files:
 - spec/simple_enum/hasher_spec.rb
 - spec/simple_enum/mongoid_spec.rb
 - spec/simple_enum/translation_spec.rb
+- spec/simple_enum/view_helpers_spec.rb
 - spec/spec_helper.rb
 - spec/support/active_record_support.rb
 - spec/support/i18n_support.rb