simple_enum 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d9087e9c59c6e44c222f89f74e64ce59ddafa95
-  data.tar.gz: c0c6198ccfb33ef5073e13d8658ddf56f2f2674d
+  metadata.gz: bc6b8efefb2a56dd5cca3e9f9751a2dc63dbf026
+  data.tar.gz: 973c2ac8568b97a5c384ef150cbd4721a42a606b
 SHA512:
-  metadata.gz: 94d9588a9eaf13c492e0cafaca3b83e36692025c0c3e58cd23178dd0b130e364d959aceb3970292d64e38a48fd77390b12f15d704260819aa5a1c52ff2fb0602
-  data.tar.gz: 00ac3629cd9e0fb9f64691070a5150adf82edafa5be16d05621857e18c1278a469d0c3f4fdf7ffd165bea338e39c9ac6caf17e6ca4f41e132deff48333fdf8e6
+  metadata.gz: 5f618673f56b4777f5c7320eb16276a54ecfcca341925ce21bca89d89f162ba331110b6f4df2669f6407ea448c8af7ab66baa80e6afc64cfdfa24d81009fc5dc
+  data.tar.gz: d5cbba0c10de4983a916282b803e11b6acdf6146fce6f2aa5e7f7f28640eda2cb3a48e18e5f8c0c248c88c5c2213ddc8a792497ee9a56f7d70f295796a407414

data/Gemfile

@@ -1,5 +1,8 @@
 source "http://rubygems.org"
 
+gem 'activesupport', '~> 5.0.0'
+gem 'activerecord', '~> 5.0.0'
+
 gemspec
 
 # some development deps

data/README.md

