site_prism-tableish 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12cb15dcd0d2e446159065bb71a03805dd2aebd5
-  data.tar.gz: 032df734cda2d10352f30068532d3da8c9c0d253
+  metadata.gz: 43956014fa7ce3841366f6ca476c2a2307d53305
+  data.tar.gz: 5a8b7bedc3684cb5ec3e0b5ca14eb2c316f3002e
 SHA512:
-  metadata.gz: 4aa7b52a7bd79e320a2958f9681e7cb72fa0c13f39d3287abb1d1832f125c16fa83c304e692d789b3094d4423f576bde346d6598919279dec81d1e8870c9e14d
-  data.tar.gz: 2bf80c338acae34f809f7668dd41edce678d167498fc6915c6cd7f828d8febd3dae811005432294e412d6207b25aa9eebad4bedfbda0aca1f946994fca51a773
+  metadata.gz: 83c8b02cf5d011938f6bf53f874af550c9e04cbeae4d894d9b4f2bf1bc2eb1a97fc09ac5441c2567f2083cb53d0bfedbb73e1773bbfacef26fd34c36135d43f6
+  data.tar.gz: d7f09ddc9899f7357627670e76cc76042b7cd9844480b2e13f85b1830d8ba54c5ecbfa743802bd4f6412a3c8810f165641d48bbebe6be234e13bfa92921c0824

data/README.md

@@ -1,8 +1,9 @@
 # SitePrism::Tableish
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/site_prism/tableish`. To experiment with that code, run `bin/console` for an interactive prompt.
+SitePrism::Tableish extends [SitePrism](https://github.com/natritmeyer/site_prism)
+making it easer and faster to parse `<table>` elements.
 
-TODO: Delete this and the text above, and describe your gem
+Inspied by [SitePrism::Table](https://github.com/investtools/site_prism-table)
 
 ## Installation
 
@@ -22,7 +23,85 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Example:
+
+```ruby
+require 'site_prism'
+require 'capybara/dsl'
+require 'site_prism/tableish'
+require 'selenium-webdriver'
+require 'pp'
+
+Capybara.default_driver = :selenium
+
+class W3SchoolsTablesPage < SitePrism::Page
+  extend SitePrism::Tableish
+  set_url 'http://www.w3schools.com/html/html_tables.asp'
+  table :customers, '#customers' do
+    column :company
+    column :contact
+    column :country
+  end
+end
+
+page = W3SchoolsTablesPage.new
+page.load
+pp page.customers.rows
+
+# [{:company=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[2]/td[1]">,
+#   :contact=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[2]/td[2]">,
+#   :country=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[2]/td[3]">},
+#  {:company=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[3]/td[1]">,
+#   :contact=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[3]/td[2]">,
+#   :country=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[3]/td[3]">},
+#  {:company=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[4]/td[1]">,
+#   :contact=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[4]/td[2]">,
+#   :country=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[4]/td[3]">},
+#  {:company=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[5]/td[1]">,
+#   :contact=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[5]/td[2]">,
+#   :country=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[5]/td[3]">},
+#  {:company=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[6]/td[1]">,
+#   :contact=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[6]/td[2]">,
+#   :country=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[6]/td[3]">},
+#  {:company=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[7]/td[1]">,
+#   :contact=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[7]/td[2]">,
+#   :country=>
+#    #<Capybara::Node::Element tag="td" path="/html/body/div[6]/div[1]/div[1]/div[3]/div/table/tbody/tr[7]/td[3]">}]
+
+pp page.customers.rows.map{|row| row.map{|k, v| [k, v.text.strip]}.to_h }
+
+# [{:company=>"Alfreds Futterkiste",
+#   :contact=>"MARIA ANDERS",
+#   :country=>"Germany"},
+#  {:company=>"Centro comercial Moctezuma",
+#   :contact=>"FRANCISCO CHANG",
+#   :country=>"Mexico"},
+#  {:company=>"Ernst Handel", :contact=>"ROLAND MENDEL", :country=>"Austria"},
+#  {:company=>"Island Trading", :contact=>"HELEN BENNETT", :country=>"UK"},
+#  {:company=>"Laughing Bacchus Winecellars",
+#   :contact=>"YOSHI TANNAMURI",
+#   :country=>"Canada"},
+#  {:company=>"Magazzini Alimentari Riuniti",
+#   :contact=>"GIOVANNI ROVELLI",
+#   :country=>"Italy"}]
+```
 
 ## Development
 
@@ -32,5 +111,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/site_prism-tableish.
+Bug reports and pull requests are welcome on GitHub at https://github.com/fkshom/site_prism-tableish. 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/lib/site_prism/tableish.rb

@@ -2,6 +2,15 @@ require "site_prism/tableish/version"
 
 module SitePrism
   module Tableish
-    # Your code goes here...
+
+    autoload :Element,    'site_prism/tableish/element'
+    autoload :Definition, 'site_prism/tableish/definition'
+
+    def table(table_name, *args, &block)
+      definition = Definition.new(&block)
+      define_method table_name do |*runtime_args, &element_block|
+        Element.new(page.find(*args), definition)
+      end
+    end
   end
 end

data/lib/site_prism/tableish/definition.rb

@@ -0,0 +1,15 @@
+module SitePrism
+  module Tableish
+    class Definition
+      attr_reader :columns
+      def initialize(&block)
+        @columns = []
+        instance_exec(&block)
+      end
+
+      def column(name, options={})
+        @columns << [ name, options ]
+      end
+    end
+  end
+end

data/lib/site_prism/tableish/element.rb

@@ -0,0 +1,26 @@
+module SitePrism
+  module Tableish
+    class Element
+      include Capybara::DSL
+      def initialize(root_element, definition)
+        @root_element = root_element
+        @definition = definition
+      end
+
+      def rows
+        [].tap do |result|
+          Capybara.within(@root_element){
+            all(:xpath, ".//tbody/tr | .//body/tr").each do |row_in|
+              row_out = {}
+              row_in.all(:xpath, "td").each_with_index do |cell, i|
+                name, options = @definition.columns[i]
+                row_out[name] = cell
+              end
+              result << row_out unless row_out.empty?
+            end
+          }
+        end
+      end
+    end
+  end
+end

data/lib/site_prism/tableish/version.rb

@@ -1,5 +1,5 @@
 module SitePrism
   module Tableish
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/site_prism-tableish.gemspec

@@ -24,4 +24,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "selenium-webdriver"
+  spec.add_dependency "site_prism"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: site_prism-tableish
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Shoma FUKUDA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-20 00:00:00.000000000 Z
+date: 2017-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  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: site_prism
+  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'
 description: Table scraping for SitePrism
 email:
 - fkshom@gmail.com
@@ -68,6 +96,8 @@ files:
 - bin/console
 - bin/setup
 - lib/site_prism/tableish.rb
+- lib/site_prism/tableish/definition.rb
+- lib/site_prism/tableish/element.rb
 - lib/site_prism/tableish/version.rb
 - site_prism-tableish.gemspec
 homepage: https://github.com/fkshom/site_prism-tableish