rails-patterns 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e7a4ed45fc0663789bf4ddb050d8d1a24dfb88af
-  data.tar.gz: 5e4b2c49b8477c44764f611439f1d556d6e361b2
+  metadata.gz: e92ba62b5937443b24c3399655e678b6deb2d273
+  data.tar.gz: '0973bdde4d88392f6cd3a2a8a08fe77a3cf1f007'
 SHA512:
-  metadata.gz: c2e27126c96ec9d5a508ccade1c3b11db7bfbeb7dc06c7754ac8ce154ae784800a5b0bd2be9b69fb74e19855c65e5dfe95defd3f46199a5b694b4cb7082a8a5a
-  data.tar.gz: 047f3867ed52a6a7cbad689ea8be6fff248d3acb6ead8a9abf93b9ce7ef57379aa312a351ddfe417302fd63f54c0bb6fbb415a425a0f54025bad9ab8a8866e75
+  metadata.gz: 8fd3b635495855827654b7b818ee074ac562a919e6610c470cce226afcdf0dfe9944ff5867858d945054732c503babd63588d3775c517f9270846901f56eeb00
+  data.tar.gz: '068e1a602e2e1c591853e1491cfb1bf13e48f56dbaff45ee0db72417be176036939073769212d983da7b098ca5ecccd6935b0812fd83f761ee7db9cd176488e0'

data/README.md

@@ -71,3 +71,52 @@ class User < ApplicationRecord
   scope :recenty_activated, RecentlyActivatedUsersQuery
 end
 ```
+
+## Service
+
+### When to use it
+
+Service objects are commonly used to mitigate problems with model callbacks that interact with external classes ([read more...](http://samuelmullen.com/2013/05/the-problem-with-rails-callbacks/)).
+Service objects are also useful for handling processes involving multiple steps. E.g. a controller that performs more than one operation on its subject (usually a model instance) is a possible candidate for Extract ServiceObject (or Extract FormObject) refactoring.
+
+### Assumptions and rules
+
+* Service objects are always used by calling class-level `.call` method
+* Service objects have to implement `#call` method
+* Calling service object's `.call` method executes `#call` and returns service object instance
+* A result of `#call` method is accessible through `#result` method
+* It is recommended for `#call` method to be the only public method of service object (besides state readers)
+* It is recommended to name service object classes after commands (e.g. `ActivateUser` instead of `UserActivation`)
+
+### Examples
+
+#### Declaration
+
+```ruby
+class ActivateUser < Patterns::Service
+  def initialize(user)
+    @user = user
+  end
+
+  def call
+    user.activate!
+    NotificationsMailer.user_activation_notification(user).deliver_now
+    user
+  end
+
+  private
+
+  attr_reader :user
+end
+```
+
+#### Usage
+
+```ruby
+  user_activation = ActivateUser.call(user)
+  user_activation.result # <User id: 5803143, email: "tony@patterns.dev ...
+```
+
+## Further reading
+
+* [7 ways to decompose fat active record models](http://blog.codeclimate.com/blog/2012/10/17/7-ways-to-decompose-fat-activerecord-models/)

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/patterns/service.rb

@@ -0,0 +1,18 @@
+module Patterns
+  class Service
+    attr_reader :result
+
+    def self.call(*args)
+      new(*args).tap do |service|
+        service.instance_variable_set(
+          "@result",
+          service.call
+        )
+      end
+    end
+
+    def call
+      raise NotImplementedError
+    end
+  end
+end

data/lib/rails-patterns.rb

@@ -1,2 +1,3 @@
 require "patterns"
 require "patterns/query"
+require "patterns/service"

data/rails-patterns.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: rails-patterns 0.1.1 ruby lib
+# stub: rails-patterns 0.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "rails-patterns".freeze
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -29,9 +29,11 @@ Gem::Specification.new do |s|
     "VERSION",
     "lib/patterns.rb",
     "lib/patterns/query.rb",
+    "lib/patterns/service.rb",
     "lib/rails-patterns.rb",
     "rails-patterns.gemspec",
     "spec/patterns/query_spec.rb",
+    "spec/patterns/service_spec.rb",
     "spec/spec_helper.rb"
   ]
   s.homepage = "http://github.com/selleo/pattern".freeze

data/spec/patterns/service_spec.rb

@@ -0,0 +1,65 @@
+RSpec.describe Patterns::Service do
+  after { Object.send(:remove_const, :DoSomething) if defined?(DoSomething) }
+
+  describe ".call" do
+    it "returns instance of service object" do
+      DoSomething = Class.new(Patterns::Service) do
+        def call; end
+      end
+
+      expect(DoSomething.call).to be_kind_of(DoSomething)
+    end
+
+    it "instantiates service object passing arguments to constructor" do
+      DoSomething = Class.new(Patterns::Service) do
+        def initialize(argument_1:, argument_2:); end
+        def call; end
+      end
+
+      expect {
+        DoSomething.call
+      }.to raise_error ArgumentError
+
+      expect {
+        DoSomething.call(argument_1: 10, argument_2: 20)
+      }.not_to raise_error
+    end
+
+    it "calls #call method on service object instance" do
+      Spy = Class.new do
+        def self.some_method; end
+      end
+      allow(Spy).to receive(:some_method)
+      DoSomething = Class.new(Patterns::Service) do
+        def call
+          Spy.some_method
+        end
+      end
+
+      DoSomething.call
+
+      expect(Spy).to have_received(:some_method)
+    end
+
+    it "requires #call method to be implemented" do
+      DoSomething = Class.new(Patterns::Service)
+
+      expect {
+        DoSomething.call
+      }.to raise_error NotImplementedError
+    end
+  end
+
+  describe "#result" do
+    it "returns a result of expression within #call method" do
+      DoSomething = Class.new(Patterns::Service) do
+        def call
+          50
+        end
+      end
+
+      service = DoSomething.call
+      expect(service.result).to eq 50
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -17,7 +17,7 @@
 #
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
-require "pattern"
+require "rails-patterns"
 
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-patterns
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Stevo
@@ -84,9 +84,11 @@ files:
 - VERSION
 - lib/patterns.rb
 - lib/patterns/query.rb
+- lib/patterns/service.rb
 - lib/rails-patterns.rb
 - rails-patterns.gemspec
 - spec/patterns/query_spec.rb
+- spec/patterns/service_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/selleo/pattern
 licenses: