alexandria-book-collection-manager 0.6.9.pre1

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# The gem's dependencies are specified in the gemspec
+gemspec
+
+group :development, :test do
+  gem 'rdoc', '~> 4.0'
+  gem 'pry'
+end

data/INSTALL.rdoc

@@ -0,0 +1,156 @@
+= Installing Alexandria
+
+Alexandria is written in Ruby with a GTK+2/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; however, many of these
+are now optional as detailed below. Once the dependencies have been
+installed, building and installing Alexandria is relatively
+straightforward.
+
+[Also note that there are pre-built packages for some distros, such as
+Fedora and Ubuntu.]
+
+== Dependencies
+
+The {Ruby-GNOME2}[http://ruby-gnome2.sourceforge.jp/] user-interface
+involves a number of packages:
+
+* <tt>ruby-gtk2</tt>
+* <tt>ruby-goocanvas</tt>
+* <tt>ruby-gst</tt>
+* <tt>ruby-pango</tt>
+
+You should have GTK+ >= 2.22.0, and use Ruby-GNOME2 >= 0.16.0.
+
+<tt>ruby-gettext</tt>[http://ponx.s5.xrea.com/hiki/ruby-gettext.html]
+is required for the internationalisation of the user interface.
+Requires version 1.7.0 or higher.
+
+=== Hpricot
+
+Alexandria uses +hpricot+[http://code.whytheluckystiff.net/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. You can install the +hpricot+ package natively or as a
+ruby gem.
+
+== HTMLEntities
+
+This is used by all website-based providers except MCU. 
+ +htmlentities+[http://htmlentities.rubyforge.org/] is used to
+provide more flexible HTML parsing.
+
+== Build Dependencies
+
+=== Ruby Dependencies
+
++rake+[http://rake.rubyforge.org] 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 <tt>ruby-gettext</tt> 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.
+
+== Optional Dependencies
+
+=== Ruby/ZOOM and Yaz
+
+For Z39.50 support and and the <b>Library of Congress</b> and
+<b>British Library</b> book providers you will need
+<tt>ruby-zoom</tt>[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
+<tt>image_size</tt>[http://rubyforge.org/projects/imagesize/] for
+optimizing the cover images in exported libraries.
+
+=== Revolution
+
+If you want to auto-complete the names of people you loan books to
+from your Evolution contacts database, you can install
++revolution+[ http://revolution.rubyforge.org/].
+
+== Build and Install
+
+To build Alexandria from a subversion 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/PACKAGING

@@ -0,0 +1,36 @@
+#!/bin/sh
+# This is just to provide clues for packaging. Not ready to be run as a script.
+
+cd alexandria
+rake package
+# sometimes I have to run 'rake docs' before this works properly.
+# this creates tarball in pkg/ (doesn't contain everything yet)
+
+mkdir /tmp/build-alexandria-deb
+mv pkg/alexandria-0.6.4.tar.gz /tmp/build-alexandria-deb/alexandria-0.6.4.orig.tar.gz
+cd /tmp/build-alexandria-deb
+tar zxf alexandria-0.6.4.orig.tar.gz
+cd alexandria-0.6.4
+
+# this is where we build the deb packages from a pristine source tree
+# (Note: as a first step 'rake clobber' is automaticallly run, making
+#        the source tree even more pristine...)
+
+
+cp -a ~/software/projects/alexandria/svn/trunk/debian-gnusense/ ./debian
+# NOW edit the files in debian/ as needed
+
+dpkg-buildpackage -d -rfakeroot
+# you will be prompted for your GnuPG passphrase twice (it takes your
+# key id from the e-mail address of the most recent change in
+# debian/changelog)
+
+cd ..
+ls -l
+
+# this  should give you:
+# a source tarball:          alexandria_0.6.4-1.tar.gz
+# a source code description: alexandria_0.6.4-1.dsc
+# a binary deb:              alexandria_0.6.4-1_all.deb
+# a changes file:            alexandria_0.6.4-1_i386.changes
+# 

data/README.md

@@ -0,0 +1,88 @@
+# Alexandria
+
+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.
+
+What is Alexandria?
+===================
+
+Alexandria is an application for managing a personal book library.
+Its main recommending feature is its clean, intuitive interface.
+Alexandria is able to retrieve book information and cover images from
+a wide variety of online data sources. It also features extensive
+import and export options, a loan interface, and smart libraries.
+Alexandria is written in Ruby using ruby-gnome2.
+
+Where can I get it?
+===================
+
+An experimental gem release can be installed by running
+
+    gem install alexandria-book-collection-manager
+
+Alternatively, download the source from the github repository at
+http://www.github.com/mvz/alexandria-book-collection-manager and follow the
+installation instructions.
+
+Where can I find out more?
+==========================
+
+For source code and bug reporting, see the repository on github at
+http://www.github.com/mvz/alexandria-book-collection-manager.
+
+## Features
+
+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 DeaStore
+          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.
+
+## Installation
+
+There are full instructions for installing Alexandria from source in the
+file 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
+or, to get verbose debugging information,
+    alexandria --debug
+
+If you are running GNOME, Alexandria should appear under the
+'Applications > Office' menu.

data/RELEASE_CHECKLIST

@@ -0,0 +1,18 @@
+String-freeze (1 week before the release)
+ - Mail translators (see AUTHORS for e-mail addresses) with the latest .pot
+   file merged with their latest translation work.
+
+Release
+ - Update NEWS with the announcement and commit ;
+ - Update README with the list of features) ;
+ - Tag the ChangeLog (=== Alexandria X.Y.Z ===) and commit ;
+ - Create the tarball release (make_release.sh "X.Y.Z") ;
+ - Check if the tarball is OK ;
+ - Upload the tarball in rubyforge.org ;
+ - Update the web site (features list, download link, eventually
+   screenshots..) ;
+ - Wait for Debian and Mandrake packages ;
+ - Mail the announcement to alexandria-list@rubyforge.org,
+   ruby-talk@ruby-lang.org and gnome-announce-list@gnome.org ;
+ - Update related pages at RAA, Freshmeat and GnomeFiles ;
+ - Open a beer.

data/Rakefile

@@ -0,0 +1,264 @@
+# -*- ruby -*-
+#--
+# Copyright (C) 2009 Cathal Mc Ginley
+# Copyright (C) 2011, 2014 Matijs van Zuijlen
+#
+# 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.
+#++
+
+load 'tasks/setup.rb'
+
+require 'rake/packagetask'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'util/rake'))
+require 'fileinstall'
+require 'gettextgenerate'
+require 'omfgenerate'
+
+require_relative 'lib/alexandria/version'
+
+stage_dir = ENV['DESTDIR'] || 'tmp'
+prefix_dir = ENV['PREFIX'] || '/usr'
+
+PROJECT = 'alexandria'
+PREFIX = prefix_dir
+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')
+end
+
+OmfGenerateTask.new(PROJECT) do |o|
+  o.gnome_helpfiles_dir = "#{SHARE}/gnome/help"
+  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'] # , 'data/menu/*']
+
+ICON_FILE_GLOBS = ['data/app-icon/**/*.png',
+                   'data/app-icon/scalable/*.svg']
+
+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('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('', '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|
+  install_common(i)
+end
+
+task debian_install: :install_package_staging
+
+FileInstallTask.new(:package) do |j|
+  install_common(j)
+
+  docs = %w(README.rdoc NEWS INSTALL.rdoc COPYING TODO)
+  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}/"
+                         ])
+end
+
+task :clobberp do
+  puts CLOBBER
+end
+
+## autogenerated files
+
+def autogen_comment
+  lines = [
+    "This file is automatically generated by the #{PROJECT} installer.",
+    '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|
+    puts "Generating #{filename}"
+    file.print autogen_comment
+    file_contents = yield
+    file.print file_contents.to_s
+  end
+end
+
+# generate default_preferences.rb
+def convert_with_type(value, type)
+  case type
+  when 'int'
+    value.to_i
+  when 'float'
+    value.to_f
+  when 'bool'
+    value == 'true'
+  else
+    value.strip
+  end
+end
+
+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'
+  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' or type == 'pair'
+      ary = default[1..-2].split(',')
+      next if ary.empty?
+      if type == 'list'
+        list_type = element.elements['list_type'].text
+        ary.map! { |x| convert_with_type(x, list_type) }
+      elsif type == 'pair'
+        next if ary.length != 2
+        ary[0] = convert_with_type(ary[0],
+                                   element.elements['car_type'].text)
+        ary[1] = convert_with_type(ary[1],
+                                   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
+  end
+
+  generate(f.name) do
+    <<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']
+
+desc 'Generate ruby files needed for the installation'
+task autogen: autogenerated_files
+
+task :autogen_clobber do |_t|
+  autogenerated_files.each do |file|
+    FileUtils.rm_f(file)
+  end
+end
+task clobber: [:autogen_clobber]
+
+## # # # default task # # # ##
+
+task build: [:autogen, :gettext, :omf]
+
+task default: [:build]
+
+# pre-release tasks
+
+ULTRA_CLOBBER = []
+task ultra_clobber: :clobber do
+  ULTRA_CLOBBER.each do |file|
+    FileUtils::Verbose.rm_f(file)
+  end
+end
+
+## # # # package task # # # ##
+
+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', 'alexandria.desktop',
+                          'alexandria.desktop.in',
+                          'bin/**/*', 'data/**/*', 'misc/**/*',
+                          'doc/**/*', 'lib/**/*', 'po/**/*',
+                          'schemas/**/*', 'spec/**/*', 'tests/**/*')
+end
+
+task tgz: [:build] do
+  `rake package`
+end
+
+## # # # system installation # # # ##
+
+task pre_install: [:build]
+task :scrollkeeper do
+  unless system('which scrollkeeper-update')
+    raise 'scrollkeeper-update cannot be found, is Scrollkeeper correctly installed?'
+  end
+  system('scrollkeeper-update -q') or raise 'Scrollkeeper update failed'
+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
+
+  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
+end
+
+task post_install: [:scrollkeeper, :gconf, :update_icon_cache]
+
+desc 'Install Alexandria'
+task install: [:pre_install, :install_package, :post_install]
+
+desc 'Uninstall Alexandria'
+task uninstall: [:uninstall_package] # TODO: gconf etc...