steel_wheel 0.6.0 → 0.7.0

data/lib/generators/steel_wheel/application_handler/templates/handler_template.rb

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
 
 class ApplicationHandler < SteelWheel::Handler
+  url_params do
+    string :controller
+    string :action
+  end
 end

data/lib/generators/steel_wheel/form/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates operations files
+
+Example:
+    rails generate steel_wheel:form Thing
+
+    This will create:
+        app/handlers/thing_form.rb

data/lib/generators/steel_wheel/form/form_generator.rb

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

data/lib/generators/steel_wheel/form/templates/form_template.rb

@@ -0,0 +1,3 @@
+class <%= class_name %>Form < ActionForm::Rails::Base
+
+end

data/lib/generators/steel_wheel/handler/templates/handler_template.rb

@@ -1,21 +1,10 @@
 class <%= class_name %>Handler < ApplicationHandler
-  define do
-    params do
-
-    end
-
-    query do
-
-    end
-
-    command do
-      def call(*)
-        # NOOP
-      end
-    end
+  def call
+    # NOOP
   end
 
-  def on_success(flow)
-    flow.call(flow)
+  def on_validation_success
+    # call if current_action.create?
+    # update if current_action.update?
   end
 end

data/lib/generators/steel_wheel/scaffold_controller/USAGE

@@ -0,0 +1,14 @@
+Description:
+    Generates controller and handler files for a resource
+
+Example:
+    rails generate steel_wheel:scaffold_controller Thing name:string age:integer active:boolean
+
+    This will create:
+        app/controllers/things_controller.rb
+        app/handlers/things/index_handler.rb
+        app/handlers/things/create_handler.rb
+        app/handlers/things/update_handler.rb
+        app/handlers/things/model_form.rb
+
+    The generated handlers will include appropriate params definitions based on the provided attributes.

data/lib/generators/steel_wheel/scaffold_controller/scaffold_controller_generator.rb

@@ -0,0 +1,100 @@
+module SteelWheel
+  class ScaffoldControllerGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+
+      source_root File.expand_path('templates', __dir__)
+
+      check_class_collision suffix: "Controller"
+
+      class_option :helper, type: :boolean
+      class_option :orm, banner: "NAME", type: :string, required: true,
+                         desc: "ORM to generate the controller for"
+      class_option :api, type: :boolean,
+                         desc: "Generate API controller"
+
+      class_option :skip_routes, type: :boolean, desc: "Don't add routes to config/routes.rb."
+
+      argument :attributes, type: :array, default: [], banner: "field:type field:type"
+
+      def create_controller_files
+        template_file = options.api? ? "api_controller.rb" : "controller.rb"
+        template template_file, File.join("app/controllers", controller_class_path, "#{controller_file_name}_controller.rb")
+      end
+
+      def copy_template
+        if behavior == :revoke
+          template 'form.tt', "lib/templates/erb/scaffold/_form.html.erb.tt"
+        elsif behavior == :invoke
+          create_file "lib/templates/erb/scaffold/_form.html.erb.tt", File.read(File.join(__dir__, 'templates', 'form.tt'))
+        end
+      end
+
+      def copy_files
+        if behavior == :revoke
+          template 'index.rb', "app/handlers/#{controller_file_path}/index_handler.rb"
+          template 'create.rb', "app/handlers/#{controller_file_path}/create_handler.rb"
+          template 'update.rb', "app/handlers/#{controller_file_path}/update_handler.rb"
+          template 'model_form.rb', "app/handlers/#{controller_file_path}/model_form.rb"
+          template 'search_form.rb', "app/handlers/#{controller_file_path}/search_form.rb"
+        elsif behavior == :invoke
+          empty_directory Pathname.new('app/handlers').join(controller_file_path)
+          template 'index.rb', "app/handlers/#{controller_file_path}/index_handler.rb"
+          template 'create.rb', "app/handlers/#{controller_file_path}/create_handler.rb"
+          template 'update.rb', "app/handlers/#{controller_file_path}/update_handler.rb"
+          template 'model_form.rb', "app/handlers/#{controller_file_path}/model_form.rb"
+          template 'search_form.rb', "app/handlers/#{controller_file_path}/search_form.rb"
+        end
+      end
+
+      hook_for :template_engine, as: :scaffold do |template_engine|
+        invoke template_engine unless options.api?
+      end
+
+      hook_for :resource_route, required: true do |route|
+        invoke route unless options.skip_routes?
+      end
+
+      hook_for :test_framework, as: :scaffold
+
+      # Invoke the helper using the controller name (pluralized)
+      hook_for :helper, as: :scaffold do |invoked|
+        invoke invoked, [ controller_name ]
+      end
+
+      private
+
+      def convert_to_easy_params_type(attr)
+        case attr.type
+        when :attachment, :attachments then ':array, of: :string'
+        when :belongs_to, :references then :integer # Assuming these are foreign keys
+        when :boolean then :bool
+        when :date then :date
+        when :datetime, :timestamp then :datetime
+        when :decimal then :decimal
+        when :digest then :string # Assuming this is for password digests
+        when :float then :float
+        when :integer then :integer
+        when :rich_text then :string # Or consider a custom RichText type
+        when :string, :text then :string
+        when :time then :time
+        when :token then :string # Or consider a custom Token type
+        end
+      end
+
+      def permitted_params
+          attachments, others = attributes_names.partition { |name| attachments?(name) }
+          params = others.map { |name| ":#{name}" }
+          params += attachments.map { |name| "#{name}: []" }
+          params.join(", ")
+        end
+
+        def simple_params
+          attributes.reject { |attr| attachments?(attr.name) }
+        end
+
+        def attachments?(name)
+          attribute = attributes.find { |attr| attr.name == name }
+          attribute&.attachments?
+        end
+    end
+  end

