action_handler 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cb17f485ca9bcfe1a0d3f8ccf1273d5a11dc0ab00f8fc24e46c4696f2c85d41
-  data.tar.gz: 2a19b8f23d01be2202a3c4bc91797d25e94afeaa318e3c54f7f4f3c62ea2c2d6
+  metadata.gz: 06a9029c41b4a4ad4284e7e91f59724885da4f47b75b561cb30ed03f76734e19
+  data.tar.gz: ffbd72526d8bf9977a6807da8c10596db7b788d0596f50c558f216cc5af38f06
 SHA512:
-  metadata.gz: e24ba8bc134de0cdec88fba626866666439db82f928dcda58cc6626bed09785ff99b938d2934eccee81651bfe8569daf49bba85c8fb2196bacffccc4f46d6435
-  data.tar.gz: 9b5269ec69e02c98fbffa7e3221a5c89ad6699443e36a34f5d7747c26c84e5687e6695ffaaaf87a7053345d1666b3a2c96c5ebf9ea75056c5442a9523fcbc293
+  metadata.gz: be995c1aea5765076ec538b25558a67c7105aa212aa9432e3bf1a83cd0b76dd6a94019dd121dcc6b00e130f6e554aa7c0997aab98bd10c52df9635fead2ce409
+  data.tar.gz: fccdd48b45bf653d32a27165945c45c6c174ec8ee872a356b22271ce4946a01f86dc1edcc39257b31426e8c23ce66b69e46d4900fd28e8abd775b59f60633a05

data/README.md

@@ -8,9 +8,9 @@ ActionHandler is a Rails plugin that helps you write controller functionalities
 
 A handler is a controller-like class. Each public method can be an action method.
 But unlike controllers, handlers inherit few methods by default.
-Intead of using super class methods such as `params`, `sessions`, you can take them as arguments.
+Instead of using super class methods such as `params`, `sessions`, you can take them as arguments.
 And you need to represent a response (data for views) as a single return value,
-instead of assiging multiple instance variables.
+instead of assigning multiple instance variables.
 
 ```ruby
 # Example
@@ -56,8 +56,7 @@ end
 
 ### Clean and clear structure
 
-- In handlers, action methods take necessary inputs as arguments and
-  return output as a return value.
+- In handlers, action methods take necessary inputs as arguments and represent output as a return value.
   So easy to read and test.
 - Handler is just a class, so you can set up any dependencies via `initialize` method.
 
@@ -67,7 +66,7 @@ end
   just by declaring them as action method's arguments.
 - You can define custom injectable arguments as well.
 
-Note that this feature is heavily inspired by [ActionArgs](https://github.com/asakusarb/action_args).
+This feature is heavily inspired by [ActionArgs](https://github.com/asakusarb/action_args).
 
 ## Motivation
 
@@ -121,11 +120,8 @@ to use basic controller functionalities like `redirect_to` or custom arguments.
 
 ## Guides
 
-See [Wiki][wiki] for detailed guides.
+- [Detail guides][wiki]
+- [Example Rails app][example]
 
 [wiki]: https://github.com/ryym/action_handler/wiki
-
-TODO:
-
-- Currently Unsupported controller features
-- Where should handlers be placed?
+[example]: https://github.com/ryym/action_handler/tree/master/examples/sample

data/lib/action_handler/args_maker.rb

@@ -1,18 +1,48 @@
 # frozen_string_literal: true
 
 module ActionHandler
-  class ArgsMaker
-    # TODO: Support optional arguments and keyword arguments.
+  class ActionArgumentError < StandardError
+    def initialize(method, details)
+      super("Arguments of #{method.owner.name}##{method.name} is invalid: #{details}")
+    end
+  end
 
-    def make_args(parameters, supplier, context: nil)
+  class ArgsMaker
+    def make_args(method, supplier, context: nil)
       supplier_args = [context].compact
-      parameters.inject([]) do |values, (_, name)|
+
+      values = []
+      keywords = {}
+
+      method.parameters.each do |kind, name|
         unless supplier.respond_to?(name)
-          raise ArgumentError, "parameter #{name} is not defined in #{supplier}"
+          raise ActionHandler::ActionArgumentError.new(
+            method,
+            "parameter #{name} is not defined in #{supplier}",
+          )
         end
 
-        values << supplier.send(name, *supplier_args)
+        case kind
+        when :req
+          values << supplier.send(name, *supplier_args)
+        when :keyreq
+          keywords[name] = supplier.send(name, *supplier_args)
+        when :opt, :key
+          raise ActionHandler::ActionArgumentError.new(method, <<~ERR)
+            Do not use optional arguments.
+            ActionHandler always injects arguments even if the value is nil,
+            so the optional values never be used.
+          ERR
+        when :rest, :keyrest
+          raise ActionHandler::ActionArgumentError.new(
+            method,
+            'rest arguments cannot be used',
+          )
+        end
       end
+
+      values << keywords unless keywords.empty?
+      values
     end
   end
 end

data/lib/action_handler/config.rb

@@ -14,24 +14,16 @@ module ActionHandler
       handler_class.instance_variable_set(CONFIG_VAR_NAME, config)
     end
 
-    attr_reader :as_controller
     attr_reader :action_methods
     attr_reader :args_suppliers
     attr_reader :custom_args
 
     def initialize
-      @as_controller = nil
       @action_methods = nil
       @args_suppliers = []
       @custom_args = {} # { method_name: proc }
     end
 
-    def as_controller=(block)
-      raise ArgumentError, 'must be proc' unless block.is_a?(Proc)
-
-      @as_controller = block
-    end
-
     def action_methods=(names)
       raise ArgumentError, 'must be array' unless names.is_a?(Array)
 

data/lib/action_handler/controller.rb

@@ -10,9 +10,8 @@ module ActionHandler
   end
 
   module ControllerExtension
-    def use_handler
-      handler = yield
-      ActionHandler::Installer.new.install(handler, self)
+    def use_handler(&block)
+      ActionHandler::Installer.new.install(self, &block)
     end
   end
 end

data/lib/action_handler/equip.rb

@@ -35,10 +35,6 @@ module ActionHandler
   end
 
   module HandlerExtension
-    def as_controller(&block)
-      ActionHandler::Config.get(self).as_controller = block
-    end
-
     def action_methods(*method_names)
       ActionHandler::Config.get(self).action_methods = method_names
     end

data/lib/action_handler/installer.rb

@@ -3,6 +3,11 @@
 require 'action_handler/args_maker'
 require 'action_handler/response_evaluator'
 
+# TODO: Add `controller_send` (to use controller methods like `send_data`)
+
+# It is better if there is a way to return streaming response.
+# (`self.response_body = ` or `response.stream.write`?)
+
 module ActionHandler
   class Installer
     attr_reader :args_maker
@@ -16,23 +21,37 @@ module ActionHandler
       @res_evaluator = res_evaluator
     end
 
-    def install(handler, ctrl_class)
-      config = ActionHandler::Config.get(handler.class) || ActionHandler::Config.new
+    def install(ctrl_class, &block)
+      ctrl_class.instance_variable_set(:@_action_handler_factory, block)
+
+      installer = self
+      initializer = Module.new.tap do |m|
+        m.define_method(:initialize) do |*args|
+          super(*args)
+          factory = self.class.instance_variable_get(:@_action_handler_factory)
+          handler = factory.call(self)
+          installer.send(:setup, self, handler)
+        end
+      end
 
-      ctrl_class.class_eval(&config.as_controller) if config.as_controller
+      ctrl_class.prepend initializer
+    end
+
+    private def setup(ctrl, handler)
+      config = ActionHandler::Config.get(handler.class) || ActionHandler::Config.new
 
       actions = action_methods(handler, config)
       args_supplier = args_supplier(config)
 
       actions.each do |name|
         installer = self
-        ctrl_class.send(:define_method, name) do
+
+        # If we use `define_singleton_method`, methods don't work correctly.
+        # I don't know Rails internal details but
+        # Rails requires methods to be defined in a class.
+        ctrl.class.define_method(name) do
           method = handler.method(name)
-          args = installer.args_maker.make_args(
-            method.parameters,
-            args_supplier,
-            context: self,
-          )
+          args = installer.args_maker.make_args(method, args_supplier, context: self)
           res = method.call(*args)
           installer.res_evaluator.evaluate(self, res)
         end

data/lib/action_handler/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: action_handler
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - ryym
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2018-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -85,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="