bracket_error_suggestion 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c2319cd55595ca590ceb6c10f1e5e432ca226e4
+  data.tar.gz: ff5243ec7c1a84153ede895bb2e817c91974f300
+SHA512:
+  metadata.gz: 7fff9ee4d9a76f1a2af221287d7c779502299ea31ff349a7137ae52c83cf9ae497565e2fd5d4573674e8102032801bf87dec9dcbe516227a427bc8a6ac3d543a
+  data.tar.gz: 89d09804f199140ee7a332d48f391164c8fcde69fee273f3a9c554895ddabe95aa30be75b4570370e345bb0d620e77e88e2f5114763e1aaa2bdb59b0d7c7b12e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 akima
+
+MIT License
+
+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,44 @@
+# BracketErrorSuggestion
+
+```
+describe BracketErrorSuggestion do
+  it "suggests the place where invalid access happens" do
+    tree = {foo: { bar: [{baz: "foo"}] }  }
+
+    BracketErrorSuggestion.enable do
+      expect{ tree[:foo][:bar][:baz] }.to raise_error(TypeError,
+        "no implicit conversion of Symbol into Integer, it attempted to access " +
+        "<Hash>[:foo][:bar][:baz] but <Hash>[:foo][:bar] is an Array")
+
+      expect{ tree[:foo][:baz][:bar] }.to raise_error(NoMethodError,
+        "undefined method `[]' for nil:NilClass, maybe it attempted to access: " + 
+        "<Hash>[:foo][:baz][:bar] but <Hash>[:foo][:baz] is nil")
+    end
+  end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bracket_error_suggestion'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bracket_error_suggestion
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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. Create new Pull Request

data/Rakefile

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

data/bracket_error_suggestion.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bracket_error_suggestion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bracket_error_suggestion"
+  spec.version       = BracketErrorSuggestion::VERSION
+  spec.authors       = ["akima"]
+  spec.email         = ["akm2000@gmail.com"]
+  spec.description   = %q{suggests Hash or Array access on error with invalid key or index}
+  spec.summary       = %q{suggests Hash or Array access on error with invalid key or index}
+  spec.homepage      = "https://github.com/groovenauts/bracket_error_suggestion"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/bracket_error_suggestion.rb

@@ -0,0 +1,50 @@
+require "bracket_error_suggestion/version"
+
+module BracketErrorSuggestion
+
+  class << self
+
+    attr_reader :enabled
+    def enable
+      if block_given?
+        @enabled, backup = true, @enabled
+        begin
+          return yield
+        ensure
+          @enabled = backup
+          nil_parent_paths.clear unless @enabled
+        end
+      else
+        @enabled = true
+      end
+    end
+
+    def disable
+      if block_given?
+        @enabled, backup = false, @enabled
+        begin
+          return yield
+        ensure
+          @enabled = backup
+        end
+      else
+        @enabled = false
+        nil_parent_paths.clear
+      end
+    end
+
+    def nil_parent_paths
+      @nil_parent_paths ||= []
+    end
+
+  end
+end
+
+
+require "bracket_error_suggestion/nil_ext"
+require "bracket_error_suggestion/bracket_access"
+
+nil.extend(BracketErrorSuggestion::NilExt)
+
+Array.send(:include, BracketErrorSuggestion::BracketAccess)
+Hash.send(:include, BracketErrorSuggestion::BracketAccess)

data/lib/bracket_error_suggestion/bracket_access.rb

@@ -0,0 +1,43 @@
+require "bracket_error_suggestion"
+
+module BracketErrorSuggestion
+
+  module BracketAccess
+    class << self
+      def included(klass)
+        klass.module_eval do
+          alias_method :_get_without_be_suggestion, :[]
+          alias_method :[], :_get_with_be_suggestion
+        end
+      end
+    end
+
+    attr_accessor :path_on_be_suggestion
+
+    def _get_with_be_suggestion(name)
+      if BracketErrorSuggestion.enabled
+        begin
+          r = _get_without_be_suggestion(name)
+        rescue TypeError => e
+          raise TypeError, "#{e.message}, it attempted to access #{_actual_path_on_be_suggestion}[#{name.inspect}] but #{_actual_path_on_be_suggestion} is an Array"
+        end
+        return r unless BracketErrorSuggestion.enabled
+        case r
+        when nil then
+          BracketErrorSuggestion.nil_parent_paths << "#{_actual_path_on_be_suggestion}[#{name.inspect}]"
+        when Array, Hash then
+          r.path_on_be_suggestion ||= "#{_actual_path_on_be_suggestion}[#{name.inspect}]"
+        end
+        return r
+      else
+        return _get_without_be_suggestion(name)
+      end
+    end
+
+    def _actual_path_on_be_suggestion
+      path_on_be_suggestion || "<#{self.class.name}>"
+    end
+  end
+
+end
+

data/lib/bracket_error_suggestion/nil_ext.rb

@@ -0,0 +1,26 @@
+require "bracket_error_suggestion"
+
+module BracketErrorSuggestion
+
+  module NilExt
+    class << self
+      def extended(obj)
+        obj.instance_eval do
+          alias :method_missing_without_be_suggestion :method_missing
+          alias :method_missing :method_missing_with_be_suggestion
+        end
+      end
+    end
+
+    def method_missing_with_be_suggestion(name, *args, &block)
+      return method_missing_without_be_suggestion(name, *args, &block) unless BracketErrorSuggestion.enabled
+      case name
+      when :[] then
+        key = args.first
+        raise NoMethodError, "undefined method `[]' for nil:NilClass, maybe it attempted to access: " +
+          BracketErrorSuggestion.nil_parent_paths.reverse.map{|path| "#{path}[#{key.inspect}] but #{path} is nil"}.join(", ")
+      end
+      return method_missing_without_be_suggestion(name, *args, &block)
+    end
+  end
+end

data/lib/bracket_error_suggestion/version.rb

@@ -0,0 +1,3 @@
+module BracketErrorSuggestion
+  VERSION = "0.0.1"
+end

data/spec/bracket_error_suggestion_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe BracketErrorSuggestion do
+  it "suggests the place where invalid access happens" do
+    tree = {foo: { bar: [{baz: "foo"}] }  }
+
+    BracketErrorSuggestion.enable do
+      expect{ tree[:foo][:bar][:baz] }.to raise_error(TypeError, "no implicit conversion of Symbol into Integer, it attempted to access <Hash>[:foo][:bar][:baz] but <Hash>[:foo][:bar] is an Array")
+      expect{ tree[:foo][:baz][:bar] }.to raise_error(NoMethodError, "undefined method `[]' for nil:NilClass, maybe it attempted to access: <Hash>[:foo][:baz][:bar] but <Hash>[:foo][:baz] is nil")
+    end
+  end
+
+
+  it 'should have a version number' do
+    BracketErrorSuggestion::VERSION.should_not be_nil
+  end
+
+  let(:tree) do
+    {
+      foo1: {bar1: :baz1},
+      "foo2" => [{"bar1" => :baz1}, {"bar2" => :baz2}],
+    }
+  end
+
+  context :disabled do
+    before{ BracketErrorSuggestion.disable }
+
+    context Hash do
+      it{ tree[:foo1].should be_a(Hash) }
+      it{ tree[:foo1][:bar1].should == :baz1 }
+      it{ tree[:foo1][:bar2].should be_nil }
+      it "raises NoMethodError" do
+        expect{ tree[:foo1][:bar2][:baz2] }.to raise_error(NoMethodError, "undefined method `[]' for nil:NilClass")
+      end
+    end
+
+    context Array do
+      it{ tree["foo2"].should be_a(Array) }
+      it{ tree["foo2"][0].should == {"bar1" => :baz1} }
+      it{ tree["foo2"][99].should be_nil }
+      it "raises TypeError" do
+        expect{ tree["foo2"]["hoge"] }.to raise_error(TypeError, "no implicit conversion of String into Integer")
+      end
+    end
+  end
+
+  context :enabled do
+    before{ BracketErrorSuggestion.enable }
+    after{ BracketErrorSuggestion.disable }
+
+    context Hash do
+      it{ tree[:foo1].should be_a(Hash) }
+      it{ tree[:foo1][:bar1].should == :baz1 }
+      it{ tree[:foo1][:bar2].should be_nil }
+      it "raises NoMethodError" do
+        msg = "undefined method `[]' for nil:NilClass, maybe it attempted to access: <Hash>[:foo1][:bar2][:baz2] but <Hash>[:foo1][:bar2] is nil"
+        expect{ tree[:foo1][:bar2][:baz2] }.to raise_error(NoMethodError, msg)
+      end
+
+      it "show all suggestions" do
+        tree[:foo1][:bar3]
+        msg = "undefined method `[]' for nil:NilClass, maybe it attempted to access: " + [
+          "<Hash>[:foo1][:bar2][:baz2] but <Hash>[:foo1][:bar2] is nil",
+          "<Hash>[:foo1][:bar3][:baz2] but <Hash>[:foo1][:bar3] is nil"
+        ].join(", ")
+        expect{ tree[:foo1][:bar2][:baz2] }.to raise_error(NoMethodError, msg)
+      end
+    end
+
+    context Array do
+      it{ tree["foo2"].should be_a(Array) }
+      it{ tree["foo2"][0].should == {"bar1" => :baz1} }
+      it{ tree["foo2"][99].should be_nil }
+      it "raises TypeError" do
+        msg = "no implicit conversion of String into Integer, it attempted to access <Hash>[\"foo2\"][\"hoge\"] but <Hash>[\"foo2\"] is an Array"
+        expect{ tree["foo2"]["hoge"] }.to raise_error(TypeError, msg)
+      end
+    end
+  end
+
+
+  context :disable do
+
+    context Hash do
+      it "show all suggestions without access in disable block" do
+        BracketErrorSuggestion.enable do
+          tree[:foo1][:bar3]
+          BracketErrorSuggestion.disable do
+            tree[:foo1][:bar4]
+          end
+          msg = "undefined method `[]' for nil:NilClass, maybe it attempted to access: " + [
+            "<Hash>[:foo1][:bar2][:baz2] but <Hash>[:foo1][:bar2] is nil",
+            "<Hash>[:foo1][:bar3][:baz2] but <Hash>[:foo1][:bar3] is nil"
+          ].join(", ")
+          expect{ tree[:foo1][:bar2][:baz2] }.to raise_error(NoMethodError, msg)
+        end
+      end
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'bracket_error_suggestion'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: bracket_error_suggestion
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- akima
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: suggests Hash or Array access on error with invalid key or index
+email:
+- akm2000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bracket_error_suggestion.gemspec
+- lib/bracket_error_suggestion.rb
+- lib/bracket_error_suggestion/bracket_access.rb
+- lib/bracket_error_suggestion/nil_ext.rb
+- lib/bracket_error_suggestion/version.rb
+- spec/bracket_error_suggestion_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/groovenauts/bracket_error_suggestion
+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.0.3
+signing_key: 
+specification_version: 4
+summary: suggests Hash or Array access on error with invalid key or index
+test_files:
+- spec/bracket_error_suggestion_spec.rb
+- spec/spec_helper.rb
+has_rdoc: