swamp-rails-actions 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f77d3514fb0654afcbf11ad9e4d24a5a28c14ee3940792589f4821c4e504f8cd
+  data.tar.gz: f9a80f1ed3d7c587a18ecfd14420a3515de8677afd7156a289c253dcd5c52be9
+SHA512:
+  metadata.gz: 3ab57d6cf5c3afaf6c0f09df82633f8c52b27b11c72084b7da07fb22c242b82d1c95bac51b7dfdb785aa59a16380aa0b597c9a33bc535624f175a8d4ae9faf5d
+  data.tar.gz: c0f2ee2ffa56db9a1d06df59546b0ec6f1c86af4d56358b699e906369f4fa6419f8478c3563675512566a71ee04e6baeba0eb968352c7539a1c34900d631be72

data/lib/swamp-rails-actions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Swamp
+end
+
+require_relative 'swamp/rails_actions/action'
+require_relative 'swamp/rails_actions/controller'

data/lib/swamp/rails_actions/action.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require_relative './action/flash'
+require_relative './action/parameters'
+require_relative './action/routes'
+
+module Swamp
+  module Action
+    def self.included(base)
+      base.extend ClassMethods
+      base.include Swamp::Action::Parameters
+      base.include Swamp::Action::Routes
+      base.include Swamp::Action::Flash
+    end
+
+    class Result
+      attr_reader :template, :redirection_path, :redirection_options
+
+      def render(template)
+        @template = template
+      end
+
+      def redirect_to(path, **options)
+        @redirection_path = path
+        @redirection_options = options
+      end
+
+      def prepare!(payload)
+        exposures.merge!(payload)
+        self
+      end
+
+      def redirect?
+        !redirection_path.nil?
+      end
+
+      def render?
+        !template.nil?
+      end
+
+      def exposures
+        @exposures ||= Hash[]
+      end
+
+      protected
+
+      def method_missing(method_name, *)
+        exposures.fetch(method_name) { super }
+      end
+
+      def respond_to_missing?(method_name, _include_all)
+        exposures.key?(method_name.to_sym) ? true : super
+      end
+    end
+
+    def call(args = Hash[])
+      prepare(args)
+
+      catch :done do
+        _call
+      end
+
+      finalize(args)
+    end
+
+    def _call; end
+
+    private
+
+    def prepare(kwargs)
+      @request = kwargs[:request]
+      @__result = ::Swamp::Action::Result.new
+    end
+
+    def expose(*names)
+      names.each do |name|
+        send(name) if self.class.exposures.include?(name)
+      end
+    end
+
+    def finalize(*)
+      @__result.prepare!(_exposures)
+    end
+
+    def _exposures
+      Hash[].tap do |result|
+        self.class.exposures.each do |name, ivar|
+          result[name] = respond_to?(name) ? send(name) : instance_variable_get(ivar)
+        end
+      end
+    end
+
+    def render(template)
+      @__result.render(template)
+      throw :done
+    end
+
+    def redirect_to(path, **options)
+      @__result.redirect_to(path, options)
+      throw :done
+    end
+
+    module ClassMethods
+      attr_reader :exposures
+
+      def self.extended(interactor)
+        interactor.class_eval do
+          self.exposures = {}
+        end
+      end
+
+      def call(args = Hash[])
+        new.call(args)
+      end
+
+      def expose(*instance_variable_names)
+        instance_variable_names.each do |name|
+          exposures[name.to_sym] = "@#{name}"
+        end
+      end
+
+      protected
+
+      attr_writer :exposures
+    end
+  end
+end

data/lib/swamp/rails_actions/action/flash.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Swamp
+  module Action
+    module Flash
+      def self.included(base)
+        base.expose :flash
+      end
+
+      def flash_alert!(message)
+        flash[:alert] = message
+      end
+
+      def flash_notice!(message)
+        flash[:notice] = message
+      end
+
+      def flash
+        @flash ||= Hash[]
+      end
+    end
+  end
+end

data/lib/swamp/rails_actions/action/parameters.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Swamp
+  module Action
+    module Parameters
+      def self.included(base)
+        base.extend ClassMethods
+        base.expose :validation_result
+      end
+
+      private
+
+      attr_reader :input, :validation_result
+
+      def prepare(params)
+        super
+        return true if self.class.param_class.nil?
+
+        @validation_result = self.class.param_class.call(params)
+        @input = validation_result.output
+      end
+
+      def method_missing(method_name, *)
+        input.fetch(method_name.to_sym) { super }
+      end
+
+      def respond_to_missing?(method_name, _include_all)
+        input.key?(method_name.to_sym) ? true : super
+      end
+
+      module ClassMethods
+        attr_reader :param_class
+
+        def params(&block)
+          @param_class = Dry::Validation.Form do
+            instance_exec(&block)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swamp/rails_actions/action/routes.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Swamp::Action
+  module Routes
+    def router
+      @router ||= Router.new
+    end
+
+    def path(name, options = Hash[])
+      router.send(:"#{name}_path", router_default_url_options.merge(options))
+    end
+
+    def url(name, options = Hash[])
+      router.send(:"#{name}_url", router_default_url_options.merge(options))
+    end
+
+    def router_default_url_options
+      Hash[].tap do |opts|
+        opts[:host] = @request.host if @request
+      end
+    end
+
+    class Router
+      include Rails.application.routes.url_helpers
+    end
+  end
+end

data/lib/swamp/rails_actions/controller.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module Swamp
+  module Controller
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    def action!(klass, **kwargs)
+      result = klass.new.call(params.to_unsafe_h.merge(request: request, **kwargs))
+
+      setup_exposures!(klass, result)
+
+      if result.render?
+        render_result(result, klass)
+      elsif result.redirect?
+        redirect_result(result, klass)
+      end
+    end
+
+    private
+
+    def render_result(result, klass)
+      setup_flash_now(result, klass)
+      render result.template
+    end
+
+    def redirect_result(result, klass)
+      setup_flash(result, klass)
+      redirect_to result.redirection_path, result.redirection_options
+    end
+
+    def setup_exposures!(klass, result)
+      klass.exposures.each do |key, value|
+        instance_variable_set(value, result.exposures[key])
+      end
+    end
+
+    def setup_flash_now(result, klass)
+      return unless klass.exposures.key?(:flash)
+
+      result.flash.each do |type, message|
+        flash.now[type] = message
+      end
+    end
+
+    def setup_flash(result, klass)
+      return unless klass.exposures.key?(:flash)
+
+      result.flash.each do |type, message|
+        flash[type] = message
+      end
+    end
+
+    module ClassMethods
+      def action!(name, klass, *args)
+        define_method name do
+          input = Hash[args.map { |k| [k, send(k)] }]
+          action! klass, **input
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: swamp-rails-actions
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marion Duprey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12'
+description: Split your controllers to actions
+email: marion@lynary.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/swamp-rails-actions.rb
+- lib/swamp/rails_actions/action.rb
+- lib/swamp/rails_actions/action/flash.rb
+- lib/swamp/rails_actions/action/parameters.rb
+- lib/swamp/rails_actions/action/routes.rb
+- lib/swamp/rails_actions/controller.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Split your controllers to actions
+test_files: []