hmvc-rails 1.0.0

data/lib/generators/hmvc_rails/hmvc_rails_generator.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+class HmvcRailsGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path("templates", __dir__)
+
+  class_option :action, type: :array, default: Hmvc::Rails.configuration.action
+  class_option :form, type: :array, default: Hmvc::Rails.configuration.form
+  class_option :parent_controller, type: :string, default: Hmvc::Rails.configuration.parent_controller
+  class_option :skip_form, type: :boolean, default: false
+  class_option :skip_view, type: :boolean, default: false
+
+  def generate
+    validate_options
+    create_controller
+    create_operation
+    create_form
+    create_view
+  end
+
+  private
+
+  def validate_options
+    return if behavior == :revoke
+
+    validate_name
+    validate_params
+    validate_form_option
+    validate_action_option
+    validate_parent_controller_option
+    validate_skip_form_option
+    validate_skip_view_option
+  end
+
+  def create_controller
+    template "controllers/controller.rb",
+             File.join("app/controllers", class_path.join("/"), "#{file_name}_controller.rb")
+  end
+
+  def create_operation
+    options[:action].each do |action|
+      @_action = action
+      template "operations/operation.rb", File.join("app/operations", file_path, "#{action}_operation.rb")
+    end
+  end
+
+  def create_form
+    return if options[:skip_form] || options[:form].blank?
+
+    forms = options[:form] & options[:action]
+    return puts "Warning: No forms created! Form and action controller does mismatch" if forms.blank?
+
+    forms.each do |action|
+      @_action = action
+      template "forms/form.rb", File.join("app/forms", file_path, "#{action}_form.rb")
+    end
+  end
+
+  def create_view
+    return if options[:skip_view] || Hmvc::Rails.configuration.view.blank?
+
+    views = Hmvc::Rails.configuration.view & options[:action]
+    return puts "Warning: No views created! View and action controller does mismatch" if views.blank?
+
+    view_engine = Rails.application&.config&.generators&.options&.dig(:rails, :template_engine) || "erb"
+    copy_view_template(views, view_engine)
+  rescue StandardError
+    copy_view_template(views, "erb")
+  end
+
+  def copy_view_template(views, view_engine)
+    views.each do |action|
+      @_action = action
+      template "views/view.#{view_engine}", File.join("app/views", file_path, "#{action}.html.#{view_engine}")
+    end
+  end
+
+  def argv
+    @argv ||= ARGV.map { |arg| arg.split("=") }.flatten
+  end
+
+  def validate_name
+    show_error_message("Invalid name arguments '#{argv[1]}'") if argv[1] && !argv[1].start_with?("-")
+  end
+
+  def validate_params
+    option_params = argv.select { |arg| arg.include?("-") }
+    wrong_options = option_params - %w[--action --form --parent-controller --skip-form --skip-view]
+    show_error_message("Invalid optional arguments '#{wrong_options.join(", ")}'") if wrong_options.present?
+  end
+
+  def validate_action_option
+    action_options = argv.select { |arg| arg == "--action" }
+    show_error_message("Optional '--action' is duplicated") if action_options.size > 1
+  end
+
+  def validate_form_option
+    form_options = argv.select { |arg| arg == "--form" }
+    show_error_message("Optional '--form' is duplicated") if form_options.size > 1
+  end
+
+  def validate_parent_controller_option
+    parent_options = argv.select { |arg| arg == "--parent-controller" }
+    show_error_message("Optional '--parent-controller' is duplicated") if parent_options.size > 1
+    index = argv.index("--parent-controller")
+    return unless index
+
+    if argv[index + 1].blank? || argv[index + 1].start_with?("-") ||
+       (argv[index + 2] && !argv[index + 2].start_with?("-"))
+      show_error_message("Option '--parent-controller' is not valid")
+    end
+  end
+
+  def validate_skip_form_option
+    index = argv.index("--skip-form")
+    return if index.blank? || argv[index + 1].blank? || argv[index + 1].start_with?("-")
+
+    show_error_message("Option '--skip-form' is not valid")
+  end
+
+  def validate_skip_view_option
+    index = argv.index("--skip-view")
+    return if index.blank? || argv[index + 1].blank? || argv[index + 1].start_with?("-")
+
+    show_error_message("Option '--skip-view' is not valid")
+  end
+
+  def show_error_message(message)
+    puts "Error:"
+    puts "  #{message}"
+    puts "------"
+    puts `rails g hmvc_rails --help`
+    exit(1)
+  end
+
+  def path_notes(action)
+    case action
+    when "index" then "# [GET]..."
+    when "show" then "# [GET]..."
+    when "new" then "# [GET]..."
+    when "edit" then "# [GET]..."
+    when "create" then "# [POST]..."
+    when "update" then "# [PUT]..."
+    when "destroy" then "# [DELETE]..."
+    else "# [METHOD]..."
+    end
+  end
+
+  def add_file_traces
+    return unless Hmvc::Rails.configuration.file_traces
+
+    "# Created at: #{Time.now.strftime("%Y-%m-%d %H:%M %z")}\n# Creator: #{`git config user.email`}"
+  end
+end

