pandocomatic 0.2.8 → 1.0.0

data/lib/pandocomatic/command/convert_file_multiple_command.rb

@@ -1,31 +1,32 @@
+# frozen_string_literal: true
+
 #--
-# Copyright 2017, Huub de Beer <Huub@heerdebeer.org>
-# 
+# Copyright 2017, 2022, Huub de Beer <Huub@heerdebeer.org>
+#
 # This file is part of pandocomatic.
-# 
+#
 # Pandocomatic 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 3 of the License, or (at your
 # option) any later version.
-# 
+#
 # Pandocomatic 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 pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Pandocomatic
+  require_relative '../error/io_error'
 
-  require_relative '../error/io_error.rb'
-
-  require_relative 'command.rb'
-  require_relative 'create_link_command.rb'
-  require_relative 'convert_file_command.rb'
-  require_relative 'convert_list_command.rb'
-  require_relative 'copy_file_command.rb'
-  require_relative 'skip_command.rb'
+  require_relative 'command'
+  require_relative 'create_link_command'
+  require_relative 'convert_file_command'
+  require_relative 'convert_list_command'
+  require_relative 'copy_file_command'
+  require_relative 'skip_command'
 
   # Create a command to convert one file multiple times
   #
@@ -33,9 +34,10 @@ module Pandocomatic
   #   @return [Command[]] the subcommands to execute when running this
   #   ConvertFileMultipleCommand
   class ConvertFileMultipleCommand < ConvertListCommand
-
     attr_reader :subcommands
 
+    # rubocop:disable Metrics
+
     # Create a new ConvertFileMultipleCommand
     #
     # @param config [Configuration] Pandocomatic's configuration used to
@@ -43,63 +45,64 @@ module Pandocomatic
     # @param src [String] the file to convert
     # @param dst [String] the output file
     def initialize(config, src, dst)
-        super()
-        @config = config
-        @src = src
+      super()
+      @config = config
+      @src = src
+
+      metadata = PandocMetadata.load_file @src
 
-        metadata = PandocMetadata.load_file @src
+      subcommands = []
 
-        subcommands = []
+      if metadata.template?
+        # There are templates in this document's metadata, try to use
+        # those.
+        metadata.templates.each do |template_name|
+          unless template_name.empty? || config.template?(template_name)
+            raise ConfigurationError.new(:no_such_template, nil,
+                                         template_name)
+          end
 
-        if metadata.has_template?
-            # There are templates in this document's metadata, try to use
-            # those. 
-            metadata.templates.each do |template_name|
-                raise ConfigurationError.new(:no_such_template, nil, template_name) unless template_name.empty? or config.has_template? template_name
+          subcommands.push ConvertFileCommand.new(@config, @src, dst, template_name)
+        end
+      else
+        # Try to match any global templates using the glob patterns
+        global_templates = @config.determine_templates(@src)
 
-                subcommands.push ConvertFileCommand.new(@config, @src, dst, template_name)
-            end
+        if global_templates.empty?
+          subcommands.push ConvertFileCommand.new(@config, @src, dst)
         else
-            # Try to match any global templates using the glob patterns
-            global_templates = @config.determine_templates(@src)
-                
-            if global_templates.empty?
-                subcommands.push ConvertFileCommand.new(@config, @src, dst)
-            else
-                global_templates.each do |template_name|
-                    subcommands.push ConvertFileCommand.new(@config, @src, dst, template_name)
-                end
-            end
+          global_templates.each do |template_name|
+            subcommands.push ConvertFileCommand.new(@config, @src, dst, template_name)
+          end
         end
+      end
 
-        # Only run a command if the src file is modified, or if the modified
-        # setting is ignored.
-        subcommands.each do |subcommand|
-            if not modified_only? or file_modified? @src, subcommand.dst then
-                push subcommand unless subcommand.nil? or subcommand.skip?
-            end
+      # Only run a command if the src file is modified, or if the modified
+      # setting is ignored.
+      subcommands.each do |subcommand|
+        if (!modified_only? || file_modified?(@src, subcommand.dst)) && !(subcommand.nil? || subcommand.skip?)
+          push subcommand
         end
+      end
     end
 
+    # rubocop:enable Metrics
 
     # A string representation of this command
     #
     # @return [String]
-    def to_s()
-        "converting #{@src} #{@subcommands.size} time#{'s' if @subcommands.size != 1}:"
+    def to_s
+      "converting #{@src} #{@subcommands.size} time#{'s' if @subcommands.size != 1}:"
     end
 
     # Execute this ConvertFileMultipleCommand
-    def execute()
-      if not @subcommands.empty?
-        CommandPrinter.new(self).print unless quiet? or @subcommands.size == 1
-        run if not dry_run? and runnable?
+    def execute
+      return if @subcommands.empty?
 
-        @subcommands.each do |subcommand|
-          subcommand.execute
-        end
-      end
-    end
+      CommandPrinter.new(self).print unless quiet? || (@subcommands.size == 1)
+      run if !dry_run? && runnable?
 
+      @subcommands.each(&:execute)
+    end
   end
 end

data/lib/pandocomatic/command/convert_list_command.rb

@@ -1,41 +1,41 @@
+# frozen_string_literal: true
+
 #--
-# Copyright 2017, Huub de Beer <Huub@heerdebeer.org>
-# 
+# Copyright 2017, 2022, Huub de Beer <Huub@heerdebeer.org>
+#
 # This file is part of pandocomatic.
-# 
+#
 # Pandocomatic 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 3 of the License, or (at your
 # option) any later version.
-# 
+#
 # Pandocomatic 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 pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Pandocomatic
+  require_relative '../error/io_error'
 
-  require_relative '../error/io_error.rb'
-
-  require_relative 'command.rb'
-  require_relative 'create_link_command.rb'
-  require_relative 'convert_file_command.rb'
-  require_relative 'copy_file_command.rb'
-  require_relative 'skip_command.rb'
+  require_relative 'command'
+  require_relative 'create_link_command'
+  require_relative 'convert_file_command'
+  require_relative 'copy_file_command'
+  require_relative 'skip_command'
 
   # A Command with sub commands
   #
   # @!attribute subcommands
   #   @return [Command[]] the subcommands of this ConvertListCommand
   class ConvertListCommand < Command
-
     attr_reader :subcommands
 
     # Create a new ConvertListCommand
-    def initialize()
+    def initialize
       super()
       @subcommands = []
     end
@@ -44,58 +44,55 @@ module Pandocomatic
     #
     # @param command [Command] command to add
     def push(command)
-        @subcommands.push command
+      @subcommands.push command
     end
 
     # Skip this ConvertListCommand when there are no sub commands
     #
     # @return [Boolean]
-    def skip?()
+    def skip?
       @subcommands.empty?
     end
 
     # The number of commands to execute when this ConvertListCommand
     # is executed.
-    def count()
-      @subcommands.reduce(if skip? then 0 else 1 end) do |total, subcommand|
-        total += subcommand.count
+    def count
+      @subcommands.reduce(0) do |total, subcommand|
+        total + subcommand.count
       end
     end
 
     # Get a list of all errors generated while running this command
     #
-    # @return [Error[]]  
-    def all_errors()
+    # @return [Error[]]
+    def all_errors
       @subcommands.reduce(@errors) do |total, subcommand|
-        total += subcommand.all_errors
+        total + subcommand.all_errors
       end
     end
 
     # A string representation of this ConvertListCommand
     #
     # @return [String]
-    def to_s()
-        "converting #{@subcommands.size} items:"
+    def to_s
+      "converting #{@subcommands.size} items:"
     end
 
     # Can this command have multiple commands?
     #
     # @return [Boolean] true
     def multiple?
-        true
+      true
     end
 
     # Execute this ConvertListCommand
-    def execute()
-      if not @subcommands.empty?
-        CommandPrinter.new(self).print unless quiet?
-        run if not dry_run? and runnable?
+    def execute
+      return if @subcommands.empty?
 
-        @subcommands.each do |subcommand|
-          subcommand.execute
-        end
-      end
-    end
+      CommandPrinter.new(self).print unless quiet?
+      run if !dry_run? && runnable?
 
+      @subcommands.each(&:execute)
+    end
   end
 end

data/lib/pandocomatic/command/copy_file_command.rb

@@ -1,26 +1,28 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2017, Huub de Beer <Huub@heerdebeer.org>
-# 
+#
 # This file is part of pandocomatic.
-# 
+#
 # Pandocomatic 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 3 of the License, or (at your
 # option) any later version.
-# 
+#
 # Pandocomatic 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 pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Pandocomatic
   require 'fileutils'
 
-  require_relative '../error/io_error.rb'
-  require_relative 'command.rb'
+  require_relative '../error/io_error'
+  require_relative 'command'
 
   # A command to copy a file
   #
@@ -38,24 +40,21 @@ module Pandocomatic
       @src = src
       @dst = dst
       @errors.push IOError.new(:file_is_not_readable, nil, @src) unless File.readable? @src
-      @errors.push IOError.new(:file_is_not_writable, nil, @dst) unless not File.exist?(@dst) or File.writable?(@dst)
+      @errors.push IOError.new(:file_is_not_writable, nil, @dst) unless !File.exist?(@dst) || File.writable?(@dst)
     end
 
     # Run this CopyFileCommand
-    def run()
-      begin
-        FileUtils.cp(@src, @dst) if file_modified?(@src, @dst)
-      rescue StandardError => e
-        raise IOError.new(:unable_to_copy_file, e, [@src, @dst])
-      end
+    def run
+      FileUtils.cp(@src, @dst) if file_modified?(@src, @dst)
+    rescue StandardError => e
+      raise IOError.new(:unable_to_copy_file, e, [@src, @dst])
     end
 
     # A string representation of this CopyFileCommand
     #
     # @return [String]
