lightrails 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0f59fc251ed38f0401596419fb3b9b21f896a059560a0d37f6a669f060d7d0b
-  data.tar.gz: b6b52941c6637741b8f11d83ff9b79806eb452f44eafc1ac5ab095ad4a60419a
+  metadata.gz: f9498da26782c4d6ecffcff083be4c80f71c0b252c4640ffb4aac5eaf5c8d818
+  data.tar.gz: 48a3522f9d95d0702a11b0b6039ceb97bbbf1e337b1b9b33b8a55593e7b74087
 SHA512:
-  metadata.gz: 33538eab110372881f27898622f098d3c576aa7e9a5dd422fe39e33eef7196a4a09b5565dca7e2b4561b87e31eefe71ecdb825a3d08955f00b2800dc7375a530
-  data.tar.gz: d83862f53ca925a90ce7d26c61a9e6f2ffc9b2c1822d7cd288b930d6095fa056a9c76a583c12a856ee2dbd4a18f355de58bd64ffc1db82c5b6d3879ad122a397
+  metadata.gz: b9af6ba83d01260fd00412912f72dffbc60ded387982e17967680e76fede3a0d719c6e1ff1e9d7aac37e9aee8c22270ca0b97f0c67c38215eabedce3f9067cd1
+  data.tar.gz: db1eebaba7422bc38d0e698f184a252f37598adf09f58cd9064426913333b3911b6f0854cf2b3c14bfbc23b0ee9eb89549af695883f9c248f6611ca698028190

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,6 +1,56 @@
 # Lightrails
 
-Utility library for Ruby on Rails
+Lightrails is a utility library including Action Interactor, Active Representer etc.  
+It aims to provide more modular layers for Ruby on Rails applications.
+
+## Getting Started
+
+Add `lightrails` to your Rails project's Gemfile and `bundle install`.
+
+```ruby
+gem "lightrails"
+```
+
+Run generators.
+
+```
+$ bin/rails generate action_facade:install
+$ bin/rails generate action_interactor:install
+$ bin/rails generate active_representer:install
+```
+
+## Action Facade
+
+Add a simple interface for obtaining multiple data in controller.
+
+```ruby
+class Mypage::IndexFacade < ApplicationFacade
+  attr_reader :current_user
+
+  def initialize(params)
+    @current_user = params[:current_user]
+  end
+
+  def active_user
+    @all_user ||= User.active.order(login_at: :desc).limit(10)
+  end
+
+  def messages
+    @messages ||= current_user.messages.order(created_at: :desc).limit(10)
+  end
+end
+
+# in MypageController
+def index
+  @facade = Mypage::IndexFacade.new(current_user: current_user)
+end
+```
+
+To create an facade, you can use the generator.
+
+```
+$ bin/rails generate facade mypage/index
+```
 
 ## Action Interactor
 
@@ -15,7 +65,7 @@ class User
   end
 end
 
-class RegistrationInteractor < ActionInteractor::Base
+class RegistrationInteractor < ApplicationInteractor
   def execute
     return unless params[:name]
     add_result(:user, User.new(name: params[:name]))
@@ -24,25 +74,41 @@ class RegistrationInteractor < ActionInteractor::Base
   end
 end
 
-interactor = RegistrationInteractor.execute(params)
+interactor = RegistrationInteractor.execute(name: "John")
 interactor.success?   # => true
 interactor.completed? # => true
 user = interactor.result[:user]
 user.name # => 'John'
 ```
 
+To create an interactor, you can use the generator.
+
+```
+$ bin/rails generate interactor registration
+```
+
 ## Active Representer
 
 Add an API model layer to your Rails application.
 
 ```ruby
-class UserRepresenter < ActiveRepresenter::Base
+class UserRepresenter < ApplicationRepresenter
   def full_name
     "#{first_name} #{last_name}"
   end
 end
 
