outcome 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2593a37dfe72ad4289cd5b9fbaa2deee9d8597c0
-  data.tar.gz: 451a46c5fc3efe5a453ec954cb08fc973d3b1977
+  metadata.gz: befe3c2c0b282b581de7fbb15fda29557e81da94
+  data.tar.gz: c92ada2f4a554925cd55f8107434ce44dfad7fba
 SHA512:
-  metadata.gz: fc495d6f38df0cfaf424ca808ed0e2d57a4d4a6b07815fd8ab14f5fc604698fd2d1c61619bfac5829c790270d90d1c61edfe6abd96e70bfbf07ca526810b0ba1
-  data.tar.gz: c4b68c86724c68e34c716a11b710d856047497e341902cf3fd84834009b2e2473121ad8515033f02f9f5be3ca475c59fa579a98484800774a94f09cc9f1c05a3
+  metadata.gz: 0a4cb88c4440215764a7c141964f62a0080de8fd8be1f964ab2d9f84ec77c5390cd47d30d6e95c4cc94048374a07e79543ed0a74ea58fe000d90231dc332fb84
+  data.tar.gz: a9040656a7eef6e595eb7b5e1c96be84361d1835971da2ce5b8eba0c4806cc4b879858943119e652ce09f6d9bc49e6ff73bee6d3f23c93b54db0d17cb3e0160e

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push "lib"
+  t.pattern = "spec/**/*_spec.rb"
+  t.verbose = true
+end
+
+task :default => ['test']

data/lib/outcome.rb

@@ -0,0 +1,27 @@
+class Outcome
+
+  attr_reader :success, :result, :messages, :errors, :warnings
+
+  # Initializes an Outcome instance
+  # @param[Boolean] success indicates if process was successful.
+  # @param[Object] result the return value of the process. Anything you want to return
+  # @param[Array<String>, optional] messages messages as Array of strings, optional
+  # @param[Array<String>, optional] errors errors as Array of strings, optional
+  # @param[Array<String>, optional] warnings warnings as Array of strings, optional
+  def initialize(success, result, messages = [], errors = [], warnings = [])
+    @success, @result, @messages, @errors, @warnings = success, result, messages, errors, warnings
+  end
+
+  def success?
+    @success
+  end
+
+  def fail?
+    !@success
+  end
+
+  def messages_to_html
+    @messages.join('<br/>')
+  end
+
+end

data/outcome.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'outcome'
+  spec.version       = '1.0.1'
+  spec.authors       = ['Jo Hund']
+  spec.email         = ['jhund@clearcove.ca']
+  spec.summary       = %q{Outcome provides a standardized container for the outcome of a Ruby process.}
+  spec.description   = %q{Outcome provides a standardized container for the outcome of a Ruby process.}
+  spec.homepage      = 'http://rails-recipes.clearcove.ca/pages/outcome.html'
+  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('rake')
+  spec.add_development_dependency('minitest')
+  spec.add_development_dependency('minitest-spec-expect')
+end

data/spec/outcome_spec.rb

@@ -0,0 +1,44 @@
+# dependencies
+require 'rubygems'
+require 'minitest'
+require 'minitest/autorun'
+
+# Gem under test
+require 'outcome'
+
+describe Outcome do
+
+  describe '#initialize and accessors' do
+    let(:outcome) { Outcome.new(true, 'result', ['message'], ['error'], ['warning']) }
+    [
+      [:success, true],
+      [:result, 'result'],
+      [:messages, ['message']],
+      [:errors, ['error']],
+      [:warnings, ['warning']],
+    ].each do |attr, expectation|
+      it "has the #{ attr } attribute" do
+        outcome.send(attr).must_equal(expectation)
+      end
+    end
+  end
+
+  describe '#success' do
+    it 'handles true' do
+      Outcome.new(true, nil).success?.must_equal true
+    end
+
+    it 'handles false' do
+      Outcome.new(false, nil).success?.must_equal false
+    end
+  end
+
+  describe '#messages_to_html' do
+    it 'returns messages as a string, each on a new line' do
+      Outcome.new(true, nil, %w[m1 m2 m3]).messages_to_html.must_equal(
+        'm1<br/>m2<br/>m3'
+      )
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: outcome
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jo Hund
@@ -62,6 +62,10 @@ files:
 - .gitignore
 - LICENSE
 - README.md
+- Rakefile
+- lib/outcome.rb
+- outcome.gemspec
+- spec/outcome_spec.rb
 homepage: http://rails-recipes.clearcove.ca/pages/outcome.html
 licenses:
 - MIT
@@ -86,4 +90,5 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Outcome provides a standardized container for the outcome of a Ruby process.
-test_files: []
+test_files:
+- spec/outcome_spec.rb