alexandria-book-collection-manager 0.7.1 → 0.7.2

data/doc/alexandria.1

@@ -0,0 +1,120 @@
+.de URL
+\\$2 \(laURL: \\$1 \(ra\\$3
+..
+.if \n[.g] .mso www.tmac
+.TH ALEXANDRIA 1 "December 1, 2007" gnome "GNOME User's Manuals"
+.SH NAME
+alexandria \- a book collection manager
+
+.SH SYNOPSIS
+.B alexandria
+.I "[OPTIONS]"
+
+.SH DESCRIPTION
+.I Alexandria
+is a GNOME desktop application for managing book collections. It has a
+simple user interface which makes it easy to enter the details of your
+library, generally using Internet sources to find catalogue
+information for your books. It also enables you to create filtered
+views of your book collection based on details such as author,
+publisher etc.
+.LP
+When launched without any options the 
+.I Alexandria
+main window opens and presents a view of your libraries, or if run
+for the first time creates a new library ready for you to add books
+either manually or with the help of providers of book information on
+the Internet.
+
+.SH OPTIONS
+.B \-\-debug
+    Print verbose debug information describing the operation of the
+    program. Useful for determining behaviour when a problem is
+    encountered. This also sets the logger level to DEBUG.
+.LP
+.B \-\-version
+    Show program version information and exit.
+.LP
+.B \-\-help
+    Show summary of options and exit. This also shows a great many
+    predefined options common to all GTK programs which are not
+    defined in this manual page.
+
+.SH FILES
+.B $HOME/.alexandria
+    The per-user configuration of 
+.I Alexandria 
+    is stored in this directory. Each the books in each library are
+    stored in a sub-directory with the library's name e.g. `My
+    Library'. Book files are stored in YAML format (a text-based data
+    format). They are named after the book's ISBN
+    e.g. 9780755322800.yaml The cover images are also named after with
+    book's ISBN, with the file extension .cover, although they are
+    usually JPEG format files. If a book has no ISBN, it's ID will be
+    a number generated from the book title.
+.LP
+.B $HOME/.alexandria/.smart_libraries
+    Smart Libraries are a filtered view of your book collection, and
+    are saved as YAML format files in this directory.
+
+.SH ENVIRONMENT
+.B LOGLEVEL
+    Setting this environment variable affects the level at which
+    messages will be logged. The log levels are cumulative, setting
+    the level to log information messages means it will also include
+    all warnings and error messages. Possible values are:
+.RS
+.LP
+.B FATAL
+Only log messages for fatal errors.
+.LP
+.B ERROR
+Log messages for all errors.
+.LP
+.B WARN
+Log warnings and errors.
+.LP
+.B INFO
+Also include information messages.
+.LP
+.B DEBUG
+Log everything, including debug messages.
+.RE
+.LP
+    The default level is 
+.B WARN
+
+.SH BUGS
+Please report any bugs you find on the
+.URL "http://rubyforge.org/tracker/?group_id=205" "Tracker" " at RubyForge."
+Please check for any similar reports before reporting a new bug.
+.LP
+You can also discuss any problems you encounter with the 
+.I Alexandria
+developers and other users by joining the
+.URL "http://rubyforge.org/mailman/listinfo/alexandria-list" "alexandria-list" " mailing list."
+
+.SH WEB SITE
+News, details of the development team and further documentation may be
+found on the
+.URL "http://alexandria.rubyforge.org/" "Alexandria web site" "."
+
+.SH AUTHOR
+Alexandria was originally written by Laurent Sansonetti. The current
+maintainer is Joseph Method <tristil@gmail.com>. For a full list of
+contributors, see the file AUTHORS in Alexandria's documentation.
+.LP
+This manual page was written by Cathal Mc Ginley
+<cathal.alexandria@gnostai.org>.
+
+.SH COPYRIGHT
+Copyright (C) 2004-2006 Laurent Sansonetti
+.LP
+Copyright (C) 2007-2010 Alexandria Contributors
+
+.SH LICENSE
+.I 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.

data/doc/cuecat_support.rdoc

@@ -0,0 +1,67 @@
+= CueCat Barcode Scanner Support
+
+Alexandria now supports the use of unmodified CueCat barcode scanners
+for scanning ISBN barcodes.
+
+
+== What is a CueCat?
+
+The CueCat is a wand-style barcode scanner, available with either a
+PS/2 keyboard connector (and a PS/2 keyboard pass-through), or with a
+standard keyboard-type USB connector. 
+
+You scan a barcode by placing the 'nose' of the scanner on one side of
+the barcode, in the clear area before the first black bar, and waiting
+until the flashing red light stops flashing and illuminates the
+surface brightly, then swiftly passing the scanner across the barcode
+and into the clear area on the far side. The scan data is then input
+into your computer as if through a keyboard. You can test the
+operation of your CueCat by placing your keyboard cursor inside any
+text editor and scanning a barcode.
+
+By default the scan data is scrambled. There are instructions, widely
+available on the Internet, detailing how to modify the circuit board to
+disable scrambling, but some barcode scanning applications, including
+Alexandria, can automatically decode scrambled data from a CueCat.
+
+
+== The History of CueCat?
+
+Millions of CueCat scanners were distributed free of charge by their
+creator the Digital Convergence Corporation in the late 1990s and
+early 2000s. The intention was that customers would use the scanners
+to scan special barcodes in magazine advertisments and articles, and
+software would take the customers to a related web page.
+
+Dozens of eager hackers, upon recieving these barcode scanners,
+immediately set about finding a way to use them for a wider variety of
+purposes, such as book cataloging. They decoded the very simple
+scrambling of the scanner output data (it was a form of Base64
+encoding), and even reported on how to lift a single microchip pin to
+circumvent the scrambling in hardware. They also discovered that each
+CueCat has a unique serial number (which could have allowed
+DigitalConvergence to build up profiles of the products customers were
+interested in) and showed how to zero-out or avoid the serial number.
+
+Digital Convergence attempted to restrict such activities, but
+eventually the company went bust, leaving several electronics
+warehouses to buy up hundreds of thousands of unshipped CueCats in the
+ensuing liquidation sale.
+
+Today, PS/2 and USB CueCat scanners are available cheaply over the
+internet (about US$12 in 2007). Apart from the slight inconvenience
+caused by the data scrambling, they are eminently usable as cheap,
+robust, wand-style barcode scanners.
+
+== The Old Linux Driver
+
+A kernel driver for the CueCat was developed as a patch for the 2.4
+Linux kernel series. This provided decoding of the scrambled input,
+and made input data available from <tt>/dev/scanners/cuecat</tt>.
+
+Since this driver is currently unmaintained and does not work with 2.6
+kernels, support for this has been dropped from Alexandria. However,
+since Alexandria 0.6.2, there is so-called 'userland' support for the
+CueCat, which simply means that modifications to the kernel are not
+necessary. Instead, the decoding of the simple data scrambling is done
+by the application software.

data/doc/dependency_decisions.yml

@@ -0,0 +1,61 @@
+---
+- - :whitelist
+  - LGPL-3+
+  - :who: 
+    :why: 
+    :versions: []
+    :when: 2017-07-23 05:51:53.629753437 Z
+- - :whitelist
+  - LGPL-2.1+
+  - :who: 
+    :why: 
+    :versions: []
+    :when: 2017-07-23 05:52:02.088395832 Z
+- - :whitelist
+  - MIT
+  - :who: 
+    :why: 
+    :versions: []
+    :when: 2017-07-23 05:52:06.806192042 Z
+- - :whitelist
+  - LGPLv2+
+  - :who: 
+    :why: 
+    :versions: []
+    :when: 2017-07-23 05:52:24.618189811 Z
+- - :whitelist
+  - ruby
+  - :who: 
+    :why: 
+    :versions: []
+    :when: 2017-07-23 05:52:36.986497403 Z
+- - :approve
+  - alexandria-book-collection-manager
+  - :who: 
+    :why: 
+    :versions: []
+    :when: 2017-07-23 05:53:02.657760962 Z
+- - :approve
+  - unf
+  - :who: 
+    :why: 
+    :versions: []
+    :when: 2017-07-23 05:54:45.171526986 Z
+- - :approve
+  - gettext
+  - :who: 
+    :why: 
+    :versions: []
+    :when: 2017-07-23 05:54:51.349832715 Z
+- - :approve
+  - cairo
+  - :who: 
+    :why: 
+    :versions: []
+    :when: 2017-07-23 05:54:54.822319735 Z
+- - :approve
+  - zoom
+  - :who: 
+    :why: Actually licensed under LGPL-2.1
+    :versions: []
+    :when: 2017-07-23 06:00:43.594558953 Z

data/lib/alexandria.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (C) 2004-2006 Laurent Sansonetti
 # Copyright (C) 2011, 2016 Matijs van Zuijlen
 #

data/lib/alexandria/about.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 # Copyright (C) 2004-2006 Laurent Sansonetti
 # Copyright (C) 2008 Joseph Method
 # Copyright (C) 2015 Matijs van Zuijlen
@@ -19,13 +20,13 @@
 # Fifth Floor, Boston, MA 02110-1301 USA.
 
 module Alexandria
-  TITLE = 'Alexandria'.freeze
-  TEXTDOMAIN = 'alexandria'.freeze
+  TITLE = 'Alexandria'
+  TEXTDOMAIN = 'alexandria'
   extend GetText
   bindtextdomain(Alexandria::TEXTDOMAIN, charset: 'UTF-8')
   DESCRIPTION = _('A program to help you manage your book collection.')
   COPYRIGHT = "Copyright (C) 2004-2006 Laurent Sansonetti\n" \
-    'Copyright (C) 2007-2010,2014,2015 Alexandria Contributors'.freeze
+    'Copyright (C) 2007-2010,2014,2015 Alexandria Contributors'
   AUTHORS = [
     'Alexander McCormmach <alexander@tunicate.org>',
     'Aymeric Nys <aymeric@nnx.com>',
@@ -77,6 +78,6 @@ module Alexandria
     'Andreas Nilsson <nisses.mail@home.se>',
     'Stefanie Dijoux <stefanie.dijoux@gmail.com>'
   ].freeze
-  BUGREPORT_URL = 'http://www.github.com/mvz/alexandria-book-collection-manager/issues'.freeze
-  WEBSITE_URL = 'http://www.github.com/mvz/alexandria-book-collection-manager'.freeze
+  BUGREPORT_URL = 'http://www.github.com/mvz/alexandria-book-collection-manager/issues'
+  WEBSITE_URL = 'http://www.github.com/mvz/alexandria-book-collection-manager'
 end

data/lib/alexandria/book_providers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (C) 2004-2006 Laurent Sansonetti
 # Copyright (C) 2009 Cathal Mc Ginley
 # Copyright (C) 2011, 2014 Matijs van Zuijlen
@@ -89,8 +91,8 @@ module Alexandria
                         'expired.') % factory.name
 
                     when SocketError
-                      _("Couldn't reach the provider '%s': socket " \
-                        'error (%s).') % [factory.name, boom.message]
+                      format(_("Couldn't reach the provider '%s': socket " \
+                        'error (%s).'), factory.name, boom.message)
 
                     when NoResultsError
                       _('No results were found.  Make sure your ' \
@@ -273,6 +275,7 @@ module Alexandria
         fullname <=> provider.fullname
       end
 
+      # FIXME: Clean up this complex abstract/concrete class system
       def self.unabstract
         include Singleton
         undef_method :reinitialize
@@ -289,11 +292,8 @@ module Alexandria
     require 'alexandria/book_providers/mcu' # yep, still mostly works !
     require 'alexandria/book_providers/douban' # only requires YAML
 
-    # require 'alexandria/book_providers/ibs_it'
     # require 'alexandria/book_providers/renaud'
-    # require 'alexandria/book_providers/bol_it'
-    # require 'alexandria/book_providers/webster_it'
-    log.info { 'Not loading IBS, Renaud, BOL, Webster (providers not functional)' }
+    log.info { 'Not loading Renaud (provider not functional)' }
 
     # Amazon AWS (Amazon Associates Web Services) provider, needs hpricot
     require 'alexandria/book_providers/amazon_aws'

data/lib/alexandria/book_providers/adlibris.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -*- ruby -*-
 #
 # Copyright (C) 2009 Cathal Mc Ginley
@@ -33,12 +35,12 @@ module Alexandria
     class AdLibrisProvider < WebsiteBasedProvider
       include Alexandria::Logging
 
-      SITE = 'http://www.adlibris.com/se/'.freeze
+      SITE = 'http://www.adlibris.com/se/'
 
       BASE_SEARCH_URL = "#{SITE}searchresult.aspx?search=advanced&%s=%s" \
-        '&fromproduct=False'.freeze # type/term
+        '&fromproduct=False' # type/term
 
-      PRODUCT_URL = "#{SITE}product.aspx?isbn=%s".freeze
+      PRODUCT_URL = "#{SITE}product.aspx?isbn=%s"
 
       def initialize
         super('AdLibris', 'AdLibris (Sweden)')
@@ -82,7 +84,7 @@ module Alexandria
             SEARCH_BY_KEYWORD => 'keyword'
           }[search_type]) || 'keyword'
           search_term_encoded = CGI.escape(search_term)
