good_services 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab9aea86bdfee7c671ed7b0b880ca45f2599cf1b
+  data.tar.gz: edb3d4af284f44bec355cd3d6e0e577716c015a1
+SHA512:
+  metadata.gz: 499c9fca7ab70df466f3ddf2bfa03156fd3c4f3bc4c630cfdf759b0bf1f00d86313940ffcfb51a60319addd6d5e39a6d7e08c881837f23653b40628c6d11998b
+  data.tar.gz: fc6c806f50865d71f41720184ed440abecedfb7cd9bc0105146df016c7a70b67469966419f5785c405f95aef56e36605e25ae93ae59f58b56333a73135244cd6

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in good_services.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Victor
+
+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/README.md

@@ -0,0 +1,136 @@
+# 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 :)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'good_services'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install good_services
+
+---
+
+## Usage
+
+*The best way to understand this gem is to have a look at the [GoodServices::Base](/victoryam/good_services/blob/master/lib/good_services/base.rb) file. It is the only file that matters for this gem (really).*
+
+To get started just create a new class inheriting from **GoodServices::Base**
+
+#### Sample Service Object:
+
+```ruby
+module Pet
+  #
+  # Errors
+  #
+  InvalidPetError = Class.new(StandardError)
+  NoNewNameError  = Class.new(StandardError)
+
+  #
+  # Service
+  #
+  class Renamer < GoodServices::Base
+    rescuable_from InvalidPetError, NoNewNameError
+    attr_reader :new_name
+
+    def initialize(pet: pet, new_name: new_name)
+      @record   = pet
+      @new_name = new_name
+    end
+
+    def perform
+      @record.name = new_name
+    end
+
+    def validate
+      raise InvalidPetError unless record.respond_to? :name
+      raise NoNewNameError  unless new_name
+    end
+  end
+end
+
+```
+
+
+#### By default the following variables are available as attr_readers:
+
+```ruby
+# Used when the service operates on only one object
+@record
+
+# Used when the service operates on a collection of objects
+@collection
+
+# If you run the service with the safe ".run" method, the @error
+# variable will be filled with any rescuable error defined in the service.
+@error
+```
+
+--
+
+### Rescuable Exceptions
+
+You can define a list of exceptions that are actually expected to happen eventually and the safe ".run" method will rescue you out of them returning **false** instaead.
+
+The exception will be saved in the **@error** variable and accessible to the outside for custom error messages and etc. Here is how you use it:
+
+```ruby
+  class Renamer < GoodServices::Base
+    rescuable_from InvalidPetError, NoNewNameError
+    (...)
+  end
+```
+
+--
+
+### Methods
+
+#### Perform
+The only required method for your service is the **perform** method.
+It will have the logic called by your .run and .run! methods.
+
+```ruby
+def perform
+  @record.name = new_name
+end
+```
+
+#### Validate
+This method is optional, but will be called before your perform method when you ".run" or ".run!" the service.
+It should raise predictable errors based on your validations, for example:
+
+```ruby
+def validate
+  raise InvalidPetError unless record.respond_to? :name
+  raise NoNewNameError  unless new_name
+end
+```
+**This syntax is not my masterpiece, I appreciate any ideas of a better way to do this.*
+
+---
+
+## Development
+
+**To-do**
+
+- Improve the way validations are done (right now the "raise x if y" stuff is kinda ugly)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/victoryam/good_services.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "good_services"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/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/good_services.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'good_services/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "good_services"
+  spec.version       = GoodServices::VERSION
+  spec.date             = '2016-07-12'
+  spec.authors       = ["Victor A.M."]
+  spec.email         = ["victor@victoryam.com.br"]
+
+  spec.summary       = %q{A simple structure to help you build your service objects better and faster}
+  spec.description   = %q{A simple structure to help you build your service objects better and faster}
+  spec.homepage      = "https://github.com/victoryam/good_services"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  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 "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/good_services/base.rb

@@ -0,0 +1,76 @@
+module GoodServices
+  class Base
+    attr_reader :record, :collection, :error
+
+    #
+    # Inheritance wizardry
+    #
+    class << self
+      attr_accessor :rescuable_list, :default_rescues
+
+      DEFAULT_RESCUES = []
+
+      def inherit_variables(rescuable_list, default_rescues)
+        @rescuable_list  = rescuable_list  || []
+        @default_rescues = default_rescues || DEFAULT_RESCUES
+      end
+
+      def inherited(subclass)
+        subclass.inherit_variables(@rescuable_list, @default_rescues)
+      end
+    end
+
+    #
+    # Helpers for instancing and running the Service
+    #
+    def self.run(*args)
+      self.new(*args).run
+    end
+
+    def self.run!(*args)
+      self.new(*args).run!
+    end
+
+    #
+    # Runs the validations and perform methods
+    # Returns true or raise an exception
+    #
+    def run!
+      validate
+      perform
+      return true
+    end
+
+    #
+    # Runs the validations and perform methods rescuing from known exceptions
+    # Returns either true or false
+    #
+    def run
+      validate
+      perform
+      return true
+    rescue *self.class.acceptable_exceptions => @error
+      return false
+    end
+
+    def validate
+    end
+
+    def perform
+    end
+
+    #
+    # This configuration method adds custom exceptions to the rescuable list
+    #
+    def self.rescuable_from(*rescuable_exceptions)
+      @rescuable_list = rescuable_exceptions
+    end
+
+    #
+    # This method returns either the set rescuable_from or the defaults
+    #
+    def self.acceptable_exceptions
+      (@rescuable_list + @default_rescues).uniq
+    end
+  end
+end

data/lib/good_services/version.rb

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

data/lib/good_services.rb

@@ -0,0 +1,5 @@
+require "good_services/version"
+require "good_services/base"
+
+module GoodServices
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: good_services
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Victor A.M.
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A simple structure to help you build your service objects better and
+  faster
+email:
+- victor@victoryam.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- good_services.gemspec
+- lib/good_services.rb
+- lib/good_services/base.rb
+- lib/good_services/version.rb
+homepage: https://github.com/victoryam/good_services
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A simple structure to help you build your service objects better and faster
+test_files: []