data/lib/generators/hmvc_rails/install_generator.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require "rails"
+require "rails/generators"
+
+module HmvcRails
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Generate base files of the HMVC structure"
+
+      class_option :api, type: :boolean, default: false
+
+      source_root File.expand_path("templates", __dir__)
+
+      def generate
+        copy_configuration
+        copy_application_operator
+        copy_application_form
+        copy_validator
+        copy_api_error_handler
+        add_config_api_error_response
+        add_api_error_response
+      end
+
+      private
+
+      def copy_configuration
+        file_selected = options[:api] ? "configures/hmvc_rails_api.rb" : "configures/hmvc_rails.rb"
+        template file_selected, "config/initializers/hmvc_rails.rb"
+      end
+
+      def copy_application_operator
+        template "operations/application_operation.rb", "app/operations/application_operation.rb"
+      end
+
+      def copy_application_form
+        template "forms/application_form.rb", "app/forms/application_form.rb"
+      end
+
+      def copy_validator
+        template "validators/uniqueness_validator.rb", "app/validators/uniqueness_validator.rb"
+        template "validators/email_validator.rb", "app/validators/email_validator.rb"
+      end
+
+      def copy_api_error_handler
+        return unless options[:api]
+
+        template "extras/exception.rb", "lib/hmvc_rails/extras/exception.rb"
+        template "extras/error_resource.rb", "lib/hmvc_rails/extras/error_resource.rb"
+        template "extras/error_response.rb", "lib/hmvc_rails/extras/error_response.rb"
+      end
+
+      # rubocop:disable Layout/LineLength
+      def add_config_api_error_response
+        return if Rails.root.blank? || !options[:api] || behavior == :revoke
+
+        file_path = Rails.root.join("config", "application.rb")
+        if File.foreach(file_path).grep(/Application < Rails::Application/).any?
+          inject_into_file file_path, "    # This setting to use the error handler of hmvc-rails\n    config.eager_load_paths << Rails.root.join('lib', 'hmvc_rails')\n\n", after: "Application < Rails::Application\n"
+        else
+          puts "Warning: The hmvc_rails module could not be automatically loaded because the \"Application < Rails::Application\" flag was not found"
+          puts "Please manually add `config.eager_load_paths << Rails.root.join('lib', 'hmvc_rails')` to your `config/application.rb` to use hmvc-rails error response"
+        end
+      end
+
+      def add_api_error_response
+        return if Rails.root.blank? || !options[:api] || behavior == :revoke
+
+        file_path = Rails.root.join("app", "controllers", "application_controller.rb")
+        if File.foreach(file_path).grep(/ApplicationController < ActionController::API/).any?
+          inject_into_file file_path, "  include Extras::ErrorResponse\n", after: "ApplicationController < ActionController::API\n"
+        else
+          puts "Warning: The error response module could not be automatically added because the \"ApplicationController < ActionController::API\" flag was not found"
+          puts "Please manually add `include Extras::ErrorResponse` to your application_controller.rb to use hmvc-rails error response"
+        end
+      end
+      # rubocop:enable Layout/LineLength
+
+      def add_file_traces
+        "# Created at: #{Time.now.strftime("%Y-%m-%d %H:%M %z")}\n# Creator: #{`git config user.email`}"
+      end
+    end
+  end
+end

