tocer 12.2.0 → 13.1.0

data/lib/tocer/cli/parser.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Tocer
+  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 { |parser| parser.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/tocer/cli/parsers/core.rb

@@ -1,29 +1,35 @@
 # frozen_string_literal: true
 
-require "tocer/identity"
+require "refinements/structs"
 
 module Tocer
   module CLI
     module Parsers
       # Handles parsing of Command Line Interface (CLI) core options.
       class Core
-        def self.call(options: {}, client: CLIENT) = new(options: options, client: client).call
+        using Refinements::Structs
 
-        def initialize options: {}, client: CLIENT
-          @options = options
+        def self.call(...) = new(...).call
+
+        def initialize configuration = Configuration::Loader.call,
+                       client: Parser::CLIENT,
+                       container: Container
+          @configuration = configuration
           @client = client
+          @container = container
         end
 
         def call arguments = []
-          client.banner = "#{Identity::LABEL} - #{Identity::SUMMARY}"
+          client.banner = "Tocer - #{specification.summary}"
           client.separator "\nUSAGE:\n"
           collate
-          arguments.empty? ? arguments : client.parse!(arguments)
+          client.parse arguments
+          configuration
         end
 
         private
 
-        attr_reader :options, :client
+        attr_reader :configuration, :client, :container
 
         def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
 
@@ -34,27 +40,35 @@ module Tocer
             %i[edit view],
             "Manage gem configuration: edit or view."
           ) do |action|
-            options[:config] = action
+            configuration.merge! action_config: action
           end
         end
 
-        def add_build
-          client.on "-b", "--build [PATH]", %(Build table of contents. Default path: ".") do |value|
-            options[:build] = value || "."
+        def add_insert
+          root_dir = configuration.root_dir
+
+          client.on(
+            "-i",
+            "--insert [PATH]",
+            %(Insert/update table of contents. Default: "#{root_dir}".)
+          ) do |path|
+            configuration.merge! action_insert: true, root_dir: path || root_dir
           end
         end
 
         def add_version
           client.on "-v", "--version", "Show gem version." do
-            options[:version] = Identity::VERSION_LABEL
+            configuration.merge! action_version: true
           end
         end
 
         def add_help
           client.on "-h", "--help", "Show this message." do
-            options[:help] = true
+            configuration.merge! action_help: true
           end
         end
+
+        def specification = container[__method__]
       end
     end
   end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "refinements/structs"
