patternist 0.1.0

data/lib/patternist/controllers/actionpack/helpers.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+
+module Patternist
+  module Controllers
+    module ActionPack
+      # Provides helper methods for controller resource handling and naming conventions.
+      # Automatically infers resource classes and names based on controller naming.
+      module Helpers
+        CONTROLLER_SUFFIX = 'Controller'
+        NAMESPACE_SEPARATOR = '::'
+
+        def self.included(base)
+          base.extend ClassMethods
+        end
+
+        def collection = resource_class.all
+        def find_resource = resource_class.find(id_param)
+        def create_resource = resource.save
+        def update_resource = resource.update(resource_params)
+        def destroy_resource = resource.destroy
+        def resource_class = @resource_class ||= self.class.resource_class
+        def resource_name = @resource_name ||= self.class.resource_name
+        def resource_class_name = @resource_class_name ||= model_name_human || resource_class.name
+        def collection_name = @collection_name ||= resource_name.pluralize
+        def resource = instance_variable_get(instance_variable_name(resource_name))
+        def id_param = params.fetch(params_id_key, nil)
+        def params_id_key = :id
+
+        private
+
+        def model_name_human
+          resource_class.respond_to?(:model_name) && resource_class.model_name.human
+        end
+
+        def collection_instance=(value)
+          instance_variable_set(instance_variable_name(collection_name), value)
+        end
+
+        def resource_instance=(value)
+          instance_variable_set(instance_variable_name(resource_name), value)
+        end
+
+        def instance_variable_name(name)
+          :"@#{name}"
+        end
+
+        # Class methods automatically added to the including class
+        module ClassMethods
+          # Infers the resource class from the controller name
+          def resource_class
+            @resource_class ||= infer_resource_class
+          end
+
+          # Returns the underscored name of the resource class
+          def resource_name
+            @resource_name ||= resource_class.name.underscore
+          end
+
+          private
+
+          # Infers the resource class based on the controller name
+          def infer_resource_class
+            base_name = if name.end_with?(CONTROLLER_SUFFIX)
+                          name[0...-CONTROLLER_SUFFIX.length]
+                        else
+                          name
+                        end
+
+            last_separator = base_name.rindex(NAMESPACE_SEPARATOR)
+            controller_name = if last_separator
+                                base_name[(last_separator + 2)..]
+                              else
+                                base_name
+                              end
+
+            Object.const_get(controller_name.singularize) if controller_name
+          rescue NameError => e
+            raise NameError, "Could not infer resource class for #{name}: #{e.message}. " \
+                             'Please define `self.resource_class` in your controller.'
+          rescue StandardError => e
+            raise NameError, "An error occurred while inferring resource class for #{name}: #{e.message}."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/patternist/controllers/actionpack/response_handling.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Patternist
+  module Controllers
+    module ActionPack
+      # Handles HTTP and JSON response formatting for controllers.
+      # Provides consistent response patterns across controllers with customizable handlers.
+      module ResponseHandling
+        HTML_FORMAT   = :html
+        JSON_FORMAT   = :json
+
+        def format_response(resource, notice:, status:, on_error_render:, formats: {}, &block)
+          respond_to do |format|
+            if block.call
+              handle_success(format, resource, notice, status, formats)
+            else
+              handle_error(format, resource, on_error_render, formats)
+            end
+          end
+        end
+
+        private
+
+        # Handles successful responses for different formats
+        def handle_success(format, resource, notice, status, custom_formats)
+          # TODO: DEPRECATE custom_formats?
+          dispatch_response(format, HTML_FORMAT, html_success(resource, notice: notice), custom_formats)
+          dispatch_response(format, JSON_FORMAT, json_success(resource, status: status), custom_formats)
+        end
+
+        # Handles error responses for different formats
+        def handle_error(format, resource, on_error_render, custom_formats)
+          dispatch_response(format, HTML_FORMAT, html_error(on_error_render), custom_formats, :on_error_html)
+          dispatch_response(format, JSON_FORMAT, json_error(resource), custom_formats, :on_error_json)
+        end
+
+        def html_success(location, notice:)
+          proc { redirect_to location, notice: notice }
+        end
+
+        def json_success(location, status:)
+          proc { render :show, status: status, location: location }
+        end
+
+        def html_error(on_error_render, status: :unprocessable_entity)
+          proc { render on_error_render, status: status }
+        end
+
+        def json_error(resource, status: :unprocessable_entity)
+          proc { render json: resource.errors, status: status }
+        end
+
+        def dispatch_response(format, format_method, default_proc, custom_procs, format_key = format_method)
+          format.public_send(format_method) do
+            (custom_procs[format_key] || default_proc).call
+          end
+        end
+      end
+    end
+  end
+end

