adequate_errors 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6292086a3e4cbd867447484ac68fbc5a68802a63
-  data.tar.gz: 862ebfd497a58618225482f232b05b08b31c09aa
+  metadata.gz: 1424b1f08a935abadf39c414affcef49d6531a9e
+  data.tar.gz: 40cc4ff506d51660af10a69b995f9b36d0c03dad
 SHA512:
-  metadata.gz: 5193cc15cf703b06b4fbe3e72b894ab25eb757b6defc60411cd5dd67f7518f2cd5aecb2ea3348505ce049d07d9413f1184b95cbfe4ba02c620099bf03081f3bf
-  data.tar.gz: 037de8bbfd563dfa981e5ab22ea581d51d8ba693717223674cb91bed5eec95d23812f75a3e671f57931c5ce2736eb6fb4c1528ab3977e30bc198f9054486179d
+  metadata.gz: 8a3ffd1f57440d0d716e4af3759e892a4cb67a8f9b79160af4a60d854a9f49ad464ef11759ee7ef6cfcf0d9094d452ca972af5f79fdc098d0771682996a434fb
+  data.tar.gz: fd881d54b1ed4afe2d1a0fa0c73162d46658cab1312d12c43cf36175c34c55cbafb5a3b39e349b5b7a0c13d5e6ef289bbcbf195fa9eaaacdf40d878d7c5288f7

data/Gemfile.lock

@@ -16,10 +16,24 @@ GEM
       tzinfo (~> 1.1)
     builder (3.2.3)
     concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
     i18n (0.9.1)
       concurrent-ruby (~> 1.0)
     minitest (5.10.3)
     rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
     thread_safe (0.3.6)
     tzinfo (1.2.4)
       thread_safe (~> 0.1)
@@ -32,6 +46,7 @@ DEPENDENCIES
   builder (~> 3.2.3)
   bundler (~> 1.16.a)
   rake (~> 10.0)
+  rspec (~> 3.7)
 
 BUNDLED WITH
-   1.16.0.pre.3
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 LULALALA
+
+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

@@ -2,7 +2,8 @@
 
 Overcoming limitation of Rails model errors API:
 
-* more expressive `where` query
+* fine-grained `where` query
+* object-oriented Error object
 * turn off message's attribute prefix.
 * lazy evaluation of messages
 
@@ -10,50 +11,122 @@ Overcoming limitation of Rails model errors API:
 
 Rails errors API is simple to use, but can be inadequate when coping with more complex requirements.
 
+Examples of how existing Rails API is limiting are listed here: http://lulalala.logdown.com/posts/2909828-adequate-errors
+
 The existing API was originally a collection of message strings without much meta data, making it very restrictive. Though `details` hash was added later for storing meta information, many fundamental issues can not be fixed without altering the API and the architecture.
 
 This gem redesigned the API, placing it in its own object, co-existing with existing Rails API. Thus nothing will break, allowing you to migrate the code one at a time.
 
+
 ## Quick start
 
-To access the AdequateErrors object, call:
+To access the AdequateErrors, call:
 
     model.errors.adequate
 
-From this object, many convenience methods are provided, for example this would return an array of AdequateErrors::Error objects, which matches the where query.
+From this `Errors` object, many convenience methods are provided:
+
+Return an array of AdequateErrors::Error objects, matching a condition:
 
     model.errors.adequate.where(attribute:'title', :type => :too_short, length: 5)
 
-The following prints out each error's full message one by one:
+Prints out each error's full message one by one:
 
     model.errors.adequate.each {|error| puts error.message }
     
-The following returns an array of all message strings:
+Return an array of all message strings:
 
     model.errors.adequate.messages
     
