gourami 0.4.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 603c7eab7f67f882417c3d2c3972b8632e50d420
-  data.tar.gz: d9ddbf73b7e29f40443d3f2ff421f434c66ee073
+SHA256:
+  metadata.gz: 9aeeb89759c11dd7f9559824ccfd42bc6ab7755aa2d60f11b8a38e5b0db08902
+  data.tar.gz: 80c1968c495c2cff9277b4bd51c0340bd8381874dc864d53dab711091f61443a
 SHA512:
-  metadata.gz: 2e98badb6ec80ba426d32da18e915944c7461e9154348efdc5c401cac9053224e4a82ed16ca78d89d81c6506cce4d6c940cf53e84e253e4ea87d1a7008634d1b
-  data.tar.gz: dddd5426e7a1c497ccd0ff57c2536944d51077dd7317637fa3961943605afed939045047043017e2bdfe3bd2b8a8f22b93e11558a3f6e47206477b63cbceb57b
+  metadata.gz: 97af9a59317e79d499c95b7b05f31a5089e9f56c7b7970818c22b36482de075f646f212b12e41ad4b53d9be1e967c34b08b34e55c46a90e033151f46416208dc
+  data.tar.gz: 48979f3194878e519431c3a46deb3da5eea9dc624731483f89e8006370d84c30027445b4ac6b31f0ca91b1d669539ad79edf988c51a2d8b2f56f7877b1659cdd

data/README.md

@@ -252,7 +252,11 @@ end
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+To add another gem owner to gourami gem `gem owner --add john.smith@example.com gourami`
 
 ## Contributing
 

data/Rakefile

@@ -8,4 +8,18 @@ Rake::TestTask.new(:test) do |t|
 end
 
 task :spec => :test
+namespace :test do
+  task :watch do |t, args|
+    require "filewatcher"
+
+    watcher = Filewatcher.new(["spec/", "lib/"], :every => true, :spinner => true, :immediate => true)
+    watcher.watch do |filename, event|
+      begin
+        Rake::Task[:test].execute(args)
+      rescue StandardError => error
+        puts "Error: #{error.message}"
+      end
+    end
+  end
+end
 task :default => :test

data/gourami.gemspec

@@ -21,8 +21,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_development_dependency "activesupport", ">= 5.1.7"
+  spec.add_development_dependency "filewatcher", "~> 1.1.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
   spec.add_development_dependency "pry", "~>0.10"
-  spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "minitest", "~> 5.0"
 end

data/lib/gourami.rb

@@ -2,6 +2,7 @@ module Gourami
 end
 
 require "gourami/error"
+require "gourami/attribute_name_conflict_error"
 require "gourami/configuration_error"
 require "gourami/not_watching_changes_error"
 require "gourami/required_attribute_error"

data/lib/gourami/attribute_name_conflict_error.rb

@@ -0,0 +1,4 @@
+module Gourami
+  class AttributeNameConflictError < Gourami::Error
+  end
+end

data/lib/gourami/attributes.rb

@@ -2,6 +2,7 @@ module Gourami
   module Attributes
 
     module ClassMethods
+
       # Copy parent attributes to inheriting class.
       #
       # @param klass [Class]
@@ -20,11 +21,16 @@ module Gourami
       # @block default_block
       #   If provided, the block will be applied to options as the :default
       def attribute(name, options = {}, &default_block)
+        base = self
         options = options.dup
         options[:default] = default_block if block_given?
 
         mixin = Module.new do |mixin|
           unless options[:skip_reader]
+            if !base.attributes.key?(name) && base.instance_methods.include?(name) && !options[:override_reader]
+              raise AttributeNameConflictError, "#{name} is already a method. To use the existing method, use `:skip_reader => true` option. To override the existing method, use `:override_reader => true` option."
+            end
+
             mixin.send(:define_method, :"#{name}") do
               value = instance_variable_get(:"@#{name}")
               default = options[:default]

data/lib/gourami/coercer.rb

@@ -11,10 +11,7 @@ module Gourami
     # @return [*]
     def setter_filter(attribute_name, value, options)
       type = options[:type]
-      coercer_method_name = :"coerce_#{type}"
-      if type
-        value = send(coercer_method_name, value, options)
-      end
+      value = send(:"coerce_#{type}", value, options) if type
 
       super(attribute_name, value, options)
     end
@@ -23,12 +20,17 @@ module Gourami
     #
     # @param value [Object]
     # @option allow_nil [Boolean] (true)
+    # @option nil_when_empty [Boolean] (true)
     # @option upcase [Boolean] (false)
     # @option strip [Boolean] (true)
     #
     # @return [String, nil]
     def coerce_string(value, options = {})
-      return nil if value.nil? && options.fetch(:allow_nil, true)
+      if options.fetch(:allow_nil, true)
+        return if value.nil?
+        value = value.to_s
+        return if value.empty? && options.fetch(:nil_when_empty, false)
+      end
 
       value = value.to_s.dup.force_encoding(Encoding::UTF_8)
       value.strip! if options.fetch(:strip, true)
@@ -44,9 +46,9 @@ module Gourami
     #
     # @return [Boolean, nil]
     def coerce_boolean(value, options = {})
-      return nil if options[:allow_nil] && (value.nil? || value == "")
+      return if options[:allow_nil] && (value.nil? || value == "")
       return false if value.to_s.strip == "false"
-      !!value && !coerce_string(value).strip.empty?
+      !!value && !coerce_string(value, :allow_nil => false).strip.empty?
     end
 
     # Coerce the value into an Array.
@@ -63,31 +65,29 @@ module Gourami
     # @return [Array]
     #   The coerced Array.
     def coerce_array(value, options = {})
+      return if options[:allow_nil] && value.nil?
+
       element_type = options[:element_type]
-      value = value.values if value.kind_of?(Hash)
+      value = value.values if value.is_a?(Hash)
 
-      if options[:split_by] && value.kind_of?(String)
+      if options[:split_by] && value.is_a?(String)
         value = value.split(options[:split_by]).map(&:strip)
       end
 
-      if value.kind_of?(Array)
-        if element_type
-          if element_type.kind_of?(Hash)
-            element_type_options = element_type
-            element_type = element_type[:type]
-          else
-            element_type_options = {}
-          end
-
-          coercer_method_name = :"coerce_#{element_type}"
-          value.map do |array_element|
-            send(coercer_method_name, array_element, element_type_options)
-          end
-        else
-          value
-        end
+      return [] unless value.is_a?(Array)
+      return value unless element_type
+
+      if element_type.is_a?(Hash)
+        element_type_options = element_type
+        element_type = element_type[:type]
       else
-        []
+        element_type_options = {}
+      end
+
+      coercer_method_name = :"coerce_#{element_type}"
+
+      value.map do |array_element|
+        send(coercer_method_name, array_element, element_type_options)
       end
     end
 
@@ -96,7 +96,7 @@ module Gourami
     # @param value [Object]
     #
     # @return [Float, nil]
-    def coerce_float(value, options = {})
+    def coerce_float(value, _options = {})
       Float(value) rescue nil
     end
 
@@ -107,7 +107,8 @@ module Gourami
     #
     # @return [String, nil]
     def coerce_phone(value, options = {})
-      value ? coerce_string(value).upcase.gsub(/[^+0-9A-Z]/,"") : nil
+      value = coerce_string(value, options)
+      value ? value.upcase.gsub(/[^+0-9A-Z]/, "") : nil
     end
 
     # Coerce the value into a Hash.
@@ -118,23 +119,39 @@ module Gourami
     #   The type of the hash keys to coerce, no coersion if value is nil.
     # @option options :value_type [Symbol, Callable] (nil)
     #   The type of the hash values to coerce, no coersion if value is nil.
+    # @option options :indifferent_access [Boolean] (false)
+    #   When true, the resulting Hash will be an ActiveSupport::HashWithIndifferentAccess
     #
-    # @return [Hash]
+    # @return [Hash, ActiveSupport::HashWithIndifferentAccess]
     #   The coerced Hash.
     def coerce_hash(value, options = {})
+      return if options[:allow_nil] && value.nil?
+
       hash_key_type = options[:key_type]
       hash_value_type = options[:value_type]
-      if value.kind_of?(Hash) || value.kind_of?(Sequel::Postgres::JSONHash)
-        value.each_with_object({}) do |(key, value), coerced_hash|
-          key_type = hash_key_type.respond_to?(:call) ? hash_key_type.call(key, value) : hash_key_type
-          key = send("coerce_#{key_type}", key) if key_type
-
-          value_type = hash_value_type.respond_to?(:call) ? hash_value_type.call(key, value) : hash_value_type
-          value = send("coerce_#{value_type}", value) if value_type
-          coerced_hash[key] = value
+
+      hash_class = options[:indifferent_access] ? ActiveSupport::HashWithIndifferentAccess : Hash
+      hash = hash_class.new
+
+      return hash unless value.is_a?(Hash) || (defined?(Sequel::Postgres::JSONHash) && value.is_a?(Sequel::Postgres::JSONHash))
+
+      value.each_with_object(hash) do |(key, value), coerced_hash|
+        key_type = hash_key_type.respond_to?(:call) ? hash_key_type.call(key, value) : hash_key_type
+        key = send(:"coerce_#{key_type}", key) if key_type
+
+        value_type = hash_value_type.respond_to?(:call) ? hash_value_type.call(key, value) : hash_value_type
+
+        # TODO: Refactor shared logic here and coerce_array to a method like `type, options = resolve_coercer_type_and_options`
+        if value_type.is_a?(Hash)
+          value_type_options = value_type
+          value_type = value_type[:type]
+        else
+          value_type_options = {}
         end
-      else
-        {}
+
+        value = send(:"coerce_#{value_type}", value, value_type_options) if value_type
+
+        coerced_hash[key] = value
       end
     end
 
@@ -145,13 +162,11 @@ module Gourami
     #
     # @return [Integer, nil]
     #   An Integer if the value can be coerced or nil otherwise.
-    def coerce_integer(value, options = {})
+    def coerce_integer(value, _options = {})
       value = value.to_s
-      if value.match(/\A0|[1-9]\d*\z/)
-        value.to_i
-      else
-        nil
-      end
+      return unless value =~ /\A0|[1-9]\d*\z/
+
+      value.to_i
     end
 
     # Coerce the value into a Date.
@@ -163,7 +178,7 @@ module Gourami
     #   A Date if the value can be coerced or nil otherwise.
     def coerce_date(value, options = {})
       value = coerce_string(value, options)
-      return nil if value.nil?
+      return if value.nil?
       begin
         Date.strptime(value, "%Y-%m-%d")
       rescue ArgumentError
@@ -180,7 +195,7 @@ module Gourami
     #   A Time if the value can be coerced or nil otherwise.
     def coerce_time(value, options = {})
       value = coerce_string(value, options)
-      return nil if !value || value.empty?
+      return if !value || value.empty?
 
       begin
         Time.parse(value).utc
@@ -198,13 +213,13 @@ module Gourami
     # @return [Hash, nil]
     #   The hash will contain the file String :filename and the File :tempfile,
     #   or nil otherwise.
-    def coerce_file(value, options = {})
-      if value.kind_of?(Hash) && !value[:filename].to_s.empty?
-        tempfile = value[:tempfile]
-        if tempfile.kind_of?(File) || tempfile.kind_of?(Tempfile)
-          value
-        end
-      end
+    def coerce_file(value, _options = {})
+      return unless value.is_a?(Hash) && !value[:filename].to_s.empty?
+
+      tempfile = value[:tempfile]
+      return unless tempfile.is_a?(File) || tempfile.is_a?(Tempfile)
+
+      value
     end
 
   end

data/lib/gourami/extensions/resources.rb

@@ -91,6 +91,28 @@ module Gourami
         resource_errors.values.flat_map(&:values).map(&:values).flatten.any?
       end
 
+      # Replace the existing resource errors with the provided errors Hash.
+      #
+      # @param new_resource_errors [Hash<Symbol, Hash<Symbol, Hash<Symbol, Array>>>]
+      #
+      # @return [Hash<Symbol, Hash<Symbol, Hash<Symbol, Array>>>]
+      def clear_and_set_resource_errors(new_resource_errors)
+        new_resource_errors = new_resource_errors.dup
+        resource_errors.clear
+        resource_errors.merge!(new_resource_errors)
+
+        resource_errors
+      end
+
+      def handle_validation_error(error)
+        super(error)
+        clear_and_set_resource_errors(error.resource_errors) unless error.resource_errors.nil?
+      end
+
+      def raise_validate_errors
+        raise ValidationError.new(errors, resource_errors)
+      end
+
     end
   end
 end

