collection_errors 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a4f63955694824b8fa8d6f788f6ed3414efeaed
+  data.tar.gz: b5f1938ed0e2f3af1f8efa024e6ad86682116fd0
+SHA512:
+  metadata.gz: 375eb2fc1c59cc5744b1484ba6634e8371609aebdb418a175673b46f03703781c0dc481e7a1a57957d6ddd4f45ede786b90d33314268a1850ff6e9ba2ebbb944
+  data.tar.gz: bab7dacb28773ecd81ca1a719eb0e6101b4ddfd89d161f19c790842fd4d04549660571fad39d865989a758156ce3c60c057520fe4f685a081f51c0cbb2f67342

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 nay3
+
+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,70 @@
+# CollectionErrors
+
+CollectionErrors provides custom validation error building for collections in your ActiveRecord model.
+
+When you have validation errors in collections, you generally get error with key such as "children.name". Sometimes this is not good because you can't show detailed messages to your users because this key is shared between all elements in the collection.
+
+CollectionErrors gives alternatives to that.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'collection_errors'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install collection_errors
+
+## Usage
+
+CollectionErrors adds 2 types of validation error building for collection in your Rails application.
+
+### Separate way
+
+When you have validation errors in collections, you generally get error with key such as "children.name".
+
+You can change this by calling separate_errors_on method in your model class.
+
+    has_many :items
+    separate_errors_on :items
+
+Then you can get error messages like "Item 1 name is invalid".
+
+You can cange the translation by setting 'collection_error' key. For example,
+
+    en
+      errors
+        messages
+          collection_error: "%{collection_name} %{index} : %{message}"
+
+By default, index will count objects as well those are marked for destruction.
+You can ignore those objects by specifying :ignore_marked_for_destruction option.
+
+    has_many :items
+    separate_errors_on :items, :ignore_marked_for_destruction => true
+
+### Unify
+
+Or you may want to get simply one message for one collection.
+
+You can get an invalid error for the collection using unify_errors_on.
+
+  has_many :items
+  unify_errors_on: items
+
+### Limitation
+
+This gem is for ActiveRecord and it requires errors#delete. If you are using too old Rails, adding delete mtheod will help.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/collection_errors.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'collection_errors/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "collection_errors"
+  spec.version       = CollectionErrors::VERSION
+  spec.authors       = ["nay3"]
+  spec.email         = ["y.ohba@everyleaf.com"]
+  spec.description   = %q{Providing special validation error building for has_many collection in Rails.}
+  spec.summary       = %q{Rails validation error extension}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/collection_errors/separate.rb

@@ -0,0 +1,59 @@
+module CollectionErrors
+  module Separate
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    private
+    def generate_error_message_for_collection_element(collection_name, index, message)
+      type = :collection_error
+      defaults = self.class.lookup_ancestors.map do |klass|
+        [ :"#{self.class.i18n_scope}.errors.models.#{klass.model_name.i18n_key}.attributes.#{collection_name}.#{type}",
+          :"#{self.class.i18n_scope}.errors.models.#{klass.model_name.i18n_key}.#{type}" ]
+      end
+      defaults << :"#{self.class.i18n_scope}.errors.messages.#{type}"
+      defaults << :"errors.attributes.#{collection_name}.#{type}"
+      defaults << :"errors.messages.#{type}"
+      defaults << "%{collection_name}%{index} %{message}"
+
+      defaults.compact!
+      defaults.flatten!
+
+      I18n.translate(defaults.shift, :collection_name => self.class.human_attribute_name(collection_name), :index => index, :message => message, :default => defaults)
+    end
+
+    module ClassMethods
+      def separate_errors_on(*args)
+        options = {:ignore_marked_for_destruction => false}.merge(args.extract_options!)
+
+        args.each do |collection_name|
+          method_name = "separate_errors_on_#{collection_name}"
+
+          define_method method_name do
+
+            # Remove 'collection_name.xxx' attributes from errors
+            targets = []
+            errors.each do |attribute, message|
+              targets << attribute if attribute.to_s =~ /^#{collection_name}\./
+            end
+            targets.each{|k| errors.delete(k) }
+
+            # Add original errors
+            index = 0
+            send(collection_name).each do |r|
+              next if options[:ignore_marked_for_destruction] && r.marked_for_destruction?
+              index += 1
+              next if r.errors.empty?
+
+              r.errors.full_messages.each do |full_message|
+                errors.add(:base, generate_error_message_for_collection_element(collection_name, index, full_message))
+              end
+            end
+          end
+
+          after_validation method_name
+        end
+      end
+    end
+  end
+end

data/lib/collection_errors/unify.rb

@@ -0,0 +1,30 @@
+module CollectionErrors
+  module Unify
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def unify_errors_on(*args)
+        args.each do |collection_name|
+          method_name = "unify_errors_on_#{collection_name}"
+
+          define_method method_name do
+
+            # Remove 'collection_name.xxx' attributes from errors
+            targets = []
+            errors.each do |attribute, message|
+              targets << attribute if attribute.to_s =~ /^#{collection_name}\./
+            end
+            targets.each{|k| errors.delete(k) }
+
+            # Add original errors
+            errors.add(collection_name, :invalid) if targets.any?
+          end
+
+          after_validation method_name
+        end
+      end
+    end
+  end
+end

data/lib/collection_errors/version.rb

@@ -0,0 +1,3 @@
+module CollectionErrors
+  VERSION = "0.0.1"
+end

data/lib/collection_errors.rb

@@ -0,0 +1,10 @@
+require "collection_errors/version"
+
+module CollectionErrors
+end
+
+require 'collection_errors/separate'
+require 'collection_errors/unify'
+
+ActiveRecord::Base.send(:include, CollectionErrors::Separate)
+ActiveRecord::Base.send(:include, CollectionErrors::Unify)

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: collection_errors
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- nay3
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Providing special validation error building for has_many collection in
+  Rails.
+email:
+- y.ohba@everyleaf.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- collection_errors.gemspec
+- lib/collection_errors.rb
+- lib/collection_errors/separate.rb
+- lib/collection_errors/unify.rb
+- lib/collection_errors/version.rb
+homepage: ''
+licenses:
+- MIT
+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.0.4
+signing_key: 
+specification_version: 4
+summary: Rails validation error extension
+test_files: []