wiki-api 0.1.0 → 0.1.2

data/test/unit/wiki_page_offline.rb

@@ -1,8 +1,6 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'rubygems'
-require 'test/unit'
-require File.expand_path(File.dirname(__FILE__) + "/../../lib/wiki/api")
+require 'test_helper'
 
 #
 # Testing the parsing of URI (with a predownloaded HTML file):
@@ -13,59 +11,55 @@ require File.expand_path(File.dirname(__FILE__) + "/../../lib/wiki/api")
 #
 
 class WikiPageOfflinePage < Test::Unit::TestCase
-
   # this global is required to resolve URIs (MediaWiki uses relative paths in their links)
-  URI_CONFIG = { uri: "http://en.wiktionary.org" }
+  URI_CONFIG = { uri: 'https://en.wiktionary.org' }.freeze
   # use local file for test loading
-  PAGE_CONFIG = { file: File.expand_path(File.dirname(__FILE__) + "/files/Wiktionary_program.html") }
+  PAGE_CONFIG = { file: File.expand_path("#{File.dirname(__FILE__)}/files/Wiktionary_program.html") }.freeze
 
   def setup
     # NOTE: comment Page.config, to use the online MediaWiki instance
-    Wiki::Api::Connect.config = URI_CONFIG
-    Wiki::Api::Connect.config.merge! PAGE_CONFIG
+    Wiki::Api::Connect.config = URI_CONFIG.merge(PAGE_CONFIG)
+    # Wiki::Api::Connect.config.merge!(PAGE_CONFIG)
   end
 
-  def teardown
-  end
+  def teardown; end
 
   # test simple page invocation
   def test_headlines_nested
-
     # load page
-    page = Wiki::Api::Page.new name: "program"
-    assert page.is_a?(Wiki::Api::Page), "expected Page object"
+    page = Wiki::Api::Page.new(name: 'program')
+    assert(page.is_a?(Wiki::Api::Page), 'expected Page object')
     headline = page.root_headline
-    assert headline.is_a?(Wiki::Api::PageHeadline), "expected PageHeadline object"
-    assert headline.name == "program", "expected developer headline"
+    assert(headline.is_a?(Wiki::Api::PageHeadline), 'expected PageHeadline object')
+    assert(headline.name == 'program', 'expected developer headline')
 
-    # search nested headline: english   
-    english = headline.headline("english").first
-    assert english.is_a?(Wiki::Api::PageHeadline), "expected PageHeadline object"
+    # search nested headline: english
+    english = headline.headline('english').first
+    assert(english.is_a?(Wiki::Api::PageHeadline), 'expected PageHeadline object')
 
     # search nested headline: noun
-    noun = english.headline("noun").first
-    assert noun.is_a?(Wiki::Api::PageHeadline), "expected PageHeadline object"
+    noun = english.headline('noun').first
+    assert(noun.is_a?(Wiki::Api::PageHeadline), 'expected PageHeadline object')
 
     # get block
     block = noun.block
-    assert block.is_a?(Wiki::Api::PageBlock), "expected PageBlock object"
+    assert(block.is_a?(Wiki::Api::PageBlock), 'expected PageBlock object')
 
     # list items
     block.list_items.each do |list_item|
-      assert list_item.is_a?(Wiki::Api::PageListItem), "expected PageListItem object"
+      assert(list_item.is_a?(Wiki::Api::PageListItem), 'expected PageListItem object')
       # links
       list_item.links.each do |link|
-        assert link.is_a?(Wiki::Api::PageLink), "expected PageListItem object"
+        assert(link.is_a?(Wiki::Api::PageLink), 'expected PageListItem object')
       end
     end
 
     # links
     block.links.each do |link|
-      assert link.is_a?(Wiki::Api::PageLink), "expected PageListItem object"
+      assert(link.is_a?(Wiki::Api::PageLink), 'expected PageListItem object')
     end
   end
 
-
   # def test_headlines_verify_tree_objects
   #   page = Wiki::Api::Page.new name: "program"
   #   assert page.is_a?(Wiki::Api::Page), "expected Page object"
@@ -101,162 +95,201 @@ class WikiPageOfflinePage < Test::Unit::TestCase
   #   end
   # end
 
-
   def test_headlines_verify_tree_data
-    page = Wiki::Api::Page.new name: "program"
-    headline = page.root_headline
+    page = Wiki::Api::Page.new(name: 'program')
+    root_headline = page.root_headline
     # get root
-    assert headline.name == "program", "expected program name"
-    
+    assert(root_headline.name == 'program', 'expected program name')
+
     # iterate one deep and verify headline index names
-    headline.headlines.each do |name, headline|
-      assert headline.name == name
+    root_headline.headlines.each do |name, headline|
+      assert(headline.name == name)
     end
-    headlines = headline.headlines.values
+    headlines = root_headline.headlines.values
 
     # English
     english_headlines = headlines[0]
-    assert english_headlines.name == "English"
+    assert(english_headlines.name == 'English')
     english_headlines = english_headlines.headlines.values
-    assert english_headlines[0].name == "Alternative_forms"
-    assert english_headlines[1].name == "Etymology"
-    assert english_headlines[2].name == "Pronunciation"
-    assert english_headlines[3].name == "Noun"
+    assert(english_headlines[0].name == 'Alternative_forms')
+    assert(english_headlines[1].name == 'Etymology')
+    assert(english_headlines[2].name == 'Pronunciation')
+    assert(english_headlines[3].name == 'Noun')
     noun_english_headlines = english_headlines[3].headlines.values
-    assert noun_english_headlines[0].name == "Usage_notes"
-    assert noun_english_headlines[1].name == "Synonyms"
-    assert noun_english_headlines[2].name == "Translations"
-    assert english_headlines[4].name == "Verb"
+    assert(noun_english_headlines[0].name == 'Usage_notes')
+    assert(noun_english_headlines[1].name == 'Synonyms')
+    assert(noun_english_headlines[2].name == 'Translations')
+    assert(english_headlines[4].name == 'Verb')
     verb_english_headlines = english_headlines[4].headlines.values
-    assert verb_english_headlines[0].name == "Related_terms"
-    assert verb_english_headlines[1].name == "Translations_2"
-    assert english_headlines[5].name == "External_links"
+    assert(verb_english_headlines[0].name == 'Related_terms')
+    assert(verb_english_headlines[1].name == 'Translations_2')
+    assert(english_headlines[5].name == 'External_links')
 
     # Czech
     czech_headlines = headlines[1]
-    assert czech_headlines.name == "Czech"
+    assert(czech_headlines.name == 'Czech')
     czech_headlines = czech_headlines.headlines.values
-    assert czech_headlines[0].name == "Pronunciation_2"
-    assert czech_headlines[1].name == "Noun_2"
+    assert(czech_headlines[0].name == 'Pronunciation_2')
+    assert(czech_headlines[1].name == 'Noun_2')
 
     # Hungarian
     hungarian_headlines = headlines[2]
-    assert hungarian_headlines.name == "Hungarian"
+    assert(hungarian_headlines.name == 'Hungarian')
     hungarian_headlines = hungarian_headlines.headlines.values
-    assert hungarian_headlines[0].name == "Pronunciation_3"
-    assert hungarian_headlines[1].name == "Noun_3"
+    assert(hungarian_headlines[0].name == 'Pronunciation_3')
+    assert(hungarian_headlines[1].name == 'Noun_3')
     noun_hungarian_headlines = hungarian_headlines[1].headlines.values
-    assert noun_hungarian_headlines[0].name == "Declension"
-    assert noun_hungarian_headlines[1].name == "Derived_terms"
+    assert(noun_hungarian_headlines[0].name == 'Declension')
+    assert(noun_hungarian_headlines[1].name == 'Derived_terms')
 
     # Norwegian
     norwegian_headlines = headlines[3]
-    assert norwegian_headlines.name == "Norwegian_Bokm.C3.A5l"
+    assert(norwegian_headlines.name == 'Norwegian_Bokm.C3.A5l')
     norwegian_headlines = norwegian_headlines.headlines.values
-    assert norwegian_headlines[0].name == "Noun_4"
+    assert(norwegian_headlines[0].name == 'Noun_4')
 
     # Romanian
     romanian_headlines = headlines[4]
-    assert romanian_headlines.name == "Romanian"
+    assert(romanian_headlines.name == 'Romanian')
     romanian_headlines = romanian_headlines.headlines.values
-    assert romanian_headlines[0].name == "Etymology_2"
-    assert romanian_headlines[1].name == "Noun_5"
+    assert(romanian_headlines[0].name == 'Etymology_2')
+    assert(romanian_headlines[1].name == 'Noun_5')
     noun_romanian_headlines = romanian_headlines[1].headlines.values
-    assert noun_romanian_headlines[0].name == "Declension_2"
-    assert noun_romanian_headlines[1].name == "Related_terms_2"
+    assert(noun_romanian_headlines[0].name == 'Declension_2')
+    assert(noun_romanian_headlines[1].name == 'Related_terms_2')
 
     # Serbo-Croatian
     serb_croatian_headlines = headlines[5]
-    assert serb_croatian_headlines.name == "Serbo-Croatian"
+    assert(serb_croatian_headlines.name == 'Serbo-Croatian')
     serb_croatian_headlines = serb_croatian_headlines.headlines.values
-    assert serb_croatian_headlines[0].name == "Noun_6"
+    assert(serb_croatian_headlines[0].name == 'Noun_6')
     noun_serb_croatian_headlines = serb_croatian_headlines[0].headlines.values
-    assert noun_serb_croatian_headlines[0].name == "Declension_3"
+    assert(noun_serb_croatian_headlines[0].name == 'Declension_3')
 
     # Slovak
     slovak_headlines = headlines[6]
-    assert slovak_headlines.name == "Slovak"
+    assert(slovak_headlines.name == 'Slovak')
     slovak_headlines = slovak_headlines.headlines.values
-    assert slovak_headlines[0].name == "Noun_7"
+    assert(slovak_headlines[0].name == 'Noun_7')
 
     # Swedish
     swedish_headlines = headlines[7]
-    assert swedish_headlines.name == "Swedish"
+    assert(swedish_headlines.name == 'Swedish')
     swedish_headlines = swedish_headlines.headlines.values
-    assert swedish_headlines[0].name == "Etymology_3"
-    assert swedish_headlines[1].name == "Noun_8"
+    assert(swedish_headlines[0].name == 'Etymology_3')
+    assert(swedish_headlines[1].name == 'Noun_8')
     noun_swedish_headlines = swedish_headlines[1].headlines.values
-    assert noun_swedish_headlines[0].name == "Declension_4"
+    assert(noun_swedish_headlines[0].name == 'Declension_4')
 
     # Turkish
     turkish_headlines = headlines[8]
-    assert turkish_headlines.name == "Turkish"
+    assert(turkish_headlines.name == 'Turkish')
     turkish_headlines = turkish_headlines.headlines.values
-    assert turkish_headlines[0].name == "Etymology_4"
-    assert turkish_headlines[1].name == "Noun_9"
+    assert(turkish_headlines[0].name == 'Etymology_4')
+    assert(turkish_headlines[1].name == 'Noun_9')
     noun_turkish_headlines = turkish_headlines[1].headlines.values
-    assert noun_turkish_headlines[0].name == "Declension_5"
-
+    assert(noun_turkish_headlines[0].name == 'Declension_5')
   end
 
-
   def test_headlines_search
-    page = Wiki::Api::Page.new name: "program"
-    headline = page.root_headline
+    page = Wiki::Api::Page.new(name: 'program')
+    root_headline = page.root_headline
     # get root
-    assert headline.name == "program", "expected program name"
+    assert(root_headline.name == 'program', 'expected program name')
 
-    headlines = headline.headline "english"
-    assert !headlines.empty?, "expected a headline"
+    headlines = root_headline.headline('english')
+    assert(!headlines.empty?, 'expected a headline')
 
     # iterate english
     headlines.each do |headline|
