gourami 0.5.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98ec9c2d757ec710e65dd5aa0662530f0f92363b72d56edce9fecebe85d0d800
-  data.tar.gz: 80842660cd5e2ed28a244414ef8a8f8f091d111d8fd2ba614bcec52dc0efe807
+  metadata.gz: 471278c6d8c858485bdec0d124139f3ccd4251eedbad1573059dcf4519ec9b0a
+  data.tar.gz: 2e62de42a3eb36e05cd247bed62ccb7f7bfecb796318a1b0c5dfeb79ce6b28bf
 SHA512:
-  metadata.gz: 94897c3b427a7528020c6df8b657c193e88488b52610bf853d2e3fffda962ba1e0ba642ba7c72e2c9bb6ecf234518372910f733bca453d72a2b72c4ee469cb55
-  data.tar.gz: 12d3a6215c2fc337aa03af6d0818b916879aebe77cb96a21aed65d47ca7385a68eb096cc81dc22ff39ca3e187260ffd0a0f55060a4fb38db948eeb5a673a0e87
+  metadata.gz: '09d6304054c99cbf3587005dfc38c8fef568dff2339cfc1ae41642bacbf4c80da1a91c54bc435b90253ac01d7c72927f516b945838db698d33df7250bb686499'
+  data.tar.gz: e33e55074af37d7776329feb8a491687ab43dea237d5ce96cd4dd9ff1d80f6a580b43b6015021c69a9444d48f788bcd1bd16c512f07da4f6377f3a19d0682ea8

data/.ruby-version

@@ -0,0 +1 @@
+2.5.3

data/README.md

@@ -1,5 +1,7 @@
 # Gourami
 
+[![Codeship Status for Vydia/gourami](https://app.codeship.com/projects/316bc070-f431-0136-4713-52c1ec7c066f/status?branch=master)](https://app.codeship.com/projects/320673)
+
 Keep your Routes, Controllers and Models thin with Plain Old Ruby Objects (PORO).
 
 ## Installation
@@ -12,7 +14,7 @@ gem 'gourami'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
@@ -20,10 +22,10 @@ Or install it yourself as:
 
 ## Usage
 
-### A Typical Gourami::Form will
+### A Typical `Gourami::Form` will
 
- - Define some attributes
- - Validate user input
+ - Define attributes (inputs & outputs)
+ - Validate input
  - Perform an action
 
 ```ruby
@@ -173,6 +175,56 @@ class UpdateFishBowl < CreateFishBowl
 end
 ```
 
+#### Configure default attribute options
+
+The following examples will result in all `:string` attributes getting the options `:strip` and `:upcase` set to `true`.
+
+Set global defaults:
+
+```ruby
+Gourami::Form.set_default_attribute_options(:string, upcase: true)
+
+# Make sure to define CreateFishBowl and other forms AFTER setting default options.
+class CreateFishBowl < Gourami::Form
+  attribute(:name, type: :string)
+end
+
+form = CreateFishBowl.new(name: "Snake Gyllenhaal")
+form.name # => "SNAKE GYLLENHAAL"
+```
+
+Instead of global defaults, you can also apply defaults to certain form classes.
+
+Just as `attributes` are inherited by subclasses, so are `default_attribute_options`.
+
+Set local defaults:
+
+```ruby
+class ScreamingForm < Gourami::Form
+  set_default_attribute_options(:string, upcase: true)
+end
+
+class CreateScreamingFish < ScreamingForm
+  attribute(:name, type: :string)
+end
+
+class UpdateScreamingFish < CreateScreamingFish; end
+
+create_form = CreateScreamingFish.new(name: "Snake Gyllenhaal")
+create_form.name # => "SNAKE GYLLENHAAL"
+
+update_form = UpdateScreamingFish.new(name: "Snake Gyllenhaal")
+update_form.name # => "SNAKE GYLLENHAAL"
+
+# Other Gourami::Forms are unaffected
+class RegularForm < Gourami::Form
+  attribute(:name, type: :string)
+end
+
+regular_form = RegularForm.new(name: "Snake Gyllenhaal")
+regular_form.name # => "Snake Gyllenhaal"
+```
+
 #### Extensions / Plugins
 
 ##### Gourami::Extensions::Changes
@@ -250,9 +302,13 @@ end
 
 ## Development
 
-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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests, or `rake test:watch` to automatically rerun the tests when you make code changes. 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,12 +2,14 @@ module Gourami
   module Attributes
 
     module ClassMethods
+
       # Copy parent attributes to inheriting class.
       #
       # @param klass [Class]
       def inherited(klass)
         super(klass)
         klass.instance_variable_set(:@attributes, attributes.dup)
+        klass.instance_variable_set(:@default_attribute_options, default_attribute_options.dup)
       end
 
       # Define an attribute for the form.
@@ -20,14 +22,21 @@ 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?
 
+        options_with_defaults = merge_default_attribute_options(options)
+
         mixin = Module.new do |mixin|
-          unless options[:skip_reader]
+          unless options_with_defaults[:skip_reader]
+            if !base.attributes.key?(name) && base.instance_methods.include?(name) && !options_with_defaults[: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]
+              default = options_with_defaults[:default]
 
               if value.nil? && default
                 default.respond_to?(:call) ? instance_exec(&default) : default
@@ -45,7 +54,7 @@ module Gourami
 
           # Define internal setter.
           mixin.send(:define_method, :"_#{name}=") do |value|
-            instance_variable_set(:"@#{name}", setter_filter(name, value, options))
+            instance_variable_set(:"@#{name}", setter_filter(name, value, self.class.merge_default_attribute_options(options)))
           end
           mixin.send(:private, :"_#{name}=")
 
@@ -84,6 +93,24 @@ module Gourami
       def attributes
         @attributes ||= {}
       end
+
+      # Useful if you want, for example, all type: :string attributes to use
+      # strip: true to remove whitespace padding.
+      def set_default_attribute_options(attr_type, options)
+        default_attribute_options[attr_type] = options
+      end
+
+      def default_attribute_options
+        @default_attribute_options ||= {}
+      end
+
+      def merge_default_attribute_options(options)
+        if options[:type]
+          default_attribute_options.fetch(options[:type], {}).merge(options)
+        else
+          options
+        end
+      end
     end
 
     # Extend ClassMethods into including class.

data/lib/gourami/coercer.rb

@@ -11,8 +11,7 @@ module Gourami
     # @return [*]
     def setter_filter(attribute_name, value, options)
       type = options[:type]
-      coercer_method_name = :"coerce_#{type}"
-      value = send(coercer_method_name, value, options) if type
+      value = send(:"coerce_#{type}", value, options) if type
 
       super(attribute_name, value, options)
     end
@@ -34,6 +33,9 @@ module Gourami
       end
 
       value = value.to_s.dup.force_encoding(Encoding::UTF_8)
+
+      # TODO: Instead of providing unconfigurable defaults like this, use
+      # set_default_attribute_options at the gem level or consumer level.
       value.strip! if options.fetch(:strip, true)
       value.upcase! if options.fetch(:upcase, false)
 
@@ -85,6 +87,9 @@ module Gourami
         element_type_options = {}
       end
 
+      element_type_options[:type] = element_type
+      element_type_options = self.class.merge_default_attribute_options(element_type_options) if self.class.respond_to?(:merge_default_attribute_options)
+
       coercer_method_name = :"coerce_#{element_type}"
 
       value.map do |array_element|
@@ -120,21 +125,41 @@ 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]
 
-      return {} unless value.is_a?(Hash) || (defined?(Sequel::Postgres::JSONHash) && value.is_a?(Sequel::Postgres::JSONHash))
+      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({}) do |(key, value), coerced_hash|
+      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
+        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
+
+        # 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
+
+        value_type_options[:type] = value_type
+        value_type_options = self.class.merge_default_attribute_options(value_type_options) if self.class.respond_to?(:merge_default_attribute_options)
+
+        value = send(:"coerce_#{value_type}", value, value_type_options) if value_type
+
         coerced_hash[key] = 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.5.0".freeze
+  VERSION = "1.3.1".freeze
 end

metadata

@@ -1,71 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: gourami
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.3.1
 platform: ruby
 authors:
 - TSMMark
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-30 00:00:00.000000000 Z
+date: 2020-10-06 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:
@@ -75,6 +89,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -85,6 +100,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
@@ -103,7 +119,7 @@ homepage: http://github.com/Vydia/gourami
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -118,9 +134,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.0.4
+signing_key:
 specification_version: 4
 summary: Keep your Routes, Controllers and Models thin.
 test_files: []