wikiscript 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa972f9f2c4580091fb3dac93cf76f94f6054ba1
-  data.tar.gz: 138954a7a0281032b68aae0f29b9d239c9f7f90a
+  metadata.gz: a34183c24ce2eac79cf72edcec39c562e6c74065
+  data.tar.gz: 56fff65e58fc1fbbbc2eeaa111d22d6ebce84f63
 SHA512:
-  metadata.gz: 74af5f6bd6b915a1887d9022763294f0e6e634415d1bbdf3b18ae9fc0f9a11b01812b904a42a4ed687a60cafbd50230afd8a804dab8bb6a8b28475f99437be2b
-  data.tar.gz: 44f92623eb560825a834de570b8cfc604a92bfb907b38c2390b2d3a52cc74bcf8f229d21369c27bd73c0b99a9db9c65f5df3bf9b6d304e9876694135e7517ddc
+  metadata.gz: 85fa8e16dffbdfdaf6b683dae530a692eb6c570a03345ddf2a013b248bbb51aaab9ce495850bdd564a163e35c37f0f80b3f6d47b5ee994e8effe02c413ac8ba8
+  data.tar.gz: ca8d9133a251f634db722575100d260c79859437fb393d9ac5b8181d0725f7d54a5290b4dfa0436a13aa73338c818adeea5c89c06b03b2f2e7360aa102f3e1c4

data/README.md

@@ -12,16 +12,203 @@ Read-only access to wikikpedia pages.
 Example - Get wikitext source (via `en.wikipedia.org/w/index.php?action=raw&title=<title>`):
 
 
+``` ruby
+page = Wikiscript::Page.get( '2022_FIFA_World_Cup' )  # same as Wikiscript.get
+page.text
 ```
->> page = Wikiscript::Page.new( '2014_FIFA_World_Cup_squads' )
->> page.text
 
-The [[2014 FIFA World Cup]] is an international [[association football|football]]
-tournament which is currently being held in Brazil from 12 June to 13 July 2014.
-The 32 national teams involved in the tournament were required to register
-a squad of 23 players, including three goalkeepers...
+prints
+
+```
+The '''2022 FIFA World Cup''' is scheduled to be the 22nd edition of the [[FIFA World Cup]],
+the quadrennial international men's [[association football]] championship contested by the
+[[List of men's national association football teams|national teams]] of the member associations of [[FIFA]].
+It is scheduled to take place in [[Qatar]] in 2022. This will be the first World Cup ever to be held
+in the [[Arab world]] and the first in a Muslim-majority country...
+```
+
+Or build your own page from scratch (no download):
+
+``` ruby
+page = Wikiscript::Page.new( <<TXT, title: '2022_FIFA_World_Cup' )
+The '''2022 FIFA World Cup''' is scheduled to be the 22nd edition of the [[FIFA World Cup]],
+the quadrennial international men's [[association football]] championship contested by the
+[[List of men's national association football teams|national teams]] of the member associations of [[FIFA]].
+It is scheduled to take place in [[Qatar]] in 2022. This will be the first World Cup ever to be held
+in the [[Arab world]] and the first in a Muslim-majority country...
+TXT
+page.text
+```
+
+prints
+
+```
+The '''2022 FIFA World Cup''' is scheduled to be the 22nd edition of the [[FIFA World Cup]],
+the quadrennial international men's [[association football]] championship contested by the
+[[List of men's national association football teams|national teams]] of the member associations of [[FIFA]].
+It is scheduled to take place in [[Qatar]] in 2022. This will be the first World Cup ever to be held
+in the [[Arab world]] and the first in a Muslim-majority country...
+```
+
+
+### Tables
+
+Parse wiki tables into an array.  Example:
+
+``` ruby
+table = Wikiscript.parse_table( <<TXT )
+{|
+|-
+! header1
+! header2
+! header3
+|-
+| row1cell1
+| row1cell2
+| row1cell3
+|-
+| row2cell1
+| row2cell2
+| row2cell3
+|}
+TXT
+
+# -or-
+
+table = Wikiscript.parse_table( <<TXT )
+{|
+! header1 !! header2 !! header3
+|-
+| row1cell1 || row1cell2 || row1cell3
+|-
+| row2cell1 || row2cell2 || row2cell3
+|}
+TXT
+
+# -or-
+
+table = Wikiscript.parse_table( <<TXT )
+{|
+|-
+!
+header1
+!
+header2
+!
+header3
+|-
+|
+row1cell1
+|
+row1cell2
+|
+row1cell3
+|-
+|
+row2cell1
+|
+row2cell2
+|
+row2cell3
+|}
+TXT
+```
+
+resulting in:
+
+``` ruby
+pp table
+#=> [["header1",   "header2",   "header3"],
+#    ["row1cell1", "row1cell2", "row1cell3"],
+#    ["row2cell1", "row2cell2", "row2cell3"]]
 ```
 
