alexandria-book-collection-manager 0.7.1 → 0.7.6

data/spec/spec_helper.rb

@@ -1,45 +1,78 @@
-# Copyright (C) 2007 Joseph Method
-# Copyright (C) 2014, 2016 Matijs van Zuijlen
-#
-# 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.
+# frozen_string_literal: true
+
+# This file is part of Alexandria.
 #
-# 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.
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '/../lib'))
+require "rspec"
+require "alexandria"
+require "webmock/rspec"
 
-require 'alexandria'
+LIBDIR = File.expand_path("data/libraries", __dir__)
+TESTDIR = File.join(LIBDIR, "test")
 
-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
 
-# def useTestLibrary(version)
-#  libVersion = File.join(LIBDIR, version)
-#  FileUtils.cp_r(libVersion, TESTDIR)
-# end
+def assert_correct_search_result(provider, query,
+                                 search_type = Alexandria::BookProviders::SEARCH_BY_ISBN)
+  begin
+    results = provider.instance.search(query, search_type)
+  rescue SocketError
+    skip "Service is offline"
+  end
 
-def an_artist_of_the_floating_world
-  Alexandria::Book.new('An Artist of the Floating World',
-                       'Kazuo Ishiguro',
-                       '9780571147168',
-                       'Faber and Faber', 1999,
-                       'Paperback')
+  expect(results).to be_instance_of(Array), "Results are not an array for #{provider}"
+  expect(results).not_to be_empty, "Results are empty for #{provider}"
+
+  if search_type == Alexandria::BookProviders::SEARCH_BY_ISBN
+    expect(results.length).to be <= 2, "Results are greater than 2 for #{provider}"
+
+    book = results.first
+
+    expect(book).to be_instance_of(Alexandria::Book),
+                    "Result is not a Book for #{provider}"
+
+    canonical_query = Alexandria::Library.canonicalise_ean(query)
+    canonical_result = Alexandria::Library.canonicalise_ean(book.isbn)
+    expect(canonical_query)
+      .to eq(canonical_result),
+          "Result's isbn #{book.isbn} is not equivalent" \
+          " to the requested isbn #{query} for #{provider}"
+
+    if results.length == 2
+      cover_url = results.last
+      if cover_url
+        expect(cover_url)
+          .to be_instance_of(String),
+              "Unexpected cover_url #{cover_url.inspect} for #{provider}"
+      end
+    end
+  else
+    expect(results.first.first)
+      .to be_instance_of(Alexandria::Book), "Result item is not a Book for #{provider}"
+  end
+  results
 end
 
 Alexandria::UI::Icons.init
 
-module Alexandria
-  class Library
-    DIR.replace TESTDIR
+test_store = Alexandria::LibraryStore.new(TESTDIR)
+Alexandria::LibraryCollection.instance.library_store = test_store
+
+RSpec.configure do |config|
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  config.before do
+    FileUtils.rm_rf(TESTDIR)
+  end
+
+  config.after do
+    FileUtils.rm_rf(TESTDIR)
   end
 end

data/tasks/setup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 #--
 # Copyright (C) 2011 Matijs van Zuijlen
 #
@@ -22,9 +24,9 @@
 # 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 'rake/clean'
+require "rake/clean"
 
 # Load the other rake files in the tasks folder
-tasks_dir = File.expand_path(File.dirname(__FILE__))
-rakefiles = Dir.glob(File.join(tasks_dir, '*.rake')).sort
+tasks_dir = __dir__
+rakefiles = Dir.glob(File.join(tasks_dir, "*.rake")).sort
 import(*rakefiles)

data/tasks/spec.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -*- ruby -*-
 #--
 # Copyright (C) 2011 Matijs van Zuijlen
@@ -24,8 +26,21 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
+
+namespace "spec" do
+  RSpec::Core::RakeTask.new("unit") do |t|
+    t.pattern = "spec/alexandria/**/*_spec.rb"
+    t.ruby_opts = ["-rbundler/setup -rsimplecov -Ilib -w"]
+  end
 
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.ruby_opts = ['-rbundler/setup -rsimplecov -Ilib -w']
+  RSpec::Core::RakeTask.new("end_to_end") do |t|
+    t.pattern = "spec/end_to_end/**/*_spec.rb"
+    t.ruby_opts = ["-rbundler/setup -rsimplecov -Ilib -w"]
+  end
+
+  desc "Runs all unit and end-to-end specs"
+  task "all" => ["spec:unit", "spec:end_to_end"]
 end
+
+task spec: "spec:all"

data/util/rake/fileinstall.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 # -*- ruby -*-
 #--
 # Copyright (C) 2009 Cathal Mc Ginley
-# Copyright (C) 2011 Matijs van Zuijlen
+# Copyright (C) 2011, 2020 Matijs van Zuijlen
 #
 # This file is part of the Alexandria build system.
 #
@@ -25,10 +27,10 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-require 'fileutils'
-require 'pathname'
-require 'set'
-require 'rake/tasklib'
+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
@@ -82,8 +84,8 @@ class FileInstallTask < Rake::TaskLib
 
     # INSTALL TASK
 
-    description = 'Install package files'
-    description += ' to staging directory' if @stage_dir
+    description = "Install package files"
+    description += " to staging directory" if @stage_dir
     desc description
     task tasknames[:install] do
       @file_groups.each { |g| g.install(@stage_dir) }
@@ -103,7 +105,7 @@ class FileInstallTask < Rake::TaskLib
       @dirs_to_remove_globs.each do |glob|
         regex = glob2regex(glob)
         all_dirs.each do |dir|
-          dir += '/' unless dir =~ /\/$/
+          dir += "/" unless dir.end_with?("/")
           to_delete << Regexp.last_match[1] if regex =~ dir
         end
       end
@@ -114,10 +116,8 @@ class FileInstallTask < Rake::TaskLib
       end
     end
 
-    uninstall_description = 'Uninstall package files'
-    if @stage_dir
-      uninstall_description += ' from staging directory'
-    end
+    uninstall_description = "Uninstall package files"
+    uninstall_description += " from staging directory" if @stage_dir
     desc uninstall_description
     task tasknames[:uninstall] => [tasknames[:uninstall_files],
                                    tasknames[:uninstall_dirs]]
@@ -145,7 +145,7 @@ class FileInstallTask < Rake::TaskLib
 
   # 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')
+  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|
@@ -154,7 +154,7 @@ class FileInstallTask < Rake::TaskLib
         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'
+        group.description = "icons"
         @file_groups << group
       end
     end
@@ -169,18 +169,16 @@ class FileInstallTask < Rake::TaskLib
   private
 
   def calculate_ruby_dir
-    ruby_prefix = RbConfig::CONFIG['prefix']
+    ruby_prefix = RbConfig::CONFIG["prefix"]
 
     ruby_libdir = if @install_to_rubylibdir
-                    RbConfig::CONFIG['rubylibdir']
+                    RbConfig::CONFIG["rubylibdir"]
                   else
-                    RbConfig::CONFIG['sitelibdir']
+                    RbConfig::CONFIG["sitelibdir"]
                   end
-    if ENV.key?('RUBYLIBDIR')
-      ruby_libdir = ENV['RUBYLIBDIR']
-    end
+    ruby_libdir = ENV["RUBYLIBDIR"] if ENV.key?("RUBYLIBDIR")
 
-    @prefix = ENV['PREFIX'] || ruby_prefix
+    @prefix = ENV["PREFIX"] || ruby_prefix
     if @prefix == ruby_prefix
       @rubylib = ruby_libdir
     elsif ruby_libdir.index(ruby_prefix).zero?
@@ -192,12 +190,12 @@ class FileInstallTask < Rake::TaskLib
   end
 
   def glob2regex(pathglob)
-    pathglob += '/' if pathglob =~ /\*\*$/
-    real_parts = pathglob.split('**/')
+    pathglob += "/" if pathglob.end_with?("**")
+    real_parts = pathglob.split("**/")
     real_parts.each do |part|