data/lib/generators/hmvc_rails/templates/configures/hmvc_rails.rb.tt

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+<%= add_file_traces %>
+if Rails.env.development?
+  Hmvc::Rails.configure do |config|
+    # The controller files's parent class of controller. Default is ApplicationController
+    # config.parent_controller = "ApplicationController"
+
+    # Method when creating the controller files. Default is %w[index show new create edit update destroy]
+    # config.action = %w[index show new create edit update destroy]
+
+    # Method when creating the view files. Default is %w[index show new edit]
+    # config.view = %w[index show new edit]
+
+    # The form files's parent class. Default is ApplicationForm
+    # config.parent_form = "ApplicationForm"
+
+    # Method when creating the form files. Default is %w[new create edit update]
+    # config.form = %w[new create edit update]
+
+    # The operation files's parent class. Default is ApplicationOperation
+    # config.parent_operation = "ApplicationOperation"
+
+    # Save author name and timestamp to file. Default is true
+    # config.file_traces = true
+  end
+end

data/lib/generators/hmvc_rails/templates/configures/hmvc_rails_api.rb.tt

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+<%= add_file_traces %>
+if Rails.env.development?
+  Hmvc::Rails.configure do |config|
+    # The controller files's parent class of controller. Default is ApplicationController
+    # config.parent_controller = "ApplicationController"
+
+    # Method when creating the controller files. Default is %w[index show new create edit update destroy]
+    config.action = %w[index show create update destroy]
+
+    # Method when creating the view files. Default is %w[index show new edit]
+    config.view = %w[]
+
+    # The form files's parent class. Default is ApplicationForm
+    # config.parent_form = "ApplicationForm"
+
+    # Method when creating the form files. Default is %w[new create edit update]
+    config.form = %w[create update]
+
+    # The operation files's parent class. Default is ApplicationOperation
+    # config.parent_operation = "ApplicationOperation"
+
+    # Save author name and timestamp to file. Default is true
+    # config.file_traces = true
+  end
+end

data/lib/generators/hmvc_rails/templates/controllers/controller.rb.tt

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+<%= add_file_traces %>
+class <%= class_name %>Controller < <%= options[:parent_controller] %><% options[:action].each do |action| %>
+  <%= path_notes(action) %>
+  def <%= action %>
+    operator = <%= class_name %>::<%= action.humanize %>Operation.new(params)
+    operator.call
+  end
+<% end %>end

data/lib/generators/hmvc_rails/templates/extras/error_resource.rb.tt

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+<%= add_file_traces %>
+module Extras
+  class ErrorResource
+    include Exception
+
+    attr_reader :status, :code, :message
+
+    def initialize(exception)
+      hash     = get_status_code(exception)
+      @code    = hash[:code]
+      @status  = hash[:status]
+      @message = exception.message
+    end
+
+    def as_json
+      return { code: code, field_error: field_errors } if status == UNPROCESSABLE_ENTITY[:status]
+
+      { code: code, message: message }
+    end
+
+    private
+
+    def field_errors
+      JSON.parse(message).map do |field, messages|
+        messages.map { |message_detail| { name: field, message: message_detail } }
+      end.flatten
+    end
+  end
+end

data/lib/generators/hmvc_rails/templates/extras/error_response.rb.tt

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+<%= add_file_traces %>
+module Extras
+  module ErrorResponse
+    extend ActiveSupport::Concern
+
+    included do
+      rescue_from StandardError do |exception|
+        handle(exception)
+      end
+
+      private
+
+      def handle(exception)
+        error = ErrorResource.new(exception)
+        render json: error.as_json, status: error.status
+      end
+    end
+  end
+end

data/lib/generators/hmvc_rails/templates/extras/exception.rb.tt

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+<%= add_file_traces %>
+module Extras
+  module Exception
+    BAD_REQUEST           = { status: 400, code: :bad_request }.freeze
+    UNAUTHORIZED          = { status: 401, code: :unauthorized }.freeze
+    FORBIDDEN             = { status: 403, code: :forbidden }.freeze
+    NOT_FOUND             = { status: 404, code: :not_found }.freeze
+    CONFLICT              = { status: 409, code: :conflict }.freeze
+    UNPROCESSABLE_ENTITY  = { status: 422, code: :unprocessable_entity }.freeze
+    INTERNAL_SERVER_ERROR = { status: 500, code: :internal_server_error }.freeze
+    NOT_IMPLEMENTED       = { status: 501, code: :not_implemented }.freeze
+    SERVICE_UNAVAILABLE   = { status: 503, code: :service_unavailable }.freeze
+
+    def get_status_code(exception)
+      case exception
+      when Exception::BadRequest, Exception::ResourceInvalid, ActionController::BadRequest
+        BAD_REQUEST
+      when Exception::SecurityError, Exception::Unauthorized
+        UNAUTHORIZED
+      when Exception::Forbidden, ActionController::InvalidAuthenticityToken
+        FORBIDDEN
+      when ActiveRecord::RecordNotFound
+        NOT_FOUND
+      when ActiveRecord::RecordNotUnique
+        CONFLICT
+      when Exception::UnprocessableEntity
+        UNPROCESSABLE_ENTITY
+      when Exception::NotImplemented
+        NOT_IMPLEMENTED
+      else
+        INTERNAL_SERVER_ERROR
+      end
+    end
+
+    class BadRequest < StandardError; end
+
+    class ResourceInvalid < StandardError; end
+
+    class SecurityError < StandardError; end
+
+    class Unauthorized < StandardError; end
+
+    class Forbidden < StandardError; end
+
+    class NotFound < StandardError; end
+
+    class ResourceNotFound < StandardError; end
+
+    class Conflict < StandardError; end
+
+    class UnprocessableEntity < ActiveRecord::RecordInvalid; end
+
+    class InternalServerError < StandardError; end
+
+    class NotImplemented < StandardError; end
+  end
+end

data/lib/generators/hmvc_rails/templates/forms/application_form.rb.tt

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+<%= add_file_traces %>
+class ApplicationForm
+  extend ActiveModel::Translation
+
+  include ActiveModel::Model
+  include ActiveModel::Attributes
+  include ActiveModel::Validations::Callbacks
+
+  def initialize(attributes = {})
+    self.class.attribute_names.each do |column|
+      self.class.attribute(column.to_sym)
+    end
+
+    super attributes
+  end
+
+  def valid!
+    raise ExceptionError::UnprocessableEntity, error_messages.to_json unless valid?
+  end
+
+  private
+
+  def error_messages
+    errors.messages.map { |key, value| { key => value.first } }
+  end
+
+  def attribute_names
+    []
+  end
+end

data/lib/generators/hmvc_rails/templates/forms/form.rb.tt

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+<%= add_file_traces %>
+class <%= class_name %>::<%= @_action.humanize %>Form < <%= Hmvc::Rails.configuration.parent_form %>
+end

data/lib/generators/hmvc_rails/templates/operations/application_operation.rb.tt

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+<%= add_file_traces %>
+class ApplicationOperation
+  attr_reader :params, :current_user
+
+  def initialize(params, data = {})
+    @params       = params
+    @current_user = data[:current_user]
+  end
+end

data/lib/generators/hmvc_rails/templates/operations/operation.rb.tt

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+<%= add_file_traces %>
+class <%= class_name %>::<%= @_action.humanize %>Operation < <%= Hmvc::Rails.configuration.parent_operation %>
+  def call; end
+end

