rubanok 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90f6ca9dfd61a6f143eff1f3ab3c2d7e41502c992879af785dcf414af15249fd
-  data.tar.gz: 8807cbb2a680e9fbc739a9f0214fb4753e24ee55e69da72d9b45c7f121900dd9
+  metadata.gz: 8233d2946a61205ae18864a6304de48bf1d89621c989e8e364ce6b7f55cce3b6
+  data.tar.gz: 5ee328fb4f857065e11750dc2a9a8f169c7eebd9120d86c0617594929ab7e1d5
 SHA512:
-  metadata.gz: 2e015d7c3c517e42e5fe42037035db950cc87f9bd0099b38580c03ad156c36d0133681bd659451e8bdb58f15254799ce8d7b3158a1dc998210e3a425867a521d
-  data.tar.gz: 6c22e9a876e86f144726e8dbbe79b42f9d3052feb6f9c31688f7259872a5eed1e5ac66b031b890e0d1b4eceba7d3903331a073f2e13321b9f3d45c9fe53229d2
+  metadata.gz: 3ca8ec88b1f4f86c30834c429cdc1acfe98a4e6ce1e19bf707acf9178f8a46c729c65e5a4549190ebd3781150362d396f72cd163441df3174b9adb4ddc876af9
+  data.tar.gz: cf3bd84216aa32ddf4dc2150213659ac70f52fef84dfe2842cdd7b80acc362042196e9385fa42d3dd84dae4b26ebea0e84eb0232692035b55c09a5b99e0c21ee

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 0.5.0 (2023-12-04)
+
+- Add nested processors support. ([@palkan][])
+
 ## 0.4.0 (2021-03-05)
 
 - Ruby 3.0 compatibility. ([@palkan][])

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-2020 Vladimir Dementyev
+Copyright (c) 2018-2024 Vladimir Dementyev
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -53,8 +53,8 @@ end
 
 Requirements:
 
-- Ruby ~> 2.5
-- (optional\*) Rails >= 5.2 (Rails 4.2 should work but we don't test against it anymore)
+- Ruby ~> 2.7
+- (optional\*) Rails >= 6.0 (see older releases for Rails <6 support)
 
 \* This gem has no dependency on Rails.
 
@@ -155,6 +155,28 @@ If in example above you will call `CourseSessionsProcessor.call(CourseSession, f
 
 **NOTE:** Rubanok only matches exact values; more complex matching could be added in the future.
 
+### Nested processors
+
+You can use the `.process` method to define sub-processors (or nested processors). It's useful when you use nested params, for example:
+
+```ruby
+class CourseSessionsProcessor < Rubanok::Processor
+  process :filter do
+    match :status do
+      having "draft" do
+        raw.where(draft: true)
+      end
+
+      having "deleted" do
+        raw.where.not(deleted_at: nil)
+      end
+    end
+
+    # You can also use .map or even .process here
+  end
+end
+```
+
 ### Default transformation
 
 Sometimes it's useful to perform some transformations before **any** rule is activated.

data/lib/rubanok/dsl/mapping.rb

@@ -40,10 +40,6 @@ module Rubanok
           add_rule rule
         end
       end
-
-      def self.included(base)
-        base.extend ClassMethods
-      end
     end
   end
 end

data/lib/rubanok/dsl/matching.rb

@@ -26,7 +26,7 @@ module Rubanok
             super(fields, activate_on: activate_on, activate_always: activate_always)
             @id = id
             @block = block
-            @values = Hash[fields.take(values.size).zip(values)].freeze
+            @values = fields.take(values.size).zip(values).to_h.freeze
             @fields = (fields - @values.keys).freeze
           end
 
@@ -34,7 +34,7 @@ module Rubanok
             values.all? { |key, matcher| params.key?(key) && (matcher == params[key]) }
           end
 
-          alias to_method_name id
+          alias_method :to_method_name, :id
         end
 
         attr_reader :clauses
@@ -73,7 +73,7 @@ module Rubanok
           rule.instance_eval(&block)
 
           define_method(rule.to_method_name) do |params = {}|
-            params ||= {} if params.nil?
+            params ||= {}
 
             clause = rule.matching_clause(params)
 
@@ -92,10 +92,6 @@ module Rubanok
         end
       end
 
-      def self.included(base)
-        base.extend ClassMethods
-      end
-
       def default_match_handler(rule, params, fail_when_no_matches)
         fail_when_no_matches = Rubanok.fail_when_no_matches if fail_when_no_matches.nil?
         return raw unless fail_when_no_matches

data/lib/rubanok/dsl/process.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Rubanok
+  module DSL
+    # Adds `.process` method to Processor to define a nested processor:
+    #
+    #   process :filter do
+    #     map :status do |status:|
+    #       raw.where(status:)
+    #     end
+    #
+    module Process
+      class Rule < Rubanok::Rule
+        METHOD_PREFIX = "__process"
+
+        def initialize(...)
+          super
+          raise ArgumentError, "Nested processor requires exactly one field" if fields.size != 1
+          @field = fields.first
+        end
+
+        def define_processor(superclass, &block)
+          @processor = Class.new(superclass, &block)
+        end
+
+        def process(input, params)
+          return input if params.nil?
+
+          subparams = fetch_value(params, field)
+          return input if subparams == UNDEFINED
+
+          return input unless subparams.respond_to?(:transform_keys)
+
+          # @type var subparams : params
+          processor.call(input, subparams)
+        end
+
+        private
+
+        attr_reader :processor, :field
+
+        def build_method_name
+          "#{METHOD_PREFIX}#{super}"
+        end
+      end
+
+      module ClassMethods
+        def process(field, superclass: ::Rubanok::Processor, activate_on: [field], activate_always: false, ignore_empty_values: Rubanok.ignore_empty_values, filter_with: nil, &block)
+          filter = filter_with
+
+          if filter.is_a?(Symbol)
+            respond_to?(filter) || raise(
+              ArgumentError,
+              "Unknown class method #{filter} for #{self}. " \
+              "Make sure that a filter method is defined before the call to .map."
+            )
+            filter = method(filter)
+          end
+
+          rule = Rule.new([field], activate_on: activate_on, activate_always: activate_always, ignore_empty_values: ignore_empty_values, filter_with: filter)
+          rule.define_processor(superclass, &block)
+
+          define_method(rule.to_method_name) do |params = {}|
+            rule.process(raw, params)
+          end
+
+          add_rule rule
+        end
+      end
+    end
+  end
+end

data/lib/rubanok/processor.rb

@@ -6,6 +6,7 @@ require "rubanok/rule"
 
 require "rubanok/dsl/mapping"
 require "rubanok/dsl/matching"
+require "rubanok/dsl/process"
 
 module Rubanok
   # Base class for processors (_planes_)
@@ -29,8 +30,12 @@ module Rubanok
   #
   # You can access the input data via `raw` method.
   class Processor
+    extend DSL::Matching::ClassMethods
     include DSL::Matching
+    extend DSL::Mapping::ClassMethods
     include DSL::Mapping
+    extend DSL::Process::ClassMethods
+    include DSL::Process
 
     UNDEFINED = Object.new
 
@@ -106,8 +111,8 @@ module Rubanok
 
     attr_accessor :input, :prepared
 
-    alias raw input
-    alias prepared? prepared
+    alias_method :raw, :input
+    alias_method :prepared?, :prepared
 
     def apply_rule!(rule, params)
       method_name, data = rule.to_method_name, rule.project(params)

data/lib/rubanok/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rubanok
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

data/sig/rubanok/dsl/mapping.rbs

@@ -1,6 +1,6 @@
 module Rubanok
   module DSL
-    module Mapping : Processor
+    module Mapping : _Processor
       class Rule < Rubanok::Rule
         METHOD_PREFIX: String
 
@@ -11,8 +11,6 @@ module Rubanok
       module ClassMethods : Module, _RulesAdding
         def map: (*field fields, ?activate_on: (field | Array[field]), ?activate_always: bool, ?ignore_empty_values: bool, ?filter_with: Symbol) { () -> input } -> void
       end
-
-      def self.included: (singleton(Processor) base) -> void
     end
   end
 end

data/sig/rubanok/dsl/matching.rbs

@@ -3,7 +3,7 @@ module Rubanok
   end
 
   module DSL
-    module Matching : Processor
+    module Matching : _Processor
       class Rule < Rubanok::Rule
         METHOD_PREFIX: String
         @method_name: String
@@ -32,13 +32,12 @@ module Rubanok
         def build_method_name: () -> String
       end
 
-      module ClassMethods : Module, _RulesAdding, Matching
+      def default_match_handler: (Rule rule, hash params, bool? fail_when_no_matches) -> void
+
+      module ClassMethods : Module, _RulesAdding
         def match: (*field fields, ?activate_on: field | Array[field], ?activate_always: bool, ?fail_when_no_matches: bool?) { (Rule) -> void } -> void
+        def define_method: (String | Symbol) ?{ () [self: Rubanok::Processor] -> void } -> Symbol
       end
-
-      def self.included: (singleton(Processor) base) -> void
-
-      def default_match_handler: (Rule rule, hash params, bool? fail_when_no_matches) -> void
     end
   end
 end

data/sig/rubanok/dsl/process.rbs

@@ -0,0 +1,23 @@
+module Rubanok
+  module DSL
+    module Process : _Processor
+      class Rule < Rubanok::Rule
+        METHOD_PREFIX: String
+
+        attr_reader field: field
+        attr_reader processor: singleton(Processor)
+
+        %a{rbs:test:skip} def define_processor: (singleton(Processor)) { () -> void } -> void
+        def process: (input, params | nil) -> input
+
+        private
+        def build_method_name: () -> String
+      end
+
+      module ClassMethods : Module, _RulesAdding
+        %a{rbs:test:skip} def process: (field, superclass: singleton(Processor), ?activate_on: (field | Array[field]), ?activate_always: bool, ?ignore_empty_values: bool, ?filter_with: Symbol) { () -> input } -> void
+        def define_method: (String | Symbol) ?{ () [self: Rubanok::Processor] -> void } -> Symbol
+      end
+    end
+  end
+end

data/sig/rubanok/processor.rbs

@@ -11,11 +11,20 @@ module Rubanok
     def add_rule: (Rule rule) -> void
   end
 
+  interface _Processor
+    def raw: () -> input
+  end
+
   class Processor
+    include DSL::Matching
     extend DSL::Matching::ClassMethods
 
+    include DSL::Mapping
     extend DSL::Mapping::ClassMethods
 
+    include DSL::Process
+    extend DSL::Process::ClassMethods
+
     extend _RulesAdding
 
     UNDEFINED: Object

data/sig/typeprof.rb

@@ -10,6 +10,16 @@ processor = Class.new(Rubanok::Processor) do
     raw
   end
 
+  process :filter do
+    map :status do |status:|
+      raw
+    end
+
+    map :name do |name:|
+      raw
+    end
+  end
+
   match :sort_by, :sort, activate_on: :sort_by do
     having "status", "asc" do
       raw

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubanok
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Vladimir Dementyev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2023-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,7 @@ files:
 - lib/rubanok.rb
 - lib/rubanok/dsl/mapping.rb
 - lib/rubanok/dsl/matching.rb
+- lib/rubanok/dsl/process.rb
 - lib/rubanok/processor.rb
 - lib/rubanok/rails/controller.rb
 - lib/rubanok/railtie.rb
@@ -116,6 +117,7 @@ files:
 - sig/rubanok.rbs
 - sig/rubanok/dsl/mapping.rbs
 - sig/rubanok/dsl/matching.rbs
+- sig/rubanok/dsl/process.rbs
 - sig/rubanok/processor.rbs
 - sig/rubanok/rule.rbs
 - sig/rubanok/version.rbs
@@ -129,7 +131,7 @@ metadata:
   documentation_uri: http://github.com/palkan/rubanok
   homepage_uri: http://github.com/palkan/rubanok
   source_code_uri: http://github.com/palkan/rubanok
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,15 +139,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.4.20
+signing_key:
 specification_version: 4
 summary: Parameters-based transformation DSL
 test_files: []