philologic-client 0.0.4 → 0.0.5

data/HISTORY.rdoc

@@ -1,5 +1,10 @@
 = Philologic::Client History
 
+== 2012-01-03 v0.0.5
+
+* Added +Philologic::Link#document()+
+* Added +Philologic::Client#encoding+ accessor
+
 == 2011-12-30 v0.0.4
 
 * Set +endpoint+ in +Philologic::Client+ initializer

data/README.rdoc

@@ -13,7 +13,7 @@
 
    # Get document
    first = client.children.first
-   doc   = client.document( first['href'] )
+   doc   = first.document
    txt   = doc.text
 
    # Search (currently only limited support)
@@ -21,6 +21,10 @@
      puts [ child['href'], child['author'], child['title'] ].join("\t")
    end
 
+   # Get/Set encoding
+   encoding        = client.encoding 
+   client.encoding = 'utf-8' # Default
+
    # Get/Set endpoint
    endpoint        = client.endpoint
    client.endpoint = 'http://philologic.example.org'
@@ -42,11 +46,10 @@ https://github.com/blairc/philologic-client/
 
 == To Do
 
-* Add +document+ to Philologic::Link
+* Expand search support
+* Switch to MiniTest::Mock?
 * Add +children+ to Philologic::Document
 * Add +parent+ to Philologic::Document
-* Make Nokogiri encoding configurable
-* Expand search support
-* Unifiy Philologic::Link and Philologic::Document
+* Unify Philologic::Link and Philologic::Document
 * Build +RDoc+
 

data/lib/philologic-client/version.rb

@@ -2,6 +2,6 @@
 
 module Philologic
   class Client
-    VERSION = '0.0.4'
+    VERSION = '0.0.5'
   end
 end

data/lib/philologic-client.rb

@@ -21,7 +21,7 @@ require 'open-uri'
 #
 #    # Get document
 #    first = client.children.first
-#    doc   = client.document( first['href'] )
+#    doc   = first.document
 #    txt   = doc.text
 #
 #    # Search (currently only limited support)
@@ -29,6 +29,10 @@ require 'open-uri'
 #      puts [ child['href'], child['author'], child['title'] ].join("\t")
 #    end
 #
+#    # Get/Set encoding
+#    encoding        = client.encoding 
+#    client.encoding = 'utf-8' # Default
+#
 #    # Get/Set endpoint
 #    endpoint        = client.endpoint
 #    client.endpoint = 'http://philologic.example.org'
@@ -50,12 +54,11 @@ require 'open-uri'
 #
 # == To Do
 #
-# * Add +document+ to Philologic::Link
+# * Expand search support
+# * Switch to MiniTest::Mock?
 # * Add +children+ to Philologic::Document
 # * Add +parent+ to Philologic::Document
-# * Make Nokogiri encoding configurable
-# * Expand search support
-# * Unifiy Philologic::Link and Philologic::Document
+# * Unify Philologic::Link and Philologic::Document
 # * Build +RDoc+
 #
 module Philologic
@@ -65,11 +68,15 @@ module Philologic
   #
   class Client
 
+    #
+    # Get/Set +encoding+
+    #
+    attr_accessor :encoding
+
     #
     # Get/Set +endpoint+
     #
     attr_accessor :endpoint
-
  
     #
     # Initialize Philologic::Client
@@ -78,6 +85,7 @@ module Philologic
     #   +endpoint+:: Philologic endpoint (defaults to +nil+)
     #
     def initialize( endpoint = nil )
+      @encoding = 'utf-8'
       @endpoint = endpoint
       yield self if block_given?
       self
@@ -129,20 +137,20 @@ module Philologic
     def _get(path)
       raise('no endpoint specified') if @endpoint.nil?
       uri = "#{ @endpoint }#{ @endpoint =~ /\/$/ || '/' }#{ path }"
-      _parse( Nokogiri::HTML( open(uri).read, nil, 'utf-8' ) )
+      _parse( Nokogiri::HTML( open(uri).read, nil, @encoding ) )
     end
 
     def _parse(doc)
       if    !doc.css('div.philologic_cite_list').first.nil?
         children = []
         doc.css('div.philologic_cite_list').css('a.philologic_cite').each do |cite|