data/lib/generators/steel_wheel/scaffold_controller/templates/controller.rb

@@ -0,0 +1,65 @@
+class <%= controller_class_name %>Controller < ApplicationController
+  before_action :authenticate_account!
+
+  # GET <%= route_url %>
+  action :index do |handler|
+    @<%= controller_file_name %> = handler.<%= controller_file_name %>
+    @form = handler.form
+  end
+
+  # GET <%= route_url %>/1
+  action :show, handler: :update do |handler|
+    @<%= file_name %> = handler.<%= file_name %>
+  end
+
+  # GET <%= route_url %>/new
+  action :new, handler: :create do |handler|
+    @<%= file_name %> = handler.<%= file_name %>
+    @form = handler.form
+  end
+
+  # GET <%= route_url %>/1/edit
+  action :edit, handler: :update do |handler|
+    @<%= file_name %> = handler.<%= file_name %>
+    @form = handler.form
+  end
+
+  # POST <%= route_url %>
+  action :create do |handler|
+    handler.success do
+      <%- if controller_class_path.empty? -%>
+      redirect_to handler.<%= file_name %>, notice: '<%= human_name %> was successfully created.'
+      <%- else -%>
+      redirect_to [<%= controller_class_path.map{|path| ":#{path}"}.join(', ') %>, handler.<%= file_name %>], notice: '<%= human_name %> was successfully created.'
+      <%- end -%>
+    end
+
+    handler.failure do
+      @<%= file_name %> = handler.<%= file_name %>
+      @form = handler.form
+      render :new
+    end
+  end
+
+  # PATCH/PUT <%= route_url %>/1
+  action :update do |handler|
+    handler.success do
+      <%- if controller_class_path.empty? -%>
+      redirect_to handler.<%= file_name %>, notice: '<%= human_name %> was successfully updated.'
+      <%- else -%>
+      redirect_to [<%= controller_class_path.map{|path| ":#{path}"}.join(', ') %>, handler.<%= file_name %>], notice: '<%= human_name %> was successfully updated.'
+      <%- end -%>
+    end
+
+    handler.failure do
+      @form = handler.form
+      @<%= file_name %> = handler.<%= file_name %>
+      render :edit
+    end
+  end
+
+  # DELETE <%= route_url %>/1
+  action :destroy, handler: :update do |handler|
+    redirect_to <%= index_helper %>_url, notice: '<%= human_name %> was successfully destroyed.'
+  end
+end

data/lib/generators/steel_wheel/scaffold_controller/templates/create.rb