-For full documentation, please see http://www.rubydoc.info/github/lulalala/adequate_errors
+## `Error` object
+
+An `Error` object provides the following:
+
+* `attribute` is the model attribute the error belongs to.
+* `type` is the error type.
+* `options` is a hash containing additional information such as `:count` or `:length`.
+* `message` is the error message. It is full message by design.
+
+## `where` query
+
+Use `where` method to find errors matching different conditions. An array of Error objects are returned.
+
+To find all errors of `title` attribute, pass it with `:attribute` key:
+
+    model.errors.adequate.where(:attribute => :title)
+    
+You can also filter by error type using the `:type` key:
+
+    model.errors.adequate.where(:type => :too_short)
+    
+Custom attributes passed can also be used to filter errors:
+
+    model.errors.adequate.where(:attribute => :title, :type => :too_short, length: 5)
+    
+    
+## `include?`
+
+Same as Rails, provide the attribute name to see if that attribute has errors.
 
-## Key difference to Rails own errors API
+## `add`, `delete`
 
-Errors are stored as Ruby objects instead of message strings, this makes more fine-grained query possible.
+Same as built-in counterparts.
+
+## `import`
+
+For copying an error from inner model to outer model, such as form object. This ensures lazy message generation can still reference all information that the inner error has.
+
+```ruby
+inner_model.errors.adequate.each do |error|
+  errors.adequate.import(error)
+end
+```
+
+Attribute and type can be overriden in case when attribute does not exist in the outer model:
+
+```ruby
+  errors.adequate.import(error, attribute: :foo, type: :bar)
+```
+
+## Message and I18n
+
+Error message strings reside under `adequate_errors` namespace. Unlike Rails, there is no global prefixing of attributes. Instead, `%{attribute}` is added into each error message when needed.
+
+```yaml
+en:
+  adequate_errors:
+    messages:
+      invalid: "%{attribute} is invalid"
+      inclusion: "%{attribute} is not included in the list"
+      exclusion: "%{attribute} is reserved"
+```
+
+This allows omission of attribute prefix. You no longer need to attach errors to `:base` for that purpose.
+
+Built-in Rails error types already have been prefixed out of the box, but error types from other gems have to be handled manually by copying entries to the  `adequate_errors` namespace and prefixing with attributes.
 
 Error messages are evaluated lazily, which means it can be rendered in a different locale at view rendering time.
 
-The messages in the locale file are looked up in its own `adequate_errors` namespace, for example:
 
-    en:
-      adequate_errors:
-        messages:
-          invalid: "%{attribute} is invalid"
+## `messages`
+
+Returns an array of all messages.
+
+    model.errors.adequate.messages
+
+## `messages_for`
 
-Note that each message by default has the `attribute` prefix. This allow easy removal of attribute prefix by overriding each message in the locale file. You no longer need to attach errors to `:base` for that purpose. This allows prefix to be changed per language.
+Returns an array of messages, filtered by conditions. Method argument is the same as `where`.
+
+    model.errors.adequate.messages_for(:attribute => :title, :type => :too_short, length: 5)
+    
+## Full documentation
 
-Calls to Rails' API are synced to AdequateErrors object, but not the reverse.
+http://www.rubydoc.info/github/lulalala/adequate_errors
 
-## Migration Note
+## Note
 
-Deprecated methods such as `[]=`, `get` and `set` are not supported, therefore calling those methods will not sync to AdequateErrors.
+Calls to Rails' API are synced to AdequateErrors object, but not in reverse. Deprecated methods such as `[]=`, `get` and `set` are not sync'ed however.
 
 The gem is developed from ActiveModel 5.1, but it should work with earlier versions.
 

data/adequate_errors.gemspec

@@ -6,10 +6,11 @@ require "adequate_errors/version"
 Gem::Specification.new do |spec|
   spec.name          = "adequate_errors"
   spec.version       = AdequateErrors::VERSION
+  spec.license       = 'MIT'
   spec.authors       = ["lulalala"]
   spec.email         = ["mark@goodlife.tw"]
 
-  spec.summary       = %q{Object-Oriented ActiveModel errors interface}
+  spec.summary       = %q{Overcoming limitation of Rails model errors API}
   spec.homepage      = "https://github.com/lulalala/adequate_errors/"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
@@ -19,9 +20,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   spec.add_dependency "activemodel"
 
   spec.add_development_dependency "bundler", "~> 1.16.a"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "builder", "~> 3.2.3"
+  spec.add_development_dependency "rspec", "~> 3.7"
 end

data/lib/adequate_errors/errors.rb

@@ -1,6 +1,7 @@
 require 'active_model/errors'
 require 'forwardable'
 require 'adequate_errors/error'
+require 'adequate_errors/nested_error'
 
 module AdequateErrors
   # Collection of {Error} objects.
@@ -45,6 +46,18 @@ module AdequateErrors
       @errors.append(::AdequateErrors::Error.new(@base, attribute, type, options))
     end
 
+    # Imports error
+    # For copying nested model's errors back to base model.
+    # The provided error will be wrapped, and its attribute/type will be copied across.
+    # If attribute or type needs to be overriden, use `override_options`.
+    #
+    # @param override_options [Hash]
+    # @option override_options [Symbol] :attribute Override the attribute the error belongs to
+    # @option override_options [Symbol] :type Override type of the error.
+    def import(error, override_options = {})
+      @errors.append(::AdequateErrors::NestedError.new(@base, error, override_options))
+    end
+
     # @return [Array(String)] all error messages
     def messages
       @errors.map(&:message)
@@ -60,7 +73,7 @@ module AdequateErrors
     # @param params [Hash]
     #   filter condition
     #   The most common keys are +:attribute+ and +:type+,
-    #   but other custom keys given during {#add} can also be used.
+    #   but other custom keys given during {Errors#add} can also be used.
     #   If params is empty, all errors are returned.
     # @option params [Symbol] :attribute Filtering on attribute the error belongs to
     # @option params [Symbol] :type Filter on type of error

data/lib/adequate_errors/nested_error.rb

@@ -0,0 +1,30 @@
+module AdequateErrors
+  # Represents one single error
+  # @!attribute [r] base
+  #   @return [ActiveModel::Base] the object which the error belongs to
+  # @!attribute [r] attribute
+  #   @return [Symbol] attribute of the object which the error belongs to
+  # @!attribute [r] type
+  #   @return [Symbol] error's type
+  # @!attribute [r] options
+  #   @return [Hash] additional options
+  # @!attribute [r] inner_error
+  #   @return [Error] inner error
+  class NestedError < Error
+    def initialize(base, inner_error, override_options = {})
+      @base = base
+      @inner_error = inner_error
+      @attribute = override_options.fetch(:attribute) { inner_error.attribute }
+      @type = override_options.fetch(:type) { inner_error.type }
+      @options = inner_error.options
+    end
+
+    attr_reader :inner_error
+
+    # Full message of the error.
+    # Sourced from inner error.
+    def message
+      @inner_error.message
+    end
+  end
+end

data/lib/adequate_errors/version.rb

@@ -1,3 +1,3 @@
 module AdequateErrors
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: adequate_errors
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - lulalala
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-14 00:00:00.000000000 Z
+date: 2017-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
 description: 
 email:
 - mark@goodlife.tw
@@ -77,6 +91,7 @@ files:
 - ".yardopts"
 - Gemfile
 - Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
 - adequate_errors.gemspec
@@ -87,9 +102,11 @@ files:
 - lib/adequate_errors/errors.rb
 - lib/adequate_errors/interceptor.rb
 - lib/adequate_errors/locale/en.yml
+- lib/adequate_errors/nested_error.rb
 - lib/adequate_errors/version.rb
 homepage: https://github.com/lulalala/adequate_errors/
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -99,7 +116,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -110,5 +127,5 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: Object-Oriented ActiveModel errors interface
+summary: Overcoming limitation of Rails model errors API
 test_files: []