+
+module Tocer
+  module CLI
+    module Parsers
+      # Handles parsing of Command Line Interface (CLI) flags.
+      class Flag
+        using Refinements::Structs
+
+        def self.call(...) = new(...).call
+
+        def initialize configuration = Configuration::Loader.call, client: Parser::CLIENT
+          @configuration = configuration
+          @client = client
+        end
+
+        def call arguments = []
+          client.separator "\nOPTIONS:\n"
+          private_methods.sort.grep(/add_/).each { |method| __send__ method }
+          client.parse arguments
+          configuration
+        end
+
+        private
+
+        attr_reader :configuration, :client
+
+        def add_label
+          client.on(
+            "--label [LABEL]",
+            %(Add label. Default: "#{configuration.label}".)
+          ) do |value|
+            configuration.merge! label: value if value
+          end
+        end
+
+        def add_include
+          client.on(
+            "--includes [a,b,c]",
+            Array,
+            %(Add include patterns. Default: #{configuration.includes}.)
+          ) do |items|
+            configuration.merge! includes: items if items
+          end
+        end
+      end
+    end
+  end
+end

data/lib/tocer/cli/shell.rb

@@ -4,41 +4,42 @@ module Tocer
   module CLI
     # The main Command Line Interface (CLI) object.
     class Shell
-      PROCESSORS = {config: Processors::Config.new, build: Processors::Build.new}.freeze
+      ACTIONS = {config: Actions::Config.new, insert: Actions::Insert.new}.freeze
 
-      def initialize parser: Parsers::Assembler.new, processors: PROCESSORS
+      def initialize parser: Parser.new, actions: ACTIONS, container: Container
         @parser = parser
-        @processors = processors
+        @actions = actions
+        @container = container
       end
 
       def call arguments = []
-        parse arguments
-
-        case options
-          in config: action then process_config action
-          in build: path then process_build path
-          in version: then puts version
-          else usage
-        end
+        perform parser.call(arguments)
+      rescue OptionParser::ParseError => error
+        puts error.message
       end
 
       private
 
-      attr_reader :parser, :processors
+      attr_reader :parser, :actions, :container
 
-      def parse arguments = []
-        parser.call arguments
-      rescue StandardError => error
-        puts error.message
+      def perform configuration
+        case configuration
+          in action_config: Symbol => action then process_config action
+          in action_insert: true then process_insert configuration
+          in action_version: true then logger.info { "Tocer #{specification.version}" }
+          else usage
+        end
       end
 
-      def process_config(action) = processors.fetch(:config).call(action)
-
-      def process_build(path) = processors.fetch(:build).call(path, options)
+      def process_config(action) = actions.fetch(:config).call(action)
 
-      def options = parser.to_h
+      def process_insert(configuration) = actions.fetch(:insert).call(configuration)
 
       def usage = puts(parser.to_s)
+
+      def specification = container[__method__]
+
+      def logger = container[__method__]
     end
   end
 end

data/lib/tocer/configuration/content.rb

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

data/lib/tocer/{cli/configuration → configuration}/defaults.yml

@@ -1,3 +1,4 @@
 :label: "## Table of Contents"
 :includes:
   - "README.md"
+:root_dir: "."

data/lib/tocer/configuration/loader.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "refinements/structs"
+require "runcom"
+require "yaml"
+
+module Tocer
+  module Configuration
+    # Represents the fully assembled Command Line Interface (CLI) configuration.
+    class Loader
+      using Refinements::Structs
+
+      DEFAULTS = YAML.load_file(Pathname(__dir__).join("defaults.yml")).freeze
+      CLIENT = Runcom::Config.new "tocer/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)
+
+      private
+
+      attr_reader :content, :client
+    end
+  end
+end

data/lib/tocer/container.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "dry-container"
+require "logger"
+require "pastel"
+
+module Tocer
+  # Provides a global gem container for injection into other objects.
+  module Container
+    extend Dry::Container::Mixin
+
+    SPEC_PATH = "#{__dir__}/../../tocer.gemspec".freeze
+
+    register(:configuration) { Configuration::Loader.call }
+    register(:specification) { Gem::Specification.load SPEC_PATH }
+    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/tocer/elements/comment_block.rb

@@ -17,6 +17,8 @@ module Tocer
         @message = message
       end
 
+      def comments = "#{start_tag}\n#{finish_tag}\n"
+
       def start_index(lines) = self.class.index(lines, start_id)
 
       def start_tag = comment(start_id, message)
@@ -25,6 +27,8 @@ module Tocer
 
       def finish_tag = comment(finish_id, message)
 
+      def empty?(lines) = (finish_index(lines) - start_index(lines)) == 1
+
       def prependable?(lines) = start_index(lines).zero? && finish_index(lines).zero?
 
       private

data/lib/tocer/rake/tasks.rb

@@ -13,7 +13,7 @@ module Tocer
 
       def self.setup = new.install
 
-      def initialize configuration: CLI::Configuration::Loader.new.call, runner: Runner.new
+      def initialize configuration = Configuration::Loader.call, runner: Runner.new
         @configuration = configuration
         @runner = runner
       end
@@ -21,7 +21,7 @@ module Tocer
       def install
         desc "Add/Update Table of Contents (README)"
         task :toc, %i[label includes] do |_task, arguments|
-          runner.call(**configuration.merge(**arguments.to_h).to_h)
+          runner.call configuration.merge(**arguments.to_h)
         end
       end
 

data/lib/tocer/runner.rb

@@ -7,21 +7,20 @@ module Tocer
   class Runner
     using Refinements::Pathnames
 
-    def initialize configuration: CLI::Configuration::Loader.call, writer: Writer.new
-      @configuration = configuration
+    def initialize writer: Writer.new
       @writer = writer
     end
 
-    def call root_dir: ".", label: configuration.label, includes: configuration.includes
-      Pathname(root_dir).files(%({#{includes.join ","}}))
-                        .each do |path|
-                          yield path if block_given?
-                          writer.call path, label: label
-                        end
+    def call configuration = Configuration::Loader.call
+      Pathname(configuration.root_dir).files(%({#{configuration.includes.join ","}}))
+                                      .each do |path|
+                                        yield path if block_given?
+                                        writer.call path, label: configuration.label
+                                      end
     end
 
     private
 
-    attr_reader :configuration, :writer
+    attr_reader :writer
   end
 end

data/lib/tocer/transformers/finder.rb

@@ -11,8 +11,9 @@ module Tocer
       end
 
       def call markdown
-        transformers.find { |pattern, transformer| break transformer if pattern.match? markdown }
-                    .then { |transformer| transformer.new markdown }
+        transformers.find do |pattern, transformer|
+          break transformer.new markdown if pattern.match? markdown
+        end
       end
 
       private

data/lib/tocer/writer.rb

@@ -24,7 +24,7 @@ module Tocer
       @builder = builder
     end
 
-    def call path, label: CLI::Configuration::Loader.call.label
+    def call path, label: Configuration::Loader.call.label
       path.rewrite do |body|
         lines = body.each_line.to_a
         builder.prependable?(lines) ? prepend(lines, label) : replace(lines, label)
@@ -41,14 +41,22 @@ module Tocer
       klass = self.class
 
       klass.add(
-        start_index: start_index,
+        start_index:,
         old_lines: klass.remove(start_index, finish_index, lines),
-        new_lines: content(lines[finish_index, lines.length], label)
+        new_lines: new_lines(lines, label, finish_index)
       ).join
     end
 
+    def new_lines lines, label, finish_index
+      if builder.unbuildable? lines
+        builder.comments
+      else
+        content lines[finish_index, lines.length], label
+      end
+    end
+
     def prepend(lines, label) = [content(lines, label), lines.join].compress.join("\n")
 
-    def content(lines, label) = builder.call(lines, label: label)
+    def content(lines, label) = builder.call(lines, label:)
   end
 end

data/lib/tocer.rb

@@ -1,20 +1,13 @@
 # frozen_string_literal: true
 
-require "tocer/identity"
-require "tocer/elements/comment_block"
-require "tocer/parsers/header"
-require "tocer/transformers/link"
-require "tocer/transformers/text"
-require "tocer/transformers/finder"
-require "tocer/builder"
-require "tocer/writer"
-require "tocer/runner"
-require "tocer/cli/configuration/content"
-require "tocer/cli/configuration/loader"
-require "tocer/cli/parsers"
-require "tocer/cli/parsers/build"
-require "tocer/cli/parsers/core"
-require "tocer/cli/parsers/assembler"
-require "tocer/cli/processors/build"
-require "tocer/cli/processors/config"
-require "tocer/cli/shell"
+require "zeitwerk"
+
+Zeitwerk::Loader.for_gem.then do |loader|
+  loader.inflector.inflect "cli" => "CLI"
+  loader.ignore "#{__dir__}/tocer/rake"
+  loader.setup
+end
+
+# Main namespace.
+module Tocer
+end

data/tocer.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "tocer"
+  spec.version = "13.1.0"
+  spec.platform = Gem::Platform::RUBY
+  spec.authors = ["Brooke Kuhlmann"]
+  spec.email = ["brooke@alchemists.io"]
+  spec.homepage = "https://www.alchemists.io/projects/tocer"
+  spec.summary = "A command line interface for generating table of contents for Markdown files."
+  spec.license = "Hippocratic-3.0"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "https://github.com/bkuhlmann/tocer/issues",
+    "changelog_uri" => "https://www.alchemists.io/projects/tocer/versions",
+    "documentation_uri" => "https://www.alchemists.io/projects/tocer",
+    "label" => "Tocer",
+    "rubygems_mfa_required" => "true",
+    "source_code_uri" => "https://github.com/bkuhlmann/tocer"
+  }
+
+  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.0"
+  spec.add_dependency "zeitwerk", "~> 2.5"
+
+  spec.bindir = "exe"
+  spec.executables << "tocer"
+  spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
+  spec.files = Dir["*.gemspec", "lib/**/*"]
+  spec.require_paths = ["lib"]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tocer
 version: !ruby/object:Gem::Version
-  version: 12.2.0
+  version: 13.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,36 +28,78 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2021-11-20 00:00:00.000000000 Z
+date: 2022-01-23 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.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
@@ -73,18 +115,17 @@ files:
 - exe/tocer
 - lib/tocer.rb
 - lib/tocer/builder.rb
-- lib/tocer/cli/configuration/content.rb
-- lib/tocer/cli/configuration/defaults.yml
-- lib/tocer/cli/configuration/loader.rb
-- lib/tocer/cli/parsers.rb
-- lib/tocer/cli/parsers/assembler.rb
-- lib/tocer/cli/parsers/build.rb
+- lib/tocer/cli/actions/config.rb
+- lib/tocer/cli/actions/insert.rb
+- lib/tocer/cli/parser.rb
 - lib/tocer/cli/parsers/core.rb
-- lib/tocer/cli/processors/build.rb
-- lib/tocer/cli/processors/config.rb
+- lib/tocer/cli/parsers/flag.rb
 - lib/tocer/cli/shell.rb
+- lib/tocer/configuration/content.rb
+- lib/tocer/configuration/defaults.yml
+- lib/tocer/configuration/loader.rb
+- lib/tocer/container.rb
 - lib/tocer/elements/comment_block.rb
-- lib/tocer/identity.rb
 - lib/tocer/parsers/header.rb
 - lib/tocer/rake/setup.rb
 - lib/tocer/rake/tasks.rb
@@ -93,13 +134,15 @@ files:
 - lib/tocer/transformers/link.rb
 - lib/tocer/transformers/text.rb
 - lib/tocer/writer.rb
+- tocer.gemspec
 homepage: https://www.alchemists.io/projects/tocer
 licenses:
-- Apache-2.0
+- Hippocratic-3.0
 metadata:
   bug_tracker_uri: https://github.com/bkuhlmann/tocer/issues
-  changelog_uri: https://www.alchemists.io/projects/tocer/changes.html
+  changelog_uri: https://www.alchemists.io/projects/tocer/versions
   documentation_uri: https://www.alchemists.io/projects/tocer
+  label: Tocer
   rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/bkuhlmann/tocer
 post_install_message:
@@ -110,14 +153,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.5
 signing_key:
 specification_version: 4
 summary: A command line interface for generating table of contents for Markdown files.