pragmater 7.2.0 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17f31f5ee7db80b11e49894b0db270e17c1fcdedb97fd9fb19bfebc04af238c2
-  data.tar.gz: fe4b1203fb590733575f72ccc569481617b978a7949dd13605582fb7a52b7bfe
+  metadata.gz: 3510b74dca65adfeed1751708bb5f85b1520cf3d226e7ff1493858431666b32f
+  data.tar.gz: 1fcf9908e0de075ae96fc609ffe94209c13dc25676fe3c87b371083601b59451
 SHA512:
-  metadata.gz: 5e5f6b2b569226308f251b080d7e51df7352f23dfa33be98afef5424982566d9a8e55f234c052752554ba2e1f8c10740b22859ed39de06a8fd03d096e1dcd15c
-  data.tar.gz: 5961184d11177ccea0a041783b6df77e4cced27a5088c63325915ed75fc20748e2ea0c59a05d0071d4d8786154905e83fda922788a67c6386b6241d4025e7177
+  metadata.gz: 783e0fe7bc7d0c6a2993e2a77f3b4093bd1f9b1e1b272ac014a39805487cb36b8cd8f30958461d5de19f12529b23f10bce188ebb0ed104d95c1d291097192c65
+  data.tar.gz: 40ce62fd3b9a050a951c91c423cb2787f82ffd0de568eaa17ff2e9efcd6351bb4edd860bdaac15c019a6122115ce1e174908a46c87fdc407d0953a82cd1e76cd

data/LICENSE.adoc

@@ -150,7 +150,7 @@ additional liability.
 
 END OF TERMS AND CONDITIONS
 
-Copyright link:https://www.alchemists.io[Alchemists].
+Copyright 2015 link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
 compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]

data/README.adoc

@@ -6,6 +6,8 @@
 
 [link=http://badge.fury.io/rb/pragmater]
 image::https://badge.fury.io/rb/pragmater.svg[Gem Version]
+[link=https://www.alchemists.io/projects/code_quality]
+image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchemists Style Guide]
 [link=https://circleci.com/gh/bkuhlmann/pragmater]
 image::https://circleci.com/gh/bkuhlmann/pragmater.svg?style=svg[Circle CI Status]
 
@@ -21,14 +23,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.
@@ -45,8 +47,6 @@ image::https://www.alchemists.io/images/screencasts/pragmater/cover.svg[Screenca
 
 == Setup
 
-=== Production
-
 To install, run:
 
 [source,bash]
@@ -54,55 +54,43 @@ To install, run:
 gem install pragmater
 ----
 
-=== Development
-
-To contribute, run:
-
-[source,bash]
-----
-git clone https://github.com/bkuhlmann/pragmater.git
-cd pragmater
-bin/setup
-----
-
-You can also use the IRB console for direct access to all objects:
-
-[source,bash]
-----
-bin/console
-----
-
 == Usage
 
 === 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 +104,7 @@ The default configuration is as follows:
 
 [source,yaml]
 ----
-:add:
+:insert:
   :comments: []
   :includes: []
 :remove:
@@ -128,10 +116,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 +243,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.
@@ -288,6 +266,24 @@ presented together for a visual comparison:
 One oddity to the above is the use of `# !/usr/bin/env ruby` is not allowed but `#! /usr/bin/env
 ruby` is which is why spacing is slightly different for shell pragmas.
 
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/pragmater.git
+cd pragmater
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
 == Tests
 
 To test, run:

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__ method }
+          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__ method }
+          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__ method }
+          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