object_attorney 3.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dbfd04fe687681f1030ef93cbbf32c177bb67f98
-  data.tar.gz: b2e7ff76d84de665db33f2275e082ad6dc24122c
+  metadata.gz: c4d890c47532df6465b42cf292cce79ea7547269
+  data.tar.gz: 53f487a5a4f3f6a8ef76e107fdb3ca5d3340af06
 SHA512:
-  metadata.gz: 416ef86c1c665c0a20ef9a9efd78ed2ab21cacd7b254bbf5282e63cf54f214bb0757020f145a404730d0c63fd6fbd06a8457461d833f706c1a7a1c3e34e61ea8
-  data.tar.gz: 878e0a1ce4a1fbcabf50ac95dd2e7090f6f21548bf19b559fca4b1dc49ce0c939d76ca28da737cc6414c384f972a13126935dc73e2f4c9f63256a8dd83d2f92f
+  metadata.gz: cc07794845c2f7370d4583e0ce75ea4918b4cf0de7644f69d35f2bb2c920b22e55989f311b5d5e76e35a004de6e38557caba229ef188c048afedb1540951d09b
+  data.tar.gz: b948a71214feb47355f3aca6caafa9970a3888a6c079e6bc3b1e09124ca3b7d6c81b3e30699059a86285085603a292d216adb8a16f3056d88d1efa91c26f2b7e

data/Gemfile.lock

@@ -1,22 +1,20 @@
 PATH
   remote: .
   specs:
-    object_attorney (3.0.0)
+    object_attorney (3.0.1)
+      activemodel (~> 3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (4.2.6)
-      activesupport (= 4.2.6)
-      builder (~> 3.1)
-    activesupport (4.2.6)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
+    activemodel (3.2.22.2)
+      activesupport (= 3.2.22.2)
+      builder (~> 3.0.0)
+    activesupport (3.2.22.2)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
     ast (2.3.0)
-    builder (3.2.2)
+    builder (3.0.4)
     codeclimate-test-reporter (0.4.8)
       simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.1)
@@ -25,7 +23,7 @@ GEM
     i18n (0.7.0)
     json (1.8.3)
     method_source (0.8.2)
-    minitest (5.9.0)
+    multi_json (1.12.1)
     parser (2.3.1.2)
       ast (~> 2.2)
     powerpack (0.1.1)
