activemodel-errors-tree 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 772373d73766843b2c2ca35fd7e54465de21f8a0
+  data.tar.gz: 0bbd37f0b7f9b15f9a34adbcf1acf4b19d8504d4
+SHA512:
+  metadata.gz: a520c6f018fc91d711253bf0ae4f2e049181549b8d1a0d228d58a1b546918e8d1d43e2d9b7b8a19f32aea2f1b5293460cbf6d4bdc586086aa44d1a2e66bbf510
+  data.tar.gz: 25332dda1bb48247af3a735364a18c88533fdd4765888bd28c20937b245aacee20d35f4ec61c19bd7cfb68ae2088106dcb646b59e6ea4852c908ccca5b575707

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/README.md

@@ -0,0 +1,91 @@
+# ActiveModel::Errors::Tree
+
+Did you too search Google for a way to encode your Rails errors in your API?
+Well you probably encountered an awful response like this:
+
+```ruby
+render json: { errors: @record.errors.messages }, status: :unprocessable_entity
+```
+
+**This is not a good mechanism.**
+
+Why? Let's say you have a model with associations. The way ActiveRecord encodes
+`errors.messages` is this:
+
+```ruby
+{ :field => ["can't be blank"], :"association.field" => ["must be less than 5"] }
+```
+
+Let's say you developed a great client side implementation to figure out
+`"association.field"` is actually an error on the association model. What
+happens when it's a one-to-many association?
+
+```ruby
+{ :field => ["can't be blank"], :"associations.field" => ["must be less than 5"] }
+```
+
+What?! How are you supposed to know which instance of `associations` received
+the error? How do you mark the correct textbox in red?
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activemodel-errors-tree'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activemodel-errors-tree
+
+## Usage
+
+By calling `@record.errors.tree` you get a much prettier picture, that is easier
+to decode on the client side.
+
+Following the examples above:
+
+### One-to-one
+
+```ruby
+@record.errors.tree.messages
+# This is actually a ActiveSupport::HashWithIndifferentAccess
+=> { field: ["can't be blank"], association: { field: ["must be less than 5"] } }
+```
+
+### One-to-many
+
+```ruby
+@record.errors.tree.messages
+# Assuming the error is on the second association out of three.
+=> { field: ["can't be blank"], associations: [{}, { field: ["must be less than 5"] }, {}] }
+```
+
+Now your client can iterate over the association's errors along with rendering
+the associations, and render out each association's errors.
+
+### errors.details (the recommended way)
+
+If you use Rails 5 or include the `active_model-errors_details` gem, you can use
+`@record.errors.tree.details` instead of `messages`. This is more API friendly
+since it let's your client decide on the actual messages.
+
+```ruby
+@record.errors.tree.details
+# Assuming the error is on the second association out of three.
+=> { field: [{ error: :blank }], associations: [{}, { field: [{ error: :less_than, count: 5 }] }, {}] }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/odedniv/activemodel-errors-tree. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+

data/Rakefile

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

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/activemodel-errors-tree.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "activemodel-errors-tree"
+  spec.version       = "0.1.0" # for some reason Rails applications do not like it defined in activemodel/errors/tree/version
+  spec.authors       = ["Oded Niv"]
+  spec.email         = ["oded.niv@gmail.com"]
+
+  spec.summary       = %q{ActiveModel errors format actually appropriate for APIs.}
+  spec.description   = %q{Builds a tree of errors instead of the 1-dimension one generated by ActiveMode::Base#errors.messages.}
+  spec.homepage      = "https://github.com/odedniv/activemodel-errors-tree"
+  spec.license       = "UNLICENSE"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activesupport", ">= 4.2"
+  spec.add_runtime_dependency "activemodel", ">= 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  # TODO: switch to activerecord 5 and remove active_model-errors_details
+  spec.add_development_dependency "active_model-errors_details", "~> 1.2"
+  spec.add_development_dependency "activerecord", "~> 4.2"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activemodel/errors/tree"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/activemodel/errors/tree.rb

@@ -0,0 +1,61 @@
+require "active_model/errors"
+require "active_support/hash_with_indifferent_access"
+
+module ActiveModel
+  class Errors
+    class Tree
+      def initialize(base, errors)
+        @base   = base
+        @errors = errors
+      end
+
+      ATTRIBUTE_SEPARATOR = "."
+
+      def messages
+        @messages ||= method_tree(:messages)
+      end
+
+      def details
+        @details ||= method_tree(:details)
+      end
+
+      private
+
+      def method_tree(method)
+        result = ActiveSupport::HashWithIndifferentAccess.new
+        @errors.keys.each do |original_attribute|
+          attribute, sub_attribute = original_attribute.to_s.split(ATTRIBUTE_SEPARATOR, 2) # we really only care about the first one
+          if sub_attribute.nil?
+            result[attribute] = @errors.send(method)[original_attribute]
+          else
+            sub_base = @base.send(attribute)
+            result[attribute] = sub_base.respond_to?(:map) ? sub_base.map { |r| r.errors.tree.send(method) } : sub_base.errors.tree.send(method)
+          end
+        end
+        result
+      end
+    end
+
+    def tree
+      @tree ||= Tree.new(@base, self)
+    end
+
+    alias_method :add_without_reset_tree, :add
+    def add(*args)
+      @tree = nil
+      add_without_reset_tree(*args)
+    end
+
+    alias_method :delete_without_reset_tree, :delete
+    def delete(*args)
+      @tree = nil
+      delete_without_reset_tree(*args)
+    end
+
+    alias_method :clear_without_reset_tree, :clear
+    def clear(*args)
+      @tree = nil
+      clear_without_reset_tree(*args)
+    end
+  end
+end

metadata

@@ -0,0 +1,168 @@
+--- !ruby/object:Gem::Specification
+name: activemodel-errors-tree
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oded Niv
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: active_model-errors_details
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Builds a tree of errors instead of the 1-dimension one generated by ActiveMode::Base#errors.messages.
+email:
+- oded.niv@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- UNLICENSE
+- activemodel-errors-tree.gemspec
+- bin/console
+- bin/setup
+- lib/activemodel/errors/tree.rb
+homepage: https://github.com/odedniv/activemodel-errors-tree
+licenses:
+- UNLICENSE
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: ActiveModel errors format actually appropriate for APIs.
+test_files: []