lean_interactor 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c50edc0cf5c6e91b20bf9913c3a9e59ac2da7078
-  data.tar.gz: 608b69f754e946155c5630c0522665c1bba55f9f
+  metadata.gz: e386d723035689112cf60bb40c222c03d1d418af
+  data.tar.gz: 915ee3699070a92ca364289c2c00fc6a6b6b94e6
 SHA512:
-  metadata.gz: e899c7c035c4d02da7105d8782fdf679b40cbf100963afd9643ed4063e4ea9da191f7d5b5013ade6d8acc0879ddb38d31da2d3148c446bcd295e06da5c02ae2a
-  data.tar.gz: 76b6d6f65c2defe52f9ec860a0b41bbeaafcbe017fcb79f2e973ad9c58c24a24b1ba3972e5c569eebe3ec393002989fc5377d878b8390e50ea462005314d72dd
+  metadata.gz: 3af4a1b194dd3b29fa2aa89e5a636d0397a93528c3676c619466c9b65483ac804acd3f7d7f19896c23a8ab4365db02f28db155677b7317d6ed6fee007c310774
+  data.tar.gz: 7716531b33cb78891ffaf496dfc8623c6304a43b5609f3b70548c34a62cf9636a9abaf6251c02990e95a4f8c62a1da977fb4690f73707933a1459d5e1d187150

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lean_interactor (0.1.2)
+    lean_interactor (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/Makefile

@@ -1,10 +1,13 @@
-build:
-	rm -rf *.gem
-	rm -rf pkg
-	gem build lean_interactor.gemspec
-
 test:
 	@ rspec
 
+build: clear
+	@ bundle
+	@ gem build *.gemspec
+
 release: test build
 	@ gem push *.gem
+
+clear:
+	@ rm -rf pkg
+	@ rm -rf *.gem

data/README.md

@@ -1,38 +1,32 @@
 # LeanInteractor
 
-Interactor is a stateless class intended to do one action. It is like function in functional languages. This gem is created to reduce amount of the boilerplate code needed to define an interactor:
+Interactor is a stateless class intended to do one action. It is like function in functional languages.
 
-##### Without LeanInteractor
-```ruby
-class Emails::Send
-  def self.for(user)
-    new(user).run
-  end
+If you are working with Rails, interactor is a perfect place to put your bussines logic and keep controllers and models light and clean.
 
-  attr_reader :user
+## Usage
 
-  def initialize(user)
-    @user = user
-  end
+Include `LeanInteractor` to your class and define `run` method:
 
-  def run
-    # email sending logic goes here
-  end
-```
-
-##### With LeanInteractor
 ```ruby
-class Emails::Send
+class Users::Create
   include LeanInteractor
 
-  initialize_with :user
+  initialize_call :user_params
 
   def run
-    # email sending logic goes here
+    # user creation logic goes here
   end
 end
 ```
 
+And then call your interactor:
+```ruby
+Users::Create.call(user_params)
+```
+
+`LeanInteractor` provides three helper methods: `initialize_call`, `initialize_run` and `initialize_for`. They generate corresponding execution methods: `call`, `run` and `for`. Use them depending on your preference.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -49,25 +43,42 @@ Or install it yourself as:
 
     $ gem install lean_interactor
 
-## Usage
+## Motivation
 
-Define interactor like this:
+This gem was created to reduce amount of the boilerplate code needed to define an interactor:
+
+##### Without LeanInteractor
 
 ```ruby
-class Emails::Send
-  include LeanInteractor
+class Users::Create
+  def self.for(user_params)
+    new(user_params).run
+  end
 
-  initialize_with :user
+  attr_reader :user_params
+
+  def initialize(user_params)
+    @user_params = user_params
+  end
 
   def run
-    # email sending logic goes here
+    # user creation logic goes here
   end
 end
 ```
 
-And then call it:
+##### With LeanInteractor
+
 ```ruby
-Emails::Send.for(user)
+class Users::Create
+  include LeanInteractor
+
+  initialize_for :user_params
+
+  def run
+    # user creation logic goes here
+  end
+end
 ```
 
 ## Development

data/lib/lean_interactor/version.rb

@@ -1,3 +1,3 @@
 module LeanInteractor
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/lean_interactor.rb

@@ -5,14 +5,29 @@ require 'lean_interactor/version'
 module LeanInteractor
   def self.included(base)
     base.extend(ClassMethods)
-    eval LeanInteractor::GenerateMainMethod.for(:base, :run, [])
   end
 
   module ClassMethods
-    def initialize_with(*argument_names)
+    def initialize_for(*argument_names)
+      initialize_method(:for, argument_names)
+    end
+
+    def initialize_run(*argument_names)
+      initialize_method(:run, argument_names)
+    end
+
+    def initialize_call(*argument_names)
+      initialize_method(:call, argument_names)
+    end
+
+    private
+
+    def initialize_method(method_name, argument_names)
       attr_reader(*argument_names)
-      eval LeanInteractor::GenerateMainMethod.for(:self, :for, argument_names)
+      eval LeanInteractor::GenerateMainMethod.for(:self, method_name, argument_names)
       eval LeanInteractor::GenerateInitializeMethod.for(argument_names)
+
+      true
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lean_interactor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Justas Kazakauskas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-28 00:00:00.000000000 Z
+date: 2018-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -100,3 +100,4 @@ signing_key:
 specification_version: 4
 summary: LeanInteractor reduces boilerplate code while defining interactor classes
 test_files: []
+has_rdoc: