pragmater 9.3.0 → 10.2.0

data/lib/pragmater/cli/parser.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Pragmater
+  module CLI
+    # Assembles and parses all Command Line Interface (CLI) options.
+    class Parser
+      CLIENT = OptionParser.new nil, 40, "  "
+      SECTIONS = [Parsers::Core, Parsers::Flag].freeze # Order is important.
+
+      def initialize sections: SECTIONS, client: CLIENT, container: Container
+        @sections = sections
+        @client = client
+        @configuration = container[:configuration].dup
+      end
+
+      def call arguments = []
+        sections.each { |section| section.call configuration, client: }
+        client.parse arguments
+        configuration.freeze
+      end
+
+      def to_s = client.to_s
+
+      private
+
+      attr_reader :sections, :client, :configuration
+    end
+  end
+end

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

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Pragmater
+  module CLI
+    module Parsers
+      # Handles parsing of Command Line Interface (CLI) core options.
+      class Core
+        using Refinements::Structs
+
+        def self.call(...) = new(...).call
+
+        def initialize configuration = Container[:configuration],
+                       client: Parser::CLIENT,
+                       container: Container
+          @configuration = configuration
+          @client = client
+          @container = container
+        end
+
+        def call arguments = []
+          client.banner = specification.labeled_summary
+          client.separator "\nUSAGE:\n"
+          collate
+          client.parse arguments
+          configuration
+        end
+
+        private
+
+        attr_reader :configuration, :client, :container
+
+        def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
+
+        def add_config
+          client.on "-c",
+                    "--config ACTION",
+                    %i[edit view],
+                    "Manage gem configuration: edit or view." do |action|
+            configuration.merge! action_config: action
+          end
+        end
+
+        def add_insert
+          client.on "-i", "--insert [PATH]", %(Insert pragmas. Default: "#{root_dir}".) do |path|
+            configuration.merge! action_insert: true, root_dir: path || root_dir
+          end
+        end
+
+        def add_remove
+          client.on "-r", "--remove [PATH]", %(Remove pragmas. Default: "#{root_dir}".) do |path|
+            configuration.merge! action_remove: true, root_dir: path || root_dir
+          end
+        end
+
+        def add_version
+          client.on "-v", "--version", "Show gem version." do
+            configuration.merge! action_version: true
+          end
+        end
+
+        def add_help
+          client.on "-h", "--help", "Show this message." do
+            configuration.merge! action_help: true
+          end
+        end
+
+        def root_dir = configuration.root_dir
+
+        def specification = container[__method__]
+      end
+    end
+  end
+end

data/lib/pragmater/cli/parsers/flag.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Pragmater
+  module CLI
+    module Parsers
+      # Parses common command line flags.
+      class Flag
+        using Refinements::Structs
+
+        def self.call(...) = new(...).call
+
+        def initialize configuration = Container[:configuration], client: Parser::CLIENT
+          @configuration = configuration
+          @client = client
+        end
+
+        def call arguments = []
+          client.separator "\nOPTIONS:\n"
+          collate
+          client.parse arguments
+          configuration
+        end
+
+        private
+
+        attr_reader :configuration, :client
+
+        def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
+
+        def add_comments
+          client.on "--comments a,b,c", Array, "Add pragma comments. Default: []." do |comments|
+            configuration.merge! comments:
+          end
+        end
+
+        def add_includes
+          client.on "--includes a,b,c", Array, "Add include patterns. Default: []." do |includes|
+            configuration.merge! includes:
+          end
+        end
+      end
+    end
+  end
+end

data/lib/pragmater/cli/shell.rb

@@ -2,61 +2,44 @@
 
 module Pragmater
   module CLI
-    # The command line interface for this gem.
+    # The main Command Line Interface (CLI) object.
     class Shell
-      def initialize merger: Options::Merger.new, runner: Runner, helper: Helper.new
-        @merger = merger
-        @runner = runner
-        @helper = helper
+      ACTIONS = {config: Actions::Config.new, run: Actions::Run.new}.freeze
+
+      def initialize parser: Parser.new, actions: ACTIONS, container: Container
+        @parser = parser
+        @actions = actions
+        @container = container
       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
-          else print_usage
-        end
+        perform parser.call(arguments)
+      rescue OptionParser::ParseError => error
+        logger.error { error.message }
       end
 
       private
 
-      attr_reader :merger, :runner, :helper
+      attr_reader :parser, :actions, :container
 
-      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}." }
+      def perform configuration
+        case configuration
+          in action_config: Symbol => action then config action
+          in {action_insert: true} | {action_remove: true} then run configuration
+          in action_version: true then logger.info { specification.labeled_version }
+          else usage
+        end
       end
 
