pragmater 7.2.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17f31f5ee7db80b11e49894b0db270e17c1fcdedb97fd9fb19bfebc04af238c2
-  data.tar.gz: fe4b1203fb590733575f72ccc569481617b978a7949dd13605582fb7a52b7bfe
+  metadata.gz: 9860e7c1b0f3f18bb0170616c5168e917809d02942c952516db131f272f69aee
+  data.tar.gz: 78c2157d4b06c08c3ff5cf6c3bcf026b54110bfc620b1fcfbab44f0c7ecdb88b
 SHA512:
-  metadata.gz: 5e5f6b2b569226308f251b080d7e51df7352f23dfa33be98afef5424982566d9a8e55f234c052752554ba2e1f8c10740b22859ed39de06a8fd03d096e1dcd15c
-  data.tar.gz: 5961184d11177ccea0a041783b6df77e4cced27a5088c63325915ed75fc20748e2ea0c59a05d0071d4d8786154905e83fda922788a67c6386b6241d4025e7177
+  metadata.gz: f62054458f1caa6a4083f25e5c03cf3b770eea28a4ef6fd12c3efc849d6f5ca01060b40ccb6a28d7c79c24ff9b1d502d2bfc7decbdd6f8c70bcc634f83f172f6
+  data.tar.gz: 6255ed2a79628616738f42bb25a01de99dbe3bebe0b8af9115e39318e62e050fabd0d26df6193499db315b870b0fed8b04f2b21947353dbab057cc4b2ac625b4

data/README.adoc

@@ -21,14 +21,14 @@ Examples:
 ----
 
 With https://www.ruby-lang.org/en/news/2015/12/25/ruby-2-3-0-released[Ruby 2.3.0], frozen strings
-are supported via a pragma. This gem provides an easy way to add pragmas to single or multiple Ruby
-source files in order to benefit from improved memory and concurrency performance.
+are supported via a pragma. This gem provides an easy way to insert or remove pragmas to single or
+multiple Ruby source files in order to benefit from improved memory and concurrency performance.
 
 toc::[]
 
 == Features
 
-* Supports adding a pragma or multiple pragmas to single or multiple source files.
+* Supports inserting a pragma or multiple pragmas to single or multiple source files.
 * Supports removing pragma(s) from single or multiple source files.
 * Supports file list filtering. Defaults to any file.
 * Ensures duplicate pragmas never exist.
@@ -76,33 +76,39 @@ bin/console
 
 === Command Line Interface (CLI)
 
-From the command line, type: `+pragmater help+`
+From the command line, type: `pragmater --help`
 
 ....
-pragmater -a, [--add=PATH]      # Add comments to source file(s).
-pragmater -c, [--config]        # Manage gem configuration.
-pragmater -h, [--help=COMMAND]  # Show this message or get help for a command.
-pragmater -r, [--remove=PATH]   # Remove comments from source file(s).
-pragmater -v, [--version]       # Show gem version.
-....
+Pragmater - A command line interface for managing/formatting source file pragma comments.
 
-Both the `+--add+` and `+--remove+` commands support options for specifying pragmas and/or included
-files (viewable by running `+pragmater --help --add+` or `+pragmater --help --remove+`):
+USAGE:
+  -v, --version                            Show gem version.
+  -h, --help                               Show this message.
+  -c, --config [options]                   Manage gem configuration.
+  -i, --insert [PATH]                      Insert pragam comments into files.
+  -r, --remove [options]                   Remove pragam comments from files.
 
-....
--c, [--comments=one two three]  # Define desired comments
--i, [--includes=one two three]  # Include specific files and/or directories
+OPTIONS:
+
+Insert/Remove:
+      --comments a,b,c                     Add pragma comments.
+      --includes a,b,c                     Add console support.
+
+Configuration:
+      --edit                               Edit configuration.
+      --info                               Print configuration.
 ....
 
-Example (same options could be used for the `+--remove+` command too):
+Both the `--insert` and `--remove` commands support the same options for specifying pragmas and/or
+included files. Example:
 
 [source,bash]
 ----
-pragmater --add --comments "# frozen_string_literal: true" --includes "Gemfile" "Guardfile" "Rakefile" ".gemspec" "config.ru" "bin/**/*" "**/*.rake" "**/*.rb"
+pragmater --insert --comments "# frozen_string_literal: true" --includes "Gemfile" "Guardfile" "Rakefile" ".gemspec" "config.ru" "bin/**/*" "**/*.rake" "**/*.rb"
 ----
 
-The `--add` and `--remove` commands default to the current working directory so a path isn’t
-necessary unless you want to run Pragmater on a directory structure other than your current working
+The `--insert` and `--remove` commands default to the current working directory so a path isn’t
+necessary unless you want to run Pragmater in a directory structure other than your current working
 directory.
 
 === Customization
@@ -116,7 +122,7 @@ The default configuration is as follows:
 
 [source,yaml]
 ----
-:add:
+:insert:
   :comments: []
   :includes: []
 :remove:
@@ -128,10 +134,10 @@ Feel free to take the above configuration, modify, and save as your own custom `
 
 The `configuration.yml` file can be configured as follows:
 
-* `add`: Defines global/local comments and/or file include lists when adding pragmas. The `comments`
-  and `includes` options can be either a single string or an array.
+* `insert`: Defines global/local comments and/or file include lists when inserting pragmas. The
+  `comments` and `includes` options can be either a single string or an array of strings.
 * `remove`: Defines global/local comments and/or file include lists when removing pragmas. The
-  `comments` and `includes` options can be either a single string or an array.
+  `comments` and `includes` options can be either a single string or an array of strings.
 
 === Available Pragmas
 
@@ -255,17 +261,7 @@ immutable = -"test"
 mutable = +"test"
 ----
 
-Despite Ruby allowing you to do this, it is _not recommended_ to use the above examples as it leads
-to hard to read code. Instead use the following:
-
-[source,ruby]
-----
-immutable = "test".freeze
-mutable = "test"
-----
-
-While this requires extra typing, it expresses intent more clearly. There is a slight caveat to this
-rule in which the use of `+String#-@+` was http://bit.ly/2DGAjgG[enhanced in Ruby 2.5.0] to
+💡 The use of `+String#-@+`, specifically, was http://bit.ly/2DGAjgG[enhanced in Ruby 2.5.0] to
 _deduplicate_ all instances of the same string thus reducing your memory footprint. This can be
 valuable in situations where you are not using the frozen string comment and need to selectively
 freeze strings.

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
+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

data/lib/pragmater/formatters/shebang.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Formatters
+    # Formats shebang pragmas in a consistent manner.
+    class Shebang
+      PATTERN = %r(\A\#!\s?/.*ruby\Z).freeze
+
+      def initialize string, pattern: PATTERN
+        @string = string
+        @pattern = pattern
+      end
+
+      def call
+        return string unless string.match? pattern
+
+        string.split("!").then { |octothorpe, path| "#{octothorpe}! #{path.strip}" }
+      end
+
+      private
+
+      attr_reader :string, :pattern
+    end
+  end
+end

data/lib/pragmater/identity.rb

@@ -5,7 +5,8 @@ module Pragmater
   module Identity
     NAME = "pragmater"
     LABEL = "Pragmater"
-    VERSION = "7.2.0"
+    VERSION = "8.0.0"
     VERSION_LABEL = "#{LABEL} #{VERSION}"
+    SUMMARY = "A command line interface for managing/formatting source file pragma comments."
   end
 end

data/lib/pragmater/parsers/comments.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Parsers
+    # Manages pragma comments.
+    class Comments
+      def initialize older, newer, formatter: Formatters::Main
+        @formatter = formatter
+        @older = format older
+        @newer = format newer
+      end
+
+      def insert
+        older.union newer
+      end
+
+      def remove
+        older - older.intersection(newer)
+      end
+
+      private
+
+      attr_reader :formatter, :older, :newer
+
+      def format pragmas
+        Array(pragmas).map { |pragma| formatter.new(pragma).call }
+      end
+    end
+  end
+end

data/lib/pragmater/parsers/file.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Parsers
+    # Parses a file into pragma comment and body lines.
+    class File
+      def initialize pattern: Formatters::Main::PATTERN,
+                     comments: Comments,
+                     processor: Processors::Handler.new
+        @pattern = pattern
+        @comments = comments
+        @processor = processor
+      end
+
+      def call path, new_comments, action:
+        path.each_line
+            .partition { |line| line.match? pattern }
+            .then do |old_comments, body|
+              processor.call action, wrap_in_new_line(old_comments, new_comments, action), body
+            end
+      end
+
+      private
+
+      attr_reader :pattern, :comments, :processor
+
+      def wrap_in_new_line old_comments, new_comments, action
+        comments.new(old_comments, new_comments).public_send(action).map { |line| "#{line}\n" }
+      end
+    end
+  end
+end

data/lib/pragmater/processors/handler.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Processors
+    # Handles the insertion or removal of pragma comments.
+    class Handler
+      DEFAULTS = {
+        insert: Inserter,
+        remove: Remover
+      }.freeze
+
+      def initialize processors: DEFAULTS
+        @processors = processors
+      end
+
+      def call action, comments, body
+        processors.fetch(action).new(comments, body).call
+      end
+
+      private
+
+      attr_reader :processors
+    end
+  end
+end

data/lib/pragmater/processors/inserter.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Processors
+    # Inserts new pragma comments.
+    class Inserter
+      def initialize comments, body
+        @comments = comments
+        @body = body
+      end
+
+      def call
+        body.first.then do |first|
+          comments.append "\n" unless first == "\n" || body.empty?
+          comments + body
+        end
+      end
+
+      private
+
+      attr_reader :comments, :body
+    end
+  end
+end

data/lib/pragmater/processors/remover.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Processors
+    # Removes existing pragma comments.
+    class Remover
+      def initialize comments, body
+        @comments = comments
+        @body = body
+      end
+
+      def call
+        body.first.then do |first_line|
+          body.delete_at 0 if first_line == "\n" && comments.empty?
+          comments + body
+        end
+      end
+
+      private
+
+      attr_reader :comments, :body
+    end
+  end
+end

data/lib/pragmater/runner.rb

@@ -1,32 +1,34 @@
 # frozen_string_literal: true
 
+require "pathname"
+require "refinements/pathnames"
+
 module Pragmater
   # Adds/removes pragma comments for files in given path.
   class Runner
-    # rubocop:disable Metrics/ParameterLists
-    def initialize path = ".", comments: [], includes: [], writer: Writer
-      @path = Pathname path
-      @comments = Array comments
-      @includes = Array includes
-      @writer = writer
-    end
-    # rubocop:enable Metrics/ParameterLists
+    using Refinements::Pathnames
 
-    def files
-      return [] unless path.exist? && path.directory? && !includes.empty?
+    def self.for **attributes
+      new Context[attributes]
+    end
 
-      Pathname.glob(%(#{path}/{#{includes.join ","}})).select(&:file?)
+    def initialize context, parser: Parsers::File.new
+      @context = context
+      @parser = parser
     end
 
-    def run action:
-      files.each do |file|
-        writer.new(file, comments).public_send action
-        yield file if block_given?
-      end
+    def call
+      Pathname(context.root_dir).files("{#{context.includes.join ","}}").map(&method(:write))
     end
 
     private
 
-    attr_reader :path, :comments, :includes, :writer
+    attr_reader :context, :parser
+
+    def write path
+      path.tap do |a_path|
+        a_path.write parser.call(a_path, context.comments, action: context.action).join
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pragmater
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,36 +28,36 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: runcom
+  name: refinements
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.7'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: runcom
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -72,20 +72,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: climate_control
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: gemsmith
   requirement: !ruby/object:Gem::Requirement
@@ -204,14 +190,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.83'
+        version: '0.89'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.83'
+        version: '0.89'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -282,12 +268,25 @@ files:
 - README.adoc
 - bin/pragmater
 - lib/pragmater.rb
-- lib/pragmater/cli.rb
-- lib/pragmater/commenter.rb
-- lib/pragmater/formatter.rb
+- lib/pragmater/cli/helper.rb
+- lib/pragmater/cli/options/assembler.rb
+- lib/pragmater/cli/options/configuration.rb
+- lib/pragmater/cli/options/core.rb
+- lib/pragmater/cli/options/defaults.yml
+- lib/pragmater/cli/options/insert_remove.rb
+- lib/pragmater/cli/options/merger.rb
+- lib/pragmater/cli/shell.rb
+- lib/pragmater/context.rb
+- lib/pragmater/formatters/general.rb
+- lib/pragmater/formatters/main.rb
+- lib/pragmater/formatters/shebang.rb
 - lib/pragmater/identity.rb
+- lib/pragmater/parsers/comments.rb
+- lib/pragmater/parsers/file.rb
+- lib/pragmater/processors/handler.rb
+- lib/pragmater/processors/inserter.rb
+- lib/pragmater/processors/remover.rb
 - lib/pragmater/runner.rb
-- lib/pragmater/writer.rb
 homepage: https://www.alchemists.io/projects/pragmater
 licenses:
 - Apache-2.0

data/lib/pragmater/cli.rb

@@ -1,124 +0,0 @@
-# frozen_string_literal: true
-
-require "pathname"
-require "thor"
-require "thor/actions"
-require "runcom"
-
-module Pragmater
-  # The Command Line Interface (CLI) for the gem.
-  class CLI < Thor
-    include Thor::Actions
-
-    package_name Identity::VERSION_LABEL
-
-    # rubocop:disable Metrics/MethodLength
-    def self.configuration
-      Runcom::Config.new "#{Identity::NAME}/configuration.yml",
-                         defaults: {
-                           add: {
-                             comments: "",
-                             includes: []
-                           },
-                           remove: {
-                             comments: "",
-                             includes: []
-                           }
-                         }
-    end
-    # rubocop:enable Metrics/MethodLength
-
-    def initialize args = [], options = {}, config = {}
-      super args, options, config
-      @configuration = self.class.configuration
-    rescue Runcom::Errors::Base => error
-      abort error.message
-    end
-
-    desc "-a, [--add=PATH]", "Add comments to source file(s)."
-    map %w[-a --add] => :add
-    method_option :comments,
-                  aliases: "-c",
-                  desc: "Define desired comments",
-                  type: :array,
-                  default: configuration.to_h.dig(:add, :comments)
-    method_option :includes,
-                  aliases: "-i",
-                  desc: "Include specific files and/or directories",
-                  type: :array,
-                  default: configuration.to_h.dig(:add, :includes)
-    def add path = "."
-      settings = configuration.merge(
-        add: {comments: options.comments, includes: options.includes}
-      ).to_h
-
-      runner = Runner.new path,
-                          comments: settings.dig(:add, :comments),
-                          includes: settings.dig(:add, :includes)
-
-      runner.run(action: :add) { |file| say_status :info, "Processed: #{file}.", :green }
-    end
-
-    desc "-r, [--remove=PATH]", "Remove comments from source file(s)."
-    map %w[-r --remove] => :remove
-    method_option :comments,
-                  aliases: "-c",
-                  desc: "Define desired comments",
-                  type: :array,
-                  default: configuration.to_h.dig(:remove, :comments)
-    method_option :includes,
-                  aliases: "-i",
-                  desc: "Include specific files and/or directories",
-                  type: :array,
-                  default: configuration.to_h.dig(:remove, :includes)
-    def remove path = "."
-      settings = configuration.merge(
-        remove: {comments: options.comments, includes: options.includes}
-      ).to_h
-
-      runner = Runner.new path,
-                          comments: settings.dig(:remove, :comments),
-                          includes: settings.dig(:remove, :includes)
-
-      runner.run(action: :remove) { |file| say_status :info, "Processed: #{file}.", :green }
-    end
-
-    desc "-c, [--config]", "Manage gem configuration."
-    map %w[-c --config] => :config
-    method_option :edit,
-                  aliases: "-e",
-                  desc: "Edit gem configuration.",
-                  type: :boolean,
-                  default: false
-    method_option :info,
-                  aliases: "-i",
-                  desc: "Print gem configuration.",
-                  type: :boolean,
-                  default: false
-    def config
-      path = configuration.current
-
-      if options.edit? then `#{ENV["EDITOR"]} #{path}`
-      elsif options.info?
-        path ? say(path) : say("Configuration doesn't exist.")
-      else help :config
-      end
-    end
-
-    desc "-v, [--version]", "Show gem version."
-    map %w[-v --version] => :version
-    def version
-      say Identity::VERSION_LABEL
-    end
-
-    desc "-h, [--help=COMMAND]", "Show this message or get help for a command."
-    map %w[-h --help] => :help
-    def help task = nil
-      say and super
-    end
-
-    private
-
-    attr_reader :configuration
-  end
-end

data/lib/pragmater/commenter.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Pragmater
-  # Handles pragma comments.
-  class Commenter
-    def initialize older, newer, formatter: Formatter
-      @formatter = formatter
-      @older = format older
-      @newer = format newer
-    end
-
-    def add
-      older | newer
-    end
-
-    def remove
-      older - (older & newer)
-    end
-
-    private
-
-    attr_reader :older, :newer, :formatter
-
-    def filter comments
-      Array(comments).select { |comment| comment =~ formatter.valid_formats }
-    end
-
-    def format comments
-      filter(comments).map { |comment| formatter.new(comment).format }
-    end
-  end
-end

data/lib/pragmater/formatter.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module Pragmater
-  # Formats pragma comments in a consistent manner.
-  class Formatter
-    def self.shebang_format
-      %r(\A\#!\s?/.*ruby\Z)
-    end
-
-    def self.pragma_format
-      /
-        \A       # Start of line.
-        \#       # Start of comment.
-        \s?      # Space - optional.
-        \w+      # Key - 1 or more word characters only.
-        :        # Key and value delimiter.
-        \s?      # Space - optional.
-        [\w-]+   # Value - 1 or more word or dash characters.
-        \Z       # End of line.
-      /x
-    end
-
-    def self.valid_formats
-      Regexp.union shebang_format, pragma_format
-    end
-
-    def initialize string
-      @string = string
-    end
-
-    def format_shebang
-      return string unless string.match? self.class.shebang_format
-
-      _, path = string.split "!"
-      "#! #{path.strip}"
-    end
-
-    def format_pragma
-      return string unless string.match? self.class.pragma_format
-
-      key, value = string.split ":"
-      "# #{key.gsub(/\#\s?/, "")}: #{value.strip}"
-    end
-
-    def format
-      klass = self.class
-
-      case string
-        when klass.shebang_format then format_shebang
-        when klass.pragma_format then format_pragma
-        else string
-      end
-    end
-
-    private
-
-    attr_reader :string
-  end
-end

data/lib/pragmater/writer.rb

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module Pragmater
-  # Writes formatted pragma comments to source file.
-  # :reek:TooManyInstanceVariables
-  # :reek:MissingSafeMethod
-  class Writer
-    # rubocop:disable Metrics/ParameterLists
-    def initialize file_path, new_comments, formatter: Formatter, commenter: Commenter
-      @file_path = file_path
-      @file_lines = File.readlines file_path
-      @formatter = formatter
-      @commenter = commenter
-      @old_comments = file_comments
-      @new_comments = new_comments
-    end
-    # rubocop:enable Metrics/ParameterLists
-
-    def add
-      comments = format commenter.new(old_comments, new_comments).add
-      lines = comments + file_lines_without_comments
-      insert_spacing! lines, comments
-      write { lines.join }
-    end
-
-    def remove
-      lines = format(commenter.new(old_comments, new_comments).remove) + file_lines_without_comments
-      remove_spacing! lines
-      write { lines.join }
-    end
-
-    private
-
-    attr_reader :file_path, :file_lines, :new_comments, :old_comments, :formatter, :commenter
-
-    def file_comments
-      file_lines.select { |line| line =~ formatter.valid_formats }
-    end
-
-    def file_lines_without_comments
-      file_lines.reject { |line| old_comments.include? line }
-    end
-
-    # :reek:UtilityFunction
-    def format lines
-      lines.map { |line| "#{line}\n" }
-    end
-
-    # :reek:UtilityFunction
-    def insert_spacing! lines, comments
-      comment_count = comments.size
-
-      return if comments.empty?
-      return if lines.size == 1
-      return if lines[comment_count] == "\n"
-
-      lines.insert comment_count, "\n"
-    end
-
-    # :reek:UtilityFunction
-    def remove_spacing! lines
-      lines.delete_at 0 if lines.first == "\n"
-    end
-
-    def write
-      File.open(file_path, "w") { |file| file.write yield }
-    end
-  end
-end