gourmet 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6659e4dffae66db91fc4833868d9f83634655827
+  data.tar.gz: 52e3c88d9f2acead46810501b3279d06293c5a07
+SHA512:
+  metadata.gz: 6b623272ac38a717582dd20b4ba7e39c2c448ef2c12df84b8ef16db92c7ef0e3b88df9049a85f8ffe4be8b592690f91bc0599e404865a5306989d40e464ec711
+  data.tar.gz: b4ca53b0c7426759acf0e1a8a108142965c104fdcb3666946418e7c29cf5720c64f607418b06b602ea224af223b70dcca44213bc67b78511308e07bd37ddb3d9

data/.gitignore

@@ -0,0 +1,45 @@
+# Numerous always-ignore extensions
+*.diff
+*.err
+*.orig
+*.log
+*.rej
+*.swo
+*.swp
+*.vi
+*~
+*.sass-cache
+
+# OS or Editor folders
+.DS_Store
+.cache
+.project
+.settings
+.tmproj
+nbproject
+Thumbs.db
+
+# Dreamweaver added files
+_notes
+dwsync.xml
+
+# Komodo
+*.komodoproject
+.komodotools
+
+# Folders to ignore
+.hg
+.svn
+.CVS
+intermediate
+publish
+.idea
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/
+.sass-cache/
+dump.rdb
+*.gem
+Makefile
+

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    gourmet (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.2)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  gourmet!
+  rspec (~> 3.0.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrew Berls
+
+MIT License
+
+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,68 @@
+# Gourmet
+
+Service Objects for Rails. Useful for extracting functionality out of long controller actions.
+Credit goes to [Philippe Creux](https://twitter.com/pcreux) for his original description of 'Gourmet Service Objects' in
+[this blog post](http://brewhouse.io/blog/2014/04/30/gourmet-service-objects.html).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gourmet'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gourmet
+
+
+
+## Usage
+
+Services are defined by subclassing `Gourmet::Service` and implementing a `#call` method. That's it! Service are an extremely thin wrapper over
+plain old Ruby objects, which make them easy to reason about and test in isolation.
+
+TODO: examples coming soon
+
+
+### Handling complex return values
+
+Gourmet ships with a built-in helper class `Gourmet::Result` for handling actions that may or may not succeed.
+`Result` has two subclasses `Success` and `Failure` (similar to Scala's Option library, or the [Possibly](https://github.com/rap1ds/ruby-possibly) gem in Ruby),
+which are instantiated using helper methods of the same name. Result objects implement `#success?` and `#failure?` query methods, and can also act as a wrapper
+for some value. To demonstrate:
+
+```ruby
+class DoWork < Gourmet::Service
+  def call(magic_number)
+    if magic_number == 7
+      Success(magic_number)
+    else
+      Failure()
+    end
+  end
+end
+
+result = DoWork.call(7)
+result.success? # => true
+result.value    # => 7
+
+result = DoWork.call(2)
+result.failure? # => true
+```
+
+Note that the use of the `Result` class and methods is completely optional - you're free to substitute your own mechanism for handling complex results,
+or forego it entirely.
+
+
+## Contributing
+
+1. Fork it ( http://github.com/andrewberls/gourmet/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/gourmet.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gourmet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gourmet'
+  spec.version       = Gourmet::VERSION
+  spec.authors       = ['Andrew Berls']
+  spec.email         = ['andrew.berls@gmail.com']
+  spec.summary       = %q{Gourmet Service Objects for Rails}
+  spec.description   = %q{An implementation of Service Objects for extracting functionality out of Rails controllers. Originally described by Philippe Creux in http://brewhouse.io/blog/2014/04/30/gourmet-service-objects.html}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+end

data/lib/gourmet.rb

@@ -0,0 +1,5 @@
+module Gourmet
+end
+
+require 'gourmet/service'
+require 'gourmet/result'

data/lib/gourmet/result.rb

@@ -0,0 +1,21 @@
+module Gourmet
+  class Result
+    attr_reader :value
+
+    def success?
+      is_a?(Success)
+    end
+
+    def failure?
+      is_a?(Failure)
+    end
+
+    def initialize(value)
+      @value = value
+    end
+  end
+
+
+  class Success < Result; end
+  class Failure < Result; end
+end

data/lib/gourmet/service.rb

@@ -0,0 +1,44 @@
+module Gourmet
+  class Service
+
+    def self.call(*args)
+      new.call(*args)
+    end
+
+    def call
+      raise "You must override #call in class #{self.class.name}"
+    end
+
+
+    # Helper methods for instantiating Success/Failure result objects
+    # inside Services
+    #
+    # Example:
+    #
+    #   class DoWork < Gourmet::Service
+    #     def call(magic_number)
+    #       if magic_number == 7
+    #         Success(magic_number)
+    #       else
+    #         Failure()
+    #       end
+    #     end
+    #   end
+    #
+    #   result = DoWork.call(7)
+    #   result.success? # => true
+    #   result.value    # => 7
+    #
+    #   result = DoWork.call(2)
+    #   result.failure? # => true
+
+    def Success(value = nil)
+      Gourmet::Success.new(value)
+    end
+
+    def Failure(value = nil)
+      Gourmet::Failure.new(value)
+    end
+
+  end
+end

data/lib/gourmet/version.rb

@@ -0,0 +1,3 @@
+module Gourmet
+  VERSION = '0.0.1'
+end

data/spec/result_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+class SucceedingService < Gourmet::Service
+  def call(value)
+    Success(value)
+  end
+end
+
+class FailingService < Gourmet::Service
+  def call(value)
+    Failure()
+  end
+end
+
+
+describe Gourmet::Result do
+  context '#success?' do
+    it 'is true for Gourmet::Success results' do
+      result = SucceedingService.call('test')
+      expect(result.success?).to eq true
+      expect(result.value).to eq 'test'
+    end
+
+    it 'is false for Gourmet::Failure results' do
+      result = FailingService.call('test')
+      expect(result.success?).to eq false
+    end
+  end
+
+
+  context '#failure?' do
+    it 'is false for Gourmet::Success results' do
+      result = SucceedingService.call('test')
+      expect(result.failure?).to eq false
+    end
+
+    it 'is true for Gourmet::Failure results' do
+      result = FailingService.call('test')
+      expect(result.failure?).to eq true
+    end
+  end
+end

data/spec/service_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+class DoWork < Gourmet::Service
+  def call(value)
+    value
+  end
+end
+
+describe Gourmet::Service do
+  context '.call' do
+    it 'delegates to #call' do
+      expect(DoWork.call(2)).to eq 2
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gourmet'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: gourmet
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Andrew Berls
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: An implementation of Service Objects for extracting functionality out
+  of Rails controllers. Originally described by Philippe Creux in http://brewhouse.io/blog/2014/04/30/gourmet-service-objects.html
+email:
+- andrew.berls@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- gourmet.gemspec
+- lib/gourmet.rb
+- lib/gourmet/result.rb
+- lib/gourmet/service.rb
+- lib/gourmet/version.rb
+- spec/result_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0
+signing_key: 
+specification_version: 4
+summary: Gourmet Service Objects for Rails
+test_files:
+- spec/result_spec.rb
+- spec/service_spec.rb
+- spec/spec_helper.rb