simple_command 0.0.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e1e044db947afd477d7b8042fbd679fdffbd8a63
-  data.tar.gz: 021cfb1817dd007895a76184af0db53095c0c9a1
+SHA256:
+  metadata.gz: 8847792f86f2c4162d832d2603abfb7f0f40208110ad339484851dfaeeb99cf4
+  data.tar.gz: ba9e8c0e1d46fb25d8408f430ba462e14e2ca386e5cd7b4c611d7787523448a0
 SHA512:
-  metadata.gz: 0a88837defef4d2cc6f3c7167e0f891f73dd09ff6378a5719df8772e8a4f1bdd7cd22043ca29b3596d9e53d619c9a714d03c2107a27d3746150c8f3d167d2730
-  data.tar.gz: ea8a66ec330153ba06932837a9795d7931c3741faed743c3ebdaa40e211ffde726a173121a84c6a91c89cca5561308373d04aca9d0a776764ce195d8f75694f2
+  metadata.gz: d4fa95128f6e3fcd15419705bf36d56c33b8da0ced34b068940a3ee3fe066feeada465f8257f5076a87f3e237bd0adfd83b377a1d68bf9e81a09240bae5be243
+  data.tar.gz: 8cc7cea6c22b3af310b039eee0f041f0ac5c48597d8cc13122771ffdef67a54dcf2ce8f2b77172ad3c6425e5598024d2ef48d95a7562083c94c3d1419348a7e0

data/README.md

@@ -1,3 +1,6 @@
+[![Code Climate](https://codeclimate.com/github/nebulab/simple_command/badges/gpa.svg)](https://codeclimate.com/github/nebulab/simple_command)
+[ ![Codeship Status for nebulab/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
@@ -31,34 +34,46 @@ Here's a basic example of a command that authenticates a user
 class AuthenticateUser
   # put SimpleCommand before the class' ancestors chain
   prepend SimpleCommand
+  include ActiveModel::Validations
 
   # optional, initialize the command with some arguments
-  def initialize(user, password)
-    @user = user
+  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)
+    if user = User.find_by(email: @email)&.authenticate(@password)
       return user
     else
-      errors.add_error(authentication: I18n.t "authenticate_user.failure")
+      errors.add(:base, :failure)
     end
     nil
   end
 end
 ```
 
+in your locale file
+```yaml
+# config/locales/en.yml
+en:
+  activemodel:
+    errors:
+      models:
+        authenticate_user:
+          failure: Wrong email or password
+```
+
 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[:user], session_params[:password])
+    # NOTE: `.call` is a shortcut for `.new(args).call`
+    command = AuthenticateUser.call(session_params[:email], session_params[:password])
 
     # check command outcome
     if command.success?
@@ -66,7 +81,7 @@ class SessionsController < ApplicationController
       session[:user_token] = command.result.secret_token
       redirect_to root_path
     else
-      flash.now[:alert] = t(command.errors[:authentication])
+      flash.now[:alert] = t(command.errors.full_messages.to_sentence)
       render :new
     end
   end
@@ -79,6 +94,35 @@ class SessionsController < ApplicationController
 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/simple_command/fork )

data/lib/simple_command/errors.rb

@@ -2,7 +2,7 @@ module SimpleCommand
   class NotImplementedError < ::StandardError; end
 
   class Errors < Hash
-    def add_error(key, value)
+    def add(key, value, _opts = {})
       self[key] ||= []
       self[key] << value
       self[key].uniq!
@@ -10,8 +10,26 @@ module SimpleCommand
 
     def add_multiple_errors(errors_hash)
       errors_hash.each do |key, values|
-        values.each { |value| add_error key, value }
+        values.each { |value| add key, value }
       end
     end
+
+    def each
+      each_key do |field|
+        self[field].each { |message| yield field, message }
+      end
+    end
+
+    def full_messages
+      map { |attribute, message| full_message(attribute, message) }
+    end
+
+    private
+    def full_message(attribute, message)
+      return message if attribute == :base
+      attr_name = attribute.to_s.tr('.', '_').capitalize
+      "%s %s" % [attr_name, message]
+    end
+
   end
 end

data/lib/simple_command/version.rb

@@ -1,3 +1,3 @@
 module SimpleCommand
-  VERSION = '0.0.8'
+  VERSION = '0.2.0'
 end

data/lib/simple_command.rb

@@ -5,8 +5,8 @@ module SimpleCommand
   attr_reader :result
 
   module ClassMethods
-    def call(*args)
-      new(*args).call
+    def call(*args, **kwargs)
+      new(*args, **kwargs).call
     end
   end
 
@@ -26,12 +26,15 @@ module SimpleCommand
   def success?
     called? && !failure?
   end
+  alias_method :successful?, :success?
 
   def failure?
     called? && errors.any?
   end
 
   def errors
+    return super if defined?(super)
+
     @errors ||= Errors.new
   end
 

data/simple_command.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(/^(test|spec|features)\//)
   s.require_paths = ['lib']
 
-  s.add_development_dependency 'bundler', '~> 1.7'
-  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 3.1'
 end

data/spec/simple_command/errors_spec.rb

@@ -3,9 +3,9 @@ require 'spec_helper'
 describe SimpleCommand::Errors do
   let(:errors) { SimpleCommand::Errors.new }
 
-  describe '#add_error' do
+  describe '#add' do
     before do
-      errors.add_error :some_error, 'some error description'
+      errors.add :some_error, 'some error description'
     end
 
     it 'adds the error' do
@@ -13,7 +13,7 @@ describe SimpleCommand::Errors do
     end
 
     it 'adds the same error only once' do
-      errors.add_error :some_error, 'some error description'
+      errors.add :some_error, 'some error description'
       expect(errors[:some_error]).to eq(['some error description'])
     end
   end
@@ -35,4 +35,38 @@ describe SimpleCommand::Errors do
       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
+
+  describe '#full_messages' do
+    before do
+      errors.add :attr1, 'has an error'
+      errors.add :attr2, 'has an error'
+      errors.add :attr2, 'has two errors'
+    end
+
+    it "returrns the full messages array" do
+      expect(errors.full_messages).to eq ["Attr1 has an error", "Attr2 has an error", "Attr2 has two errors"]
+    end
+
+  end
+
 end

data/spec/simple_command_spec.rb

@@ -40,7 +40,7 @@ describe SimpleCommand do
     end
 
     it 'is false if something went wrong' do
-      command.errors.add_error(:some_error, 'some message')
+      command.errors.add(:some_error, 'some message')
       expect(command.call.success?).to be_falsy
     end
 
@@ -69,7 +69,7 @@ describe SimpleCommand do
     end
 
     it 'is true if something went wrong' do
-      command.errors.add_error(:some_error, 'some message')
+      command.errors.add(:some_error, 'some message')
       expect(command.call.failure?).to be_truthy
     end
 
@@ -93,7 +93,7 @@ describe SimpleCommand do
 
     context 'with errors' do
       before do
-        command.errors.add_error(:some_error, 'some message')
+        command.errors.add(:some_error, 'some message')
       end
 
       it 'has a key with error message' do

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: simple_command
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrea Pavoni
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-01-19 00:00:00.000000000 Z
+date: 2022-04-28 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'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +80,7 @@ homepage: http://github.com/nebulab/simple_command
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,9 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.2.20
+signing_key:
 specification_version: 4
 summary: Easy way to build and manage commands (service objects)
 test_files: