alexandria-book-collection-manager 0.6.9.pre1

data/test/test_helper.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# Copyright (C) 2011, 2014 Matijs van Zuijlen
+# Incorporates code Copyright (C) 2007 Joseph Method
+#
+# This file is part of Alexandria, a GNOME book collection manager.
+#
+# 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.
+
+require 'minitest/autorun'
+
+require 'gettext'
+require 'alexandria'
+
+LIBDIR = File.expand_path(File.join(File.dirname(__FILE__), '/data/libraries'))
+TESTDIR = File.join(LIBDIR, 'test')
+
+def an_artist_of_the_floating_world
+  Alexandria::Book.new('An Artist of the Floating World',
+                       'Kazuo Ishiguro',
+                       '9780571147168',
+                       'Faber and Faber', 1999,
+                       'Paperback')
+end
+
+module Alexandria
+  class Library
+    DIR.replace TESTDIR
+  end
+end

data/util/rake/fileinstall.rb

@@ -0,0 +1,313 @@
+# -*- ruby -*-
+#--
+# Copyright (C) 2009 Cathal Mc Ginley
+# Modifications Copyright (C) 2011 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.
+#++
+
+require 'fileutils'
+require 'pathname'
+require 'set'
+require 'rake/tasklib'
+
+# A file installer task, capable of installing into the system
+# directories, or doing a staged install to a given directory
+# (preparatory to bundling the installed files in a binary package
+# such as deb or rpm).
+class FileInstallTask < Rake::TaskLib
+  # The calculated location of the preferred ruby lib installation dir.
+  attr_reader :rubylib
+
+  # Creates an installer task with the given +taskname+. If a
+  # +dirname+ is given, the task will perform a staged installation to
+  # that directory with a correct sub-tree e.g. 'tmp/usr/bin',
+  # 'tmp/usr/share/doc/packagename'.
+  #
+  # This constructor is called with a block, which is passed the
+  # installer task. You should call +install+ or +install_exe+ on that
+  # installer as follows:
+  #
+  #     FileInstallTask.new(:install) do |i|
+  #       i.install('lib', 'lib/**/*.rb', i.rubylib)
+  #       i.install_exe('bin', 'bin/*', '/usr/bin')
+  #     end
+  #
+  # If you set +install_to_rubylibdir+ true, or specify the
+  # +RUBYLIBDIR+ environment variable, you can ensure the files are
+  # installed in the correct place for staged installation, e.g. on
+  # Debian, set +dirname+ to 'debian/packagename' and
+  # +install_to_rubylibdir+ to true so that files are stage-installed
+  # to 'debian/packagename/usr/lib/ruby/1.8'
+  def initialize(taskname, dirname = nil, install_to_rubylibdir = false)
+    @taskname = taskname
+    @install_to_rubylibdir = install_to_rubylibdir
+    calculate_ruby_dir
+    @stage_dir = dirname # || @prefix
+    @file_groups = []
+    @dirs_to_remove_globs = []
+    if block_given?
+      yield self
+    end
+    make_tasks
+  end
+
+  protected
+
+  # Creates the install and uninstall tasks based on the contents
+  # of the @file_groups list
+  def make_tasks
+    tasknames = {}
+    tasknames[:install] = "install_#{@taskname}".intern
+    tasknames[:uninstall] = "uninstall_#{@taskname}".intern
+    tasknames[:uninstall_files] = "uninstall_#{@taskname}_files".intern
+    tasknames[:uninstall_dirs] = "uninstall_#{@taskname}_dirs".intern
+
+    # INSTALL TASK
+
+    description = 'Install package files'
+    if @stage_dir
+      description += ' to staging directory'
+    end
+    desc description
+    task tasknames[:install] do
+      @file_groups.each { |g| g.install(@stage_dir) }
+    end
+
+    # UNINSTALL TASKS
+
+    task tasknames[:uninstall_files] do
+      @file_groups.each { |g| g.uninstall(@stage_dir) }
+    end
+
+    task tasknames[:uninstall_dirs] => tasknames[:uninstall_files] do
+      all_dirs = Set.new
+      @file_groups.each { |g| g.get_installation_dirs(@stage_dir, all_dirs) }
+
+      to_delete = Set.new
+      @dirs_to_remove_globs.each do |glob|
+        regex = glob2regex(glob)
+        all_dirs.each do |dir|
+          unless dir =~ /\/$/
+            dir += '/'
+          end
+          if regex =~ dir
+            to_delete << Regexp.last_match[1]
+          end
+        end
+      end
+      to_delete.each do |dirname|
+        dir = dirname
+        if @stage_dir
+          dir = File.join(@stage_dir, dirname)
+        end
+        delete_empty(dir)
+      end
+    end
+
+    uninstall_description = 'Uninstall package files'
+    if @stage_dir
+      uninstall_description += ' from staging directory'
+    end
+    desc uninstall_description
+    task tasknames[:uninstall] => [tasknames[:uninstall_files],
+                                   tasknames[:uninstall_dirs]]
+  end
+
+  public
+
+  # Include the files specified in the +file_glob+ to be installed in
+  # +dest_dir+, but noting that the prefix +src_dir+ is to be
+  # disregarded in the installation.
+  #
+  # This means that
+  #     i.install('data', 'data/gnome/**', '/usr/share')
+  # would install files in the 'data/gnome/help' directory to
+  # '/usr/share/gnome/help'
+  def install(src_dir, file_glob, dest_dir)
+    @file_groups << FileGroup.new(src_dir, file_glob, dest_dir)
+  end
+
+  # Install files the same way as +install+, but setting the mode of
+  # the installed file to be executable.
+  def install_exe(src_dir, file_glob, dest_dir)
+    @file_groups << FileGroup.new(src_dir, file_glob, dest_dir, 0755)
+  end
+
+  # Install icon files. This method splits up the source file name and
+  # determines where they should be put in the destination hierarchy.
+  def install_icons(file_globs, dest_dir, theme = 'hicolor', icon_type = 'apps')
+    file_globs.each do |fg|
+      files = FileList.new(fg)
+      files.each do |f|
+        icon_file = Pathname.new(f)
+        icon_dir = icon_file.dirname
+        icon_size = Pathname.new(icon_dir).basename
+        icon_dest_dir = "#{dest_dir}/#{theme}/#{icon_size}/#{icon_type}"
+        group = FileGroup.new(icon_dir, f, icon_dest_dir)
+        group.description = 'icons'
+        @file_groups << group
+      end
+    end
+  end
+
+  # Specify which directories should be deleted by the uninstall task
+  # if they are empty (or only contain more empty directories).
+  def uninstall_empty_dirs(dir_globs)
+    @dirs_to_remove_globs = dir_globs
+  end
+
+  private
+
+  def calculate_ruby_dir
+    ruby_prefix = RbConfig::CONFIG['prefix']
+
+    if @install_to_rubylibdir
+      ruby_libdir = RbConfig::CONFIG['rubylibdir']
+    else
+      ruby_libdir = RbConfig::CONFIG['sitelibdir']
+    end
+    if ENV.key?('RUBYLIBDIR')
+      ruby_libdir = ENV['RUBYLIBDIR']
+    end
+
+    @prefix = ENV['PREFIX'] || ruby_prefix
+    if @prefix == ruby_prefix
+      @rubylib = ruby_libdir
+    elsif ruby_libdir.index(ruby_prefix) == 0
+      libpart = ruby_libdir[ruby_prefix.size..-1]
+      @rubylib = File.join(@prefix, libpart)
+    else
+      @rubylib = ruby_libdir
+    end
+  end
+
+  def glob2regex(pathglob)
+    if pathglob =~ /\*\*$/
+      pathglob += '/'
+    end
+    real_parts = pathglob.split('**/')
+    real_parts.each do |part|
+      part.gsub!('.', '\\.')
+      part.gsub!('*', '[^\\/]*')
+      part.gsub!('?', '[^\\/]')
+    end
+    pattern = real_parts.join("([^\/]+\/)*")
+    /(#{pattern})/
+  end
+
+  # For each of the directories named in the list +dirs+, delete the
+  # tree if is empty except for further empty directories.
+  def delete_empty(dirs)
+    dirs.each do |d|
+      p = Pathname.new(d)
+      if p.exist?
+        delete_if_empty(p.realpath)
+      end
+    end
+  end
+
+  # Delete the directory at the given Pathname +p+ if all its children
+  # can be similarly deleted, and if it is then empty.
+  def delete_if_empty(p)
+    unless p.directory?
+      return false
+    end
+    p.children.each do |c|
+      delete_if_empty(c)
+    end
+    if p.children.empty?
+      p.delete # TODO optional verbose output here
+      true
+    else
+      false
+    end
+  end
+
+  class FileGroup
+    attr_reader :mode
+    attr_accessor :description
+    def initialize(src_dir, file_glob, dest_dir, mode = 0644)
+      @src_dir = src_dir
+      @file_glob = file_glob
+      @dest_dir = dest_dir
+      @mode = mode
+      @description = 'files'
+    end
+
+    def to_s
+      "FileGroup[#{@src_dir}] => #{@dest_dir}"
+    end
+
+    def dest_dir(file, staging_dir = nil)
+      source_basedir = Pathname.new(@src_dir)
+      source_file = Pathname.new(file)
+
+      if staging_dir
+        stage_dest = File.join(staging_dir, @dest_dir)
+        dest_basedir = Pathname.new(stage_dest)
+      else
+        dest_basedir = Pathname.new(@dest_dir)
+      end
+      if source_file.file?
+        source_path = source_file.dirname.relative_path_from(source_basedir)
+      end
+      dest = source_path ? dest_basedir + source_path : dest_basedir
+      dest.to_s
+    end
+
+    def files
+      FileList.new(@file_glob)
+    end
+
+    def install(base_dir)
+      puts "Installing #{@description} to #{base_dir}#{@dest_dir}"
+      files.each do |f|
+        dest = dest_dir(f, base_dir)
+        FileUtils.mkdir_p(dest) unless test('d', dest)
+        if test('f', f)
+          FileUtils.install(f, dest, mode: mode)
+        end
+      end
+    end
+
+    def uninstall(base_dir)
+      files.each do |f|
+        dest = dest_dir(f, base_dir)
+        filename = File.basename(f)
+        file = File.join(dest, filename)
+        if test('f', file)
+          FileUtils::Verbose.rm_f(file) # , :noop => true)
+        end
+      end
+    end
+
+    def get_installation_dirs(base_dir, all_dirs_set)
+      files.each do |f|
+        dest = dest_dir(f, base_dir)
+        filename = File.basename(f)
+        file = File.join(dest, filename)
+        all_dirs_set << File.dirname(file)
+      end
+    end
+  end # class FileGroup
+end # class FileInstallTask

data/util/rake/gettextgenerate.rb

@@ -0,0 +1,158 @@
+# -*- ruby -*-
+#--
+# Copyright (C) 2009 Cathal Mc Ginley
+#
+# 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.
+#++
+
+require 'fileutils'
+require 'pathname'
+require 'rake/tasklib'
+
+class GettextGenerateTask < Rake::TaskLib
+  def initialize(projectname)
+    @projectname = projectname
+    @generated_files = []
+    if block_given?
+      yield self
+    end
+    make_task
+  end
+
+  def make_task
+    desc 'Generate gettext localization files'
+    task gettext: @generated_files
+
+    if CLOBBER
+      @generated_files.each { |gen| CLOBBER << gen }
+    end
+  end
+
+  def generate_po_files(po_dir, file_glob, dest_dir)
+    @po_dir = po_dir
+    @po_files_glob = file_glob
+    @mo_dir = dest_dir
+    @mo_files_regex = /.*\/(.+)\/LC_MESSAGES\/.+\.mo/
+
+    # create MO files
+    rule(/\.mo$/ => [->(dest) { source_file(dest) }]) do |t|
+      dest_dir = File.dirname(t.name)
+      FileUtils.makedirs(dest_dir) unless FileTest.exists?(dest_dir)
+      puts "Generating #{t.name}"
+      system("msgfmt #{t.source} -o #{t.name}")
+      raise "msgfmt failed for #{t.source}" if $CHILD_STATUS != 0
+    end
+    mo_files.each { |mo| @generated_files << mo }
+  end
+
+  def po_files
+    FileList[@po_files_glob]
+  end
+
+  def generate_desktop(infile, outfile)
+    @generated_files << outfile
+    file outfile => [infile, *po_files] do |_f|
+      unless `intltool-merge --version`
+        raise Exception, 'Need to install intltool'
+      end
+      system("intltool-merge -d #{@po_dir} #{infile} #{outfile}")
+    end
+  end
+
+  def locales
+    po_files.map { |po| File.basename(po).split('.')[0] }
+  end
+
+  def mo_files
+    locales.map { |loc| mo_file_for(loc) }
+  end
+
+  def po_file_for(locale)
+    "#{@po_dir}/#{locale}.po"
+  end
+
+  def mo_file_for(locale)
+    "#{@mo_dir}/#{locale}/LC_MESSAGES/#{@projectname}.mo"
+  end
+
+  def source_file(dest_file)
+    dest_file =~ @mo_files_regex
+    po_file_for(Regexp.last_match[1])
+  end
+end
+
+#   class GettextConfig < BuildConfig
+#     attr_accessor :po_dir, :po_files_glob
+#     attr_accessor :mo_dir, :mo_files_regex
+#     def initialize(build)
+#       super(build)
+#       @po_dir = 'po'
+#       @po_files_glob = "#{@po_dir}/*.po"
+#       @mo_dir = 'data/locale'
+#       @mo_files_regex = /.*\/(.+)\/LC_MESSAGES\/.+\.mo/
+#     end
+#     def po_files
+#       FileList[po_files_glob]
+#     end
+#     def po_file_for(locale)
+#       "#{po_dir}/#{locale}.po"
+#     end
+#     def locales
+#       po_files.map { |po| File.basename(po).split('.')[0] }
+#     end
+#     def mo_files
+#       locales.map { |loc| mo_file_for(loc) }
+#     end
+#     def mo_file_for(locale)
+#       "#{mo_dir}/#{locale}/LC_MESSAGES/#{build.name}.mo"
+#     end
+#     def source_file(dest_file)
+#       dest_file =~ mo_files_regex
+#       po_file_for($1)
+#     end
+#   end
+
+#   def define_gettext_tasks
+#     # extract translations from PO files into other files
+#     file files.desktop => ["#{files.desktop}.in",
+#       *@gettext.po_files] do |f|
+#       raise "Need to install intltool" unless system("intltool-merge -d #{@gettext.po_dir} #{f.name}.in #{f.name}")
+#       end
+
+#     # create MO files
+#     rule( /\.mo$/ => [ lambda { |dest| @gettext.source_file(dest) }]) do |t|
+#       dest_dir = File.dirname(t.name)
+#       FileUtils.makedirs(dest_dir) unless FileTest.exists?(dest_dir)
+#       puts "Generating #{t.name}"
+#       system("msgfmt #{t.source} -o #{t.name}")
+#       raise "msgfmt failed for #{t.source}" if $? != 0
+#     end
+
+#     desc "Generate gettext localization files"
+#     task :gettext => [files.desktop, *@gettext.mo_files]
+
+#     task :clobber_gettext do
+#       FileUtils.rm_f(files.desktop)
+#       FileUtils.rm_rf(@gettext.mo_dir)
+#     end
+#     task :clobber => [:clobber_gettext]
+#   end