alexandria-book-collection-manager 0.7.3 → 0.7.8

data/lib/alexandria/book_providers.rb

@@ -19,8 +19,8 @@
 # write to the Free Software Foundation, Inc., 51 Franklin Street,
 # Fifth Floor, Boston, MA 02110-1301 USA.
 
-require 'singleton'
-require 'observer'
+require "singleton"
+require "observer"
 
 module Alexandria
   # FIXME: Use delegation instead of inheritance.
@@ -29,27 +29,28 @@ module Alexandria
     include Singleton
     include Observable
     include GetText
-    GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: 'UTF-8')
+    GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: "UTF-8")
 
     SEARCH_BY_ISBN, SEARCH_BY_TITLE, SEARCH_BY_AUTHORS,
     SEARCH_BY_KEYWORD = (0..3).to_a
 
     class SearchError < StandardError; end
     class NoResultsError < SearchError; end
-    class ProviderSkippedError < NoResultsError; end # not an error :^(
-    class SearchEmptyError < SearchError; end # sigh, again not really an error
     class TooManyResultsError < SearchError; end
     class InvalidSearchTypeError < SearchError; end
 
+    # These errors are not really errors
+    class ProviderSkippedError < NoResultsError; end
+    class SearchEmptyError < SearchError; end
+
     def self.search(criterion, type)
       factory_n = 0
-      # puts "book_providers search #{self.instance.count_observers}"
 
       begin
         factory = instance[factory_n]
-        puts factory.fullname + ' lookup' if $DEBUG
+        log.debug { factory.fullname + " lookup" }
         unless factory.enabled
-          puts factory.fullname + ' disabled!, skipping...' if $DEBUG
+          log.debug { factory.fullname + " disabled!, skipping..." }
           raise ProviderSkippedError
         end
         instance.changed
@@ -64,14 +65,14 @@ module Alexandria
           instance.notify_observers(:not_found, factory.fullname) # new
           raise NoResultsError
         else
-          log.info { 'found at ' + factory.fullname }
+          log.info { "found at " + factory.fullname }
           instance.changed
           instance.notify_observers(:found, factory.fullname) # new
-          return results
+          results
         end
-      rescue StandardError => boom
-        if boom.is_a? NoResultsError
-          unless boom.instance_of? ProviderSkippedError
+      rescue StandardError => ex
+        if ex.is_a? NoResultsError
+          unless ex.instance_of? ProviderSkippedError
             instance.changed
             instance.notify_observers(:not_found, factory.fullname) # new
             Thread.new { sleep(0.5) }.join
@@ -80,41 +81,41 @@ module Alexandria
           instance.changed
           instance.notify_observers(:error, factory.fullname) # new
           Thread.new { sleep(0.5) }.join # hrmmmm, to make readable...
-          trace = boom.backtrace.join("\n >")
-          log.warn { "Provider #{factory.name} encountered error: #{boom.message} #{trace}" }
+          trace = ex.backtrace.join("\n >")
+          log.warn { "Provider #{factory.name} encountered error: #{ex.message} #{trace}" }
         end
-        if last == factory
+        if factory == instance.last
           log.warn { "Error while searching #{criterion}" }
-          message = case boom
+          message = case ex
                     when Timeout::Error
                       _("Couldn't reach the provider '%s': timeout " \
-                        'expired.') % factory.name
+                        "expired.") % factory.name
 
                     when SocketError
                       format(_("Couldn't reach the provider '%s': socket " \
-                        'error (%s).'), factory.name, boom.message)
+                        "error (%s)."), factory.name, ex.message)
 
                     when NoResultsError
-                      _('No results were found.  Make sure your ' \
-                        'search criterion is spelled correctly, and ' \
-                        'try again.')
+                      _("No results were found.  Make sure your " \
+                        "search criterion is spelled correctly, and " \
+                        "try again.")
 
                     when ProviderSkippedError
-                      _('No results were found.  Make sure your ' \
-                        'search criterion is spelled correctly, and ' \
-                        'try again.')
+                      _("No results were found.  Make sure your " \
+                        "search criterion is spelled correctly, and " \
+                        "try again.")
 
                     when TooManyResultsError
