good_services 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab9aea86bdfee7c671ed7b0b880ca45f2599cf1b
-  data.tar.gz: edb3d4af284f44bec355cd3d6e0e577716c015a1
+  metadata.gz: 3ba29e93e768c8a9b999b0b26ba0ec861610742d
+  data.tar.gz: 6bbe678af7397a8b9046b36e198cd3cb398fe05f
 SHA512:
-  metadata.gz: 499c9fca7ab70df466f3ddf2bfa03156fd3c4f3bc4c630cfdf759b0bf1f00d86313940ffcfb51a60319addd6d5e39a6d7e08c881837f23653b40628c6d11998b
-  data.tar.gz: fc6c806f50865d71f41720184ed440abecedfb7cd9bc0105146df016c7a70b67469966419f5785c405f95aef56e36605e25ae93ae59f58b56333a73135244cd6
+  metadata.gz: e21461365f61b0c4f5be9a0f091a8b6b9fde7a4a23df3ffd36aa4115c6caa99ca0183b141bbccd114f37f3690bfc28dda9869baa8006e1ffaf38a8cfd66fd2a4
+  data.tar.gz: c1b364fd4b13a7affd7fbbbcfcd296d3f9a73e725ad018d9f4494dac918e1c2f13246e7791bb9eca275da5917e8bb9085a1a9c097fe36e38e82255e09b4df631

data/Gemfile

@@ -1,4 +1,7 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
+ruby "2.3.0"
 
 # Specify your gem's dependencies in good_services.gemspec
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,6 +1,10 @@
 # GoodServices
 
