steel_wheel 0.6.1 → 0.8.0

data/lib/steel_wheel/handler.rb

@@ -1,106 +1,106 @@
 # frozen_string_literal: true
 
+require 'steel_wheel/query/dependency_validator'
+require 'steel_wheel/query/verify_validator'
+require 'steel_wheel/query/exists_validator'
+
 module SteelWheel
   # Base class that defines main flow
   class Handler
-    include Nina
+    include Memery
     include ActiveModel::Validations
+    include SteelWheel::Filters
+    include SteelWheel::Components
+    include SteelWheel::Shortcuts
+    include SteelWheel::Callbacks
+    include SteelWheel::Preconditions
+    include SteelWheel::Composition
+
+    attr_reader :input, :form_input
+    attr_accessor :http_status, :helpers
+
+    unless defined?(ActiveModel::Error)
+      def self.generic_validation_keys(*keys)
+        include SteelWheel::SkipActiveModelErrorsKeys[*keys]
+      end
 
-    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
+      generic_validation_keys(:not_found, :forbidden, :unprocessable_entity, :bad_request, :unauthorized)
     end
 
-    def self.define(flow: :main, &block)
-      builders[flow].subclass(&block)
+    def initialize(params = {})
+      @http_status = :ok
+      prepare_params(params)
     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)
+    class << self
+      def handle(input = {}, &block)
+        new(input).handle(&block)
       end
 
-      def validate(object)
-        return if object.valid?
-
-        self.http_status ||= object.http_status
-        errors.merge!(object.errors) if errors.empty?
+      def name
+        to_s.match?(/Class/) ? 'SteelWheel::Handler' : to_s
       end
-    end
-
-    def initialize(&callbacks)
-      @user_defined_callbacks = callbacks
-    end
 
-    def on_params_created(params)
-      # NOOP
+      def inherited(subclass)
+        super
+        subclass.url_params(url_params_definition)
+        subclass.form(form_definition)
+      end
     end
 
-    def on_query_created(query)
-      # NOOP
+    def call
+      raise SteelWheel::ActionNotImplementedError, 'Subclass must implement #call'
     end
 
-    def on_command_created(command)
-      # NOOP
-    end
+    def handle(&block)
+      yield(self) if block
+      validate_preconditions
+      return self unless success?
 
-    def on_response_created(response)
-      # NOOP
+      on_validation_success
+      errors.empty? ? success_callback : failure_self
+      self
     end
 
-    def on_failure(flow)
+    def on_validation_success
       # NOOP
     end
 
-    def on_success(flow)
-      # NOOP
+    def success?
+      http_status == :ok
     end
 
-    def self.base_class_for(factory, flow: :main)
-      builders[flow].abstract_factory.factories[factory].instance_variable_get(:@base_class)
-    end
+    def status
+      return :ok if errors.empty?
+      return errors.keys.first unless defined?(ActiveModel::Error)
 
-    def self.handle(input:, flow: :main, &block)
-      new.handle(input: input, flow: flow, &block)
+      errors.map(&:type).first
     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
+    def current_action
+      ActiveSupport::StringInquirer.new(url_params.action)
     end
 
     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
+    def prepare_params(params)
+      normalized_params = normalize_params(params)
+      @form_scope = self.class.form_definition.scope
+      @validate_form = false
+      if @form_scope
+        @form_input = normalized_params.delete(@form_scope)
+        @validate_form = @form_input.present?
+      else
+        @form_input = normalized_params.except(*self.class.url_params_definition.schema.keys)
+      end
+      @input = normalized_params
     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) }
+    def normalize_params(params)
+      if params.is_a?(Hash)
+        params.deep_symbolize_keys
+      elsif params.is_a?(ActionController::Parameters)
+        params.to_unsafe_h.deep_symbolize_keys
       end
     end
   end

data/lib/steel_wheel/params.rb

@@ -3,7 +3,11 @@
 module SteelWheel
   # Base class for params
   class Params < EasyParams::Base
-    def http_status
+    def self.name
+      'SteelWheel::Params'
+    end
+
+    def status
       return :ok if errors.empty?
 
       :bad_request

data/lib/steel_wheel/preconditions.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SteelWheel
+  # Provides precondition validation functionality for handlers
+  module Preconditions
+    private
+
+    def validate_preconditions
+      if url_params.invalid?
+        failure_params
+      elsif @validate_form && form_params.invalid?
+        failure_form
+      elsif invalid?
+        failure_self
+      end
+    end
+
+    def failure_params
+      self.http_status = url_params.status
+      errors.merge!(url_params.errors)
+      failure_callback
+    end
+
+    def failure_form
+      self.http_status = :unprocessable_entity
+      @form = create_form_from_form_params
+      failure_callback
+    end
+
+    def failure_self
+      self.http_status = status
+      errors.delete(@form_scope) if @form_scope
+      failure_callback
+    end
+  end
+end

data/lib/steel_wheel/query/dependency_validator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module SteelWheel
+  class Query
+    # Presence validation for dependencies
+    class DependencyValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        return if value
+
+        record.errors.add :base, :not_found, message: options.fetch(:message, "#{attribute.to_s.humanize} is missing")
+      end
+    end
+  end
+end

data/lib/steel_wheel/query/exists_validator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SteelWheel
+  class Query
+    # Presence validation for loaders
+    class ExistsValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        return unless value.blank?
+
+        error_key = options[:base] ? :base : attribute
+        record.errors.add(error_key, :not_found, message: options.fetch(:message, 'not found'))
+      end
+    end
+  end
+end

data/lib/steel_wheel/query/verify_validator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module SteelWheel
+  class Query
+    # Verify validation for objects
+    class VerifyValidator < ActiveModel::EachValidator
+      def validate_each(record, attribute, value)
+        return if value.nil? || value.valid?
+
+        value.errors.each { |error| add_error_to_record(record, attribute, error) }
+      end
+
+      private
+
+      def add_error_to_record(record, attribute, error)
+        error_key = options[:base] ? :base : attribute
+        message = build_error_message(error)
+        record.errors.add(error_key, :unprocessable_entity, message: message)
+      end
+
+      def build_error_message(error)
+        if options[:message]
+          options.fetch(:message).fetch(error.attribute.to_sym, "#{error.attribute} #{error.message}")
+        else
+          "#{error.attribute} #{error.message}"
+        end
+      end
+    end
+  end
+end

data/lib/steel_wheel/railtie.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module SteelWheel # rubocop:disable Style/Documentation
+  # Rails integration for SteelWheel handlers
+  module RailsHelpers
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.include(InstanceMethods)
+    end
+
+    module ClassMethods # rubocop:disable Style/Documentation
+      def action(action_name, handler: action_name, &block)
+        define_method(action_name) do
+          handler_klass = handler_class_for(handler)
+          handler_klass.handle(params) do |handler_instance|
+            handler_instance.owner = self
+            handler_instance.helpers = view_context
+            instance_exec(handler_instance, &block)
+            failure_callbacks(handler_instance)
+          end
+        end
+      end
+    end
+
+    module InstanceMethods # rubocop:disable Style/Documentation
+      def handler_class_for(handler)
+        different_namespace = handler.to_s.split('/').size > 1
+        return "#{handler.to_s.camelize}Handler".constantize if different_namespace
+
+        "#{[params[:controller], handler].compact.join('/')}_handler".classify.constantize
+      end
+
+      def failure_callbacks(handler)
+        handler.failure(:not_found) do
+          render file: Rails.root.join('public', '404.html').to_s, status: handler.http_status
+        end
+      end
+    end
+  end
+  # Rails integration for SteelWheel handlers
+  if defined?(Rails)
+    class Railtie < Rails::Railtie # rubocop:disable Style/Documentation
+      initializer 'steel_wheel.helpers' do
+        ActiveSupport.on_load(:action_controller) do
+          ActionController::Base.include RailsHelpers if defined?(ActionController::Base)
+          ActionController::API.include RailsHelpers if defined?(ActionController::API)
+        end
+      end
+    end
+  end
+end

data/lib/steel_wheel/shortcuts.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SteelWheel
+  # Provides shortcuts methods for handlers
+  module Shortcuts
+    def self.included(base)
+      base.extend(self)
+    end
+
+    def depends_on(*attrs, validate_provided: true)
+      attr_accessor(*attrs)
+
+      validates(*attrs, 'steel_wheel/query/dependency': validate_provided)
+    end
+
+    def verify(*attrs, valid: true)
+      validates(*attrs, 'steel_wheel/query/verify': valid)
+    end
+
+    def finder(name, scope, validate_existence: false)
+      define_method(name) do
+        instance_exec(&scope)
+      end
+      memoize name
+      validates name, 'steel_wheel/query/exists': validate_existence
+    end
+  end
+end

data/lib/steel_wheel/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SteelWheel
-  VERSION = '0.6.1'
+  VERSION = '0.8.0'
 end

data/lib/steel_wheel.rb

@@ -1,19 +1,49 @@
 # frozen_string_literal: true
 
-require 'ostruct'
 require 'easy_params'
-require 'nina'
-require 'json'
 require 'active_model'
 require 'memery'
+require 'action_form'
+require 'steel_wheel/composition'
 require 'steel_wheel/skip_active_model_errors_keys'
 require 'steel_wheel/params'
-require 'steel_wheel/query'
-require 'steel_wheel/command'
-require 'steel_wheel/response'
+require 'steel_wheel/filters'
+require 'steel_wheel/preconditions'
+require 'steel_wheel/callbacks'
+require 'steel_wheel/components'
+require 'steel_wheel/shortcuts'
 require 'steel_wheel/handler'
+require 'steel_wheel/railtie'
 require 'steel_wheel/version'
 
 module SteelWheel
   class Error < StandardError; end