-          children << Philologic::Link.new(cite) # TODO Why not a select?
+          children << Philologic::Link.new(self, cite) # TODO Why not a select?
         end
         return children
       elsif !doc.css('div.philologic_concordance').first.nil?
         results = []
         doc.css('div.philologic_concordance').css('a.philologic_cite').each do |cite|
-          results << Philologic::Link.new(cite) # TODO Why not a select?
+          results << Philologic::Link.new(self, cite) # TODO Why not a select?
         end
         return results
       elsif !doc.css('div.philologic_object').first.nil?
@@ -191,7 +199,8 @@ module Philologic
   #
   class Link
 
-    def initialize(document)
+    def initialize(client, document)
+      @client     = client
       @doc        = document
       # TODO Prefer lazy initialization?
       @properties = {}
@@ -207,6 +216,12 @@ module Philologic
       @doc.attributes.key?(key) ? @doc.attributes[key].value : @properties[key]
     end
 
+    #
+    # Returns Philologic::Document referenced by this Philologic::Link object.
+    def document
+      @client.document( self['href'] )
+    end
+
   end # class Philologic::Link
 
 

data/test/test_philologic_client.rb

@@ -50,6 +50,18 @@ class TestPhilologicClient < Test::Unit::TestCase
     assert_equal    @endpoint, client.endpoint
   end
 
+  def test_encoding_accessor
+    Philologic::Client.new do |client|
+      assert_equal  'utf-8', client.encoding
+      assert_equal  'foo',   client.encoding = 'foo'
+      assert_equal  'foo',   client.encoding
+#
+#      assert_nil   client.endpoint,                        'defaults to nil'
+#      assert_equal @endpoint, client.endpoint = @endpoint, 'returns value on set'
+#      assert_equal @endpoint, client.endpoint,             'returns value on get'
+    end
+  end
+
   def test_endpoint_accessor
     Philologic::Client.new do |client|
       assert_nil   client.endpoint,                        'defaults to nil'
@@ -133,7 +145,7 @@ class TestPhilologicClient < Test::Unit::TestCase
     end
   end
 
-  def test_get_document_from_cite
+  def test_get_document_from_cite_through_client
     Philologic::Client.new do |client|
       client.endpoint = @endpoint
       child           = client.children(@root_path).first
@@ -145,6 +157,18 @@ class TestPhilologicClient < Test::Unit::TestCase
     end
   end
 
+  def test_get_document_from_cite
+    Philologic::Client.new do |client|
+      client.endpoint = @endpoint
+      child           = client.children(@root_path).first
+      assert_not_nil  child
+      assert_kind_of  Philologic::Link, child
+      doc = client.send( :_parse, Nokogiri::HTML( open(@doc_file) ) )
+      client.stubs(:_get).with('./1/0/0/0/0/0/0').returns(doc) # TODO Improve
+      assert_equal    doc, child.document
+    end
+  end
+
   def test_nil_search
     Philologic::Client.new(@endpoint) do |client|
       assert_raise(RuntimeError, 'no query specified') { client.search(nil) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: philologic-client
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-30 00:00:00.000000000Z
+date: 2012-01-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70149535209220 !ruby/object:Gem::Requirement
+  requirement: &70270934047440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70149535209220
+  version_requirements: *70270934047440
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70149535208780 !ruby/object:Gem::Requirement
+  requirement: &70270934047000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70149535208780
+  version_requirements: *70270934047000
 - !ruby/object:Gem::Dependency
   name: rdoc-readme
-  requirement: &70149535208360 !ruby/object:Gem::Requirement
+  requirement: &70270934046580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70149535208360
+  version_requirements: *70270934046580
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70149535207940 !ruby/object:Gem::Requirement
+  requirement: &70270934046160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70149535207940
+  version_requirements: *70270934046160
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70149535207520 !ruby/object:Gem::Requirement
+  requirement: &70270934045740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70149535207520
+  version_requirements: *70270934045740
 description: Ruby client for interacting with the Philologic API.
 email:
 - blair.christensen@gmail.com
@@ -99,7 +99,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2190975545106679734
+      hash: -2626252476221214395
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -108,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2190975545106679734
+      hash: -2626252476221214395
 requirements: []
 rubyforge_project: philologic-client
 rubygems_version: 1.8.7