-      assert headline.is_a?(Wiki::Api::PageHeadline), "expected PageHeadline object"
-      assert headline.name == "English", "expected English"
-      noun_headlines = headline.headline "noun"
-      assert !noun_headlines.empty?, "exptected a headline"
+      assert(headline.is_a?(Wiki::Api::PageHeadline), 'expected PageHeadline object')
+      assert(headline.name == 'English', 'expected English')
+      noun_headlines = headline.headline('noun')
+      assert(!noun_headlines.empty?, 'exptected a headline')
       # iterate nouns
       noun_headlines.each do |noun_headline|
-        assert noun_headline.is_a?(Wiki::Api::PageHeadline), "expected PageHeadline object"
-        assert noun_headline.name == "Noun", "expected Noun"
-        
-        #list_item.links.each do |link|  
+        assert(noun_headline.is_a?(Wiki::Api::PageHeadline), 'expected PageHeadline object')
+        assert(noun_headline.name == 'Noun', 'expected Noun')
+
+        # list_item.links.each do |link|
       end
     end
   end
 
   def test_headlines_has_headline
     # load page
-    page = Wiki::Api::Page.new name: "program"
+    page = Wiki::Api::Page.new(name: 'program')
 
     # get root
     root_headline = page.root_headline
-    assert root_headline.name == "program", "expected program name"
-    headline = root_headline.headline("english").first
+    assert(root_headline.name == 'program', 'expected program name')
+    headline = root_headline.headline('english').first
 
     # verify existence english headlines
-    assert headline.has_headline?("alternative forms")
-    assert headline.has_headline?("etymology")
-    assert headline.has_headline?("pronunciation")
-    assert headline.has_headline?("noun")
-    assert headline.has_headline?("verb")
-    assert headline.has_headline?("external links")
-    assert !headline.has_headline?("alternative12 forms")
-    assert !headline.has_headline?("etymolfaogy")
-    assert !headline.has_headline?("pronunciafaation")
-    assert !headline.has_headline?("nounia")
-    assert !headline.has_headline?("verbaf")
-    assert !headline.has_headline?("externalaf links")
+    assert(headline.has_headline?('alternative forms'))
+    assert(headline.has_headline?('etymology'))
+    assert(headline.has_headline?('pronunciation'))
+    assert(headline.has_headline?('noun'))
+    assert(headline.has_headline?('verb'))
+    assert(headline.has_headline?('external links'))
+    assert(!headline.has_headline?('alternative12 forms'))
+    assert(!headline.has_headline?('etymolfaogy'))
+    assert(!headline.has_headline?('pronunciafaation'))
+    assert(!headline.has_headline?('nounia'))
+    assert(!headline.has_headline?('verbaf'))
+    assert(!headline.has_headline?('externalaf links'))
 
     # verify existence czech headlines
-    headline = root_headline.headline("czech").first
-    assert headline.has_headline?("pronunciation")
-    assert headline.has_headline?("noun")
-    assert !headline.has_headline?("pronunciation82")
-    assert !headline.has_headline?("nouan")
+    headline = root_headline.headline('czech').first
+    assert(headline.has_headline?('pronunciation'))
+    assert(headline.has_headline?('noun'))
+    assert(!headline.has_headline?('pronunciation82'))
+    assert(!headline.has_headline?('nouan'))
+
+    # TODO: add other headlines here as well!
+  end
+
+  def test_headlines_recursive_search
+    # load page
+    page = Wiki::Api::Page.new(name: 'program')
+
+    # get root
+    root_headline = page.root_headline
+    assert(root_headline.name == 'program', 'expected program name')
+    headline = root_headline.headline('english').first
+
+    related_terms_headline = headline.headline_in_depth('related terms').first
+    assert(related_terms_headline.is_a?(Wiki::Api::PageHeadline), 'expected PageHeadline object')
+    assert(related_terms_headline.name == 'Related_terms')
+    assert(related_terms_headline.parent.is_a?(Wiki::Api::PageHeadline))
+    assert(related_terms_headline.parent.name == 'Verb')
+    assert(related_terms_headline.parent.parent.is_a?(Wiki::Api::PageHeadline))
+    assert(related_terms_headline.parent.parent.name == 'English')
+  end
 
-    #TODO: add other headlines here as well!
+  def test_headlines_recursive_multi_search
+    # load page
+    page = Wiki::Api::Page.new(name: 'program')
 
