nxt_support 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 187a9226c75ccd071bd9c32bf599f3d0b8badf1888fc4d09dd656d815b0af2ff
-  data.tar.gz: fa7e12a3f24c9bc3a0fe2e3bc455b4b09e3ee3fd2fa90371886e49d3eda2f5c3
+  metadata.gz: 683364c398008994e7e9efb8007e03bf7056dd816dec3e396a4482ede9e546d9
+  data.tar.gz: 4e8cee47fa7c145b01ae07b5e8c8ded7da56211ba1272794823e2f8b3a8be5ce
 SHA512:
-  metadata.gz: 9c9ced17e3a32dd6a91e3863e589d645b0ac6f0b370ce6ba94c8abc7ae645c5f5e3c1d81ef4c15c919afcb8f9c2a931701de67a8304985346c5fc1370e6dad05
-  data.tar.gz: c62f77b8707d77af40ea9e32c8151c7b8aae07975ac2032b9b73d31b6664c61d9eac7d8159f0842d7bdc202e9fb67504a785b4ef95366020c9fbffc3a721074f
+  metadata.gz: de2c12071f41de18b97e49d1516faa54d01b343ab68ff0949004713c8e2345b443cdd60f2f051394e41e966480aca79451b9327d189a60915261814b297620a5
+  data.tar.gz: 8b3a6e21cedd45c22ca925099c02a2e62fe1c7f3f25dae05770e09952c754cf433c0737746f699da42fb6caddb966673daafe20795f1618bcdb5411a1db9ac31

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v0.1.6 2020-06-18
+
+- Added `NxtSupport::PreprocessAttributes`
+
 # v0.1.5 2020-06-17
 
 - Added `NxtSupport::AssignableValues`

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    nxt_support (0.1.5)
+    nxt_support (0.1.6)
       nxt_init
+      nxt_registry
       rails
 
 GEM
@@ -90,6 +91,8 @@ GEM
       mini_portile2 (~> 2.4.0)
     nxt_init (0.1.5)
       activesupport
+    nxt_registry (0.1.5)
+      activesupport
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)

data/README.md

@@ -96,6 +96,46 @@ book.genre #=> crime
 ```
 If the default value is not in the list of assignable values, then validation will fail.
 
+#### NxtSupport::PreprocessAttributes
+
+This mixin provides the `preprocess_attributes` class method which can preprocess columns before saving by either stripping whitespace, downcasing, or both.
+
+```ruby
+class Book < ApplicationRecord
+  include NxtSupport::PreprocessAttributes
+
+  preprocess_attributes :title, :author, preprocessors: %i[strip downcase]
+end
+
+book = Book.new(title: '  Moche!')
+book.save
+book.title #=> "moche!"
+```
+
+Register a custom preprocesser:
+
+```ruby
+NxtSupport::Preprocessor.register(:compress, CompressPreprocessor)
+```
+
+Also works with non-string columns
+
+```ruby
+NxtSupport::Preprocessor.register(:add_one, AddOnePreprocessor, :integer)
+```
+
+```ruby
+class Book < ApplicationRecord
+  include NxtSupport::PreprocessAttributes
+
+  preprocess_attributes :views, preprocessors: %i[add_one], column_type: :integer
+end
+
+book = Book.new(views: 1000)
+book.save
+book.views #=> "1001"
+```
+
 ### NxtSupport/Serializers
 
 Enjoy mixins for your serializers.

data/lib/nxt_support.rb

@@ -1,5 +1,8 @@
 require 'active_support/all'
+require 'nxt_registry'
+
 require "nxt_support/version"
+require "nxt_support/preprocessor"
 require "nxt_support/models"
 require "nxt_support/serializers"
 require "nxt_support/util"

data/lib/nxt_support/models.rb

@@ -2,3 +2,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"
+require "nxt_support/models/preprocess_attributes"

data/lib/nxt_support/models/preprocess_attributes.rb

@@ -0,0 +1,35 @@
+module NxtSupport
+  module PreprocessAttributes
+    extend ActiveSupport::Concern
+
+    class_methods do
+      attr_reader :nxt_preprocessors
+
+      def preprocess_attributes(*attributes, **options)
+        attributes_to_process =
+          if attributes.any?
+            attributes.map(&:to_sym)
+          else
+            column_names.map(&:to_sym)
+          end
+
+        @nxt_preprocessors ||= []
+        @nxt_preprocessors << NxtSupport::Preprocessor.new(attributes_to_process, options)
+      end
+    end
+
+    included do
+      before_validation do |record|
+        nxt_preprocessors.each do |preprocessor|
+          preprocessor.process(record)
+        end
+      end
+    end
+
+    private
+
+    def nxt_preprocessors
+      self.class.nxt_preprocessors
+    end
+  end
+end

data/lib/nxt_support/preprocessor.rb

@@ -0,0 +1,76 @@
+require "nxt_support/preprocessors/strip_preprocessor"
+require "nxt_support/preprocessors/downcase_preprocessor"
+
+module NxtSupport
+  class Preprocessor
+    extend NxtRegistry
+
+    PREPROCESSORS = registry :type, callable: false do
+      nested :preprocessors
+    end
+
+    attr_accessor :attributes, :preprocessors, :options
+    attr_reader :type
+
+    def initialize(attributes, options)
+      @type = options.fetch(:column_type) { :string }
+      @options = options
+
+      attributes_to_preprocess(attributes, options)
+      extract_preprocessors
+      register_default_preprocessors
+    end
+
+    def process(record)
+      attributes.each do |attr|
+        value_to_process = record[attr]
+        processed_value = process_value(value_to_process)
+        record[attr] = processed_value
+      end
+    end
+
+    private
+
+    def attributes_to_preprocess(attributes, options = {})
+      if options[:only]
+        attributes.select! { |attr| attr.in?(options[:only]) }
+      elsif options[:except]
+        attributes.reject! { |attr| attr.in?(options[:except]) }
+      end
+
+      @attributes = attributes
+    end
+
+    def extract_preprocessors
+      @preprocessors = options[:preprocessors]
+      raise ArgumentError, 'No preprocessors provided' unless preprocessors.present?
+    end
+
+    def process_value(value)
+      preprocessors.each do |key|
+        value = resolve(key, value)
+      end
+
+      value
+    end
+
+    def resolve(key, value)
+      if key.respond_to?(:lambda?)
+        key.call(value)
+      else
+        PREPROCESSORS.resolve(type).resolve(key).new(value).call
+      end
+    end
+
+    def register_default_preprocessors
+      PREPROCESSORS.type(:string).preprocessors!(:strip, NxtSupport::Preprocessors::StripPreprocessor)
+      PREPROCESSORS.type(:string).preprocessors!(:downcase, NxtSupport::Preprocessors::DowncasePreprocessor)
+    end
+
+    class << self
+      def register(name, preprocessor, type = :string)
+        PREPROCESSORS.type(type).preprocessors!(name, preprocessor)
+      end
+    end
+  end
+end

data/lib/nxt_support/preprocessors/downcase_preprocessor.rb

@@ -0,0 +1,22 @@
+module NxtSupport
+  module Preprocessors
+    class WrongTypeError < StandardError; end
+
+    class DowncasePreprocessor
+      attr_accessor :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def call
+        return if value.nil?
+
+        value.downcase!
+        value
+      rescue NoMethodError => e
+        raise WrongTypeError, "Tried to call #{e.name} on #{value}, but #{value} does not respond to #{e.name}"
+      end
+    end
+  end
+end

data/lib/nxt_support/preprocessors/strip_preprocessor.rb

@@ -0,0 +1,22 @@
+module NxtSupport
+  module Preprocessors
+    class WrongTypeError < StandardError; end
+
+    class StripPreprocessor
+      attr_accessor :value
+
+      def initialize(value)
+        @value = value
+      end
+
+      def call
+        return if value.nil?
+
+        value.strip!
+        value
+      rescue NoMethodError => e
+        raise WrongTypeError, "Tried to call #{e.name} on #{value}, but #{value} does not respond to #{e.name}"
+      end
+    end
+  end
+end

data/lib/nxt_support/version.rb

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

data/nxt_support.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rails"
   spec.add_dependency "nxt_init"
+  spec.add_dependency "nxt_registry"
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nxt_support
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Nils Sommer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-18 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -39,6 +39,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nxt_registry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +151,11 @@ files:
 - 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/preprocess_attributes.rb
 - lib/nxt_support/models/safely_find_or_createable.rb
+- lib/nxt_support/preprocessor.rb
+- lib/nxt_support/preprocessors/downcase_preprocessor.rb
+- lib/nxt_support/preprocessors/strip_preprocessor.rb
 - lib/nxt_support/serializers.rb
 - lib/nxt_support/serializers/has_time_attributes.rb
 - lib/nxt_support/util.rb
@@ -168,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Support through reusable Mixins and Helpers for Ruby on Rails Applications