steel_wheel 0.5.1 → 0.6.0

data/lib/steel_wheel/handler.rb

@@ -1,50 +1,107 @@
+# frozen_string_literal: true
+
 module SteelWheel
-  class Handler < FlowObject::Base
-    from :params
-    to :response
+  # Base class that defines main flow
+  class Handler
+    include Nina
+    include ActiveModel::Validations
+
+    attr_reader :user_defined_callbacks
+
+    builder :main do
+      factory :params, produces: SteelWheel::Params
+      factory :query, produces: SteelWheel::Query
+      factory :command, produces: SteelWheel::Command
+      factory :response, produces: SteelWheel::Response
+    end
+
+    def self.define(flow: :main, &block)
+      builders[flow].subclass(&block)
+    end
+
+    # Runs validation on objects
+    class Validator
+      include ActiveModel::Validations
+      attr_accessor :http_status
+
+      def self.run(flow)
+        validator = new
+        [flow.params, flow.query, flow.command].each do |obj|
+          break if validator.errors.any?
+
+          validator.validate(obj)
+        end
+        flow.status = validator.http_status || :ok
+        flow.errors.merge!(validator.errors)
+      end
+
+      def validate(object)
+        return if object.valid?
+
+        self.http_status ||= object.http_status
+        errors.merge!(object.errors) if errors.empty?
+      end
+    end
+
+    def initialize(&callbacks)
+      @user_defined_callbacks = callbacks
+    end
 
-    input :params, base_class: SteelWheel::Params
-    flow do
-      stage :query, base_class: SteelWheel::Query
-      stage :command, base_class: SteelWheel::Command
+    def on_params_created(params)
+      # NOOP
     end
-    output :response, base_class: SteelWheel::Response
 
-    def self.halt_flow?(object, id)
-      !object.valid?
+    def on_query_created(query)
+      # NOOP
     end
 
-    def on_params_failure
-      output.status = :bad_request
-      output.errors.merge!(output.params.errors)
+    def on_command_created(command)
+      # NOOP
     end
 
-    def on_query_failure
-      output.status = output.query.http_status
-      output.errors.merge!(output.query.errors)
+    def on_response_created(response)
+      # NOOP
     end
 
-    def on_command_failure
-      output.status = output.command.http_status
-      output.errors.merge!(output.command.errors)
+    def on_failure(flow)
+      # NOOP
     end
 
-    def on_success
+    def on_success(flow)
       # NOOP
     end
 
+    def self.base_class_for(factory, flow: :main)
+      builders[flow].abstract_factory.factories[factory].base_class
+    end
+
     def self.handle(input:, flow: :main, &block)
-      call(input: input, flow: flow) do |callbacks|
-        callbacks.flow_initialized(&block) if block
-      end
+      new.handle(input: input, flow: flow, &block)
+    end
+
+    def handle(input:, flow: :main, &block)
+      object = configure_builder(flow).wrap(delegate: true) { |i| i.params(input) }
+      yield(object) if block
+      Validator.run(object)
+      object.success? ? on_success(object) : on_failure(object)
+      object
     end
 
-    alias_method(:flow, :output)
-    class << self
-      alias_method :params, :params_input
-      alias_method :query, :query_stage
-      alias_method :command, :command_stage
-      alias_method :response, :response_output
+    private
+
+    def configure_builder(flow)
+      builder = self.class.builders[flow].with_callbacks(&required_callbacks)
+      builder = builder.with_callbacks(&user_defined_callbacks) if user_defined_callbacks
+      builder
+    end
+
+    def required_callbacks
+      lambda do |c|
+        c.params { |o| on_params_created(o) }
+        c.query { |o| on_query_created(o) }
+        c.command { |o| on_command_created(o) }
+        c.response { |o| on_response_created(o) }
+      end
     end
   end
 end

data/lib/steel_wheel/params.rb

@@ -1,3 +1,12 @@
+# frozen_string_literal: true
+
 module SteelWheel
-  class Params < EasyParams::Base; end
+  # Base class for params
+  class Params < EasyParams::Base
+    def http_status
+      return :ok if errors.empty?
+
+      :bad_request
+    end
+  end
 end

data/lib/steel_wheel/query.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 module SteelWheel
+  # Base class for queries
   class Query
     include Memery
     include ActiveModel::Validations
@@ -8,7 +11,10 @@ module SteelWheel
     end
 
     def http_status
-      errors.keys.first
+      return :ok if errors.empty?
+      return errors.keys.first unless defined?(ActiveModel::Error)
+
+      errors.map(&:type).first
     end
   end
 end

data/lib/steel_wheel/response.rb

@@ -1,14 +1,19 @@
+# frozen_string_literal: true
+
 module SteelWheel
+  # Base class for responses
   class Response
     attr_accessor :status
-    attr_writer :errors
+
     include ActiveModel::Validations
 
-    def self.generic_validation_keys(*keys)
-      include SteelWheel::SkipActiveModelErrorsKeys[*keys]
-    end
+    unless defined?(ActiveModel::Error)
+      def self.generic_validation_keys(*keys)
+        include SteelWheel::SkipActiveModelErrorsKeys[*keys]
+      end
 
-    generic_validation_keys(:not_found, :forbidden, :unprocessable_entity)
+      generic_validation_keys(:not_found, :forbidden, :unprocessable_entity, :bad_request, :unauthorized)
+    end
 
     def self.name
       'SteelWheel::Response'

data/lib/steel_wheel/skip_active_model_errors_keys.rb

@@ -1,7 +1,15 @@
+# frozen_string_literal: true
+
 module SteelWheel
+  # Allows to treat some error codes as :base
+  #   EX:
+  #   generic_validation_keys :not_found
+  #   errors.add(:not_found, 'Can not find')
+  #   errors.full_messages => ['Can not find']
+  #   not ['Not found an not find']
   module SkipActiveModelErrorsKeys
     def self.build_module
-      mod = Module.new do
+      Module.new do
         class << self
           attr_accessor :skip_keys
 
@@ -12,6 +20,7 @@ module SteelWheel
       end
     end
 
+    # rubocop:disable Metrics/MethodLength
     def self.patch_errors_method_on_instance(mod, klass)
       class << klass
         alias_method :__new__, :new
@@ -21,11 +30,13 @@ module SteelWheel
         instance = __new__(*args)
         instance.errors.define_singleton_method :full_message do |attribute, message|
           return message if mod.skip_keys.include?(attribute)
+
           super(attribute, message)
         end
         instance
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     def self.[](*skip_keys)
       mod = build_module

data/lib/steel_wheel/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SteelWheel
-  VERSION = '0.5.1'.freeze
+  VERSION = '0.6.0'
 end

data/lib/steel_wheel.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'ostruct'
 require 'easy_params'
-require 'flow_object'
+require 'nina'
 require 'json'
 require 'active_model'
 require 'memery'

data/steel_wheel.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'steel_wheel/version'
@@ -23,7 +25,7 @@ Gem::Specification.new do |spec|
     # spec.metadata['changelog_uri'] = 'TODO: Put your gem's CHANGELOG.md URL here.'
   else
     raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+          'public gem pushes.'
   end
 
   # Specify which files should be added to the gem when it is released.
@@ -34,20 +36,13 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 2.4'
+  spec.required_ruby_version = '>= 2.6'
 
   version_string = ['>= 3.2', '< 8']
 
   spec.add_runtime_dependency 'railties', version_string
 
+  spec.add_dependency 'easy_params', '~> 0.3'
   spec.add_dependency 'memery', '~> 1'
-  spec.add_dependency 'easy_params', '~> 0.1.2'
-  spec.add_dependency 'flow_object', '~> 0.3.1'
-
-  spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'pry', '~> 0.10'
-  spec.add_development_dependency 'rake', '>= 12.3.3'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov', '0.17'
-  spec.add_development_dependency 'rspec_vars_helper', '~> 0.1'
+  spec.add_dependency 'nina', '~> 0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: steel_wheel
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Andrii Baran
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-29 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -30,132 +30,48 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
-- !ruby/object:Gem::Dependency
-  name: memery
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
 - !ruby/object:Gem::Dependency
   name: easy_params
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '0.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: flow_object
+  name: memery
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.1
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-- !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: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '0.17'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: '0.17'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: rspec_vars_helper
+  name: nina
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
+        version: 0.1.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.2
 description: Tiny DSL for code in controllers
 email:
 - andriy.baran.v@gmail.com
@@ -163,9 +79,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -177,10 +95,12 @@ files:
 - assets/action_diagram.png
 - bin/console
 - bin/setup
+- lib/generators/steel_wheel/application_handler/USAGE
+- lib/generators/steel_wheel/application_handler/application_handler_generator.rb
+- lib/generators/steel_wheel/application_handler/templates/handler_template.rb
 - lib/generators/steel_wheel/command/USAGE
 - lib/generators/steel_wheel/command/command_generator.rb
 - lib/generators/steel_wheel/command/templates/command_template.rb
-- lib/generators/steel_wheel/generic_generator.rb
 - lib/generators/steel_wheel/handler/USAGE
 - lib/generators/steel_wheel/handler/handler_generator.rb
 - lib/generators/steel_wheel/handler/templates/handler_template.rb
@@ -206,7 +126,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/andriy-baran/steel_wheel
   source_code_uri: https://github.com/andriy-baran/steel_wheel
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -214,15 +134,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.30
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Adds operations to your rails code
 test_files: []

data/lib/generators/steel_wheel/generic_generator.rb

@@ -1,23 +0,0 @@
-module SteelWheel
-  class GenericGenerator < Rails::Generators::NamedBase
-    def self.setup_templates_root(templates_relative_path)
-      source_root File.expand_path(templates_relative_path, __dir__)
-    end
-
-    def self.on_revoke(&block)
-      block_given? ? @on_revoke = block : @on_revoke
-    end
-
-    def self.on_invoke(&block)
-      block_given? ? @on_invoke = block : @on_invoke
-    end
-
-    def copy_files
-      if behavior == :revoke
-        instance_eval(&self.class.on_revoke)
-      elsif behavior == :invoke
-        instance_eval(&self.class.on_invoke)
-      end
-    end
-  end
-end