actionfacade 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3bedbc973b233f70841ecf8a3b557d3f0bb6302306f760046138414f057a5501
-  data.tar.gz: 86f186bfab9dc90c9e92be9f77bfc31c6f80193085b2bd53430e9e99f65831a7
+  metadata.gz: acc5cc8f790b16e138491a94522c420b0894908388225268045213148ed5e234
+  data.tar.gz: d09cd8cd2b31eefa8074bbe33b1568fb65334335f85b0c70ec60d7b31495a975
 SHA512:
-  metadata.gz: bf199820d39bef1f3f7fff9ede02988b9553eb10abad19480c95eb4219e8d0997b927686e0ec74f21b313f7326e56e8868c8923614cf1302f39bb8ab9545e976
-  data.tar.gz: 6f36c26b988e1a1c32dc214718d03cc642270c294cca7984d4fc6f0904b0e9cbbdbeae861eb49783e092f60b01b55eaf41f995075c16d50866803734e6e1a4df
+  metadata.gz: 25e92d8db525bc03b0d93d3e24b718107f27a08cd008c2c408916dabaa685d9bd192bef7483cf65565e648e90d19d0d13e3ea247f0e356b00125342a4f9c87e0
+  data.tar.gz: 9732bb3fb425292463bbf2bb65e7a8f4f86227932b07d9965e547300d494b4b12986be44ae400266943491fc8e1dc5ced5c1daa1688e54e924367d3c27e871d2

data/actionfacade.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.test_files  = s.files.grep(/^test/)
 
   s.add_dependency "bundler", ">= 1.3"
+  s.add_dependency "activesupport", ">= 5.2"
   s.add_development_dependency "rake", ">= 12.3.3"
   s.add_development_dependency "test-unit", ">= 3.3"
 end

data/lib/action_facade/base.rb

@@ -30,7 +30,7 @@ module ActionFacade
     attr_reader :payload
 
     # Initialize with payload
-    def initialize(payload)
+    def initialize(payload = {})
       @payload = payload
     end
   end

data/lib/action_facade/retrieval.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "active_support/core_ext/string/inflections"
+
 module ActionFacade
   # == Action \Facade \Retrieval
   #
@@ -11,13 +13,80 @@ module ActionFacade
   module Retrieval
     # Retrieve data from `facade`
     #
+    # If `facade_or_other` is a facade, retrieve data from it.
+    # If it is a string or a symbol, it will be merged to `variable_names` and
+    # retrieve_from method called with controller params.
+    # If it is a hash, retrieve_from method will be called with the hash as a payload.
+    #
     # `variable_names` are symbols for the method names in the facade and
     # they will be set as instance variables in the class that
     # includes the module.
-    def retrieve(facade, *variable_names)
-      variable_names.each do |name|
+    def retrieve(facade_or_other, *variable_names)
+      facade = nil
+      names = variable_names.dup
+      case facade_or_other
+      when ActionFacade::Base
+        facade = facade_or_other
+      when String, Symbol
+        if defined?(params)
+          names.unshift(facade_or_other)
+          return retrieve_from(params, *names)
+        else
+          raise ArgumentError.new("Can't call the method with #{facade_or_other.class} if params is undefined.")
+        end
+      when Hash
+        return retrieve_from(facade_or_other, *variable_names)
+      else
+        raise ArgumentError.new("First parameter must be instance of ActionFacade::Base, String, Symbol or Hash")
+      end
+      names.each do |name|
         instance_variable_set("@#{name}", facade.send(name.to_sym))
       end
     end
