much-rails 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27f3cbd1c25d6f0cf73e2c03fa74b46eafde3b21de611f2d3780dc0931673bef
-  data.tar.gz: c912adf462f52b7ad317ff8e5e490cc8af11b97e40bc5ee62409143506590c15
+  metadata.gz: 612174b3a0ff8ace3d3f203a69a69586be9e2d2a7946ab20c8934e07209f8e95
+  data.tar.gz: d74beef0988406dc358b7bbccd6f5d23dc47e8f2997616b1323af8467c16dfff
 SHA512:
-  metadata.gz: ce101e8082e13fafc1ae6333d2b3e741541a6de012c2d476c3befcbd589af8103f5d0980c34f0663f08c8796f2a9340c0292db987b6681a3880c04eb34ef4a4e
-  data.tar.gz: '08807f38e83e8983ab6e5bd14bda024e39ed59d226093b669ad3cc379eeae0756c2725b4d8346978f2dd822537ccbd52f730dea86c35581b97eb3e79d997e6b4'
+  metadata.gz: ffe4bf14bdafb94b01c7078b70d0f01eda42e45aedc5dcc935d616e2fc5149c7b1901577af8da172c2df457da8cbeed9dbd30327276dca94ce214f808fac51be
+  data.tar.gz: 77a0d880a84289e969c99644429458a991c125287205b086953f73c683e1b730842d727e42621561c1b9d7cfb122de2c7f025951b7e7cafc852f50efce3a345a

data/Gemfile

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 ruby "~> 2.5"
 
 gemspec
 
-gem "pry", "~> 0.12.2"
+gem "pry"

data/lib/much-rails.rb

@@ -1,4 +1,89 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/core_ext"
+
 require "much-rails/version"
+require "much-rails/action"
+require "much-rails/boolean"
+require "much-rails/call_method"
+require "much-rails/call_method_callbacks"
+require "much-rails/change_action"
+require "much-rails/change_action_result"
+require "much-rails/config"
+require "much-rails/date"
+require "much-rails/decimal"
+require "much-rails/destroy_action"
+require "much-rails/destroy_service"
+require "much-rails/has_slug"
+require "much-rails/input_value"
+require "much-rails/json"
+require "much-rails/layout"
+require "much-rails/not_given"
+require "much-rails/mixin"
+require "much-rails/records"
+require "much-rails/result"
+require "much-rails/save_action"
+require "much-rails/save_service"
+require "much-rails/service"
+require "much-rails/time"
+require "much-rails/view_models"
+require "much-rails/wrap_and_call_method"
+require "much-rails/wrap_method"
+
+require "much-rails/railtie" if defined?(Rails::Railtie)
 
 module MuchRails
+  include MuchRails::Config
+  include MuchRails::NotGiven
+
+  add_config :much_rails, method_name: :config
+  singleton_class.alias_method :configure, :configure_much_rails
+
+  class MuchRailsConfig
+    include MuchRails::Config
+
+    add_instance_config :action, method_name: :action
+    add_instance_config :layout, method_name: :layout
+
+    def add_save_service_validation_error(exception_class, &block)
+      MuchRails::SaveService::ValidationErrors.add(exception_class, &block)
+    end
+
+    def add_destroy_service_validation_error(exception_class, &block)
+      MuchRails::DestroyService::ValidationErrors.add(exception_class, &block)
+    end
+
+    class ActionConfig
+      attr_accessor :namespace
+      attr_accessor :sanitized_exception_classes
+      attr_accessor :raise_response_exceptions
+
+      def initialize
+        @namespace = ""
+        @sanitized_exception_classes = [ActiveRecord::RecordInvalid]
+        @raise_response_exceptions   = false
+      end
+
+      def raise_response_exceptions?
+        !!@raise_response_exceptions
+      end
+    end
+
+    class LayoutConfig
+      attr_accessor :full_page_title_segment_separator
+      attr_accessor :full_page_title_application_separator
+
+      # Override as desired in an initializer, e.g.:
+      #
+      # Example:
+      #   # in config/initializers/much_rails.rb
+      #   MuchRails.config.layout.full_page_title_segment_separator " / "
+      #   MuchRails.config.layout.full_page_title_application_separator " :: "
+      def initialize
+        @full_page_title_segment_separator = " - "
+        @full_page_title_application_separator = " | "
+      end
+    end
+  end
 end

data/lib/much-rails/action.rb

