haltable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37e7c0750250355a8bf0154dd9b828a831e37fc0
+  data.tar.gz: 10fd5467b7d4b88cf40df1592f8ddb898111731f
+SHA512:
+  metadata.gz: 89cae40b2b9eee0cee4cf1084803c28b71dd4230369e3a73f81515de25ec99415d599b48ef31ed7080df268c81d8ef19efbe165f35c7bec4e10373bd4d4bc837
+  data.tar.gz: 8bff808fbb01912c2cddb6c92ba905ad25bc5773882aefcf4279a34ad361894a12b319303c1ecb0384920437d3b3a04d6d9c7071a022d46fe0cd5005a82223ca

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.5
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in haltable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Guillaume Malette
+
+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,49 @@
+# Haltable
+
+Haltable is a gem that allows halting controller actions to simplify the flows.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'haltable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install haltable
+
+## Usage
+
+```ruby
+class AwesomesController < ApplicationController
+  def update
+    haltable do
+      verify_something
+      verify_something_else
+
+      awesome.update(params)
+    end
+  end
+
+  private
+  def verify_something
+    return if something.valid?
+    render :somethings_not_valid
+    halt
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/haltable/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/haltable.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'haltable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "haltable"
+  spec.version       = Haltable::VERSION
+  spec.authors       = ["Guillaume Malette"]
+  spec.email         = ["gmalette@gmail.com"]
+  spec.summary       = %q{Haltable gem for Ruby}
+  spec.description   = %q{Haltable is a gem that allows halting controller actions to simplify the flows.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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 "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1.0"
+end

data/lib/haltable.rb

@@ -0,0 +1,16 @@
+require "haltable/version"
+
+module Haltable
+  protected
+  def haltable
+    catch(:halt) do
+      yield if block_given?
+      return false
+    end
+    true
+  end
+
+  def halt
+    throw(:halt)
+  end
+end

data/lib/haltable/version.rb

@@ -0,0 +1,3 @@
+module Haltable
+  VERSION = "0.0.1"
+end

data/spec/haltable_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'haltable'
+
+module Spec
+  class Controller
+    include Haltable
+
+    def halted_action
+      halted = haltable do
+        update
+        halt
+        fail
+      end
+
+      render
+      halted
+    end
+
+    def unhalted_action
+      halted = haltable do
+        update
+      end
+
+      halted
+    end
+
+    def update
+    end
+
+    def render
+    end
+  end
+end
+
+RSpec.describe Haltable do
+  let(:controller) { Spec::Controller.new }
+
+  it 'returns early when halted' do
+    allow(controller).to receive(:update).once
+    allow(controller).to receive(:render).once
+    allow(controller).to receive(:fail).never
+
+    controller.halted_action
+  end
+
+  it 'returns true if halted' do
+    expect(controller.halted_action).to be true
+  end
+
+  it 'returns false if not halted' do
+    expect(controller.unhalted_action).to be false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.disable_monkey_patching!
+
+  config.warnings = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: haltable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Guillaume Malette
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Haltable is a gem that allows halting controller actions to simplify
+  the flows.
+email:
+- gmalette@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- haltable.gemspec
+- lib/haltable.rb
+- lib/haltable/version.rb
+- spec/haltable_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.2
+signing_key: 
+specification_version: 4
+summary: Haltable gem for Ruby
+test_files:
+- spec/haltable_spec.rb
+- spec/spec_helper.rb