pandocomatic 0.2.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1284979156a2581d20af236ed7d72345f31b072070be957977636a5f8cccc75
-  data.tar.gz: 321ac5998d2041ec5a7860c5fe6dbe0854bd41855ba42def4ee2743a4be8c908
+  metadata.gz: f8185106783d727335ad8c571251e9352c99ae9c135c073db975d42bed3b567f
+  data.tar.gz: 99b41c4033cb7e39c060aa4f3affae90f4c50c9ac65d0bd2bf0fb823cd897345
 SHA512:
-  metadata.gz: 1484fa4d1cfae0b195e5d238c11e5f9e2d346cb9b4891ee83b17268fc867ab098da810032a6edf5551c89b58516dd3e6f84fc7005f58a0f2b452187d608cc001
-  data.tar.gz: 8dfeb39e74c7621f9d55e50a43a0dc3dfb0d6ac1d2ef680b0dee0c27cd47438c836af89958d18b7d7cf68b181f15260815d733f72e04421de3d4118c5f7d195e
+  metadata.gz: feed8b1cc30bf78341c357dcf44ada7f9f88ef4f74b4ab847a4e592d1ddfddcb3754d0a38b050e8c6b282a0ee3122dc0a5a3bf5d5157f58c9331121dc6cc0d21
+  data.tar.gz: 9ea7f3801f2bd93a3fadf5399d0597a046e6fecfb46f57da8f8eccc3e6ba2a5bddc7c706a6a192f1b21f10ada40882c331e68a3bdfa475f83595b79c251cee32

data/lib/pandocomatic/cli.rb

@@ -1,37 +1,38 @@
+# frozen_string_literal: true
+
 #--
-# Copyright 2017-2019, 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 'optimist'
 
-  require_relative './error/cli_error.rb'
-  require_relative './configuration.rb'
+  require_relative './error/cli_error'
+  require_relative './configuration'
 
   ##
   # Command line options parser for pandocomatic using optimist.
   #
   class CLI
-
     ##
     # Parse the arguments, returns a triplet with the global options, an
     # optional subcommand, and the (optional) options for that subcommand.
     #
-    # @param args [String, Array] A command line invocation string or a list of strings like ARGV
+    # @param args [String, Array] A command-line invocation string or a list of strings like ARGV
     #
     # @return [Configuration] The configuration for running pandocomatic given
     # the command-line options.
@@ -39,39 +40,38 @@ module Pandocomatic
       args = args.split if args.is_a? String
 
       begin
-        parse_options args || Configuration.new({:help => true, :help_given => true})
+        parse_options args || Configuration.new({ help: true, help_given: true })
       rescue Optimist::CommandlineError => e
         raise CLIError.new(:problematic_invocation, e, args)
       end
     end
 
-    private 
+    # rubocop:disable Metrics
 
     # Parse pandocomatic's global options.
     #
     # @return [Configuration]
-    def self.parse_options(args)
+    private_class_method def self.parse_options(args)
       parser = Optimist::Parser.new do
-        # General options 
-        opt :dry_run, 'Do a dry run', :short => '-y'
-        opt :quiet, 'Run quietly', :short => '-q'
-        opt :debug, 'Debug mode, shows pandoc invocations', :short => '-b'
-        opt :modified_only, 'Modified files only', :short => '-m'
+        # General options
+        opt :dry_run, 'Do a dry run', short: '-y'
+        opt :verbose, 'Run verbosely', short: '-V'
+        opt :debug, 'Debug mode, shows pandoc invocations', short: '-b'
+        opt :modified_only, 'Modified files only', short: '-m'
 
         # Configuration of the converter
-        opt :data_dir, 'Data dir', :short => '-d', :type => String
-        opt :config, 'Configuration file', :short => '-c', :type => String
+        opt :data_dir, 'Data dir', short: '-d', type: String
+        opt :config, 'Configuration file', short: '-c', type: String
+        opt :root_path, 'Root path', short: '-r', type: String
 
         # What to convert and where to put it
-        opt :output, 'Output', :short => '-o', :type => String
-        opt :input, 'Input', :short => '-i', :type => String, :multi => true
-
-        # Experimental
-        opt :root_path, 'Root path', :short => '-r', :type => String
+        opt :output, 'Output', short: '-o', type: String
+        opt :input, 'Input', short: '-i', type: String, multi: true
+        opt :stdout, 'Output to standard out', short: '-s'
 
         # Common
-        opt :show_version, 'Version', :short => '-v', :long => 'version'
-        opt :show_help, 'Help', :short => '-h', :long => 'help'
+        opt :show_version, 'Version', short: '-v', long: 'version'
+        opt :show_help, 'Help', short: '-h', long: 'help'
       end
 
       # All options should be parsed according to the specification given in the parser
@@ -80,55 +80,71 @@ module Pandocomatic
       rescue Optimist::CommandlineError => e
         raise CLIError.new(:problematic_invocation, e, args)
       end
-      
+
       options = use_custom_version options
       options = use_custom_help options
 
       if options_need_to_be_validated? options
         # if no input option is specified, all items following the last option
         # are treated as input files.
-        if not options[:input_given]
+        if !(options[:input_given])
           options[:input] = args
           options[:input_given] = true
-        elsif not args.empty?
-          raise CLIError.new(:no_mixed_inputs)
+        elsif !args.empty?
+          raise CLIError, :no_mixed_inputs
         end
 
         # There should be an input specified
-        raise CLIError.new(:no_input_given) if options[:input].nil? or options[:input].empty?
+        raise CLIError, :no_input_given if options[:input].nil? || options[:input].empty?
 
         # Support multiple input files for conversion
-        multiple_inputs = 1 < options[:input].size
+        multiple_inputs = options[:input].size > 1
 
         # The input files or directories should exist
         input = options[:input].map do |input_file|
           raise CLIError.new(:input_does_not_exist, nil, input_file) unless File.exist? input_file
           raise CLIError.new(:input_is_not_readable, nil, input_file) unless File.readable? input_file
-        
+
           # If there are multiple input files, these files cannot be directories
-          raise CLIError.new(:multiple_input_files_only, nil, input_file) if multiple_inputs and File.directory? input_file
-          
+          if multiple_inputs && File.directory?(input_file)
+            raise CLIError.new(:multiple_input_files_only, nil,
+                               input_file)
+          end
+
           File.absolute_path input_file
         end
 
+        # You cannot use the --stdout option while converting directories
+        if options[:stdout_given] && File.directory?(input.first)
+          options[:stdout] = false
+          raise CLIError, :cannot_use_stdout_with_directory
+        end
+
         if options[:output_given]
-          output = File.absolute_path options[:output]
-          # Input and output should be both files or directories
-          match_file_types input.first, output
-
-          # The output, if it already exist, should be writable
-          raise CLIError.new(:output_is_not_writable, nil, output) unless not File.exist? output or File.writable? output
-        else
-          # If the input is a directory, an output directory should be
-          # specified as well. If the input is a file, the output could be
-          # specified in the input file, or STDOUT could be used.
-          raise CLIError.new(:no_output_given) if not multiple_inputs and File.directory? input.first
+          # You cannot use --stdout with --output
+          if options[:stdout_given]
+            options[:stdout] = false
+            raise CLIError, :cannot_use_both_output_and_stdout
+          else
+            output = File.absolute_path options[:output]
+            # Input and output should be both files or directories
+            match_file_types input.first, output
+
+            # The output, if it already exist, should be writable
+            unless (!File.exist? output) || File.writable?(output)
+              raise CLIError.new(:output_is_not_writable, nil,
+                                 output)
+            end
+          end
+        elsif !multiple_inputs && File.directory?(input.first)
+          raise CLIError, :no_output_given
         end
+        # If the input is a directory, an output directory should be
+        # specified as well. If the input is a file, the output could be
+        # specified in the input file, or STDOUT could be used.
 
         # No check for root_path: a user can supply one that does not exists
         # at this location and still work on the output location.
-        if options[:root_path_given]
-        end
 
         # Data dir, if specified, should be an existing and readable directory
         if options[:data_dir_given]
@@ -148,13 +164,15 @@ module Pandocomatic
           raise CLIError.new(:config_file_is_not_a_file, nil, config) unless File.file? config
         end
 
-      end 
+      end
 
       Configuration.new options, input
     end
 
-    def self.options_need_to_be_validated? options
-      not options[:version_given] and not options[:help_given]
+    # rubocop:enable Metrics
+
+    private_class_method def self.options_need_to_be_validated?(options)
+      !(options[:version_given]) and !(options[:help_given])
     end
 
     #--
@@ -163,8 +181,8 @@ module Pandocomatic
     # set, these are put in the options as "version" and "help"
     # respectively.
     #++
-    
-    def self.use_custom_version options
+
+    private_class_method def self.use_custom_version(options)
       if options[:show_version]
         options.delete :show_version
         options.delete :show_version_given
@@ -174,29 +192,28 @@ module Pandocomatic
       options
     end
 
-    def self.use_custom_help options
+    private_class_method def self.use_custom_help(options)
       if options[:show_help]
         options.delete :show_help
         options.delete :show_help_given
         options[:help] = true
         options[:help_given] = true
       end
-      options 
+      options
     end
 
     # If output does not exist, the output can be
     # created with the same type. If output does exist, however, it should
     # have the same type as the input.
-    def self.matching_file_types?(input, output)
-      not File.exist?(output) or File.ftype(input) == File.ftype(output)
-    end
-    
-    def self.match_file_types(input, output)
-        if not matching_file_types? input, output 
-          raise CLIError.new(:output_is_not_a_file, nil, input) if File.file? input
-          raise CLIError.new(:output_is_not_a_directory, nil, input) if File.directory? input
-        end
+    private_class_method def self.matching_file_types?(input, output)
+      !File.exist?(output) or File.ftype(input) == File.ftype(output)
     end
 
+    private_class_method def self.match_file_types(input, output)
+      return if matching_file_types? input, output
+
+      raise CLIError.new(:output_is_not_a_file, nil, input) if File.file? input
+      raise CLIError.new(:output_is_not_a_directory, nil, input) if File.directory? input
+    end
   end
 end

data/lib/pandocomatic/command/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 '../printer/command_printer.rb'
+  require_relative '../printer/command_printer'
 
   # Command is a base class of all actions pandocomatic executes while
   # converting a file or a directory of files.
@@ -31,18 +32,19 @@ module Pandocomatic
   #   @return [Number] the index of this Command in the list with all commands
   #     to run when running pandocomatic.
   class Command
-
     attr_reader :errors, :index
 
+    # rubocop:disable Style/ClassVars
+
     @@total = 0
     @@dry_run = false
     @@quiet = false
     @@debug = false
-    @@src_root = "."
+    @@src_root = '.'
     @@modified_only = false
 
     # Create a new Command
-    def initialize()
+    def initialize
       @errors = []
       @@total += 1
       @index = @@total
@@ -63,35 +65,35 @@ module Pandocomatic
     # Get the root directory of this Command's conversion process
     #
     # @return [String]
-    def src_root()
+    def src_root
       @@src_root
     end
 
     # Does this Command not actually execute?
     #
     # @return [Boolean]
-    def dry_run?()
+    def dry_run?
       @@dry_run
     end
 
     # Is this Command executed silently?
     #
     # @return [Boolean]
-    def quiet?()
+    def quiet?
       @@quiet
     end
 
     # Is this Command executed in debug mode?
     #
     # @return [Boolean]
-    def debug?()
+    def debug?
       @@debug
     end
 
     # Is this Command only executed on modified files?
     #
     # @return [Boolean]
-    def modified_only?()
+    def modified_only?
       @@modified_only
     end
 
@@ -99,86 +101,87 @@ module Pandocomatic
     # commands as well.
     #
     # @return [Number]
-    def count()
+    def count
       1
     end
 
     # Get all the errors generated while executing this Command
     #
     # @return [Error[]]
-    def all_errors()
+    def all_errors
       @errors
     end
 
     # Make this Command run quietly
-    def make_quiet()
+    def make_quiet
       @@quiet = true
     end
 
     # Convert this Command's index to a string representation
     #
     # @return [String]
-    def index_to_s()
-      "#{@@total - @index + 1}".rjust(@@total.to_s.size)
+    def index_to_s
+      (@@total - @index + 1).to_s.rjust(@@total.to_s.size)
     end
 
     # Execute this Command. A Command can be dry-run as well, in which it is
     # not actually run.
-    def execute()
+    def execute
       CommandPrinter.new(self).print unless quiet?
-      run if not dry_run? and runnable?
+      run if !dry_run? && runnable?
     end
 
     # Actually run this Command
-    def run()
-    end
+    def run; end
 
     # Are there any errors while configuring this Command? If not, this
     # Command is runnable.
     #
     # @return [Boolean]
-    def runnable?()
-      not has_errors?
+    def runnable?
+      !errors?
     end
 
     # Create a String representation of this Command
     #
     # @return [String]
-    def to_s()
+    def to_s
       'command'
     end
-    
+
     # Is this Command converting a directory?
     #
     # @return [Boolean] false
-    def directory?()
+    def directory?
       false
     end
 
     # Does this Command convert a file multiple times?
     #
     # @return [Boolean] false
-    def multiple?()
+    def multiple?
       false
     end
 
     # Will this Command be skipped, thus not executed?
     #
     # @return [Boolean] false
-    def skip?()
+    def skip?
       false
     end
 
     # Decrement the total number of conversion commands by 1
-    def uncount()
+    def uncount
       @@total -= 1
     end
 
+    # rubocop:enable Style/ClassVars
+
     # Has this Command run in any errors?
     #
     # @return [Error[]]
-    def has_errors?()
-      not @errors.empty?
+    def errors?
+      !@errors.empty?
     end
 
     # Is the source file newer than the destination file?
@@ -188,8 +191,7 @@ module Pandocomatic
     #
     # @return [Boolean] True if src has been modified after dst has been last
     def file_modified?(src, dst)
-      not File.exist? dst or File.mtime(src) > File.mtime(dst)
+      !File.exist? dst or File.mtime(src) > File.mtime(dst)
     end
-
   end
 end

data/lib/pandocomatic/command/convert_dir_command.rb

@@ -1,32 +1,33 @@
+# 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 '../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 'convert_file_multiple_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 'convert_file_multiple_command'
+  require_relative 'copy_file_command'
+  require_relative 'skip_command'
 
   # Commmand to convert a directory
   #
@@ -39,9 +40,10 @@ module Pandocomatic
   # @!attribute dst_dir
   #   @return [String] the destination directory to convert to
   class ConvertDirCommand < ConvertListCommand
-
     attr_reader :config, :src_dir, :dst_dir
 
+    # rubocop:disable Metrics
+
     # Create a new ConvertDirCommand
     #
     # @param current_config [Configuration] The configuration of pandocomatic
@@ -76,80 +78,76 @@ module Pandocomatic
 
         dst = File.join @dst_dir, filename
 
-        if File.symlink? src and not config.follow_links?
+        if File.symlink?(src) && !config.follow_links?
           subcommand = CreateLinkCommand.new(src, dst)
-        elsif File.directory? src then
-          if config.recursive? then
-            subcommand = ConvertDirCommand.new(config, src, dst)
-          else
-            subcommand = SkipCommand.new(src, :skipping_directory)
-          end
-        elsif File.file? src 
-          if config.convert? src then
-              subcommand = ConvertFileMultipleCommand.new(config, src, dst)
-          else
-            if not modified_only? or file_modified? src, dst then
-              subcommand = CopyFileCommand.new(src, dst)
-            end
+        elsif File.directory? src
+          subcommand = if config.recursive?
+                         ConvertDirCommand.new(config, src, dst)
+                       else
+                         SkipCommand.new(src, :skipping_directory)
+                       end
+        elsif File.file? src
+          if config.convert? src
+            subcommand = ConvertFileMultipleCommand.new(config, src, dst)
+          elsif !modified_only? || file_modified?(src, dst)
+            subcommand = CopyFileCommand.new(src, dst)
           end
         else
           subcommand = SkipCommand.new(src, :unclear_what_to_do)
         end
 
-        push subcommand unless subcommand.nil? or subcommand.skip?
+        push subcommand unless subcommand.nil? || subcommand.skip?
       end
 
       # Empty commands do not count to the total amount of commands to execute
       uncount if skip?
     end
 
+    # rubocop:enable Metrics
+
     # Should this command be skipped?
     #
     # @return [Boolean] True if this command has no sub commands
-    def skip?()
+    def skip?
       @subcommands.empty?
     end
 
     # Converts this command a directory?
     #
     # @return [Boolean] true
-    def directory?()
+    def directory?
       true
     end
 
     # Convert this command to a String representation for a Printer
     #
     # @return [String]
-    def to_s()
-      "convert #{@src_dir}" + '; ' + if create_directory? then 'create and ' else '' end + "enter #{@dst_dir}"
+    def to_s
+      "convert #{@src_dir}; #{create_directory? ? 'create and ' : ''}enter #{@dst_dir}"
     end
 
     # Run this command
-    def run()
-      begin
-        Dir.mkdir @dst_dir if create_directory?
-      rescue SystemError => e
-        raise IOError.new(:error_creating_directory, e, @dst_dir)
-      end
+    def run
+      Dir.mkdir @dst_dir if create_directory?
+    rescue SystemError => e
+      raise IOError.new(:error_creating_directory, e, @dst_dir)
     end
 
     private
 
-    def create_directory?()
-      not File.exist? @dst_dir or not File.directory? @dst_dir
+    def create_directory?
+      !File.exist? @dst_dir or !File.directory? @dst_dir
     end
 
     # If the source directory contains a configuration file, use it to
     # reconfigure the converter. Otherwise, use the current configuration
     def reconfigure(current_config, src_dir)
       config_file = File.join src_dir, Configuration::CONFIG_FILE
-      if File.exist? config_file then
-        config = current_config.reconfigure config_file
+      if File.exist? config_file
+        current_config.reconfigure config_file
       else
-        config = current_config
+        current_config
       end
-      config
     end
-
   end
 end