@@ -0,0 +1,23 @@
+class <%= controller_class_name %>::CreateHandler < ApplicationHandler
+  form <%= controller_class_name %>::ModelForm
+
+  verify memoize def <%= file_name %>
+    <%= singular_name.camelize %>.new(form_params.to_h)
+  end
+
+  def form_attributes
+    <%- if controller_class_path.empty? -%>
+    { model: <%= file_name %> }
+    <%- else -%>
+    { model: [<%= controller_class_path.map{|path| ":#{path}"}.join(', ') %>, <%= file_name %>] }
+    <%- end -%>
+  end
+
+  def on_validation_success
+    call if current_action.create?
+  end
+
+  def call
+    <%= file_name %>.save
+  end
+end

data/lib/generators/steel_wheel/scaffold_controller/templates/form.tt

@@ -0,0 +1,12 @@
+<%% if @errors.any? %>
+  <div style="color: red">
+    <h2><%%= pluralize(@errors.count, "error") %> prohibited this <%= singular_table_name %> from being saved:</h2>
+
+    <ul>
+      <%% @errors.each do |error| %>
+        <li><%%= error.full_message %></li>
+      <%% end %>
+    </ul>
+  </div>
+<%% end %>
+<%%= render @form %>

data/lib/generators/steel_wheel/scaffold_controller/templates/index.rb

@@ -0,0 +1,17 @@
+class <%= controller_class_name %>::IndexHandler < ApplicationHandler
+  def form_attributes
+    { method: :get, action: helpers.<%= index_helper %>_path, params: form_params }
+  end
+
+  form <%= controller_class_name %>::SearchForm
+  <%- simple_params.each do |attribute| -%>
+
+  filter :<%= attribute.column_name %> do |scope, value|
+    scope.where(<%= attribute.column_name %>: value)
+  end
+  <%- end -%>
+
+  filterable def <%= controller_file_name %>
+    <%= singular_name.camelize %>.all
+  end
+end

data/lib/generators/steel_wheel/scaffold_controller/templates/model_form.rb

@@ -0,0 +1,32 @@
+module <%= controller_class_name %>
+  class ModelForm < ActionForm::Rails::Base
+    resource_model <%= singular_name.camelize %>
+    <%- simple_params.each do |attribute| -%>
+
+    element :<%= attribute.column_name %> do
+      <%- if attribute.type == :boolean -%>
+      input(type: :checkbox)
+      output(type: :boolean, presence: true)
+      <%- elsif attribute.type == :text -%>
+      input(type: :textarea)
+      output(type: :string, presence: true)
+      <%- elsif attribute.type == :decimal || attribute.type == :float -%>
+      input(type: :number, step: 'any')
+      output(type: :decimal, presence: true)
+      <%- elsif attribute.type == :integer -%>
+      input(type: :number)
+      output(type: :integer, presence: true)
+      <%- elsif attribute.type == :date -%>
+      input(type: :date)
+      output(type: :date, presence: true)
+      <%- elsif attribute.type == :datetime || attribute.type == :timestamp -%>
+      input(type: :datetime_local)
+      output(type: :datetime, presence: true)
+      <%- else -%>
+      input(type: :text)
+      output(type: :string, presence: true)
+      <%- end -%>
+    end
+    <%- end -%>
+  end
+end

data/lib/generators/steel_wheel/scaffold_controller/templates/search_form.rb

@@ -0,0 +1,31 @@
+module <%= controller_class_name %>
+  class SearchForm < ActionForm::Base
+    <%- simple_params.each do |attribute| -%>
+
+    element :<%= attribute.column_name %> do
+      <%- if attribute.type == :boolean -%>
+      input(type: :checkbox)
+      output(type: :boolean)
+      <%- elsif attribute.type == :text -%>
+      input(type: :textarea)
+      output(type: :string)
+      <%- elsif attribute.type == :decimal || attribute.type == :float -%>
+      input(type: :number, step: 'any')
+      output(type: :decimal)
+      <%- elsif attribute.type == :integer -%>
+      input(type: :number)
+      output(type: :integer)
+      <%- elsif attribute.type == :date -%>
+      input(type: :date)
+      output(type: :date)
+      <%- elsif attribute.type == :datetime || attribute.type == :timestamp -%>
+      input(type: :datetime_local)
+      output(type: :datetime)
+      <%- else -%>
+      input(type: :text)
+      output(type: :string)
+      <%- end -%>
+    end
+    <%- end -%>
+  end
+end

