assignable_values 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd2475ca27683328810e810b40276043bf60b442c621be57f29885e58647183a
-  data.tar.gz: f3e17c9e48ce5e73faf2dfe3b3529b8275c603beef2551c6b3d83cac01a3343e
+  metadata.gz: d0359f423877ba1c7d9b303053434f7d80077da0cf314a964b6577f31b97fd01
+  data.tar.gz: e3818b1b35b173d4db2a896092a7cf0ee7f8d93381631cd1cfbbf62f64fc6783
 SHA512:
-  metadata.gz: d2f513338f30247aba1d2b8f436266e3f8865c3c367a0367268131f4f61df7ee80a21e049a4a96b7ce65e90e38068ee759ca6829e23e620635d4595cfa6cc825
-  data.tar.gz: be46b3706a7fc5fece9c43b4ac47164ae9b1cd67a43227707c6182d8ae5755eed601aed0f79d25a5fbfdca88519df64f1323104999265725f0992fb6662417f5
+  metadata.gz: 479c5751e8086031feadcc70a06b878d04020f5fc023b69afd790c2a684f219d56e6d44abfa31387aa342a5c08b4ecfdcea6da085bc9060685ac04750fef3fba
+  data.tar.gz: c38e04dc6003f5f3ab055eeb2b4a9183351c4a7101da42750bd381263e190cdbca0e9638c5e44a88e6510f6aa741eac1612285b1bbfb5347dbb599fdefa95388

data/CHANGELOG.md

@@ -6,11 +6,18 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ### Breaking changes
 
--
+### Compatible changes
+
+
+## 0.15.0 - 2018-10-26
+
+### Breaking changes
+
+- `#humanized_values` is deprecated, in favour of `#humanized_assignablevalues`
 
 ### Compatible changes
 
--
+- `#humanized_value(value)` and `#humanized_assignable_values` now also works for the `multiple: true` case
 
 
 ## 0.14.0 - 2018-09-17

data/README.md

@@ -65,13 +65,13 @@ Or you can retrieve the humanized version of any given value by passing it as an
 
 You can obtain a list of all assignable values with their humanizations:
 
-    song.humanized_genres.size            # => 3
-    song.humanized_genres.first.value     # => "pop"
-    song.humanized_genres.first.humanized # => "Pop music"
+    song.humanized_assignable_genres.size            # => 3
+    song.humanized_assignable_genres.first.value     # => "pop"
+    song.humanized_assignable_genres.first.humanized # => "Pop music"
 
 A good way to populate a `<select>` tag with pairs of internal values and human labels is to use the `collection_select` helper from Rails:
 
-    form.collection_select :genre, form.object.humanized_genres, :value, :humanized
+    form.collection_select :genre, form.object.humanized_assignable_genres, :value, :humanized
 
 
 ### Defining default values
@@ -166,7 +166,7 @@ This is to prevent records from becoming invalid as the list of assignable value
 
 ### Array values
 
-Assignable values can also be used for array values. This works when you use Rails 5+ and PostgreSQL with an array column, or with ActiveRecord's `serialize`.
+Assignable values can also be used for array values. This works when you use Rails 5+ and PostgreSQL with an array column, or on older Rails versions and other databases using ActiveRecord's `serialize`.
 
 To validate array values, pass `multiple: true`:
 
@@ -182,6 +182,13 @@ end
 
 In this case, every *subset* of the given values is valid, for example `['pop', 'electronic']`.
 
+For humanization, you can still use
+
+```
+song.humanizable_genre('pop')                       # => "Pop music"
+song.assignable_humanizable_genres.last.humanized   # => "Electronic music"
+```
+
 
 Restricting belongs_to associations
 -----------------------------------

data/gemfiles/Gemfile.2.3.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    assignable_values (0.14.0)
+    assignable_values (0.15.0)
       activerecord (>= 2.3)
 
 GEM

data/gemfiles/Gemfile.3.2.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    assignable_values (0.14.0)
+    assignable_values (0.15.0)
       activerecord (>= 2.3)
 
 GEM

data/gemfiles/Gemfile.4.2.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    assignable_values (0.14.0)
+    assignable_values (0.15.0)
       activerecord (>= 2.3)
 
 GEM

data/gemfiles/Gemfile.5.0.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    assignable_values (0.14.0)
+    assignable_values (0.15.0)
       activerecord (>= 2.3)
 
 GEM

data/gemfiles/Gemfile.5.1.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    assignable_values (0.14.0)
+    assignable_values (0.15.0)
       activerecord (>= 2.3)
 
 GEM

