nikkou 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Tom Benner
+
+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,78 @@
+Nikkou
+======
+description
+
+Description
+-----------
+
+Nikkou...
+
+### time
+
+Returns a Time object (in UTC) by automatically parsing the text or specified attribute of the node.
+
+```ruby
+# <a href="/p/1">3 hours ago</a>
+doc.search('a').first.time # 2013-04-16 02:42:34 UTC
+```
+
+###### Options
+
+`attribute` - The attribute to parse:
+
+```ruby
+# <a href="/p/1" data-published-at="2013-04-16 02:42:34">My link</a>
+doc.search('a').first.time(attribute: 'data-published-at') # 2013-04-16 02:42:34 UTC
+```
+
+`time_zone` - The document's time zone (the time will be converted from that to UTC):
+
+```ruby
+# <a href="/p/1">3 hours ago</a>
+doc.search('a').first.time(time_zone: 'America/New_York') # 2013-04-16 06:42:34 UTC
+```
+
+#### url
+
+Returns an absolute URL; useful for parsing relative hrefs. The document's `uri` needs to be set for Nikkou to know what domain to add to relative hrefs.
+
+```ruby
+# <a href="/p/1">My link</a>
+doc.uri = 'http://mysite.com/mypage'
+doc.search('a').first.url # http://mysite.com/p/1
+```
+
+###### Options
+
+`attribute` - The attribute to parse:
+
+```ruby
+# <a href="/p/1" data-comments-url="/p/1#comments">My Link</a>
+doc.uri = 'http://mysite.com/mypage'
+doc.search('a').first.url('data-comments-url') # http://mysite.com/p/1#comments
+```
+
+### attr_matches(attribute, pattern)
+
+Selects nodes with an attribute matching a pattern. The pattern's matches are stored in `Node#matches`.
+
+```ruby
+# <span data-tooltip="3 Comments">My Text</span>
+doc.search('span').attr_matches('data-tooltip', /(\d+) comments/i).first.text # My Text
+doc.search('span').attr_matches('data-tooltip', /(\d+) comments/i).first.matches # ["3 Comments", "3"]
+```
+
+### text_matches(attribute, pattern)
+
+Selects nodes with text matching a pattern. The pattern's matches are stored in `Node#matches`.
+
+```ruby
+# <a href="/p/1">3 Comments</a>
+doc.search('span').text_matches(/^(\d+) comments$/i).first.attr('href') # "/p/1"
+doc.search('span').text_matches(/^(\d+) comments$/i).first.matches # ["3 Comments", "3"]
+```
+
+License
+-------
+
+Nikkou is released under the MIT License. Please see the MIT-LICENSE file for details.

data/Rakefile

@@ -0,0 +1,28 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Nikkou'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/lib/nikkou.rb

@@ -0,0 +1,16 @@
+require 'nokogiri'
+require 'active_support/core_ext'
+require 'tzinfo'
+
+module Nikkou
+end
+
+directory = Pathname.new(File.dirname(File.absolute_path(__FILE__)))
+Dir.glob(directory.join('nikkou', '*.rb')) { |file| require file }
+Dir.glob(directory.join('nikkou', '**/*.rb')) { |file| require file }
+
+Nokogiri::XML::Document.send(:include, Nikkou::Nokogiri::XML::Document)
+Nokogiri::XML::Node.send(:include, Nikkou::Nokogiri::XML::Node)
+Nokogiri::XML::NodeSet.send(:include, Nikkou::Nokogiri::XML::NodeSet)
+
+Mechanize::Page.send(:include, Nikkou::Mechanize::Page) if defined?(Mechanize::Page)

data/lib/nikkou/drillable.rb

@@ -0,0 +1,16 @@
+module Nikkou
+  module Drillable
+    def drill(*methods)
+      value = self
+      methods.each do |method|
+        if method.is_a?(Array)
+          value = value.send(*method)
+        else
+          value = value.send(method)
+        end
+        return nil if value.blank?
+      end
+      value
+    end
+  end
+end

data/lib/nikkou/findable.rb

@@ -0,0 +1,7 @@
+module Nikkou
+  module Findable
+    def find(*paths)
+      search(*paths).first
+    end
+  end
+end

data/lib/nikkou/mechanize.rb

@@ -0,0 +1,4 @@
+module Nikkou
+  module Mechanize
+  end
+end

data/lib/nikkou/mechanize/page.rb

@@ -0,0 +1,15 @@
+module Nikkou
+  module Mechanize
+    module Page
+      def self.included(base)
+        base.send(:alias_method, :original_parser, :parser)
+      end
+
+      def parser
+        original_parser
+        @parser.uri = @uri
+        @parser
+      end
+    end
+  end
+end

data/lib/nikkou/nokogiri.rb

@@ -0,0 +1,4 @@
+module Nikkou
+  module Nokogiri
+  end
+end

data/lib/nikkou/nokogiri/xml.rb

@@ -0,0 +1,6 @@
+module Nikkou
+  module Nokogiri
+    module XML
+    end
+  end
+end

data/lib/nikkou/nokogiri/xml/document.rb

@@ -0,0 +1,14 @@
+module Nikkou
+  module Nokogiri
+    module XML
+      module Document
+        attr_accessor :uri
+
+        def uri=(uri)
+          uri = URI(uri) if uri.is_a?(String)
+          @uri = uri
+        end
+      end
+    end
+  end
+end

data/lib/nikkou/nokogiri/xml/node.rb

@@ -0,0 +1,39 @@
+module Nikkou
+  module Nokogiri
+    module XML
+      module Node
+        include Nikkou::Drillable
+        include Nikkou::Findable
+
+        attr_accessor :matches
+
+        def url(attribute='href')
+          return nil if attr(attribute).nil? || document.nil? || document.uri.nil?
+          href = attr(attribute)
+          return href if href =~ /^https?:\/\//
+          return "http:#{href}" if href.start_with?('//')
+          root_url = "#{document.uri.scheme}://#{document.uri.host}"
+          URI.join(root_url, href).to_s
+        end
+
+        def time(options={})
+          defaults = {
+            attribute: nil,
+            time_zone: 'UTC' # e.g. 'Eastern Time (US & Canada)'
+          }
+          options.reverse_merge!(defaults)
+          time_zone = TZInfo::Timezone.get(options[:time_zone])
+          string = options[:attribute] ? attr(options[:attribute]).to_s : text.to_s
+          if string =~ /(\d+)\s+(seconds?|minutes?|hours?|days?|weeks?|months?)\s+ago/i
+            number = $1.to_i
+            units = $2
+            time = (Time.now.utc - number.send(units))
+          else
+            time = Time.zone.parse(string)
+          end
+          time_zone.local_to_utc(time)
+        end
+      end
+    end
+  end
+end

data/lib/nikkou/nokogiri/xml/node_set.rb

@@ -0,0 +1,48 @@
+module Nikkou
+  module Nokogiri
+    module XML
+      module NodeSet
+        include Nikkou::Drillable
+        include Nikkou::Findable
+        
+        def attr_includes(attribute, string)
+          list = select do |node|
+            return false if node.attr(attribute).nil?
+            node.attr(attribute).include?(string)
+          end
+          self.class.new(document, list)
+        end
+        
+        def attr_matches(attribute, pattern)
+          list = []
+          each do |node|
+            next if node.attr(attribute).nil?
+            if node.attr(attribute).match(pattern)
+              node.matches = $~.to_a
+              list << node
+            end
+          end
+          self.class.new(document, list)
+        end
+        
+        def text_includes(string)
+          list = select do |node|
+            node.text.include?(string)
+          end
+          self.class.new(document, list)
+        end
+
+        def text_matches(pattern)
+          list = []
+          each do |node|
+            if node.text.match(pattern)
+              node.matches = $~.to_a
+              list << node
+            end
+          end
+          self.class.new(document, list)
+        end
+      end
+    end
+  end
+end