-      part.gsub!('.', '\\.')
-      part.gsub!('*', '[^\\/]*')
-      part.gsub!('?', '[^\\/]')
+      part.gsub!(".", '\\.')
+      part.gsub!("*", '[^\\/]*')
+      part.gsub!("?", '[^\\/]')
     end
     pattern = real_parts.join("([^\/]+\/)*")
     /(#{pattern})/
@@ -212,15 +210,16 @@ class FileInstallTask < Rake::TaskLib
     end
   end
 
-  # Delete the directory at the given Pathname +p+ if all its children
+  # Delete the directory at the given Pathname +path+ if all its children
   # can be similarly deleted, and if it is then empty.
-  def delete_if_empty(p)
-    return false unless p.directory?
-    p.children.each do |c|
+  def delete_if_empty(path)
+    return false unless path.directory?
+
+    path.children.each do |c|
       delete_if_empty(c)
     end
-    if p.children.empty?
-      p.delete # TODO: optional verbose output here
+    if path.children.empty?
+      path.delete # TODO: optional verbose output here
       true
     else
       false
@@ -230,12 +229,13 @@ class FileInstallTask < Rake::TaskLib
   class FileGroup
     attr_reader :mode
     attr_accessor :description
+
     def initialize(src_dir, file_glob, dest_dir, mode = 0o644)
       @src_dir = src_dir
       @file_glob = file_glob
       @dest_dir = dest_dir
       @mode = mode
-      @description = 'files'
+      @description = "files"
     end
 
     def to_s
@@ -267,10 +267,8 @@ class FileInstallTask < Rake::TaskLib
       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
+        FileUtils.mkdir_p(dest) unless test("d", dest)
+        FileUtils.install(f, dest, mode: mode) if test("f", f)
       end
     end
 
@@ -279,7 +277,7 @@ class FileInstallTask < Rake::TaskLib
         dest = dest_dir(f, base_dir)
         filename = File.basename(f)
         file = File.join(dest, filename)
-        if test('f', file)
+        if test("f", file)
           FileUtils::Verbose.rm_f(file) # , :noop => true)
         end
       end
@@ -293,5 +291,5 @@ class FileInstallTask < Rake::TaskLib
         all_dirs_set << File.dirname(file)
       end
     end
-  end # class FileGroup
-end # class FileInstallTask
+  end
+end

data/util/rake/gettextgenerate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # -*- ruby -*-
 #--
 # Copyright (C) 2009 Cathal Mc Ginley
@@ -24,9 +26,9 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-require 'fileutils'
-require 'pathname'
-require 'rake/tasklib'
+require "fileutils"
+require "pathname"
+require "rake/tasklib"
 
 class GettextGenerateTask < Rake::TaskLib
   def initialize(projectname)
@@ -37,27 +39,25 @@ class GettextGenerateTask < Rake::TaskLib
   end
 
   def make_task
-    desc 'Generate gettext localization files'
+    desc "Generate gettext localization files"
     task gettext: @generated_files
 
-    if CLOBBER
-      @generated_files.each { |gen| CLOBBER << gen }
-    end
+    @generated_files.each { |gen| CLOBBER << gen } if CLOBBER
   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/
+    @mo_files_regex = %r{.*/(.+)/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.nonzero?
+      result = system("msgfmt #{t.source} -o #{t.name}")
+      raise "msgfmt failed for #{t.source}" unless result
     end
     mo_files.each { |mo| @generated_files << mo }
   end
@@ -69,15 +69,17 @@ class GettextGenerateTask < Rake::TaskLib
   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'
+      begin
+        `intltool-merge --version`
+      rescue Errno::ENOENT
+        raise "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] }
+    po_files.map { |po| File.basename(po).split(".")[0] }
   end
 
   def mo_files
@@ -97,60 +99,3 @@ class GettextGenerateTask < Rake::TaskLib
     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