@@ -61,16 +59,12 @@ GEM
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
     slop (3.6.0)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
     unicode-display_width (0.3.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activemodel (= 4.2.6)
   codeclimate-test-reporter (= 0.4.8)
   object_attorney!
   pry (= 0.10.3)

data/README.md

@@ -1,5 +1,5 @@
 # Object Attorney
-
+This gem allows you to create use cases with ActiveModel validations and keep your model clean.
 
 [![Code Climate](https://codeclimate.com/github/goncalvesjoao/object_attorney/badges/gpa.svg)](https://codeclimate.com/github/goncalvesjoao/object_attorney)
 [![Test Coverage](https://codeclimate.com/github/goncalvesjoao/object_attorney/badges/coverage.svg)](https://codeclimate.com/github/goncalvesjoao/object_attorney/coverage)
@@ -12,25 +12,57 @@ end
 ```
 
 ```ruby
-class UserValidator < Struct.new(:user)
+class UserValidator < ObjectAttorney::Base
+  validates_presence_of :first_name
+
+  validate :last_name_present
+
+  def last_name_present(user)
+    return if user.last_name.present?
+
+    user.errors.add(:last_name, :blank)
+  end
+end
+```
+
+```ruby
+@user = User.new
+
+UserValidator.new(@user).valid? # false
+
+@user.errors.messages # { first_name: ["can't be blank"], last_name: ["can't be blank"] }
+```
+
+## 2) Custom Usage
+```ruby
+class User < ActiveRecord::Base
+end
+```
+
+```ruby
+class UserValidator
   include ObjectAttorney
 
   defend :user
 
-  validates_presence_of :first_name
-end
+  validates_presence_of :first_name, if: :last_name_is_present
 
-# OR
+  attr_accessor :user
 
-class UserValidator < ObjectAttorney::Base
-  validates_presence_of :first_name
+  def initialize(user)
+    @user = user
+  end
+
+  def last_name_is_present(user)
+    user.last_name.present?
+  end
 end
 ```
 
 ```ruby
-@user = User.new
+@user = User.new(last_name: 'Snow')
 
-UserValidator.new(@user).valid?
+UserValidator.new(@user).invalid? # true
 
 @user.errors.messages # { first_name: ["can't be blank"] }
 ```

data/lib/object_attorney/errors.rb

@@ -9,9 +9,10 @@ module ObjectAttorney
         attribute
       end
 
-      def lookup_ancestors
-        [self]
-      end
+      # Having doubts if this is really necessary
+      # def lookup_ancestors
+      #   [self]
+      # end
     end
 
     def self.included(base_class)

data/lib/object_attorney/helpers.rb

@@ -16,14 +16,16 @@ module ObjectAttorney
       if proc_or_method.is_a?(Proc)
         base.instance_exec(object, &proc_or_method)
       else
-        base.send(proc_or_method, object)
+        call_method!(base, proc_or_method, object)
       end
     end
 
-    def safe_call_method(base, method)
-      return nil unless base.respond_to?(method)
+    def call_method!(base, method, *args)
+      unless base.respond_to?(method)
+        raise NotImplementedError, "#{base} does not respond to #{method}"
+      end
 
-      base.send(method)
+      base.send(method, *args)
     end
 
     def extend_errors_if_necessary(object)

data/lib/object_attorney/validations/custom.rb

@@ -14,7 +14,9 @@ module ObjectAttorney
       end
 
       def validate(defendant)
-        [*@methods].map { |method| @attorney.send(method, defendant) }.all?
+        [*@methods].all? do |method|
+          Helpers.call_method!(@attorney, method, defendant)
+        end
       end
 
     end

data/lib/object_attorney/version.rb

@@ -1,5 +1,5 @@
 module ObjectAttorney
 
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.0.2'.freeze
 
 end

data/lib/object_attorney.rb

@@ -11,9 +11,9 @@ module ObjectAttorney
   end
 
   def defendant_is_innocent?
-    proven_innocent = defendants.all? do |defendant|
+    proven_innocent = defendants.map do |defendant|
       innocent_of_all_accusations?(defendant)
-    end
+    end.all?
 
     make_the_parent_guilty unless proven_innocent
 
@@ -29,13 +29,14 @@ module ObjectAttorney
   protected ######################### PROTECTED ################################
 
   def defendants
-    defendant = Helpers.safe_call_method(self, defendant_options[:name])
-
-    if parent_defendant
-      Helpers.extend_errors_if_necessary(parent_defendant)
-
-      defendant ||= parent_defendant.send(defendant_options[:name])
-    end
+    defendant =
+      if parent_defendant
+        Helpers.extend_errors_if_necessary(parent_defendant)
+
+        Helpers.call_method!(parent_defendant, defendant_options[:name])
+      else
+        Helpers.call_method!(self, defendant_options[:name])
+      end
 
     [defendant].flatten.compact
   end

data/object_attorney.gemspec

@@ -10,8 +10,8 @@ Gem::Specification.new do |gem|
   gem.license = 'MIT'
   gem.authors = ['João Gonçalves']
   gem.email = ['goncalves.joao@gmail.com']
-  gem.summary = 'Ruby Form Object pattern implementation'
-  gem.description = "This gem allows you to extract the code responsible for 'validations', 'nested objects' and 'strong parameters' from your model onto a specific class for a specific use case."
+  gem.summary = 'Allows you to keep your ActiveModel validations out of your objects'
+  gem.description = 'This gem allows you to create use cases with ActiveModel validations and keep your model clean'
   gem.homepage = 'https://github.com/streetbees/object_attorney'
 
   gem.files = `git ls-files`.split($/)
@@ -24,8 +24,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'rspec', '3.4.0'
   gem.add_development_dependency 'rubocop', '0.37.2'
   gem.add_development_dependency 'simplecov', '0.11.2'
-  gem.add_development_dependency 'activemodel', '4.2.6'
   gem.add_development_dependency 'codeclimate-test-reporter', '0.4.8'
 
-  # gem.add_dependency 'i18n', '~> 0.7'
+  gem.add_dependency 'activemodel', '~> 3'
 end

data/spec/object_attorney/custom_validation_spec.rb

@@ -25,7 +25,7 @@ describe ObjectAttorney do
 
     context "given a user with an invalid phone_number" do
       before do
-        @user = User.new('jon', 'bad number')
+        @user = User.new(phone_number: 'bad number')
         @custom_validator.new(@user).valid?
       end
 
@@ -35,7 +35,7 @@ describe ObjectAttorney do
 
       context "and preventing the validation" do
         before do
-          @user = User.new('jon', 'really bad number', true)
+          @user = User.new(phone_number: 'really bad number', dont_validate: true)
           @custom_validator.new(@user).valid?
         end
 
@@ -47,7 +47,7 @@ describe ObjectAttorney do
 
     context "given a user with a valid phone_number" do
       before do
-        @user = User.new('jon', '123 123')
+        @user = User.new(phone_number: '123 123')
         @custom_validator.new(@user).valid?
       end
 

data/spec/object_attorney/object_attorney_spec.rb

@@ -2,6 +2,77 @@ require 'spec_helper'
 
 describe ObjectAttorney do
 
+  context "When the defendant is nil" do
+    before do
+      @user_validator = Struct.new(:user) do
+        include ObjectAttorney
+
+        defend :user
+
+        validates_presence_of :first_name, unless: Proc.new { |user| user.dont_validate }
+      end
+    end
+
+    it "#valid? should be true" do
+      expect(@user_validator.new(nil).valid?).to be true
+    end
+  end
+
+  context "When the defendant is empty" do
+    before do
+      @user = User.new
+      @user.posts = []
+
+      @user_validator = Struct.new(:user) do
+        include ObjectAttorney
+
+        defend :posts, in: :user
+
+        validates_presence_of :first_name, unless: Proc.new { |user| user.dont_validate }
+      end
+    end
+
+    it "#valid? should be true" do
+      expect(@user_validator.new(@user).valid?).to be true
+    end
+  end
+
+  context "When the defendant is not defined" do
+    before do
+      @user = User.new
+
+      @user_validator = Struct.new(:user) do
+        include ObjectAttorney
+
+        defend :posts
+
+        validates_presence_of :first_name, unless: Proc.new { |user| user.dont_validate }
+      end
+    end
+
+    it "#valid? should raise an error" do
+      expect { @user_validator.new(@user).valid? }.to raise_error NotImplementedError
+    end
+  end
+
+  context "When the defendant is not defined on the parent" do
+    before do
+      @user = User.new
+
+      @user_validator = Struct.new(:user) do
+        include ObjectAttorney
+
+        defend :comments, in: :user
+
+        validates_presence_of :first_name, unless: Proc.new { |user| user.dont_validate }
+      end
+    end
+
+    it "#valid? should raise an error" do
+      expect { @user_validator.new(@user).valid? }.to raise_error NotImplementedError
+    end
+  end
+
   context "When the defendant is a single object" do
     before do
       @user = User.new
@@ -23,7 +94,7 @@ describe ObjectAttorney do
 
     context "and the unless validation is true" do
       before do
-        @user = User.new('', '', true)
+        @user = User.new(dont_validate: true)
       end
 
       it "@user.errors should be empty" do
@@ -37,7 +108,7 @@ describe ObjectAttorney do
   context "When the defendant is an array nested inside another object" do
     before do
       @user = User.new
-      @user.posts = [Post.new, Post.new(nil, true), Post.new('yada')]
+      @user.posts = [Post.new, Post.new(_destroy: true), nil, Post.new(title: 'yada')]
 
       @user_validator = Struct.new(:user) do
         include ObjectAttorney
@@ -57,8 +128,101 @@ describe ObjectAttorney do
     it "only the first @user.posts should have errors" do
       expect(@user.posts[0].errors.messages).to eq({ title: ["can't be blank"] })
       expect(@user.posts[1].errors.empty?).to be true
-      expect(@user.posts[2].errors.empty?).to be true
+      expect(@user.posts[2]).to be_nil
+      expect(@user.posts[3].errors.empty?).to be true
     end
   end
 
+  describe "inheritance" do
+
+    context "when a use case inherits from another that has a dependant and a validation" do
+      before do
+        @user1 = User.new
+        @user2 = User.new
+        @user3 = User.new
+        @user4 = User.new
+
+        @user_validator1 = Class.new do
+          include ObjectAttorney
+
+          defend :user
+
+          validates_presence_of :first_name
+
+          attr_accessor :user
+
+          def initialize(user)
+            @user = user
+          end
+        end
+
+        @user_validator2 = Class.new(@user_validator1) do
+          validates_presence_of :phone_number
+        end
+
+        @user_validator3 = Class.new(@user_validator2) do
+          defend :users
+
+          attr_accessor :users
+
+          def initialize(users)
+            @users = users
+          end
+        end
+
+        @user_validator1.new(@user1).valid?
+        @user_validator2.new(@user2).valid?
+        @user_validator3.new([@user3, @user4]).valid?
+      end
+
+      it "@user_validator1.defendant_options should mention :user" do
+        expect(@user_validator1.defendant_options).to eq({ name: :user })
+      end
+
+      it "@user_validator2.defendant_options should mention :user" do
+        expect(@user_validator2.defendant_options).to eq({ name: :user })
+      end
+
+      it "@user_validator3.defendant_options should mention :users" do
+        expect(@user_validator3.defendant_options).to eq({ name: :users })
+      end
+
+      it "@user1.errors should ONLY mention first_name" do
+        expect(@user1.errors.count).to be 1
+
+        expect(@user1.errors.messages).to eq({
+          first_name: ["can't be blank"]
+        })
+      end
+
+      it "@user2.errors should mention first_name and phone_number" do
+        expect(@user2.errors.messages).to eq({
+          first_name: ["can't be blank"],
+          phone_number: ["can't be blank"]
+        })
+
+        expect(@user2.errors.count).to be 2
+      end
+
+      it "@user3.errors should mention first_name and phone_number" do
+        expect(@user3.errors.messages).to eq({
+          first_name: ["can't be blank"],
+          phone_number: ["can't be blank"]
+        })
+
+        expect(@user3.errors.count).to be 2
+      end
+
+      it "@user4.errors should mention first_name and phone_number" do
+        expect(@user4.errors.messages).to eq({
+          first_name: ["can't be blank"],
+          phone_number: ["can't be blank"]
+        })
+
+        expect(@user4.errors.count).to be 2
+      end
+    end
+
+  end
+
 end

data/spec/support/post.rb

@@ -1,7 +1,13 @@
-class Post < Struct.new(:title, :marked_for_destruction)
+class Post
+
+  attr_accessor :title, :_destroy
+
+  def initialize(attributes = {})
+    (attributes || {}).each { |name, value| send("#{name}=", value) }
+  end
 
   def marked_for_destruction?
-    self.marked_for_destruction
+    _destroy
   end
 
 end

data/spec/support/user.rb

@@ -1,5 +1,9 @@
-class User < Struct.new(:first_name, :phone_number, :dont_validate)
+class User
 
-  attr_accessor :posts
+  attr_accessor :first_name, :phone_number, :dont_validate, :posts
+
+  def initialize(attributes = {})
+    (attributes || {}).each { |name, value| send("#{name}=", value) }
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: object_attorney
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.2
 platform: ruby
 authors:
 - João Gonçalves
@@ -81,36 +81,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.11.2
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.6
+        version: 0.4.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.6
+        version: 0.4.8
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.8
-  type: :development
+        version: '3'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.8
-description: This gem allows you to extract the code responsible for 'validations',
-  'nested objects' and 'strong parameters' from your model onto a specific class for
-  a specific use case.
+        version: '3'
+description: This gem allows you to create use cases with ActiveModel validations
+  and keep your model clean
 email:
 - goncalves.joao@gmail.com
 executables: []
@@ -166,7 +165,7 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Ruby Form Object pattern implementation
+summary: Allows you to keep your ActiveModel validations out of your objects
 test_files:
 - spec/object_attorney/base_spec.rb
 - spec/object_attorney/custom_validation_spec.rb