+Note: `parse_table` will strip/remove (leading) style attributes (e.g. `àttribute="value" |` and (inline) bold and italic emphases (e.g. `''`) from the (cell) text. Example:
+
+``` ruby
+table = Wikiscript.parse_table( <<TXT )
+{|
+|-
+! style="width:200px;"|Club
+! style="width:150px;"|City
+|-
+|[[Biu Chun Rangers]]||[[Sham Shui Po]]
+|-
+|bgcolor=#ffff44 |''[[Eastern Sports Club|Eastern]]''||[[Mong Kok]]
+|-
+|[[HKFC Soccer Section]]||[[Happy Valley, Hong Kong|Happy Valley]]
+|}
+TXT
+```
+
+resulting in:
+
+``` ruby
+pp table
+#=> [["Club",                            "City"],
+#    ["[[Biu Chun Rangers]]",            "[[Sham Shui Po]]"],
+#    ["[[Eastern Sports Club|Eastern]]", "[[Mong Kok]]"],
+#    ["[[HKFC Soccer Section]]",         "[[Happy Valley, Hong Kong|Happy Valley]]"]]
+```
+
+### Links
+
+Split links into two parts. Note: The alternate link title is optional. Example:
+
+``` ruby
+link, title = Wikiscript.parse_link( '[[La Florida, Chile|La Florida]]' )
+link   #=> "La Florida, Chile"
+title  #=> "La Florida"
+
+link, title = Wikiscript.parse_link( '[[ La Florida, Chile]]' )
+link   #=> "La Florida, Chile"
+title  #=> nil
+
+link, title = Wikiscript.parse_link( 'La Florida' )
+link   #=> nil
+title  #=> nil
+```
+
+### Document Element Structure
+
+Get the document's element structure.
+Note: For now only section headings (`h1`, `h2`, `h3`, ...) and tables are supported.
+Example:
+
+``` ruby
+nodes = Wikiscript.parse( <<TXT )
+=Heading 1==
+==Heading 2==
+===Heading 3===
+
+{|
+|-
+! header1
+! header2
+! header3
+|-
+| row1cell1
+| row1cell2
+| row1cell3
+|-
+| row2cell1
+| row2cell2
+| row2cell3
+|}
+TXT
+
+pp nodes
+#=> [[:h1, "Heading 1"],
+#    [:h2, "Heading 2"],
+#    [:h3, "Heading 3"],
+#    [:table, [["header1", "header2", "header3"],
+#              ["row1cell1", "row1cell2", "row1cell3"],
+#              ["row2cell1", "row2cell2", "row2cell3"]]]
+```
+
+
+That's all for now. More functionality will get added over time.
+
 
 
 ## Install

data/Rakefile

@@ -5,7 +5,7 @@ Hoe.spec 'wikiscript' do
 
   self.version = Wikiscript::VERSION
 
-  self.summary = 'wikiscript - scripts for wikipedia (get wikitext for page etc.)'
+  self.summary = "wikiscript - scripts for wikipedia (get wikitext for page, parse tables 'n' links, etc.)"
   self.description = summary
 
   self.urls = ['https://github.com/wikiscript/wikiscript']

data/lib/wikiscript/page.rb

@@ -33,11 +33,23 @@ module Wikiscript
     end
 
     def text
-      @text ||= get   # cache text (from request)
+      @text ||= get        # cache text (from request)
+    end
+
+    def nodes
+      @nodes ||= parse     # cache text (from parse)
+    end
+
+    def each   ## loop over all nodes / elements -note: nodes is a (flat) list (array) for now
+      nodes.each do |node|
+        yield( node )
+      end
     end
 
 
     def get    ## "force" refresh text (get/fetch/download)
+      @nodes = nil  ## note: reset cached parsed nodes too
+
       @text = Client.new.text( @title, lang: @lang )
       @text
     end
@@ -45,9 +57,9 @@ module Wikiscript
     alias_method :download, :get
 
 
-
     def parse   ## todo/change: use/find a different name e.g. doc/elements/etc. - why? why not?
-      PageReader.parse( text )
+      @nodes = PageReader.parse( text )
+      @nodes
     end
   end # class Page
 end # Wikiscript

data/lib/wikiscript/version.rb

@@ -1,6 +1,6 @@
 
 module Wikiscript
-   VERSION = '0.3.1'
+   VERSION = '0.3.2'
 
    def self.banner
      "wikiscript/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"

data/test/test_page_reader.rb

@@ -11,7 +11,7 @@ require 'helper'
 class TestPageReader < MiniTest::Test
 
   def test_basic
-    el = Wikiscript.parse( <<TXT )
+    nodes = Wikiscript.parse( <<TXT )
 =Heading 1==
 ==Heading 2==
 ===Heading 3===
@@ -32,15 +32,15 @@ class TestPageReader < MiniTest::Test
 |}
 TXT
 