+  class ActionNotImplementedError < Error; end
+
+  class FilterNotImplementedError < Error # rubocop:disable Style/Documentation
+    def initialize(filter_name)
+      super(<<~HEREDOC)
+        Filter #{filter_name} is not implemented
+
+        Example:
+        filter :#{filter_name} do |scope, value|
+          scope.where(#{filter_name}: value)
+        end
+
+      HEREDOC
+    end
+  end
+
+  class FormAttributesNotImplementedError < Error # rubocop:disable Style/Documentation
+    def initialize
+      super(<<~HEREDOC)
+        Subclass must implement form_attributes which returns a hash of attributes for the form
+
+        Example:
+        def form_attributes
+          { model: model }
+        end
+      HEREDOC
+    end
+  end
 end

data/steel_wheel.gemspec

@@ -38,11 +38,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
   spec.required_ruby_version = '>= 2.6'
 
-  version_string = ['>= 3.2', '< 8']
+  version_string = ['>= 3.2', '< 9']
 
-  spec.add_runtime_dependency 'railties', version_string
+  spec.add_dependency 'railties', version_string
 
-  spec.add_dependency 'easy_params', '~> 0.3'
+  spec.add_dependency 'action_form', '~> 0.6.6'
+  spec.add_dependency 'easy_params', '~> 0.9.1'
   spec.add_dependency 'memery', '~> 1'
-  spec.add_dependency 'nina', '~> 0.1.3'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: steel_wheel
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Andrii Baran
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-12 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -19,7 +18,7 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,49 +28,49 @@ dependencies:
         version: '3.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '9'
 - !ruby/object:Gem::Dependency
-  name: easy_params
+  name: action_form
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.6.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: 0.6.6
 - !ruby/object:Gem::Dependency
-  name: memery
+  name: easy_params
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 0.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: 0.9.1
 - !ruby/object:Gem::Dependency
-  name: nina
+  name: memery
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: '1'
 description: Tiny DSL for code in controllers
 email:
 - andriy.baran.v@gmail.com
@@ -80,8 +79,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
-- ".github/workflows/ruby.yml"
+- ".github/workflows/main.yml"
 - ".gitignore"
+- ".qlty/.gitignore"
+- ".qlty/qlty.toml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
@@ -98,24 +99,34 @@ files:
 - 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/form/USAGE
+- lib/generators/steel_wheel/form/form_generator.rb
+- lib/generators/steel_wheel/form/templates/form_template.rb
 - lib/generators/steel_wheel/handler/USAGE
 - lib/generators/steel_wheel/handler/handler_generator.rb
 - lib/generators/steel_wheel/handler/templates/handler_template.rb
-- lib/generators/steel_wheel/params/USAGE
-- lib/generators/steel_wheel/params/params_generator.rb
-- lib/generators/steel_wheel/params/templates/params_template.rb
-- lib/generators/steel_wheel/query/USAGE
-- lib/generators/steel_wheel/query/query_generator.rb
-- lib/generators/steel_wheel/query/templates/query_template.rb
+- lib/generators/steel_wheel/scaffold_controller/USAGE
+- lib/generators/steel_wheel/scaffold_controller/scaffold_controller_generator.rb
+- lib/generators/steel_wheel/scaffold_controller/templates/controller.rb
+- lib/generators/steel_wheel/scaffold_controller/templates/create.rb
+- lib/generators/steel_wheel/scaffold_controller/templates/form.tt
+- lib/generators/steel_wheel/scaffold_controller/templates/index.rb
+- lib/generators/steel_wheel/scaffold_controller/templates/model_form.rb
+- lib/generators/steel_wheel/scaffold_controller/templates/search_form.rb
+- lib/generators/steel_wheel/scaffold_controller/templates/update.rb
 - lib/steel_wheel.rb
-- lib/steel_wheel/command.rb
+- lib/steel_wheel/callbacks.rb
+- lib/steel_wheel/components.rb
+- lib/steel_wheel/composition.rb
+- lib/steel_wheel/filters.rb
 - lib/steel_wheel/handler.rb
 - lib/steel_wheel/params.rb
-- lib/steel_wheel/query.rb
-- lib/steel_wheel/response.rb
+- lib/steel_wheel/preconditions.rb
+- lib/steel_wheel/query/dependency_validator.rb
+- lib/steel_wheel/query/exists_validator.rb
+- lib/steel_wheel/query/verify_validator.rb
+- lib/steel_wheel/railtie.rb
+- lib/steel_wheel/shortcuts.rb
 - lib/steel_wheel/skip_active_model_errors_keys.rb
 - lib/steel_wheel/version.rb
 - steel_wheel.gemspec
@@ -126,7 +137,6 @@ 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:
 rdoc_options: []
 require_paths:
 - lib
@@ -141,8 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Adds operations to your rails code
 test_files: []

data/.github/workflows/ruby.yml

@@ -1,43 +0,0 @@
-name: Ruby
-
-on:
-  push:
-    branches:
-      - master
-
-  pull_request:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    name: Ruby ${{ matrix.ruby }}
-    strategy:
-      matrix:
-        ruby:
-          - '3.1.3'
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.0.0
-    - name: Install dependencies
-      run: |
-        gem install bundler -v 2.2.3
-        bundle install
-    - name: Setup Code Climate test-reporter
-      run: |
-        curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-        chmod +x ./cc-test-reporter
-        ./cc-test-reporter before-build
-    - name: Run the default task
-      env:
-        CC_TEST_REPORTER_ID: 4bb114295e4e80ad0f42b2f30b7611f0459c1cbdc7a74a0fe6fa437a543796d9
-      run: bundle exec rake
-    - name: Publish code coverage
-      run: |
-        export GIT_BRANCH="master"
-        pwd
-        ls -l coverage
-        ./cc-test-reporter after-build -d -t simplecov -r 4bb114295e4e80ad0f42b2f30b7611f0459c1cbdc7a74a0fe6fa437a543796d9

data/lib/generators/steel_wheel/command/USAGE

@@ -1,8 +0,0 @@
-Description:
-    Generates commands files
-
-Example:
-    rails generate steel_wheel:command Thing
-
-    This will create:
-        app/commands/thing_command.rb

data/lib/generators/steel_wheel/command/command_generator.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module SteelWheel
-  class CommandGenerator < Rails::Generators::NamedBase
-    source_root File.expand_path('templates', __dir__)
-
-    def copy_files
-      if behavior == :revoke
-        template 'command_template.rb', "app/handlers/#{file_path}_handler/command.rb"
-      elsif behavior == :invoke
-        empty_directory Pathname.new('app/commands').join(*class_path)
-        template 'command_template.rb', "app/handlers/#{file_path}_handler/command.rb"
-      end
-    end
-  end
-end