@@ -0,0 +1,415 @@
+# frozen_string_literal: true
+
+require "active_record"
+require "much-rails/action/controller"
+require "much-rails/action/head_result"
+require "much-rails/action/redirect_to_result"
+require "much-rails/action/render_result"
+require "much-rails/action/router"
+require "much-rails/action/send_data_result"
+require "much-rails/action/send_file_result"
+require "much-rails/action/unprocessable_entity_result"
+require "much-rails/boolean"
+require "much-rails/config"
+require "much-rails/date"
+require "much-rails/mixin"
+require "much-rails/time"
+require "much-rails/wrap_and_call_method"
+
+module MuchRails; end
+
+# MuchRails::Action defines the common behaviors for all view action classes.
+module MuchRails::Action
+  ForbiddenError = Class.new(StandardError)
+  ActionError = Class.new(StandardError)
+
+  include MuchRails::Mixin
+
+  mixin_included do
+    include MuchRails::Config
+    include MuchRails::WrapAndCallMethod
+
+    add_config :much_rails_action
+
+    attr_reader :params, :current_user, :request, :errors
+  end
+
+  mixin_class_methods do
+    def action_error_class
+      MuchRails::Action::ActionError
+    end
+
+    def params_root(*args)
+      much_rails_action_config.set_params_root(args) if args.any?
+      much_rails_action_config.params_root
+    end
+
+    def required_params(*args)
+      much_rails_action_config.add_required_params(args) if args.any?
+      much_rails_action_config.required_params
+    end
+
+    def date_params(*args)
+      much_rails_action_config.add_date_params(self, args) if args.any?
+      much_rails_action_config.date_params
+    end
+
+    def time_params(*args)
+      much_rails_action_config.add_time_params(self, args) if args.any?
+      much_rails_action_config.time_params
+    end
+
+    def boolean_params(*args)
+      much_rails_action_config.add_boolean_params(self, args) if args.any?
+      much_rails_action_config.boolean_params
+    end
+
+    def format(*args)
+      much_rails_action_config.set_format(args.first) if args.any?
+      much_rails_action_config.format
+    end
+
+    def on_validation(&block)
+      much_rails_action_config.add_on_validation_block(block)
+      much_rails_action_config.on_validation_blocks
+    end
+
+    def on_validation_blocks
+      much_rails_action_config.on_validation_blocks
+    end
+
+    def on_call(&block)
+      much_rails_action_config.set_on_call_block(block)
+      much_rails_action_config.on_call_block
+    end
+
+    def on_call_block
+      much_rails_action_config.on_call_block
+    end
+
+    def on_before_call(&block)
+      much_rails_action_config.add_on_before_call_block(block)
+      much_rails_action_config.on_before_call_blocks
+    end
+
+    def on_before_call_blocks
+      much_rails_action_config.on_before_call_blocks
+    end
+
+    def on_after_call(&block)
+      much_rails_action_config.add_on_after_call_block(block)
+      much_rails_action_config.on_after_call_blocks
+    end
+
+    def on_after_call_blocks
+      much_rails_action_config.on_after_call_blocks
+    end
+
+    def default_action_template_name
+      @default_action_template_name ||=
+        to_s
+          .remove(/\A#{MuchRails.config.action.namespace}/)
+          .tableize
+          .singularize
+    end
+  end
+
+  mixin_instance_methods do
+    def initialize(params: nil, current_user: nil, request: nil)
+      @params = params.to_h.with_indifferent_access
+      @current_user = current_user
+      @request = request
+      @errors = Hash.new{ |hash, key| hash[key] = [] }
+    end
+
+    def on_call
+      return @much_rails_action_result if @much_rails_action_result
+
+      catch(:halt) do
+        validate_action
+        on_action_call if valid_action?
+      end
+
+      if valid_action? && successful_action?
+        @much_rails_action_result ||= default_action_success_result
+      else
+        @much_rails_action_result = default_action_failure_result
+      end
+    end
+
+    def valid_action?
+      if @much_rails_valid_action.nil?
+        @much_rails_valid_action = errors.compact.empty?
+      end
+
+      @much_rails_valid_action
+    end
+
+    def successful_action?
+      if @much_rails_successful_action.nil?
+        @much_rails_successful_action = errors.compact.empty?
+      end
+
+      @much_rails_successful_action
+    end
+
+    private
+
+    def default_action_success_result
+      MuchRails::Action::HeadResult.new(:ok)
+    end
+
+    def default_action_failure_result
+      MuchRails::Action::UnprocessableEntityResult.new(errors)
+    end
+
+    def validate_action
+      validate_action_required_params
+      validate_action_date_params
+      validate_action_time_params
+      call_action_on_validation_blocks
+    end
+
+    def validate_action_required_params
+      self.class.required_params.each do |param_name|
+        add_required_param_error(param_name) if params[param_name].blank?
+      end
+    end
+
+    def validate_action_date_param(name)
+      __send__(name.to_s)
+    rescue MuchRails::Date::InvalidError
+      errors[name] << action_date_param_error_message
+    end
+
+    def validate_action_date_params
+      self.class.date_params.each do |param|
+        validate_action_date_param(param)
+      end
+    end
+
+    def validate_action_time_param(name)
+      __send__(name.to_s)
+    rescue MuchRails::Time::InvalidError
+      errors[name] << action_time_param_error_message
+    end
+
+    def validate_action_time_params
+      self.class.time_params.each do |param|
+        validate_action_time_param(param)
+      end
+    end
+
+    def call_action_on_validation_blocks
+      self.class.on_validation_blocks.each do |on_validation_block|
+        instance_eval(&on_validation_block)
+      end
+    end
+
+    def action_required_param_error_message
+      "can't be blank"
+    end
+
+    def action_date_param_error_message
+      "invalid date"
+    end
+
+    def action_time_param_error_message
+      "invalid time"
+    end
+
+    def on_action_call
+      call_action_on_before_call_blocks
+      catch(:halt){ instance_exec(&self.class.on_call_block) }
+      call_action_on_after_call_blocks
+    rescue *MuchRails.config.action.sanitized_exception_classes => ex
+      raise(self.class.action_error_class, ex.message, ex.backtrace, cause: ex)
+    end
+
+    def call_action_on_before_call_blocks
+      self.class.on_before_call_blocks.each do |on_before_call_block|
+        instance_eval(&on_before_call_block)
+      end
+    end
+
+    def call_action_on_after_call_blocks
+      self.class.on_after_call_blocks.each do |on_after_call_block|
+        instance_eval(&on_after_call_block)
+      end
+    end
+
+    def add_required_param_error(param_name)
+      errors[param_name] << action_required_param_error_message
+    end
+
+    def halt
+      throw(:halt)
+    end
+
+    def render(*args, **kargs)
+      template, view_model =
+        [
+          args.last.is_a?(::String) ? args.pop : nil,
+          args.pop,
+        ]
+      result_kargs =
+        {
+          template: template || default_action_template_name,
+        }.merge(**kargs)
+
+      @much_rails_action_result =
+        MuchRails::Action::RenderResult.new(view_model, *args, **result_kargs)
+      halt
+    end
+
+    def redirect_to(*args)
+      @much_rails_action_result =
+        MuchRails::Action::RedirectToResult.new(*args)
+      halt
+    end
+
+    def head(*args)
+      @much_rails_action_result =
+        MuchRails::Action::HeadResult.new(*args)
+      halt
+    end
+
+    def send_file(*args)
+      @much_rails_action_result =
+        MuchRails::Action::SendFileResult.new(*args)
+      halt
+    end
+
+    def send_data(*args)
+      @much_rails_action_result =
+        MuchRails::Action::SendDataResult.new(*args)
+      halt
+    end
+
+    def default_action_template_name
+      self.class.default_action_template_name
+    end
+  end
+
+  class MuchRailsActionConfig
+    attr_reader :params_root, :required_params, :date_params, :time_params
+    attr_reader :boolean_params, :format, :on_validation_blocks
+    attr_reader :on_call_block, :on_before_call_blocks, :on_after_call_blocks
+
+    def initialize
+      @params_root = nil
+      @required_params = []
+      @date_params = []
+      @time_params = []
+      @boolean_params = []
+
+      @format = nil
+
+      @on_validation_blocks = []
+      @on_before_call_blocks = []
+      @on_after_call_blocks = []
+      @on_call_block = ->{}
+    end
+
+    def set_params_root(value)
+      @params_root = value
+    end
+
+    def add_required_params(param_names)
+      @required_params.concat(Array.wrap(param_names))
+    end
+
+    def add_date_params(klass, param_names)
+      Array.wrap(param_names).tap do |names|
+        @date_params.concat(names)
+
+        names.each do |name|
+          klass.public_send(:define_method, name, &memoize_date_decode(name))
+        end
+      end
+    end
+
+    def add_time_params(klass, param_names)
+      Array.wrap(param_names).tap do |names|
+        @time_params.concat(names)
+
+        names.each do |name|
+          klass.public_send(:define_method, name, &memoize_time_decode(name))
+        end
+      end
+    end
+
+    def add_boolean_params(klass, param_names)
+      Array.wrap(param_names).tap do |names|
+        @boolean_params.concat(names)
+
+        names.each do |name|
+          klass.public_send(
+            :define_method, "#{name}?", &memoize_boolean_decode(name)
+          )
+        end
+      end
+    end
+
+    def set_format(value)
+      @format = value
+    end
+
+    def add_on_validation_block(block)
+      @on_validation_blocks << block
+    end
+
+    def set_on_call_block(block)
+      @on_call_block = block
+    end
+
+    def add_on_before_call_block(block)
+      @on_before_call_blocks << block
+    end
+
+    def add_on_after_call_block(block)
+      @on_after_call_blocks << block
+    end
+
+    private
+
+    def memoize_date_decode(method_name)
+      ->{
+        instance_variable_name = "@#{method_name}"
+        if instance_variable_get(instance_variable_name).nil?
+          instance_variable_set(
+            instance_variable_name,
+            MuchRails::Date.for(params[method_name]),
+          )
+        end
+        instance_variable_get(instance_variable_name)
+      }
+    end
+
+    def memoize_time_decode(method_name)
+      ->{
+        instance_variable_name = "@#{method_name}"
+        if instance_variable_get(instance_variable_name).nil?
+          instance_variable_set(
+            instance_variable_name,
+            MuchRails::Time.for(params[method_name]),
+          )
+        end
+        instance_variable_get(instance_variable_name)
+      }
+    end
+
+    def memoize_boolean_decode(method_name)
+      ->{
+        instance_variable_name = "@#{method_name}"
+        if instance_variable_get(instance_variable_name).nil?
+          instance_variable_set(
+            instance_variable_name,
+            MuchRails::Boolean.convert(params[method_name]),
+          )
+        end
+        instance_variable_get(instance_variable_name)
+      }
+    end
+  end
+end