service_it 0.1.6 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 614561e699e7f8c0ae4f2fba193f64318d5c68f8658fce2c5319cf92bc2194e5
-  data.tar.gz: 3069a058004f09a212c2f759ceb13918757621aa9d621a1f1798391c37bea935
+  metadata.gz: be1085eaf772f8657824e4495bdb6bb3ffe89362368fd922b7202ed8a7293966
+  data.tar.gz: d27ac5b1a0f82925d1d13849a9a556c84565d5427765a3ebf925971e3c1a627a
 SHA512:
-  metadata.gz: 49a2c89469386d1ad13489e0637dbf82f739e5dfe6c02eb166441d6b4e04c28c3d89e47588f8b0c71dc26bf7ae9c7f934ece6308e298189ec29264de3b347a13
-  data.tar.gz: 61546e88499409d96b13bfb88405065e8a1b75c2e6b0f58343955d428e63daeb13a643472ce7777d0a24ee866f60a5cd85d7c0326dc89a3f5561307cac2f4275
+  metadata.gz: 6eb0d062f6453045d96ef3549e01a8c6347eec3f4cf689b7fc96882f169171a2e8e7ac03634813fdec713ea3291ce475f0c867da06de6b96b6c89f4250bb0f09
+  data.tar.gz: 585172ed14df1120bc16d551f8336c9fbf4bb84f5355c488084a0cd012af64880ecbb1fd4eb8e3469da712167059c97a16b7ddaaafd104fdcb45bbbe76dec4ae

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  TargetRubyVersion: 2.2
+  Exclude:
+    - 'lib/generators/rails/templates/**/*'

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+
+cache: bundler
+
+language: ruby
+
+rvm:
+  - 2.2
+
+script:
+  - bundle exec rspec
+  - bundle exec rubocop

data/Gemfile.lock

@@ -1,40 +1,56 @@
 PATH
   remote: .
   specs:
-    service_it (0.1.6)
+    service_it (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
+    ast (2.4.0)
     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)
+    jaro_winkler (1.5.2)
+    parallel (1.17.0)
+    parser (2.6.2.1)
+      ast (~> 2.4.0)
+    psych (3.1.0)
+    rainbow (3.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.1)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    rubocop (0.67.2)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-performance (1.1.0)
+      rubocop (>= 0.67.0)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    unicode-display_width (1.5.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler
-  pry
-  rake
   rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
   service_it!
 
 BUNDLED WITH

data/README.md

@@ -1,11 +1,6 @@
-# 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) [![Downloads](https://img.shields.io/gem/dt/service_it.svg)](https://rubygems.org/gems/service_it) [![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
 
-[![Gem Version](https://badge.fury.io/rb/service_it.svg)](https://badge.fury.io/rb/service_it)
-
-<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>
+Provide you a way to delegate responsibilities in your project using callables
 
 <br/>
 
@@ -13,7 +8,7 @@
 
 Add this line to your application's Gemfile:
 
-    gem 'service_it', '0.1.6'
+    gem 'service_it', '~> 0.1.6'
 
 And then execute:
 
@@ -22,40 +17,46 @@ And then execute:
 Or install it yourself as:
 
     $ gem install service_it
+    
+## Generator
+
+    $ rails g service NAME
 
 ## 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
+# app/services/foo.rb
+class Foo < ServiceIt::Base
+  def perform
+    # here you can use params that became instance variables
   end
+end
 ```
 
 Call your service from anywhere
 ```ruby
-  Foo.call(params)
+Foo.call(params)
 ```    
 
 ## Example 
 
-Simple example to change status of a "transaction" to complete
+Simple example to change status of a _transaction_ to complete
+
+    $ rails g service CompleteTransaction
 
 ```ruby
-  # app/services/complete_transation_service.rb
-  class CompleteTransation < Service
-    def perform
-      @transation.update(:status, :complete)
-    end
+# app/services/complete_transaction.rb
+class CompleteTransaction < ServiceIt::Base
+  def perform
+    @transaction.update(:status, :complete)
   end
+end
 ```    
 
 ```ruby
-  if CompleteTransation.call(transation: @transation)
-    puts 'Transation complete!'
-  end
+if CompleteTransaction.call(transaction: transaction)
+  puts 'Transaction complete!'
+end
 ```    
 
 ## Contributing

data/Rakefile

@@ -1,5 +1,4 @@
 require 'rspec/core/rake_task'
-require 'bundler/gem_tasks'
 
 RSpec::Core::RakeTask.new(:spec)
 

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,13 @@
+module Rails
+  module Generators
+    # Generates a service by command line
+    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/base.rb

@@ -0,0 +1,41 @@
+module ServiceIt
+  # Inherit this class and implement perform method
+  #
+  # Documentation:
+  #   https://github.com/iago-silva/service_it#usage
+  class Base
+    class << self
+      # Call your service
+      #
+      # Example:
+      #   Foo.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
+end

data/lib/service_it.rb

@@ -1 +1 @@
-require "service"
+require 'service_it/base'

data/service_it.gemspec

@@ -3,24 +3,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = 'service_it'
-  s.version     = '0.1.6'
+  s.version     = '0.2.0'
   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.summary     = 'Simple gem for Rails that allows you to isolate a piece of
+                  code and call it from anywhere'
+  s.description = 'Provide you a way to delegate responsibilities in your
+                  project using callables'
 
-  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.test_files  = `git ls-files -- spec/*`.split("\n")
+  s.files       = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
 
   s.add_development_dependency 'bundler'
-  s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
-  s.add_development_dependency 'pry'
+
+  if RUBY_VERSION >= '2.2.0'
+    s.add_development_dependency 'rubocop'
+    s.add_development_dependency 'rubocop-performance'
+    s.add_development_dependency 'rubocop-rspec'
+  end
 end

data/spec/service_it_spec.rb

@@ -0,0 +1,10 @@
+describe ServiceIt do
+  describe SayMyName do
+    let(:name) { 'Heisenberg' }
+    let(:perform) { described_class.call(name: name) }
+
+    it 'says Heisenberg' do
+      expect(perform).to eq(name)
+    end
+  end
+end

data/spec/spec_helper.rb

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

data/spec/support/test_classes.rb

@@ -0,0 +1,5 @@
+class SayMyName < ServiceIt::Base
+  def perform
+    @name
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: service_it
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
 platform: ruby
 authors:
 - Iago Silva
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,27 +81,31 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |-
-  Its main objective is to provide you a way to delegate
-                    responsibilities in your project
+  Provide you a way to delegate responsibilities in your
+                    project using callables
 email: iago.silva@interage.in
-executables:
-- console
-- setup
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - 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
+- lib/service_it/base.rb
 - service_it.gemspec
-- spec/service_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
@@ -111,7 +129,9 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: A simple gem for Rails that allows you to isolate a snippet of code and call
+summary: Simple gem for Rails that allows you to isolate a piece of code and call
   it from anywhere
 test_files:
-- spec/service_spec.rb
+- spec/service_it_spec.rb
+- spec/spec_helper.rb
+- spec/support/test_classes.rb

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/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