yyks_simple_command 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5908aee2a7893aca88b4424b777548d47464dd8b7f9f47d902b743917d63f509
+  data.tar.gz: 169f8262fdc7531cf8e19a2e5eff2cb180452d537263d38f017c786f32789905
+SHA512:
+  metadata.gz: 020005e1308bc8b4d048c7c58ac8b26dba4ef8eaa9dc90d95456a5405d69d455d32d8d650ccf1a94e7c5b20a06135d9db5f42f3a03347f24a585950a659b608e
+  data.tar.gz: 32b42c1752d64255f4668f5699aa093fb871310912a0af2a960059db1759ab22fd2729ad0bbbd08ce6650e8b30c7e13df48e62c2480d55158bb50b9b1e0423cc

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rubocop.yml

@@ -0,0 +1,14 @@
+# This is the configuration used to check the rubocop source code.
+
+# inherit_from: .rubocop_todo.yml
+
+# AllCops:
+#   Exclude:
+#     - 'yyks_simple_command.gemspec'
+#     - 'spec/factories/**/*'
+
+# Style/Encoding:
+#   Enabled: when_needed
+
+Style/Documentation:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yyks_simple_command.gemspec
+gemspec
+
+group :development do
+  gem 'simplecov'
+  gem 'rubocop'
+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,120 @@
+[![Code Climate](https://codeclimate.com/github/nebulab/yyks_simple_command/badges/gpa.svg)](https://codeclimate.com/github/nebulab/yyks_simple_command)
+[ ![Codeship Status for nebulab/yyks_simple_command](https://app.codeship.com/projects/45ce7790-8daf-0132-1412-669677a474c3/status?branch=master)](https://app.codeship.com/projects/60741)
+
+# SimpleCommand
+
+A simple, standardized way to build and use _Service Objects_ (aka _Commands_) in Ruby
+
+## Requirements
+
+* Ruby 2.0+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yyks_simple_command'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yyks_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(email, password)
+    @email = email
+    @password = password
+  end
+
+  # mandatory: define a #call method. its return value will be available
+  #            through #result
+  def call
+    if user = User.authenticate(@email, @password)
+      return user
+    else
+      errors.add(: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
+    # NOTE: `.call` is a shortcut for `.new(args).call)`
+    command = AuthenticateUser.call(session_params[:email], session_params[:password])
+
+    # 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
+```
+
+## Test with Rspec
+Make the spec file `spec/commands/authenticate_user_spec.rb` like:
+
+```ruby
+describe AuthenticateUser do
+  subject(:context) { described_class.call(username, password) }
+
+  describe '.call' do
+    context 'when the context is successful' do
+      let(:username) { 'correct_user' }
+      let(:password) { 'correct_password' }
+      
+      it 'succeeds' do
+        expect(context).to be_success
+      end
+    end
+
+    context 'when the context is not successful' do
+      let(:username) { 'wrong_user' }
+      let(:password) { 'wrong_password' }
+
+      it 'fails' do
+        expect(context).to be_failure
+      end
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/nebulab/yyks_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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/yyks_simple_command/errors.rb

@@ -0,0 +1,23 @@
+module SimpleCommand
+  class NotImplementedError < ::StandardError; end
+
+  class Errors < Hash
+    def add(key, value, _opts = {})
+      self[key] ||= []
+      self[key] << value
+      self[key].uniq!
+    end
+
+    def add_multiple_errors(errors_hash)
+      errors_hash.each do |key, values|
+        values.each { |value| add key, value }
+      end
+    end
+
+    def each
+      each_key do |field|
+        self[field].each { |message| yield field, message }
+      end
+    end
+  end
+end

data/lib/yyks_simple_command/version.rb

@@ -0,0 +1,3 @@
+module SimpleCommand
+  VERSION = '0.1.0'
+end

data/lib/yyks_simple_command.rb

@@ -0,0 +1,43 @@
+require 'yyks_simple_command/version'
+require 'yyks_simple_command/errors'
+
+module SimpleCommand
+  attr_reader :result
+
+  module ClassMethods
+    def call(*args)
+      new(*args).call
+    end
+  end
+
+  def self.prepended(base)
+    base.extend ClassMethods
+  end
+
+  def call
+    fail NotImplementedError unless defined?(super)
+
+    @called = true
+    @result = super
+
+    self
+  end
+
+  def success?
+    called? && !failure?
+  end
+
+  def failure?
+    called? && errors.any?
+  end
+
+  def errors
+    @errors ||= Errors.new
+  end
+
+  private
+
+  def called?
+    @called ||= false
+  end
+end

data/spec/factories/missed_call_command.rb

@@ -0,0 +1,7 @@
+class MissedCallCommand
+  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 call
+    @input * 2
+  end
+end

data/spec/spec_helper.rb

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

data/spec/yyks_simple_command/errors_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe SimpleCommand::Errors do
+  let(:errors) { SimpleCommand::Errors.new }
+
+  describe '#add' do
+    before do
+      errors.add :some_error, 'some error description'
+    end
+
+    it 'adds the error' do
+      expect(errors[:some_error]).to eq(['some error description'])
+    end
+
+    it 'adds the same error only once' do
+      errors.add :some_error, 'some error description'
+      expect(errors[:some_error]).to eq(['some error description'])
+    end
+  end
+
+  describe '#add_multiple_errors' do
+    let(:errors_list) do
+      {
+        some_error: ['some error description'],
+        another_error: ['another error description']
+      }
+    end
+
+    before do
+      errors.add_multiple_errors errors_list
+    end
+
+    it 'populates itself with the added errors' do
+      expect(errors[:some_error]).to eq(errors_list[:some_error])
+      expect(errors[:another_error]).to eq(errors_list[:another_error])
+    end
+  end
+
+  describe '#each' do
+    let(:errors_list) do
+      {
+        email: ['taken'],
+        password: ['blank', 'too short']
+      }
+    end
+
+    before { errors.add_multiple_errors(errors_list) }
+
+    it 'yields each message for the same key independently' do
+      expect { |b| errors.each(&b) }.to yield_control.exactly(3).times
+      expect { |b| errors.each(&b) }.to yield_successive_args(
+        [:email, 'taken'],
+        [:password, 'blank'],
+        [:password, 'too short']
+      )
+    end
+  end
+end

data/spec/yyks_simple_command_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe SimpleCommand do
+  let(:command) { SuccessCommand.new(2) }
+
+  describe '.call' do
+    before do
+      allow(SuccessCommand).to receive(:new).and_return(command)
+      allow(command).to receive(:call)
+
+      SuccessCommand.call 2
+    end
+
+    it 'initializes the command' do
+      expect(SuccessCommand).to have_received(:new)
+    end
+
+    it 'calls #call method' do
+      expect(command).to have_received(:call)
+    end
+  end
+
+  describe '#call' do
+    let(:missed_call_command) { MissedCallCommand.new(2) }
+
+    it 'returns the command object' do
+      expect(command.call).to be_a(SuccessCommand)
+    end
+
+    it 'raises an exception if the method is not defined in the command' do
+      expect do
+        missed_call_command.call
+      end.to raise_error(SimpleCommand::NotImplementedError)
+    end
+  end
+
+  describe '#success?' do
+    it 'is true by default' do
+      expect(command.call.success?).to be_truthy
+    end
+
+    it 'is false if something went wrong' do
+      command.errors.add(:some_error, 'some message')
+      expect(command.call.success?).to be_falsy
+    end
+
+    context 'when call 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.call.result).to eq(4)
+    end
+
+    context 'when call 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.call.failure?).to be_falsy
+    end
+
+    it 'is true if something went wrong' do
+      command.errors.add(:some_error, 'some message')
+      expect(command.call.failure?).to be_truthy
+    end
+
+    context 'when call is not called yet' do
+      it 'is false by default' do
+        expect(command.failure?).to be_falsy
+      end
+    end
+  end
+
+  describe '#errors' do
+    it 'returns an SimpleCommand::Errors' do
+      expect(command.errors).to be_a(SimpleCommand::Errors)
+    end
+
+    context 'with no errors' do
+      it 'is empty' do
+        expect(command.errors).to be_empty
+      end
+    end
+
+    context 'with errors' do
+      before do
+        command.errors.add(:some_error, 'some message')
+      end
+
+      it 'has a key with error message' do
+        expect(command.errors[:some_error]).to eq(['some message'])
+      end
+    end
+  end
+end

data/yyks_simple_command.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yyks_simple_command/version'
+
+Gem::Specification.new do |s|
+  s.required_ruby_version = '>= 2.0'
+  s.name          = 'yyks_simple_command'
+  s.version       = SimpleCommand::VERSION
+  s.authors       = ['Andrea Pavoni']
+  s.email         = ['andrea.pavoni@gmail.com']
+  s.summary       = 'Easy way to build and manage commands (service objects)'
+  s.description   = 'Easy way to build and manage commands (service objects)'
+  s.homepage      = 'http://github.com/nebulab/yyks_simple_command'
+  s.license       = 'MIT'
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(/^bin\//) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(/^(test|spec|features)\//)
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'rake', '>= 10.0'
+  s.add_development_dependency 'rspec', '>= 3.1'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: yyks_simple_command
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrea Pavoni
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-05 00:00:00.000000000 Z
+dependencies:
+- !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: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Easy way to build and manage commands (service objects)
+email:
+- andrea.pavoni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yyks_simple_command.rb
+- lib/yyks_simple_command/errors.rb
+- lib/yyks_simple_command/version.rb
+- spec/factories/missed_call_command.rb
+- spec/factories/success_command.rb
+- spec/spec_helper.rb
+- spec/yyks_simple_command/errors_spec.rb
+- spec/yyks_simple_command_spec.rb
+- yyks_simple_command.gemspec
+homepage: http://github.com/nebulab/yyks_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.7.6
+signing_key: 
+specification_version: 4
+summary: Easy way to build and manage commands (service objects)
+test_files:
+- spec/factories/missed_call_command.rb
+- spec/factories/success_command.rb
+- spec/spec_helper.rb
+- spec/yyks_simple_command/errors_spec.rb
+- spec/yyks_simple_command_spec.rb