data/gemfiles/Gemfile.5.1.pg.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    assignable_values (0.14.0)
+    assignable_values (0.15.0)
       activerecord (>= 2.3)
 
 GEM

data/lib/assignable_values.rb

@@ -1,4 +1,5 @@
 require 'active_record'
+require 'active_support/deprecation'
 require 'assignable_values/errors'
 require 'assignable_values/active_record'
 require 'assignable_values/active_record/restriction/base'

data/lib/assignable_values/active_record/restriction/scalar_attribute.rb

@@ -7,7 +7,7 @@ module AssignableValues
           super
           define_humanized_value_instance_method
           define_humanized_value_class_method
-          define_humanized_values_instance_method
+          define_humanized_assignable_values_instance_method
         end
 
         def humanized_value(value)
@@ -17,7 +17,7 @@ module AssignableValues
           end
         end
 
-        def humanized_values(record)
+        def humanized_assignable_values(record)
           values = assignable_values(record)
           values.collect do |value|
             HumanizedValue.new(value, humanized_value(value))
@@ -45,8 +45,12 @@ module AssignableValues
 
         def define_humanized_value_instance_method
           restriction = self
+          multiple = @options[:multiple]
           enhance_model do
-            define_method :"humanized_#{restriction.property}" do |*args|
+            define_method :"humanized_#{restriction.property.to_s.singularize}" do |*args|
+              if args.size > 1 || (multiple && args.size == 0)
+                raise ArgumentError.new("wrong number of arguments (#{args.size} for #{multiple ? '1' : '0..1'})")
+              end
               given_value = args[0]
               value = given_value || send(restriction.property)
               restriction.humanized_value(value)
@@ -54,11 +58,19 @@ module AssignableValues
           end
         end
 
-        def define_humanized_values_instance_method
+        def define_humanized_assignable_values_instance_method
           restriction = self
+          multiple = @options[:multiple]
           enhance_model do
-            define_method :"humanized_#{restriction.property.to_s.pluralize}" do
-              restriction.humanized_values(self)
+            define_method :"humanized_assignable_#{restriction.property.to_s.pluralize}" do
+              restriction.humanized_assignable_values(self)
+            end
+
+            unless multiple
+              define_method :"humanized_#{restriction.property.to_s.pluralize}" do
+                ActiveSupport::Deprecation.warn("humanized_<value>s is deprecated, use humanized_assignable_<value>s instead", caller)
+                restriction.humanized_assignable_values(self)
+              end
             end
           end
         end

data/lib/assignable_values/humanizable_string.rb

@@ -8,7 +8,8 @@ class HumanizableString < String
   end
 
   def humanized
+    ActiveSupport::Deprecation.warn("assignable_<value>.humanized is deprecated, use humanized_assignable_<value>s.humanized instead", caller)
     @humanization
   end
 
-end
+end

data/lib/assignable_values/version.rb

@@ -1,3 +1,3 @@
 module AssignableValues
-  VERSION = '0.14.0'
+  VERSION = '0.15.0'
 end

data/spec/assignable_values/active_record_spec.rb

@@ -20,6 +20,10 @@ describe AssignableValues::ActiveRecord do
           assignable_values_for :sub_genre do
             %w[pop rock]
           end
+
+          assignable_values_for :multi_genres, :allow_blank => true do
+            %w[pop rock]
+          end
         end
       end
 
@@ -35,6 +39,8 @@ describe AssignableValues::ActiveRecord do
       it 'should generate a method returning the humanized value' do
         song = @klass.new(:sub_genre => 'pop')
         song.humanized_sub_genre.should == 'Pop music'
+        song.humanized_sub_genre('rock').should == 'Rock music'
+        song.humanized_multi_genre('rock').should == 'Rock music'
       end
 
     end
@@ -45,21 +51,21 @@ describe AssignableValues::ActiveRecord do
 
         before :each do
           @klass = Song.disposable_copy do
-            assignable_values_for :sub_genres,:multiple => true do
+            assignable_values_for :multi_genres, :multiple => true do
               %w[pop rock]
             end
           end
         end
 
         it 'should validate that the attribute is a subset' do
-          @klass.new(:sub_genres => ['pop']).should be_valid
-          @klass.new(:sub_genres => ['pop', 'rock']).should be_valid
-          @klass.new(:sub_genres => ['pop', 'disallowed value']).should_not be_valid
+          @klass.new(:multi_genres => ['pop']).should be_valid
+          @klass.new(:multi_genres => ['pop', 'rock']).should be_valid
+          @klass.new(:multi_genres => ['pop', 'disallowed value']).should_not be_valid
         end
 
         it 'should not allow nil or [] for allow_blank: false' do