@@ -2,7 +2,7 @@ SimpleEnum
 ==========
 
 [![Build Status](https://travis-ci.org/lwe/simple_enum.svg)](https://travis-ci.org/lwe/simple_enum)
-[![Code Climate](https://codeclimate.com/github/lwe/simple_enum.png)](https://codeclimate.com/github/lwe/simple_enum)
+[![Code Climate](https://codeclimate.com/github/lwe/simple_enum.svg)](https://codeclimate.com/github/lwe/simple_enum)
 
 Unobtrusive enum-like fields for ActiveRecord and Ruby, brings enums functionality
 to ActiveRecord and Mongoid models (built for Rails 4+).
@@ -50,7 +50,7 @@ to use simple_enum with another version of mongoid, use version 1.6 instead.
 Load mongoid support in the `Gemfile`:
 
 ```ruby
-gem 'simple_enum', '~> 2.0.0' , require: 'simple_enum/mongoid'
+gem 'simple_enum', '~> 2.3.0' , require: 'simple_enum/mongoid'
 ```
 
 Add this to a model:
@@ -98,10 +98,40 @@ Accessing actual enum values is possible at the class level:
 ```ruby
 User.genders                            # => #<SimpleEnum::Enum:0x0....>
 User.genders[:male]                     # => 0
-User.genders.values_at(:male, :female)  # => [0, 1]
+User.genders.values_at(:male, :female)  # => [0, 1] (since 2.1.0)
 User.females                            # => #<ActiveRecord::Relation:0x0.....> (WHERE gender_cd = 1)
 ```
 
+By default, scope names are generated as pluralized forms of the defined enum values e.g.
+
+```ruby
+class Booking < ActiveRecord::Base
+  as_enum :status, active: 1, cancelled: 2, pending: 3
+end
+```
+
+would generate the following:
+```ruby
+Booking.actives     # => #<ActiveRecord::Relation:0x0.....> (WHERE status_cd = 1)
+Booking.cancelleds  # => #<ActiveRecord::Relation:0x0.....> (WHERE status_cd = 2)
+Booking.pendings    # => #<ActiveRecord::Relation:0x0.....> (WHERE status_cd = 3)
+```
+
+By setting `pluralize_scopes: false` will not generate pluralized versions of scopes e.g.
+
+```ruby
+class Booking < ActiveRecord::Base
+  as_enum :status, active: 1, cancelled: 2, pending: 3, pluralize_scopes: false
+end
+```
+
+would generate the following:
+```ruby
+Booking.active     # => #<ActiveRecord::Relation:0x0.....> (WHERE status_cd = 1)
+Booking.cancelled  # => #<ActiveRecord::Relation:0x0.....> (WHERE status_cd = 2)
+Booking.pending    # => #<ActiveRecord::Relation:0x0.....> (WHERE status_cd = 3)
+```
+
 ### Wait, there's more!
 
 - Too tired of always adding the integer values? Try:
@@ -223,9 +253,9 @@ so expect them to change in future versions of SimpleEnum.
   translate_enum user, :gender # => "Frau" # assuming :de and translations exist
   te user, :gender # translate_enum is also aliased to te
   ```
-  
+
   Provide translations in the i18n yaml file like:
-  
+
   ```ruby
     de:
       enums:
@@ -233,13 +263,13 @@ so expect them to change in future versions of SimpleEnum.
           female: 'Frau'
           male: 'Mann'
   ```
-  
+
 - Build a select tag with a translated dropdown and symbol as value:
 
   ```ruby
   select :user, :gender, enum_option_pairs(User, :gender)
   ```
-  
+
 - ...and one with the index as value:
 
   ```ruby
@@ -255,6 +285,8 @@ the following extensions can be used:
   [simple_enum-multiple](https://github.com/bbtfr/simple_enum-multiple)
 - **Persistence values**, i.e. store values in the DB:
   [simple_enum-persistence](https://github.com/bbtfr/simple_enum-persistence)
+- **Scopes**, scopes helper for ActiveRecord enum attributes:
+  [simple_enum-scopes](https://github.com/aovertus/simple_enum-scopes)
 
 ## Best practices
 

data/lib/simple_enum.rb

@@ -33,6 +33,9 @@ module SimpleEnum
   mattr_accessor :field
   @@field = {}
 
+  mattr_accessor :pluralize_scopes
+  @@pluralize_scopes = true
+
   def self.configure
     yield(self)
   end

data/lib/simple_enum/attribute.rb

@@ -17,7 +17,7 @@ module SimpleEnum
     EXTENSIONS = []
 
     def as_enum(name, values, options = {})
-      options.assert_valid_keys(:source, :prefix, :with, :accessor, :map)
+      options.assert_valid_keys(:source, :prefix, :with, :accessor, :map, :pluralize_scopes)
 
       hash     = SimpleEnum::Hasher.map(values, options)
       enum     = SimpleEnum::Enum.new(name, hash)
@@ -25,10 +25,7 @@ module SimpleEnum
 
       generate_enum_class_accessors_for(enum, accessor)
       generate_enum_instance_accessors_for(enum, accessor)
-
-      Array.wrap(options.fetch(:with, SimpleEnum.with)).each do |feature|
-        send "generate_enum_#{feature}_methods_for", enum, accessor
-      end
+      generate_additional_enum_methods_for(enum, accessor, options)
 
       EXTENSIONS.uniq.each do |extension|
         send "generate_enum_#{extension}_extension_for", enum, accessor
@@ -57,6 +54,20 @@ module SimpleEnum
       end
     end
 
+    def generate_additional_enum_methods_for(enum, accessor, options)
+      with_options = Array.wrap(options.fetch(:with, SimpleEnum.with))
+      scope_option = with_options.delete(:scope)
+
+      with_options.each do |feature|
+        send "generate_enum_#{feature}_methods_for", enum, accessor
+      end
+
+      if scope_option
+        pluralize_scopes = options.fetch(:pluralize_scopes, SimpleEnum.pluralize_scopes)
+        generate_enum_scope_methods_for(enum, accessor, pluralize_scopes)
+      end
+    end
+
     def generate_enum_dirty_methods_for(enum, accessor)
       simple_enum_module.module_eval do
         define_method("#{accessor}_changed?") { accessor.changed?(self) }
@@ -73,11 +84,12 @@ module SimpleEnum
       end
     end
 
-    def generate_enum_scope_methods_for(enum, accessor)
+    def generate_enum_scope_methods_for(enum, accessor, pluralize_scopes)
       return unless respond_to?(:scope)
 
       enum.each_pair do |key, value|
-        scope "#{accessor.prefix}#{key.pluralize}", -> { accessor.scope(self, value) }
+        scope_key = pluralize_scopes ? key.pluralize : key
+        scope "#{accessor.prefix}#{scope_key}", -> { accessor.scope(self, value) }
       end
     end
   end

data/lib/simple_enum/version.rb

@@ -1,5 +1,5 @@
 module SimpleEnum
 
   # The current `SimpleEnum` version.
-  VERSION = "2.3.0"
+  VERSION = "2.3.1"
 end

data/spec/simple_enum/attribute_spec.rb

@@ -223,6 +223,38 @@ describe SimpleEnum::Attribute do
         subject { klass.gender_females }
         it_behaves_like 'delegates to accessor#scope', 1
       end
+
+      context 'and pluralize scopes option is set to false' do
+        fake_active_record(:klass) {
+          as_enum :gender, [:male, :female], with: [:scope], prefix: true, pluralize_scopes: false
+        }
+
+        context '.gender_male' do
+          subject { klass.gender_male }
+          it_behaves_like 'delegates to accessor#scope', 0
+        end
+
+        context '.gender_female' do
+          subject { klass.gender_female }
+          it_behaves_like 'delegates to accessor#scope', 1
+        end
+      end
+    end
+
+    context 'when pluralize scopes option is set to false' do
+      fake_active_record(:klass) {
+        as_enum :gender, [:male, :female], with: [:scope], pluralize_scopes: false
+      }
+
+      context '.male' do
+        subject { klass.male }
+        it_behaves_like 'delegates to accessor#scope', 0
+      end
+
+      context '.female' do
+        subject { klass.female }
+        it_behaves_like 'delegates to accessor#scope', 1
+      end
     end
 
     context 'without scope method' do

data/spec/spec_helper.rb

@@ -6,8 +6,8 @@ require 'active_record'
 require 'mongoid'
 
 if ENV['CODECLIMATE_REPO_TOKEN']
-  require "codeclimate-test-reporter"
-  CodeClimate::TestReporter.start
+  require 'simplecov'
+  SimpleCov.start
 end
 
 require 'simple_enum'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_enum
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Lukas Westermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2018-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -138,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Simple enum-like field support for models.