resultable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11270d59cfd27594b90ac4ab578801eb507cc274
+  data.tar.gz: e8f4d86b2d1cb7de01f474ecb27d055a081fd260
+SHA512:
+  metadata.gz: 85cc5e18cffd51c31cf68e395c4774370465bfb66999b5860be252dfd7c02af66cce6be4ee6bb2339a12e94b267d274619e47e236de1780c93e5fa6b1ff19300
+  data.tar.gz: 8df54a0fef6644de9b583a5c144c548d90712a68bfc747c61649eef7ce036a8f4e7512cf419de88a8824693d43f53ef19af3030957734fc9dcf1b7e168100309

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ruslan Milevskiy
+
+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,52 @@
+# Resultable
+
+Simple ruby gem that provides reusable result object
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resultable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resultable
+
+## Usage
+
+Include Resultable in any class that you want
+
+```ruby
+class Service
+  include Resultable
+end
+```
+
+Use result object
+
+```ruby
+service = Service.new
+puts service.result.successful?
+=> false
+puts service.result.error?
+=> true
+service.result.successful!
+puts service.result.successful?
+=> true
+puts service.result.error?
+=> false
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/resultable/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/lib/resultable/result.rb

@@ -0,0 +1,33 @@
+module Resultable
+  class Result
+
+    module Status
+      SUCCESSFUL = 'successful'
+      ERROR = 'error'
+    end
+
+    attr_accessor :status, :response
+
+    def initialize
+      self.error!
+    end
+
+    def successful!
+      self.status = Status::SUCCESSFUL
+      self
+    end
+
+    def successful?
+      self.status == Status::SUCCESSFUL
+    end
+
+    def error!
+      self.status = Status::ERROR
+      self
+    end
+
+    def error?
+      self.status == Status::ERROR
+    end
+  end
+end

data/lib/resultable/version.rb

@@ -0,0 +1,3 @@
+module Resultable
+  VERSION = "0.1.0"
+end

data/lib/resultable.rb

@@ -0,0 +1,10 @@
+require "resultable/version"
+require "resultable/result"
+
+module Resultable
+  attr_accessor :result
+
+  def initialize
+    self.result = Resultable::Result.new
+  end
+end

data/resultable.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resultable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resultable"
+  spec.version       = Resultable::VERSION
+  spec.authors       = ["Ruslan Milevskiy"]
+  spec.email         = ["rpmilevskiy@gmail.com"]
+  spec.summary       = %q{Simple ruby gem that provides reusable result object.}
+  spec.description   = ""
+  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"
+end

data/spec/resultable/result_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Resultable::Result do
+  subject { Resultable::Result.new }
+
+  it 'sets default error status' do
+    expect(subject.status).to eq(Resultable::Result::Status::ERROR)
+  end
+
+  describe '#successful!' do
+    before { subject.successful! }
+
+    it 'sets successful status' do
+      expect(subject.status).to eq(Resultable::Result::Status::SUCCESSFUL)
+    end
+  end
+
+  describe '#successful?' do
+    context 'if status is successful' do
+      it 'returns true' do
+        subject.status = Resultable::Result::Status::SUCCESSFUL
+        expect(subject.successful?).to eq(true)
+      end
+    end
+
+    context 'if status is error' do
+      it 'returns false' do
+        subject.status = Resultable::Result::Status::ERROR
+        expect(subject.successful?).to eq(false)
+      end
+    end
+  end
+
+  describe '#error!' do
+    before { subject.error! }
+
+    it 'sets error status' do
+      expect(subject.status).to eq(Resultable::Result::Status::ERROR)
+    end
+  end
+
+  describe '#error?' do
+    context 'if status is error' do
+      it 'returns true' do
+        subject.status = Resultable::Result::Status::ERROR
+        expect(subject.error?).to eq(true)
+      end
+    end
+
+    context 'if status is successful' do
+      it 'returns false' do
+        subject.status = Resultable::Result::Status::SUCCESSFUL
+        expect(subject.error?).to eq(false)
+      end
+    end
+  end
+
+  describe '#response' do
+    it 'allows to set response attribute' do
+      subject.response = 'success'
+      expect(subject.response).to eq('success')
+    end
+  end
+end

data/spec/resultable_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Resultable do
+  class Service
+    include Resultable
+  end
+
+  subject { Service.new }
+
+  it 'adds result attribute' do
+    expect(subject.result).to_not be_nil
+  end
+
+  it 'initializes result attribute' do
+    expect(subject.result.class).to eq(Resultable::Result)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'resultable'

data/tasks/rspec.rake

@@ -0,0 +1,3 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: resultable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ruslan Milevskiy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-11 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- rpmilevskiy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resultable.rb
+- lib/resultable/result.rb
+- lib/resultable/version.rb
+- resultable.gemspec
+- spec/resultable/result_spec.rb
+- spec/resultable_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.rake
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple ruby gem that provides reusable result object.
+test_files:
+- spec/resultable/result_spec.rb
+- spec/resultable_spec.rb
+- spec/spec_helper.rb