nxt_support 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 291cef0c8832ad19e20d28d8b74f49aa9f5a3b5fa7de6790f2e63ed8eb509639
-  data.tar.gz: f5079328af526df44ce25c107cf078a3536ce797962e11d309f8df8707c9b786
+  metadata.gz: 187a9226c75ccd071bd9c32bf599f3d0b8badf1888fc4d09dd656d815b0af2ff
+  data.tar.gz: fa7e12a3f24c9bc3a0fe2e3bc455b4b09e3ee3fd2fa90371886e49d3eda2f5c3
 SHA512:
-  metadata.gz: 8790a32d160b0735eb142cbd08afb37c0a56fe9cbf9481fd1d019c677e0218a039f9e944cb2c80389e922cb961b2cc52e16578eb73fe6cc1af10769713b797ba
-  data.tar.gz: e73f904229c0752092ee9991ad74d5bf4dbda6f774a8207467ec79cf66e51a37fd51700ad26c77d2936ff3d18dc8ca8a83e111ac3cb976ac10b089288a1c5391
+  metadata.gz: 9c9ced17e3a32dd6a91e3863e589d645b0ac6f0b370ce6ba94c8abc7ae645c5f5e3c1d81ef4c15c919afcb8f9c2a931701de67a8304985346c5fc1370e6dad05
+  data.tar.gz: c62f77b8707d77af40ea9e32c8151c7b8aae07975ac2032b9b73d31b6664c61d9eac7d8159f0842d7bdc202e9fb67504a785b4ef95366020c9fbffc3a721074f

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.1.5 2020-06-17
+
+- Added `NxtSupport::AssignableValues`
+
 # v0.1.3 2020-02-19
 
 - Added `NxtSupport::IndifferentlyAccessibleJsonAttrs`

data/Gemfile.lock

@@ -1,63 +1,63 @@
 PATH
   remote: .
   specs:
-    nxt_support (0.1.4)
+    nxt_support (0.1.5)
       nxt_init
       rails
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (6.0.3.1)
-      actionpack (= 6.0.3.1)
+    actioncable (6.0.3.2)
+      actionpack (= 6.0.3.2)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (6.0.3.1)
-      actionpack (= 6.0.3.1)
-      activejob (= 6.0.3.1)
-      activerecord (= 6.0.3.1)
-      activestorage (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
+    actionmailbox (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       mail (>= 2.7.1)
-    actionmailer (6.0.3.1)
-      actionpack (= 6.0.3.1)
-      actionview (= 6.0.3.1)
-      activejob (= 6.0.3.1)
+    actionmailer (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (6.0.3.1)
-      actionview (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (6.0.3.1)
-      actionpack (= 6.0.3.1)
-      activerecord (= 6.0.3.1)
-      activestorage (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
+    actiontext (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       nokogiri (>= 1.8.5)
-    actionview (6.0.3.1)
-      activesupport (= 6.0.3.1)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (6.0.3.1)
-      activesupport (= 6.0.3.1)
+    activejob (6.0.3.2)
+      activesupport (= 6.0.3.2)
       globalid (>= 0.3.6)
-    activemodel (6.0.3.1)
-      activesupport (= 6.0.3.1)
-    activerecord (6.0.3.1)
-      activemodel (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
-    activestorage (6.0.3.1)
-      actionpack (= 6.0.3.1)
-      activejob (= 6.0.3.1)
-      activerecord (= 6.0.3.1)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activestorage (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
       marcel (~> 0.3.1)
-    activesupport (6.0.3.1)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -73,7 +73,7 @@ GEM
       activesupport (>= 4.2.0)
     i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    loofah (2.5.0)
+    loofah (2.6.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -93,32 +93,32 @@ GEM
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (2.2.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
-    rails (6.0.3.1)
-      actioncable (= 6.0.3.1)
-      actionmailbox (= 6.0.3.1)
-      actionmailer (= 6.0.3.1)
-      actionpack (= 6.0.3.1)
-      actiontext (= 6.0.3.1)
-      actionview (= 6.0.3.1)
-      activejob (= 6.0.3.1)
-      activemodel (= 6.0.3.1)
-      activerecord (= 6.0.3.1)
-      activestorage (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
+    rails (6.0.3.2)
+      actioncable (= 6.0.3.2)
+      actionmailbox (= 6.0.3.2)
+      actionmailer (= 6.0.3.2)
+      actionpack (= 6.0.3.2)
+      actiontext (= 6.0.3.2)
+      actionview (= 6.0.3.2)
+      activejob (= 6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activerecord (= 6.0.3.2)
+      activestorage (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       bundler (>= 1.3.0)
-      railties (= 6.0.3.1)
+      railties (= 6.0.3.2)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.3.1)
-      actionpack (= 6.0.3.1)
-      activesupport (= 6.0.3.1)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)

data/README.md

@@ -39,7 +39,7 @@ This mixin provides the `indifferently_accessible_json_attrs` class method which
 ```ruby
 class MyModel < ApplicationRecord
   include IndifferentlyAccessibleJsonAttrs
-  
+
   indifferently_accessible_json_attrs :data
 end
 ```
@@ -58,6 +58,44 @@ end
 Book.safely_find_or_create_by!(market: 'de', title: 'Moche!')
 ```
 
+#### NxtSupport::AssignableValues
+
+The `NxtSupport::AssignableValues` allows you to restrict the possible values for your ActiveRecord model attributes. These values will only be checked on new records or if the attribute in question has been changed, so existing records will not be affected even if they contain invalid values.
+
+```ruby
+class Book < ApplicationRecord
+	include NxtSupport::AssignableValues
+
+  # You can use a block
+  assignable_values_for :genre do
+    %w[fantasy adventure crime historical]
+  end
+
+  # Or you can also use an array argument
+  assignable_values_for :genre, %w[fantasy adventure crime historical]
+end
+
+book = Book.new(genre: 'fantasy', title: 'Moche!')
+book.valid? #=> true
+
+book.genre = 'comedy'
+book.valid? #=> false
+
+book.valid_genres #=> ["fantasy", "adventure", "crime", "historical"]
+```
+
+A default can be included
+```ruby
+assignable_values_for :genre, default: 'crime' do
+  %w[fantasy adventure crime historical]
+end
+```
+```ruby
+book = Book.new(title: 'Moche!')
+book.genre #=> crime
+```
+If the default value is not in the list of assignable values, then validation will fail.
+
 ### NxtSupport/Serializers
 
 Enjoy mixins for your serializers.
@@ -69,7 +107,7 @@ This mixin provides your serializer classes with a `attribute_as_iso8601` and a
 ```ruby
 class MySerializer < ActiveModel::Serializer
   include NxtSupport::HasTimeAttributes
-  
+
   attributes_as_iso8601 :created_at, :updated_at
 end
 ```
@@ -80,8 +118,8 @@ Enjoy some useful utilities
 
 #### NxtSupport::EnumHash
 
-`NxtSupport::EnumHash` is a simple hash with indifferent access to organize a collection of enums. 
-Keys will be normalized to be underscore and downcase and access with [] is raising a `KeyError` in case there is 
+`NxtSupport::EnumHash` is a simple hash with indifferent access to organize a collection of enums.
+Keys will be normalized to be underscore and downcase and access with [] is raising a `KeyError` in case there is
 no value for the key.
 
 ```ruby
@@ -99,7 +137,7 @@ Book::STATES['in_weird_state'] # 'in weird State'
 
 #### NxtSupport::HashTranslator
 
-`NxtSupport::HashTranslator` is a module that allows you to manipulate keys and values of original hash through tuple hash. 
+`NxtSupport::HashTranslator` is a module that allows you to manipulate keys and values of original hash through tuple hash.
 Tuple hash is a hash where `key` - represent's the key of original hash, and `value` - represents the key of result hash.
 Use `#translate_hash` method to get the result hash.
 
@@ -112,7 +150,7 @@ TestClass.translate_hash(firstname: 'John', firstname: :first_name)
 => { 'first_name' => 'John' }
 ```
 The `value` also could be a `Hash` where key represents the new key in result hash and value must be a lambda or Proc
-that would be used to process value from origin hash. If the tuple hash contains more than 1 key-value paris or value in key value pair 
+that would be used to process value from origin hash. If the tuple hash contains more than 1 key-value paris or value in key value pair
 is not a callable block `InvalidTranslationArgument` error would be raised.
 
 ```ruby

data/lib/nxt_support/models.rb

@@ -1,3 +1,4 @@
 require "nxt_support/models/email"
 require "nxt_support/models/safely_find_or_createable"
 require "nxt_support/models/indifferently_accessible_json_attrs"
+require "nxt_support/models/assignable_values"

data/lib/nxt_support/models/assignable_values.rb

@@ -0,0 +1,84 @@
+module NxtSupport
+  module AssignableValues
+    extend ActiveSupport::Concern
+
+    class_methods do
+      attr_reader :assignable_values
+
+      def assignable_values_for(column, values = [], **options, &block)
+        @assignable_values ||= {}
+        @assignable_values[column.to_sym] = {
+          values: (block_given? ? block.call : values),
+          default: options[:default],
+          allow_blank: options[:allow_blank]
+        }
+
+        define_assignable_instance_methods
+      end
+
+      def assignable_values_list_for(column)
+        assignable_values[column][:values]
+      end
+
+      def define_assignable_instance_methods
+        assignable_values.keys.each do |key|
+          define_method :"valid_#{key.to_s.pluralize}" do
+            self.class.assignable_values_list_for(key)
+          end
+        end
+      end
+    end
+
+    included do
+      validate :values_are_assignable
+      after_initialize :set_default_assignable
+    end
+
+    private
+
+    def values_are_assignable
+      attributes_to_validate.each do |attr|
+        next if changes_to_validate[attr].blank? && allow_blank_for?(attr)
+        next if changes_to_validate[attr].in?(assignable_values_for(attr))
+
+        if changes_to_validate[attr].blank?
+          errors.add(attr, "can't be blank.")
+        else
+          errors.add(attr, "the value #{changes_to_validate[attr]} is not in the list of acceptable values.")
+        end
+      end
+    end
+
+    def set_default_assignable
+      self.class.assignable_values.each do |column, assignable|
+        next unless new_record? && send(column).nil? && assignable[:default]
+
+        if assignable[:default].is_a? Proc
+          send("#{column}=", instance_exec(&assignable[:default]))
+        else
+          send("#{column}=", assignable[:default])
+        end
+      end
+    end
+
+    def allow_blank_for?(attr)
+      self.class.assignable_values[attr][:allow_blank]
+    end
+
+    def assignable_values_for(attr)
+      self.class.assignable_values[attr][:values]
+    end
+
+    def attributes_to_validate
+      new_record? ? self.class.assignable_values.keys : (changed_keys & self.class.assignable_values.keys)
+    end
+
+    def changed_keys
+      changes.keys.map(&:to_sym)
+    end
+
+    def changes_to_validate
+      new_record? ? attributes.symbolize_keys : changes.transform_values(&:last).symbolize_keys
+    end
+  end
+end

data/lib/nxt_support/version.rb

@@ -1,3 +1,3 @@
 module NxtSupport
-  VERSION = "0.1.4".freeze
+  VERSION = "0.1.5".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_support
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Nils Sommer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-17 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -134,6 +134,7 @@ files:
 - bin/setup
 - lib/nxt_support.rb
 - lib/nxt_support/models.rb
+- lib/nxt_support/models/assignable_values.rb
 - lib/nxt_support/models/email.rb
 - lib/nxt_support/models/indifferently_accessible_json_attrs.rb
 - lib/nxt_support/models/safely_find_or_createable.rb
@@ -167,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Support through reusable Mixins and Helpers for Ruby on Rails Applications