-          @klass.new(:sub_genres => nil).should_not be_valid
-          @klass.new(:sub_genres => []).should_not be_valid
+          @klass.new(:multi_genres => nil).should_not be_valid
+          @klass.new(:multi_genres => []).should_not be_valid
         end
 
       end
@@ -68,15 +74,15 @@ describe AssignableValues::ActiveRecord do
 
         before :each do
           @klass = Song.disposable_copy do
-            assignable_values_for :sub_genres, :multiple => true, :allow_blank => true do
+            assignable_values_for :multi_genres, :multiple => true, :allow_blank => true do
               %w[pop rock]
             end
           end
         end
 
         it 'should allow nil or [] for allow_blank: false' do
-          @klass.new(:sub_genres => nil).should be_valid
-          @klass.new(:sub_genres => []).should be_valid
+          @klass.new(:multi_genres => nil).should be_valid
+          @klass.new(:multi_genres => []).should be_valid
         end
 
       end
@@ -791,11 +797,18 @@ describe AssignableValues::ActiveRecord do
             assignable_values_for :genre do
               %w[pop rock]
             end
+
+            assignable_values_for :multi_genres, :multiple => true do
+              %w[pop rock]
+            end
           end
-          genres = klass.new.humanized_genres
+          genres = klass.new.humanized_assignable_genres
           genres.collect(&:value).should == ['pop', 'rock']
           genres.collect(&:humanized).should == ['Pop music', 'Rock music']
           genres.collect(&:to_s).should == ['Pop music', 'Rock music']
+
+          multi_genres = klass.new.humanized_assignable_multi_genres
+          multi_genres.collect(&:humanized).should == ['Pop music', 'Rock music']
         end
 
         it 'should use String#humanize as a default translation' do
@@ -804,7 +817,7 @@ describe AssignableValues::ActiveRecord do
               %w[electronic]
             end
           end
-          klass.new.humanized_genres.collect(&:humanized).should == ['Electronic']
+          klass.new.humanized_assignable_genres.collect(&:humanized).should == ['Electronic']
         end
 
         it 'should allow to define humanizations for values that are not strings' do
@@ -813,7 +826,7 @@ describe AssignableValues::ActiveRecord do
               [1977, 1980, 1983]
             end
           end
-          years = klass.new.humanized_years
+          years = klass.new.humanized_assignable_years
           years.collect(&:value).should == [1977, 1980, 1983]
           years.collect(&:humanized).should == ['The year a new hope was born', 'The year the Empire stroke back', 'The year the Jedi returned']
         end
@@ -824,18 +837,30 @@ describe AssignableValues::ActiveRecord do
               [1977, 1980, 1983]
             end
           end
-          years = klass.new.humanized_years
+          years = klass.new.humanized_assignable_years
           years.collect(&:humanized).should == ['The year a new hope was born', 'The year the Empire stroke back', 'The year the Jedi returned']
         end
 
         context 'legacy methods for API compatibility' do
 
+          it 'should define a method that return pairs of values and their humanization' do
+            klass = Song.disposable_copy do
+              assignable_values_for :genre do
+                %w[pop rock]
+              end
+            end
+            ActiveSupport::Deprecation.should_receive(:warn)
+            genres = klass.new.humanized_genres
+            genres.collect(&:humanized).should == ['Pop music', 'Rock music']
+          end
+
           it "should define a method #humanized on assignable string values, which return up the value's' translation" do
             klass = Song.disposable_copy do
               assignable_values_for :genre do
                 %w[pop rock]
               end
             end
+            ActiveSupport::Deprecation.should_receive(:warn).at_least(:once)
             klass.new.assignable_genres.collect(&:humanized).should == ['Pop music', 'Rock music']
           end
 

data/spec/support/i18n.yml

@@ -12,6 +12,9 @@ en:
       genre:
         pop: 'Pop music'
         rock: 'Rock music'
+      multi_genres:
+        pop: 'Pop music'
+        rock: 'Rock music'
       sub_genre:
         pop: 'Pop music'
         rock: 'Rock music'

data/spec/support/models.rb

@@ -8,7 +8,7 @@ class Song < ActiveRecord::Base
 
   belongs_to :artist
 
-  attr_accessor :sub_genre, :sub_genres
+  attr_accessor :sub_genre, :sub_genres, :multi_genres
 
   if ActiveRecord::VERSION::MAJOR < 4 || !Song.new(:genres => ['test']).genres.is_a?(Array)
     # Rails 4 or not postgres

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: assignable_values
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-17 00:00:00.000000000 Z
+date: 2018-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -90,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Restrict the values assignable to ActiveRecord attributes or associations