data/lib/generators/hmvc_rails/templates/validators/email_validator.rb.tt

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+<%= add_file_traces %>
+class EmailValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return if value.blank? || /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\z/i.match?(value)
+
+    record.errors.add(attribute, :invalid)
+  end
+end

data/lib/generators/hmvc_rails/templates/validators/uniqueness_validator.rb.tt

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+<%= add_file_traces %>
+class UniquenessValidator < ActiveModel::EachValidator
+  def initialize(klass)
+    super
+    @klass = options[:model] if options[:model]
+  end
+
+  def validate_each(record, attribute)
+    record_org    = record
+    attribute_org = attribute
+    attribute     = options[:attribute].to_sym if options[:attribute]
+    base_attrs    = {}
+    base_attrs[attribute] = record_org.send(attribute)
+
+    options[:scope]&.each do |scope_attribute|
+      base_attrs[scope_attribute] = record_org.send(scope_attribute)
+    end
+
+    record = if record_org.try(:record)
+               options[:model].where.not(id: record_org.send(:record).id).exists?(base_attrs)
+             else
+               options[:model].exists?(base_attrs)
+             end
+
+    record_org.errors.add(attribute_org, :taken) if record
+  end
+end

data/lib/generators/hmvc_rails/templates/views/view.erb.tt

@@ -0,0 +1 @@
+<h1><%= @_action.camelize %></h1>

data/lib/generators/hmvc_rails/templates/views/view.haml.tt

@@ -0,0 +1 @@
+%h1= @_action.camelize

data/lib/generators/hmvc_rails/templates/views/view.slim.tt

@@ -0,0 +1 @@
+h1= @_action.camelize

data/lib/hmvc/rails/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Hmvc
+  module Rails
+    VERSION = "1.0.0"
+  end
+end

data/lib/hmvc/rails.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "rails/version"
+
+module Hmvc
+  module Rails
+    class Error < StandardError; end
+
+    class << self
+      attr_writer :configuration
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+
+      def configure
+        yield(configuration)
+      end
+    end
+
+    class Configuration
+      attr_accessor :parent_controller, :action, :view, :form, :parent_form, :parent_operation, :file_traces
+
+      def initialize
+        @parent_controller = "ApplicationController"
+        @action = %w[index show new create edit update destroy]
+        @view = %w[index show new edit]
+        @form = %w[new create edit update]
+        @parent_form = "ApplicationForm"
+        @parent_operation = "ApplicationOperation"
+        @file_traces = true
+      end
+    end
+  end
+end

data/lib/rubocop/cop/hmvc_rails/formal_style.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module HmvcRails
+      class FormalStyle < RuboCop::Cop::Base
+        def on_class(node)
+          class_name = node.children.first.children.last.to_s
+          return if class_name.end_with?("Form")
+
+          add_offense(node, message: "The form name does not match the desired format")
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/hmvc_rails/operating_style.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module HmvcRails
+      class OperatingStyle < RuboCop::Cop::Base
+        def on_class(node)
+          class_name = node.children.first.children.last.to_s
+          return if class_name.end_with?("Operation")
+
+          add_offense(node, message: "The operation name does not match the desired format")
+        end
+
+        def on_def(node)
+          return unless node.children.first == :call
+
+          node.body.to_a.compact.each do |ast|
+            next if ast.is_a?(Symbol) && (ast.to_s.start_with?("step_") || ats.to_s == "super")
+
+            next if ast.is_a?(RuboCop::AST::SendNode) &&
+                    (ast.children.last.to_s.start_with?("step_") || ast.children.last.to_s == "super")
+
+            add_offense(node, message: "Method works in \"call\" without prefix \"step_\"")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/hmvc_rails_cops.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "hmvc_rails/operating_style"
+require_relative "hmvc_rails/formal_style"

data/sig/hmvc/rails.rbs

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