-    def to_s()
+    def to_s
       "copy #{File.basename @src}"
     end
-    
   end
 end

data/lib/pandocomatic/command/create_link_command.rb

@@ -1,28 +1,29 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2017, Huub de Beer <Huub@heerdebeer.org>
-# 
+#
 # This file is part of pandocomatic.
-# 
+#
 # Pandocomatic 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 3 of the License, or (at your
 # option) any later version.
-# 
+#
 # Pandocomatic 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 pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Pandocomatic
+  require_relative 'command'
 
-  require_relative 'command.rb'
-
-  require_relative '../warning.rb'
-  require_relative '../error/io_error.rb'
-  require_relative '../printer/warning_printer.rb'
+  require_relative '../warning'
+  require_relative '../error/io_error'
+  require_relative '../printer/warning_printer'
 
   # A command to create a link to a file
   #
@@ -35,7 +36,6 @@ module Pandocomatic
   # @!attribute dst_target
   #   @return [String] the link in the destination tree to link to
   class CreateLinkCommand < Command
-
     attr_reader :src, :dst, :dst_target
 
     # Create a new CreateLinkCommand
@@ -48,10 +48,10 @@ module Pandocomatic
       begin
         src_target = File.readlink @src
 
-        if src_target.start_with? '.' then
+        if src_target.start_with? '.'
           full_src_target = File.expand_path src_target, File.dirname(src)
 
-          if full_src_target.start_with? src_root()
+          if full_src_target.start_with? src_root
             @dst = dst
             @dst_target = src_target
           else
@@ -66,39 +66,37 @@ module Pandocomatic
     end
 
     # Run this CreateLinkCommand
-    def run()
-      begin
-        File.symlink @dst_target, @dst unless File.exist? @dst
-      rescue StandardError => e
-        raise IOError.new(:unable_to_create_symbolic_link, e, [@src, @dst])
-      end
+    def run
+      File.symlink @dst_target, @dst unless File.exist? @dst
+    rescue StandardError => e
+      raise IOError.new(:unable_to_create_symbolic_link, e, [@src, @dst])
     end
 
     # Can this CreateLinkCommand be run?
     #
     # @return [Boolean] True if there are no errors and both source and
     #   destination do exist
-    def runnable?()
-      not (has_errors? or @dst.nil? or @dst_target.nil? or @src.nil?)
+    def runnable?
+      !(errors? or @dst.nil? or @dst_target.nil? or @src.nil?)
     end
 
     # Create a string representation of this CreateLinkCommand
-    def to_s()
+    def to_s
       "link #{File.basename @dst} -> #{@dst_target}"
     end
 
     # Should this CreateLinkCommand be skipped?
     #
     # @return [Boolean]
-    def skip?()
-      not modified_only? or not modified?
+    def skip?
+      !modified_only? or !modified?
     end
-    
+
     # Has the source file been modified?
     #
     # @return [Boolean]
-    def modified?()
-      if File.exist? @dst then
+    def modified?
+      if File.exist? @dst
         absolute_dst = File.realpath @dst
         target = File.expand_path(@dst_target, absolute_dst)
         absolute_dst != target
@@ -106,6 +104,5 @@ module Pandocomatic
         true
       end
     end
-
   end
 end

data/lib/pandocomatic/command/skip_command.rb

@@ -1,24 +1,25 @@
+# frozen_string_literal: true
+
 #--
 # Copyright 2017, Huub de Beer <Huub@heerdebeer.org>
-# 
+#
 # This file is part of pandocomatic.
-# 
+#
 # Pandocomatic 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 3 of the License, or (at your
 # option) any later version.
-# 
+#
 # Pandocomatic 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 pandocomatic.  If not, see <http://www.gnu.org/licenses/>.
 #++
 module Pandocomatic
-
-  require_relative 'command.rb'
+  require_relative 'command'
 
   # A command to skip a file or directory
   #
@@ -44,18 +45,17 @@ module Pandocomatic
     # Has this SkipCommand a message?
     #
     # @return [Boolean]
-    def has_message?()
-      not(@message.nil? or @message.empty?)
+    def message?
+      !((@message.nil? or @message.empty?))
     end
 
     # 'Run' this SkipCommand by doing nothing
-    def run()
-    end
+    def run; end
 
     # Skip this command
     #
     # @return [Boolean] true
-    def skip?()
+    def skip?
       true
     end
 
@@ -63,10 +63,7 @@ module Pandocomatic
     #
     # @return [String]
     def to_s
-      "skipping #{File.basename @src}" + if has_message?
-        ": #{@message.to_s}"
-      end
+      "skipping #{File.basename @src}" + (": #{@message}" if message?)
     end
-
   end
 end