simple_command 0.0.9 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: dd27f8350ae4a2243a2f2bde7f2481edda37ee2e
-  data.tar.gz: dcf03e07231a348a26747e94d346c20c77d119c5
+SHA256:
+  metadata.gz: 709a8e79d062fc2df30ceb2515a4996dac770a1a06b26cfedef243b560fa86d4
+  data.tar.gz: 6b30945ca6b05353376bb3636f42c501d7c349ded063adc98706628ced2ecc03
 SHA512:
-  metadata.gz: 3c2ddec2804d8f4c60376bb562e8e82cf753fcbed65dfd8713cfecec668592c2b67267d1bd1036db5507dd999ddb6083fc12b402f2b3f8da7d7da262024881c6
-  data.tar.gz: 471b1498238e7a5e444d2f61af683ed78c823dc24b300dcd7f38f2629f50e187731fb3d4adc6b38b4178f03bb2fc36e2e435ae017c7e25b865f02b81be108899
+  metadata.gz: 5e9a41d79fe67caa53d69c54d690958f62eae87ef54c8e966360854adb4b1716580446255ccf5767a35aaea9f45ac53c1d20b0686b5ff30cd715ac37074d5d8c
+  data.tar.gz: 5ac692c46307b7f034658608b8217e5a367587b91760ca7f38aebb8cca3612eae9b29f3069ddb896b6ffbadd8b12f600609ebcc6b38c2f06f395358c9dc5655b

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.7", "3.0", "3.1", ruby-head, jruby-9.3, jruby-head]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true # 'bundle install' and cache gems
+        ruby-version: ${{ matrix.ruby }}
+    - name: Run tests
+      run: bundle exec rake

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

@@ -10,8 +10,26 @@ module SimpleCommand
 
     def add_multiple_errors(errors_hash)
       errors_hash.each do |key, values|
-        values.each { |value| add key, value }
+        SimpleCommand::Utils.array_wrap(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/utils.rb

@@ -0,0 +1,14 @@
+module SimpleCommand
+  module Utils
+    # Borrowed from active_support/core_ext/array/wrap
+    def self.array_wrap(object)
+      if object.nil?
+        []
+      elsif object.respond_to?(:to_ary)
+        object.to_ary || [object]
+      else
+        [object]
+      end
+    end
+  end
+end

data/lib/simple_command/version.rb

@@ -1,3 +1,3 @@
 module SimpleCommand
-  VERSION = '0.0.9'
+  VERSION = '1.0.0'
 end

data/lib/simple_command.rb

@@ -1,12 +1,13 @@
 require 'simple_command/version'
+require 'simple_command/utils'
 require 'simple_command/errors'
 
 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 +27,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

@@ -19,20 +19,66 @@ describe SimpleCommand::Errors do
   end
 
   describe '#add_multiple_errors' do
-    let(:errors_list) do
-      {
+    it 'populates itself with the added errors' do
+      errors_list = {
         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
+
+    it 'copies errors from another SimpleCommand::Errors object' do
+      command_errors = SimpleCommand::Errors.new
+      command_errors.add :some_error, "was found"
+      command_errors.add :some_error, "happened again"
+
+      errors.add_multiple_errors command_errors
+
+      expect(errors[:some_error]).to eq(["was found", "happened again"])
+    end
+
+    it "ignores nil values" do
+      errors.add_multiple_errors({:foo => nil})
+
+      expect(errors[:foo]).to eq nil
+    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,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: simple_command
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrea Pavoni
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-01-23 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
@@ -59,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -69,6 +70,7 @@ files:
 - Rakefile
 - lib/simple_command.rb
 - lib/simple_command/errors.rb
+- lib/simple_command/utils.rb
 - lib/simple_command/version.rb
 - simple_command.gemspec
 - spec/factories/missed_call_command.rb
@@ -80,7 +82,7 @@ homepage: http://github.com/nebulab/simple_command
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -95,9 +97,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: