service_it 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fbc4d1a0417b325824e46ebea9bd0a0f95b9a62f4c6fdff153d7309aef20fc9c
-  data.tar.gz: a2f728a79e46cac2e2fa9829786267269d98628cd58bd2a2c1d757a8ae3abf66
+  metadata.gz: 4cd3980a2426fb7838e0ae392a4a12a79ea81d0a385eae6fd5b53e3147f02f11
+  data.tar.gz: 4bef1fceed1af00155948b3399da13cee01b24ca65ad77dbfb8a6ac92df3165f
 SHA512:
-  metadata.gz: 12d152f0218349f96ffa2f75b831c629d024ec074b3d327d9d248771d2cd1e57774a8b373cb645c842e817525733e1bd4d05a986aa8c16a0b74e22014e01ab85
-  data.tar.gz: 71012594645c160acfe675067d52b6b4cc29bb85ebf5397b13d5dcaafb7a66266a535ce98b2184fe567807c0bdb62826193d1a86446dd31c12ccb9162507790a
+  metadata.gz: 017467fd53746def423e3456badf5a0ac6e7ff896489738b9015a5b83cca12718a13355de5489f6b28282bc05ab7cb85d7b1266a12ceedc50c8db724c4f06a9d
+  data.tar.gz: ce95f14007a1dbbcd1aae0c1186e6c79852f037f4e4fb4fa5c8d8cefd371855cbb6c9b45e96648a7988af46256c8284c5b35ff59e22217fb6e39c84bf237f94a

data/README.md

@@ -1,71 +1,112 @@
-[![Gem Version](https://badge.fury.io/rb/service_it.svg)](https://badge.fury.io/rb/service_it) [![Build Status](https://travis-ci.org/iago-silva/service_it.svg?branch=master)](https://travis-ci.org/iago-silva/service_it) [![Code Climate](https://codeclimate.com/github/iago-silva/service_it.png)](https://codeclimate.com/github/iago-silva/service_it)
-
 # ServiceIt
+[![Gem Version](https://badge.fury.io/rb/service_it.svg)](https://badge.fury.io/rb/service_it) [![Build Status](https://travis-ci.org/iago-silva/service_it.svg?branch=master)](https://travis-ci.org/iago-silva/service_it) [![Code Climate](https://codeclimate.com/github/iago-silva/service_it.png)](https://codeclimate.com/github/iago-silva/service_it) [![Test Coverage](https://api.codeclimate.com/v1/badges/fcc8375ebe8fa5412381/test_coverage)](https://codeclimate.com/github/iago-silva/service_it/test_coverage)
 
-[Service objects are a holy grail to keep your controllers and models slim and readable](https://medium.com/selleo/essential-rubyonrails-patterns-part-1-service-objects-1af9f9573ca1)
-
-<br/>
+- [ServiceIt](#serviceit)
+  - [Installation](#installation)
+  - [With Bundler](#with-bundler)
+  - [Rails Generator](#rails-generator)
+  - [Usage](#usage)
+  - [Example](#example)
 
 ## Installation
 
     $ gem install service_it
-    
+
 ## With Bundler
 
 Add this line to your `Gemfile`:
 
-    gem 'service_it', '~> 0.2.0'
+    gem 'service_it', '~> 1.0.0'
 
 And then execute:
 
     $ bundle
-    
-## With Rails
+
+## Rails Generator
 
 You can use Rails generator to create a `Service`
 
     $ rails g service NAME
 
+This will create:
+
+```
+├── app
+    ├── services
+        └── name.rb
+```
+
 ## Usage
 
 ```ruby
 class Foo < ServiceIt::Base
   def perform
-    # here you can use params that became instance variables
+    # put your logic here
+    # you can use params that became variables
   end
 end
 ```
 
 Call your service from anywhere
+
 ```ruby
-Foo.call(params)
-```    
+Foo.call(foo: foo, bar: bar)
+```
 
-## Example 
+## Example
 
-Simple example _using Rails_ to change status of a _transaction_ to complete
+Simple example to release a _POST_
 
-    $ rails g service CompleteTransaction
+* Before
 
 ```ruby
-# app/services/complete_transaction.rb
-class CompleteTransaction < ServiceIt::Base
-  def perform
-    @transaction.update(:status, :complete)
+# app/controllers/post_releases_controller.rb
+class PostReleasesController < ApplicationController
+
+  # [...]
+
+  def update
+    @post.prepare_to_release                      # <--
+    if @post.update(released_at: Date.current)    # <--
+      # [...]
+    else
+      # [...]
+    end
   end
+
+  # [...]
+
 end
-```    
+
+```
+
+* After
 
 ```ruby
-if CompleteTransaction.call(transaction: transaction)
-  puts 'Transaction complete!'
-end
-```    
+# app/controllers/post_releases_controller.rb
+class PostReleasesController < ApplicationController
 
-## Contributing
+  # [...]
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/iago-silva/service_it.
+  def update
+    if ReleasePost.call(post: @post)    # <--
+      # [...]
+    else
+      # [...]
+    end
+  end
 
-## License
+  # [...]
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+end
+```
+
+```ruby
+# app/services/release_post.rb
+class ReleasePost < ServiceIt::Base
+  def perform
+    post.prepare_to_release
+    post.update(released_at: Date.current)
+  end
+end
+```

data/lib/service_it/base.rb

@@ -28,6 +28,12 @@ module ServiceIt
 
         args.each do |key, value|
           instance.instance_variable_set("@#{key}", value)
+
+          class_eval do
+            private
+
+            attr_accessor key.to_sym
+          end
         end
 
         instance

data/lib/service_it/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ServiceIt
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/spec/service_it_spec.rb

@@ -3,10 +3,18 @@ require 'spec_helper'
 describe ServiceIt do
   describe SayMyName do
     let(:name) { 'Heisenberg' }
-    let(:perform) { described_class.call(name: name) }
+    let(:call) { SayMyName.call(name: 'Heisenberg') }
 
     it 'says Heisenberg' do
-      expect(perform).to eq(name)
+      expect(call).to eq(name)
+    end
+  end
+
+  context 'when perform method is not defined' do
+    it 'raises an NotImplementedError exception' do
+      expect do
+        MissedPerformService.call
+      end.to raise_error(NotImplementedError)
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,3 +1,10 @@
+require 'simplecov'
+
+SimpleCov.minimum_coverage 100
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)
 
 require 'service_it'

data/spec/support/test_classes.rb

@@ -1,5 +1,10 @@
+# frozen_string_literal: true
+
 class SayMyName < ServiceIt::Base
   def perform
-    @name
+    name
   end
 end
+
+class MissedPerformService < ServiceIt::Base
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: service_it
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Iago Silva
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |-
   Service objects are a holy grail to keep your controllers and
                     models slim and readable
@@ -76,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: Simple gem to keep your controllers and models slim and readable