data/lib/nikkou/version.rb

@@ -0,0 +1,3 @@
+module Nikkou
+  VERSION = "0.0.2"
+end

data/spec/drillable_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Nikkou::Drillable do
+  before do
+    assets_directory = File.expand_path(File.join(File.dirname(__FILE__), 'files'))
+    html_file = File.join(assets_directory, 'test.html')
+    @html = Nokogiri::HTML.parse(File.read(html_file))
+  end
+
+  describe Nokogiri::XML::Document do
+    it 'returns nil' do
+      nodes = @html.drill([:search, '.post'], :first, [:search, '.post-non-existent'])
+      nodes.should be_nil
+    end
+
+    it 'returns non-nil' do
+      nodes = @html.drill([:search, '.post'], :first, [:search, '.post-footer'])
+      nodes.should == @html.search('.post').first.search('.post-footer')
+    end
+  end
+
+  describe Nokogiri::XML::Node do
+    it 'returns nil' do
+      nodes = @html.search('body').first.drill([:search, '.post'], :first, [:search, '.post-non-existent'])
+      nodes.should be_nil
+    end
+
+    it 'returns non-nil' do
+      nodes = @html.search('body').first.drill([:search, '.post'], :first, [:search, '.post-footer'])
+      nodes.should == @html.search('.post').first.search('.post-footer')
+    end
+  end
+
+  describe Nokogiri::XML::NodeSet do
+    it 'returns nil' do
+      nodes = @html.search('body').drill([:search, '.post'], :first, [:search, '.post-non-existent'])
+      nodes.should be_nil
+    end
+
+    it 'returns non-nil' do
+      nodes = @html.search('body').drill([:search, '.post'], :first, [:search, '.post-footer'])
+      nodes.should == @html.search('.post').first.search('.post-footer')
+    end
+  end
+end

data/spec/files/test.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <title>Test</title>
+  </head>
+
+  <body>
+    <div class="post">
+      <h3><a class="relative-url" href="/p/1">Post 1</a></h3>
+      <div class="post-body">
+        <a class="absolute-url" href="http://www.absoluteurl.com/">Lorem</a> <a class="external-url" href="http://www.ipsum.com/">ipsum</a> dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+      </div>
+      <div class="post-footer">
+        <ul>
+          <li><a class="post-comments" href="/p/1#comments">12 comments</a></li>
+          <li><a class="post-published-at" href="/p/1" data-published-at="2013-04-01 00:00:00">3 hours ago</a></li>
+        </ul>
+      </div>
+    </div>
+  </body>
+</html>

data/spec/findable_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Nikkou::Findable do
+  before do
+    assets_directory = File.expand_path(File.join(File.dirname(__FILE__), 'files'))
+    html_file = File.join(assets_directory, 'test.html')
+    @html = Nokogiri::HTML.parse(File.read(html_file))
+  end
+
+  describe Nokogiri::XML::Document do
+    it 'returns nil' do
+      node = @html.find('.post .post-non-existent')
+      node.should be_nil
+    end
+
+    it 'returns non-nil' do
+      node = @html.find('.post .post-footer')
+      node.should == @html.search('.post .post-footer').first
+    end
+  end
+
+  describe Nokogiri::XML::Node do
+    it 'returns nil' do
+      node = @html.search('body').first.find('.post .post-non-existent')
+      node.should be_nil
+    end
+
+    it 'returns non-nil' do
+      node = @html.search('body').first.find('.post .post-footer')
+      node.should == @html.search('.post .post-footer').first
+    end
+  end
+
+  describe Nokogiri::XML::NodeSet do
+    it 'returns nil' do
+      node = @html.search('body').find('.post .post-non-existent')
+      node.should be_nil
+    end
+
+    it 'returns non-nil' do
+      node = @html.search('body').find('.post .post-footer')
+      node.should == @html.search('.post .post-footer').first
+    end
+  end
+end

data/spec/node_set_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Nokogiri::XML::NodeSet do
+  before do
+    assets_directory = File.expand_path(File.join(File.dirname(__FILE__), 'files'))
+    html_file = File.join(assets_directory, 'test.html')
+    @html = Nokogiri::HTML.parse(File.read(html_file))
+  end
+
+  describe '.attr_includes' do
+    it 'finds nodes' do
+      nodes = @html.search('a').attr_includes('href', 'ipsum.com')
+      nodes.first.text.should == 'ipsum'
+    end
+  end
+
+  describe '.attr_matches' do
+    it 'finds nodes' do
+      nodes = @html.search('a').attr_matches('href', /(lorem|ipsum)\.com/)
+      nodes.first.text.should == 'ipsum'
+    end
+
+    it 'sets matches' do
+      nodes = @html.search('a').attr_matches('href', /(lorem|ipsum)\.com/)
+      nodes.first.matches.should == ['ipsum.com', 'ipsum']
+    end
+  end
+
+  describe '.text_matches' do
+    it 'finds nodes' do
+      nodes = @html.search('a').text_matches(/(\d+) comments/)
+      nodes.first.text.should == '12 comments'
+    end
+
+    it 'sets matches' do
+      nodes = @html.search('a').text_matches(/(\d+) comments/)
+      nodes.first.matches.should == ['12 comments', '12']
+    end
+  end
+
+  describe '.text_includes' do
+    it 'finds nodes' do
+      nodes = @html.search('a').text_includes('ipsum')
+      nodes.first.text.should == 'ipsum'
+    end
+  end
+end

data/spec/node_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Nokogiri::XML::Node do
+  before do
+    assets_directory = File.expand_path(File.join(File.dirname(__FILE__), 'files'))
+    html_file = File.join(assets_directory, 'test.html')
+    @html = Nokogiri::HTML.parse(File.read(html_file))
+    @html.uri = 'http://www.loremipsum.com/page/2'
+  end
+
+  describe '.url' do
+    it 'reads absolute URLs' do
+      @html.search('a.absolute-url').first.url.should == 'http://www.absoluteurl.com/'
+    end
+
+    it 'reads relative URLs' do
+      @html.search('a.relative-url').first.url.should == 'http://www.loremipsum.com/p/1'
+    end
+  end
+
+  describe '.time' do
+    it 'reads relative time' do
+      @html.search('.post-published-at').first.time.to_i.should == (Time.now.utc - 3.hours).to_i
+    end
+
+    it 'reads attributes' do
+      @html.search('.post-published-at').first.time(attribute: 'data-published-at').to_s.should == '2013-04-01 00:00:00 UTC'
+    end
+
+    it 'converts time zones' do
+      @html.search('.post-published-at').first.time(attribute: 'data-published-at', time_zone: 'America/New_York').to_s.should == '2013-04-01 04:00:00 UTC'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+ENV["RAILS_ENV"] ||= 'test'
+
+require 'rspec'
+require 'nikkou'
+require 'pry'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+  config.formatter = 'documentation'
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: nikkou
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Tom Benner
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Utilities for Nokogiri
+email:
+- tombenner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/nikkou/drillable.rb
+- lib/nikkou/findable.rb
+- lib/nikkou/mechanize/page.rb
+- lib/nikkou/mechanize.rb
+- lib/nikkou/nokogiri/xml/document.rb
+- lib/nikkou/nokogiri/xml/node.rb
+- lib/nikkou/nokogiri/xml/node_set.rb
+- lib/nikkou/nokogiri/xml.rb
+- lib/nikkou/nokogiri.rb
+- lib/nikkou/version.rb
+- lib/nikkou.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+- spec/drillable_spec.rb
+- spec/files/test.html
+- spec/findable_spec.rb
+- spec/node_set_spec.rb
+- spec/node_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/tombenner/nikkou
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Utilities for Nokogiri
+test_files:
+- spec/drillable_spec.rb
+- spec/files/test.html
+- spec/findable_spec.rb
+- spec/node_set_spec.rb
+- spec/node_spec.rb
+- spec/spec_helper.rb