+
+    # Retrieve data from given payload
+    #
+    # If the class which includes the module is Rails controller,
+    # guessed facade name will be "Controller" is replaced by the action name + "Facade".
+    # If the class is not Rails controller, the name will be suffixed by "Facade".
+    #
+    # `payload` is the initialization parameter for the facade.
+    #
+    # `variable_names` are symbols for the method names in the facade and
+    # they will be set as instance variables in the class that
+    # includes the module.
+    def retrieve_from(payload, *variable_names)
+      facade = guess_facade
+      if facade.nil?
+        raise FacadeNotFoundError.new("Could not find Facade class #{guess_facade_name}.")
+      end
+      retrieve(facade.new(payload), *variable_names)
+    end
+
+    class FacadeNotFoundError < StandardError; end
+
+    private
+
+    def guess_facade
+      facade_name = guess_facade_name
+      begin
+        facade_name.constantize
+      rescue NameError
+        nil
+      end
+    end
+
+    def guess_facade_name
+      klass_name = self.class.name
+      if klass_name.end_with?("Controller")
+        if defined?(params) && params[:action]
+          klass_name.delete_suffix("Controller") + "::#{params[:action].camelize}Facade"
+        else
+          klass_name.delete_suffix("Controller") + "Facade"
+        end
+      else
+        klass_name + "Facade"
+      end
+    end
   end
 end

data/test/base_test.rb

@@ -1,15 +1,12 @@
-require "test/unit"
-require_relative "../lib/actionfacade"
+require_relative "./test_helper"
 
 class BaseTest < Test::Unit::TestCase
   test ".new does not raise error" do
-    payload = {}
-    assert_nothing_raised { ActionFacade::Base.new(payload) }
+    assert_nothing_raised { ActionFacade::Base.new }
   end
 
   test "#payload returns original payload object" do
-    payload = {}
-    facade = ActionFacade::Base.new(payload)
-    assert_equal(facade.payload, payload)
+    facade = ActionFacade::Base.new
+    assert_equal(facade.payload, {})
   end
 end

data/test/inheritance_test.rb

@@ -1,5 +1,4 @@
-require "test/unit"
-require_relative "../lib/actionfacade"
+require_relative "./test_helper"
 
 class UserFacade < ActionFacade::Base
   USER_DATA = [{ id: 1, name: "john" }, { id: 2, name: "taro" }]

data/test/rails_app/retrieval_test.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+require_relative "./test_app"
+
+module RailsApp
+  USER_DATA = [{ id: 1, name: "john" }, { id: 2, name: "bob" }]
+end
+
+module Home; end
+
+class Home::IndexFacade < ActionFacade::Base
+  def all_users
+    RailsApp::USER_DATA
+  end
+end
+
+class HomeController < ActionController::Base
+  include Rails.application.routes.url_helpers
+  include ActionFacade::Retrieval
+
+  def index
+    case params[:retrieve]
+    when "facade"
+      facade = Home::IndexFacade.new
+      retrieve(facade, :all_users)
+    when "string"
+      retrieve("all_users")
+    when "symbol"
+      retrieve(:all_users)
+    when "hash"
+      retrieve({}, :all_users)
+    else
+      retrieve_from({}, :all_users)
+    end
+    render plain: @all_users
+  end
+end
+
+require "rack/test"
+
+module RailsApp; end
+
+class RailsApp::RetrievalTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  test "@all_users is set after retrieve_from({}, :all_users)" do
+    get "/"
+    assert_equal(last_response.body, RailsApp::USER_DATA.to_s)
+  end
+
+  test "@all_users is set after retrieve(facade, :all_users)" do
+    get "/", params: { retrieve: "facade" }
+    assert_equal(last_response.body, RailsApp::USER_DATA.to_s)
+  end
+
+  test "@all_users is set after retrieve(:all_users)" do
+    get "/", params: { retrieve: "symbol" }
+    assert_equal(last_response.body, RailsApp::USER_DATA.to_s)
+  end
+
+  test "@all_users is set after retrieve(\"all_users\")" do
+    get "/", params: { retrieve: "string" }
+    assert_equal(last_response.body, RailsApp::USER_DATA.to_s)
+  end
+
+  test "@all_users is set after retrieve({}, :all_users)" do
+    get "/", params: { retrieve: "hash" }
+    assert_equal(last_response.body, RailsApp::USER_DATA.to_s)
+  end
+
+  private
+
+  def app
+    Rails.application
+  end
+end

data/test/rails_app/test_app.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "action_controller/railtie"
+
+class TestApp < Rails::Application
+  config.root = __dir__
+  config.hosts << "example.org"
+  secrets.secret_key_base = "secret_key_base"
+
+  config.logger = Logger.new($stdout)
+  Rails.logger  = config.logger
+
+  routes.draw do
+    get "/" => "home#index"
+  end
+end

data/test/retrieval_test.rb

@@ -1,15 +1,21 @@
-require "test/unit"
-require_relative "../lib/action_facade/base.rb"
-require_relative "../lib/action_facade/retrieval.rb"
+require_relative "./test_helper"
 
-USER_DATA = [{ id: 1, name: "john" }]
+USER_DATA = [{ id: 1, name: "john" }, { id: 2, name: "bob" }]
 
-class UserFacade < ActionFacade::Base
+class UsersFacade < ActionFacade::Base
   def john
     USER_DATA.find { |user| user[:name] == "john" }
   end
 end
 
+module Admin
+  class ShowFacade < ActionFacade::Base
+    def bob
+      USER_DATA.find { |user| user[:name] == "bob" }
+    end
+  end
+end
+
 class UsersController
   include ActionFacade::Retrieval
 
@@ -17,9 +23,26 @@ class UsersController
 
   def show
     payload = {}
-    facade = UserFacade.new(payload)
+    facade = UsersFacade.new(payload)
     retrieve(facade, :john)
   end
+
+  def show_symbol
+    retrieve(:john)
+  end
+
+  def show_string
+    retrieve("john")
+  end
+
+  def show_hash
+    retrieve({}, :john)
+  end
+
+  def show_from
+    payload = {}
+    retrieve_from(payload, :john)
+  end
 end
 
 class RetrievalTest < Test::Unit::TestCase
@@ -33,4 +56,36 @@ class RetrievalTest < Test::Unit::TestCase
     controller.show
     assert_equal(controller.john, { id: 1, name: "john" })
   end
+
+  test "raised exception when retrieve(:john)" do
+    controller = UsersController.new
+    assert_nil(controller.john)
+    error = assert_raises ArgumentError do
+      controller.show_symbol
+    end
+    assert_equal(error.message, "Can't call the method with Symbol if params is undefined.")
+  end
+
+  test "raised exception when retrieve(\"john\")" do
+    controller = UsersController.new
+    assert_nil(controller.john)
+    error = assert_raises ArgumentError do
+      controller.show_string
+    end
+    assert_equal(error.message, "Can't call the method with String if params is undefined.")
+  end
+
+  test "@john is set after retrieve({}, :john)" do
+    controller = UsersController.new
+    assert_nil(controller.john)
+    controller.show_hash
+    assert_equal(controller.john, { id: 1, name: "john" })
+  end
+
+  test "@john is set after retrieve_from(payload, :john)" do
+    controller = UsersController.new
+    assert_nil(controller.john)
+    controller.show_from
+    assert_equal(controller.john, { id: 1, name: "john" })
+  end
 end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require "test/unit"
+require_relative "../lib/actionfacade"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionfacade
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.5
 platform: ruby
 authors:
 - Ryo Hashimoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2021-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +80,10 @@ files:
 - lib/actionfacade.rb
 - test/base_test.rb
 - test/inheritance_test.rb
+- test/rails_app/retrieval_test.rb
+- test/rails_app/test_app.rb
 - test/retrieval_test.rb
+- test/test_helper.rb
 homepage: https://github.com/ryohashimoto/lightrails
 licenses:
 - MIT
@@ -86,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.8.11
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Action Facade provides a simple interface for data required by view / controller
@@ -94,4 +111,7 @@ summary: Action Facade provides a simple interface for data required by view / c
 test_files:
 - test/base_test.rb
 - test/inheritance_test.rb
+- test/rails_app/retrieval_test.rb
+- test/rails_app/test_app.rb
 - test/retrieval_test.rb
+- test/test_helper.rb