-      def edit_configuration
-        helper.run "#{ENV["EDITOR"]} #{merger.configuration_path}"
-      end
+      def config(action) = actions.fetch(__method__).call(action)
 
-      def print_configuration
-        merger.configuration_path.then do |path|
-          return helper.info "No configuration found." unless path
+      def run(configuration) = actions.fetch(__method__).call(configuration)
 
-          helper.info "#{path}\n"
-          helper.info path.read
-        end
-      end
+      def usage = logger.unknown(parser.to_s)
 
-      def print_version
-        helper.info Identity::VERSION_LABEL
-      end
+      def specification = container[__method__]
 
-      def print_usage
-        helper.info merger.usage
-      end
+      def logger = container[__method__]
     end
   end
 end

data/lib/pragmater/configuration/content.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Pragmater
+  module Configuration
+    # Defines the content of the configuration for use throughout the gem.
+    Content = Struct.new(
+      :action_config,
+      :action_help,
+      :action_insert,
+      :action_remove,
+      :action_version,
+      :comments,
+      :includes,
+      :root_dir,
+      keyword_init: true
+    ) do
+      def initialize *arguments
+        super
+        freeze
+      end
+    end
+  end
+end

data/lib/pragmater/configuration/defaults.yml

@@ -0,0 +1,3 @@
+:comments: []
+:includes: []
+:root_dir: "."

data/lib/pragmater/configuration/loader.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "refinements/hashes"
+require "refinements/structs"
+require "runcom"
+require "yaml"
+
+module Pragmater
+  module Configuration
+    # Represents the fully assembled Command Line Interface (CLI) configuration.
+    class Loader
+      using Refinements::Hashes
+      using Refinements::Structs
+
+      DEFAULTS = YAML.load_file(Pathname(__dir__).join("defaults.yml")).freeze
+      CLIENT = Runcom::Config.new "pragmater/configuration.yml", defaults: DEFAULTS
+
+      def self.call = new.call
+
+      def self.with_defaults = new(client: DEFAULTS)
+
+      def initialize content: Content.new, client: CLIENT
+        @content = content
+        @client = client
+      end
+
+      def call = content.merge(**client.to_h.flatten_keys)
+
+      private
+
+      attr_reader :content, :client
+    end
+  end
+end

data/lib/pragmater/container.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "dry-container"
+require "logger"
+require "pastel"
+require "spek"
+
+module Pragmater
+  # Provides a global gem container for injection into other objects.
+  module Container
+    extend Dry::Container::Mixin
+
+    register(:configuration) { Configuration::Loader.call }
+    register(:specification) { Spek::Loader.call "#{__dir__}/../../pragmater.gemspec" }
+    register(:colorizer) { Pastel.new enabled: $stdout.tty? }
+    register(:kernel) { Kernel }
+
+    register :log_colors do
+      {
+        "DEBUG" => self[:colorizer].white.detach,
+        "INFO" => self[:colorizer].green.detach,
+        "WARN" => self[:colorizer].yellow.detach,
+        "ERROR" => self[:colorizer].red.detach,
+        "FATAL" => self[:colorizer].white.bold.on_red.detach,
+        "ANY" => self[:colorizer].white.bold.detach
+      }
+    end
+
+    register :logger do
+      Logger.new $stdout,
+                 level: Logger.const_get(ENV.fetch("LOG_LEVEL", "INFO")),
+                 formatter: (
+                   lambda do |severity, _at, _name, message|
+                     self[:log_colors][severity].call "#{message}\n"
+                   end
+                 )
+    end
+  end
+end

data/lib/pragmater/formatters/main.rb

@@ -5,6 +5,7 @@ module Pragmater
     # 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
@@ -14,9 +15,7 @@ module Pragmater
         @formatters = formatters
       end
 
-      def call
-        formatters.reduce(string) { |pragma, formatter| formatter.new(pragma).call }
-      end
+      def call = formatters.reduce(string) { |pragma, formatter| formatter.new(pragma).call }
 
       private
 

data/lib/pragmater/parsers/comments.rb

@@ -10,21 +10,15 @@ module Pragmater
         @newer = format newer
       end
 
-      def insert
-        older.union newer
-      end
+      def insert = older.union(newer)
 
-      def remove
-        older - older.intersection(newer)
-      end
+      def remove = older - older.intersection(newer)
 
       private
 
       attr_reader :formatter, :older, :newer
 
-      def format pragmas
-        Array(pragmas).map { |pragma| formatter.new(pragma).call }
-      end
+      def format(pragmas) = Array(pragmas).map { |pragma| formatter.new(pragma).call }
     end
   end
 end

data/lib/pragmater/processors/handler.rb

@@ -10,9 +10,7 @@ module Pragmater
         @processors = processors
       end
 
-      def call action, comments, body
-        processors.fetch(action).new(comments, body).call
-      end
+      def call(action, comments, body) = processors.fetch(action).new(comments, body).call
 
       private
 

data/lib/pragmater/runner.rb

@@ -7,23 +7,31 @@ module Pragmater
   class Runner
     using Refinements::Pathnames
 
-    def self.for **attributes
-      new Context[attributes]
-    end
-
-    def initialize context, parser: Parsers::File.new
-      @context = context
+    def initialize parser: Parsers::File.new, container: Container
       @parser = parser
+      @container = container
     end
 
-    def call
-      Pathname(context.root_dir).files("{#{context.includes.join ","}}").map do |path|
-        path.write parser.call(path, context.comments, action: context.action).join
+    def call configuration = Configuration::Loader.call
+      Pathname(configuration.root_dir).files("{#{configuration.includes.join ","}}").map do |path|
+        yield path if block_given?
+
+        case configuration
+          in action_insert: true then write path, configuration, :insert
+          in action_remove: true then write path, configuration, :remove
+          else logger.error { "Unknown run action. Use insert or remove." }
+        end
       end
     end
 
     private
 
-    attr_reader :context, :parser
+    attr_reader :parser, :container
+
+    def write path, configuration, action
+      path.write parser.call(path, configuration.comments, action:).join
+    end
+
+    def logger = container[__method__]
   end
 end

data/lib/pragmater.rb

@@ -1,20 +1,11 @@
 # frozen_string_literal: true
 
-require "pragmater/identity"
-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/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"
+require "zeitwerk"
+
+Zeitwerk::Loader.for_gem
+                .tap { |loader| loader.inflector.inflect "cli" => "CLI" }
+                .setup
+
+# Main namespace.
+module Pragmater
+end

data/pragmater.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "pragmater"
+  spec.version = "10.2.0"
+  spec.authors = ["Brooke Kuhlmann"]
+  spec.email = ["brooke@alchemists.io"]
+  spec.homepage = "https://www.alchemists.io/projects/pragmater"
+  spec.summary = "A command line interface for managing/formatting source file pragma comments."
+  spec.license = "Hippocratic-3.0"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/bkuhlmann/pragmater/issues",
+    "changelog_uri" => "https://www.alchemists.io/projects/pragmater/versions",
+    "documentation_uri" => "https://www.alchemists.io/projects/pragmater",
+    "label" => "Pragmater",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/bkuhlmann/pragmater"
+  }
+
+  spec.signing_key = Gem.default_key_path
+  spec.cert_chain = [Gem.default_cert_path]
+
+  spec.required_ruby_version = "~> 3.1"
+  spec.add_dependency "dry-container", "~> 0.9"
+  spec.add_dependency "pastel", "~> 0.8"
+  spec.add_dependency "refinements", "~> 9.1"
+  spec.add_dependency "runcom", "~> 8.2"
+  spec.add_dependency "spek", "~> 0.0"
+  spec.add_dependency "zeitwerk", "~> 2.5"
+
+  spec.bindir = "exe"
+  spec.executables << "pragmater"
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pragmater
 version: !ruby/object:Gem::Version
-  version: 9.3.0
+  version: 10.2.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,36 +28,92 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2021-11-20 00:00:00.000000000 Z
+date: 2022-02-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: refinements
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.5'
+        version: '9.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.5'
+        version: '9.1'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '8.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+- !ruby/object:Gem::Dependency
+  name: spek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '2.5'
 description:
 email:
 - brooke@alchemists.io
@@ -72,32 +128,35 @@ files:
 - README.adoc
 - exe/pragmater
 - lib/pragmater.rb
+- lib/pragmater/cli/actions/config.rb
+- lib/pragmater/cli/actions/run.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/parser.rb
+- lib/pragmater/cli/parsers/core.rb
+- lib/pragmater/cli/parsers/flag.rb
 - lib/pragmater/cli/shell.rb
-- lib/pragmater/context.rb
+- lib/pragmater/configuration/content.rb
+- lib/pragmater/configuration/defaults.yml
+- lib/pragmater/configuration/loader.rb
+- lib/pragmater/container.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
+- pragmater.gemspec
 homepage: https://www.alchemists.io/projects/pragmater
 licenses:
-- Apache-2.0
+- Hippocratic-3.0
 metadata:
   bug_tracker_uri: https://github.com/bkuhlmann/pragmater/issues
-  changelog_uri: https://www.alchemists.io/projects/pragmater/changes.html
+  changelog_uri: https://www.alchemists.io/projects/pragmater/versions
   documentation_uri: https://www.alchemists.io/projects/pragmater
+  label: Pragmater
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/bkuhlmann/pragmater
 post_install_message:
@@ -108,14 +167,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.31
+rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
 summary: A command line interface for managing/formatting source file pragma comments.