simple_command 0.0.9 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dd27f8350ae4a2243a2f2bde7f2481edda37ee2e
-  data.tar.gz: dcf03e07231a348a26747e94d346c20c77d119c5
+SHA256:
+  metadata.gz: e1f9517aa67b971a3bf9f8a44789254c5bdcc0e790abba2dd154043d7654012a
+  data.tar.gz: d137bb78badaff5767a9dc692d685cd7d6280cf3413b0fd3df2c954922055c4a
 SHA512:
-  metadata.gz: 3c2ddec2804d8f4c60376bb562e8e82cf753fcbed65dfd8713cfecec668592c2b67267d1bd1036db5507dd999ddb6083fc12b402f2b3f8da7d7da262024881c6
-  data.tar.gz: 471b1498238e7a5e444d2f61af683ed78c823dc24b300dcd7f38f2629f50e187731fb3d4adc6b38b4178f03bb2fc36e2e435ae017c7e25b865f02b81be108899
+  metadata.gz: 2f1dde12a3f9d6258fd6d85fd9591aaec4c9bd1839de53b511224a924d5faba132de927c375fe56898fb87862c33c2379fcd0410e3f5ce2cd2abeb5e54378593
+  data.tar.gz: 70b63c426ec5e29060cdb9ce0b7c7457d84564b4ba109a481eb1cfe1779c1f2069bc1f878bb3c972abd1674bc3e1d0dfcd3a285cb9fc75e498c40eabe70a8c6e

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(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.rb

@@ -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/lib/simple_command/errors.rb

@@ -13,5 +13,23 @@ module SimpleCommand
         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.9'
+  VERSION = '0.1.0'
 end

data/spec/simple_command/errors_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_command
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrea Pavoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2019-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,8 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Easy way to build and manage commands (service objects)