+    # get root
+    root_headline = page.root_headline
+    assert(root_headline.name == 'program', 'expected program name')
+    headline = root_headline.headline('english').first
+    # search translations within english
+    translations_headlines = headline.headline_in_depth('translations')
+    assert(translations_headlines[0].name == 'Translations')
+    assert(translations_headlines[1].name == 'Translations_2')
   end
 
-end
+  def test_headlines_recursive_search_limit_depth
+    # load page
+    page = Wiki::Api::Page.new(name: 'program')
+    # get root
+    root_headline = page.root_headline
+    assert(root_headline.name == 'program', 'expected program name')
+    headline = root_headline.headline('english').first
+    # search translations within english
+    translations_headlines = headline.headline_in_depth('translations', 0)
+    assert(translations_headlines.empty?, 'expected no translations at depth 0')
+  end
+end

data/wiki-api.gemspec

@@ -1,29 +1,32 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+require 'English'
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'wiki/api/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "wiki-api"
+  spec.name          = 'wiki-api'
   spec.version       = Wiki::Api::VERSION
-  spec.authors       = ["Dennis Blommesteijn"]
-  spec.email         = ["dennis@blommesteijn.com"]
-  spec.description   = %q{MediaWiki API and Page content parser for Headlines (nested), TextBlocks, ListItems, and Links.}
-  spec.summary       = %q{MediaWiki API and Page content parser for Headlines (nested), TextBlocks, ListItems, and Links.}
-  spec.homepage      = "https://github.com/dblommesteijn/wiki-api"
-  spec.license       = "MIT"
+  spec.authors       = ['Dennis Blommesteijn']
+  spec.email         = ['dennis@blommesteijn.com']
+  spec.description   = 'MediaWiki API and Page content parser for Headlines (nested), TextBlocks, ListItems, and Links.'
+  spec.summary       = 'MediaWiki API and Page content parser for Headlines (nested), TextBlocks, ListItems, and Links.'
+  spec.homepage      = 'https://github.com/dblommesteijn/wiki-api'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 1.9.3'
 
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
+  spec.add_development_dependency('bundler', '> 1.3')
+  spec.add_development_dependency('pry', '~> 0.14')
+  spec.add_development_dependency('rake')
+  spec.add_development_dependency('rubocop', '~> 1.59.0')
+  spec.add_development_dependency('test-unit', '> 2.0.0')
 
   # dependencies
-  spec.add_dependency 'nokogiri', "~> 1.5.0"
-  spec.add_dependency 'json', "~> 1.6.1"
-  spec.add_development_dependency "test-unit", "~> 2.0.0"
-
+  spec.add_dependency('nokogiri', '> 1.13.0')
 end

metadata

@@ -1,97 +1,116 @@
 --- !ruby/object:Gem::Specification
 name: wiki-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Dennis Blommesteijn
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-04-09 00:00:00.000000000 Z
+date: 2023-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
-  prerelease: false
+        version: '0.14'
   type: :development
-- !ruby/object:Gem::Dependency
-  name: rake
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency
-  name: nokogiri
+  prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.59.0
+  type: :development
   prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: json
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 1.59.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 1.6.1
+        version: 2.0.0
+  type: :development
   prerelease: false
-  type: :runtime
-- !ruby/object:Gem::Dependency
-  name: test-unit
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: 1.13.0
+  type: :runtime
   prerelease: false
-  type: :development
-description: MediaWiki API and Page content parser for Headlines (nested), TextBlocks, ListItems, and Links.
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 1.13.0
+description: MediaWiki API and Page content parser for Headlines (nested), TextBlocks,
+  ListItems, and Links.
 email:
 - dennis@blommesteijn.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
 - lib/wiki/api.rb
 - lib/wiki/api/connect.rb
 - lib/wiki/api/page.rb
@@ -119,18 +138,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.0.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: MediaWiki API and Page content parser for Headlines (nested), TextBlocks, ListItems, and Links.
+summary: MediaWiki API and Page content parser for Headlines (nested), TextBlocks,
+  ListItems, and Links.
 test_files:
 - test/test_helper.rb
 - test/unit/files/Wiktionary_Welcome,_newcomers.html