alexandria-book-collection-manager 0.7.1 → 0.7.6

data/lib/alexandria/net.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (C) 2009 Cathal Mc Ginley
 # Copyright (C) 2014 Matijs van Zuijlen
 #
@@ -22,7 +24,7 @@ module Alexandria
   class WWWAgent
     def initialize
       user_agent = "Ruby #{RUBY_VERSION} #{Alexandria::TITLE}/#{Alexandria::VERSION}"
-      @extra_request_headers = { 'User-Agent' => user_agent }
+      @extra_request_headers = { "User-Agent" => user_agent }
     end
 
     def self.transport
@@ -36,18 +38,17 @@ module Alexandria
       @extra_request_headers.each_pair do |header_name, value|
         req.add_field(header_name, value)
       end
-      res = WWWAgent.transport.start(uri.host, uri.port) { |http|
+      WWWAgent.transport.start(uri.host, uri.port) do |http|
         http.request(req)
-      }
-      res
+      end
     end
 
     def language=(lang)
-      @extra_request_headers['Accept-Language'] = lang.to_s
+      @extra_request_headers["Accept-Language"] = lang.to_s
     end
 
     def user_agent=(agent_string)
-      @extra_request_headers['User-Agent'] = agent_string
+      @extra_request_headers["User-Agent"] = agent_string
     end
   end
 end

data/lib/alexandria/preferences.rb

@@ -1,37 +1,24 @@
-# Copyright (C) 2004-2006 Laurent Sansonetti
-# Copyright (C) 2011 Cathal Mc Ginley
-# Copyright (C) 2011, 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.
 
-require 'singleton'
-require 'set'
-require 'alexandria/default_preferences'
+require "singleton"
+require "set"
+require "alexandria/default_preferences"
 
 module Alexandria
   class Preferences
     include Singleton
     include Logging
 
-    APP_DIR = '/apps/alexandria'.freeze
-    HTTP_PROXY_DIR = '/system/http_proxy'.freeze
-    HTTP_PROXY_MODE = '/system/proxy/mode'.freeze
-    URL_HANDLERS_DIR = '/desktop/gnome/url-handlers'.freeze
+    APP_DIR = "/apps/alexandria"
+    HTTP_PROXY_DIR = "/system/http_proxy"
+    HTTP_PROXY_MODE = "/system/proxy/mode"
+    URL_HANDLERS_DIR = "/desktop/gnome/url-handlers"
 
-    GCONFTOOL = 'gconftool-2'.freeze
+    GCONFTOOL = "gconftool-2"
 
     def initialize
       @alexandria_settings = {}
@@ -59,38 +46,35 @@ module Alexandria
     end
 
     def save!
-      log.debug { 'preferences save!' }
+      log.debug { "preferences save!" }
       @changed_settings.each do |variable_name|
-        log.debug { "saving preference #{variable_name} / #{@alexandria_settings[variable_name].class}" }
+        log.debug do
+          klass = @alexandria_settings[variable_name].class
+          "saving preference #{variable_name} / #{klass}"
+        end
         generic_save_setting(variable_name, @alexandria_settings[variable_name])
       end
       @changed_settings.clear
     end
 
-    def method_missing(id, *args)
-      method = id.id2name
-      if (match = /(.*)=$/.match(method))
-        if args.length != 1
-          raise "Set method #{method} should be called with " \
-            "only one argument (was called with #{args.length})"
-        end
-        variable_name = match[1]
-        new_value = args.first
-        generic_setter(variable_name, new_value)
-      else
-        unless args.empty?
-          raise "Get method #{method} should be called " \
-            "without argument (was called with #{args.length})"
-        end
-        generic_getter(method)
-      end
-    end
-
     def remove_preference(variable_name)
       @alexandria_settings.delete(variable_name)
       @changed_settings << variable_name
     end
 
+    DEFAULT_VALUES.each_key do |var|
+      define_method(var) { generic_getter var }
+      define_method("#{var}=") { |val| generic_setter var, val }
+    end
+
+    def get_variable(variable_name)
+      generic_getter(variable_name.to_s)
+    end
+
+    def set_variable(variable_name, value)
+      generic_setter(variable_name.to_s, value)
+    end
+
     private
 
     ##
@@ -116,13 +100,11 @@ module Alexandria
       end
       old_value = @alexandria_settings[variable_name]
       @alexandria_settings[variable_name] = new_value
-      unless new_value == old_value
-        @changed_settings << variable_name
-      end
+      @changed_settings << variable_name unless new_value == old_value
     end
 
     def generic_save_setting(variable_name, new_value)
-      var_path = APP_DIR + '/' + variable_name
+      var_path = APP_DIR + "/" + variable_name
       if new_value.is_a?(Array)
         # when setting array, first remove nil elements (fixing #9007)
         new_value.compact!
@@ -132,17 +114,17 @@ module Alexandria
           # set list value
           exec_gconf_set_list(var_path, new_value)
         end
+      elsif new_value.nil?
+        exec_gconf_unset(variable_name)
       else
         # set non-list value
