update comments and specs for new ONIX::Reader new() arguments

* passing product class as the second argument is now deprecated
* the second argument to ONIX::Reader is now an optional options Hash
* the product class should now be specified using the :product_class option
* this change was motivated by the need for an :encoding option

Author: yob

lib/onix/reader.rb

@@ -25,7 +25,7 @@ module ONIX
   # in a shim that provides simple accessor access to common attributes, pass the
   # shim class as a second argument
   #
-  #   reader = ONIX::Reader.new("somefile.xml", ONIX::APAProduct)
+  #   reader = ONIX::Reader.new("somefile.xml", :product_class => ONIX::APAProduct)
   #
   #   puts reader.header.inspect
   #
@@ -39,7 +39,7 @@ module ONIX
   # As well as accessing the file header, there are handful of other read only
   # attributes that might be useful
   #
-  #   reader = ONIX::Reader.new("somefile.xml", ONIX::APAProduct)
+  #   reader = ONIX::Reader.new("somefile.xml")
   #
   #   puts reader.version
   #   puts reader.xml_lang
@@ -62,7 +62,7 @@ module ONIX
   # If the encoding declaration is missing or wrong and the file isn't UTF-8,
   # you can manually set or override it like so:
   #
-  #   reader = ONIX::Reader.new("somefile.xml", ONIX::APAProduct, :encoding => "iso-8859-1")
+  #   reader = ONIX::Reader.new("somefile.xml", :encoding => "iso-8859-1")
   #
   # If the file contains invalid bytes for the source encoding an exception will
   # be raised. This isn't ideal, but I'm still looking for ways to make this
@@ -73,18 +73,22 @@ class Reader
 
     attr_reader :header, :release
 
-    def initialize(input, product_klass = nil, options = {})
+    def initialize(input, *args)
+      opts = args.last.kind_of?(Hash) ? args.pop : {}
+      if args.size > 0
+        ActiveSupport::Deprecation.warn("Passing a klass as ONIX::Reader's second argument is deprecated, use the :product_class option instead", caller)
+      end
+      @product_klass = opts[:product_class] || args.pop || ::ONIX::Product
+
       if input.kind_of?(String)
         @file   = File.open(input, "r")
-        @reader = Nokogiri::XML::Reader(@file, nil, options[:encoding]) { |cfg| cfg.dtdload.noent }
+        @reader = Nokogiri::XML::Reader(@file, nil, opts[:encoding]) { |cfg| cfg.dtdload.noent }
       elsif input.kind_of?(IO)
-        @reader = Nokogiri::XML::Reader(input, nil, options[:encoding]) { |cfg| cfg.dtdload.noent }
+        @reader = Nokogiri::XML::Reader(input, nil, opts[:encoding]) { |cfg| cfg.dtdload.noent }
       else
         raise ArgumentError, "Unable to read from file or IO stream"
       end
 
-      @product_klass = product_klass || ::ONIX::Product
-
       @release = find_release
       @header = find_header
 

spec/reader_spec.rb

@@ -112,7 +112,7 @@
   end
 
   it "should transparently convert an iso-8859-1 file to utf-8 when there's no declaration but the user manually specifies iso-8859-1" do
-    reader = ONIX::Reader.new(@no_encoding_decl_file, nil, :encoding => "iso-8859-1")
+    reader = ONIX::Reader.new(@no_encoding_decl_file, :encoding => "iso-8859-1")
     reader.each do |product|
       if RUBY_VERSION >= "1.9"
         utf8 = Encoding.find("utf-8")
@@ -138,4 +138,18 @@
 
     product.contributors[0].person_name_inverted.should eql("Küng, Hans")
   end
+
+  it "should support returning an APAProduct using deprecated API" do
+    reader = ONIX::Reader.new(@file1, ONIX::APAProduct)
+    reader.each do |product|
+      product.should be_a_kind_of(ONIX::APAProduct)
+    end
+  end
+
+  it "should support returning an APAProduct using new API" do
+    reader = ONIX::Reader.new(@file1, :product_class => ONIX::APAProduct)
+    reader.each do |product|
+      product.should be_a_kind_of(ONIX::APAProduct)
+    end
+  end
 end