service_it 0.1.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 614561e699e7f8c0ae4f2fba193f64318d5c68f8658fce2c5319cf92bc2194e5
-  data.tar.gz: 3069a058004f09a212c2f759ceb13918757621aa9d621a1f1798391c37bea935
+  metadata.gz: 242be73eac2e2beb31caa752a64e14b3df89a8d5d1e86171ed0ebd17108363eb
+  data.tar.gz: f9bf6a0a347ea667a1b1d057edc866db2a7c720699bd2227ff251f71a1e212c7
 SHA512:
-  metadata.gz: 49a2c89469386d1ad13489e0637dbf82f739e5dfe6c02eb166441d6b4e04c28c3d89e47588f8b0c71dc26bf7ae9c7f934ece6308e298189ec29264de3b347a13
-  data.tar.gz: 61546e88499409d96b13bfb88405065e8a1b75c2e6b0f58343955d428e63daeb13a643472ce7777d0a24ee866f60a5cd85d7c0326dc89a3f5561307cac2f4275
+  metadata.gz: 63383bbf3934b6a25a3ed4bef403c0e21ad2c35abb5ba81914cd6fa010fa602d948e9868927a981ed0e0870df0767c5bf304bf8297f419d7c8bfb496950445e4
+  data.tar.gz: d44619f576bfb329151a241f40f589ff0c54248faf0bc9dce9b229bf0095a79cd6cc432feaf6ac95f3d11f9ce40483b49b84b982e3f4b57714493a8ccfe7a7ca

data/README.md

@@ -1,67 +1,74 @@
-# ServiceIt 
+# 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) 
 
-[![Gem Version](https://badge.fury.io/rb/service_it.svg)](https://badge.fury.io/rb/service_it)
+Its benefit is to facilitate the creation of Service Objects, providing you the basic and enough to have a complete one and letting you free to use on your own way.
 
-<div align="center">
-  <img src="https://pbs.twimg.com/profile_images/1123677732/logo_avatar_large.png" height="250" width="250">
-  <p>Its main objective is to provide you a way to delegate responsibilities in your project</p>
-</div>
-
-<br/>
+- [ServiceIt](#serviceit)
+  - [Installation](#installation)
+  - [With Bundler](#with-bundler)
+  - [Rails Generator](#rails-generator)
+  - [Usage](#usage)
+  - [Example](#example)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    $ gem install service_it
+
+## With Bundler
 
-    gem 'service_it', '0.1.6'
+Add this line to your `Gemfile`:
+
+    gem 'service_it', '~> 1.2.0'
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Rails Generator
 
-    $ gem install service_it
+You can use Rails generator to create a `Service`
+
+    $ rails g service NAME
+
+This will create:
+
+```
+├── app
+    ├── services
+        └── name.rb
+```
 
 ## Usage
 
-Inherit your class of `Service` and implement `perform` method 
 ```ruby
-  class Foo < Service
-    def perform
-      # here you can use params that became instance variables
-    end
+class Foo < ServiceIt::Base
+  def perform
+    # put your logic here
+    # you can use params that became variables
   end
+end
 ```
 
-Call your service from anywhere
+Call your service from anywhere (controllers, models, migrations, ...)
+
 ```ruby
-  Foo.call(params)
-```    
+Foo.call(foo: foo, bar: bar)
+```
 
-## Example 
+## Example
 
-Simple example to change status of a "transaction" to complete
+Simple example to release a _POST_
 
 ```ruby
-  # app/services/complete_transation_service.rb
-  class CompleteTransation < Service
-    def perform
-      @transation.update(:status, :complete)
-    end
-  end
-```    
+ReleasePost.call(post: @post)
+```
 
 ```ruby
-  if CompleteTransation.call(transation: @transation)
-    puts 'Transation complete!'
+# app/services/release_post.rb
+class ReleasePost < ServiceIt::Base
+  def perform
+    post.prepare_to_release
+    post.update(released_at: Date.current)
   end
-```    
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/iago-silva/service_it.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+end
+```

data/lib/generators/rails/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Creates a service
+
+Example:
+    rails g service Foo
+
+    This will create:
+        app/services/foo.rb

data/lib/generators/rails/service_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Rails
+  module Generators
+    # Generates a service by rails generator
+    class ServiceGenerator < NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      def create_service_file
+        template 'service.rb',
+                 File.join('app/services', class_path, "#{file_name}.rb")
+      end
+    end
+  end
+end

data/lib/generators/rails/templates/service.rb

@@ -0,0 +1,4 @@
+class <%= class_name %> < ServiceIt::Base
+  def perform
+  end
+end

data/lib/service_it.rb

@@ -1 +1,3 @@
-require "service"
+# frozen_string_literal: true
+
+require 'service_it/base'

data/lib/service_it/base.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module ServiceIt
+  # Inherit this class and implement perform method
+  #
+  # Documentation:
+  #   https://github.com/iago-silva/service_it
+  class Base
+    private_class_method :new
+
+    # Call your service
+    #
+    # Example:
+    #   Foo.call(arg1: 1, arg2: 2)
+    #
+    # Arguments:
+    #   args: (Hash)
+    #
+    # Return:
+    #   perform's return
+    def self.call(**args)
+      new(args).perform
+    end
+
+    def initialize(args)
+      args.each do |key, value|
+        define_ivar(key, value)
+        define_private_reader(key)
+      end
+    end
+
+    # Implement this method to run your service
+    def perform
+      raise NotImplementedError,
+            "Please implement 'perform' method in your #{self.class.name}"
+    end
+
+    private
+
+    def define_ivar(key, value)
+      instance_variable_set("@#{key}", value)
+    end
+
+    def define_private_reader(key)
+      self.class.class_eval do
+        private
+
+        attr_reader key.to_sym
+      end
+    end
+  end
+end

data/lib/service_it/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ServiceIt
+  VERSION = '2.0.0'
+end

data/spec/service_it/base_spec.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+describe ServiceIt::Base do
+  context 'when calls new method' do
+    subject { described_class.new }
+
+    it 'raises NoMethodError exception' do
+      expect { subject }.to raise_error(NoMethodError)
+    end
+  end
+
+  describe SayMyName do
+    context 'when I ask what is my name' do
+      subject { described_class.call(name: name) }
+
+      let(:name) { 'Heisenberg' }
+
+      it 'says Heisenberg' do
+        expect(subject).to eq(name)
+      end
+    end
+  end
+
+  describe MissedPerformService do
+    context 'when perform method is not defined' do
+      subject { described_class.call }
+
+      it 'raises NotImplementedError exception' do
+        expect { subject }.to raise_error(NotImplementedError)
+      end
+    end
+  end
+end

data/spec/service_it_spec.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+describe ServiceIt do
+  it 'has a version number' do
+    expect(ServiceIt::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('../lib', __dir__)
+
+require 'service_it'
+
+Dir['./spec/support/**/*.rb'].sort.each { |f| require f }

data/spec/support/test_classes.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class SayMyName < ServiceIt::Base
+  def perform
+    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: 0.1.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Iago Silva
@@ -11,87 +11,87 @@ cert_chain: []
 date: 2018-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.5.1
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.1
 description: |-
-  Its main objective is to provide you a way to delegate
-                    responsibilities in your project
-email: iago.silva@interage.in
-executables:
-- console
-- setup
+  Service objects are a holy grail to keep your controllers and
+                    models slim and readable
+email:
+- iago.cith@hotmail.com
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
-- Gemfile.lock
-- LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
-- lib/service.rb
+- lib/generators/rails/USAGE
+- lib/generators/rails/service_generator.rb
+- lib/generators/rails/templates/service.rb
 - lib/service_it.rb
-- service_it.gemspec
-- spec/service_spec.rb
+- lib/service_it/base.rb
+- lib/service_it/version.rb
+- spec/service_it/base_spec.rb
+- spec/service_it_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_classes.rb
 homepage: https://github.com/iago-silva/service_it
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/iago-silva/service_it
+  source_code_uri: https://github.com/iago-silva/service_it
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -100,18 +100,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: A simple gem for Rails that allows you to isolate a snippet of code and call
-  it from anywhere
+summary: Simple gem to keep your controllers and models slim and readable
 test_files:
-- spec/service_spec.rb
+- spec/service_it_spec.rb
+- spec/support/test_classes.rb
+- spec/service_it/base_spec.rb
+- spec/spec_helper.rb

data/.gitignore

@@ -1,12 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-.idea
-
-*.gem

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/Gemfile.lock

@@ -1,41 +0,0 @@
-PATH
-  remote: .
-  specs:
-    service_it (0.1.6)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    method_source (0.9.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (12.3.2)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  pry
-  rake
-  rspec
-  service_it!
-
-BUNDLED WITH
-   1.16.1

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2018 Iago Silva
-
-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/Rakefile

@@ -1,6 +0,0 @@
-require 'rspec/core/rake_task'
-require 'bundler/gem_tasks'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/bin/console

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'service_it'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-require "pry"
-Pry.start
-
-require 'irb'
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/lib/service.rb

@@ -1,39 +0,0 @@
-# Inherit this class and implement perform method
-#
-# Documentation:
-#   https://github.com/iago-silva/service_it#usage
-class Service
-  class << self
-    # Call your service
-    #
-    # Example:
-    #   ServiceIt.call(arg1: 1, arg2: 2)
-    #
-    # Arguments:
-    #   args: (Hash)
-    #
-    # Return:
-    #   perform's return
-    def call(**args)
-      new_instance(args).perform
-    end
-
-    private
-
-    def new_instance(args)
-      instance = new
-
-      args.each do |key, value|
-        instance.instance_variable_set("@#{key}", value)
-      end
-
-      instance
-    end
-  end
-
-  # Implement this method to run your service
-  def perform
-    raise NotImplementedError,
-          "Please implement 'perform' method in your #{self.class.name}"
-  end
-end

data/service_it.gemspec

@@ -1,26 +0,0 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-Gem::Specification.new do |s|
-  s.name        = 'service_it'
-  s.version     = '0.1.6'
-  s.date        = '2018-07-27'
-  s.authors     = ['Iago Silva']
-  s.email       = 'iago.silva@interage.in'
-  s.homepage    = 'https://github.com/iago-silva/service_it'
-  s.license     = 'MIT'
-  s.summary     = 'A simple gem for Rails that allows you to isolate a snippet
-                  of code and call it from anywhere'
-  s.description = 'Its main objective is to provide you a way to delegate
-                  responsibilities in your project'
-
-  s.files         = `git ls-files -z`.split("\x0")
-  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ['lib']
-
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'pry'
-end

data/spec/service_spec.rb

@@ -1,17 +0,0 @@
-require 'service'
-
-describe Service do
-  let(:result) { SayMyName.call(name: 'Heisenberg') }
-
-  before do
-    class SayMyName < Service
-      def perform
-        @name
-      end
-    end
-  end
-
-  it 'say Heisenberg' do
-    expect(result).to eq('Heisenberg')
-  end
-end