practical_errors 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1de337bcc6877c1cb9de094109359c9a96cd8fe2
+  data.tar.gz: bd7048b4efbeaa3bb4fe16437ef182535e37e699
+SHA512:
+  metadata.gz: a22e290946b7f849abdecedf204e388e979cc9ee700f3a55272b5123558be1e9e2229b40eae3c7fbb0b21fe5ff6dcdf35aa33e5362adcc7213f45f52d7b6e869
+  data.tar.gz: a8aee17c92cdf2ac5c7c58b59b0e9597333869ac5940de8cf8b5f29918d9e62a8ea35e8849b532c42782301f12f41606701fe0c3473deaee36ad9663166831b3

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at nserihiro@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kazuhiro Serizawa
+
+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,83 @@
+# PracticalErrors
+
+Make rails error messages more practical.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'practical_errors'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install practical_errors
+
+## Usage
+
+Add `include PracticalErrors::Practicable` to your controller.
+
+```ruby
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+  
+  include PracticalErrors::Practicable
+end
+```
+
+And then, error message will be like this:
+
+```
+ActiveRecord::RecordNotFound (
+========== Practical Errors appends message from here ==========
+
+Rails says, "Couldn't find Post with 'id'=1000".
+
+You might have called ActiveRecord::FinderMethods#find, but the record for provided id was not found.
+If you DO NOT want to raise ActiveRecord::RecordNotFound even if the record was not found,
+you should use ActiveRecord::FinderMethods#find_by instead.
+
+Post.find(1000) # raise ActiveRecord::RecordNotFound
+Post.find_by(id: 1000) # just returns nill
+
+
+========== Practical Errors appends message to here ==========
+See more detail about Practical Errors: https://github.com/serihiro/practical_errors
+
+):
+```
+
+
+### Supported error list
+- `ActiveRecord::RecordNotFound`
+- `ActiveRecord::RecordNotUnique`
+
+Do you think that there is little error that support?
+Please add !! (I will continue to increase supported errors, of course.)
+
+## Dependency
+- Rails '>= 4.0.0', '< 5.0'
+- [error_arranger](https://github.com/serihiro/error_arranger) '0.1.0'
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/practical_errors. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "practical_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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/practical_errors.rb

@@ -0,0 +1,9 @@
+require 'practical_errors/version'
+require 'practical_errors/practicable'
+require 'practical_errors/error_advisers/loader'
+require 'error_arranger'
+
+module PracticalErrors
+  module ErrorAdvisers
+  end
+end

data/lib/practical_errors/error_advisers/active_record/loader.rb

@@ -0,0 +1,9 @@
+module PracticalErrors
+  module ErrorAdvisers
+    module ActiveRecord
+      %w(record_not_found record_not_unique).each do |file|
+        require File.join(File.expand_path('../', __FILE__), file)
+      end
+    end
+  end
+end

data/lib/practical_errors/error_advisers/active_record/record_not_found.rb

@@ -0,0 +1,21 @@
+module PracticalErrors
+  module ErrorAdvisers
+    module ActiveRecord
+      class RecordNotFound
+        def self.advise(exception)
+          values = %r{\ACouldn't find (.*?) with '(.*?)'=(.*)\Z}.match(exception.message)
+
+          <<-"EOS".strip_heredoc
+            You might have called ActiveRecord::FinderMethods#find, but the record for provided id was not found.
+            If you DO NOT want to raise ActiveRecord::RecordNotFound even if the record was not found,
+            you should use ActiveRecord::FinderMethods#find_by instead.
+
+            #{values[1]}.find(#{values[3]}) # raise ActiveRecord::RecordNotFound
+            #{values[1]}.find_by(#{values[2]}: #{values[3]}) # just returns nill
+
+          EOS
+        end
+      end
+    end
+  end
+end

data/lib/practical_errors/error_advisers/active_record/record_not_unique.rb

@@ -0,0 +1,20 @@
+module PracticalErrors
+  module ErrorAdvisers
+    module ActiveRecord
+      class RecordNotUnique
+        def self.advise(exception)
+          <<-EOS.strip_heredoc
+            The column included in the record that you were about to insert or update, is not allowed duplicated value.
+            This error was detected by database, not Rails.
+
+            You might have configured uniqueness validation to this column, but uniqueness validation is not panacea.
+            In race condition, uniqueness validation was passed easily.
+
+            For more detail, see rails document
+            http://api.rubyonrails.org/classes/ActiveRecord/Validations/ClassMethods.html#method-i-validates_uniqueness_of
+          EOS
+        end
+      end
+    end
+  end
+end

data/lib/practical_errors/error_advisers/loader.rb

@@ -0,0 +1,5 @@
+module PracticalErrors
+  module ErrorAdvisers
+    require File.join(File.expand_path('../',__FILE__), 'active_record/loader')
+  end
+end

data/lib/practical_errors/practicable.rb

@@ -0,0 +1,53 @@
+# error list
+# https://github.com/rails/rails/blob/4-2-stable/activerecord/lib/active_record/errors.rb
+module PracticalErrors
+  module Practicable
+    def arrange_exception!(exception)
+      @customised_message = ''
+
+      append_header
+
+      abstract_original_message(exception)
+
+      if PracticalErrors::ErrorAdvisers::const_defined?(exception.class.to_s)
+        @customised_message << PracticalErrors::ErrorAdvisers::const_get(exception.class.to_s).advise(exception)
+      else
+        @customised_message << <<-"EOS".strip_heredoc
+          hmm... I don't know this error :(
+          Tell me => https://github.com/serihiro/practical_errors
+        EOS
+      end
+
+      append_footer
+
+      exception.message.gsub!(/.+/, @customised_message)
+    end
+
+    private
+
+    def append_header
+      @customised_message << <<-EOS.strip_heredoc
+
+        ========== Practical Errors appends message from here ==========
+      EOS
+    end
+
+    def append_footer
+      @customised_message << <<-EOS.strip_heredoc
+
+        ========== Practical Errors appends message to here ==========
+        See more detail about Practical Errors: https://github.com/serihiro/practical_errors
+
+      EOS
+    end
+
+    def abstract_original_message(exception)
+      original_message = exception.message
+      @customised_message << <<-"EOS".strip_heredoc
+
+          Rails says, "#{original_message}".
+
+      EOS
+    end
+  end
+end

data/lib/practical_errors/version.rb

@@ -0,0 +1,3 @@
+module PracticalErrors
+  VERSION = "0.1.0"
+end

data/practical_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 'practical_errors/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'practical_errors'
+  spec.version       = PracticalErrors::VERSION
+  spec.authors       = ['Kazuhiro Serizawa']
+  spec.email         = ['nserihiro@gmail.com']
+
+  spec.summary       = 'Make rails error messages more practical.'
+  spec.description   = 'Make rails error messages more practical.'
+  spec.homepage      = 'https://github.com/serihiro/practical_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_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'activesupport', '>= 4.0', '<5.0'
+  spec.add_runtime_dependency 'error_arranger', '~> 0.1'
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: practical_errors
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kazuhiro Serizawa
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: error_arranger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Make rails error messages more practical.
+email:
+- nserihiro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/practical_errors.rb
+- lib/practical_errors/error_advisers/active_record/loader.rb
+- lib/practical_errors/error_advisers/active_record/record_not_found.rb
+- lib/practical_errors/error_advisers/active_record/record_not_unique.rb
+- lib/practical_errors/error_advisers/loader.rb
+- lib/practical_errors/practicable.rb
+- lib/practical_errors/version.rb
+- practical_errors.gemspec
+homepage: https://github.com/serihiro/practical_errors
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Make rails error messages more practical.
+test_files: []