alexandria-book-collection-manager 0.7.1 → 0.7.6

data/bin/alexandria

@@ -1,55 +1,33 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-# Copyright (C) 2004-2006 Laurent Sansonetti
-# Copyright (C) 2007, 2008 Joseph Method
-# Copyright (C) 2007, 2009 Cathal Mc Ginley
-# Copyright (C) 2014, 2015 Matijs van Zuijlen
+# This file is part of Alexandria.
 #
-# 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.
+
+require "gettext"
+require "alexandria"
+require "optparse"
+require "ostruct"
 
-require 'gettext'
-require 'alexandria'
-require 'optparse'
-require 'ostruct'
+store = Alexandria::LibraryStore.new(Alexandria::Library::DEFAULT_DIR)
+Alexandria::LibraryCollection.instance.library_store = store
 
 # options = OpenStruct.new
 OptionParser.new do |opts|
-  opts.banner = 'Usage: alexandria [options]'
-  opts.on('-l', '--list', 'List libraries in numbered format') do
+  opts.banner = "Usage: alexandria [options]"
+  opts.on("-l", "--list", "List libraries in numbered format") do
     puts Alexandria.list_books_on_console
     exit
   end
-  # opts.on("--output FORMAT",
-  #        "Output library as FORMAT: csv|xml|yaml; use with --library or omit for ALL") do |val|
-  #        options.format = val
-  #        exit
-  # end
-  # opts.on("--library LIBRARY",
-  #        "Used with --output to pick a library to output") do |val|
-  #        options.library = val
-  #        exit
-  # end
-  opts.on('-d', '--debug', 'Run in debug mode') do
+  opts.on("-d", "--debug", "Run in debug mode") do
     $DEBUG = true
   end
-  opts.on('-h', '--help', 'Show help options') do
+  opts.on("-h", "--help", "Show help options") do
     puts opts
     exit
   end
-  opts.on('-v', '--version', 'Get version number') do
+  opts.on("-v", "--version", "Get version number") do
     puts Alexandria::VERSION
     exit
   end
@@ -57,21 +35,21 @@ end.parse!
 
 begin
   Alexandria.main
-rescue => e
-  $stderr.puts <<EOS
------------------------
-Alexandria just crashed
------------------------
-Timestamp: #{Time.now}
-Message: #{e.message}
-Backtrace:
-#{e.backtrace.join("\n")}
-Release: #{Alexandria::VERSION}(#{Alexandria::DISPLAY_VERSION})
-Uname -a: #{`uname -a`.chomp}
---
-Please report this dump to '#{Alexandria::BUGREPORT_URL}' with some additional
-information, such as the description of the crash and the steps to reproduce it
-(if it's possible).
-EOS
+rescue StandardError => ex
+  warn <<~EOS
+    -----------------------
+    Alexandria just crashed
+    -----------------------
+    Timestamp: #{Time.now}
+    Message: #{ex.message}
+    Backtrace:
+    #{ex.backtrace.join("\n")}
+    Release: #{Alexandria::VERSION}(#{Alexandria::DISPLAY_VERSION})
+    Uname -a: #{`uname -a`.chomp}
+    --
+    Please report this dump to '#{Alexandria::BUGREPORT_URL}' with some additional
+    information, such as the description of the crash and the steps to reproduce it
+    (if it's possible).
+  EOS
   exit 1
 end

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.

data/doc/FAQ

@@ -0,0 +1,365 @@
+Copyright (C) 2007 Marco Costantini
+
+########################################################################
+
+Question: I have a ( Bug | Support Request | Patch | Feature Request ).
+
+Answer: You are welcome to report it. Please use the tracker at
+http://rubyforge.org/tracker/?group_id=205
+
+It may be helpful to read the text "How to Report Bugs Effectively", at
+http://www.chiark.greenend.org.uk/~sgtatham/bugs.html
+
+Please, one bug per report, and one report per bug.
+
+Please use a meaningful and specific summary.
+
+In order to let us investigate the bug and fix it for you, we need a clear
+and specific information about how to replicate it. For instance: report
+the ISBN of the book for which the bug happens; report the book provider
+used if relevant; copy and paste the error message. You may also start
+Alexandria in terminal window, and copy and paste the output on that
+window.
+
+In the past we got the bug report [#6767] saying:
+"Entering a valid ISBN number (many different) is rejected by the
+program. Stating to be an invalid ISBN."
+This user didn't report any single non-working ISBN; and didn't explain
+"rejected" enough. Hence, even if further work has been done on this
+topic, we can't know whether this bug was a real one, and whether it has
+been already solved or not.
+
+If you report only the backtrace without saying how to replicate the 
+bug, it is usually impossible to understand and fix the bug.
+
+Please have a look at the already reported bugs or feature request:
+it is useless to report again an already reported one. 
+If you have more information, please add it at the already reported bug,
+instead of opening a new one.
+
+Your bug could be a bug already solved in the development version of
+Alexandria. You can get the development version at
+http://rubyforge.org/scm/?group_id=205
+
+
+########################################################################
+
+
+Question: Where are the Z39.50 stuff, the providers US Library of 
+Congress and British Library, the advanced options, and the window for 
+adding new providers? I can't install Ruby/ZOOM.
+
+Answer: All these things require that the library Ruby/ZOOM,
+version >= 0.2.0 is installed and working. You can get it at
+http://ruby-zoom.rubyforge.org/ Install it according to its
+documentation.
+
+Ruby/ZOOM requires YAZ, http://www.indexdata.dk/yaz/ , compiled with 
+passing the --enable-shared option to the configure script:
+
+./configure --enable-shared
+
+before building YAZ with make.
+
+The following works for me with Ubuntu
+
+sudo apt-get -y install libyaz-dev ruby ruby1.8-dev make gcc
+wget http://rubyforge.org/frs/download.php/6940/ruby-zoom-0.2.2.tar.gz
+tar xfz ruby-zoom-0.2.2.tar.gz
+cd ruby-zoom-0.2.2/
+ruby extconf.rb
+make
+sudo make install
+
+
+
+List of Z39.50 server are at
+http://www.webclarity.info/registry/browse
+http://targettest.indexdata.com/
+
+
+When adding new Z39.50 providers, you must choose the record syntax.
+Currently (March 2007), these are offered: "USMARC", "SUTRS", "UNIMARC".
+
+"USMARC" works, "UNIMARC" works very limited, "SUTRS" doesn't work. 
+Choose a provider that supports "USMARC", or if none is available, one 
+that supports "UNIMARC".
+MARC21 is the same as USMARC (at least for Alexandria).
+
+You must choose also the charset encoding. Some are 
+
+UTF-8
+ISO-8859-1 (also known as Latin-1, Western Europe)
+ISO-8859-15
+ISO_6937-2 (also known as Ala, Ansel)
+
+The list of all possible charset encoding could be at
+/usr/lib/gconv/gconv-modules
+
+
+There is a plan to replace in future the provider British Library with 
+Copac, which includes British Library and others; see
+http://copac.ac.uk/libraries/
+http://en.wikipedia.org/wiki/Copac
+
+
+########################################################################
+
+
+Question: A provider is not working, or only partial information it 
+retrieved from it, or there are books on the providers for which 
+Alexandria fails to retrieve information.
+
+Answer: Yes, the provider may have changed the structure of its
+web pages, and hence it is necessary to update the file for that
+provider; this file is in the directory
+/<something>/alexandria/book_providers/
+
+It is also possible that the file handles only the "simple" cases, and the 
+case of your book is a "complex" one.
+
+Try to get the development version at http://rubyforge.org/scm/?group_id=205 
+because the problem could be already fixed there. 
+
+Try to fix by yourself, and thereafter send us a patch. 
+Otherwise, report the bug, saying for which ISBN this problem happens.
+
+
+########################################################################
+
+
+Question: I know another book provider
+
+Answer: There are many other providers, see 
+http://en.wikipedia.org/wiki/Wikipedia:Book_sources
+That page contains also links to the pages for book providers in other
+languages.
+If you now other providers, please add them to that lists.
+
+
+########################################################################
+
+
+Question: Please add a new provider
+
+Answer: First, choose wisely which provider(s) to ask. Do a 
+search on Internet of the various existing providers for your language 
+(see also, but not only, the previous question). 
+
+You may prefer providers that list also out-of-prints, instead of 
+providers that list only available books. It is also preferable a 
+provider that lists not only the books of your country, but also the 
+books of the neighbor countries.
+
+Check whether the provider supports the Z39.50 protocol. This is probable
+for public libraries, and very unlikely for commercial booksellers. 
+(If the Z39.50 protocol is supported, just go to "Preferences", 
+"Providers", "Advanced Settings", and add the provider there.)
+
+It is useful if you choose a provider that allows to specify the ISBN in 
+the address, such as 
+http://www.internetbookshop.it/ame/ser/serdsp.asp?e=0060748222&shop=1
+
+It is necessary that the HTML page of each provider is easily parsable, 
+that is, that the computer can easily find title, author(s), ISBN, 
+publisher, year of publication, binding.
+For instance, the following piece of HTML page is easily parsable.
+
+<span class="BDtitoloLibro">The Krusty Book</span>
+<span class="BDauthLibro">by: Matt 
+Groening </span><span class="BDformatoLibro"><span 
+class="BDEticLibro">Format: </span>paperback</span><span 
+class="BDEticLibro">Publication date: </span><span 
+class="BDdataPubbLibro">10/23/2006</span><span 
+class="BDEticLibro">Publisher: </span><span 
+class="BDeditoreLibro">HarperCollins Publishers (Australia) Pty 
+Ltd</span><br /><span class="BDEticLibro">ISBN: </span><span 
+class="isbn">0-06-074822-2</span><br /><span class="BDEticLibro">ISBN 
+13: </span><span class="isbn">978-0-06-074822-7</span></div>
+
+It is not necessary that the provider reports for each book all the
+information: title, author(s), ISBN, publisher, year of publication,
+binding. In case that one of these is missing, Alexandria will not get 
+it.
+
+It is easier, if the provider doesn't use cookies.
+
+After the choice of the provider, try by yourself to modify the file for 
+an already implemented provider. Probably it may be only required that 
+you modify some regular expressions. Please send us the patch.
+If you can program already, learning Ruby may require 20 minutes, see 
+http://www.ruby-lang.org/en/documentation/quickstart/
+
+If you can't implement the new provider by yourself, write a 'feature 
+request' at http://rubyforge.org/tracker/?group_id=205
+Please report some ISBNs of books that your provider knows and no other 
+provider implemented by Alexandria knows. Report also how are the words 
+title, author(s), ISBN, publisher, year of publication, binding in the 
+language used by the site. Report any other relevant information.
+
+
+########################################################################
+
+
+Question: What are the ISBN, the ISBN-13, and the EAN? 
+
+Answer: For more information about ISBN, ISBN-13, EAN, see 
+http://en.wikipedia.org/wiki/International_Standard_Book_Number
+
+
+########################################################################
+
+
+Question: Does Alexandria support the ISBN-13? Do I need to enter the 
+ISBN with or without dashes?
+
+Answer: Alexandria support both the 10-digit and 13-digit ISBN, and the 
+dashes entered with the ISBN are ignored. Hence you can enter the book 
+in any of these equivalent forms:
+
+88-06-14930-X
+880614930X
+88-06-14930-x
+880614930x
+978-88-06-14930-7
+9788806149307
+
+
+########################################################################
+
+
+Question: I entered the ISBN exactly as it shows on the book, and 
+Alexandria says that it is invalid.
+
+Answer: You can check whether an ISBN is valid with
+http://www.isbn-check.com/ 
+Sometimes the ISBN reported on the book is wrong. Try to use the
+13-digit one, or to use the ISBN reported on the back of the title page,
+or to search by title/author on a book provider, in order to find the
+correct ISBN.
+
+
+########################################################################
+
+
+Question: Where is stored the data about the books?
+
+Answer: In the files ~/.alexandria/<library_name>/<ISBN>.yaml
+These files are in YAML ( http://www.yaml.org/ ) format, and you can 
+edit them manually. The covers are in the files 
+~/.alexandria/<library_name>/<ISBN>.cover
+These files persist if you install or deinstall Alexandria.
+
+
+########################################################################
+
+
+Question: I was enjoying Alexandria a lot and now it doesn't work any 
+more, I can't enter other books, or crashes when it starts.
+
+Answer: This usually happens when there is some invalid data in one of 
+the .yaml files (see the question above). For one or more of the 
+latest books that you have entered, a bug happened, and now the data 
+stored is invalid and causes trouble. Try to find which book it was, 
+(please send also a bug report), and to delete or to move to another 
+directory that .yaml file or the whole ~/.alexandria directory.
+
+This kind of problem may show only with the manual entered books, and 
+not with the books searched by ISBN.
+
+
+########################################################################
+
+
+Question: can I catalog other objects?
+
+Answer: Yes. Some kinds of object, such as illustrated calendars, or 
+geographical maps, have the ISBN, and can be treated as books.
+
+For other objects, insert the EAN or bar-code number as ISBN. Provider 
+Thalia knows about music CDs, video DVDs, games and software, and can be 
+used to retrieve information about them. Other providers may be added in 
+future (possibly by you). Otherwise, the other objects may be added 
+manually.
+
+
+########################################################################
+
+
+Question: I prefer to have the field "Author" as "Surname, Name" instead 
+of "Name Surname".
+
+Answer: Alexandria relies on what the providers say: 
+some providers report "Surname Name": Webster.it, Ibs.it,
+some "Name Surname": Bn, Thalia, Bol.it, Adlibris, L Siciliano, Worldcat,
+and some without any rule: Amazon, Proxis.
+You can change, in the preferences, the order in which the providers are 
+queried.
+
+If Alexandria reports "Name Surname" with one provider, and in the HTML 
+page of that provider there is also (in a parsable way) "Surname, Name", 
+then this is a bug to be reported. In some of these cases, it would be 
+possible to get "Surname, Name", but the code would be complicated and 
+unreliable. 
+
+There is no algorithm that can decide, given the Author as a string, 
+which part of the string is the name and which part is the surname.
+For instance, the name or the surname can be composed by more than one 
+word, or the author may be a collective author, or be a title or a 
+pseudonym, or in the author's country they may use that the surname is 
+the first word and the name is the second, or there may be the 
+patronymic, and so on.
+
+For one provider, for books with more that one author, it's non-trivial 
+even to split the string of all the authors into strings "Name Surname" for 
+each author.
+
+The only possibility to convert "Name Surname" to "Surname, Name" is to do
+that by hand.
+
+If you still believe that it is possible for a software to convert "Name 
+Surname" into "Surname, Name" in a reliable way, here are some cases of 
+real authors for you to try. (Some accented letters have been replaced by 
+the non accented ones.)
+
+"Agente Italiano"
+"Albert Sydney Hornby"
+"Alexandre Dumas fils"
+"Antoine de Saint-Exupery"
+"Boston Women's Health Book Collective"
+"Camilla"
+"Central Intelligence Agency"
+"Christiane F."
+"Dario De Toffoli"
+"Elaine St. James"
+"Ernesto Che Guevara"
+"Francois-Marie Arouet de Voltaire"
+"Gaius Caesar Octavianus Augustus"
+"Geographers A-Z Map Company"
+"Gian Antonio Stella"
+"H G Wells"
+"John Paul II" (the surname is "Wojtyla")
+"Jose Ortega y Gasset"
+"Joseph K. von Eichendorff"
+"Leonardo da Vinci" (he had no surname, "da Vinci" means "from the village
+'Vinci'")
+"Leone Stella" (this only is fictional, from a comic movie, whose main
+characters are some "Leone Stella" and a "Stella Leone"
+"Levi Strauss"
+"Lewis Carroll" ("Lewis" may be both name and surname, and here the 
+surname is "Dodgson")
+"Lorenzo il Magnifico"
+"Lucio Lombado Radice"
+"Luigi Luca Cavalli-Sforza"
+"Malcolm X"
+"Mao Zedong"
+"Martin Luther"
+"Martin Luther King Jr."
+"Mihail Sergeevic Gorbacev"
+"Robert Van der Plas"
+"Saint Augustine"
+"Scuola di Barbiana"
+"Subcomandante Insurgente Marcos"
+"Vladimir Lenin" (the surname is "Ulyanov")
+
+########################################################################