light_operations 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d66e8c5f9729b8c5d261eab885164317a64619f
+  data.tar.gz: aec76cd8d6088dfbcafee5e1eb607d58cd30d901
+SHA512:
+  metadata.gz: 51a815033d9623f4e3b70087e6a9b85e70a1a982dcafadd92676b415037fd604daddffa02a6f132121591b7f54a6d7f1406288e6eb311395341275f7fb783242
+  data.tar.gz: ee0e5dc1efa1f059421fc5fca252e78da16e5a07345decac4c7fd091f4cb69d2d95e0388f9422f024e12069737f09e32eb66124f603a6102e8dc8d18a7633e69

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.rubocop_todo.yml

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--require spec_helper
+--format progress
+--no-profile

data/.rubocop.yml

@@ -0,0 +1,47 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-02-23 06:17:38 +0100 using RuboCop version 0.27.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Style/Documentation:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+# Offense count: 2
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+Style/TrailingBlankLines:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, Whitelist.
+Style/TrivialAccessors:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120
+
+AllCops:
+  Exclude:
+    - '**/Guardfile'

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+script: bundle exec rake
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^lib/(.+).rb$})      { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^spec/(.+).rb$})     { |m| "spec/#{m[1]}.rb" }
+  watch('spec/spec_helper.rb')  { 'spec' }
+  watch('Gemfile')
+end
+
+guard :rubocop, all_on_start: false, cli: ['--format', 'clang'] do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Pawel Niemczyk
+
+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,31 @@
+# LightOperations
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'light_operations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install light_operations
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/swift_operations/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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task default: 'spec'

data/lib/light_operations/core.rb

@@ -0,0 +1,63 @@
+require 'active_support'
+
+module LightOperations
+  class Core
+    include ::ActiveSupport::Rescuable
+    include ::ActiveSupport
+    MissingDependency = Class.new(StandardError)
+
+    attr_reader :dependencies, :params, :subject
+
+    def initialize(params = {}, dependencies = {})
+      @params, @dependencies = params, dependencies
+    end
+
+    # do not override this method
+    def run
+      @subject = execute
+      self
+    rescue => exception
+      rescue_with_handler(exception) || raise
+    ensure
+      self
+    end
+
+    def on_success(&block)
+      block.call(subject) if success?
+      self
+    end
+
+    def on_fail(&block)
+      block.call(subject, errors) unless success?
+      self
+    end
+
+    def errors
+      @errors ||= (subject.respond_to?(:errors) ? subject.errors : [])
+    end
+
+    def fail?
+      !success?
+    end
+
+    def success?
+      errors.respond_to?(:empty?) ? errors.empty? : !errors
+    end
+
+    protected
+
+    def execute
+      fail 'Not implemented yet'
+    end
+
+    def fail!(errors = [])
+      @errors = errors
+    end
+
+    def dependency(name)
+      dependencies.fetch(name)
+    rescue KeyError => e
+      raise MissingDependency, e.message
+    end
+  end
+end

data/lib/light_operations/version.rb

@@ -0,0 +1,3 @@
+module LightOperations
+  VERSION = '0.0.1'
+end

data/lib/light_operations.rb

@@ -0,0 +1,5 @@
+require 'light_operations/version'
+require 'light_operations/core'
+
+module LightOperations
+end

data/light_operations.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'light_operations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'light_operations'
+  spec.version       = LightOperations::VERSION
+  spec.authors       = ['Pawel Niemczyk']
+  spec.email         = ['pniemczyk.info@.gmail.com']
+  spec.summary       = %q{Light operations}
+  spec.description   = %q{Light operations for success or fail result}
+  spec.homepage      = 'https://github.com/pniemczyk/light_operations'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'activesupport', '~> 4.2'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+  spec.add_development_dependency 'guard', '~> 2.12'
+  spec.add_development_dependency 'guard-rspec', '~> 4.5'
+  spec.add_development_dependency 'guard-rubocop', '~> 1.2'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
+  spec.add_development_dependency 'awesome_print', '~> 1.6'
+end

data/spec/lib/core_spec.rb

@@ -0,0 +1,158 @@
+require 'spec_helper'
+
+describe LightOperations::Core do
+  let(:login_service) { double('login_service') }
+  let(:params)        { { login: 'pawel', password: 'abc' } }
+  let(:dependencies)  { { login_service: login_service } }
+
+  def subject_factory(&block)
+    Class.new(described_class).tap do |klass|
+      klass.class_eval(&block)
+    end.new(params, dependencies)
+  end
+
+  subject { described_class.new(params, dependencies) }
+
+  it 'raise error when #execute is not implemented' do
+    expect { subject.run }.to raise_error('Not implemented yet')
+  end
+
+  context 'use cases' do
+
+    # dependency using
+
+    context 'dependency usage' do
+      subject do
+        subject_factory do
+          def execute
+            dependency(:login_service)
+          end
+        end
+      end
+
+      it 'is allowed when is initialized correctly' do
+        expect { subject.run }.not_to raise_error
+      end
+
+      context 'raise_error' do
+        let(:dependencies) { {} }
+        it 'when dependency missing' do
+          expect { subject.run }.to raise_error(LightOperations::Core::MissingDependency)
+        end
+      end
+    end
+
+    # error handling
+
+    context '.rescue_from specific error' do
+      context 'by block' do
+        subject do
+          subject_factory do
+            rescue_from StandardError do |_exception|
+              fail 'execute block instead original error'
+            end
+
+            def execute
+              fail StandardError, 'What now'
+            end
+          end
+        end
+
+        it 'call' do
+          expect { subject.run }.to raise_error('execute block instead original error')
+        end
+      end
+
+      context 'by defined method' do
+        subject do
+          subject_factory do
+            rescue_from StandardError, with: :rescue_me
+
+            def rescue_me
+              fail 'execute rescue_me method instead original error'
+            end
+
+            def execute
+              fail StandardError, 'What now'
+            end
+          end
+        end
+
+        it 'execute' do
+          expect { subject.run }.to raise_error('execute rescue_me method instead original error')
+        end
+      end
+    end
+
+    context 'when operation is successful' do
+      subject do
+        subject_factory do
+          def execute
+            :success
+          end
+        end
+      end
+
+      it '#on_success' do
+        subject.run.on_success do |result|
+          expect(result).to eq(:success)
+        end
+      end
+
+      it '#on_fail' do
+        block_to_exec = -> () {}
+        expect(block_to_exec).not_to receive(:call)
+        subject.run.on_fail(&block_to_exec)
+      end
+
+      it '#errors' do
+        expect(subject.run.errors).to eq([])
+      end
+
+      it '#fail?' do
+        expect(subject.run.fail?).to eq(false)
+      end
+
+      it '#success?' do
+        expect(subject.run.success?).to eq(true)
+      end
+    end
+
+    context 'when operation is fail' do
+      subject do
+        subject_factory do
+          def execute
+            fail!([email: :unknown])
+            :fail
+          end
+        end
+      end
+
+      it '#on_success' do
+        block_to_exec = -> () {}
+        expect(block_to_exec).not_to receive(:call)
+        subject.run.on_success(&block_to_exec)
+      end
+
+      it '#on_fail' do
+
+        subject.run.on_fail do |result, errors|
+          expect(result).to eq(:fail)
+          expect(errors).to eq([email: :unknown])
+        end
+      end
+
+      it '#errors' do
+        expect(subject.run.errors).to eq([email: :unknown])
+      end
+
+      it '#fail?' do
+        expect(subject.run.fail?).to eq(true)
+      end
+
+      it '#success?' do
+        expect(subject.run.success?).to eq(false)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require 'bundler/setup'
+require 'awesome_print'
+Bundler.setup
+
+require 'coveralls'
+Coveralls.wear!
+
+require 'light_operations'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  config.default_formatter = 'doc' if config.files_to_run.one?
+
+  config.profile_examples = 10
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end
+require 'guard/rubocop'

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification
+name: light_operations
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pawel Niemczyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Light operations for success or fail result
+email:
+- pniemczyk.info@.gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/light_operations.rb
+- lib/light_operations/core.rb
+- lib/light_operations/version.rb
+- light_operations.gemspec
+- spec/lib/core_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/pniemczyk/light_operations
+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.3
+signing_key: 
+specification_version: 4
+summary: Light operations
+test_files:
+- spec/lib/core_spec.rb
+- spec/spec_helper.rb