simple_service_object 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a5534a40455d739b14652ccb075bdf604e8569d
+  data.tar.gz: cf85c7b63550be18162ba98797b539e45d2431a4
+SHA512:
+  metadata.gz: 33265986f179d53655613041f1c79d4a778241baf2398ec1d4f34d9f7bd986c409cce5bb71b3f53e7d3d08c614236d5b087c4071ed8d904d39e4810e825d4104
+  data.tar.gz: 5da3cfdcece4150d387dcf5971ecd8696fe2dee401d0d8fed5cfff31a576a7e815a067c72063926b22892db2f7fd377632ba465277c815c1731c2f60b9668ecb

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,21 @@
+AllCops:
+  TargetRubyVersion: 2.3
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+  Exclude:
+    - 'bin/*'
+
+Metrics/LineLength:
+  Max: 100
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - '*.gemspec'
+    - '**/*_spec.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.4.0

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.3.3
+  - 2.4.0
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at fabrizio.monti@welaika.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_service_object.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Fabrizio Monti
+
+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,117 @@
+# SimpleServiceObject
+
+A simple command pattern implementation in Ruby.
+
+[![Build Status](https://travis-ci.org/welaika/simple_service_object.svg?branch=master)](https://travis-ci.org/welaika/simple_service_object)
+[![Code Climate](https://codeclimate.com/github/welaika/simple_service_object/badges/gpa.svg)](https://codeclimate.com/github/welaika/simple_service_object)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_service_object'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_service_object
+
+## Usage
+
+### Basic usage
+
+Write your service object class, which must inherit from `SimpleServiceObject::Base` and must define
+a `call` instance method.
+
+```ruby
+  class SubscribeUser < SimpleServiceObject::Base
+    def initialize(user)
+      @user = user
+    end
+
+    def call
+      add_user_to_newsletter_recipients(@user)
+      notify_user(@user)
+    end
+
+    private
+
+    def add_user_to_newsletter_recipients(user)
+      # ...
+    end
+
+    def notify_user(user)
+      # ...
+    end
+  end
+```
+
+To run your command, simply:
+
+```ruby
+  SubscribeUser.call(my_new_user) # arguments are passed to your class '#initialize' method
+```
+
+### Return value and errors
+
+You can add errors using the `errors` method, which exposes to you an array of errors.
+
+```ruby
+class CalculateSquareRoot < SimpleServiceObject::Base
+  def initialize(number)
+    @number = number
+  end
+
+  def call
+    if number < 0
+      errors.push("Cannot calculate square root!")
+      return
+    end
+    Math.sqrt(@number)
+  end
+end
+```
+
+```ruby
+  result = CalculateSquareRoot.call(9)
+  result.success? # true
+  result.failure? # false
+  result.errors # []
+  result.value # 3.0
+```
+
+```ruby
+  result = CalculateSquareRoot.call(-1)
+  result.success? # false
+  result.failure? # true
+  result.errors # ["Cannot calculate square root!"]
+  result.value # nil
+```
+
+You can also use `.call!` instead of `.call`. If there aren't any errors, it will return the value,
+otherwise it will raise an exception.
+
+```ruby
+  CalculateSquareRoot.call!(9) # 3.0
+  CalculateSquareRoot.call!(-1) # raises SimpleServiceObject::FailureError
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run rubocop and tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/welaika/simple_service_object. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,12 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
+
+task default: :rubocop
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "simple_service_object"
+
+# 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/lib/simple_service_object.rb

@@ -0,0 +1,10 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+require "simple_service_object/version"
+require "simple_service_object/base"
+require "simple_service_object/result"
+require "simple_service_object/errors"
+
+module SimpleServiceObject
+end

data/lib/simple_service_object/base.rb

@@ -0,0 +1,26 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module SimpleServiceObject
+  class Base
+    def self.call(*args)
+      instance = new(*args)
+      result_value = instance.call
+      Result.new(result_value, instance.errors)
+    end
+
+    def self.call!(*args)
+      result = call(*args)
+      raise FailureError, result.errors.join(", ") if result.failure?
+      result.value
+    end
+
+    def call
+      raise NotImplementedError, "Should be implemented in subclass."
+    end
+
+    def errors
+      @errors ||= []
+    end
+  end
+end

data/lib/simple_service_object/errors.rb

@@ -0,0 +1,10 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module SimpleServiceObject
+  class Error < StandardError
+  end
+
+  class FailureError < Error
+  end
+end

data/lib/simple_service_object/result.rb

@@ -0,0 +1,21 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module SimpleServiceObject
+  class Result
+    attr_reader :errors, :value
+
+    def initialize(value, errors = [])
+      @value = value
+      @errors = Array(errors)
+    end
+
+    def success?
+      errors.empty?
+    end
+
+    def failure?
+      !success?
+    end
+  end
+end

data/lib/simple_service_object/version.rb

@@ -0,0 +1,6 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+module SimpleServiceObject
+  VERSION = "0.1.0"
+end

data/simple_service_object.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_service_object/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_service_object"
+  spec.version       = SimpleServiceObject::VERSION
+  spec.authors       = ["Fabrizio Monti"]
+  spec.email         = ["fabrizio.monti@welaika.com"]
+
+  spec.summary       = "Simple service object implementation."
+  spec.description   = <<-TEXT
+    It implements the command pattern in a simple way.
+  TEXT
+  spec.homepage      = "https://github.com/welaika/simple_service_object"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  if RUBY_VERSION < '2.0.0'
+    spec.add_development_dependency "rubocop", "~> 0.41.1"
+  else
+    spec.add_development_dependency "rubocop", "~> 0.46.0"
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: simple_service_object
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fabrizio Monti
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.46.0
+description: "    It implements the command pattern in a simple way.\n"
+email:
+- fabrizio.monti@welaika.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/simple_service_object.rb
+- lib/simple_service_object/base.rb
+- lib/simple_service_object/errors.rb
+- lib/simple_service_object/result.rb
+- lib/simple_service_object/version.rb
+- simple_service_object.gemspec
+homepage: https://github.com/welaika/simple_service_object
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Simple service object implementation.
+test_files: []