rubanok 0.1.1 → 0.4.0

data/lib/rubanok/rule.rb

@@ -1,23 +1,39 @@
 # frozen_string_literal: true
 
 module Rubanok
+  using(Module.new do
+    refine NilClass do
+      def empty?
+        true
+      end
+    end
+
+    refine Object do
+      def empty?
+        false
+      end
+    end
+  end)
+
   class Rule # :nodoc:
-    UNDEFINED = :__undef__
+    UNDEFINED = Object.new
 
-    attr_reader :fields, :activate_on, :activate_always
+    attr_reader :fields, :activate_on, :activate_always, :ignore_empty_values, :filter_with
 
-    def initialize(fields, activate_on: fields, activate_always: false)
+    def initialize(fields, activate_on: fields, activate_always: false, ignore_empty_values: Rubanok.ignore_empty_values, filter_with: nil)
       @fields = fields.freeze
-      @activate_on = Array(activate_on).freeze
+      # @type var activate_on: Array[Symbol]
+      activate_on = Array(activate_on)
+      @activate_on = activate_on.freeze
       @activate_always = activate_always
+      @ignore_empty_values = ignore_empty_values
+      @filter_with = filter_with
     end
 
     def project(params)
       fields.each_with_object({}) do |field, acc|
         val = fetch_value params, field
-        next acc if val == UNDEFINED
-
-        acc[field] = val
+        acc[field] = val if val != UNDEFINED
         acc
       end
     end
@@ -25,7 +41,7 @@ module Rubanok
     def applicable?(params)
       return true if activate_always == true
 
-      activate_on.all? { |field| params.key?(field) && !empty?(params[field]) }
+      activate_on.all? { |field| fetch_value(params, field) != UNDEFINED }
     end
 
     def to_method_name
@@ -39,27 +55,19 @@ module Rubanok
     end
 
     def fetch_value(params, field)
-      return UNDEFINED if !params.key?(field) || empty?(params[field])
+      return UNDEFINED unless params.key?(field)
 
-      params[field]
-    end
+      val = params[field]
 
-    using(Module.new do
-      refine NilClass do
-        def empty?
-          true
-        end
-      end
+      val = filter_with&.call(val) if filter_with
 
-      refine Object do
-        def empty?
-          false
-        end
-      end
-    end)
+      return UNDEFINED if empty?(val)
+
+      val
+    end
 
     def empty?(val)
-      return false unless Rubanok.ignore_empty_values
+      return false unless ignore_empty_values
 
       val.empty?
     end

data/lib/rubanok/version.rb

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

data/sig/rubanok.rbs

@@ -0,0 +1,6 @@
+module Rubanok
+  def self.fail_when_no_matches: () -> bool
+  def self.fail_when_no_matches=: (bool) -> bool
+  def self.ignore_empty_values: () -> bool
+  def self.ignore_empty_values=: (bool) -> bool
+end

data/sig/rubanok/dsl/mapping.rbs

@@ -0,0 +1,18 @@
+module Rubanok
+  module DSL
+    module Mapping : Processor
+      class Rule < Rubanok::Rule
+        METHOD_PREFIX: String
+
+        private
+        def build_method_name: () -> String
+      end
+
+      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

@@ -0,0 +1,44 @@
+module Rubanok
+  class UnexpectedInputError < StandardError
+  end
+
+  module DSL
+    module Matching : Processor
+      class Rule < Rubanok::Rule
+        METHOD_PREFIX: String
+        @method_name: String
+        @fields: Array[field]
+
+        class Clause < Rubanok::Rule
+          @fields: Array[field]
+
+          attr_reader values: params
+          attr_reader id: String
+          attr_reader block: ^() -> input
+
+          def initialize: (String id, Array[field] fields, untyped values, ?activate_on: field | Array[field], ?activate_always: bool) { () -> input } -> void
+          def applicable?: (params) -> bool
+
+          alias to_method_name id
+        end
+
+        attr_reader clauses: Array[Clause]
+
+        def matching_clause: (hash params) -> Clause?
+        def having: (*untyped values) { () -> input } -> void
+        def default: () { () -> input } -> void
+
+        private
+        def build_method_name: () -> String
+      end
+
+      module ClassMethods : Module, _RulesAdding, Matching
+        def match: (*field fields, ?activate_on: field | Array[field], ?activate_always: bool, ?fail_when_no_matches: bool?) { (Rule) -> void } -> void
+      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/processor.rbs

