lightrails 0.1.0.1 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2d323b4c3519ff4287bfe1e70b284130a97a3674ff50e53b5ae3394f0b721e5
-  data.tar.gz: 92c7130f73c22b76b4d1df1260b87f38879ce7255c0a8b8a0021a824d8e8f277
+  metadata.gz: 4a10f0d8a2eaa70e659e3be3ec804dd702c7326490e75b0a9d900328da3748da
+  data.tar.gz: 5a8137e45c785b8e951e5e6246a55174c01c78b57a83e51d8586300d208c25b6
 SHA512:
-  metadata.gz: 8e02d5648ca064786bc029bc139f8216919b0500d984b3f211db1e4c4bdae90a2acf6addb30e2a50dfa99275b9655cb39dfef38cf9a10824801388d2cfdf00c7
-  data.tar.gz: 3c369315c4f528930b058d64029d7f9b59625c5be9737eaaa220051507e5e5c84771bbcbab800c41d6e3c2be6a039a06ec3151f30d3a8a668168f547757947a5
+  metadata.gz: a4af89866cb3d7c7fe2aaefde579e86b58d1ef15a44d205c82d166412cc220ba98f83a52c53aacb558a1d60ac414e7f982db36505814cd332b75c6d5c43c005e
+  data.tar.gz: 376127380a11e80046e5bfcc313a6ca3e510ea09fbc805206553d86e2e118bb49c49a587b7e3e7eba93d1ee8e83b824ca400b35edea2e4295e4aa2da802d6923

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018-2019 Ryo Hashimoto
+Copyright (c) 2018-2020 Ryo Hashimoto
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -24,6 +24,10 @@ $ bin/rails generate lightrails:install
 
 Add a simple interface for obtaining multiple data used in a view.
 
+It uses Facade design pattern and takes responsibility for preparing data outside of the controller.
+
+In the example below, by using `MyPage::IndexFacade` and `MyPage::NotificationsFacade`, Active Record methods will be called outside of the `MyPageController`.
+
 ```ruby
 class Mypage::IndexFacade < ApplicationFacade
   attr_reader :current_user
@@ -41,6 +45,18 @@ class Mypage::IndexFacade < ApplicationFacade
   end
 end
 
+class MyPage::NotificationsFacade < ApplicationFacade
+  attr_reader :current_user
+
+  def initialize(payload)
+    @current_user = payload[:current_user]
+  end
+
+  def messages
+    @messages ||= current_user.messages.order(created_at: :desc).limit(10)
+  end
+end
+
 class MypageController < ApplicationController
   # for using #retrieve method
   include ActionFacade::Retrieval
@@ -50,16 +66,29 @@ class MypageController < ApplicationController
     # assign instance variables
     retrieve(facade, :active_users, :messages)
   end
+
+  def notifications
+    # You can retrieve data from the guessed facade
+    # MyPageController#notifications => MyPage::NotificationsFacade
+    payload = { current_user: current_user }
+    retrieve_from(payload, :messages)
+  end
 end
 ```
 
 ```erb
-<%# in View %>
+<%# in View (index.html.erb) %>
 
 <% @active_users.each do |user| %>
   ...
 <% end %>
 
+<% @messages.each do |user| %>
+  ...
+<% end %>
+
+<%# in View (messages.html.erb) %>
+
 <% @messages.each do |user| %>
   ...
 <% end %>
@@ -75,6 +104,10 @@ $ bin/rails generate facade mypage/index
 
 Add standarized data processing units to your Rails application.
 
+It uses Command design pattern and will be usable for various business logic (ex: user registration) in Rails applications.
+
+In the example, by using `RegistrationInteractor`, user registration process will be executed outside of model and controller.
+
 ```ruby
 class User
   attr_accessor :name
@@ -86,16 +119,15 @@ end
 
 class RegistrationInteractor < ApplicationInteractor
   def execute
-    return fail! unless payload[:name]
+    return failure! unless payload[:name]
     # complicated business logic
     # set results
     results.add(:user, User.new(name: payload[:name]))
-    success!
+    successful!
   end
 end
 
-interactor = RegistrationInteractor.execute(name: "John")
-interactor.success?   # => true
+interactor.successful?   # => true
 interactor.finished?  # => true
 user = interactor.results[:user]
 user.name # => 'John'
@@ -109,9 +141,29 @@ $ bin/rails generate interactor registration
 
 ## Active Representer
 
-Add 'represented' models to your Rails application.
-It can be used with API responses.
-You can wrap hash-like objects (OpenStruct, Hashie::Mash etc.) like below.
+It provides a class for wrapping a object and used like Model.
+You can add custom methods to the class (using the decorator pattern).
+It can be used with API responses or simple decorators.
+
+In addition, `attr_field` / `attr_one` / `attr_many` can be used for attributes.
+
+### `attr_field`
+
+Declare additional field and type to the objects.
+You can get / set field's value (converted to corresponding).
+It uses `ActiveModel::Attributes` internally.
+
+### `attr_one`
+
+Declare an associated object like has one association.
+If a representer for the object is found, the object will be wrapped by the representer.
+
+### `attr_mamy`
+
+Declare associated objects like has many association.
+If a representer for the objects is found, the objects will be wrapped by the representer.
+
+You can wrap hash-like objects (`OpenStruct`, `Hashie::Mash` etc.) like below.
 
 ```ruby
 class ActivityRepresenter < ApplicationRepresenter
@@ -123,7 +175,7 @@ end
 class UserRepresenter < ApplicationRepresenter
   attr_field :first_name, :string
   attr_field :last_name, :string
-  attr_collection :activities
+  attr_many :activities
 
   def full_name
     "#{first_name} #{last_name}"
@@ -143,7 +195,7 @@ activity.class # => ActivityRepresenter
 activity.created_on # => returns current date
 ```
 
-To create a representer, you can use the generator.
+To create a representer, you can use the Rails generator.
 
 ```
 $ bin/rails generate representer user
@@ -152,4 +204,4 @@ $ bin/rails g representer activity
 
 ## License
 
-MIT License. Copyright 2018-2019 Ryo Hashimoto.
+MIT License. Copyright 2018-2020 Ryo Hashimoto.

data/RELEASE_DATE

@@ -1 +1 @@
-2020-03-02
+2021-04-11

data/VERSION

@@ -1 +1 @@
-0.1.0.1
+0.2.4

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightrails
 version: !ruby/object:Gem::Version
-  version: 0.1.0.1
+  version: 0.2.4
 platform: ruby
 authors:
 - Ryo Hashimoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-02 00:00:00.000000000 Z
+date: 2021-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -19,7 +19,7 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,49 +29,49 @@ dependencies:
         version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: actionfacade
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.0.1
+        version: 0.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.0.1
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: actioninteractor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.0.1
+        version: 0.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.0.1
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: activerepresenter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.0.1
+        version: 0.2.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.0.1
+        version: 0.2.4
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -154,7 +154,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: Utility library including Action Facade, Action Interactor, Active Representer