-                      _('Too many results for that search.')
+                      _("Too many results for that search.")
 
                     when InvalidSearchTypeError
-                      _('Invalid search type.')
+                      _("Invalid search type.")
 
                     else
-                      boom.message
+                      ex.message
                     end
-          puts "raising empty error #{message}"
-          raise SearchEmptyError, message
+          log.debug { "raising empty error #{message}" }
+          raise SearchEmptyError, message # rubocop:disable GetText/DecorateFunctionMessage
         else
           factory_n += 1
           retry
@@ -152,9 +153,8 @@ module Alexandria
         end
 
         def new_value=(new_value)
-          message = @provider.variable_name(self) + '='
-          Alexandria::Preferences.instance.send(message,
-                                                new_value)
+          name = @provider.variable_name(self)
+          Alexandria::Preferences.instance.set_variable(name, new_value)
           self.value = new_value
         end
 
@@ -187,9 +187,9 @@ module Alexandria
 
       def read
         each do |var|
-          message = @provider.variable_name(var)
-          val = Alexandria::Preferences.instance.send(message)
-          var.value = val unless val.nil? || ((val == '') && var.mandatory?)
+          name = @provider.variable_name(var)
+          val = Alexandria::Preferences.instance.get_variable(name)
+          var.value = val unless val.nil? || ((val == "") && var.mandatory?)
         end
       end
     end
@@ -203,35 +203,35 @@ module Alexandria
         @name = name
         @fullname = (fullname || name)
         @prefs = Preferences.new(self)
-        @prefs.add('enabled', _('Enabled'), true, [true, false])
+        @prefs.add("enabled", _("Enabled"), true, [true, false])
       end
 
       def enabled
-        @prefs['enabled']
+        @prefs["enabled"]
       end
 
       def toggle_enabled
         old_value = enabled
-        @prefs.variable_named('enabled').new_value = !old_value
+        @prefs.variable_named("enabled").new_value = !old_value
       end
 
       def reinitialize(fullname)
-        @name << '_' << fullname.hash.to_s
+        @name = "#{name}_#{fullname.hash}"
         @fullname = fullname
         prefs = Alexandria::Preferences.instance
-        ary = prefs.abstract_providers
+        ary = prefs.get_variable :abstract_providers
         ary ||= []
         ary << @name
-        prefs.abstract_providers = ary
-        message = variable_name('name') + '='
-        prefs.send(message, @fullname)
+        prefs.set_variable :abstract_providers, ary
+        message = variable_name("name")
+        prefs.set_variable(message, @fullname)
       end
 
       def remove
         prefs = Alexandria::Preferences.instance
-        if (ary = prefs.abstract_providers)
+        if (ary = prefs.get_variable :abstract_providers)
           ary.delete(@name)
-          prefs.abstract_providers = ary
+          prefs.set_variable :abstract_providers, ary
         end
         if (ary = prefs.providers_priority) && ary.include?(@name)
           ary.delete(@name)
@@ -241,7 +241,7 @@ module Alexandria
           name = variable_name(variable)
           prefs.remove_preference(name)
         end
-        name = variable_name('name')
+        name = variable_name("name")
         prefs.remove_preference(name)
         prefs.save!
       end
@@ -255,7 +255,7 @@ module Alexandria
             else
               raise
             end
-        @name.downcase + '_' + s
+        @name.downcase + "_" + s
       end
 
       def transport
@@ -271,8 +271,8 @@ module Alexandria
         !included_modules.include?(Singleton)
       end
 
-      def <=>(provider)
-        fullname <=> provider.fullname
+      def <=>(other)
+        fullname <=> other.fullname
       end
 
       # FIXME: Clean up this complex abstract/concrete class system
@@ -289,24 +289,21 @@ module Alexandria
       unabstract
     end
 
-    require 'alexandria/book_providers/douban' # only requires YAML
-
-    # require 'alexandria/book_providers/renaud'
-    log.info { 'Not loading Renaud (provider not functional)' }
+    require "alexandria/book_providers/douban" # only requires YAML
 
     # Amazon AWS (Amazon Associates Web Services) provider, needs hpricot
-    require 'alexandria/book_providers/amazon_aws'
+    require "alexandria/book_providers/amazon_aws"
 
     # Website based providers
-    require 'alexandria/book_providers/adlibris'
-    require 'alexandria/book_providers/barnes_and_noble'
-    require 'alexandria/book_providers/proxis'
-    require 'alexandria/book_providers/siciliano'
-    require 'alexandria/book_providers/thalia'
-    require 'alexandria/book_providers/worldcat'
+    require "alexandria/book_providers/adlibris"
+    require "alexandria/book_providers/barnes_and_noble"
+    require "alexandria/book_providers/proxis"
+    require "alexandria/book_providers/siciliano"
+    require "alexandria/book_providers/thalia_provider"
+    require "alexandria/book_providers/worldcat"
 
     # Z39.50 based providers
-    require 'alexandria/book_providers/z3950'
+    require "alexandria/book_providers/z3950"
 
     attr_reader :abstract_classes
 
@@ -328,10 +325,9 @@ module Alexandria
         next unless md
 
         klass = self.class.module_eval(constant.to_s)
-        if klass.ancestors.include?(AbstractProvider) &&
+        if klass < AbstractProvider &&
             (klass != GenericProvider) &&
-            (klass != WebsiteBasedProvider) &&
-            (klass != AbstractProvider)
+            (klass != WebsiteBasedProvider)
 
           if klass.abstract?
             @abstract_classes << klass
@@ -340,16 +336,16 @@ module Alexandria
           end
         end
       end
-      if (ary = @prefs.abstract_providers)
+      if (ary = @prefs.get_variable :abstract_providers)
         ary.each do |name|
           md = /^(.+)_/.match(name)
           next unless md
 
-          klass_name = md[1] + 'Provider'
+          klass_name = md[1] + "Provider"
           klass = @abstract_classes.find { |x| x.name.include?(klass_name) }
           next unless klass
 
-          fullname = @prefs.send(name.downcase + '_name')
+          fullname = @prefs.send(name.downcase + "_name")
           next unless fullname
 
           instance = klass.new
@@ -369,37 +365,36 @@ module Alexandria
       compact!
     end
 
-    # FIXME: Define the handful of methods that use this.
-    def self.method_missing(id, *args, &block)
-      if instance.respond_to? id
-        instance.method(id).call(*args, &block)
-      else
-        super
-      end
+    def self.list
+      instance
+    end
+
+    def self.abstract_classes
+      instance.abstract_classes
     end
 
     private
 
     def rejig_providers_priority
       priority = (@prefs.providers_priority || [])
-      unless priority.empty?
-        changed = false
+      return if priority.empty?
 
-        if (ecs_index = priority.index('AmazonECS'))
-          priority[ecs_index] = 'Amazon' # replace legacy "AmazonECS" name
-          priority.uniq! # remove any other "Amazon" from the list
-          changed = true
-        end
-        if (worldcat_index = priority.index('Worldcat'))
-          priority[worldcat_index] = 'WorldCat'
-          changed = true
-        end
-        if (adlibris_index = priority.index('Adlibris'))
-          priority[adlibris_index] = 'AdLibris'
-          changed = true
-        end
-        @prefs.providers_priority = priority if changed
+      changed = false
+
+      if (ecs_index = priority.index("AmazonECS"))
+        priority[ecs_index] = "Amazon" # replace legacy "AmazonECS" name
+        priority.uniq! # remove any other "Amazon" from the list
+        changed = true
+      end
+      if (worldcat_index = priority.index("Worldcat"))
+        priority[worldcat_index] = "WorldCat"
+        changed = true
+      end
+      if (adlibris_index = priority.index("Adlibris"))
+        priority[adlibris_index] = "AdLibris"
+        changed = true
       end
+      @prefs.providers_priority = priority if changed
     end
   end
 end

data/lib/alexandria/book_providers/adlibris.rb

@@ -1,24 +1,8 @@
 # frozen_string_literal: true
 
-# -*- ruby -*-
+# This file is part of Alexandria.
 #
-# Copyright (C) 2009 Cathal Mc Ginley
-# Copyright (C) 2014 Matijs van Zuijlen
-#
-# Alexandria is free software; you can redistribute it and/or
-# modify it under the terms of the GNU General Public License as
-# published by the Free Software Foundation; either version 2 of the
-# License, or (at your option) any later version.
-#
-# Alexandria is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# General Public License for more details.
-#
-# You should have received a copy of the GNU General Public
-# License along with Alexandria; see the file COPYING.  If not,
-# write to the Free Software Foundation, Inc., 51 Franklin Street,
-# Fifth Floor, Boston, MA 02110-1301 USA.
+# See the file README.md for authorship and licensing information.
 
 # AdLibris  Bokhandel AB http://www.adlibris.com/se/
 # Swedish online book store
@@ -27,23 +11,23 @@
 # modified to fit the structure of Alexandria book providers.
 # (26 Feb 2009)
 
-require 'cgi'
-require 'alexandria/book_providers/web'
+require "cgi"
+require "alexandria/book_providers/web"
 
 module Alexandria
   class BookProviders
     class AdLibrisProvider < WebsiteBasedProvider
-      include Alexandria::Logging
+      include Logging
 
-      SITE = 'http://www.adlibris.com/se/'
+      SITE = "http://www.adlibris.com/se/"
 
       BASE_SEARCH_URL = "#{SITE}searchresult.aspx?search=advanced&%s=%s" \
-        '&fromproduct=False' # type/term
+        "&fromproduct=False" # type/term
 
       PRODUCT_URL = "#{SITE}product.aspx?isbn=%s"
 
       def initialize
-        super('AdLibris', 'AdLibris (Sweden)')
+        super("AdLibris", "AdLibris (Sweden)")
         prefs.read
         # @ent = HTMLEntities.new
       end
@@ -79,10 +63,10 @@ module Alexandria
           PRODUCT_URL % Library.canonicalise_isbn(search_term)
         else
           (search_type_code = {
-            SEARCH_BY_AUTHORS => 'author',
-            SEARCH_BY_TITLE   => 'title',
-            SEARCH_BY_KEYWORD => 'keyword'
-          }[search_type]) || 'keyword'
+            SEARCH_BY_AUTHORS => "author",
+            SEARCH_BY_TITLE   => "title",
+            SEARCH_BY_KEYWORD => "keyword"
+          }[search_type]) || "keyword"
           search_term_encoded = CGI.escape(search_term)
           format(BASE_SEARCH_URL, search_type_code, search_term_encoded)
         end
@@ -97,20 +81,17 @@ module Alexandria
       end
 
       def parse_search_result_data(html)
-        # adlibris site presents data in ISO-8859-1, so change it to UTF-8
-        # html = Iconv.conv("UTF-8", "ISO-8859-1", html)
-        # doc = Hpricot(html)
         doc = html_to_doc(html)
         book_search_results = []
 
         search_hit = doc.search("div'searchResult")[0]
         return [] unless search_hit
 
-        (search_hit / 'ul.ulSearch table').each do |t|
+        (search_hit / "ul.ulSearch table").each do |t|
           result = {}
-          if (title_data = (t % 'div.divTitle'))
+          if (title_data = (t % "div.divTitle"))
             result[:title] = (title_data % :a).inner_text
-            lookup_url = (title_data % :a)['href']
+            lookup_url = (title_data % :a)["href"]
           end
           result[:lookup_url] = "#{SITE}#{lookup_url}"
 
@@ -119,45 +100,25 @@ module Alexandria
         book_search_results
       end
 
-      # def binding_type(binding) # swedish string
-      #  # hrm, this is a HACK and not currently working
-      #  # perhaps use regexes instead...
-      #  {"inbunden" => :hardback,
-      #    "pocket" => :paperback,
-      #    "storpocket" => :paperback,
-      #    "kartonnage" => :hardback,
-      #    "kassettbok" => :audiobook}[binding.downcase] or :paperback
-      #  # H&#228;ftad == Paperback
-      # end
-
       def normalize(text)
-        # unless text.nil?
-        #  text = @ent.decode(text).strip
-        # end
         text
       end
 
       def parse_result_data(html)
-        # adlibris site presents data in ISO-8859-1, so change it to UTF-8
-        # html = Iconv.conv("UTF-8", "ISO-8859-1", html)
-        ## File.open(',log.html', 'wb') {|f| f.write('<?xml encoding="utf-8"?>'); f.write(html) } # DEBUG
-        # doc = Hpricot(html)
         doc = html_to_doc(html)
         begin
-          title = nil
-          if (h1 = doc.at('div.productTitleFormat h1'))
-            title = text_of(h1)
-          else
-            raise NoResultsError, 'title not found on page'
-          end
+          h1 = doc.at("div.productTitleFormat h1")
+          raise NoResultsError, _("title not found on page") unless h1
+
+          title = text_of(h1)
 
-          product = doc.at('div.product')
-          ul_info = doc.at('ul.info') # NOTE, two of these
+          product = doc.at("div.product")
+          ul_info = doc.at("ul.info") # NOTE, two of these
 
-          author_cells = ul_info.search('li.liAuthor') # css-like search
+          author_cells = ul_info.search("li.liAuthor") # css-like search
           authors = []
           author_cells.each do |li|
-            author_name = text_of(li.search('h2 > a')[0])
+            author_name = text_of(li.search("h2 > a")[0])
 
             authors << author_name
           end
@@ -168,9 +129,9 @@ module Alexandria
           end
 
           binding = nil
-          if (format = doc.search('div.productTitleFormat span').first)
+          if (format = doc.search("div.productTitleFormat span").first)
             binding = text_of(format)
-            binding = Regexp.last_match[1] if binding =~ /\(([^\)]+)\)/
+            binding = Regexp.last_match[1] if binding =~ /\(([^)]+)\)/
           end
 
           year = nil
@@ -186,8 +147,8 @@ module Alexandria
             isbn = isbn_td.inner_text
             next unless isbn =~ /[0-9x]{10,13}/i
 
-            isbn.gsub(/(\n|\r)/, ' ')
-            isbn = Regexp.last_match[1] if isbn =~ /:[\s]*([0-9x]+)/i
+            isbn.gsub(/(\n|\r)/, " ")
+            isbn = Regexp.last_match[1] if isbn =~ /:\s*([0-9x]+)/i
             isbns << isbn
           end
           isbn = isbns.first
@@ -195,13 +156,15 @@ module Alexandria
 
           # cover
           image_url = nil
-          if (cover_img = doc.search('span.imageWithShadow img[@id$="ProductImageNotLinked"]').first)
-            image_url = if cover_img['src'] =~ /^http\:\/\//
-                          cover_img['src']
+          cover_img =
+            doc.search('span.imageWithShadow img[@id$="ProductImageNotLinked"]').first
+          if cover_img
+            image_url = if cover_img["src"].start_with?("http://")
+                          cover_img["src"]
                         else
                           "#{SITE}/#{cover_img['src']}" # HACK: use html base
                         end
-            if image_url =~ /noimage.gif$/
+            if /noimage.gif$/.match?(image_url)
               # no point downloading a "no image" graphic
               # Alexandria has its own generic book icon...
               image_url = nil
@@ -211,15 +174,15 @@ module Alexandria
 
           book = Book.new(title, authors, isbn, publisher, year, binding)
 
-          return [book, image_url]
+          [book, image_url]
         rescue StandardError => ex
           raise ex if ex.instance_of? NoResultsError
 
           trace = ex.backtrace.join("\n> ")
-          log.warn {
-            'Failed parsing search results for AdLibris ' \
+          log.warn do
+            "Failed parsing search results for AdLibris " \
             "#{ex.message} #{trace}"
-          }
+          end
           raise NoResultsError
         end
       end