simple_command 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c874dea14c49cfea5cf2d5f8dafcbc8352199a55
+  data.tar.gz: caedd0f176a3f0091728dabd200212100c4462b0
+SHA512:
+  metadata.gz: cbf388daa3f6482e3916afd9f2d982d22b50927e4af7e60e6b4b88d88f94020e872c1ad206bbe039e732936e3d43a065608f32d0624e6153dd172852f4f2eb68
+  data.tar.gz: 07ccf08861301769d364e60dce60a388bea5319988e90ab83b108409ca9a629a9e1eaf280b01a7408a4f2a8cc0a7709bff6dfb0f01940c25692f4af2fec8df43

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 @@
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.3

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in simple_command.gemspec
+gemspec
+
+group :development do
+  gem 'simplecov'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nebulab S.r.l. (http://nebulab.it)
+
+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,89 @@
+# SimpleCommand
+
+A simple, standardized way to build and use _Service Objects_ (aka _Commands_) in Ruby
+
+## Requirements
+
+* Ruby 2.0+
+
+## Installation
+
+*NOTE:* this gem is not yet published on rubygems, use the github repository.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simple_command', github: 'nebulab/simple_command'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_command
+
+## Usage
+
+Here's a basic example of a command that authenticates a user
+
+```ruby
+# define a command class
+class AuthenticateUser
+  # put SimpleCommand before the class' ancestors chain
+  prepend SimpleCommand
+
+  # optional, initialize the command with some arguments
+  def initialize(user, password)
+    @user = user
+    @password = password
+  end
+
+  # mandatory: define a #perform method. its return value will be available
+  #            through #result
+  def perform
+    if user = User.authenticate(@email, @password)
+      return user
+    else
+      add_error(authentication: I18n.t "authenticate_user.failure")
+    end
+    nil
+  end
+end
+```
+
+Then, in your controller:
+
+```ruby
+class SessionsController < ApplicationController
+  def create
+    # initialize and execute the command
+    command = AuthenticateUser.new(session_params[:user], session_params[:password]).perform
+
+    # check command outcome
+    if command.success?
+      # command#result will contain the user instance, if found
+      session[:user_token] = command.result.secret_token
+      redirect_to root_path
+    else
+      flash.now[:alert] = t(command.errors[:authentication])
+      render :new
+    end
+  end
+
+  private
+
+  def session_params
+    params.require(:session).permit(:email, :password)
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/nebulab/simple_command/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,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/lib/simple_command.rb

@@ -0,0 +1,43 @@
+require "simple_command/version"
+require "simple_command/errors"
+
+module SimpleCommand
+
+  def perform
+    if !defined?(super)
+      raise NotImplementedError
+    end
+
+    @performed = true
+    @result = super
+
+    self
+  end
+
+  def success?
+    performed? && !failure?
+  end
+
+  def failure?
+    performed? && errors.any?
+  end
+
+  def result
+    @result
+  end
+
+  def errors
+    @errors ||= {}
+  end
+
+  private
+
+  def performed?
+    @performed ||= false
+  end
+
+  def add_error(key, value)
+    errors[key] ||= []
+    errors[key] << value
+  end
+end

data/lib/simple_command/errors.rb

@@ -0,0 +1,3 @@
+module SimpleCommand
+  class NotImplementedError < ::StandardError ; end
+end

data/lib/simple_command/version.rb

@@ -0,0 +1,3 @@
+module SimpleCommand
+  VERSION = "0.0.3"
+end

data/simple_command.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_command/version'
+
+Gem::Specification.new do |spec|
+  spec.required_ruby_version = '~> 2.0'
+  spec.name          = "simple_command"
+  spec.version       = SimpleCommand::VERSION
+  spec.authors       = ["Andrea Pavoni"]
+  spec.email         = ["andrea.pavoni@gmail.com"]
+  spec.summary       = %q{Easy way to build and manage commands (aka: service objects)}
+  spec.description   = %q{Easy way to build and manage commands (aka: service objects)}
+  spec.homepage      = "http://github.com/nebulab/simple_command"
+  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/factories/fail_command.rb

@@ -0,0 +1,11 @@
+class FailCommand
+  prepend SimpleCommand
+
+  def initialize(input)
+    @input = input
+  end
+
+  def perform
+    add_error(:wrong_math, 'Math is not an opinion') if true
+  end
+end

data/spec/factories/missed_perform_command.rb

@@ -0,0 +1,7 @@
+class MissedPerformCommand
+  prepend SimpleCommand
+
+  def initialize(input)
+    @input = input
+  end
+end

data/spec/factories/success_command.rb

@@ -0,0 +1,11 @@
+class SuccessCommand
+  prepend SimpleCommand
+
+  def initialize(input)
+    @input = input
+  end
+
+  def perform
+    @input * 2
+  end
+end

data/spec/simple_command_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+
+describe SimpleCommand do
+  let(:command) { SuccessCommand.new(2) }
+  let(:fail_command) { FailCommand.new(2) }
+
+  describe '#perform' do
+    let(:missed_perform_command) { MissedPerformCommand.new(2) }
+
+    it 'returns the command object' do
+      expect(command.perform).to be_a(SuccessCommand)
+    end
+
+    it 'raises an exception if the method is not defined in the command' do
+      expect { missed_perform_command.perform }.to raise_error(SimpleCommand::NotImplementedError)
+    end
+  end
+
+  describe '#success?' do
+    it 'is true by default' do
+      expect(command.perform.success?).to be_truthy
+    end
+
+    it 'is false if something went wrong' do
+      expect(fail_command.perform.success?).to be_falsy
+    end
+
+    context 'when perform is not called yet' do
+      it 'is false by default' do
+        expect(command.success?).to be_falsy
+      end
+    end
+  end
+
+  describe '#result' do
+    it 'returns the result of command execution' do
+      expect(command.perform.result).to eq(4)
+    end
+
+    context 'when perform is not called yet' do
+      it 'returns nil' do
+        expect(command.result).to be_nil
+      end
+    end
+  end
+
+  describe '#failure?' do
+    it 'is false by default' do
+      expect(command.perform.failure?).to be_falsy
+    end
+
+    it 'is true if something went wrong' do
+      expect(fail_command.perform.failure?).to be_truthy
+    end
+
+    context 'when perform is not called yet' do
+      it 'is false by default' do
+        expect(command.failure?).to be_falsy
+      end
+    end
+  end
+
+  describe '#errors' do
+    let(:errors) { command.perform.errors }
+
+    it 'returns an Hash' do
+      expect(errors).to be_a(Hash)
+    end
+
+    context 'with no errors' do
+      it 'returns an empty Hash' do
+        expect(errors).to be_empty
+      end
+    end
+
+    context 'with errors' do
+      let(:errors) { fail_command.perform.errors }
+
+      it 'has a key with error message' do
+        expect(errors[:wrong_math]).to_not be_nil
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'simple_command'
+
+Dir[File.join(File.dirname(__FILE__), 'factories', '**/*.rb')].each { |f| require f }

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: simple_command
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Andrea Pavoni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-02 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: 'Easy way to build and manage commands (aka: service objects)'
+email:
+- andrea.pavoni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_command.rb
+- lib/simple_command/errors.rb
+- lib/simple_command/version.rb
+- simple_command.gemspec
+- spec/factories/fail_command.rb
+- spec/factories/missed_perform_command.rb
+- spec/factories/success_command.rb
+- spec/simple_command_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/nebulab/simple_command
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.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: 'Easy way to build and manage commands (aka: service objects)'
+test_files:
+- spec/factories/fail_command.rb
+- spec/factories/missed_perform_command.rb
+- spec/factories/success_command.rb
+- spec/simple_command_spec.rb
+- spec/spec_helper.rb