simple_command 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c874dea14c49cfea5cf2d5f8dafcbc8352199a55
-  data.tar.gz: caedd0f176a3f0091728dabd200212100c4462b0
+  metadata.gz: e0354a2aa2db1b280b8f692540d1cc43bc8d5101
+  data.tar.gz: 338efb5cc5dba3c0dc871f0b8c95303199bee39e
 SHA512:
-  metadata.gz: cbf388daa3f6482e3916afd9f2d982d22b50927e4af7e60e6b4b88d88f94020e872c1ad206bbe039e732936e3d43a065608f32d0624e6153dd172852f4f2eb68
-  data.tar.gz: 07ccf08861301769d364e60dce60a388bea5319988e90ab83b108409ca9a629a9e1eaf280b01a7408a4f2a8cc0a7709bff6dfb0f01940c25692f4af2fec8df43
+  metadata.gz: 93599a158af6881b4a0bff6d580ecc7f3324669bdef4a9a8781aa7772d7372e392fc4bfadb44e3688605c2c5ea0a792fe86e4ff0f1e0e2c4809895c17d9fe35e
+  data.tar.gz: a0e8fa514b19948d4725f35f152aaa612ba359f30abe7108e5ab7afc0a1edbc556e4d513650213e2d875ead4215f27f764bd80faaf9662bf8b2426e40d8a5797

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:
+#     - 'simple_command.gemspec'
+#     - 'spec/factories/**/*'
+
+# Style/Encoding:
+#   Enabled: when_needed
+
+Style/Documentation:
+  Enabled: false

data/Gemfile

@@ -5,4 +5,5 @@ gemspec
 
 group :development do
   gem 'simplecov'
+  gem 'rubocop'
 end

data/README.md

@@ -8,12 +8,10 @@ A simple, standardized way to build and use _Service Objects_ (aka _Commands_) i
 
 ## 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'
+gem 'simple_command'
 ```
 
 And then execute:
@@ -59,7 +57,8 @@ Then, in your controller:
 class SessionsController < ApplicationController
   def create
     # initialize and execute the command
-    command = AuthenticateUser.new(session_params[:user], session_params[:password]).perform
+    # NOTE: `.perform` is a shortcut for `.new(args).perform)`
+    command = AuthenticateUser.perform(session_params[:user], session_params[:password])
 
     # check command outcome
     if command.success?

data/Rakefile

@@ -1,7 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
-
+task default: :spec

data/lib/simple_command.rb

@@ -1,12 +1,21 @@
-require "simple_command/version"
-require "simple_command/errors"
+require 'simple_command/version'
+require 'simple_command/errors'
 
 module SimpleCommand
+  attr_reader :result
 
-  def perform
-    if !defined?(super)
-      raise NotImplementedError
+  module ClassMethods
+    def perform(*args)
+      new(*args).perform
     end
+  end
+
+  def self.prepended(base)
+    base.extend ClassMethods
+  end
+
+  def perform
+    fail NotImplementedError unless defined?(super)
 
     @performed = true
     @result = super
@@ -22,10 +31,6 @@ module SimpleCommand
     performed? && errors.any?
   end
 
-  def result
-    @result
-  end
-
   def errors
     @errors ||= {}
   end

data/lib/simple_command/errors.rb

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

data/lib/simple_command/version.rb

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

data/simple_command.gemspec

@@ -3,23 +3,23 @@ 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"
+Gem::Specification.new do |s|
+  s.required_ruby_version = '>= 2.0'
+  s.name          = '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/simple_command'
+  s.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"]
+  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']
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  s.add_development_dependency 'bundler', '~> 1.7'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.1'
 end

data/spec/factories/fail_command.rb

@@ -6,6 +6,6 @@ class FailCommand
   end
 
   def perform
-    add_error(:wrong_math, 'Math is not an opinion') if true
+    add_error(:wrong_math, 'Math is not an opinion')
   end
 end

data/spec/simple_command_spec.rb

@@ -4,6 +4,23 @@ describe SimpleCommand do
   let(:command) { SuccessCommand.new(2) }
   let(:fail_command) { FailCommand.new(2) }
 
+  describe '.perform' do
+    before do
+      allow(SuccessCommand).to receive(:new).and_return(command)
+      allow(command).to receive(:perform)
+
+      SuccessCommand.perform 2
+    end
+
+    it 'initializes the command' do
+      expect(SuccessCommand).to have_received(:new)
+    end
+
+    it 'calls #perform method' do
+      expect(command).to have_received(:perform)
+    end
+  end
+
   describe '#perform' do
     let(:missed_perform_command) { MissedPerformCommand.new(2) }
 
@@ -12,7 +29,9 @@ describe SimpleCommand do
     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)
+      expect do
+        missed_perform_command.perform
+      end.to raise_error(SimpleCommand::NotImplementedError)
     end
   end
 
@@ -81,5 +100,4 @@ describe SimpleCommand do
       end
     end
   end
-
 end

data/spec/spec_helper.rb

@@ -1,11 +1,13 @@
 require 'simplecov'
 
 SimpleCov.start do
-  add_filter "/spec/"
+  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 }
+Dir[File.join(File.dirname(__FILE__), 'factories', '**/*.rb')].each do |factory|
+  require factory
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_command
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Andrea Pavoni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-02 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -42,17 +42,17 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   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)'
+        version: '3.1'
+description: Easy way to build and manage commands (service objects)
 email:
 - andrea.pavoni@gmail.com
 executables: []
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -85,7 +86,7 @@ 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
@@ -98,7 +99,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: 'Easy way to build and manage commands (aka: service objects)'
+summary: Easy way to build and manage commands (service objects)
 test_files:
 - spec/factories/fail_command.rb
 - spec/factories/missed_perform_command.rb