-    pp el
+    pp nodes
 
-    assert_equal 4, el.size
-    assert_equal [:h1, 'Heading 1'],  el[0]
-    assert_equal [:h2, 'Heading 2'],  el[1]
-    assert_equal [:h3, 'Heading 3'],  el[2]
+    assert_equal 4, nodes.size
+    assert_equal [:h1, 'Heading 1'],  nodes[0]
+    assert_equal [:h2, 'Heading 2'],  nodes[1]
+    assert_equal [:h3, 'Heading 3'],  nodes[2]
     assert_equal [:table, [['header1', 'header2', 'header3'],
                            ['row1cell1', 'row1cell2', 'row1cell3'],
-                           ['row2cell1', 'row2cell2', 'row2cell3']]],  el[3]
+                           ['row2cell1', 'row2cell2', 'row2cell3']]],  nodes[3]
   end
 
   def test_parse
@@ -65,16 +65,53 @@ TXT
 |}
 TXT
 
-    el = page.parse
-    pp el
+    nodes = page.parse
+    pp nodes
 
-    assert_equal 4, el.size
-    assert_equal [:h1, 'Heading 1'],  el[0]
-    assert_equal [:h2, 'Heading 2'],  el[1]
-    assert_equal [:h3, 'Heading 3'],  el[2]
+    assert_equal 4, nodes.size
+    assert_equal [:h1, 'Heading 1'],  nodes[0]
+    assert_equal [:h2, 'Heading 2'],  nodes[1]
+    assert_equal [:h3, 'Heading 3'],  nodes[2]
     assert_equal [:table, [['header1', 'header2', 'header3'],
                            ['row1cell1', 'row1cell2', 'row1cell3'],
-                           ['row2cell1', 'row2cell2', 'row2cell3']]],  el[3]
+                           ['row2cell1', 'row2cell2', 'row2cell3']]],  nodes[3]
+  end
+
+  def test_each
+    page = Wikiscript::Page.new( <<TXT )
+=Heading 1==
+==Heading 2==
+===Heading 3===
+
+{|
+|-
+! header1
+! header2
+! header3
+|-
+| row1cell1
+| row1cell2
+| row1cell3
+|-
+| row2cell1
+| row2cell2
+| row2cell3
+|}
+TXT
+
+    nodes = []
+    page.each do |node|
+      nodes << node
+    end
+    pp nodes
+
+    assert_equal 4, nodes.size
+    assert_equal [:h1, 'Heading 1'],  nodes[0]
+    assert_equal [:h2, 'Heading 2'],  nodes[1]
+    assert_equal [:h3, 'Heading 3'],  nodes[2]
+    assert_equal [:table, [['header1', 'header2', 'header3'],
+                           ['row1cell1', 'row1cell2', 'row1cell3'],
+                           ['row2cell1', 'row2cell2', 'row2cell3']]],  nodes[3]
   end
 
 end # class TestPageReader

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wikiscript
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-21 00:00:00.000000000 Z
+date: 2019-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logutils
@@ -66,7 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.16'
-description: wikiscript - scripts for wikipedia (get wikitext for page etc.)
+description: wikiscript - scripts for wikipedia (get wikitext for page, parse tables
+  'n' links, etc.)
 email: opensport@googlegroups.com
 executables: []
 extensions: []
@@ -120,5 +121,6 @@ rubyforge_project:
 rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
-summary: wikiscript - scripts for wikipedia (get wikitext for page etc.)
+summary: wikiscript - scripts for wikipedia (get wikitext for page, parse tables 'n'
+  links, etc.)
 test_files: []