usecasing_validations 0.5.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MGUyMzJjMTM2MDg0NWFhNzBhNjI2MWZjODc2NmUzYjA1MDlmMDI5Zg==
+  data.tar.gz: !binary |-
+    NWEyZTM5MTVlNjc3MThkYmUyOTg0NmE1MGUxYTA1ZjVmNzg2MTlkNQ==
+SHA512:
+  metadata.gz: !binary |-
+    MmExMzUyN2U1OWI0NWUwOGVjOGY3YmI1NjMwMjhhYjcwN2RjYWM4ZWQ5MzE2
+    OTJkMjcyMmFiZjc5MmE1YWUwNWIxMjUzYzExZmVjZWIzZmUxMjQyZTk1ZDAy
+    N2I5ODk2MTBiODkxYWEwZTM1ODA1YzA5YjUwYWE3Y2YxNjRlNTg=
+  data.tar.gz: !binary |-
+    MzZhZTk0MWM4Y2IxZWQ1YzI3ZmRmNzcxMTY2MzRjZjAxNzE4Y2E4ZDliMjA1
+    NzIwOWQ0OTBhYmVkZjFmZDBlODc2MmU1Yjg3NTQ5MzFjOWVkZTZlNGUzZDhh
+    MmY1NzY1OGJiNjEzNjY0NGVjMzE0MDZmYmUyMDk3MDE3YTQ5MDY=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp/*
+*.DS_Store
+db/test.sqlite3

data/.rspec

@@ -0,0 +1,3 @@
+--tty
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3@usecasing_validations --create

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in usecasing.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    usecasing_validations (0.5.0)
+      usecasing (= 0.1.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    metaclass (0.0.2)
+    method_source (0.8.2)
+    mocha (1.0.0)
+      metaclass (~> 0.0.1)
+    pry (0.9.12.4)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.1.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    slop (3.4.7)
+    usecasing (0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha
+  pry
+  rake
+  rspec
+  usecasing_validations!

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Thiago Dantas
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1 @@
+Nothing to add for now

data/Rakefile

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

data/lib/usecasing/depends_all.rb

@@ -0,0 +1,21 @@
+module UseCase
+  
+  class DependsAll < Base
+
+    private ######################### PRIVATE ######################
+
+    def self.tx(execution_order, context)
+      ctx = Context.new(context)
+      executed = []
+      execution_order.each do |usecase|
+        # break unless ctx.success?
+        executed.push(usecase)
+        yield usecase, ctx
+      end
+      rollback(executed, ctx) unless ctx.success?
+      ctx
+    end
+
+  end
+
+end

data/lib/usecasing/validator.rb

@@ -0,0 +1,31 @@
+module UseCase
+  
+  class Validator < Base
+
+    include UseCaseValidations
+    
+    def perform
+      targets = [*target]
+
+      if target.nil?
+        all_validations_green = false
+
+      elsif targets.empty?
+        all_validations_green = true
+        
+      else
+        all_validations_green = targets.map do |object_to_validate|
+          if Helpers._marked_for_destruction?(object_to_validate)
+            true
+          else
+            valid?(object_to_validate)
+          end
+        end.all?
+      end
+
+      failure(self.class.to_s.downcase.to_sym, :failed) unless all_validations_green
+    end
+
+  end
+
+end

data/lib/usecasing_validations/custom_validator.rb

@@ -0,0 +1,21 @@
+module UseCaseValidations
+
+  class CustomValidator < Validator
+
+    attr_reader :methods
+
+    def initialize(args)
+      options = Helpers._extract_options!(args)
+      @methods = args
+      super(options)
+    end
+
+    def validate(record)
+      [*methods].map do |method|
+        base.send(method, record)
+      end.all?
+    end
+    
+  end
+
+end

data/lib/usecasing_validations/each_validator.rb

@@ -0,0 +1,32 @@
+module UseCaseValidations
+
+  class EachValidator < Validator
+    
+    attr_reader :attributes
+
+    def initialize(options)
+      @attributes = Array(options.delete(:attributes))
+      raise ArgumentError, ":attributes cannot be blank" if @attributes.empty?
+      super
+      check_validity!
+    end
+
+    def validate(record)
+      attributes.each do |attribute|
+        value = record.respond_to?(attribute) ? record.send(attribute) : nil
+        next if (value.nil? && options[:allow_nil]) || (Helpers._blank?(value) && options[:allow_blank])
+        validate_each(record, attribute, value)
+      end
+    end
+
+    # Override this method in subclasses with the validation logic, adding
+    # errors to the records +errors+ array where necessary.
+    def validate_each(record, attribute, value)
+      raise NotImplementedError, "Subclasses must implement a validate_each(record, attribute, value) method"
+    end
+
+    def check_validity!; end
+
+  end
+
+end

data/lib/usecasing_validations/errors.rb

@@ -0,0 +1,364 @@
+module UseCaseValidations
+
+  class Errors
+    include Enumerable
+
+    CALLBACKS_OPTIONS = [:if, :unless, :on, :allow_nil, :allow_blank, :strict]
+
+    attr_reader :messages
+
+    # Pass in the instance of the object that is using the errors object.
+    #
+    #   class Person
+    #     def initialize
+    #       @errors = ActiveModel::Errors.new(self)
+    #     end
+    #   end
+    def initialize(base)
+      @base     = base
+      @messages = {}
+    end
+
+    def initialize_dup(other) # :nodoc:
+      @messages = other.messages.dup
+      super
+    end
+
+    # Clear the error messages.
+    #
+    #   person.errors.full_messages # => ["name can not be nil"]
+    #   person.errors.clear
+    #   person.errors.full_messages # => []
+    def clear
+      messages.clear
+    end
+
+    # Returns +true+ if the error messages include an error for the given key
+    # +attribute+, +false+ otherwise.
+    #
+    #   person.errors.messages        # => {:name=>["can not be nil"]}
+    #   person.errors.include?(:name) # => true
+    #   person.errors.include?(:age)  # => false
+    def include?(attribute)
+      (v = messages[attribute]) && v.any?
+    end
+    # aliases include?
+    alias :has_key? :include?
+
+    # Get messages for +key+.
+    #
+    #   person.errors.messages   # => {:name=>["can not be nil"]}
+    #   person.errors.get(:name) # => ["can not be nil"]
+    #   person.errors.get(:age)  # => nil
+    def get(key)
+      messages[key]
+    end
+
+    # Set messages for +key+ to +value+.
+    #
+    #   person.errors.get(:name) # => ["can not be nil"]
+    #   person.errors.set(:name, ["can't be nil"])
+    #   person.errors.get(:name) # => ["can't be nil"]
+    def set(key, value)
+      messages[key] = value
+    end
+
+    # Delete messages for +key+. Returns the deleted messages.
+    #
+    #   person.errors.get(:name)    # => ["can not be nil"]
+    #   person.errors.delete(:name) # => ["can not be nil"]
+    #   person.errors.get(:name)    # => nil
+    def delete(key)
+      messages.delete(key)
+    end
+
+    # When passed a symbol or a name of a method, returns an array of errors
+    # for the method.
+    #
+    #   person.errors[:name]  # => ["can not be nil"]
+    #   person.errors['name'] # => ["can not be nil"]
+    def [](attribute)
+      get(attribute.to_sym) || set(attribute.to_sym, [])
+    end
+
+    # Adds to the supplied attribute the supplied error message.
+    #
+    #   person.errors[:name] = "must be set"
+    #   person.errors[:name] # => ['must be set']
+    def []=(attribute, error)
+      self[attribute] << error
+    end
+
+    # Iterates through each error key, value pair in the error messages hash.
+    # Yields the attribute and the error for that attribute. If the attribute
+    # has more than one error message, yields once for each error message.
+    #
+    #   person.errors.add(:name, "can't be blank")
+    #   person.errors.each do |attribute, error|
+    #     # Will yield :name and "can't be blank"
+    #   end
+    #
+    #   person.errors.add(:name, "must be specified")
+    #   person.errors.each do |attribute, error|
+    #     # Will yield :name and "can't be blank"
+    #     # then yield :name and "must be specified"
+    #   end
+    def each
+      messages.each_key do |attribute|
+        self[attribute].each { |error| yield attribute, error }
+      end
+    end
+
+    # Returns the number of error messages.
+    #
+    #   person.errors.add(:name, "can't be blank")
+    #   person.errors.size # => 1
+    #   person.errors.add(:name, "must be specified")
+    #   person.errors.size # => 2
+    def size
+      values.flatten.size
+    end
+
+    # Returns all message values.
+    #
+    #   person.errors.messages # => {:name=>["can not be nil", "must be specified"]}
+    #   person.errors.values   # => [["can not be nil", "must be specified"]]
+    def values
+      messages.values
+    end
+
+    # Returns all message keys.
+    #
+    #   person.errors.messages # => {:name=>["can not be nil", "must be specified"]}
+    #   person.errors.keys     # => [:name]
+    def keys
+      messages.keys
+    end
+
+    # Returns an array of error messages, with the attribute name included.
+    #
+    #   person.errors.add(:name, "can't be blank")
+    #   person.errors.add(:name, "must be specified")
+    #   person.errors.to_a # => ["name can't be blank", "name must be specified"]
+    def to_a
+      full_messages
+    end
+
+    # Returns the number of error messages.
+    #
+    #   person.errors.add(:name, "can't be blank")
+    #   person.errors.count # => 1
+    #   person.errors.add(:name, "must be specified")
+    #   person.errors.count # => 2
+    def count
+      to_a.size
+    end
+
+    # Returns +true+ if no errors are found, +false+ otherwise.
+    # If the error message is a string it can be empty.
+    #
+    #   person.errors.full_messages # => ["name can not be nil"]
+    #   person.errors.empty?        # => false
+    def empty?
+      all? { |k, v| v && v.empty? && !v.is_a?(String) }
+    end
+    # aliases empty?
+    alias_method :blank?, :empty?
+
+    # Returns an xml formatted representation of the Errors hash.
+    #
+    #   person.errors.add(:name, "can't be blank")
+    #   person.errors.add(:name, "must be specified")
+    #   person.errors.to_xml
+    #   # =>
+    #   #  <?xml version=\"1.0\" encoding=\"UTF-8\"?>
+    #   #  <errors>
+    #   #    <error>name can't be blank</error>
+    #   #    <error>name must be specified</error>
+    #   #  </errors>
+    def to_xml(options={})
+      to_a.to_xml({ root: "errors", skip_types: true }.merge!(options))
+    end
+
+    # Returns a Hash that can be used as the JSON representation for this
+    # object. You can pass the <tt>:full_messages</tt> option. This determines
+    # if the json object should contain full messages or not (false by default).
+    #
+    #   person.as_json                      # => {:name=>["can not be nil"]}
+    #   person.as_json(full_messages: true) # => {:name=>["name can not be nil"]}
+    def as_json(options=nil)
+      to_hash(options && options[:full_messages])
+    end
+
+    # Returns a Hash of attributes with their error messages. If +full_messages+
+    # is +true+, it will contain full messages (see +full_message+).
+    #
+    #   person.to_hash       # => {:name=>["can not be nil"]}
+    #   person.to_hash(true) # => {:name=>["name can not be nil"]}
+    def to_hash(full_messages = false)
+      if full_messages
+        messages = {}
+        self.messages.each do |attribute, array|
+          messages[attribute] = array.map { |message| full_message(attribute, message) }
+        end
+        messages
+      else
+        self.messages.dup
+      end
+    end
+
+    # Adds +message+ to the error messages on +attribute+. More than one error
+    # can be added to the same +attribute+. If no +message+ is supplied,
+    # <tt>:invalid</tt> is assumed.
+    #
+    #   person.errors.add(:name)
+    #   # => ["is invalid"]
+    #   person.errors.add(:name, 'must be implemented')
+    #   # => ["is invalid", "must be implemented"]
+    #
+    #   person.errors.messages
+    #   # => {:name=>["must be implemented", "is invalid"]}
+    #
+    # If +message+ is a symbol, it will be translated using the appropriate
+    # scope (see +generate_message+).
+    #
+    # If +message+ is a proc, it will be called, allowing for things like
+    # <tt>Time.now</tt> to be used within an error.
+    #
+    #   person.errors.messages # => {}
+    def add(attribute, message = nil, options = {})
+      message = normalize_message(attribute, message, options)
+      self[attribute] << message
+    end
+
+    # Returns +true+ if an error on the attribute with the given message is
+    # present, +false+ otherwise. +message+ is treated the same as for +add+.
+    #
+    #   person.errors.add :name, :blank
+    #   person.errors.added? :name, :blank # => true
+    def added?(attribute, message = nil, options = {})
+      message = normalize_message(attribute, message, options)
+      self[attribute].include? message
+    end
+
+    # Returns all the full error messages in an array.
+    #
+    #   class Person
+    #     validates_presence_of :name, :address, :email
+    #     validates_length_of :name, in: 5..30
+    #   end
+    #
+    #   person = Person.create(address: '123 First St.')
+    #   person.errors.full_messages
+    #   # => ["Name is too short (minimum is 5 characters)", "Name can't be blank", "Email can't be blank"]
+    def full_messages
+      map { |attribute, message| full_message(attribute, message) }
+    end
+
+    # Returns all the full error messages for a given attribute in an array.
+    #
+    #   class Person
+    #     validates_presence_of :name, :email
+    #     validates_length_of :name, in: 5..30
+    #   end
+    #
+    #   person = Person.create()
+    #   person.errors.full_messages_for(:name)
+    #   # => ["Name is too short (minimum is 5 characters)", "Name can't be blank"]
+    def full_messages_for(attribute)
+      (get(attribute) || []).map { |message| full_message(attribute, message) }
+    end
+
+    # Returns a full message for a given attribute.
+    #
+    #   person.errors.full_message(:name, 'is invalid') # => "Name is invalid"
+    def full_message(attribute, message)
+      return message if attribute == :base || !@base.class.respond_to?(:model_name)
+
+      attr_name = attribute.to_s.tr('.', '_').humanize
+      attr_name = @base.class.human_attribute_name(attribute, default: attr_name)
+      I18n.t(:"errors.format", {
+        default:  "%{attribute} %{message}",
+        attribute: attr_name,
+        message:   message
+      })
+    end
+
+    # Translates an error message in its default scope
+    # (<tt>activemodel.errors.messages</tt>).
+    #
+    # Error messages are first looked up in <tt>models.MODEL.attributes.ATTRIBUTE.MESSAGE</tt>,
+    # if it's not there, it's looked up in <tt>models.MODEL.MESSAGE</tt> and if
+    # that is not there also, it returns the translation of the default message
+    # (e.g. <tt>activemodel.errors.messages.MESSAGE</tt>). The translated model
+    # name, translated attribute name and the value are available for
+    # interpolation.
+    #
+    # When using inheritance in your models, it will check all the inherited
+    # models too, but only if the model itself hasn't been found. Say you have
+    # <tt>class Admin < User; end</tt> and you wanted the translation for
+    # the <tt>:blank</tt> error message for the <tt>title</tt> attribute,
+    # it looks for these translations:
+    #
+    # * <tt>activemodel.errors.models.admin.attributes.title.blank</tt>
+    # * <tt>activemodel.errors.models.admin.blank</tt>
+    # * <tt>activemodel.errors.models.user.attributes.title.blank</tt>
+    # * <tt>activemodel.errors.models.user.blank</tt>
+    # * any default you provided through the +options+ hash (in the <tt>activemodel.errors</tt> scope)
+    # * <tt>activemodel.errors.messages.blank</tt>
+    # * <tt>errors.attributes.title.blank</tt>
+    # * <tt>errors.messages.blank</tt>
+    def generate_message(attribute, type = :invalid, options = {})
+      type = options.delete(:message) if options[:message].is_a?(Symbol)
+
+      if !@base.class.respond_to?(:model_name)
+        return options.key?(:message) ? options[:message] : type
+      end
+
+      if @base.class.respond_to?(:i18n_scope)
+        defaults = @base.class.lookup_ancestors.map do |klass|
+          [ :"#{@base.class.i18n_scope}.errors.models.#{klass.model_name.i18n_key}.attributes.#{attribute}.#{type}",
+            :"#{@base.class.i18n_scope}.errors.models.#{klass.model_name.i18n_key}.#{type}" ]
+        end
+      else
+        defaults = []
+      end
+
+      defaults << options.delete(:message)
+      defaults << :"#{@base.class.i18n_scope}.errors.messages.#{type}" if @base.class.respond_to?(:i18n_scope)
+      defaults << :"errors.attributes.#{attribute}.#{type}"
+      defaults << :"errors.messages.#{type}"
+
+      defaults.compact!
+      defaults.flatten!
+
+      key = defaults.shift
+      value = (attribute != :base ? @base.send(attribute) : nil)
+
+      options = {
+        default: defaults,
+        model: @base.class.model_name.human,
+        attribute: @base.class.human_attribute_name(attribute),
+        value: value
+      }.merge!(options)
+
+      I18n.translate(key, options)
+    end
+
+  private
+    def normalize_message(attribute, message, options)
+      message ||= :invalid
+      
+      case message
+      when Symbol
+        generate_message(attribute, message, Helpers._except(options, *CALLBACKS_OPTIONS))
+      when Proc
+        message.call
+      else
+        message
+      end
+    end
+    
+  end
+
+end

data/lib/usecasing_validations/helpers.rb

@@ -0,0 +1,50 @@
+module UseCaseValidations
+
+  module Helpers
+
+    extend self
+
+    def _blank?(object)
+      if object.is_a?(String)
+        object !~ /[^[:space:]]/
+      else
+        object.respond_to?(:empty?) ? object.empty? : !object
+      end
+    end
+
+    def _marked_for_destruction?(object)
+      object.respond_to?(:marked_for_destruction?) ? object.marked_for_destruction? : false
+    end
+  
+    def _extract_options!(array)
+      if array.last.is_a?(Hash) && array.last.instance_of?(Hash)
+        array.pop
+      else
+        {}
+      end
+    end
+
+    def _symbolyze_keys(hash)
+      hash.keys.reduce({ }) do |acc, key|
+        acc[key.to_sym] = hash[key]
+        acc
+      end
+    end
+
+    def _except(hash, *keys)
+      _hash = hash.dup
+      keys.each { |key| _hash.delete(key) }
+      _hash
+    end
+
+    def _call_proc_or_method(base, proc_or_method, object = nil)
+      if object.nil?
+        proc_or_method.is_a?(Proc) ? base.instance_exec(&proc_or_method) : base.send(proc_or_method)
+      else
+        proc_or_method.is_a?(Proc) ? base.instance_exec(object, &proc_or_method) : base.send(proc_or_method, object)
+      end
+    end
+
+  end
+
+end

data/lib/usecasing_validations/target.rb

@@ -0,0 +1,44 @@
+module UseCaseValidations
+  
+  module Target
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def target_sym
+      self.class.target_sym
+    end
+
+    def parent_target_sym
+      self.class.options.key?(:in) ? self.class.options[:in] : nil
+    end
+
+    def target
+      send(target_sym)
+    end
+
+    def parent_target
+      parent_target_sym ? send(parent_target_sym) : nil
+    end
+
+    module ClassMethods
+
+      attr_reader :target_sym, :options
+      
+      def target(target_sym, options = {})
+        @target_sym, @options = target_sym, options
+
+        if options.key?(:in)
+          define_method(options[:in]) { context.send(options[:in]) }
+          define_method(target_sym) { send(options[:in]).send(target_sym) }
+        else
+          define_method(target_sym) { context.send(target_sym) }
+        end
+      end
+
+    end
+    
+  end
+
+end