nokogiri_bang_finders 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3584b7abe3e4df0f0b85120296766ec7e1a24438
-  data.tar.gz: 9b0b553216740fc6f311a283afa9fbc338423eb8
+  metadata.gz: 38f3b45d9436abb86e0308f5eb9edf95baf0fdbc
+  data.tar.gz: b84eb8c29d48d8546ddd84bde32ee78901b09095
 SHA512:
-  metadata.gz: 268af5bb0f08d50f6daa4d1f78b4af6d51fabf5ea45856d28bf47d8fb36da7e2773a7b54b4cdf881e2164a9d1091b35ea56242d0ef4d45ee36e0d261bcc0706a
-  data.tar.gz: 41a375c7da3916b7f77a21536d8d38fce36ee54c8ff4ade166c8aea6b334b2eaa7db91686841add7e2d2875f5c1059e420e8c938cc5e51fa728731f7a9db3496
+  metadata.gz: 716b0b308507f3598b3cc50ec9a25e680258448f43131922bc8b55c0b759c83749ac6ad270a69c27a4b2eb1552a9675baf25c0c2a2d888c977241ed01fc3bd43
+  data.tar.gz: 7ecb8574b7322a8dc6e77f8fa334abd5c1062ad0b2bb92047bde36ca1df3706d8f126f77131a7126a085eea6d31475e824a6e072802ea8834068159df0d178f1

data/CHANGELOG.md

@@ -4,7 +4,13 @@ All notable changes to this project will be documented in this file. Version num
 
 ## Unreleased
 
-Nothing
+None
+
+## 1.1.0 - 2015-03-19
+
+### Added
+
+Allow user to specify an integer number of characters of context to be given with exceptions, or to request `:all` context, using `Nokogiri::XML::BangFinders.context_length = some_value`
 
 ## 1.0.0 - 2014-08-14
 

data/README.md

@@ -25,6 +25,14 @@ Each method just calls its non-bang namesake and, if the result is `nil`, raises
 
 This gem is so tiny, you could just copy and paste its code. But if it's convenient, use it. :smile:
 
+## Context
+
+ When an exception is raised, its message includes some context from the document, to show "I was looking for your selector in a document that looks like this". By default, up to 200 characters of context are given.
+
+You can specify an integer number of characters of context, like `Nokogiri::XML::BangFinders.context_length = 500`.
+
+Or you can specify `:all` to get the whole document in the exception message (though this probably isn't a good idea for production code): `Nokogiri::XML::BangFinders.context_length = :all`
+
 ## Installation
 
     $ gem install nokogiri_bang_finders

data/Rakefile

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

data/lib/nokogiri_bang_finders.rb

@@ -3,6 +3,19 @@ require "nokogiri_bang_finders/version"
 module Nokogiri
   module XML
     module BangFinders
+
+      def self.context_length
+        @context_length ||= 200
+      end
+
+      def self.context_length=(val)
+        @context_length = if val.to_s == "all"
+                            Float::INFINITY
+                          else
+                            val.to_i
+                          end
+      end
+
       def at!(*args)
         node = at(*args);       raise NotFound.new(args, self) if node.nil?; node
       end
@@ -20,11 +33,15 @@ module Nokogiri
     class NotFound < StandardError
       attr_reader :message
       def initialize(needle, haystack)
-        @message = "#{needle} in \n#{snippet(haystack)}"
+        @message = "#{needle} in \n#{snippet(haystack)}\n"
       end
       def snippet(haystack)
         snippet = haystack.to_s
-        snippet.length > 200 ? "#{snippet[0...200]}..." : snippet
+        snippet.length <= context_length ? snippet : "#{snippet[0..(context_length - 1)]}...\n"
+      end
+
+      def context_length
+        Nokogiri::XML::BangFinders.context_length
       end
     end
   end

data/lib/nokogiri_bang_finders/version.rb

@@ -1,3 +1,3 @@
 module NokogiriBangFinders
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/nokogiri_bang_finders.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "nokogiri", ">= 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.5"
-  spec.add_development_dependency "rspec", '~> 2.14.1'
+  spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "rake"
 end

data/spec/nokogiri_bang_finders_spec.rb

@@ -25,7 +25,9 @@ describe Nokogiri::XML::BangFinders do
     describe "when #at returns nil" do
 
       it "raises an exception describing the failed search" do
-        expect{xml_doc.at!('robots')}.to raise_error(Nokogiri::XML::NotFound, /robots/)
+        e = exception_from { xml_doc.at!("robots") }
+        expect(e).to be_a(Nokogiri::XML::NotFound)
+        expect(e.message).to match(/robots/)
       end
 
     end
@@ -50,7 +52,9 @@ describe Nokogiri::XML::BangFinders do
     describe "when #at_css returns nil" do
 
       it "raises an exception describing the failed search" do
-        expect{xml_doc.at_css!('robots')}.to raise_error(Nokogiri::XML::NotFound, /robots/)
+        e = exception_from { xml_doc.at_css!("robots") }
+        expect(e).to be_a(Nokogiri::XML::NotFound)
+        expect(e.message).to match(/robots/)
       end
 
     end
@@ -75,7 +79,70 @@ describe Nokogiri::XML::BangFinders do
     describe "when #at_xpath returns nil" do
 
       it "raises an exception describing the failed search" do
-        expect{xml_doc.at_xpath!('//robots')}.to raise_error(Nokogiri::XML::NotFound, /\/\/robots/)
+        e = exception_from { xml_doc.at_xpath!("//robots") }
+        expect(e).to be_a(Nokogiri::XML::NotFound)
+        expect(e.message).to match(/\/\/robots/)
+      end
+
+    end
+
+  end
+
+  describe "providing context with an exception" do
+
+    let(:xml_doc) {
+      body = "<root><numbers>"
+      1_000.times do |i|
+        body << "<number>#{i}</number>"
+      end
+      body << "</numbers></root>"
+      Nokogiri::XML(body)
+    }
+
+    it "does not include the whole document" do
+      e = exception_from { xml_doc.at_css!("robots") }
+      expect(e.message).not_to include(xml_doc.to_s)
+    end
+
+
+    it "includes the first 200 characters of the document by default" do
+      e = exception_from { xml_doc.at_css!("robots") }
+      expect(e.message    ).to include(xml_doc.to_s[0..199])
+      expect(e.message).not_to include(xml_doc.to_s[0..200])
+    end
+
+    describe "specifying how much document context to supply with errors" do
+
+      before :each do
+        @original_setting = Nokogiri::XML::BangFinders.context_length
+        Nokogiri::XML::BangFinders.context_length = specified_context
+      end
+
+      after :each do
+        Nokogiri::XML::BangFinders.context_length = @original_setting
+      end
+
+      describe "when context_length is given as a number" do
+
+        let(:specified_context) { 10 }
+
+        it "includes the specified number of characters of context" do
+          e = exception_from { xml_doc.at_css!("robots") }
+          expect(e.message    ).to include(xml_doc.to_s[0..9])
+          expect(e.message).not_to include(xml_doc.to_s[0..10])
+        end
+
+      end
+
+      describe "when context is given as 'all'" do
+
+        let(:specified_context) { :all }
+
+        it "includes the entire document" do
+          e = exception_from { xml_doc.at_css!("robots") }
+          expect(e.message    ).to include(xml_doc.to_s)
+        end
+
       end
 
     end

data/spec/spec_helper.rb

@@ -3,7 +3,6 @@ require 'nokogiri_bang_finders'
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 
@@ -13,3 +12,12 @@ RSpec.configure do |config|
   #     --seed 1234
   config.order = 'random'
 end
+
+def exception_from
+  begin
+    yield
+  rescue => e
+    return e
+  end
+  fail "Tried to get the exception from the block given, but it didn't raise one"
+end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: nokogiri_bang_finders
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Nathan Long
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-14 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.2'
 - !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'
 description: Adds XML finders to Nokogiri that raise if nothing is found.
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -95,17 +95,17 @@ 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.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Adds XML finders to Nokogiri that raise if nothing is found.