philologic-client 0.0.11 → 0.0.13

data/test/test_collocation.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start
+
+require 'philologic-client'
+require 'test_response'
+require 'test/unit'
+
+
+class TestCollocation < TestResponse
+
+  def test_initialization_with_nil_document
+    assert_raise(RuntimeError, 'nil document') {  Philologic::Client::Collocation.new(nil) }
+  end
+
+  def test_initialization_with_empty_document
+    r = Philologic::Client::Collocation.new(@doc)
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response,     r
+    assert_kind_of  Philologic::Client::Collocation,  r
+    assert_nil      r.client
+    assert          !r.results?
+    assert_not_nil  r.results
+    assert_kind_of  Array,                          r.results
+    assert_equal    0,                              r.results.size
+  end
+
+  def test_initialization_with_client
+    r = Philologic::Client::Collocation.new( @doc, @client )
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response,     r
+    assert_kind_of  Philologic::Client::Collocation,  r
+    assert_not_nil  r.client
+    assert_equal    @client,                        r.client
+    assert          !r.results?
+    assert_not_nil  r.results
+    assert_kind_of  Array,                          r.results
+    assert_equal    0,                              r.results.size
+  end
+
+  def test_with_sample_file
+    f = File.join( File.dirname(__FILE__), 'data', 'collocation.html' )
+    r = Philologic::Client::Collocation.new( Nokogiri::HTML( open(f).read, nil, @client.encoding ) )
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response,     r
+    assert_kind_of  Philologic::Client::Collocation,  r
+    assert_nil      r.client
+
+    assert          r.results?
+    assert_not_nil  r.results
+    assert_kind_of  Array,                          r.results
+
+    skip('r.results.size == 642')
+    # TODO assert_equal    642,                            r.results.size
+
+    #first = r.results.first
+    #assert_not_nil  first
+    #assert_equal    'first',  first.inspect
+    #assert_kind_of  Philologic::Client::CollocationRow,               first
+    #assert_equal    "A Midsummer Night's Dream",                    first.label
+    #assert_equal    './?q=lion&title=A+Midsummer+Night%27s+Dream',  first.link
+    #assert_equal    '30',                                           first.value
+
+    #last = r.results.last
+    #assert_not_nil  last
+    # assert_equal    '', last.inspect
+    # assert_kind_of  Philologic::Client::CollocationRow,               last
+    # assert_equal    'As You Like It',                               last.label
+    # assert_equal    './?q=lion&title=As+You+Like+It',               last.link
+    # assert_equal    '1',                                            last.value
+
+  end
+
+end
+

data/test/test_concordance.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start
+
+require 'philologic-client'
+require 'test_response'
+require 'test/unit'
+
+
+class TestConcordance < TestResponse
+
+  def test_initialization_with_nil_document
+    assert_raise(RuntimeError, 'nil document') {  Philologic::Client::Concordance.new(nil) }
+  end
+
+  def test_initialization_with_empty_document
+    r = Philologic::Client::Concordance.new(@doc)
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response,     r
+    assert_kind_of  Philologic::Client::Concordance,  r
+    assert_nil      r.client
+    assert          !r.results?
+    assert_kind_of  Array,                            r.results
+  end
+
+  def test_initialization_with_client
+    r = Philologic::Client::Concordance.new( @doc, @client )
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response,     r
+    assert_kind_of  Philologic::Client::Concordance,  r
+    assert_not_nil  r.client
+    assert_equal    @client,                          r.client
+    assert          !r.results?
+    assert_kind_of  Array,                            r.results
+  end
+
+  def test_with_sample_file
+    f = File.join( File.dirname(__FILE__), 'data', 'concordance.html' )
+    r = Philologic::Client::Concordance.new( Nokogiri::HTML( open(f).read, nil, @client.encoding ) )
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response,     r
+    assert_kind_of  Philologic::Client::Concordance,  r
+    assert_nil      r.client
+
+    assert          r.results?
+    assert_kind_of  Array,      r.results
+    assert_equal    50,         r.results.size
+
+    first = r.results.first
+    assert_not_nil  first
+    assert_kind_of  Philologic::Client::Occurrence,             first
+    assert_equal    1,                                          first['hit_n']
+    assert_equal    'William Shakespeare',                      first['author']
+    assert_equal    'The First Part of King Henry the Fourth',  first['title']
+    assert_equal    'Prince',                                   first['who']
+    assert          first.text?
+    assert_not_nil  first.text
+    assert_match    /^ cat or a lugged bear/,                   first.text
+    assert_match    /Yea$/,                                     first.text
+    assert_not_nil  first.html
+    assert_match    /^ cat or a lugged bear/,                   first.html
+    assert_match    /Yea$/,                                     first.html
+
+    last = r.results.last
+    assert_not_nil  last
+    assert_kind_of  Philologic::Client::Occurrence, last
+    assert_equal    50,                             last['hit_n']
+    assert_equal    'William Shakespeare',          last['author']
+    assert_equal    "A Midsummer Night's Dream",    last['title']
+    assert_equal    'Bottom',                       last['who']
+
+    assert          last.text?
+    assert_not_nil  last.text
+    assert_match    /^Masters, you ought to /,      last.text.strip
+    assert_match    /for there is not a more$/,     last.text.strip
+    assert_not_nil  last.html
+    assert_match    /^Masters, you ought to /,      last.html.strip
+    assert_match    /for there is not a more$/,     last.html.strip
+  end
+
+end
+

data/test/test_document.rb

@@ -0,0 +1,127 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start
+
+require 'philologic-client'
+require 'test_response'
+require 'test/unit'
+
+
+class TestDocument < TestResponse
+
+  def test_initialization_with_nil_document
+    assert_raise(RuntimeError, 'nil document') {  Philologic::Client::Document.new(nil) }
+  end
+
+  def test_initialization_with_empty_document
+    r = Philologic::Client::Document.new(@doc)
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response, r
+    assert_kind_of  Philologic::Client::Document, r
+    assert_nil      r.client
+    assert          !r.links?
+    assert          !r.text?
+    assert_kind_of  Array,                        r.links
+    assert_equal    0,                            r.links.size
+  end
+
+  def test_initialization_with_client
+    r = Philologic::Client::Document.new( @doc, @client )
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response, r
+    assert_kind_of  Philologic::Client::Document, r
+    assert_not_nil  r.client
+    assert_equal    @client,                      r.client
+    assert          !r.links?
+    assert          !r.text?
+    assert_nil      r['author']
+    assert_nil      r['title']
+    assert_kind_of  Array,                        r.links
+    assert_equal    0,                            r.links.size
+  end
+
+  def test_with_sample_navigation_file
+    f = File.join( File.dirname(__FILE__), 'data', 'navigation.html' )
+    r = Philologic::Client::Document.new( Nokogiri::HTML( open(f).read, nil, @client.encoding ) )
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response,   r
+    assert_kind_of  Philologic::Client::Document,   r
+    assert_nil      r.client
+
+    assert_not_nil  r.keys
+    assert_kind_of  Array,              r.keys
+    assert_equal    2,                  r.keys.size
+    assert_equal    %w( author title ), r.keys
+
+    r.each_with_index do |k, idx|
+      case  idx
+      when  0
+        assert_equal  'author',               k 
+        assert_equal  'William Shakespeare',  r[k]
+      when  1
+        assert_equal  'title',                                    k 
+        assert_equal  'The First Part of King Henry the Fourth',  r[k]
+      end
+    end
+
+    assert_equal    'William Shakespeare',                      r['author']
+    assert_equal    'The First Part of King Henry the Fourth',  r['title']
+
+    assert          r.links?
+    assert_kind_of  Array,                                      r.links
+    assert_equal    26,                                         r.links.size
+    assert_kind_of  Philologic::Client::Link, r.links.first
+    assert_equal    './1/2',                  r.links.first.url
+    assert_equal    '',                       r.links.first.text
+    assert_kind_of  Philologic::Client::Link, r.links.last
+    assert_equal    './1/7/6',                r.links.last.url
+    assert_equal    'Act 5, Scene 5',         r.links.last.text
+
+    assert      !r.text?
+    assert_nil  r.text
+    assert_nil  r.html
+  end
+
+  def test_with_sample_object_file
+    f = File.join( File.dirname(__FILE__), 'data', 'object.html' )
+    r = Philologic::Client::Document.new( Nokogiri::HTML( open(f).read, nil, @client.encoding ) )
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response, r
+    assert_kind_of  Philologic::Client::Document, r
+    assert_nil      r.client
+
+    assert_not_nil  r.keys
+    assert_kind_of  Array,              r.keys
+    assert_equal    2,                  r.keys.size
+    assert_equal    %w( author title ), r.keys
+
+    r.each_with_index do |k, idx|
+      case  idx
+      when  0
+        assert_equal  'author',               k 
+        assert_equal  'William Shakespeare',  r[k]
+      when  1
+        assert_equal  'title',                                    k 
+        assert_equal  'The First Part of King Henry the Fourth',  r[k]
+      end
+    end
+
+    assert_equal    'William Shakespeare',                      r['author']
+    assert_equal    'The First Part of King Henry the Fourth',  r['title']
+
+    assert          !r.links?
+    assert_kind_of  Array,  r.links
+    assert_equal    0,      r.links.size
+
+    assert                                    r.text?
+    assert_match  /^The First Part of King /, r.text.strip
+    assert_match  /assistants\s+\n The/,      r.text.strip
+    assert_match  /and W\. A\. Wright\.$/,    r.text.strip
+    assert_match  /^The First Part of King /, r.html.strip
+    assert_match  /<p><\/p> The WordHoard/,   r.html.strip
+    assert_match  /and W\. A\. Wright\.$/,    r.html.strip
+  end
+
+end
+