@@ -0,0 +1,53 @@
+module Rubanok
+  # Transformation parameters
+  type params = Hash[Symbol | String, untyped]
+  # Untyped Hash
+  type hash =  Hash[untyped, untyped]
+  type field = Symbol
+  # Transformation target (we assume that input and output types are the same)
+  type input = Object?
+
+  interface _RulesAdding
+    def add_rule: (Rule rule) -> void
+  end
+
+  class Processor
+    extend DSL::Matching::ClassMethods
+
+    extend DSL::Mapping::ClassMethods
+
+    extend _RulesAdding
+
+    UNDEFINED: Object
+
+    self.@rules: Array[Rule]
+    self.@fields_set: Set[field]
+
+    def self.superclass: () -> singleton(Processor)
+
+    def self.call: (input, params) -> input
+                 | (params) -> input
+    def self.rules: () -> Array[Rule]
+    def self.fields_set: () -> Set[field]
+    def self.project: (params) -> params
+    def self.prepare: () { () -> input } -> void
+
+    def initialize: (input) -> void
+    def call: (params) -> input
+
+    attr_accessor input: input
+
+    private
+    attr_accessor prepared: bool
+
+    alias raw input
+    alias prepared? prepared
+
+    def apply_rule!: (Rule rule, params) -> void
+    def prepare: () -> input
+    def prepare!: () -> void
+    def rules: () -> Array[Rule]
+  end
+
+  Plane: singleton(Processor)
+end

data/sig/rubanok/rule.rbs

@@ -0,0 +1,29 @@
+module Rubanok
+  class Rule
+    UNDEFINED: Object
+
+    @method_name: String
+
+    attr_reader fields: Array[field]
+    attr_reader activate_on: Array[field]
+    attr_reader activate_always: bool
+    attr_reader ignore_empty_values: bool
+    attr_reader filter_with: Method?
+
+    %a{rbs:test:skip} def initialize: (
+      Array[field] fields,
+      ?activate_on: field | Array[field],
+      ?activate_always: bool,
+      ?ignore_empty_values: bool,
+      ?filter_with: Method?
+    ) -> void
+    def project: (params) -> params
+    def applicable?: (params) -> bool
+    def to_method_name: () -> String
+
+    private
+    def build_method_name: () -> String
+    def fetch_value: (params, field) -> Object
+    def empty?: (untyped) -> bool
+  end
+end

data/sig/rubanok/version.rbs

@@ -0,0 +1,3 @@
+module Rubanok
+  VERSION: String
+end

data/sig/typeprof.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Run typeprofiler:
+#
+#   typeprof -Ilib sig/typeprof.rb
+require "rubanok"
+
+processor = Class.new(Rubanok::Processor) do
+  map :q do |q:|
+    raw
+  end
+
+  match :sort_by, :sort, activate_on: :sort_by do
+    having "status", "asc" do
+      raw
+    end
+
+    default do |sort_by:, sort: "asc"|
+      raw
+    end
+  end
+end
+
+processor.project({q: "search", sort_by: "name"})
+processor.call([], {q: "search", sort_by: "name"})

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubanok
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Vladimir Dementyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -54,62 +54,34 @@ dependencies:
         version: '1.16'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: standard
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,36 +101,34 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.local
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- gemfiles/rails42.gemfile
-- gemfiles/rails52.gemfile
-- gemfiles/railsmaster.gemfile
 - lib/rubanok.rb
 - lib/rubanok/dsl/mapping.rb
 - lib/rubanok/dsl/matching.rb
-- lib/rubanok/ext/symbolize_keys.rb
-- lib/rubanok/plane.rb
+- lib/rubanok/processor.rb
 - lib/rubanok/rails/controller.rb
 - lib/rubanok/railtie.rb
 - lib/rubanok/rspec.rb
 - lib/rubanok/rule.rb
 - lib/rubanok/version.rb
-- rubanok.gemspec
+- sig/rubanok.rbs
+- sig/rubanok/dsl/mapping.rbs
+- sig/rubanok/dsl/matching.rbs
+- sig/rubanok/processor.rbs
+- sig/rubanok/rule.rbs
+- sig/rubanok/version.rbs
+- sig/typeprof.rb
 homepage: https://github.com/palkan/rubanok
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: http://github.com/palkan/rubanok/issues
+  changelog_uri: https://github.com/palkan/rubanok/blob/master/CHANGELOG.md
+  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: 
 rdoc_options: []
 require_paths:
@@ -174,8 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Parameters-based transformation DSL