data/lib/generators/steel_wheel/scaffold_controller/templates/update.rb

@@ -0,0 +1,31 @@
+class <%= controller_class_name %>::UpdateHandler < ApplicationHandler
+  form <%= controller_class_name %>::ModelForm
+
+  url_params do
+    integer :id, presence: true
+  end
+
+  finder :<%= file_name %>, -> { <%= singular_name.camelize %>.find_by(id: url_params.id) }, validate_existence: true
+
+  def on_validation_success
+    call if current_action.update?
+    destroy if current_action.destroy?
+  end
+
+  def call
+    <%= file_name %>.update(form_params.to_h)
+  end
+
+  def destroy
+    <%= file_name %>.destroy
+  end
+
+  def form_attributes
+    <%- if controller_class_path.empty? -%>
+    { model: <%= file_name %> }
+    <%- else -%>
+    { model: [<%= controller_class_path.map{|path| ":#{path}"}.join(', ') %>, <%= file_name %>] }
+    <%- end -%>
+  end
+end
+

data/lib/steel_wheel/callbacks.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module SteelWheel
+  # Provides callbacks functionality for handlers
+  module Callbacks
+    NOOP = ->(o) { o }.freeze
+
+    def callbacks
+      @callbacks ||= {}
+    end
+
+    def failure(*statuses, &block)
+      return callbacks[:unprocessable_entity] = block if statuses.empty?
+
+      statuses.each do |status|
+        callbacks[status] = block
+      end
+    end
+
+    def success(&block)
+      callbacks[:success] = block
+    end
+
+    private
+
+    def success_callback
+      callbacks.fetch(:success, NOOP).call(self)
+    end
+
+    def failure_callback
+      callbacks.fetch(http_status, NOOP).call(self)
+    end
+  end
+end

data/lib/steel_wheel/components.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module SteelWheel
+  # Provides parameter and form components
+  module Components
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.include(InstanceMethods)
+      base.singleton_class.attr_writer :url_params_definition, :form_definition
+    end
+
+    module ClassMethods # rubocop:disable Style/Documentation
+      def url_params_definition
+        @url_params_definition ||= Class.new(SteelWheel::Params)
+      end
+
+      def form_definition
+        @form_definition ||= Class.new(ActionForm::Rails::Base)
+      end
+
+      def url_params(klass = nil, &block)
+        self.url_params_definition = Class.new(klass) if klass
+        url_params_definition.class_exec(self, &block) if block
+      end
+
+      def form(klass = nil, &block)
+        self.form_definition = Class.new(klass) if klass
+        form_definition.class_eval(&block) if block
+      end
+    end
+
+    module InstanceMethods # rubocop:disable Style/Documentation
+      def url_params
+        @url_params ||= self.class.url_params_definition.new(input)
+      end
+
+      def form_params
+        @form_params ||= if @form_scope
+                           self.class.form_definition.params_definition.schema[@form_scope].class.new(form_input)
+                         else
+                           self.class.form_definition.params_definition.new(form_input)
+                         end
+      end
+
+      def form(attrs = form_attributes)
+        @form ||= self.class.form_definition.new(**attrs)
+      end
+
+      def form_attributes
+        raise SteelWheel::FormAttributesNotImplementedError
+      end
+    end
+  end
+end

data/lib/steel_wheel/filters.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SteelWheel
+  # Provides filtering functionality for handlers
+  module Filters
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.include(InstanceMethods)
+    end
+
+    module ClassMethods # rubocop:disable Style/Documentation
+      def filter(name, &definition)
+        define_method("filter_by_#{name}", &definition)
+      end
+
+      def filterable(name)
+        alias_method :"initial_#{name}_scope", name
+        define_method(name) do
+          apply_filters(send(:"initial_#{name}_scope"), form_params.to_h)
+        end
+      end
+    end
+
+    module InstanceMethods # rubocop:disable Style/Documentation
+      def apply_filters(scope, search_params)
+        search_params.each do |key, value|
+          filter_method = "filter_by_#{key}"
+          raise SteelWheel::FilterNotImplementedError, key unless respond_to?(filter_method)
+
+          scope = send(filter_method, scope, value) if value.present?
+        end
+        scope
+      end
+    end
+  end
+end