alexandria-book-collection-manager 0.7.1 → 0.7.6

data/Rakefile

@@ -1,79 +1,58 @@
-# -*- ruby -*-
-#--
-# Copyright (C) 2009 Cathal Mc Ginley
-# Copyright (C) 2011, 2014, 2016 Matijs van Zuijlen
-#
+# frozen_string_literal: true
+
 # This file is part of the Alexandria build system.
 #
-# Permission is hereby granted, free of charge, to any person obtaining
-# a copy of this software and associated documentation files (the
-# "Software"), to deal in the Software without restriction, including
-# without limitation the rights to use, copy, modify, merge, publish,
-# distribute, sublicense, and/or sell copies of the Software, and to
-# permit persons to whom the Software is furnished to do so, subject to
-# the following conditions:
-#
-# The above copyright notice and this permission notice shall be
-# included in all copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-#++
+# See the file README.md for authorship and licensing information.
 
-load 'tasks/setup.rb'
+load "tasks/setup.rb"
 
-require 'rake/packagetask'
+require "rake/packagetask"
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'util/rake'))
-require 'fileinstall'
-require 'gettextgenerate'
-require 'omfgenerate'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "util/rake"))
+require "fileinstall"
+require "gettextgenerate"
+require "omfgenerate"
 
-require_relative 'lib/alexandria/version'
+require_relative "lib/alexandria/version"
 
-stage_dir = ENV['DESTDIR'] || 'tmp'
-prefix_dir = ENV['PREFIX'] || '/usr'
+stage_dir = ENV["DESTDIR"] || "tmp"
+prefix_dir = ENV["PREFIX"] || "/usr"
 
-PROJECT = 'alexandria'.freeze
+PROJECT = "alexandria"
 PREFIX = prefix_dir
-share_dir = ENV['SHARE'] || "#{PREFIX}/share"
+share_dir = ENV["SHARE"] || "#{PREFIX}/share"
 SHARE = share_dir
 
 GettextGenerateTask.new(PROJECT) do |g|
-  g.generate_po_files('po', 'po/*.po', 'share/locale')
-  g.generate_desktop('alexandria.desktop.in', 'alexandria.desktop')
+  g.generate_po_files("po", "po/*.po", "share/locale")
+  g.generate_desktop("alexandria.desktop.in", "alexandria.desktop")
 end
 
 OmfGenerateTask.new(PROJECT) do |o|
   o.gnome_helpfiles_dir = "#{SHARE}/gnome/help"
-  o.generate_omf('data/omf/alexandria', 'share/omf/alexandria/*.in')
+  o.generate_omf("data/omf/alexandria", "share/omf/alexandria/*.in")
 end
 
-SHARE_FILE_GLOBS = ['data/alexandria/**/*', 'data/gnome/**/*.*',
-                    'data/locale/**/*.mo', 'data/omf/**/*.omf',
-                    'data/sounds/**/*.ogg'].freeze # , 'data/menu/*']
+SHARE_FILE_GLOBS = ["data/alexandria/**/*", "data/gnome/**/*.*",
+                    "data/locale/**/*.mo", "data/omf/**/*.omf",
+                    "data/sounds/**/*.ogg"].freeze # , 'data/menu/*']
 
-ICON_FILE_GLOBS = ['data/app-icon/**/*.png',
-                   'data/app-icon/scalable/*.svg'].freeze
+ICON_FILE_GLOBS = ["data/app-icon/**/*.png",
+                   "data/app-icon/scalable/*.svg"].freeze
 
-PIXMAP_GLOBS = 'data/app-icon/32x32/*.xpm'.freeze
+PIXMAP_GLOBS = "data/app-icon/32x32/*.xpm"
 
 def install_common(install_task)
-  install_task.install_exe('bin', 'bin/*', "#{PREFIX}/bin")
-  install_task.install('lib', 'lib/**/*.rb', install_task.rubylib)
+  install_task.install_exe("bin", "bin/*", "#{PREFIX}/bin")
+  install_task.install("lib", "lib/**/*.rb", install_task.rubylib)
 
-  install_task.install('data', SHARE_FILE_GLOBS, SHARE)
+  install_task.install("data", SHARE_FILE_GLOBS, SHARE)
   install_task.install_icons(ICON_FILE_GLOBS, "#{SHARE}/icons")
-  install_task.install('data/app-icon/32x32', PIXMAP_GLOBS, "#{SHARE}/pixmaps")
+  install_task.install("data/app-icon/32x32", PIXMAP_GLOBS, "#{SHARE}/pixmaps")
 
-  install_task.install('', 'schemas/alexandria.schemas', "#{SHARE}/gconf")
-  install_task.install('', 'alexandria.desktop', "#{SHARE}/applications")
-  install_task.install('doc', 'doc/alexandria.1', "#{SHARE}/man/man1")
+  install_task.install("", "schemas/alexandria.schemas", "#{SHARE}/gconf")
+  install_task.install("", "alexandria.desktop", "#{SHARE}/applications")
+  install_task.install("doc", "doc/alexandria.1", "#{SHARE}/man/man1")
 end
 
 FileInstallTask.new(:package_staging, stage_dir, true) do |i|
@@ -85,11 +64,11 @@ task debian_install: :install_package_staging
 FileInstallTask.new(:package) do |j|
   install_common(j)
 
-  docs = %w(README.rdoc NEWS INSTALL.rdoc COPYING TODO.md)
-  devel_docs = ['doc/AUTHORS', 'doc/BUGS', 'doc/FAQ',
-                'doc/cuecat_support.rdoc']
-  j.install('', docs, "#{SHARE}/doc/#{PROJECT}")
-  j.install('doc', devel_docs, "#{SHARE}/doc/#{PROJECT}")
+  docs = %w(README.rdoc CHANGELOG.md INSTALL.md COPYING TODO.md)
+  devel_docs = ["doc/AUTHORS", "doc/BUGS", "doc/FAQ",
+                "doc/cuecat_support.rdoc"]
+  j.install("", docs, "#{SHARE}/doc/#{PROJECT}")
+  j.install("doc", devel_docs, "#{SHARE}/doc/#{PROJECT}")
 
   j.uninstall_empty_dirs(["#{SHARE}/**/#{PROJECT}/",
                           "#{j.rubylib}/#{PROJECT}/"])
@@ -104,14 +83,14 @@ end
 def autogen_comment
   lines = [
     "This file is automatically generated by the #{PROJECT} installer.",
-    'Do not edit it directly.'
+    "Do not edit it directly."
   ]
   result = lines.map { |line| "# #{line}" }
   result.join("\n") + "\n\n"
 end
 
 def generate(filename)
-  File.open(filename, 'w') do |file|
+  File.open(filename, "w") do |file|
     puts "Generating #{filename}"
     file.print autogen_comment
     file_contents = yield
@@ -122,69 +101,75 @@ end
 # generate default_preferences.rb
 def convert_with_type(value, type)
   case type
-  when 'int'
+  when "int"
     value.to_i
-  when 'float'
+  when "float"
     value.to_f
-  when 'bool'
-    value == 'true'
+  when "bool"
+    value == "true"
+  when "string"
+    value.to_s.strip
   else
-    value.strip
+    raise NotImplementedError, "Unknown type #{type}"
   end
 end
 
-SCHEMA_PATH = 'schemas/alexandria.schemas'.freeze
+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|
-  require 'rexml/document'
+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
-
-    if (type == 'list') || (type == 'pair')
-      ary = default[1..-2].split(',')
+  doc.elements.each("gconfschemafile/schemalist/schema") do |element|
+    default = element.elements["default"].text
+
+    varname = File.basename(element.elements["key"].text)
+    type = element.elements["type"].text
+
+    if (type == "list") || (type == "pair")
+      ary = default[1..-2].split(",")
       next if ary.empty?
-      if type == 'list'
-        list_type = element.elements['list_type'].text
+
+      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],
-                                   element.elements['car_type'].text)
+                                   element.elements["car_type"].text)
         ary[1] = convert_with_type(ary[1],
-                                   element.elements['cdr_type'].text)
+                                   element.elements["cdr_type"].text)
       end
       default = ary.inspect
     else
       default = convert_with_type(default, type).inspect.to_s
     end
 
-    generated_lines << varname.inspect + ' => ' + default
+    generated_lines << varname.inspect + " => " + default
   end
 
   generate(f.name) do
-    <<EOS
-module Alexandria
-  class Preferences
-    DEFAULT_VALUES = {#{generated_lines.join(",\n      ")}}
-  end
-end
-EOS
+    <<~EOS
+      module Alexandria
+        class Preferences
+          DEFAULT_VALUES = {
+            #{generated_lines.join(",\n      ")}
+          }
+        end
+      end
+    EOS
   end
 end
 
-autogenerated_files = ['lib/alexandria/config.rb',
-                       'lib/alexandria/default_preferences.rb']
+autogenerated_files = ["lib/alexandria/default_preferences.rb"]
 
-desc 'Generate ruby files needed for the installation'
+desc "Generate ruby files needed for the installation"
 task autogen: autogenerated_files
 
 task :autogen_clobber do |_t|
@@ -213,13 +198,13 @@ end
 
 Rake::PackageTask.new(PROJECT, Alexandria::DISPLAY_VERSION) do |p|
   p.need_tar_gz = true
-  p.package_files.include('README*', 'COPYING', 'CHANGELOG.md', 'INSTALL.rdoc',
-                          'NEWS', 'Rakefile', 'util/**/*',
-                          'TODO.md', 'alexandria.desktop',
-                          'alexandria.desktop.in',
-                          'bin/**/*', 'data/**/*', 'misc/**/*',
-                          'doc/**/*', 'lib/**/*', 'po/**/*',
-                          'schemas/**/*', 'spec/**/*')
+  p.package_files.include("README.md", "COPYING", "CHANGELOG.md", "INSTALL.md",
+                          "Rakefile", "util/**/*",
+                          "TODO.md", "alexandria.desktop",
+                          "alexandria.desktop.in",
+                          "bin/**/*", "data/**/*", "misc/**/*",
+                          "doc/**/*", "lib/**/*", "po/**/*",
+                          "schemas/**/*", "spec/**/*")
 end
 
 task tgz: [:build] do
@@ -230,36 +215,37 @@ end
 
 task pre_install: [:build]
 task :scrollkeeper do
-  unless system('which scrollkeeper-update')
-    raise 'scrollkeeper-update cannot be found, is Scrollkeeper correctly installed?'
+  unless system("which scrollkeeper-update")
+    raise "scrollkeeper-update cannot be found, is Scrollkeeper correctly installed?"
   end
-  system('scrollkeeper-update -q') || raise('Scrollkeeper update failed')
+
+  system("scrollkeeper-update -q") || raise("Scrollkeeper update failed")
 end
 
 task :gconf do
-  return if ENV['GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL']
+  return if ENV["GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL"]
 
-  unless system('which gconftool-2')
-    raise 'gconftool-2 cannot be found, is GConf2 correctly installed?'
+  unless system("which gconftool-2")
+    raise "gconftool-2 cannot be found, is GConf2 correctly installed?"
   end
 
-  ENV['GCONF_CONFIG_SOURCE'] = `gconftool-2 --get-default-source`.chomp
-  Dir['schemas/*.schemas'].each do |schema|
+  ENV["GCONF_CONFIG_SOURCE"] = `gconftool-2 --get-default-source`.chomp
+  Dir["schemas/*.schemas"].each do |schema|
     system("gconftool-2 --makefile-install-rule '#{schema}'")
   end
   # system("killall -HUP gconfd-2")
 end
 
 task :update_icon_cache do
-  system('gtk-update-icon-cache -f -t /usr/share/icons/hicolor') # HACK
+  system("gtk-update-icon-cache -f -t /usr/share/icons/hicolor") # HACK
 end
 
 task post_install: [:scrollkeeper, :gconf, :update_icon_cache]
 
-desc 'Install Alexandria'
+desc "Install Alexandria"
 task install: [:pre_install, :install_package, :post_install]
 
-desc 'Uninstall Alexandria'
+desc "Uninstall Alexandria"
 task uninstall: [:uninstall_package] # TODO: gconf etc...
 
-task default: [:spec, :dogtail]
+task default: [:spec]

data/TODO.md

@@ -1,7 +1,15 @@
 Alexandria's TODO list
 ======================
 
-This is an old list of TODO's.
+## New TODOs
+
+* [ ] Clean up broken providers
+* [ ] Add openlibrary provider
+* [ ] Allow searching for cover image for existing books
+
+## Old TODOs
+
+This is an old list of TODO's that should be cleaned up.
 
 For the next release:
 

data/alexandria-book-collection-manager.gemspec

@@ -1,61 +1,68 @@
-# -*- encoding: utf-8 -*-
-require_relative 'lib/alexandria/version'
+# frozen_string_literal: true
+
+require_relative "lib/alexandria/version"
 
 Gem::Specification.new do |s|
-  s.name = 'alexandria-book-collection-manager'
+  s.name = "alexandria-book-collection-manager"
   s.version = Alexandria::VERSION
 
-  s.summary = 'GNOME application for managing collections of books'
-  s.required_ruby_version = '>= 1.9.3'
+  s.summary = "GNOME application for managing collections of books"
+  s.required_ruby_version = ">= 2.5.0"
 
   s.authors = [
-    'Alexander McCormmach',
-    'Aymeric Nys',
-    'Cathal Mc Ginley',
-    'Claudio Belotti',
-    'Constantine Evans',
-    'Dafydd Harries',
-    'Javier Fernandez-Sanguino Pena',
-    'Joseph Method',
-    'Kevin Schultz',
-    'Laurent Sansonetti',
-    'Marco Costantini',
-    'Mathieu Leduc-Hamel',
-    'Matijs van Zuijlen',
-    'Owain Evans',
-    'Pascal Terjan',
-    'Rene Samselnig',
-    'Robby Stephenson',
-    'Sun Ning',
-    'Takayuki Kusano',
-    'Timothy Malone',
-    'Zachary P. Landau'
+    "Alexander McCormmach",
+    "Aymeric Nys",
+    "Cathal Mc Ginley",
+    "Claudio Belotti",
+    "Constantine Evans",
+    "Dafydd Harries",
+    "Javier Fernandez-Sanguino Pena",
+    "Joseph Method",
+    "Kevin Schultz",
+    "Laurent Sansonetti",
+    "Marco Costantini",
+    "Mathieu Leduc-Hamel",
+    "Matijs van Zuijlen",
+    "Owain Evans",
+    "Pascal Terjan",
+    "Rene Samselnig",
+    "Robby Stephenson",
+    "Sun Ning",
+    "Takayuki Kusano",
+    "Timothy Malone",
+    "Zachary P. Landau"
   ]
-  s.email = ['matijs@matijs.net']
-  s.homepage = 'http://www.github.com/mvz/alexandria-book-collection-manager'
+  s.email = ["matijs@matijs.net"]
+  s.homepage = "http://www.github.com/mvz/alexandria-book-collection-manager"
 
-  s.license = 'GPL-2'
+  s.license = "GPL-2"
 
   s.files = `git ls-files -z`.split("\0") |
-    ['lib/alexandria/default_preferences.rb']
+    ["lib/alexandria/default_preferences.rb"]
 
-  s.executables = ['alexandria']
+  s.executables = ["alexandria"]
 
-  s.rdoc_options = ['--main', 'README.md']
+  s.rdoc_options = ["--main", "README.md"]
 
-  s.add_runtime_dependency('gettext', ['~> 3.1'])
-  s.add_runtime_dependency('hpricot', ['~> 0.8.5'])
-  s.add_runtime_dependency('htmlentities', ['~> 4.3'])
-  s.add_runtime_dependency('gtk3', ['~> 3.1.0'])
-  s.add_runtime_dependency('gio2', ['~> 3.1.0'])
-  s.add_runtime_dependency('gstreamer', ['~> 3.0'])
-  s.add_runtime_dependency('image_size', ['~> 1.5.0'])
-  s.add_runtime_dependency('marc', ['~> 1.0.0'])
-  s.add_runtime_dependency('zoom', ['~> 0.5.0'])
+  s.add_runtime_dependency("gettext", ["~> 3.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.2.0"])
+  s.add_runtime_dependency("zoom", ["~> 0.5.0"])
 
-  s.add_development_dependency('minitest', ['~> 5.0'])
-  s.add_development_dependency('rake', ['~> 12.0'])
-  s.add_development_dependency('rspec', ['~> 3.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']
+  s.require_paths = ["lib"]
 end