mintdigital-fancy_errors 1.0.0

data/README.rdoc

@@ -0,0 +1,54 @@
+= Fancy Errors
+
+== Description
+
+Define the whole error message for an attribute by prefixing it with '^':
+
+  validates_acceptance_of :terms, :message => "^Terms must be accepted."
+  @user.errors.full_messages #=> ['Terms must be accepted']
+
+Order your error messages:
+
+  validates_presence_of :title, :content
+  @post.errors.full_messages(:order => [:title, :content])
+    #=> ["Title can't be blank", "Content can't be blank"]
+
+Get the full messages for a specific attribute:
+
+  validates_presence_of :title, :message => "^Can has title?"
+  validates_uniqueness_of :title, :message => 'must be unique'
+  @post.errors.full_messages_on(:title)
+    #=> ['Can has title?', 'Title must be unique']
+
+== Installation
+
+    sudo gem install mintdigital-fancy_errors
+
+== Usage
+
+    config.gem 'mintdigital-fancy_errors', :lib => 'fancy_errors'
+
+== License
+
+Copyright (c) 2009 Dean Strelau, Mint Digital
+
+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/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+require 'rake/gempackagetask'
+spec = Gem::Specification.new do |s|
+  s.name             = 'fancy_errors'
+  s.version          = '1.0.0'
+  s.has_rdoc         = false
+  s.extra_rdoc_files = %w(README.rdoc)
+  s.rdoc_options     = %w(--main README.rdoc)
+  s.summary          = "Make your ActiveRecord::Errors fancy"
+  s.author           = 'Dean Strelau'
+  s.email            = 'dean@mintdigital.com'
+  s.homepage         = 'http://mintdigital.github.com/fancy_errors'
+  s.files            = %w(README.rdoc Rakefile) + Dir.glob("{lib,test,rails}/**/*")
+  
+  s.add_development_dependency('jeremymcanally-context', '> 0.5.0')
+  s.add_development_dependency('mhennemeyer-matchy', '> 0.3.0')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/*_test.rb']
+    t.verbose = true
+    end
+  rescue
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :gemspec do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end
+
+
+task :default => :test

data/lib/fancy_errors.rb

@@ -0,0 +1,26 @@
+class FancyErrors < ActiveRecord::Errors
+  def full_messages(options = {})
+    if options[:order] && order = options[:order].map {|a| a.to_s }
+      # add attrs specified in order
+      ordered_attrs = order & @errors.keys
+      ordered_attrs += @errors.keys - order
+    end
+
+    (ordered_attrs||@errors.keys).inject([]) do |full_messages, a|
+      full_messages.concat(full_messages_on(a))
+    end
+  end
+
+  def full_messages_on(attribute)
+    (@errors[attribute.to_s] || []).inject([]) do |messages, msg|
+      if attribute.to_s == 'base'
+        messages << msg
+      elsif msg =~ /^\^/
+        messages << msg[1..-1]
+      else
+        attr_name = @base.class.human_attribute_name(attribute)
+        messages << attr_name + I18n.t('activerecord.errors.format.separator', :default => ' ') + msg
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,7 @@
+module ::ActiveRecord
+  module Validations
+    def errors
+      @errors ||= FancyErrors.new(self)
+    end
+  end
+end

data/test/fancy_errors_test.rb

@@ -0,0 +1,77 @@
+require 'helper'
+
+class FancyErrorsTest < Test::Unit::TestCase
+  def setup
+    @errors = FancyErrors.new(Base.new)
+  end
+
+  context "#full_messages" do
+    it "returns just the message when it starts with ^ " do
+      @errors.add(:title, '^That title sucks')
+      @errors.full_messages.should == ['That title sucks']
+    end
+
+    it "does not change messages that don't start with ^" do
+      @errors.add(:title, "can't be blank")
+      @errors.full_messages.should == ["Title can't be blank"]
+    end
+
+    it "can mix and match" do
+      @errors.add_to_base('You fail')
+      @errors.add(:title, '^That title sucks')
+      @errors.add(:title, "can't be blank")
+      ['You fail', "That title sucks", "Title can't be blank"].each do |err|
+        @errors.full_messages.should include(err)
+      end
+    end
+
+    it "returns ordered errors for object when given an order key" do
+      [:title, :snippet, :content].each do |attribute|
+        @errors.add(attribute, "can't be blank")
+      end
+      @errors.full_messages(:order => [:snippet, :title, :content]).should == [
+        "Snippet can't be blank",
+        "Title can't be blank",
+        "Content can't be blank"
+      ]
+    end
+
+    it "excludes ordering attributes that don't have errors" do
+      @errors.add(:title, "can't be blank")
+      @errors.full_messages(:order => [:snippet, :title, :content]).
+        should == ["Title can't be blank"]
+    end
+  end
+
+  context "#full_messages_on" do
+    it "returns empty if no error on that attribute" do
+      @errors.full_messages_on(:title).should == []
+    end
+
+    it "returns just the message when it starts with ^ " do
+      @errors.add(:title, '^That title sucks')
+      @errors.full_messages_on(:title).should == ['That title sucks']
+    end
+
+    it "does not change messages that don't start with ^" do
+      @errors.add(:title, "can't be blank")
+      @errors.full_messages_on(:title).should == ["Title can't be blank"]
+    end
+
+    it "works with errors on base" do
+      @errors.add_to_base('You fail')
+      @errors.full_messages_on(:base).should == ['You fail']
+    end
+  end
+
+  it "allows full, ordered messages" do
+    @errors.add(:snippet, "must be less than 160 characters")
+    @errors.add(:content, "^You must have content")
+    @errors.add(:title, "can't be blank")
+    @errors.full_messages(:order => [:title, :snippet, :content]).should == [
+      "Title can't be blank",
+      "Snippet must be less than 160 characters",
+      "You must have content"
+    ]
+  end
+end

data/test/helper.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'test/unit'
+require 'context'
+require 'matchy'
+
+begin
+  require 'redgreen'
+rescue LoadError
+end
+
+# Define this error so Validations can be loaded without Base
+class ActiveRecordError < StandardError; end
+require 'i18n'
+require 'active_record/validations'
+
+require File.join(File.dirname(__FILE__), '../lib/fancy_errors')
+
+# Mock out an AR::Base class
+class Base
+  attr_accessor :title, :snippet, :content
+  class << self
+    def human_attribute_name(a); a.to_s.capitalize; end
+  end
+end
+
+module Kernel
+  def silence_warnings
+    old_verbose, $VERBOSE = $VERBOSE, nil
+    yield
+  ensure
+    $VERBOSE = old_verbose
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: mintdigital-fancy_errors
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Dean Strelau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jeremymcanally-context
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.5.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mhennemeyer-matchy
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.3.0
+    version: 
+description: 
+email: dean@mintdigital.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- lib/fancy_errors.rb
+- test/fancy_errors_test.rb
+- test/helper.rb
+- rails/init.rb
+has_rdoc: false
+homepage: http://mintdigital.github.com/fancy_errors
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Make your ActiveRecord::Errors fancy
+test_files: []
+