-user = OpenStruct.new(first_name: 'John', last_name: 'Appleseed')
+user = OpenStruct.new(first_name: "John", last_name: "Appleseed")
 representer = UserRepresenter.new(user)
 representer.full_name # => 'John Appleseed'
 ```
+
+To create a representer, you can use the generator.
+
+```
+$ bin/rails generate representer user
+```
+
+## License
+
+MIT License. Copyright 2018 Ryo Hashimoto.

data/RELEASE_DATE

@@ -0,0 +1 @@
+2018-10-06

data/VERSION

@@ -0,0 +1 @@
+0.0.6

data/lib/generators/action_facade/install_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module ActionFacade
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_application_facade_file
+        template "application_facade.rb", File.join("app/facades/application_facade.rb")
+      end
+    end
+  end
+end

data/lib/generators/action_facade/templates/application_facade.rb

@@ -0,0 +1,2 @@
+class ApplicationFacade < ActionFacade::Base
+end

data/lib/generators/action_interactor/install_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module ActionInteractor
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_application_interactor_file
+        template "application_interactor.rb", File.join("app/interactors/application_interactor.rb")
+      end
+    end
+  end
+end

data/lib/generators/action_interactor/templates/application_interactor.rb

@@ -0,0 +1,2 @@
+class ApplicationInteractor < ActionInteractor::Base
+end

data/lib/generators/active_representer/install_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module ActiveRepresenter
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_application_representer_file
+        template "application_representer.rb", File.join("app/representers/application_representer.rb")
+      end
+    end
+  end
+end

data/lib/generators/active_representer/templates/application_representer.rb

@@ -0,0 +1,2 @@
+class ApplicationRepresenter < ActiveRepresenter::Base
+end

data/lib/generators/facade_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Rails
+  module Generators
+    class FacadeGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_facade_file
+        template "facade.tt", File.join("app/facades", class_path, "#{file_name}_facade.rb")
+      end
+    end
+  end
+end

data/lib/generators/interactor_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Rails
+  module Generators
+    class InteractorGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_interactor_file
+        template "interactor.tt", File.join("app/interactors", class_path, "#{file_name}_interactor.rb")
+      end
+    end
+  end
+end

data/lib/generators/representer_generator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+module Rails
+  module Generators
+    class RepresenterGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_representer_file
+        template "representer.tt", File.join("app/representers", class_path, "#{file_name}_representer.rb")
+      end
+    end
+  end
+end

data/lib/generators/templates/facade.tt

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class <%= class_name %>Facade < ApplicationFacade
+end
+<% end -%>

data/lib/generators/templates/interactor.tt

@@ -0,0 +1,7 @@
+<% module_namespacing do -%>
+class <%= class_name %>Interactor < ApplicationInteractor
+  def execute
+    super
+  end
+end
+<% end -%>

data/lib/generators/templates/representer.tt

@@ -0,0 +1,4 @@
+<% module_namespacing do -%>
+class <%= class_name %>Representer < ApplicationRepresenter
+end
+<% end -%>

data/lib/lightrails.rb

@@ -0,0 +1,3 @@
+require 'actionfacade'
+require 'actioninteractor'
+require 'activerepresenter'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lightrails
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Ryo Hashimoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-05 00:00:00.000000000 Z
+date: 2018-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,34 +24,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: actionfacade
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: actioninteractor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: activerepresenter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,14 +80,31 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.3.0
-description: Lightrails is a utility library including ActionInteractor, ActiveRepresenter
-  etc. for Ruby on Rails.
+description: Lightrails is a utility library including Action Facade, Action Interactor,
+  Active Representer etc. It aims to provide more modular layers for Ruby on Rails
+  applications.
 email: ryohashimoto@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
+- RELEASE_DATE
+- VERSION
+- lib/generators/action_facade/install_generator.rb
+- lib/generators/action_facade/templates/application_facade.rb
+- lib/generators/action_interactor/install_generator.rb
+- lib/generators/action_interactor/templates/application_interactor.rb
+- lib/generators/active_representer/install_generator.rb
+- lib/generators/active_representer/templates/application_representer.rb
+- lib/generators/facade_generator.rb
+- lib/generators/interactor_generator.rb
+- lib/generators/representer_generator.rb
+- lib/generators/templates/facade.tt
+- lib/generators/templates/interactor.tt
+- lib/generators/templates/representer.tt
+- lib/lightrails.rb
 homepage: https://github.com/ryohashimoto/lightrails
 licenses:
 - MIT
@@ -97,5 +128,6 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Utility library for Ruby on Rails
+summary: Utility library including Action Facade, Action Interactor, Active Representer
+  etc. (for Ruby on Rails)
 test_files: []