actionfacade 0.0.17.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3af09415afc5078d3a98c2bb8042ef29adf85ba074021877e776f1c481381349
-  data.tar.gz: 69b47890f5458a4a310246ded5db649d077dc6e65bc8c66720c2d7474c44f1e2
+  metadata.gz: 99906896fc350593d51d0d42f39e1ee6485da45f1e489978b10576495c51761e
+  data.tar.gz: 36035451577d796e903d9bf827fb83c61330b58e0bf71da07ae66d0c6fabd34d
 SHA512:
-  metadata.gz: 42d4357c1a77324ac3a580aed4767fdca916efe6e4d390fc558523cdb34d6d717fbc7d319067b0708ee5131c7df138215835bc522458950e5c233b05999e6f94
-  data.tar.gz: e2ee8b5015e17b40b594ba9db188b68c7ea619db1262f1201f4dce4a494fc9340c331b488bbbfb8c0b05cc5829cea769326276e0dbb11c08b766ef78ca11deda
+  metadata.gz: ce6689c0718cf998e3a635791b7b427653ec64b49bf75db90031ffb4bc09af0cda375cb879bf0437865104a74d193667bf025954ffd774ab442c2ff9abbfdc98
+  data.tar.gz: e5f9b334d397a2690d47d2325b38286a64c82d2d2008a903547b36a7fa655e23d64fb658d1084a49433e4312a684dcaab47f483d8ce3f671de2e1d5b3ca9ccaf

data/actionfacade.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |s|
 
   s.add_dependency "bundler", ">= 1.3"
   s.add_development_dependency "rake", "~> 0"
+  s.add_development_dependency "test-unit", ">= 3.3"
 end

data/lib/action_facade/base.rb

@@ -1,12 +1,37 @@
 # frozen_string_literal: true
 
 module ActionFacade
+  # == Action \Facade \Base
+  #
+  # This is only a base class for extract data from input (payload).
+  # This can be inherited to another class and you can implement
+  # some mothods for obtaining data.
+  # In Ruby on Rails, you can implemented Active Record query methods
+  # to the inherited class.
+  # For example
+  #
+  #   class Mypage::IndexFacade < ActionFacade::Base
+  #     attr_reader :current_user
+  #
+  #     def initialize(payload)
+  #       @current_user = payload[:current_user]
+  #     end
+  #
+  #     def active_users
+  #       @active_users ||= User.active.order(login_at: :desc).limit(10)
+  #     end
+  #
+  #     def messages
+  #       @messages ||= current_user.messages.order(created_at: :desc).limit(10)
+  #     end
+  #   end
+  #
   class Base
-    attr_reader :params
+    attr_reader :payload
 
-    # pass controller's params by default
-    def initialize(params)
-      @params = params
+    # Initialize with payload
+    def initialize(payload)
+      @payload = payload
     end
   end
 end

data/lib/action_facade/retrieval.rb

@@ -1,7 +1,19 @@
 # frozen_string_literal: true
 
 module ActionFacade
+  # == Action \Facade \Retrieval
+  #
+  # This module provides `retrieve` method to the class which includes the module.
+  # The `retrieve` method can be used for obtaining data from the external facade.
+  # In Ruby on Rails controllers, this module can be used for assing many instance
+  # variables by extracting Active Record queries to the class that is inherited
+  # from ActionFacade::Base.
   module Retrieval
+    # Retrieve data from `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(facade, *variable_names)
       variable_names.each do |name|
         instance_variable_set("@#{name}", facade.send(name.to_sym))

data/lib/actionfacade.rb

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
 
-require "action_facade/base"
-require "action_facade/retrieval"
+$:.unshift File.dirname(__FILE__)
+
+module ActionFacade
+  autoload :Base, "action_facade/base"
+  autoload :Retrieval, "action_facade/retrieval"
+end

data/test/base_test.rb

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

data/test/inheritance_test.rb

@@ -1,5 +1,5 @@
 require "test/unit"
-require "actionfacade"
+require_relative "../lib/actionfacade"
 
 class UserFacade < ActionFacade::Base
   USER_DATA = [{ id: 1, name: "john" }, { id: 2, name: "taro" }]
@@ -15,25 +15,25 @@ end
 
 class InheritanceTest < Test::Unit::TestCase
   test ".new does not raise error" do
-    params = {}
-    assert_nothing_raised { UserFacade.new(params) }
+    payload = {}
+    assert_nothing_raised { UserFacade.new(payload) }
   end
 
-  test "#params returns user object" do
-    params = {}
-    facade = UserFacade.new(params)
-    assert_equal(facade.params, params)
+  test "#payload returns user object" do
+    payload = {}
+    facade = UserFacade.new(payload)
+    assert_equal(facade.payload, payload)
   end
 
   test "#all returns all data" do
-    params = {}
-    facade = UserFacade.new(params)
+    payload = {}
+    facade = UserFacade.new(payload)
     assert_equal(facade.all, [{ id: 1, name: "john" }, { id: 2, name: "taro" }])
   end
 
   test "#taro returns taro's data" do
-    params = {}
-    facade = UserFacade.new(params)
+    payload = {}
+    facade = UserFacade.new(payload)
     assert_equal(facade.taro, { id: 2, name: "taro" })
   end
 end

data/test/retrieval_test.rb

@@ -2,9 +2,9 @@ require "test/unit"
 require_relative "../lib/action_facade/base.rb"
 require_relative "../lib/action_facade/retrieval.rb"
 
-class UserFacade < ActionFacade::Base
-  USER_DATA = [{ id: 1, name: "john" }]
+USER_DATA = [{ id: 1, name: "john" }]
 
+class UserFacade < ActionFacade::Base
   def john
     USER_DATA.find { |user| user[:name] == "john" }
   end
@@ -16,8 +16,8 @@ class UsersController
   attr_reader :john
 
   def show
-    params = {}
-    facade = UserFacade.new(params)
+    payload = {}
+    facade = UserFacade.new(payload)
     retrieve(facade, :john)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionfacade
 version: !ruby/object:Gem::Version
-  version: 0.0.17.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Ryo Hashimoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-25 00:00:00.000000000 Z
+date: 2020-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
 description: Action Facade provides a simple interface for data required by view /
   controller.
 email: ryohashimoto@gmail.com