-This is a very simple gem I've created to keep the logic I've been frequently using in my apps to standardize my Service Objects. I intend to keep it as simple as possible so it can be versatile and easy to use, but ideas to improve it and pull-requests are welcome :)
+[![Code Climate](https://codeclimate.com/github/victoryam/good_services/badges/gpa.svg)](https://codeclimate.com/github/victoryam/good_services) [![Gem Version](https://badge.fury.io/rb/good_services.svg)](https://badge.fury.io/rb/good_services)  ![Build](https://circleci.com/gh/victoryam/good_services.svg?style=shield) [![Test Coverage](https://codeclimate.com/github/victoryam/good_services/badges/coverage.svg?no_cache)](https://codeclimate.com/github/victoryam/good_services/coverage)
+
+This is a very simple gem I've created to keep the logic I've been frequently using in my apps Service Objects.
+
+I intend to keep it as simple as possible so it can be versatile and easy to use, but ideas and pull-requests are welcome :)
 
 ## Installation
 
@@ -59,8 +63,39 @@ module Pet
   end
 end
 
+```
+#### Generators
+
+When using Rails you can use our generator to get a simple Service boilerplate:
+```
+rails generate good_services:service PetRenamer
+```
+
+If you prefer using namespaces for your services (**we recommend it**), you can use it like that:
+
+```
+rails generate good_services:service Pets::Renamer
 ```
 
+#### Basic usage
+
+The **run** method is considered the safe way to run the service (always returns true or false)
+```ruby
+Pet::Renamer.run(pet: Pet.new, name: "Flipsy")
+# => true
+
+Pet::Renamer.run(pet: nil, name: "Flipsy")
+# => false
+```
+
+The **run!** method does the same, except that it doesn't rescue any errors (always returns true or raises an exception)
+```ruby
+Pet::Renamer.run!(pet: Pet.new, name: "Flipsy")
+# => true
+
+Pet::Renamer.run!(pet: nil, name: "Flipsy")
+# => InvalidPetError
+```
 
 #### By default the following variables are available as attr_readers:
 
@@ -98,10 +133,11 @@ The exception will be saved in the **@error** variable and accessible to the out
 #### Perform
 The only required method for your service is the **perform** method.
 It will have the logic called by your .run and .run! methods.
+**Try to always use methods that raise exceptions, like the example below (in Rails)**
 
 ```ruby
 def perform
-  @record.name = new_name
+  @record.update!(name: new_name)
 end
 ```
 
@@ -115,7 +151,7 @@ def validate
   raise NoNewNameError  unless new_name
 end
 ```
-**This syntax is not my masterpiece, I appreciate any ideas of a better way to do this.*
+**I'm not proud of this syntax, I appreciate any insights on a better way to do this.*
 
 ---
 

data/Rakefile

@@ -4,7 +4,7 @@ require "rake/testtask"
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList['test/**/*_spec.rb']
 end
 
 task :default => :test

data/circle.yml

@@ -0,0 +1,8 @@
+machine:
+  ruby:
+    version: 2.3.0
+  environment:
+    CODECLIMATE_REPO_TOKEN: 4f60d39541aca05c29688637baba3630f400c2c1fe9af5a8f6a385fa62541047
+dependencies:
+  pre:
+    - gem install bundler -v 1.12.5

data/good_services.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "bundler", "~> 1.12.5"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 end

data/lib/generators/good_services/service_generator.rb

@@ -0,0 +1,64 @@
+module GoodServices
+  module Generators
+    class ServiceGenerator < Rails::Generators::NamedBase
+      desc "Creates a GoodServices basic service"
+
+      def create_service
+        if constants.size == 1
+          create_file service_path, namespaceless_template
+        elsif constants.size == 2
+          create_file service_path, namespaced_template
+        else
+          puts
+          puts "[Error] This generator only supports one level of namespacing!"
+        end
+      end
+
+      private
+
+      def namespaceless_template
+        get_template("namespaceless_service").result(binding)
+      end
+
+      def namespaced_template
+        get_template("namespaced_service").result(binding)
+      end
+
+      def get_template(file)
+        path = File.expand_path("../templates/#{file}.erb", __FILE__)
+        ERB.new(File.read(path))
+      end
+
+      def service_path
+        if service_module
+          "app/services/#{module_name}/#{service_name}.rb"
+        else
+          "app/services/#{service_name}.rb"
+        end
+      end
+
+      #
+      # Argument Helpers
+      #
+      def constants
+        class_name.split("::")
+      end
+
+      def service_module
+        @_service_module ||= constants.first if constants.size > 1
+      end
+
+      def service_class
+        @_service_class ||= class_name.split("::").last
+      end
+
+      def service_name
+        @_service_name ||= service_class.underscore
+      end
+
+      def module_name
+        @_module_name ||= service_module.underscore
+      end
+    end
+  end
+end

data/lib/generators/good_services/templates/namespaced_service.erb

@@ -0,0 +1,21 @@
+module <%= service_module %>
+  class <%= service_class %> < GoodServices::Base
+    rescuable_from ActiveRecord::RecordInvalid
+
+    def initialize(record)
+      # Define your service parameters here
+      # We've set the 'record' parameter for you as an example
+      @record = record
+    end
+
+    def validate
+      # Add your validations here or delete this method
+    end
+
+    def perform
+      # Insert your service behaviour here
+      # The behaviour below is just an example
+      record.save!
+    end
+  end
+end

data/lib/generators/good_services/templates/namespaceless_service.erb

@@ -0,0 +1,19 @@
+class <%= service_class %> < GoodServices::Base
+  rescuable_from ActiveRecord::RecordInvalid
+
+  def initialize(record)
+    # Define your service parameters here
+    # We've set the 'record' parameter for you as an example
+    @record = record
+  end
+
+  def validate
+    # Add your validations here or delete this method
+  end
+
+  def perform
+    # Insert your service behaviour here
+    # The behaviour below is just an example
+    record.save!
+  end
+end

data/lib/good_services/version.rb

@@ -1,3 +1,3 @@
 module GoodServices
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: good_services
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Victor A.M.
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 1.12.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.12'
+        version: 1.12.5
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -68,7 +68,11 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- circle.yml
 - good_services.gemspec
+- lib/generators/good_services/service_generator.rb
+- lib/generators/good_services/templates/namespaced_service.erb
+- lib/generators/good_services/templates/namespaceless_service.erb
 - lib/good_services.rb
 - lib/good_services/base.rb
 - lib/good_services/version.rb
@@ -92,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: A simple structure to help you build your service objects better and faster