farah 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 263fc057737c09addca0efa70b5eaee932c6af6a
-  data.tar.gz: 13335817e964656a896ca9bc0be6b81601fd0e1f
+  metadata.gz: e828bce0fd5655a3f8c9ede3c673b44bc9ede83e
+  data.tar.gz: 4d10b0c3b6c76cbd3b9a63cf35812f741390582f
 SHA512:
-  metadata.gz: bf82066b3bf7fdf6dd906e5a847e819348b88798fa014d59be407c8640b08ce6d42d0c14c6910d11e860979796e5f00d0f1578035315811b4fab26f768748078
-  data.tar.gz: 52ecb0e02a27a72fb843656e28260bbab0a4423ac508d0bf36b9afeafc1901843feaf69c64ff2b071cbd0764a6126c0aa92d4ad2b751547c0a8dea574999439d
+  metadata.gz: 9f6889814563bedbb63a3f7e40d0876c8d006fc213c2a3e1de7ad8359050145ccaba7c5b9f31f8e3a695fe6830cc8a03d94542c35bcfe93a0a27c3e70f18e832
+  data.tar.gz: 2b6a092ae68913fea62f407faaab8adef1621f827cae7d1873160089943e2f2b762c3b7355ad55f2269088384c56b1baae4cfe9fd1d1d7f60c33b23c6e739386

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.DS_Store
+*.gem

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Steven Weiss
+
+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,29 @@
+# Farah
+
+Farah is a tiny library for implementing "runners" (service objects).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'farah'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install farah
+
+For RubyMotion, require the gem inside your Gemfile:
+
+```ruby
+require 'farah'
+```
+
+## 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,5 @@
+task :spec do
+  Dir.glob('./spec/**/*_spec.rb').each { |file| require file }
+end
+
+task default: :spec

data/farah.gemspec

@@ -0,0 +1,12 @@
+require_relative './lib/farah/version'
+
+Gem::Specification.new do |s|
+  s.name     = 'farah'
+  s.summary  = 'Farah'
+  s.version  = Farah::VERSION
+  s.authors  = ['Steve Weiss']
+  s.email    = ['weissst@mail.gvsu.edu']
+  s.homepage = 'https://github.com/sirscriptalot/farah'
+  s.license  = 'MIT'
+  s.files    = `git ls-files`.split("\n")
+end

data/lib/farah.rb

@@ -0,0 +1,60 @@
+module Farah
+  module Helpers
+    def start(klass, action, *args)
+      klass.new(self, action).call(*args)
+    end
+  end
+
+  module Results
+    class Result
+      attr_reader :payload
+
+      def initialize(payload)
+        @payload = payload
+      end
+    end
+
+    class Success < Result
+      def success?
+        true
+      end
+
+      def failure?
+        false
+      end
+    end
+
+    class Failure < Result
+      def success?
+        false
+      end
+
+      def failure?
+        true
+      end
+    end
+  end
+
+  class Runner
+    def initialize(context, action)
+      @context = context
+      @action  = action
+    end
+
+    def call(*args)
+      catch(:finish) { send(action, *args) }
+    end
+
+    private
+
+    attr_reader :context, :action
+
+    def success!(payload)
+      throw :finish, Results::Success.new(payload)
+    end
+
+    def failure!(payload)
+      throw :finish, Results::Failure.new(payload)
+    end
+  end
+end

data/lib/farah/version.rb

@@ -0,0 +1,3 @@
+module Farah
+  VERSION = '0.2.0'.freeze
+end

data/spec/farah_spec.rb

@@ -0,0 +1,74 @@
+require_relative './spec_helper'
+
+module Runners
+  include Farah::Helpers
+
+  class Foo < Farah::Runner
+    def bar(sym)
+      success!('success!') if sym == :bar
+      failure!('failure!')
+    end
+
+    def qux(value)
+      value
+    end
+  end
+end
+
+class Controller
+  include Runners
+
+  attr_reader :success, :failure
+
+  def initialize
+    @success = nil
+    @failure = nil
+  end
+
+  def call(value)
+    start(Foo, :bar, value)
+  end
+end
+
+describe 'Farah::Helpers' do
+  before do
+    @controller = Controller.new
+  end
+
+  describe '#start' do
+    it 'calls action on runner with value' do
+      value = '123'
+
+      assert_equal @controller.start(Runners::Foo, :qux, value), value
+    end
+  end
+end
+
+describe 'Farah::Runner' do
+  before do
+    @controller = Controller.new
+  end
+
+  describe '#success!' do
+    it 'sends payload with result' do
+      result = @controller.call(:bar)
+
+      assert       result.success?
+      assert_equal result.payload, 'success!'
+    end
+  end
+
+  describe '#failure!' do
+    def @controller.bar
+      failure!('failure!') unless sym == :bar
+      success!('success!')
+    end
+
+    it 'sends payload with result' do
+      result = @controller.call(:baz)
+
+      assert       result.failure?
+      assert_equal result.payload, 'failure!'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'minitest/autorun'
+require_relative '../lib/farah'
+
+def context(*args, &block)
+  describe(*args, &block)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: farah
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Steve Weiss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-30 00:00:00.000000000 Z
+date: 2016-12-04 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -16,7 +16,17 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- farah.gemspec
+- lib/farah.rb
+- lib/farah/version.rb
+- spec/farah_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/sirscriptalot/farah
 licenses:
 - MIT