data/lib/gourami/validation_error.rb

@@ -9,20 +9,39 @@ module Gourami
       end
     end
 
+    def self.stringify_resource_errors(resource_errors)
+      [].tap do |array|
+        resource_errors.each do |resource_namespace, resource_namespace_errors|
+          resource_namespace_errors.each do |resource_uid, resource_uid_errors|
+            resource_uid_errors.each do |attribute_name, error|
+               array.push("#{resource_namespace}:#{resource_uid}:#{attribute_name}: #{error}")
+            end
+          end
+        end
+      end
+    end
+
     # !@attribute [r] errors
     #   @return [Hash<Symbol, Array>]
     attr_reader :errors
 
+    # !@attribute [r] resource_errors
+    #   @return [Hash<Symbol, Hash<Symbol, Hash<Symbol, Array>>>]
+    attr_reader :resource_errors
+
     # Initialize the Gourami::ValidationError.
     #
     # @param errors [Hash<Symbol, Array>]
-    def initialize(errors)
+    # @param resource_errors [Hash<Symbol, Hash<Symbol, Hash<Symbol, Array>>>]
+    def initialize(errors, resource_errors = {})
+      @resource_errors = resource_errors
       @errors = errors
+
       super(message)
     end
 
     def message
-      @message ||= "Validation failed with errors: #{stringify_errors.join("\n")}"
+      @message ||= stringify_all_errors
     end
 
     private
@@ -31,5 +50,16 @@ module Gourami
       ValidationError.stringify_errors(errors)
     end
 
+    def stringify_resource_errors
+      ValidationError.stringify_resource_errors(resource_errors)
+    end
+
+    def stringify_all_errors
+      messages = []
+      messages << "Validation failed with errors: #{stringify_errors.join("\n")}" unless errors.nil? || errors.empty?
+      messages << "Validation failed with resource errors: #{stringify_resource_errors.join("\n")}" unless resource_errors.nil? || resource_errors.empty?
+      messages.join("\n")
+    end
+
   end
 end

data/lib/gourami/validations.rb

@@ -15,11 +15,16 @@ module Gourami
     # @raise [Gourami::ValidationError]
     def perform!
       if valid?
-        returned = perform
+        begin
+          returned = perform
+        rescue Gourami::ValidationError => error
+          handle_validation_error(error)
+          raise
+        end
       end
 
       if any_errors?
-        raise ValidationError.new(errors)
+        raise_validate_errors
       end
 
       returned
@@ -46,9 +51,9 @@ module Gourami
 
     # Replace the existing errors with the provided errors Hash.
     #
-    # @param new_errors [Hash<Symbol, nil>, Array<Symbol, String>]
+    # @param new_errors Hash<Symbol, Array>
     #
-    # @return [Hash<Symbol, nil>, Array<Symbol, String>]
+    # @return Hash<Symbol, Array>
     def clear_and_set_errors(new_errors)
       new_errors = new_errors.dup
       errors.clear
@@ -57,6 +62,14 @@ module Gourami
       errors
     end
 
+    def raise_validate_errors
+      raise ValidationError.new(errors)
+    end
+
+    def handle_validation_error(error)
+      clear_and_set_errors(error.errors) unless error.errors.nil?
+    end
+
     # Return true if there given attribute has any errors.
     def attribute_has_errors?(attribute_name)
       errors[attribute_name.to_sym].any?

data/lib/gourami/version.rb

@@ -1,3 +1,3 @@
 module Gourami
-  VERSION = "0.4.0".freeze
+  VERSION = "1.3.0".freeze
 end

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: gourami
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.3.0
 platform: ruby
 authors:
 - TSMMark
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-22 00:00:00.000000000 Z
+date: 2020-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.7
+- !ruby/object:Gem::Dependency
+  name: filewatcher
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '10.0'
 description: Create Plain Old Ruby Objects that take attributes, validate them, and
   perform an action.
 email:
@@ -85,6 +99,7 @@ files:
 - bin/setup
 - gourami.gemspec
 - lib/gourami.rb
+- lib/gourami/attribute_name_conflict_error.rb
 - lib/gourami/attributes.rb
 - lib/gourami/coercer.rb
 - lib/gourami/configuration_error.rb
@@ -118,8 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Keep your Routes, Controllers and Models thin.