-          BASE_SEARCH_URL % [search_type_code, search_term_encoded]
+          format(BASE_SEARCH_URL, search_type_code, search_term_encoded)
         end
       end
 
@@ -142,7 +144,6 @@ module Alexandria
         # doc = Hpricot(html)
         doc = html_to_doc(html)
         begin
-
           title = nil
           if (h1 = doc.at('div.productTitleFormat h1'))
             title = text_of(h1)
@@ -169,17 +170,13 @@ module Alexandria
           binding = nil
           if (format = doc.search('div.productTitleFormat span').first)
             binding = text_of(format)
-            if binding =~ /\(([^\)]+)\)/
-              binding = Regexp.last_match[1]
-            end
+            binding = Regexp.last_match[1] if binding =~ /\(([^\)]+)\)/
           end
 
           year = nil
           if (published = product.search('span[@id$="Published"]').first)
             publication = published.inner_text
-            if publication =~ /([12][0-9]{3})/
-              year = Regexp.last_match[1].to_i
-            end
+            year = Regexp.last_match[1].to_i if publication =~ /([12][0-9]{3})/
           end
 
           isbns = []
@@ -189,9 +186,7 @@ module Alexandria
             isbn = isbn_td.inner_text
             next unless isbn =~ /[0-9x]{10,13}/i
             isbn.gsub(/(\n|\r)/, ' ')
-            if isbn =~ /:[\s]*([0-9x]+)/i
-              isbn = Regexp.last_match[1]
-            end
+            isbn = Regexp.last_match[1] if isbn =~ /:[\s]*([0-9x]+)/i
             isbns << isbn
           end
           isbn = isbns.first

data/lib/alexandria/book_providers/amazon_aws.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (C) 2004-2006 Laurent Sansonetti
 # Copyright (C) 2008 Cathal Mc Ginley
 # Copyright (C) 2014, 2016 Matijs van Zuijlen
@@ -46,29 +48,19 @@ module Alexandria
         # kill old (shorter) tokens, or previously distributed Access Key Id (see #26250)
 
         if token
-          if token.value != token.value.strip
-            token.new_value = token.value.strip
-          end
-        end
-        if token && ((token.value.size != 20) || (token.value == '0J356Z09CN88KB743582'))
-          token.new_value = ''
+          token.new_value = token.value.strip if token.value != token.value.strip
         end
+        token.new_value = '' if token && ((token.value.size != 20) || (token.value == '0J356Z09CN88KB743582'))
 
         secret = prefs.variable_named('secret_key')
         if secret
-          if secret.value != secret.value.strip
-            secret.new_value = secret.value.strip
-          end
+          secret.new_value = secret.value.strip if secret.value != secret.value.strip
         end
 
         associate = prefs.variable_named('associate_tag')
         if associate
-          if associate.value.strip.empty?
-            associate.new_value = 'rubyalexa-20'
-          end
-          if associate.value != associate.value.strip
-            associate.new_value = associate.value.strip
-          end
+          associate.new_value = 'rubyalexa-20' if associate.value.strip.empty?
+          associate.new_value = associate.value.strip if associate.value != associate.value.strip
         end
       end
 
@@ -76,7 +68,9 @@ module Alexandria
         prefs.read
 
         if prefs['secret_key'].empty?
-          raise Amazon::RequestError, 'Secret Access Key required for Authentication: you must sign up for your own Amazon AWS account'
+          raise(Amazon::RequestError,
+                'Secret Access Key required for Authentication:' \
+                ' you must sign up for your own Amazon AWS account')
         end
 
         if (config = Alexandria::Preferences.instance.http_proxy_config)
@@ -105,7 +99,8 @@ module Alexandria
           when SEARCH_BY_ISBN
             criterion = Library.canonicalise_isbn(criterion)
             # This isn't ideal : I'd like to do an ISBN/EAN-specific search
-            res = Amazon::Ecs.item_search(criterion, response_group: 'ItemAttributes,Images', country: request_locale)
+            res = Amazon::Ecs.item_search(criterion, response_group: 'ItemAttributes,Images',
+                                                     country: request_locale)
             res.items.each do |item|
               products << item
             end
@@ -125,29 +120,36 @@ module Alexandria
             # result with different ISBNs
 
             if products.length > 1
-              log.warn { "ISBN search at Amazon[#{request_locale}] got #{products.length} results; returning the first result only" }
+              log.warn {
+                "ISBN search at Amazon[#{request_locale}] got #{products.length} results;" \
+                ' returning the first result only'
+              }
             end
 
           when SEARCH_BY_TITLE
-            res = Amazon::Ecs.item_search(criterion, response_group: 'ItemAttributes,Images', country: request_locale)
+            res = Amazon::Ecs.item_search(criterion,
+                                          response_group: 'ItemAttributes,Images',
+                                          country: request_locale)
 
             res.items.each do |item|
-              if item.get('itemattributes/title') =~ /#{criterion}/i
-                products << item
-              end
+              products << item if item.get('itemattributes/title') =~ /#{criterion}/i
             end
             # #req.keyword_search(criterion) do |product|
 
           when SEARCH_BY_AUTHORS
             criterion = "author:#{criterion}"
-            res = Amazon::Ecs.item_search(criterion, response_group: 'ItemAttributes,Images', country: request_locale, type: 'Power')
+            res = Amazon::Ecs.item_search(criterion,
+                                          response_group: 'ItemAttributes,Images',
+                                          country: request_locale, type: 'Power')
             res.items.each do |item|
               products << item
             end
             # #req.author_search(criterion) do |product|
 
           when SEARCH_BY_KEYWORD
-            res = Amazon::Ecs.item_search(criterion, response_group: 'ItemAttributes,Images', country: request_locale)
+            res = Amazon::Ecs.item_search(criterion,
+                                          response_group: 'ItemAttributes,Images',
+                                          country: request_locale)
 
             res.items.each do |item|
               products << item
@@ -156,9 +158,7 @@ module Alexandria
           else
             raise InvalidSearchTypeError
           end
-          if products.empty?
-            raise Amazon::RequestError, 'No products'
-          end
+          raise Amazon::RequestError, 'No products' if products.empty?
           # raise NoResultsError if products.empty?
         rescue Amazon::RequestError => re
           log.debug { "Got Amazon::RequestError at #{request_locale}: #{re}" }
@@ -176,9 +176,7 @@ module Alexandria
           media = nil if media == 'Unknown Binding'
 
           isbn = normalize(atts.get('isbn'))
-          isbn = if isbn && Library.valid_isbn?(isbn)
-                   Library.canonicalise_ean(isbn)
-                 end
+          isbn = (Library.canonicalise_ean(isbn) if isbn && Library.valid_isbn?(isbn))
           # hack, extract year by regexp (not Y10K compatible :-)
           /([1-9][0-9]{3})/ =~ atts.get('publicationdate')
           publishing_year = Regexp.last_match[1] ? Regexp.last_match[1].to_i : nil
@@ -202,9 +200,7 @@ module Alexandria
             results.each do |rslt|
               book = rslt[0]
               book_isbn_canon = Library.canonicalise_ean(book.isbn)
-              if query_isbn_canon == book_isbn_canon
-                return rslt
-              end
+              return rslt if query_isbn_canon == book_isbn_canon
               log.debug { "rejected possible result #{book}" }
             end
             # gone through all and no ISBN match, so just return first result