service-objecter 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57106416b9e845a3ba712be54cc61f56cf1d8a9c
+  data.tar.gz: ed9f9ec2225f398483588bfa4cd94b8438434fb4
+SHA512:
+  metadata.gz: d6d012ab9ca388b19187db3fb8961a2f157870d6169a9e1b56db6f4441e4227c98d9b41232ba03537d472dd9ac5c32d222491e312a73de6b5f103d41afcb2012
+  data.tar.gz: 7637a2b110650b5023285974032a165e9fc3b15ada5024886c4e7fb91e22259779b914746c6c037b7bb97b6bee37f710f97da6d175784eea457d58dab595053e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in chain_it.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 btolarz
+
+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,113 @@
+# ServiceObjecter
+
+[![CircleCI](https://circleci.com/gh/tier-tools/service_objecter/tree/master.svg?style=svg)](https://circleci.com/gh/tier-tools/service_objecter/tree/master)
+
+## Description
+
+Simple module, to tidy service objects.
+
+You can read our guide how we think service objects should works [The best service object (for us)](https://github.com/tier-tools/service_objecter/wiki/The-best-service-object-(for-us))
+
+## Usage
+
+### Always call service object in one way, ex. by `call` method.
+
+```ruby
+class Service
+  def call
+    puts 'hello'
+  end
+end
+
+Service.new.call
+```
+
+To simplify this ServiceObjecter provides some shortcuts
+
+```ruby
+class Service
+  include ServiceObjecter
+  def call
+    puts 'hello'
+  end
+end
+
+Service.call
+```
+
+### Returns result object as Result struct object
+
+```ruby
+class Service
+  include ServiceObjecter
+
+  def call
+    puts 'hello'
+    success('some value')
+  end
+end
+
+service = Service.call
+service.success? #=> true
+service.failure? #=> false
+service.value #=> 'some value'
+```
+
+With ServiceObjecter You can end call in many ways
+
+```ruby
+success(:optional_value)
+failed(:optional_value)
+Result.new(
+  true, #=> success?
+  'optional_value'
+)
+```
+
+## Full example
+
+
+```ruby
+class Service
+  include ServiceObjecter
+
+  def call(params) #=> instead of passing params to #new, do it in #call
+    a = params[:a]
+    # do something important
+    Result.new(true, a)# return result object
+  end
+end
+
+params = {a: 1}
+service = Service.call(params)
+
+if service.success?
+  puts service.value
+end
+```
+
+## ChainIt integration
+
+Install `ChainIt` to get more power of service objects.
+Read more [ChainIt gem](https://github.com/tier-tools/ChainIt)
+With `ServiceObjecter` you get shortcuts.
+
+```ruby
+class Service
+  include ServiceObjecter
+
+  def call(params)
+    chain { some method }
+    chain { other method }
+    result
+  end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tier-tools/service_objecter.
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'service_objecter'
+
+# 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(__FILE__)

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/service_objecter.rb

@@ -0,0 +1,70 @@
+require 'service_objecter/result'
+require 'service_objecter/chainit_integration'
+
+module ServiceObjecter
+  def self.included(klass)
+    klass.extend(ClassMethods)
+    klass.singleton_class.prepend(ChainitIntegration) if defined?(ChainIt)
+  end
+
+  module ClassMethods
+    def call(*args)
+      new.call(*args)
+    end
+  end
+
+  def call
+    raise NotImplementedError
+  end
+
+  private
+
+  def success(value = nil)
+    result.push(true, value)
+  end
+
+  def failed(value = nil)
+    result.push(false, value)
+  end
+
+  def crashed(error, value = nil)
+    log(error)
+    failed value || error
+  end
+
+  def log(data)
+    return unless defined?(Rails)
+    Rails.logger.error data
+  end
+
+  def result
+    @result ||= Result.new(true)
+  end
+
+  # Transactions helper
+  # Simple usage
+  #
+  # def call
+  #   with_transaction do
+  #     ChainIt.new.chain { failed }.result
+  #   end
+  # end
+  #
+  # def call
+  #   with_transaction do
+  #     failed
+  #   end
+  # end
+
+  def with_transaction
+    return yield unless defined?(ActiveRecord)
+    result = nil
+    ActiveRecord::Base.transaction(requires_new: true) do
+      result = yield
+      raise ActiveRecord::Rollback if result.failure?
+    end
+    result
+  end
+end
+
+require 'service_objecter/version'

data/lib/service_objecter/chainit_integration.rb

@@ -0,0 +1,31 @@
+require 'forwardable'
+module ServiceObjecter
+  module ChainitIntegration
+    extend(Forwardable)
+
+    def self.prepended(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def call(*args)
+        service = new
+        service.send :__set_chain__
+        service.call(*args)
+      end
+    end
+
+    def_delegators :@__chain__, :chain, :skip_next, :on_error, :result
+    alias run chain
+
+    private
+
+    def __set_chain__
+      @__chain__ = ChainIt.new
+    end
+
+    def __get_chain__
+      @__chain__
+    end
+  end
+end

data/lib/service_objecter/result.rb

@@ -0,0 +1,34 @@
+module ServiceObjecter
+  class Result
+    def initialize(success, value = nil)
+      @success, @value = success, value
+    end
+
+    def push(success, value = nil)
+      @success = success
+      store.merge!(value) if value.is_a?(Hash)
+      @value = value
+      self
+    end
+
+    def success?
+      @success
+    end
+
+    def failure?
+      !@success
+    end
+
+    def value
+      @value
+    end
+
+    def [](val)
+      @store[val]
+    end
+
+    def store
+      @store ||= Hash.new
+    end
+  end
+end

data/lib/service_objecter/version.rb

@@ -0,0 +1,3 @@
+module ServiceObjecter
+  VERSION = '1.0.1'.freeze
+end

data/service_objecter.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'service_objecter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'service-objecter'
+  spec.version       = ServiceObjecter::VERSION
+  spec.authors       = %w[btolarz nnande]
+  spec.email         = ['btolarz@gmail.com']
+
+  spec.summary       = 'Easy way to create service objects'
+  spec.description   = 'Easy way to create service objects'
+  spec.homepage      = 'https://github.com/tier-tools/service_objecter'
+  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.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: service-objecter
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- btolarz
+- nnande
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: Easy way to create service objects
+email:
+- btolarz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/service_objecter.rb
+- lib/service_objecter/chainit_integration.rb
+- lib/service_objecter/result.rb
+- lib/service_objecter/version.rb
+- service_objecter.gemspec
+homepage: https://github.com/tier-tools/service_objecter
+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.14
+signing_key: 
+specification_version: 4
+summary: Easy way to create service objects
+test_files: []