ames_by_type 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa5b9b0c015e27d8c02d60a6b74514cc211fc705
-  data.tar.gz: 6f5c387a1abb4430fbccd338724ac4dfc7d0cbfb
+  metadata.gz: 671825b8444b47a3e24596c262fb4426c77c43d1
+  data.tar.gz: 8a8f90602a3147ef59c53745de165986eedf28e3
 SHA512:
-  metadata.gz: 1f75bf304122650c27e928a0a16ecfec07d004306c03d01a1b7404f06ae8564146b7800bdebec2fe42c311e039e3308f26f632f1c26c468c99e1f3c5c96193e1
-  data.tar.gz: 01b1e811be5e4a25930978138bd3378bb0d9d03f142a5936664c3cfd3a618e4b20b4d81c39c34d351efa849be1dde90d08bdb0306c9d35b697da8d199c762665
+  metadata.gz: b34b39961f0a574b26a66be5f21612dccf3d8d0d19ff7c035fb03164175cb48d82982bde03dc3cc69037b49d520127f095455a800326359cd641a8fd9c6419d2
+  data.tar.gz: 1efa524ac699828bd3cbb641a43076673802a3b7dd338259b2a58eb9f8980d07fe457338aa3f15c233cae98192d9444aa2f77c44f6bc12a6335ed596b0de4b75

data/README.rdoc

@@ -5,6 +5,51 @@ retrieve a hash of error messages scoped by attribute and type. Empower your
 server-sent, serialized form/record validation messages to play nicely with data-binding JS
 frameworks. Get more granular with your validation UIs.
 
+==== Installation
+
+Add the following to your +Gemfile+ and +bundle install+.
+
+  gem 'ames_by_type'
+
+==== Usage
+
+When an error message is added to an instance of <tt>ActiveModel::Errors</tt>,
+we add said error message (organized by attribute and message type) to a +messages_by_type+
+hash. We can retrieve this hash as it exists or with full messages (by keyword argument, shown below).
+
+  zebra.errors.add(:name, :blank)
+  zebra.errors.add(:name, :too_short, count: 2)
+  zebra.errors.by_type
+  # =>  {
+          name: {
+            blank: "can't be blank",
+            too_short: "is too short (minimum is 2 characters)"
+          }
+        }
+  zebra.errors.by_type(full_messages: true)
+  # =>  {
+          name: {
+              blank: "Name can't be blank",
+              too_short: "Name is too short (minimum is 2 characters)"
+          }
+        }
+
+In a Rails controller action:
+
+  ...
+  def create
+    @zebra = Zebra.new(zebra_params)
+    if @zebra.save
+      render json: @zebra
+    else
+      render json: @zebra.errors.by_type
+    end
+  end
+  ...
+
+Learn how to set up translations for your ActiveRecord models (including error messages)
+here[http://guides.rubyonrails.org/i18n.html#translations-for-active-record-models].
+
 ==== Copyright
 
 Copyright (c) 2014 Travis Loncar.

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/ames_by_type.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: ames_by_type 0.2.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "ames_by_type"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Travis Loncar"]
+  s.date = "2014-02-18"
+  s.description = "This gem extends the functionality of Rails' ActiveModel::Errors\n                     with a #by_type method that returns a hash of error messages\n                     scoped by attribute and type."
+  s.email = "loncar.travis@gmail.com"
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "ames_by_type.gemspec",
+    "lib/ames_by_type.rb",
+    "lib/ames_by_type/errors.rb",
+    "spec/ames_by_type_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/tbloncar/ames_by_type"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.1"
+  s.summary = "Extends ActiveModel::Errors with errors by type."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.7"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.7"])
+  end
+end
+

data/lib/ames_by_type.rb

@@ -1,36 +1 @@
-module ActiveModel
-  class Errors
-    attr_reader :messages_by_type
-
-    def initialize(base)
-      @base = base
-      @messages = {}
-      @messages_by_type = {}
-    end
-
-    def add(attribute, message = :invalid, options = {})
-      normalized_message = normalize_message(attribute, message, options)
-      if exception = options[:strict]
-        exception = ActiveModel::StrictValidationFailed if exception == true
-        raise exception, full_message(attribute, message)
-      end
-
-      if message.is_a?(Symbol)
-        message_by_type = {}
-        message_by_type[message] = normalized_message
-        self.messages_by_type[attribute] = (self.messages_by_type[attribute] || {}).merge(message_by_type)
-      end
-      
-      self[attribute] = normalized_message
-    end
-
-    def by_type(full_messages: false)
-      return messages_by_type.dup unless full_messages
-      messages_by_type.each do |attribute, messages|
-        messages.each do |type, message|
-          messages_by_type[attribute][type] = full_message(attribute, message)
-        end
-      end
-    end
-  end
-end
+require 'ames_by_type/errors'

data/lib/ames_by_type/errors.rb

@@ -0,0 +1,53 @@
+ActiveModel::Errors.class_eval do
+  attr_reader :messages_by_type
+
+  def initialize(base)
+    @base = base
+    @messages = {}
+    @messages_by_type = {}
+  end
+    
+  # If the provided message is a symbol, it is treated as a type.
+  # The +messages_by_type+ hash includes a key for each attribute
+  # (like +messages+), where the corresponding values are error
+  # messages organized (in hash form) by validation types.
+  # 
+  #   giraffe.errors.add(:name, :blank)
+  #   giraffe.errors.add(:name, :too_short, count: 1)
+  #   giraffe.errors.messages_by_type
+  #   # => { name: { blank: "can't be blank",
+  #                  too_short: "is too short (minimum is 1 character)"
+  #                }}
+  def add(attribute, message = :invalid, options = {})
+    normalized_message = normalize_message(attribute, message, options)
+    if exception = options[:strict]
+      exception = ActiveModel::StrictValidationFailed if exception == true
+      raise exception, full_message(attribute, message)
+    end
+    
+    if message.is_a?(Symbol)
+      message_by_type = {}
+      message_by_type[message] = normalized_message
+      self.messages_by_type[attribute] = (self.messages_by_type[attribute] || {}).merge(message_by_type)
+    end
+    
+    self[attribute] = normalized_message
+  end
+
+  # Returns +messages_by_type+ (outlined above). Accepts a +full_message+
+  # keyword argument. When +true+, full messages are included. 
+  #
+  #   zebra.errors.add(:name, :blank)
+  #   zebra.errors.by_type
+  #   # => { name: { blank: "can't be blank" }}
+  #   zebra.errors.by_type(full_messages: true)
+  #   # => { name: { blank: "Name can't be blank" }}
+  def by_type(full_messages: false)
+    return messages_by_type.dup unless full_messages
+    messages_by_type.each do |attribute, messages|
+      messages.each do |type, message|
+        messages_by_type[attribute][type] = full_message(attribute, message)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ames_by_type
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Travis Loncar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-17 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -83,7 +83,9 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- ames_by_type.gemspec
 - lib/ames_by_type.rb
+- lib/ames_by_type/errors.rb
 - spec/ames_by_type_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/tbloncar/ames_by_type