alexandria-book-collection-manager 0.7.1 → 0.7.2

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.7.2 / 2018-03-18
+
+* Update dependencies
+* Various code cleanups
+
 ## 0.7.1 / 2016-12-13
 
 * Various code cleanups

data/ChangeLog.0

@@ -1,38 +1,36 @@
-alexandria (0.6.2) unstable; urgency=low
-
- * Revision of the Italian translation
- * Added anonymous patch
- * [#11170] cuecat userland support:
- - http://rubyforge.org/tracker/index.php?func=detail&aid=11170&group_id=205&atid=865
- - I don't have a cuecat, and I don't know whether this patch is OK.
-
- -- Marco Costantini <costanti@science.unitn.it> Mon, 18 Jun 2007 18:28:55 -0400
-
- * Updated providers Worldcat and bol.it
-
- -- Marco Costantini <costanti@science.unitn.it> Fri, 27 Apr
-
-
- * CSV list export:
-  - the file has extension "csv"
-  - fixed in case that authors is [] or elements are missing
- * ONIX export:
-  - removed an unnecessary .to_s
-  - removed use of CGI.escapeHTML, whch is unnecessary
-  - fixed in case that ISBN is missing
- * BibTeX export:
-  - fixed in case that authors is [] or elements are missing
-  - exported also book.publishing_year
- * HTML export:
-  - added meta "Author", "Description", "Keywords"
- * Tellico export:
-  - added info on wether the book has been read or loaned
- * Tellico import:
-  - imported notes
-
- -- 2007-04-06 Marco Costantini <costanti@science.unitn.it>
-
- 2007-02-24 to 2007-04-02 Marco Costantini <costanti@science.unitn.it>
+2007-06-18 Marco Costantini <costanti@science.unitn.it>
+
+	* Revision of the Italian translation
+	* Added anonymous patch
+	* [#11170] cuecat userland support
+	  http://rubyforge.org/tracker/index.php?func=detail&aid=11170&group_id=205&atid=865
+	  I don't have a cuecat, and I don't know whether this patch is OK.
+
+2007-04-27 Marco Costantini <costanti@science.unitn.it>
+
+	* Updated providers Worldcat and bol.it
+
+2007-04-06 Marco Costantini <costanti@science.unitn.it>
+
+	* CSV list export:
+	  - the file has extension "csv"
+	  - fixed in case that authors is [] or elements are missing
+	* ONIX export:
+	  - removed an unnecessary .to_s
+	  - removed use of CGI.escapeHTML, whch is unnecessary
+	  - fixed in case that ISBN is missing
+	* BibTeX export:
+	  - fixed in case that authors is [] or elements are missing
+	  - exported also book.publishing_year
+	* HTML export:
+	  - added meta "Author", "Description", "Keywords"
+	* Tellico export:
+	  - added info on wether the book has been read or loaned
+	* Tellico import:
+	  - imported notes
+
+
+2007-02-24 to 2007-04-02 Marco Costantini <costanti@science.unitn.it>
 
 	* added new Z39.50 provider "Servizio Bibliotecario Nazionale (Italy)"
 	* added the FAQ

data/Gemfile

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # The gem's dependencies are specified in the gemspec
 gemspec
 
 group :development, :test do
-  gem 'pry'
-  gem 'rubocop', '~> 0.46.0'
   gem 'simplecov'
   gem 'yard', '~> 0.9.5'
 end

data/INSTALL.md

@@ -0,0 +1,152 @@
+# Installing Alexandria
+
+Alexandria is written in Ruby with a GTK+3/GNOME user-interface. It
+currently only runs on UNIX-style systems, such as GNU/Linux.
+
+Alexandria is not an easy project to build from scratch. Apart from
+Ruby and GNOME, it has a lot of dependencies. Once the dependencies have been
+installed, however, building and installing Alexandria is relatively
+straightforward.
+
+## Dependencies
+
+The [Ruby-GNOME2](http://ruby-gnome2.sourceforge.jp/) user-interface
+involves a number of packages:
+
+* `gtk3`
+* `gio2`
+* `gstreamer`
+
+You should have GTK+ 3, and use Ruby-GNOME2 `~> 3.1.0`.
+
+[`ruby-gettext`](http://ruby-gettext.github.io/)
+is required for the internationalisation of the user interface.
+Requires version `~> 3.1`.
+
+### Hpricot
+
+Alexandria uses [hpricot](https://github.com/hpricot/hpricot) to
+parse the HTML from web pages for providers such as DeaStore and
+Siciliano. It is also used to parse the XML for the Amazon web
+service.
+
+## HTMLEntities
+
+This is used by all website-based providers except MCU.
+[htmlentities](https://github.com/threedaymonk/htmlentities) is used to
+provide more flexible HTML parsing.
+
+## Build Dependencies
+
+### Ruby Dependencies
+
+[`rake`](https://github.com/ruby/rake) is required to build Alexandria from
+the project `Rakefile`.
+
+You also need [`rubygems`](http://www.rubygems.org/) and
+[`rspec`](http://rspec.rubyforge.org/) to run the RSpec test suite.
+
+### Native Dependencies
+
+The [`gettext`](http://www.gnu.org/software/gettext) package is needed
+to generate the binary `mo` files used by `ruby-gettext` at
+runtime. You also need the
+[`intltool`](http://www.freedesktop.org/wiki/Software/intltool) package
+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
+change the translations.
+
+### 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).
+
+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.
+
+### image_size
+
+You will need
+[`image_size`](https://github.com/toy/image_size) for
+optimizing the cover images in exported libraries.
+
+## Installing Alexandria
+
+After installing all the non-Ruby dependencies, you should be able to install alexandria using
+
+    gem install alexandria-book-collection-manager
+
+## Installing from Source
+
+**These instructions are outdated and you should for now install alexandria as a gem**
+
+To build Alexandria from a git checkout, go to the base project
+directory (where the Rakefile and this INSTALL file are located) and
+issue the command
+
+    rake build
+
+If you have downloaded a source package, this step will not usually be
+necessary.
+
+You must have root priveledges to install, so use `su`
+    su -c 'rake install'
+or `sudo`
+    sudo rake install
+
+Now you can check the version of the installed Alexandria
+    alexandria --version
+
+To launch Alexandria, simply use
+    alexandria
+
+If you wish to see more output on the console, you can use
+    alexandria --debug
+
+### Staged installation for making packages
+
+When building a binary package (such as a deb or rpm) you will want to
+"install" Alexandria into a specified directory instead of the root
+filesystem. You should specify this as the DESTDIR environment variable
+and use the `install_package_staging` task instead of `install`
+
+    DESTDIR=debian/alexandria rake install_package_staging
+
+If your distribution uses a specific directory to install Ruby
+packages, you should also set the RUBYLIBDIR.
+
+### Installing in the home directory
+
+If you want to install Alexandria in your home directory, you should
+specify the PREFIX, SHARE and RUBYLIBDIR envrionment variables, and
+use the `install_package` task instead of `install`.
+
+    PREFIX=$HOME SHARE=$HOME/.share RUBYLIBDIR=$HOME/.rubylib rake install_package
+
+This will install the `alexandria` program into `$HOME/bin` (which you
+should add to your `PATH`), and the ruby files to your
+`$HOME/.rubylib` which you should add to your `RUBYLIBDIR` environment
+variable.
+
+### Uninstalling
+
+To uninstall, simply run
+
+    sudo rake uninstall
+
+(or `rake uninstall_package` if you installed in your home directory).
+
+If you specified any of the environment variables PREFIX, SHARE,
+RUBYLIBDIR and DESTDIR during the installation, you should use the
+same variables during uninstallation (or rake won't know where to look
+for the files it has to remove).

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -*- ruby -*-
 #--
 # Copyright (C) 2009 Cathal Mc Ginley
@@ -39,7 +41,7 @@ require_relative 'lib/alexandria/version'
 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 = share_dir
@@ -61,7 +63,7 @@ SHARE_FILE_GLOBS = ['data/alexandria/**/*', 'data/gnome/**/*.*',
 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")
@@ -85,7 +87,7 @@ task debian_install: :install_package_staging
 FileInstallTask.new(:package) do |j|
   install_common(j)
 
-  docs = %w(README.rdoc NEWS INSTALL.rdoc COPYING TODO.md)
+  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}")
@@ -133,7 +135,7 @@ def convert_with_type(value, 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?)
@@ -174,7 +176,9 @@ file 'lib/alexandria/default_preferences.rb' => [SCHEMA_PATH] do |f|
     <<EOS
 module Alexandria
   class Preferences
-    DEFAULT_VALUES = {#{generated_lines.join(",\n      ")}}
+    DEFAULT_VALUES = {
+      #{generated_lines.join(",\n      ")}
+    }
   end
 end
 EOS
@@ -213,8 +217,8 @@ 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/**/*',
+  p.package_files.include('README.md', 'COPYING', 'CHANGELOG.md', 'INSTALL.md',
+                          'Rakefile', 'util/**/*',
                           'TODO.md', 'alexandria.desktop',
                           'alexandria.desktop.in',
                           'bin/**/*', 'data/**/*', 'misc/**/*',
@@ -239,9 +243,7 @@ end
 task :gconf do
   return if ENV['GCONF_DISABLE_MAKEFILE_SCHEMA_INSTALL']
 
-  unless system('which gconftool-2')
-    raise 'gconftool-2 cannot be found, is GConf2 correctly installed?'
-  end
+  raise 'gconftool-2 cannot be found, is GConf2 correctly installed?' unless system('which gconftool-2')
 
   ENV['GCONF_CONFIG_SOURCE'] = `gconftool-2 --get-default-source`.chomp
   Dir['schemas/*.schemas'].each do |schema|

data/alexandria-book-collection-manager.gemspec

@@ -1,4 +1,5 @@
-# -*- encoding: utf-8 -*-
+# frozen_string_literal: true
+
 require_relative 'lib/alexandria/version'
 
 Gem::Specification.new do |s|
@@ -6,7 +7,7 @@ Gem::Specification.new do |s|
   s.version = Alexandria::VERSION
 
   s.summary = 'GNOME application for managing collections of books'
-  s.required_ruby_version = '>= 1.9.3'
+  s.required_ruby_version = '>= 2.3.0'
 
   s.authors = [
     'Alexander McCormmach',
@@ -44,11 +45,10 @@ Gem::Specification.new do |s|
   s.rdoc_options = ['--main', 'README.md']
 
   s.add_runtime_dependency('gettext', ['~> 3.1'])
+  s.add_runtime_dependency('gstreamer', ['3.2.1'])
+  s.add_runtime_dependency('gtk3', ['3.2.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'])

data/bin/alexandria

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Copyright (C) 2004-2006 Laurent Sansonetti
 # Copyright (C) 2007, 2008 Joseph Method
@@ -58,7 +59,7 @@ end.parse!
 begin
   Alexandria.main
 rescue => e
-  $stderr.puts <<EOS
+  warn <<EOS
 -----------------------
 Alexandria just crashed
 -----------------------

data/doc/AUTHORS

@@ -0,0 +1,61 @@
+Maintainer:
+Matijs van Zuijlen <matijs@matijs.net>
+
+Contributors:
+Alexander McCormmach <alexander@tunicate.org>
+Aymeric Nys <aymeric@nnx.com>
+Cathal Mc Ginley <cathal.alexandria@gnostai.org>
+Claudio Belotti <bel8@lilik.it>
+Constantine Evans <cevans@costinet.org>
+Dafydd Harries <daf@muse.19inch.net>
+Javier Fernandez-Sanguino Pena <jfs@debian.org>
+Joseph Method <tristil@gmail.com>
+Kevin Schultz <schultkl@ieee.org>
+Laurent Sansonetti <lrz@gnome.org>
+Marco Costantini <costanti@science.unitn.it>
+Mathieu Leduc-Hamel <arrak@arrak.org>
+Owain Evans <o.evans@gmail.com>
+Pascal Terjan <pterjan@linuxfr.org>
+Rene Samselnig <sandman@sdm-net.org>
+Robby Stephenson <robby@periapsis.org>
+Sun Ning <classicning@gmail.com>
+Takayuki Kusano <AE5T-KSN@asahi-net.or.jp>
+Timothy Malone <timothy.malone@gmail.com>
+Zachary P. Landau <kapheine@hypa.net>
+
+Documentors:
+Cathal Mc Ginley <cathal.alexandria@gnostai.org>
+Liam Davison <registrations@liamjdavison.info>
+
+Artists:
+Andreas Nilsson <nisses.mail@home.se>
+Stefanie Dijoux <stefanie.dijoux@gmail.com>
+
+Translators:
+Adrián Chaves Fernández <adriyetichaves@gmail.com> (gl)
+Cathal Mc Ginley <cathal.alexandria@gnostai.org> (ga)
+CHIKAMA Masaki <masaki.chikama@gmail.com> (ja)
+Dafydd Harries <daf@muse.19inch.net> (cy)
+Damjan Dimitrioski <damjandimitrioski@gmail.com> (mk)
+Giacomo Margarito <giacomomargarito@gmail.com> (it)
+Jack Myrseh <jack@enkom.no> (nb)
+Joachim Breitner <mail@joachim-breitner.de> (de)
+José Ling <jlgdot369@gmail.com> (zh_TW)
+Lennart Karssen <lennart@karssen.org> (nl)
+Lígia Moreira <ligia.moreira@netvisao.pt> (fr, pt, pt_BR)
+Martin Karlsson <martinkarlsson81@hotmail.com> (sv)
+Michael Kotsarinis <mkotsari1@pre.forthnet.gr> (el)
+Miguel Ángel García <magmax@ieee.org> (es)
+Peter Kováč <kovac.peter@fotopriestor.sk> (sk)
+Petr Vanek <vanous@penguin.cz> (cs)
+Piotr Drąg <piotrdrag@gmail.com> (pl)
+Serhij Dubyk <dubyk@library.lviv.ua> (uk)
+
+Former translators:
+David Weinehall <tao@debian.org> (sv)
+Jiří Pejchal <jiri.pejchal@gmail.com> (cs)
+Laurent Sansonetti <lrz@gnome.org> (fr)
+Lucas Rocha <lucasr@im.ufba.br> (pt_BR)
+Marco Costantini <costanti@science.unitn.it> (it)
+Masao Mutoh <mutoh@highway.ne.jp> (ja)
+Mirko Maischberger <mirko@lilik.it> (it)

data/doc/BUGS

@@ -0,0 +1,31 @@
+= Bugs and Shortcomings
+
+There are a couple of well known, long-standing issues with
+Alexandria. These issues will, hopefully, be addressed in upcoming
+releases. There are also specific bugs tracked on RubyForge:
+<http://rubyforge.org/tracker/?group_id=205>
+
+== Icon Display Spacing
+
+While the list view of books is naturally neat, the default icon view
+suffers from problematic icon spacing; often the book covers appear to
+be randomly scattered. They cannot even be adjusted afterwards. This
+is just an aesthetic concern, but a frustrating one.
+
+It is probable that this is due to inconsistent use of the GTK+ thread
+dispatcher is at the root of these problems. Hopefully future
+development can clean up the code in this regard.
+
+== Multiple Copies of Books
+
+The limited expressiveness of Alexandria's domain model means that it
+is not possible to keep a record of more than one copy of a given book
+in a single library.
+
+== Large Collections
+
+The user-interface becomes slow and unresponsive when dealing with
+libraries over about 100 books. This is quite a low threshold on
+scalability. The simple solution is to make a couple of new libraries
+to hold a hundred books each; a common approach is to split them up
+according to broad subject area.