data/test/test_frequency.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start
+
+require 'philologic-client'
+require 'test_response'
+require 'test/unit'
+
+
+class TestFrequency < TestResponse
+
+  def test_initialization_with_nil_document
+    assert_raise(RuntimeError, 'nil document') {  Philologic::Client::Frequency.new(nil) }
+  end
+
+  def test_initialization_with_empty_document
+    r = Philologic::Client::Frequency.new(@doc)
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response,   r
+    assert_kind_of  Philologic::Client::Frequency,  r
+    assert_nil      r.client
+    assert_nil      r.label_header
+    assert_nil      r.value_header
+    assert          !r.results?
+    assert_not_nil  r.results
+    assert_kind_of  Array,                          r.results
+    assert_equal    0,                              r.results.size
+  end
+
+  def test_initialization_with_client
+    r = Philologic::Client::Frequency.new( @doc, @client )
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response,   r
+    assert_kind_of  Philologic::Client::Frequency,  r
+    assert_not_nil  r.client
+    assert_equal    @client,                        r.client
+    assert_nil      r.label_header
+    assert_nil      r.value_header
+    assert          !r.results?
+    assert_not_nil  r.results
+    assert_kind_of  Array,                          r.results
+    assert_equal    0,                              r.results.size
+  end
+
+  def test_with_sample_file
+    f = File.join( File.dirname(__FILE__), 'data', 'frequency.html' )
+    r = Philologic::Client::Frequency.new( Nokogiri::HTML( open(f).read, nil, @client.encoding ) )
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response,   r
+    assert_kind_of  Philologic::Client::Frequency,  r
+    assert_nil      r.client
+
+    assert_equal    'title',  r.label_header
+    assert_equal    'count',  r.value_header
+
+    assert          r.results?
+    assert_not_nil  r.results
+    assert_kind_of  Array,                          r.results
+    assert_equal    29,                             r.results.size
+
+    first = r.results.first
+    assert_not_nil  first
+    assert_kind_of  Philologic::Client::FrequencyRow,               first
+    assert_equal    "A Midsummer Night's Dream",                    first.label
+    assert_equal    './?q=lion&title=A+Midsummer+Night%27s+Dream',  first.link
+    assert_equal    '30',                                           first.value
+
+    last = r.results.last
+    assert_not_nil  last
+    assert_kind_of  Philologic::Client::FrequencyRow,               last
+    assert_equal    'As You Like It',                               last.label
+    assert_equal    './?q=lion&title=As+You+Like+It',               last.link
+    assert_equal    '1',                                            last.value
+  end
+
+end
+

data/test/test_occurrence.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start
+
+require 'philologic-client'
+require 'test/unit'
+
+
+class TestOccurrence < Test::Unit::TestCase
+
+  def setup
+    @endpoint = File.expand_path( File.join( File.dirname(__FILE__), 'data' ) )
+    @client   = Philologic::Client.new(@endpoint)
+    @doc      = Nokogiri::HTML("")
+  end
+
+
+  def test_initialization_with_nil_document
+    assert_raise(RuntimeError, 'nil document') {  Philologic::Client::Occurrence.new(nil) }
+  end
+
+  def test_initialization_with_empty_document
+    r = Philologic::Client::Occurrence.new(@doc)
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Occurrence, r
+    assert_kind_of  Philologic::Client::Response,   r
+    assert_nil      r.client
+    assert_nil      r['author']
+    assert_nil      r['title']
+    assert_nil      r['href']
+  end
+
+  def test_initialization_with_client
+    r = Philologic::Client::Occurrence.new( @doc, @client )
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Occurrence, r
+    assert_kind_of  Philologic::Client::Response,   r
+    assert_not_nil  r.client
+    assert_equal    @client,                      r.client
+    assert_nil      r['author']
+    assert_nil      r['title']
+    assert_nil      r['href']
+  end
+
+  def test_occurrence
+    html = <<EOHTML;
+<li class='philologic_occurence'>
+ <a href="./1/0/0/0/0" class='philologic_cite'><span class='philologic_property' title='author'>William Shakespeare</span>, <i><span class='philologic_cite' title='title'>The First Part of King Henry the Fourth</span></i> : <span class='philologic_property' title='who'></span></a>
+</li>
+EOHTML
+    r = Philologic::Client::Occurrence.new( Nokogiri::HTML(html), @client )
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Occurrence,             r
+    assert_kind_of  Philologic::Client::Response,               r
+    assert_not_nil  r.client
+    assert_equal    @client,                                    r.client
+
+    assert_equal    'William Shakespeare',                      r['author']
+    assert_equal    'The First Part of King Henry the Fourth',  r['title']
+    assert_equal    '',                                         r['who']
+    assert_equal    './1/0/0/0/0',                              r['href']
+  end
+  
+end
+

data/test/test_response.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require 'simplecov'
+SimpleCov.start
+
+require 'philologic-client'
+require 'test/unit'
+
+
+class TestResponse < Test::Unit::TestCase
+
+  def setup
+    @endpoint = File.expand_path( File.join( File.dirname(__FILE__), 'data' ) )
+    @client   = Philologic::Client.new(@endpoint)
+    @doc      = Nokogiri::HTML("")
+  end
+
+
+  def test_initialization_with_nil_document
+    assert_raise(RuntimeError, 'nil document') {  Philologic::Client::Response.new(nil) }
+  end
+
+  def test_initialization_with_empty_document
+    r = Philologic::Client::Response.new(@doc)
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response, r
+    assert_nil      r.client
+  end
+
+  def test_initialization_with_client
+    r = Philologic::Client::Response.new( @doc, @client )
+    assert_not_nil  r
+    assert_kind_of  Philologic::Client::Response, r
+    assert_not_nil  r.client
+    assert_equal    @client,                      r.client
+    assert_nil      r['author']
+    assert_nil      r['title']
+  end
+
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: philologic-client
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-09 00:00:00.000000000Z
+date: 2012-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70128325064720 !ruby/object:Gem::Requirement
+  requirement: &70355940235640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70128325064720
+  version_requirements: *70355940235640
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70128325064280 !ruby/object:Gem::Requirement
+  requirement: &70355940234740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70128325064280
+  version_requirements: *70355940234740
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70128325063780 !ruby/object:Gem::Requirement
+  requirement: &70355940234220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70128325063780
+  version_requirements: *70355940234220
 - !ruby/object:Gem::Dependency
   name: rdoc-readme
