orc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 57771a0ccf6f041a6fa4b078d8e1afd949a45109
+  data.tar.gz: d516bad7021c748534a91cba5a83e0128631fb48
+SHA512:
+  metadata.gz: 6473d492c84c8c6a7f5cd620470199e19af61762043c9e9ab9cadfb135dc1b83c0f53e7c0752203d5c699f2f3c9f07565c1e6a3e90e1fa28a9d91578df46d26b
+  data.tar.gz: a0433644c852466a2efaba48dbaf11e7d9a35ca6d2614cc24f98e3d9019d90c97a49cb98dc7d597e203aa8150a0cc7ef4df0ca07389c4568a7737cecd28c46cb

data/.gitignore

@@ -0,0 +1,37 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## Rubinius
+*.rbc
+.rbx
+
+## PROJECT::GENERAL
+*.gem
+coverage
+profiling
+turbulence
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements
+
+## BUNDLER
+.bundle
+Gemfile.lock
+
+## PROJECT::SPECIFIC

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--profile
+--order random
+--format progress

data/.ruby-gemset

@@ -0,0 +1 @@
+orc

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+before_install: gem install bundler
+bundler_args: --without yard guard benchmarks
+script: "bundle exec rake ci"
+rvm:
+  - 1.9.3
+  - 2.1.2
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx-2
+matrix:
+  include:
+    - rvm: jruby-19mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: jruby-head
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+  allow_failures:
+    - rvm: ruby-head
+notifications:
+  email: false

data/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+Contributing
+------------
+
+* If you want your code merged into the mainline, please discuss the proposed changes with me before doing any work on it.
+* Fork the project.
+* Make your feature addition or bug fix.
+  * Follow this [style guide](https://github.com/dkubb/styleguide).
+* Add specs for it. This is important so I don't break it in a future version unintentionally. Tests must cover all branches within the code, and code must be fully covered.
+* Commit, do not mess with Rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Run "rake ci". This must pass and not show any regressions in the metrics for the code to be merged.
+* Send me a pull request. Bonus points for topic branches.

data/Changelog.md

@@ -0,0 +1 @@
+# v0.0.1 (Not yet released)

data/Gemfile

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'devtools', git: 'https://github.com/rom-rb/devtools.git', branch: 'master'
+end
+
+# added by devtools
+eval_gemfile 'Gemfile.devtools'

data/Gemfile.devtools

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+group :development do
+  gem 'rake',       '~> 10.3.2'
+  gem 'rspec',      '~> 3.0.0'
+  gem 'rspec-its',  '~> 1.0.1'
+  gem 'yard',       '~> 0.8.7.4'
+
+  platform :rbx do
+    gem 'rubysl-singleton', '~> 2.0.0'
+  end
+end
+
+group :yard do
+  gem 'kramdown', '~> 1.3.3'
+end
+
+group :guard do
+  gem 'guard',         '~> 2.6.1'
+  gem 'guard-bundler', '~> 2.0.0'
+  gem 'guard-rspec',   '~> 4.2.9'
+  gem 'guard-rubocop', '~> 1.1.0'
+
+  # file system change event handling
+  gem 'listen',     '~> 2.7.7'
+  gem 'rb-fchange', '~> 0.0.6', require: false
+  gem 'rb-fsevent', '~> 0.9.4', require: false
+  gem 'rb-inotify', '~> 0.9.5', require: false
+
+  # notification handling
+  gem 'libnotify',               '~> 0.8.3', require: false
+  gem 'rb-notifu',               '~> 0.0.4', require: false
+  gem 'terminal-notifier-guard', '~> 1.5.3', require: false
+end
+
+group :metrics do
+  gem 'coveralls', '~> 0.7.0'
+  gem 'flay',      '~> 2.5.0'
+  gem 'flog',      '~> 4.2.1'
+  gem 'reek',      '~> 1.3.7'
+  gem 'rubocop',   '~> 0.23.0'
+  gem 'simplecov', '~> 0.7.1'
+  gem 'yardstick', '~> 0.9.9'
+
+  platforms :mri do
+    gem 'mutant',       '~> 0.5.23'
+    gem 'mutant-rspec', '~> 0.5.21'
+  end
+
+  platforms :ruby_19, :ruby_20 do
+    gem 'yard-spellcheck', '~> 0.1.5'
+  end
+
+  platform :rbx do
+    gem 'json',               '~> 1.8.1'
+    gem 'racc',               '~> 1.4.11'
+    gem 'rubysl-logger',      '~> 2.0.0'
+    gem 'rubysl-open-uri',    '~> 2.0.0'
+    gem 'rubysl-prettyprint', '~> 2.0.3'
+  end
+end
+
+group :benchmarks do
+  gem 'rbench', '~> 0.2.3'
+end
+
+platform :jruby do
+  group :jruby do
+    gem 'jruby-openssl', '~> 0.9.4'
+  end
+end

data/Guardfile

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+guard :bundler do
+  watch('Gemfile')
+end
+
+guard :rspec, :all_on_start => false, :all_after_pass => false, :cli => '--fail-fast --seed 1' do
+  # run all specs if the spec_helper or supporting files files are modified
+  watch('spec/spec_helper.rb')                      { 'spec/unit' }
+  watch(%r{\Aspec/(?:lib|support|shared)/.+\.rb\z}) { 'spec/unit' }
+
+  # run unit specs if associated lib code is modified
+  watch(%r{\Alib/(.+)\.rb\z})                                         { |m| Dir["spec/unit/#{m[1]}"] }
+  watch("lib/#{File.basename(File.expand_path('../', __FILE__))}.rb") { 'spec/unit'                       }
+
+  # run a spec if it is modified
+  watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Martin Gamsjaeger (snusnu)
+
+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,70 @@
+# orc
+
+[![Gem Version](https://badge.fury.io/rb/orc.png)][gem]
+[![Build Status](https://secure.travis-ci.org/snusnu/orc.png?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/snusnu/orc.png)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/snusnu/orc.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/snusnu/orc/badge.png?branch=master)][coveralls]
+
+[gem]: https://rubygems.org/gems/orc
+[travis]: https://travis-ci.org/snusnu/orc
+[gemnasium]: https://gemnasium.com/snusnu/orc
+[codeclimate]: https://codeclimate.com/github/snusnu/orc
+[coveralls]: https://coveralls.io/r/snusnu/orc
+
+## Usage
+
+Whenever you want to communicate success or failure of an operation, the following might be handy
+
+```ruby
+describe Orc::Result do
+  describe '.success' do
+    subject { Orc::Result.success(object) }
+
+    let(:object) { :object }
+
+    it 'signals success' do
+      expect(subject.success?).to be(true)
+    end
+
+    it 'returns :success state' do
+      expect(subject.status).to be(:success)
+    end
+
+    it 'exposes the associated object' do
+      expect(subject.object).to be(object)
+    end
+  end
+
+  describe '.failure' do
+    subject { Orc::Result.failure(status, context) }
+
+    let(:status)  { :confused }
+    let(:context) { :context }
+
+    it 'signals failure' do
+      expect(subject.success?).to be(false)
+    end
+
+    it 'returns :success state' do
+      expect(subject.status).to be(status)
+    end
+
+    it 'exposes the associated context' do
+      expect(subject.context).to be(context)
+    end
+  end
+end
+```
+
+## Credits
+
+* [snusnu](https://github.com/snusnu)
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## Copyright
+
+Copyright © 2014 Martin Gamsjaeger (snusnu). See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+require 'rake'
+require 'devtools'
+
+Devtools.init_rake_tasks

data/TODO.md

@@ -0,0 +1 @@
+*

data/config/devtools.yml

@@ -0,0 +1,2 @@
+---
+unit_test_timeout: 0.1

data/config/flay.yml

@@ -0,0 +1,3 @@
+---
+threshold: 4
+total_score: 8

data/config/flog.yml

@@ -0,0 +1,2 @@
+---
+threshold: 1.1

data/config/mutant.yml

@@ -0,0 +1,3 @@
+---
+name: orc
+namespace: Orc

data/config/reek.yml

@@ -0,0 +1,104 @@
+---
+Attribute:
+  enabled: true
+  exclude: []
+BooleanParameter:
+  enabled: true
+  exclude: []
+ClassVariable:
+  enabled: true
+  exclude: []
+ControlParameter:
+  enabled: true
+  exclude: []
+DataClump:
+  enabled: true
+  exclude: []
+  max_copies: 2
+  min_clump_size: 2
+DuplicateMethodCall:
+  enabled: true
+  exclude: []
+  max_calls: 1
+  allow_calls: []
+FeatureEnvy:
+  enabled: true
+  exclude: []
+IrresponsibleModule:
+  enabled: true
+  exclude: []
+LongParameterList:
+  enabled: true
+  exclude: []
+  max_params: 3
+  overrides:
+    initialize:
+      max_params: 3
+LongYieldList:
+  enabled: true
+  exclude: []
+  max_params: 2
+NestedIterators:
+  enabled: true
+  exclude: []
+  max_allowed_nesting: 1
+  ignore_iterators: []
+NilCheck:
+  enabled: true
+  exclude: []
+RepeatedConditional:
+  enabled: true
+  exclude: []
+  max_ifs: 1
+TooManyInstanceVariables:
+  enabled: true
+  exclude: []
+  max_instance_variables: 3
+TooManyMethods:
+  enabled: true
+  exclude: []
+  max_methods: 10
+TooManyStatements:
+  enabled: true
+  exclude:
+  - each
+  max_statements: 3
+UncommunicativeMethodName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^[a-z]$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeModuleName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  accept: []
+UncommunicativeParameterName:
+  enabled: true
+  exclude: []
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UncommunicativeVariableName:
+  enabled: true
+  exclude:
+  - "r" # used in routes block
+  reject:
+  - !ruby/regexp /^.$/
+  - !ruby/regexp /[0-9]$/
+  - !ruby/regexp /[A-Z]/
+  accept: []
+UnusedParameters:
+  enabled: true
+  exclude: []
+UtilityFunction:
+  enabled: true
+  exclude: []
+  max_helper_calls: 0

data/config/rubocop.yml

@@ -0,0 +1,75 @@
+AllCops:
+  Includes:
+    - '**/*.rake'
+    - 'Gemfile'
+    - 'Gemfile.devtools'
+  Excludes:
+    - '**/vendor/**'
+    - '**/benchmarks/**'
+
+# Avoid parameter lists longer than five parameters.
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Align with the style guide.
+CollectionMethods:
+  PreferredMethods:
+    collect:  'map'
+    inject:   'reduce'
+    find:     'detect'
+    find_all: 'select'
+
+# Limit line length
+LineLength:
+  Max: 81
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Do not favor modifier if/unless usage when you have a single-line body
+IfUnlessModifier:
+  Enabled: false
+
+# Allow case equality operator (in limited use within the specs)
+CaseEquality:
+  Enabled: false
+
+# Constants do not always have to use SCREAMING_SNAKE_CASE
+ConstantName:
+  Enabled: false
+
+# Not all trivial readers/writers can be defined with attr_* methods
+TrivialAccessors:
+  Enabled: false
+
+# Do not prefer do/end over {} for multiline blocks
+Blocks:
+  Enabled: false
+
+# Do not favor aligned parameters in method calls
+AlignParameters:
+  Enabled: false
+
+HashSyntax:
+  Enabled: false
+
+SpaceInsideBrackets:
+  Enabled: false
+
+Lambda:
+  Enabled: false # i personally like the look of multiline ->(arg) {} lambdas
+
+AndOr:
+  Enabled: false # we agree to use and/or for control flow
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/EmptyLinesAroundBody:
+  Enabled: false

data/config/yardstick.yml

@@ -0,0 +1,2 @@
+---
+threshold: 100

data/lib/orc.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+
+require 'concord'
+require 'abstract_type'
+
+# Operation result class
+module Orc
+
+  # Abstract base class for a result returned from some computation
+  class Result
+
+    # Create a result indicating success
+    #
+    # @param [Object] object
+    #   arbitrary data associated with the result
+    #
+    # @return [Success]
+    def self.success(object)
+      Success.new(object)
+    end
+
+    # Create a result indicating failure
+    #
+    # @param [Object] status
+    #   an arbitrary status description (symbol)
+    #
+    # @param [Object] context
+    #   context information associated with the failure
+    #
+    # @return [Success]
+    def self.failure(status, context)
+      Failure.new(status, context)
+    end
+
+    include AbstractType
+
+    abstract_method :success?
+    abstract_method :status
+
+    # Result object indicating success along with associated data
+    class Success < self
+      include Concord::Public.new(:object)
+
+      # Indicate success
+      #
+      # @return [true]
+      def success?
+        true
+      end
+
+      # Status description
+      #
+      # @return [:success]
+      def status
+        :success
+      end
+    end # Success
+
+    # Result object indicating failure along with status and context
+    class Failure < self
+      include Concord::Public.new(:status, :context)
+
+      # Indicate success
+      #
+      # @return [false]
+      def success?
+        false
+      end
+    end # Failure
+  end # Result
+end # Orc

data/lib/orc/version.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+module Orc
+  VERSION = '0.0.1'.freeze
+end # Orc

data/orc.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/orc/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "orc"
+  gem.version     = Orc::VERSION.dup
+  gem.authors     = [ "Martin Gamsjaeger (snusnu)" ]
+  gem.email       = [ "gamsnjaga@gmail.com" ]
+  gem.description = "Operation result class"
+  gem.summary     = "Provides Result.success(object) and Result.failure(status, context)"
+  gem.homepage    = "https://github.com/snusnu/orc"
+
+  gem.require_paths    = [ "lib" ]
+  gem.files            = `git ls-files`.split("\n")
+  gem.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  gem.extra_rdoc_files = %w[LICENSE README.md TODO.md]
+  gem.license          = 'MIT'
+
+  gem.add_dependency 'concord',             '~> 0.1', '>= 0.1.5'
+  gem.add_dependency 'abstract_type',       '~> 0.0', '>= 0.0.7'
+
+  gem.add_development_dependency 'bundler', '~> 1.6', '>= 1.6.5'
+  gem.add_development_dependency 'rspec',   '~> 3.0', '>= 3.0.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name     'spec:unit'
+    add_filter       'config'
+    add_filter       'spec'
+    minimum_coverage 100
+  end
+end
+
+require 'orc'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.mock_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/unit/orc/result_spec.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Orc::Result do
+  describe '.success' do
+    subject { Orc::Result.success(object) }
+
+    let(:object) { :object }
+
+    it 'signals success' do
+      expect(subject.success?).to be(true)
+    end
+
+    it 'returns :success state' do
+      expect(subject.status).to be(:success)
+    end
+
+    it 'exposes the associated object' do
+      expect(subject.object).to be(object)
+    end
+  end
+
+  describe '.failure' do
+    subject { Orc::Result.failure(status, context) }
+
+    let(:status)  { :confused }
+    let(:context) { :context }
+
+    it 'signals failure' do
+      expect(subject.success?).to be(false)
+    end
+
+    it 'returns :success state' do
+      expect(subject.status).to be(status)
+    end
+
+    it 'exposes the associated context' do
+      expect(subject.context).to be(context)
+    end
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: orc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Martin Gamsjaeger (snusnu)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: abstract_type
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !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'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Operation result class
+email:
+- gamsnjaga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+- TODO.md
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Changelog.md
+- Gemfile
+- Gemfile.devtools
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- config/devtools.yml
+- config/flay.yml
+- config/flog.yml
+- config/mutant.yml
+- config/reek.yml
+- config/rubocop.yml
+- config/yardstick.yml
+- lib/orc.rb
+- lib/orc/version.rb
+- orc.gemspec
+- spec/spec_helper.rb
+- spec/unit/orc/.gitkeep
+- spec/unit/orc/result_spec.rb
+homepage: https://github.com/snusnu/orc
+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: Provides Result.success(object) and Result.failure(status, context)
+test_files: []
+has_rdoc: