scraping 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b9aff8bf11dbde49763faa84c830518cb308daab
+  data.tar.gz: ba701a4490c085c2278ff93efbdeb244a9b74b12
+SHA512:
+  metadata.gz: b6bc072d8df959e32b8cd5230db684ebffdb08d23ce3a2633a683042eed6f92a5f0c8e61b4c35ecd570975461d417a93f6941b1688d328eafb76cf958f247627
+  data.tar.gz: 0149081ebc7cd6073e2a178f10c1904e46a3e3cab8e2fa9f35fc82387b1a7938d4f48428a9eb58d1adc835680c5dc0248b76bd562fb7b1e8288cc24efca46154

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ray Zane
+
+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,114 @@
+# Scraping
+
+A really simple HTML scraping DSL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'scraping'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+#### A simple example
+
+```ruby
+class Person
+  include Scraping
+  element :name, 'h1'
+end
+
+person = Person.scrape('<h1>Millard Fillmore</h1>')
+person.name #=> 'Millard Fillmore'
+```
+
+#### More complex data structures
+
+You can also scrape arrays, objects, and arrays of objects. `elements` and `elements_of` can be deeply nested.
+
+```ruby
+class YouCan
+  include Scraping
+  elements :scrape, '.scrape'
+
+  elements :also_scrape, '.also-scrape li' do
+    element :name, 'a'
+    element :link, 'a/@href'
+    elements :numbers, 'span'
+  end
+
+  elements_of :nested_scrape do
+    element :data, '.data'
+  end
+end
+
+you_can = YouCan.scrape(<<-EOF)
+  <p class="scrape">
+    <span>Arrays</span>
+    <span>Too</span>
+  </p>
+
+  <ul class="also-scrape">
+    <li>
+      <a href="example.com">Meek Mill</a>
+      <span>1</span>
+      <span>2</span>
+    </li>
+    <li><a href="test.com">Drake</a></li>
+  <ul>
+
+  <p class="data">Beef</p>
+EOF
+
+you_can.scrape #=> ['Arrays', 'Too']
+
+you_can.also_scrape.first.name #=> 'Meek Mill'
+you_can.also_scrape.first.link #=> 'example.com'
+you_can.also_scrape.first.numbers #=> ['1', '2']
+
+you_can.nested_scrape.data #=> 'Beef'
+```
+
+#### Customizing extraction
+
+Any block given to `#element` will allow you to customize the value extracted from the found node.
+
+Using `as: :something` would call a method named `#extract_something`.
+
+```ruby
+class Advanced
+  element :first_name, '.name' do |node|
+    node.text.split(', ').first
+  end
+
+  element :birthday, '.birthday', as: :date
+
+  private
+
+  def extract_date(node)
+    Date.parse(node.text)
+  end
+end
+
+advanced = Advanced.new(<<-EOF)
+  <h1 class="name">Millard Fillmore</h1>
+  <h2 class="birthday">7-1-1800</h2>
+EOF
+
+advanced.first_name #=> 'Millard'
+advanced.birthday #=> #<Date: 1800-01-07>
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/scraping.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/scraping.rb

@@ -0,0 +1,55 @@
+require 'nokogiri'
+require 'scraping/version'
+require 'scraping/dsl'
+require 'scraping/rules/element'
+require 'scraping/rules/elements_of'
+require 'scraping/rules/elements'
+
+module Scraping
+  def self.included(base)
+    base.extend ClassMethods
+
+    base.class_eval do
+      attr_reader :page
+    end
+  end
+
+  def initialize(page)
+    @page = page
+  end
+
+  def scrape
+    self.class.rules.each do |name, rule|
+      public_send("#{name}=", rule.call(self, page))
+    end
+  end
+
+  module ClassMethods
+    include DSL
+
+    # Make the rules inheritable, but prevent mutation
+    # of the original hash
+    def inherited(subclass)
+      subclass.instance_variable_set(:@rules, rules.clone)
+    end
+
+    def element(name, *)
+      attr_accessor name
+      super
+    end
+
+    def elements_of(name)
+      attr_accessor name
+      super
+    end
+
+    def elements(name, *)
+      attr_accessor name
+      super
+    end
+
+    def scrape(html)
+      new(Nokogiri::HTML(html)).tap(&:scrape)
+    end
+  end
+end

data/lib/scraping/dsl.rb

@@ -0,0 +1,19 @@
+module Scraping
+  module DSL
+    def rules
+      @rules ||= {}
+    end
+
+    def element(name, selector, options = {}, &block)
+      rules[name] = Rules::Element.new(name, selector, options, &block)
+    end
+
+    def elements_of(name, &block)
+      rules[name] = Rules::ElementsOf.new(name).evaluate(&block)
+    end
+
+    def elements(name, selector, options = {}, &block)
+      rules[name] = Rules::Elements.new(name, selector, options).evaluate(&block)
+    end
+  end
+end

data/lib/scraping/rules/element.rb

@@ -0,0 +1,26 @@
+module Scraping
+  module Rules
+    class Element
+      attr_reader :name, :selector, :options, :extract
+
+      def initialize(name, selector, options = {}, &extract)
+        @name = name
+        @selector = selector
+        @options = options
+        @extract = extract if block_given?
+      end
+
+      def call(scraper, node)
+        item = node.at(selector)
+
+        if item && options[:as]
+          scraper.send("extract_#{options[:as]}", item)
+        elsif item && extract
+          scraper.instance_exec(item, &extract)
+        elsif item
+          item.text
+        end
+      end
+    end
+  end
+end

data/lib/scraping/rules/elements.rb

@@ -0,0 +1,29 @@
+module Scraping
+  module Rules
+    class Elements
+      attr_reader :name, :selector, :rule, :options
+
+      def initialize(name, selector, options = {})
+        @name = name
+        @selector = selector
+        @options = options
+      end
+
+      def evaluate(&block)
+        if block_given?
+          @rule = ElementsOf.new(name).evaluate(&block)
+        else
+          @rule = Element.new(name, '.', options)
+        end
+
+        self
+      end
+
+      def call(scraper, node)
+        node.search(selector).map do |item|
+          rule.call(scraper, item)
+        end
+      end
+    end
+  end
+end

data/lib/scraping/rules/elements_of.rb

@@ -0,0 +1,26 @@
+require 'ostruct'
+
+module Scraping
+  module Rules
+    class ElementsOf
+      include DSL
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+
+      def evaluate(&block)
+        instance_eval(&block)
+        self
+      end
+
+      def call(scraper, node)
+        rules.inject(OpenStruct.new) do |obj, (name, rule)|
+          obj[name] = rule.call(scraper, node)
+          obj
+        end
+      end
+    end
+  end
+end

data/lib/scraping/version.rb

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

data/scraping.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'scraping/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "scraping"
+  spec.version       = Scraping::VERSION
+  spec.authors       = ["Ray Zane"]
+  spec.email         = ["ray@promptworks.com"]
+
+  spec.summary       = %q{A DSL for scraping HTML into objects}
+  spec.description   = %q{A DSL for scraping HTML into objects}
+  spec.homepage      = "https://github.com/rzane/scraping"
+  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_dependency 'nokogiri'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: scraping
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ray Zane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A DSL for scraping HTML into objects
+email:
+- ray@promptworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/scraping.rb
+- lib/scraping/dsl.rb
+- lib/scraping/rules/element.rb
+- lib/scraping/rules/elements.rb
+- lib/scraping/rules/elements_of.rb
+- lib/scraping/version.rb
+- scraping.gemspec
+homepage: https://github.com/rzane/scraping
+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.8
+signing_key: 
+specification_version: 4
+summary: A DSL for scraping HTML into objects
+test_files: []