errors-renderer 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in errors-renderer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 De Marque inc.
+
+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,29 @@
+Errors Renderer
+===============
+
+Error rendering engine to standardize all error outputs.
+
+Install
+-------
+
+```
+gem install errors-renderer
+```
+
+### Rails 3
+
+In your Gemfile:
+
+```ruby
+gem 'errors-renderer'
+```
+
+IMPORTANT
+-----
+
+Errors-Renderer currently have some dependencies with a private project. It is therefore unusable for other projects. We hope to fix that soon.
+
+Copyright
+---------
+
+Copyright (c) 2013 De Marque inc. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler"
+require "rspec/core/rake_task"
+
+Bundler::GemHelper.install_tasks
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+end
+
+task :default => :spec

data/lib/errors-renderer/engine.rb

@@ -0,0 +1,5 @@
+module ErrorsRenderer
+  class Engine < Rails::Engine
+    #auto wire
+  end
+end

data/lib/errors-renderer/errors.rb

@@ -0,0 +1,104 @@
+module ErrorsRenderer
+  class Errors
+    def initialize(errors_or_record, options={})
+      options.reverse_merge! controller: nil, action: nil
+
+      @errors = parse_raw_errors errors_or_record
+      @root_name = get_root_name options[:controller], options[:action]
+    end
+
+    def all
+      @errors
+    end
+
+    def codes
+      @errors.map{ |e| e[:code] }.compact
+    end
+
+    def empty?
+      @errors.empty?
+    end
+
+    def full_codes
+      @errors.map { |e| e[:full_code] }.compact
+    end
+
+    def full_messages
+      @errors.map{ |e| e[:full_message] }.compact
+    end
+
+    def localize
+      ErrorsRenderer::Localizor
+    end
+
+    def root_name
+      @root_name
+    end
+
+    def to_json
+      result = @errors.map do |e|
+        err = { code: e[:full_code], message: e[:full_message] }
+        err[:field] = e[:field] if e[:field]
+
+        err
+      end
+
+      return result.to_json
+    end
+
+    private
+
+    def get_root_name(controller, action)
+      if action == 'index'
+        controller
+      else
+        controller.singularize
+      end
+    end
+
+    def parse_error(code, message, field=nil, full_message=nil)
+      error = { code: code, message: message }
+
+      if field == :model_error
+        field = nil
+        full_message = message
+      end
+
+      error[:field] = field if field
+      error[:full_message] = full_message || message
+      error[:full_code] = [field, code].compact.join('_')
+
+      return error
+    end
+
+    def parse_error_from_code(code)
+      parse_error code, I18n.t("errors.messages.#{code}")
+    end
+
+    def parse_raw_errors(errors_or_record)
+      if errors_or_record.is_a? String
+        [parse_error_from_code(errors_or_record)]
+      elsif errors_or_record.is_a? Array
+        errors_or_record.map { |e| parse_error_from_code e }
+      else
+        parse_record_errors errors_or_record
+      end
+    end
+
+    # TOFIX: Dependencies
+    # translate_with_article
+    # bbl.field_label
+    # downcase_utf8
+    def parse_record_errors(record)
+      errors = []
+
+      record.errors.each do |e,b|
+        full_message = [I18n.translate_with_article('form.field'), record.bbl.field_label(e).downcase_utf8, b].join(' ')
+
+        errors << parse_error(localize.get_code_from_message(b), b, e, full_message)
+      end
+
+      return errors
+    end
+  end
+end

data/lib/errors-renderer/implants/active_model_errors.rb

@@ -0,0 +1,13 @@
+module ErrorsRenderer::Implants
+  module ActiveModelErrors
+    def add_from_code(attribute, code)
+      self.add attribute, ErrorsRenderer::Localizor.get_message_from_code(code)
+    end
+
+    def add_to_model(code)
+      self.add 'model_error', ErrorsRenderer::Localizor.get_message_from_code(code)
+    end
+  end
+end
+
+ActiveModel::Errors.send :include, ErrorsRenderer::Implants::ActiveModelErrors if defined? ActiveModel

data/lib/errors-renderer/implants/controller_actions.rb

@@ -0,0 +1,44 @@
+module ErrorsRenderer::Implants
+  module ControllerActions
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :response_errors
+    end
+
+    def render_errors(status, errors_or_record, options={})
+      options.reverse_merge! template: 'errors/response'
+
+      self.response.extend ResponseErrorAttribute
+
+      @response_errors = ErrorsRenderer::Errors.new(errors_or_record, controller: self.request[:controller], action: self.request[:action])
+      @response_error_codes = @response_errors.full_codes
+
+      self.response.error_codes = @response_error_codes
+      self.response.status = status
+      self.respond_to do |format|
+        format.html { self.render(template: 'errors/response') }
+        format.any(:json, :xml) { self.render(template: options[:template]) }
+      end
+    end
+
+    def response_errors?
+      @response_errors and not response_errors.empty?
+    end
+
+    def response_errors
+      @response_errors
+    end
+
+    def response_error_codes
+      @response_error_codes
+    end
+
+    module ResponseErrorAttribute
+      attr_accessor :error_codes
+    end
+
+    ::ActionController::Base.send :include, self
+  end
+
+end

data/lib/errors-renderer/implants/railtie.rb

@@ -0,0 +1,9 @@
+module ErrorsRenderer::Implants
+  class Railtie < Rails::Railtie
+    initializer "errors-renderer" do |app|
+      ActiveSupport.on_load :action_controller do
+        require 'errors-renderer/implants/controller_actions'
+      end
+    end
+  end
+end

data/lib/errors-renderer/implants.rb

@@ -0,0 +1,12 @@
+module ErrorsRenderer
+  module Implants
+  end
+end
+
+if defined? Rails::Railtie
+  require 'errors-renderer/implants/railtie'
+elsif defined? Rails::Initializer
+  raise "errors-renderer is not compatible with Rails 2.3 or older"
+end
+
+require 'errors-renderer/implants/active_model_errors'

data/lib/errors-renderer/localizor.rb

@@ -0,0 +1,11 @@
+module ErrorsRenderer
+  module Localizor
+    def self.get_message_from_code(code)
+      I18n.t('errors.messages')[code.to_sym]
+    end
+
+    def self.get_code_from_message(message)
+      I18n.t('errors.messages').invert[message]
+    end
+  end
+end

data/lib/errors-renderer.rb

@@ -0,0 +1,9 @@
+module ErrorsRenderer
+
+end
+
+require 'errors-renderer/errors'
+require 'errors-renderer/localizor'
+
+require 'errors-renderer/engine'
+require 'errors-renderer/implants'

data/spec/errors-renderer_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe ErrorsRenderer do
+
+  context 'with this particular fixture' do
+
+    describe "#method" do
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "rubygems"
+require "bundler/setup"
+
+require 'rspec'
+
+require File.expand_path('../../lib/errors-renderer', __FILE__)
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: errors-renderer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sebastien Rosa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: &2159489980 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+    none: false
+  prerelease: false
+  type: :development
+  name: rake
+  version_requirements: *2159489980
+- !ruby/object:Gem::Dependency
+  requirement: &2159489320 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    none: false
+  prerelease: false
+  type: :development
+  name: rspec
+  version_requirements: *2159489320
+description: ''
+email:
+- sebastien@demarque.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+files:
+- lib/errors-renderer/engine.rb
+- lib/errors-renderer/errors.rb
+- lib/errors-renderer/implants/active_model_errors.rb
+- lib/errors-renderer/implants/controller_actions.rb
+- lib/errors-renderer/implants/railtie.rb
+- lib/errors-renderer/implants.rb
+- lib/errors-renderer/localizor.rb
+- lib/errors-renderer.rb
+- spec/errors-renderer_spec.rb
+- spec/spec_helper.rb
+- LICENSE
+- README.md
+- Rakefile
+- Gemfile
+homepage: https://github.com/demarque/errors-renderer
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: errors-renderer
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []