alexandria-book-collection-manager 0.7.5 → 0.7.6

data/.simplecov

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 SimpleCov.start do
-  track_files 'lib/**/*.rb'
-  add_filter '/spec/'
+  add_group "Main", "lib"
+  add_group "Specs", "spec"
+  enable_coverage :branch
 end

data/.travis.yml

@@ -29,10 +29,16 @@ before_install:
 cache:
   bundler: true
 
-rvm:
-  - 2.5
-  - 2.6
-  - 2.7
+script: bundle exec rake
+
+jobs:
+  include:
+    - rvm: 2.5
+    - rvm: 2.6
+    - rvm: 2.7
+    - rvm: 2.7.1
+      name: "RuboCop"
+      script: bundle exec rubocop
 
 branches:
   only:

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 0.7.6 / 2020-11-01
+
+* Make more strings translatable with help from rubocop-i18n
+* Code quality and testing infrastructure improvements
+* Update Polish translation ([#51] and [#64], by [Piotr Drąg][piotrdrag])
+* Update Dutch translation
+* Make several dialogs that stopped appearing appear again
+* Remove ability to enable and disable providers through a pop-up menu
+* Fix New Library functionality
+* Update dependencies on gtk3, gstreamer, and psych
+* Fix issues in preferences, smart library dialog, and book selection
+* Improve installation instructions
+* Improve README ([#83] by [Happy][HappyFacade])
+
 ## 0.7.5 / 2020-05-11
 
 * Avoid crash when opening Import dialog
@@ -82,7 +96,12 @@
 
 <!-- contributors -->
 [jrmhaig]: https://github.com/jrmhaig
+[piotrdrag]: https://github.com/piotrdrag
+[HappyFacade]: https://github.com/HappyFacade
 
 <!-- issues and pull requests -->
+[#83]: https://github.com/mvz/alexandria-book-collection-manager/pull/83
+[#64]: https://github.com/mvz/alexandria-book-collection-manager/pull/64
+[#51]: https://github.com/mvz/alexandria-book-collection-manager/pull/51
 [#23]: https://github.com/mvz/alexandria-book-collection-manager/pull/23
 [#19]: https://github.com/mvz/alexandria-book-collection-manager/issues/19

data/INSTALL.md

@@ -56,23 +56,35 @@ to merge translations into generated files (and to extract
 translatable string from xml files during development).
 
 Note that these files are pre-generated in tar.gz releases, so you'll
-only need them if you're building from the SVN version, or want to
+only need them if you're building from the Git version, or want to
 change the translations.
 
+For support of the Z38.50 protocol you will need the
+[`yaz`](http://www.indexdata.dk/yaz) package.
+
+Alexandria also uses the outdate gconf2 configuration storage system, so you'll
+need to install `gconf2`.
+
+On Debian/Ubuntu systems, you can install the needed dependencies by running
+
+```
+apt-get install gettext intltool libyaz-dev gconf2
+```
+
 ### Ruby/ZOOM and Yaz
 
-For Z39.50 support and and the *Library of Congress* and
-*British Library* book providers you will need
-[`ruby-zoom`](http://ruby-zoom.rubyforge.org), which in turn
-requires the non-Ruby package [`yaz`](http://www.indexdata.dk/yaz).
+For Z39.50 support and the *Library of Congress* and *British Library* book
+providers you will need [`ruby-zoom`](http://ruby-zoom.rubyforge.org), which in
+turn requires the non-Ruby package [`yaz`](http://www.indexdata.dk/yaz) (see
+Native Dependencies above).
 
-Note that if you install the recent Ruby/ZOOM as the `zoom` gem, you
-will also need to install the `marc` gem. (Older implementations of
-ruby-zoom contained their own implementation of MARC.)
+Note that if you install the recent Ruby/ZOOM as the `zoom` gem, you will also
+need to install the `marc` gem. (Older implementations of ruby-zoom contained
+their own implementation of MARC.)
 
-The Z39.50 Object-Orientation Model (ZOOM) is an international
-standard for communication between computer systems, particularly
-libraries and information-related systems.
+The Z39.50 Object-Orientation Model (ZOOM) is an international standard for
+communication between computer systems, particularly libraries and
+information-related systems.
 
 ### image_size
 

data/README.md

@@ -4,7 +4,7 @@ Alexandria is a GNOME application for managing collections of books.
 
 Alexandria is written in Ruby, and is free software, distributed under
 the terms of the GNU General Public License, version 2 or later. See
-the file COPYING for more information.
+the file [COPYING](COPYING) for more information.
 
 What is Alexandria?
 ===================
@@ -39,49 +39,50 @@ Alexandria is a simple program designed to allow individuals to keep a
 catalogue of their book collection. In addition, it enables users to
 keep track of books which are on loan.
 
-    * retrieves and displays book information (sometimes with cover
-      pictures) from several online libraries and bookshops, such as
-          o Amazon
-          o Proxis
-          o AdLibris
-          o Spanish Ministry of Culture
-          o Livraria Siciliano
-          o WorldCat
-          o US Library of Congress
-          o British Library
-    * allows books to be added and updated by hand
-    * enables searches either by ISBN, title, author or keyword
-    * supports the Z39.50 standard and allow you to manage your own
-      sources (e.g. university libraries)
-    * saves data using the plain-text YAML format
-    * can import and export data into ONIX, Tellico, ISBN-list
-      and GoodReads CSV formats
-    * can export XHTML web pages of your libraries, themable with CSS
-    * allows marking your books as loaned, each with the loan-date and
-      the name of the person who has borrowed them
-    * features a HIG-compliant user interface
-    * shows books in different views (standard list or icons list),
-      that can be filtered and/or sorted
-    * handles book rating and notes
-    * supports CueCat and standard "keyboard wedge" barcode readers
-    * includes translations for several languages
-    * is documented in a complete manual (at the moment only in
-      English and Japanese)
-
-Alexandria is not without problems. See doc/BUGS for a summary of issues.
+* retrieves and displays book information (sometimes with cover
+  pictures) from several online libraries and bookshops, such as
+   - Amazon
+   - Proxis
+   - AdLibris
+   - Spanish Ministry of Culture
+   - Livraria Siciliano
+   - WorldCat
+   - US Library of Congress
+   - British Library
+* allows books to be added and updated by hand
+* enables searches either by ISBN, title, author or keyword
+* supports the Z39.50 standard and allow you to manage your own
+  sources (e.g. university libraries)
+* saves data using the plain-text YAML format
+* can import and export data into ONIX, Tellico, ISBN-list
+  and GoodReads CSV formats
+* can export XHTML web pages of your libraries, themable with CSS
+* allows marking your books as loaned, each with the loan-date and
+  the name of the person who has borrowed them
+* features a HIG-compliant user interface
+* shows books in different views (standard list or icons list),
+  that can be filtered and/or sorted
+* handles book rating and notes
+* supports CueCat and standard "keyboard wedge" barcode readers
+* includes translations for several languages
+* is documented in a complete manual (at the moment only in
+  English and Japanese)
+
+Alexandria is not without problems. See [doc/BUGS](doc/BUGS) for a
+summary of issues.
 
 ## Installation
 
 There are full instructions for installing Alexandria from source in the
-file INSTALL, including information about all the dependencies.
+file [INSTALL](INSTALL), including information about all the dependencies.
 
 If you are installing on a Debian-based system, things should be
 easier as the dependencies can be handled automatically.
 
 To run the program, just type
-    alexandria
+    `alexandria`
 or, to get verbose debugging information,
-    alexandria --debug
+    `alexandria --debug`
 
 If you are running GNOME, Alexandria should appear under the
 'Applications > Office' menu.
@@ -166,4 +167,4 @@ Copyright (C) 2005-2010,2014-2020 Alexandria Contributors
 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. See the file COPYING for details.
+version. See the file [COPYING](COPYING) for details.

data/Rakefile

@@ -107,8 +107,10 @@ def convert_with_type(value, type)
     value.to_f
   when "bool"
     value == "true"
+  when "string"
+    value.to_s.strip
   else
-    value.strip
+    raise NotImplementedError, "Unknown type #{type}"
   end
 end
 
@@ -117,14 +119,13 @@ SCHEMA_PATH = "schemas/alexandria.schemas"
 # This generates default_preferences.rb by copying over values from
 # providers_priority key in alexandria.schemas (necessary?)
 
-file "lib/alexandria/default_preferences.rb" => [SCHEMA_PATH] do |f|
+file "lib/alexandria/default_preferences.rb" => ["Rakefile", SCHEMA_PATH] do |f|
   require "rexml/document"
   generated_lines = []
 
   doc = REXML::Document.new(IO.read(SCHEMA_PATH))
   doc.elements.each("gconfschemafile/schemalist/schema") do |element|
     default = element.elements["default"].text
-    next unless default
 
     varname = File.basename(element.elements["key"].text)
     type = element.elements["type"].text
@@ -133,10 +134,11 @@ file "lib/alexandria/default_preferences.rb" => [SCHEMA_PATH] do |f|
       ary = default[1..-2].split(",")
       next if ary.empty?
 
-      if type == "list"
+      case type
+      when "list"
         list_type = element.elements["list_type"].text
         ary.map! { |x| convert_with_type(x, list_type) }
-      elsif type == "pair"
+      when "pair"
         next if ary.length != 2
 
         ary[0] = convert_with_type(ary[0],

data/alexandria-book-collection-manager.gemspec

@@ -45,19 +45,24 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--main", "README.md"]
 
   s.add_runtime_dependency("gettext", ["~> 3.1"])
-  s.add_runtime_dependency("gstreamer", ["~> 3.4.1"])
-  s.add_runtime_dependency("gtk3", ["~> 3.4.1"])
+  s.add_runtime_dependency("gstreamer", ["~> 3.4.3"])
+  s.add_runtime_dependency("gtk3", ["~> 3.4.3"])
   s.add_runtime_dependency("hpricot", ["~> 0.8.5"])
   s.add_runtime_dependency("htmlentities", ["~> 4.3"])
   s.add_runtime_dependency("image_size", ["~> 2.0"])
   s.add_runtime_dependency("marc", ["~> 1.0.0"])
-  s.add_runtime_dependency("psych", ["~> 3.1.0"])
+  s.add_runtime_dependency("psych", ["~> 3.2.0"])
   s.add_runtime_dependency("zoom", ["~> 0.5.0"])
 
   s.add_development_dependency("gnome_app_driver", ["~> 0.2.1"])
   s.add_development_dependency("minitest", ["~> 5.0"])
   s.add_development_dependency("rake", ["~> 13.0"])
   s.add_development_dependency("rspec", ["~> 3.0"])
+  s.add_development_dependency("rubocop", "~> 0.93.1")
+  s.add_development_dependency("rubocop-i18n", ["~> 2.0.2"])
+  s.add_development_dependency("rubocop-performance", ["~> 1.8.0"])
+  s.add_development_dependency("rubocop-rspec", "~> 1.44.1")
+  s.add_development_dependency("webmock", "~> 3.9")
 
   s.require_paths = ["lib"]
 end

data/doc/dependency_decisions.yml

@@ -53,9 +53,28 @@
     :why: 
     :versions: []
     :when: 2017-07-23 05:54:54.822319735 Z
-- - :approve
+- - :license
   - zoom
+  - LGPL-2.1
+  - :who: 
+    :why: 
+    :versions: []
+    :when: 2020-07-30 06:44:22.960902375 Z
+- - :permit
+  - Simplified BSD
+  - :who: 
+    :why: 
+    :versions: []
+    :when: 2020-07-30 06:45:58.599399721 Z
+- - :permit
+  - Apache 2.0
   - :who: 
-    :why: Actually licensed under LGPL-2.1
+    :why: 
+    :versions: []
+    :when: 2020-07-30 06:46:08.280121582 Z
+- - :permit
+  - LGPL-2.1
+  - :who: 
+    :why: 
     :versions: []
-    :when: 2017-07-23 06:00:43.594558953 Z
+    :when: 2020-07-30 06:46:32.729325577 Z

data/lib/alexandria.rb

@@ -28,8 +28,8 @@ module Alexandria
   end
 
   def self.set_log_level
-    Alexandria.log.level = Logger::DEBUG if $DEBUG
-    Alexandria.log.debug { "Initializing Alexandria..." }
+    log.level = Logger::DEBUG if $DEBUG
+    log.debug { "Initializing Alexandria" }
   end
 
   def self.main

data/lib/alexandria/book_providers.rb

@@ -36,20 +36,21 @@ module Alexandria
 
     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
@@ -83,7 +84,7 @@ module Alexandria
           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 ex
                     when Timeout::Error
@@ -113,8 +114,8 @@ module Alexandria
                     else
                       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,8 +187,8 @@ module Alexandria
 
       def read
         each do |var|
-          message = @provider.variable_name(var)
-          val = Alexandria::Preferences.instance.send(message)
+          name = @provider.variable_name(var)
+          val = Alexandria::Preferences.instance.get_variable(name)
           var.value = val unless val.nil? || ((val == "") && var.mandatory?)
         end
       end
@@ -216,22 +216,22 @@ module Alexandria
       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)
@@ -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
@@ -325,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
@@ -337,7 +336,7 @@ 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
@@ -366,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