basic_service 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e933ceced4c2ef5c0cef61cd59ab0883fbbcf0b0
+  data.tar.gz: 16e82a8d106a9bf259a1d2257f8fb6c0b2b54e55
+SHA512:
+  metadata.gz: 1c27b98b3ca60fc38efc5446f093543071ebfb532f9a8a71f20bbf4670e7ea7483b937e7b0e27821b601fdf46ba79721fb03a0f5c59c37523dc1eaadda84a7b2
+  data.tar.gz: 111cf3a08adf541d1acf618cc322cc060cf4a08ce450dda0bf40cb60ce5f6fdde66e827fefb23d70519010ae22f59e5d05c84294627bbcf9e2bd72779d28019b

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+*.rbc
+/.config
+/pkg/
+/tests/tmp/
+/tests/version_tmp/
+/tmp/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+.idea/

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Julián Porta
+
+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,64 @@
+# basic_service
+
+Simple class for a simple service object implementation.
+
+While there are a few different implementations for this pattern out there, this particular has a few unique (I think) features.
+
+  - It forces you to call `success()` or `error()` inside the `call()` method in order to access the `result?` method (or it will raise a `RuntimeError` if you haven't)
+
+  - It raises a `RuntimeError` if both `success()` and `error()` are called.
+
+  - It allows a return value independently of the `message` method.
+
+
+## Usage
+
+```ruby
+# Gemfile
+gem 'basic_service'
+
+
+# my_service.rb
+class MyService < Basic::Service
+
+  def call
+    first_param = args.pop #args contains the parameters passed to the call function
+    if first_param == "foo"
+      success('foo found') # call #success() to make #success? return true.
+    else
+      error('foo not found') # calling #error() will make #success? return false
+    end
+    "I'm done"  #this return value is passed as result from the #call() method itself,
+                #independently from the #success? and #message methods
+  end
+
+end
+
+# somewhere_else.rb
+require_relative 'my_service'
+
+service = MyService.call('foo')
+
+service.success?
+# => true
+service.message
+# => "foo found"
+service.error?
+# => false
+service.result
+# => "I'm done"
+
+service = MyService.call('bar')
+
+service.success?
+# => false
+service.message
+# => "foo not found"
+service.error?
+# => true
+service.result
+# => "I'm done"
+
+```
+
+## More to come

data/basic_service.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |s|
+  s.name = 'basic_service'
+  s.version = '0.0.1'
+  s.summary = 'Simple class for a simple service object implementation.'
+  s.authors = ['Julián Porta']
+  s.email = ['julian@porta.sh']
+  s.homepage = "http://github.com/Porta/basic_service/"
+  s.license = "MIT"
+  s.files = `git ls-files`.split("\n")
+  s.add_development_dependency "minitest", '~>5.5'
+end

data/lib/basic_service.rb

@@ -0,0 +1,48 @@
+# encoding: UTF-8
+module Basic
+  class Service
+
+    def self.call(args)
+      new(args).tap do |basic_service|
+        basic_service.instance_eval do
+          self.result = call
+        end
+      end
+    end
+
+    def success(str = '')
+      @success = true
+      @message = str
+      @pristine = true
+    end
+
+    def error(str = '')
+      @error = true
+      @message = str
+      @pristine = true
+    end
+
+    def initialize(*args)
+      @args = args
+      @success = false
+      @error = false
+      @pristine = false
+    end
+
+    attr_accessor :result
+    attr_reader :args, :message
+    private :result=, :args
+
+    # Defaults to the boolean'ed result of "call"
+    def success?
+      raise RuntimeError, "#success or #error should be called inside #call" unless @pristine
+      raise RuntimeError, "both #success and #error where called" if (@success && @error)
+      @success && !@error
+    end
+
+    # method error if call not defined
+    def call
+      raise NoMethodError, "Called undefined #call. You need to implement the method in the class: #{self.class.name}"
+    end    
+  end
+end

data/makefile

@@ -0,0 +1,4 @@
+all: test
+
+test:
+	ruby ./tests/test_class.rb

data/tests/bad_test.rb

@@ -0,0 +1,6 @@
+class BadTest < Basic::Service
+  def call
+    something = args.pop
+    "this is the result"
+  end
+end

data/tests/good_test.rb

@@ -0,0 +1,11 @@
+class GoodTest < Basic::Service
+  def call
+    something = args.pop
+    if something == 'mimimi'
+      success("success is great")
+    else
+      error("error is for loosers")
+    end
+    "this is the result"
+  end
+end

data/tests/test_class.rb

@@ -0,0 +1,49 @@
+#! /usr/bin/env ruby
+require 'minitest/autorun'
+require_relative '../lib/basic_service'
+
+require_relative './good_test.rb'
+require_relative './bad_test.rb'
+require_relative './ugly_test.rb'
+
+class TestClass < Minitest::Test
+
+  def test_success_should_work
+    test = GoodTest.call('mimimi')
+    assert_equal test.success?, true
+    assert_equal test.message, "success is great"
+  end
+
+  def test_error_should_work
+    test = GoodTest.call('mandanga')
+    assert_equal test.success?, false
+    assert_equal test.message, "error is for loosers"
+  end
+
+  def test_result
+    test = GoodTest.call('mimimi')
+    assert_equal test.result, "this is the result"
+  end
+
+
+  def test_raise_if_not_pristine
+    test = BadTest.call('mimimi')
+    exception = assert_raises(RuntimeError) { test.success? }
+    assert_equal("#success or #error should be called inside #call", exception.message) 
+  end
+
+  def test_raise_if_success_and_error
+    test = UglyTest.call('Pistola')
+    exception = assert_raises(RuntimeError) { test.success? }
+    assert_equal("both #success and #error where called", exception.message) 
+  end
+
+
+  def test_instance_cases
+    mimimi = GoodTest.call('mimimi')
+    foo = GoodTest.call('foo')
+    refute_equal mimimi.object_id, foo.object_id
+    refute_equal mimimi.message, foo.message
+  end
+
+end

data/tests/ugly_test.rb

@@ -0,0 +1,8 @@
+class UglyTest < Basic::Service
+  def call
+    something = args.pop
+    success("success is great")
+    error("error is for loosers")
+    "this is the result"
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: basic_service
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Julián Porta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.5'
+description: 
+email:
+- julian@porta.sh
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- basic_service.gemspec
+- lib/basic_service.rb
+- makefile
+- tests/bad_test.rb
+- tests/good_test.rb
+- tests/test_class.rb
+- tests/ugly_test.rb
+homepage: http://github.com/Porta/basic_service/
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple class for a simple service object implementation.
+test_files: []