-        if new_value.nil?
-          exec_gconf_unset(variable_name)
-        else
-          exec_gconf_set(var_path, new_value)
-        end
+        exec_gconf_set(var_path, new_value)
       end
-    rescue => ex
+    rescue StandardError => ex
       log.debug { new_value.inspect }
-      log.error { "Could not set GConf setting #{variable_name} to value: #{new_value.inspect}" }
+      log.error do
+        "Could not set GConf setting #{variable_name} to value: #{new_value.inspect}"
+      end
       log << ex.message
       log << ex
     end
@@ -152,14 +134,15 @@ module Alexandria
     ##
 
     def get_gconf_type(value)
-      if value.is_a?(String)
-        'string'
-      elsif value.is_a?(Integer)
-        'int'
-      elsif value.is_a?(TrueClass) || value.is_a?(FalseClass)
-        'bool'
+      case value
+      when String
+        "string"
+      when Integer
+        "int"
+      when TrueClass, FalseClass
+        "bool"
       else
-        'string'
+        "string"
       end
     end
 
@@ -167,7 +150,7 @@ module Alexandria
       # NOTE we must check between list and pair...
 
       list_type = get_gconf_type(new_list.first)
-      if list_type == 'int' && new_list.size == 2
+      if list_type == "int" && new_list.size == 2
         # treat this as a pair of int
         a = new_list[0]
         b = new_list[1]
@@ -180,31 +163,29 @@ module Alexandria
     end
 
     def make_list_string(list)
-      if get_gconf_type(list.first) == 'string'
-        list.map! { |x| x.gsub(/\"/, '\\"') }
-      end
-      contents = list.join(',')
-      '[' + contents + ']'
+      list.map! { |x| x.gsub(/"/, '\\"') } if get_gconf_type(list.first) == "string"
+      contents = list.join(",")
+      "[" + contents + "]"
     end
 
     def exec_gconf_set(var_path, new_value)
-      if /cols_width/ =~ var_path
-        puts new_value
+      if /cols_width/.match?(var_path)
+        log.debug { new_value }
 
         # new_value = {}
       end
       type = get_gconf_type(new_value)
       value_str = new_value
       if new_value.is_a? String
-        new_value.gsub!(/\"/, '\\"')
+        new_value = new_value.gsub(/"/, '\\"')
         value_str = "\"#{new_value}\""
       end
-      puts value_str if /cols_width/ =~ var_path
+      log.debug { value_str } if /cols_width/.match?(var_path)
       `gconftool-2 --type #{type} --set #{var_path} #{value_str}`
     end
 
     def exec_gconf_unset(variable_name)
-      `#{GCONFTOOL} --unset #{APP_DIR + '/' + variable_name}`
+      `#{GCONFTOOL} --unset #{APP_DIR + "/" + variable_name}`
     end
 
     ##
@@ -224,14 +205,14 @@ module Alexandria
     def load_http_proxy_settings
       http_proxy_vars = `#{GCONFTOOL} --recursive-list #{HTTP_PROXY_DIR}`
       http_proxy = gconftool_values_to_hash(http_proxy_vars)
-      if http_proxy['use_http_proxy']
+      if http_proxy["use_http_proxy"]
         proxy_mode = `#{GCONFTOOL} --get #{HTTP_PROXY_MODE}`.chomp
-        if proxy_mode == 'manual'
+        if proxy_mode == "manual"
           @use_http_proxy = true
-          @proxy_host = http_proxy['host']
-          @proxy_port = http_proxy['port']
-          @proxy_user = http_proxy['authentication_user']
-          @proxy_password = http_proxy['authentication_n_password']
+          @proxy_host = http_proxy["host"]
+          @proxy_port = http_proxy["port"]
+          @proxy_user = http_proxy["authentication_user"]
+          @proxy_password = http_proxy["authentication_n_password"]
         end
       end
       @http_proxy_loaded = true
@@ -256,20 +237,21 @@ module Alexandria
     # gconftool. This is not fool-proof, but it *does* work for the
     # range of values used by Alexandria.
     def discriminate(value)
-      if value == 'true'        # bool
+      case value
+      when "true" # bool
         true
-      elsif value == 'false'    # bool
+      when "false"    # bool
         false
-      elsif value =~ /^[0-9]+$/   # int
+      when /^[0-9]+$/ # int
         value.to_i
-      elsif value =~ /^\[(.*)\]$/ # list (assume of type String)
-        Regexp.last_match[1].split(',')
-      elsif value =~ /^\((.*)\)$/ # pair (assume of type int)
+      when /^\[(.*)\]$/ # list (assume of type String)
+        Regexp.last_match[1].split(",")
+      when /^\((.*)\)$/ # pair (assume of type int)
         begin
-          pair = Regexp.last_match[1].split(',')
-          return [discriminate(pair.first), discriminate(pair.last)]
-        rescue
-          return [0, 0]
+          pair = Regexp.last_match[1].split(",")
+          [discriminate(pair.first), discriminate(pair.last)]
+        rescue StandardError
+          [0, 0]
         end
       else
         value # string

data/lib/alexandria/scanners.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (C) 2005-2006 Christopher Cyll
 # Copyright (C) 2014-2016 Matijs van Zuijlen
 #
@@ -38,8 +40,8 @@ module Alexandria
       registry.find { |scanner| scanner.name == name }
     end
 
-    def self.each_scanner
-      registry.each { |scanner| yield scanner }
+    def self.each_scanner(&block)
+      registry.each(&block)
     end
 
     private_class_method :registry

data/lib/alexandria/scanners/{cuecat.rb → cue_cat.rb}

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (C) 2005-2006 Christopher Cyll
 # Copyright (C) 2011 Matijs van Zuijlen
 #
@@ -16,28 +18,30 @@
 # write to the Free Software Foundation, Inc., 51 Franklin Street,
 # Fifth Floor, Boston, MA 02110-1301 USA.
 
-require 'alexandria/scanners'
+require "alexandria/scanners"
 
 module Alexandria
   module Scanners
     class CueCat
-      include Alexandria::Logging
+      include Logging
 
       def name
-        'CueCat'
+        "CueCat"
       end
 
       def display_name
-        'CueCat'
+        "CueCat"
       end
 
       # Checks if data looks like cuecat input
       def match?(data)
-        data.chomp!
-        return false if data[-1] != '.'
-        fields = data.split('.')
+        data = data.chomp
+        return false if data[-1] != "."
+
+        fields = data.split(".")
         return false if fields.size != 4
         return false if fields[2].size != 4
+
         true
       end
 
@@ -45,14 +49,14 @@ module Alexandria
       # The following code is adapted from Skip Rosebaugh's public
       # domain perl implementation.
       def decode(data)
-        data.chomp!
-        fields = data.split('.')
+        data = data.chomp
+        fields = data.split(".")
         fields.shift # First part is gibberish
         fields.shift # Second part is cuecat serial number
         type, code = fields.map { |field| decode_field(field) }
 
-        if type == 'IB5'
-          type = 'IBN'
+        if type == "IB5"
+          type = "IBN"
           code = code[0, 13]
         end
 
@@ -60,33 +64,33 @@ module Alexandria
           if Library.valid_upc? code
             isbn13 = Library.canonicalise_ean(code)
             code = isbn13
-            type = 'IBN'
+            type = "IBN"
           end
-        rescue
+        rescue StandardError
           log.debug { "Cannot translate UPC (#{type}) code #{code} to ISBN" }
         end
 
-        return code if type == 'IBN'
+        return code if type == "IBN"
 
-        raise "Don't know how to handle type #{type} (barcode: #{code})"
+        raise format(_("Don't know how to handle type %<type>s (barcode: %<code>s)"),
+                     type: type, code: code)
       end
 
       private
 
       def decode_field(encoded)
-        seq = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-'
+        seq = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-"
 
         chars   = encoded.split(//)
         values  = chars.map { |c| seq.index(c) }
 
         padding = pad(values)
         result  = calc(values)
-        result  = result[0, result.length - padding]
-        result
+        result[0, result.length - padding]
       end
 
       def calc(values)
-        result = ''
+        result = ""
         until values.empty?
           num = ((values[0] << 6 | values[1]) << 6 | values[2]) << 6 | values[3]
           result += ((num >> 16) ^ 67).chr
@@ -102,7 +106,7 @@ module Alexandria
         length = array.length % 4
 
         if length.nonzero?
-          raise 'Error parsing CueCat input' if length == 1
+          raise _("Error parsing CueCat input") if length == 1
 
           length = 4 - length
           length.times { array.push(0) }

data/lib/alexandria/scanners/keyboard.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (C) 2005-2006 Christopher Cyll
 # Copyright (C) 2008 Cathal Mc Ginley
 #
@@ -16,7 +18,7 @@
 # write to the Free Software Foundation, Inc., 51 Franklin Street,
 # Fifth Floor, Boston, MA 02110-1301 USA.
 
-require 'alexandria/scanners'
+require "alexandria/scanners"
 
 module Alexandria
   module Scanners
@@ -25,28 +27,28 @@ module Alexandria
     # like this.)
     class KeyboardWedge
       def name
-        'KeyboardWedge'
+        "KeyboardWedge"
       end
 
       def display_name
-        'Keyboard Wedge'
+        "Keyboard Wedge"
       end
 
       # Checks if data looks like a completed scan
       def match?(data)
-        data.gsub!(/\s/, '')
+        data.gsub!(/\s/, "")
         (data =~ /[0-9]{12,18}/) || (data =~ /[0-9]{9}[0-9Xx]/)
       end
 
       # Gets the essential 13-digits from an ISBN barcode (EAN-13)
       def decode(data)
-        data.gsub!(/\s/, '')
+        data.gsub!(/\s/, "")
         if data.length == 10
-          return data
+          data
         elsif data.length >= 13
-          return data[0, 13]
+          data[0, 13]
         else
-          raise "Unknown scan data #{data}"
+          raise format(_("Unknown scan data %s<data>"), data: data)
         end
       end
     end