Initial Release

pboling · pboling · commit 7c25111f4c12 · 2015-04-08T01:42:13.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
diff --git a/.rspec b/.rspec
@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2
diff --git a/CODE_OF_CONDUCT.md b/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, 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/)
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in destination_errors.gemspec
+gemspec
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Trumaker, Inc & Peter Boling
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,82 @@
+# DestinationErrors
+
+Allows you to create a class that has multiple error surfaces registered but stays within the familiar territory of `ActiveRecord::Validations`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'destination_errors'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install destination_errors
+
+## Usage
+
+Here is a contrived example.
+
+You have three models, and a form that interacts with all of them:
+```
+class User
+  has_one :profile
+  has_one :account
+end
+
+class Profile
+  belongs_to :user
+end
+
+class Account
+  belongs_to :user
+end
+```
+
+So you create an admin user form presenter class to handle everything, and you want it to be *railsy*.
+```
+class AdminUserFormPresenter
+
+  include DestinationErrors
+
+  attr_accessor :user, :profile, :account
+  has_error_surfaces [nil, :user, :profile, :account]
+
+  def initialize(*args)
+    @surface_errors_on = nil # nil means errors will be moved onto this instance.
+  end
+
+end
+```
+
+For more example usage see the specs.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Maintenance
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/destination_errors/fork )
+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. Make sure to add tests!
+6. Create a new Pull Request
+
+## Contributors
+
+See the [Network View](https://github.com/trumaker/destination_errors/network)
+
diff --git a/Rakefile b/Rakefile
@@ -0,0 +1 @@
+require "bundler/gem_tasks"
diff --git a/bin/console b/bin/console
@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "destination_errors"
+
+# 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
diff --git a/bin/setup b/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
diff --git a/destination_errors.gemspec b/destination_errors.gemspec
@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'destination_errors/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "destination_errors"
+  spec.version       = DestinationErrors::VERSION
+  spec.authors       = ["Peter Boling"]
+  spec.email         = ["peter.boling@gmail.com"]
+
+  spec.summary       = %q{Mixin providing management of error surfaces within the familiar territory of ActiveModel}
+  spec.description   = %q{Useful when a presenter deals with multiple objects that may enter into error states, and the errors need to be collected at a single point.}
+  spec.homepage      = "https://github.com/trumaker/destination_errors"
+  spec.license       = "MIT"
+
+  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_dependency "activemodel", "~> 3.1"
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+  spec.add_development_dependency "pry", "~> 0.10"
+end
diff --git a/lib/destination_errors.rb b/lib/destination_errors.rb
@@ -0,0 +1,158 @@
+require "destination_errors/version"
+
+#
+#   There are three steps to implementing this module in a class:
+#
+#   Setup 1: include DestinationErrors and set error_surfaces
+#
+#     include DestinationErrors
+#     # Usage: set explicitly in each class
+#     #        individual error surfaces can be nil, it's safe.
+#     has_error_surfaces [nil, :lead, :user]
+#
+#     # a simple default with only one surface, nil, where the errors
+#     # accumulate on the object including this module would be:
+#     #   has_error_surfaces [nil]
+#
+#   Setup 2: (optional)
+#
+#     def initialize
+#       # choose one of the surfaces to aggregate errors onto, with nil indicating self.
+#       @surface_errors_on = nil
+#     end
+#
+#   Setup 3: call move_all_errors_to_destination after errors may exist on the error_surfaces
+#
+#     def finalize
+#       move_all_errors_to_destination
+#       self # if you want chainability return self
+#     end
+#
+
+require "active_model"
+
+module DestinationErrors
+
+  def self.included(base)
+    base.include(ActiveModel::Validations)
+    base.prepend(Initializer)
+    base.extend(ClassMethods)
+    base.class_eval do
+      attr_reader :errors
+      attr_reader :errors_finalized
+      attr_accessor :surface_errors_on
+      class_attribute :error_surfaces
+    end
+  end
+
+  module Initializer
+    def initialize(*args)
+      @errors = ActiveModel::Errors.new(self)
+      @surface_errors_on = nil
+      super
+    end
+  end
+
+  # Checks to see if any errors have been registered on any of the error surfaces but:
+  #   1. does not re-run validations
+  #   2. does not add or move errors
+  # returns true if any errors are found on any surface or false otherwise
+  def error_surfaces_clean?
+    return false if self.errors.any?
+    self.class.error_surfaces.compact.each do |surface|
+      return false if errors_on_surface?(surface)
+    end
+    return false if custom_error_destination_has_errors?
+    return true
+  end
+
+  # Required for ActiveModel::Validations
+  def read_attribute_for_validation(attr)
+    send(attr)
+  end
+
+  # dynamically access the surface where errors are being aggregated
+  def error_destination
+    @error_destination = error_destination_is_self? ?
+        self :
+        self.send(self.surface_errors_on)
+  end
+
+  module ClassMethods
+    # Implementation hook
+    def has_error_surfaces(value)
+      if value.length == 1 && value.first.nil?
+        warn "#{self}: error_surfaces might not be configured"
+      end
+      self.error_surfaces = value
+    end
+
+    # Required for ActiveModel::Validations
+    def human_attribute_name(attr, options = {})
+      attr
+    end
+
+    # Required for ActiveModel::Validations
+    def lookup_ancestors
+      [self]
+    end
+  end
+
+  protected
+
+  # The error destination is not one of error_surfaces, and is not self, and has errors...
+  def custom_error_destination_has_errors?
+    !self.class.error_surfaces.include?(surface_errors_on) &&
+        !error_destination_is_self? &&
+            errors_on_surface?(surface_errors_on)
+  end
+
+  def move_all_errors_to_destination
+    return false if self.errors_finalized
+    self.error_surfaces.each do |surface|
+      move_errors_from_surface_to_destination_if_needed(surface)
+    end
+    self.errors_finalized = true
+  end
+
+  def move_errors_from_surface_to_destination_if_needed(surface)
+    if move_errors_from_surface?(surface)
+      (
+        surface.nil? ?
+          errors.full_messages :
+          self.send(surface).errors.full_messages
+      ).each do |message|
+        move_error_to_destination(message)
+      end
+    end
+  end
+
+  def move_errors_from_surface?(surface)
+    if surface.nil?
+      !error_destination_is_self? && errors && errors.any?
+    else
+      (surface_errors_on.to_s != surface.to_s) && errors_on_surface?(surface)
+    end
+  end
+
+  def errors_on_surface?(surface)
+    self.send(surface) && self.send(surface).errors.any?
+  end
+
+  def error_destination
+    @error_destination = error_destination_is_self? ?
+        self :
+        self.send(surface_errors_on)
+  end
+
+  def error_destination_is_self?
+    surface_errors_on.nil? || !self.send(surface_errors_on)
+  end
+
+  def move_error_to_destination(message)
+    if error_destination
+      error_destination.errors.add(:base, message)
+    end
+  end
+
+end
diff --git a/lib/destination_errors/version.rb b/lib/destination_errors/version.rb
@@ -0,0 +1,3 @@
+module DestinationErrors
+  VERSION = "0.0.1"
+end
diff --git a/spec/destination_errors_spec.rb b/spec/destination_errors_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+--color`
	`2`	`+--require spec_helper`
	`3`	`+--format documentation`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+language: ruby`
	`2`	`+rvm:`
	`3`	`+ - 2.1.2`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,4 @@ @@
 +source 'https://rubygems.org'
++
 +# Specify your gem's dependencies in destination_errors.gemspec
 +gemspec