data/lib/patternist/controllers/actionpack/restful.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative 'helpers'
+require_relative 'response_handling'
+
+module Patternist
+  module Controllers
+    module ActionPack
+      # Provides RESTful CRUD actions for controllers.
+      # Requires implementing `resource_params` for strong parameter handling.
+      module Restful
+        def self.included(base)
+          base.include Helpers
+          base.include ResponseHandling
+          base.include InstanceMethods
+        end
+
+        # Instance methods implementing RESTful actions
+        module InstanceMethods
+          # Lists all resources
+          def index = self.collection_instance = collection
+
+          # Shows a single resource
+          def show
+            self.resource_instance = find_resource
+            yield if block_given?
+          end
+
+          # Prepares a resource for editing
+          def edit
+            self.resource_instance = find_resource
+            yield if block_given?
+          end
+
+          # Initializes a new resource
+          def new
+            self.resource_instance = resource_class.new
+            yield if block_given?
+          end
+
+          # Creates a new resource
+          def create
+            self.resource_instance = resource_class.new(resource_params)
+
+            format_response(resource,
+                            notice: "#{resource_class_name} was successfully created.",
+                            status: :created,
+                            on_error_render: :new) do
+              create_resource
+            end
+          end
+
+          # Updates an existing resource
+          def update
+            self.resource_instance = find_resource
+
+            format_response(resource,
+                            notice: "#{resource_class_name} was successfully updated.",
+                            status: :ok,
+                            on_error_render: :edit) do
+              update_resource
+            end
+          end
+
+          # Destroys an existing resource
+          def destroy
+            self.resource_instance = find_resource
+
+            notice = "#{resource_class_name} was successfully destroyed."
+            format_response(resource,
+                            notice: notice,
+                            status: :see_other,
+                            on_error_render: :show,
+                            formats: {
+                              html: -> { redirect_to resource_class, notice: notice },
+                              json: -> { head :no_content }
+                            }) do
+              destroy_resource
+            end
+          end
+
+          protected
+
+          # Override this method to define allowed parameters
+          def resource_params
+            raise NotImplementedError,
+                  'Controller must define `resource_params`. Example: `params.require(:post).permit(:title, :body)`'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/patternist/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Patternist
+  VERSION = '0.1.0'
+end

data/lib/patternist.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'patternist/version'
+
+module Patternist
+  class Error < StandardError; end
+  class NotImplementedError < Error; end
+  class NameError < Error; end
+  class FormatError < Error; end
+end

data/sig/patternist.rbs

@@ -0,0 +1,4 @@
+module Patternist
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: patternist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Emerson Xavier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2025-07-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: Reusable utilities for Ruby and Rails
+email:
+- msxavii@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/devcontainer.json"
+- ".rspec"
+- ".rspec_status"
+- ".rubocop.yml"
+- ".ruby-lsp/.gitignore"
+- ".ruby-lsp/Gemfile"
+- ".ruby-lsp/Gemfile.lock"
+- ".ruby-lsp/last_updated"
+- ".ruby-lsp/main_lockfile_hash"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- coverage/.last_run.json
+- coverage/.resultset.json
+- coverage/.resultset.json.lock
+- coverage/assets/0.13.1/DataTables-1.10.20/images/sort_asc.png
+- coverage/assets/0.13.1/DataTables-1.10.20/images/sort_asc_disabled.png
+- coverage/assets/0.13.1/DataTables-1.10.20/images/sort_both.png
+- coverage/assets/0.13.1/DataTables-1.10.20/images/sort_desc.png
+- coverage/assets/0.13.1/DataTables-1.10.20/images/sort_desc_disabled.png
+- coverage/assets/0.13.1/application.css
+- coverage/assets/0.13.1/application.js
+- coverage/assets/0.13.1/colorbox/border.png
+- coverage/assets/0.13.1/colorbox/controls.png
+- coverage/assets/0.13.1/colorbox/loading.gif
+- coverage/assets/0.13.1/colorbox/loading_background.png
+- coverage/assets/0.13.1/favicon_green.png
+- coverage/assets/0.13.1/favicon_red.png
+- coverage/assets/0.13.1/favicon_yellow.png
+- coverage/assets/0.13.1/images/ui-bg_flat_0_aaaaaa_40x100.png
+- coverage/assets/0.13.1/images/ui-bg_flat_75_ffffff_40x100.png
+- coverage/assets/0.13.1/images/ui-bg_glass_55_fbf9ee_1x400.png
+- coverage/assets/0.13.1/images/ui-bg_glass_65_ffffff_1x400.png
+- coverage/assets/0.13.1/images/ui-bg_glass_75_dadada_1x400.png
+- coverage/assets/0.13.1/images/ui-bg_glass_75_e6e6e6_1x400.png
+- coverage/assets/0.13.1/images/ui-bg_glass_95_fef1ec_1x400.png
+- coverage/assets/0.13.1/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- coverage/assets/0.13.1/images/ui-icons_222222_256x240.png
+- coverage/assets/0.13.1/images/ui-icons_2e83ff_256x240.png
+- coverage/assets/0.13.1/images/ui-icons_454545_256x240.png
+- coverage/assets/0.13.1/images/ui-icons_888888_256x240.png
+- coverage/assets/0.13.1/images/ui-icons_cd0a0a_256x240.png
+- coverage/assets/0.13.1/loading.gif
+- coverage/assets/0.13.1/magnify.png
+- coverage/index.html
+- docs/PERFORMANCE_ASSESSMENT.md
+- docs/benchmark.rb
+- docs/performance_improvements.rb
+- docs/performance_recommendations.rb
+- lib/patternist.rb
+- lib/patternist/controller.rb
+- lib/patternist/controllers/actionpack/helpers.rb
+- lib/patternist/controllers/actionpack/response_handling.rb
+- lib/patternist/controllers/actionpack/restful.rb
+- lib/patternist/version.rb
+- sig/patternist.rbs
+homepage: https://github.com/xavius-rb/patternist
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/xavius-rb/patternist
+  source_code_uri: https://github.com/xavius-rb/patternist
+  changelog_uri: https://github.com/xavius-rb/patternist/blob/main/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Reusable utilities
+test_files: []