pragmater 6.3.3 → 8.0.0

data/bin/pragmater

@@ -1,9 +1,10 @@
 #! /usr/bin/env ruby
 # frozen_string_literal: true
 
+# TODO: Remove once the Pattern Matching feature is fully supported.
+Warning[:experimental] = false
+
 require "pragmater"
-require "pragmater/cli"
-require "pragmater/identity"
 
-Process.setproctitle Pragmater::Identity.version_label
-Pragmater::CLI.start
+Process.setproctitle Pragmater::Identity::VERSION_LABEL
+Pragmater::CLI::Shell.new.call ARGV

data/lib/pragmater.rb

@@ -1,8 +1,20 @@
 # frozen_string_literal: true
 
 require "pragmater/identity"
-require "pragmater/formatter"
-require "pragmater/commenter"
-require "pragmater/writer"
+require "pragmater/formatters/general"
+require "pragmater/formatters/shebang"
+require "pragmater/formatters/main"
+require "pragmater/parsers/comments"
+require "pragmater/parsers/file"
+require "pragmater/processors/inserter"
+require "pragmater/processors/remover"
+require "pragmater/processors/handler"
+require "pragmater/context"
 require "pragmater/runner"
-require "pragmater/cli"
+require "pragmater/cli/options/configuration"
+require "pragmater/cli/options/insert_remove"
+require "pragmater/cli/options/core"
+require "pragmater/cli/options/assembler"
+require "pragmater/cli/options/merger"
+require "pragmater/cli/helper"
+require "pragmater/cli/shell"

data/lib/pragmater/cli/helper.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "open3"
+require "logger"
+
+module Pragmater
+  module CLI
+    # A simple delegator for common shell functionality.
+    class Helper
+      extend Forwardable
+
+      LOGGER = Logger.new STDOUT,
+                          formatter: (
+                            proc do |_severity, _datetime, _program_name, message|
+                              "#{message}\n"
+                            end
+                          )
+
+      delegate %i[info error fatal debug unknown] => :logger
+
+      def initialize commander: Open3, logger: LOGGER
+        @commander = commander
+        @logger = logger
+      end
+
+      def run command
+        commander.capture3 command
+      end
+
+      def warn message
+        logger.warn message
+      end
+
+      private
+
+      attr_reader :commander, :logger
+    end
+  end
+end

data/lib/pragmater/cli/options/assembler.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "optparse"
+require "forwardable"
+
+module Pragmater
+  module CLI
+    module Options
+      # Coalesces all options and arguments into a single hash for further processing.
+      class Assembler
+        extend Forwardable
+
+        PARSER = OptionParser.new nil, 40, "  "
+        SECTIONS = [Core, InsertRemove, Configuration].freeze
+
+        EXCEPTIONS = [
+          OptionParser::InvalidOption,
+          OptionParser::MissingArgument,
+          OptionParser::InvalidArgument
+        ].freeze
+
+        delegate %i[to_s] => :parser
+
+        def initialize sections: SECTIONS, parser: PARSER, exceptions: EXCEPTIONS
+          @sections = sections
+          @parser = parser
+          @options = {}
+          @exceptions = exceptions
+        end
+
+        def call arguments = []
+          sections.each { |section| section.new(options, parser: parser).call }
+          parser.parse! arguments
+          options
+        rescue *EXCEPTIONS
+          {}
+        end
+
+        private
+
+        attr_reader :parser, :sections, :options, :exceptions
+      end
+    end
+  end
+end

data/lib/pragmater/cli/options/configuration.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module CLI
+    module Options
+      # Defines gem configuration options.
+      class Configuration
+        def initialize values, parser: OptionParser.new
+          @parser = parser
+          @values = values
+        end
+
+        def call
+          parser.separator "\nConfiguration:\n"
+          private_methods.grep(/add_/).each(&method(:__send__))
+          parser
+        end
+
+        private
+
+        attr_reader :parser, :values
+
+        def add_edit
+          parser.on "--edit", "Edit configuration." do
+            values[:edit] = true
+          end
+        end
+
+        def add_info
+          parser.on "--info", "Print configuration." do
+            values[:info] = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pragmater/cli/options/core.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module CLI
+    module Options
+      # Defines gem primary options.
+      class Core
+        def initialize values, parser: OptionParser.new
+          @values = values
+          @parser = parser
+        end
+
+        def call
+          parser.banner = "#{Identity::LABEL} - #{Identity::SUMMARY}"
+          parser.separator "\nUSAGE:\n"
+          private_methods.grep(/add_/).each(&method(:__send__))
+          parser
+        end
+
+        private
+
+        attr_reader :values, :parser
+
+        def add_configuration
+          parser.on "-c", "--config [options]", "Manage gem configuration." do
+            values[:config] = true
+          end
+        end
+
+        def add_insert
+          parser.on "-i", "--insert [PATH]", "Insert pragam comments into files." do |path|
+            values[:insert] = path || "."
+          end
+        end
+
+        def add_remove
+          parser.on "-r", "--remove [options]", "Remove pragam comments from files." do |path|
+            values[:remove] = path || "."
+          end
+        end
+
+        def add_version
+          parser.on "-v", "--version", "Show gem version." do
+            values[:version] = Identity::VERSION
+          end
+        end
+
+        def add_help
+          parser.on "-h", "--help", "Show this message." do
+            values[:help] = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pragmater/cli/options/defaults.yml

@@ -0,0 +1,6 @@
+:insert:
+  :comments: []
+  :includes: []
+:remove:
+  :comments: []
+  :includes: []

data/lib/pragmater/cli/options/insert_remove.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module CLI
+    module Options
+      # Defines gem insert and remove options.
+      class InsertRemove
+        def initialize values, parser: OptionParser.new
+          @values = values
+          @parser = parser
+        end
+
+        def call
+          parser.separator "\nOPTIONS:\n"
+          parser.separator "\nInsert/Remove:\n"
+          private_methods.grep(/add_/).each(&method(:__send__))
+          parser
+        end
+
+        private
+
+        attr_reader :values, :parser
+
+        def add_comments
+          parser.on "--comments a,b,c", Array, "Add pragma comments." do |comments|
+            values[:comments] = comments
+          end
+        end
+
+        def add_includes
+          parser.on "--includes a,b,c", Array, "Add console support." do |includes|
+            values[:includes] = includes
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pragmater/cli/options/merger.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "pathname"
+require "runcom"
+
+module Pragmater
+  module CLI
+    module Options
+      # Merges arguments with configuration for fully assembled configuration for use by shell.
+      class Merger
+        DEFAULTS = YAML.load_file(Pathname(__dir__).join("defaults.yml")).freeze
+        CONFIGURATION = Runcom::Config.new "#{Identity::NAME}/configuration.yml", defaults: DEFAULTS
+
+        def initialize configuration = CONFIGURATION, assembler = Assembler.new
+          @configuration = configuration
+          @assembler = assembler
+        end
+
+        def call arguments = []
+          assembler.call(arguments).then do |options|
+            case options
+              in insert: path, **settings then build_insert_options path, settings
+              in remove: path, **settings then build_remove_options path, settings
+              else options
+            end
+          end
+        end
+
+        def configuration_path
+          configuration.current
+        end
+
+        def usage
+          assembler.to_s
+        end
+
+        private
+
+        attr_reader :configuration, :assembler
+
+        def build_insert_options path, options
+          {insert: path, **configuration.to_h.fetch(:insert).merge(options)}
+        end
+
+        def build_remove_options path, options
+          {remove: path, **configuration.to_h.fetch(:remove).merge(options)}
+        end
+      end
+    end
+  end
+end

data/lib/pragmater/cli/shell.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module CLI
+    # The command line interface for this gem.
+    class Shell
+      def initialize merger: Options::Merger.new, runner: Runner, helper: Helper.new
+        @merger = merger
+        @runner = runner
+        @helper = helper
+      end
+
+      def call arguments = []
+        case merger.call arguments
+          in insert: path, **options then insert_pragmas options, path
+          in remove: path, **options then remove_pragmas options, path
+          in config:, edit:, **remainder then edit_configuration
+          in config:, info:, **remainder then print_configuration
+          in version:, **remainder then print_version
+          in help:, **remainder then print_usage
+          else print_usage
+        end
+      end
+
+      private
+
+      attr_reader :merger, :runner, :helper
+
+      def insert_pragmas options, path
+        runner.for(**options.merge(action: :insert, root_dir: path))
+              .call
+              .map { |file| helper.info "Processed: #{file}." }
+      end
+
+      def remove_pragmas options, path
+        runner.for(**options.merge(action: :remove, root_dir: path))
+              .call
+              .map { |file| helper.info "Processed: #{file}." }
+      end
+
+      def edit_configuration
+        helper.run "#{ENV["EDITOR"]} #{merger.configuration_path}"
+      end
+
+      def print_configuration
+        merger.configuration_path.then do |path|
+          return helper.info "No configuration found." unless path
+
+          helper.info "#{path}\n"
+          helper.info path.read
+        end
+      end
+
+      def print_version
+        helper.info Identity::VERSION_LABEL
+      end
+
+      def print_usage
+        helper.info merger.usage
+      end
+    end
+  end
+end

data/lib/pragmater/context.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Pragmater
+  # Provides context for runner.
+  Context = Struct.new :action, :root_dir, :comments, :includes, keyword_init: true do
+    def initialize *arguments
+      super
+
+      self[:root_dir] ||= "."
+      self[:comments] = Array comments
+      self[:includes] = Array includes
+    end
+  end
+end

data/lib/pragmater/formatters/general.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Formatters
+    # Formats general pragmas in a consistent manner.
+    class General
+      PATTERN = /
+        \A      # Start of line.
+        \#      # Start of comment.
+        \s?     # Space - optional.
+        \w+     # Key - One or more word characters only.
+        :       # Delimiter.
+        \s?     # Space - optional.
+        [\w-]+  # Value - One or more word or dash characters.
+        \Z      # End of line.
+      /x.freeze
+
+      def initialize string, pattern: PATTERN
+        @string = string
+        @pattern = pattern
+      end
+
+      def call
+        return string unless string.match? pattern
+
+        string.split(":").then { |key, value| "# #{key.gsub(/\#\s?/, "")}: #{value.strip}" }
+      end
+
+      private
+
+      attr_reader :string, :pattern
+    end
+  end
+end

data/lib/pragmater/formatters/main.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Formatters
+    # Formats all pragmas in a consistent manner.
+    class Main
+      FORMATTERS = [General, Shebang].freeze
+      PATTERN = FORMATTERS.map { |formatter| formatter::PATTERN }
+                          .then { |patterns| Regexp.union(*patterns) }
+                          .freeze
+
+      def initialize string, formatters: FORMATTERS
+        @string = string
+        @formatters = formatters
+      end
+
+      def call
+        formatters.reduce(string) { |pragma, formatter| formatter.new(pragma).call }
+      end
+
+      private
+
+      attr_reader :string, :formatters
+    end
+  end
+end