-  requirement: &70128325052240 !ruby/object:Gem::Requirement
+  requirement: &70355940233580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.1.2
   type: :development
   prerelease: false
-  version_requirements: *70128325052240
+  version_requirements: *70355940233580
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70128325051400 !ruby/object:Gem::Requirement
+  requirement: &70355940233100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70128325051400
+  version_requirements: *70355940233100
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70128325050940 !ruby/object:Gem::Requirement
+  requirement: &70355940255960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70128325050940
+  version_requirements: *70355940255960
 description: Ruby client for interacting with the Philologic API.
 email:
 - blair.christensen@gmail.com
@@ -87,21 +87,35 @@ files:
 - .gitignore
 - Gemfile
 - HISTORY.rdoc
+- PhiloLogicResponseDocumentation.txt
 - README.rdoc
 - Rakefile
-- doc/PhiloLogicResponseTemplates.txt
 - lib/philologic-client.rb
+- lib/philologic-client/bibliography.rb
+- lib/philologic-client/collocation.rb
+- lib/philologic-client/concordance.rb
+- lib/philologic-client/document.rb
+- lib/philologic-client/frequency.rb
+- lib/philologic-client/frequency_row.rb
+- lib/philologic-client/link.rb
+- lib/philologic-client/occurrence.rb
+- lib/philologic-client/response.rb
 - lib/philologic-client/version.rb
 - philologic-client.gemspec
-- test/data/collocation_links.html
-- test/data/collocation_sartre.html
-- test/data/doc_file.html
-- test/data/frequency_links.html
-- test/data/frequency_sartre.html
-- test/data/query_sartre.html
-- test/data/root_file.html
-- test/test_philologic_client.rb
-- test/test_philologic_link.rb
+- test/data/bibliography.html
+- test/data/collocation.html
+- test/data/concordance.html
+- test/data/frequency.html
+- test/data/navigation.html
+- test/data/object.html
+- test/test_bibliography.rb
+- test/test_client.rb
+- test/test_collocation.rb
+- test/test_concordance.rb
+- test/test_document.rb
+- test/test_frequency.rb
+- test/test_occurrence.rb
+- test/test_response.rb
 homepage: https://github.com/blairc/philologic-client/
 licenses: []
 post_install_message: 
@@ -116,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3858874117340008545
+      hash: 1785018451817117729
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -125,20 +139,25 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3858874117340008545
+      hash: 1785018451817117729
 requirements: []
 rubyforge_project: philologic-client
-rubygems_version: 1.8.7
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Ruby client for interacting with the Philologic API.
 test_files:
-- test/data/collocation_links.html
-- test/data/collocation_sartre.html
-- test/data/doc_file.html
-- test/data/frequency_links.html
-- test/data/frequency_sartre.html
-- test/data/query_sartre.html
-- test/data/root_file.html
-- test/test_philologic_client.rb
-- test/test_philologic_link.rb
+- test/data/bibliography.html
+- test/data/collocation.html
+- test/data/concordance.html
+- test/data/frequency.html
+- test/data/navigation.html
+- test/data/object.html
+- test/test_bibliography.rb
+- test/test_client.rb
+- test/test_collocation.rb
+- test/test_concordance.rb
+- test/test_document.rb
+- test/test_frequency.rb
+- test/test_occurrence.rb
+- test/test_response.rb