tocer 13.0.0 → 13.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f01d37e55755b4242744ef97618aa53d885ebc991720b6dc51e61d0ffc33bdf3
-  data.tar.gz: f64c607d7696f9f8b558beec2cd2d7ff4d65e3744b3a3d7a88e684af620e806e
+  metadata.gz: 106fe66e91b4c302490857f948a672413a10e7729d56af5800964a3409fcfb17
+  data.tar.gz: b1569fe8b8ef51f0f2174d2506c8f1cba3b2180bdc47c8c60c28c0a6712e2e78
 SHA512:
-  metadata.gz: c551b013375913a6de8e5c4f0d61bf10113a6f05598e418214c8f0f22bd2b2208b12a69d04bdec8157d51e2ab80bd175ca1ed49271978340d82bcd55373f35dc
-  data.tar.gz: 2a61d437c27b50bce2a5d537fe7a1edba22af45599a1c4fc0b3d2c97be4cf3460a3a6a17b7dfc5b7824b3cfbc41c771721545fbf1f8e5dae472997f702742fe6
+  metadata.gz: 7574ea429e82b68a289e7c9c288b417d87a7d93f0a9b123766e2579c90eca585e63b97c1c41947f03696e430ec183112ff04d38095b7b4b98f34e269692b7a5d
+  data.tar.gz: 10378c3612273946c194e6a414c614ad4bb47dde72aa1c407cadc9122f9549eb939e223f059acdce5cf904be7be2fb11424627792c0db18871c11551829d0481

data/README.adoc

@@ -4,13 +4,6 @@
 
 = Tocer
 
-[link=http://badge.fury.io/rb/tocer]
-image::https://badge.fury.io/rb/tocer.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/tocer]
-image::https://circleci.com/gh/bkuhlmann/tocer.svg?style=svg[Circle CI Status]
-
 Tocer (a.k.a. Table of Contenter) is a command line interface for generating table of contents for
 Markdown files. Use this tool to automatically manage and update your documentation with minimal
 effort. Works on single files or multiple files within nested directory structures.
@@ -176,35 +169,17 @@ To test, run:
 bundle exec rake
 ----
 
-== Versioning
-
-Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means:
-
-* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
-* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
-* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
-
-== Code of Conduct
-
-Please note that this project is released with a link:CODE_OF_CONDUCT.adoc[CODE OF CONDUCT]. By
-participating in this project you agree to abide by its terms.
-
-== Contributions
-
-Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
-
-== Community
+== link:https://www.alchemists.io/policies/license[License]
 
-Feel free to link:https://www.alchemists.io/community[join the commmunity] for discussions related
-to this project and much more.
+== link:https://www.alchemists.io/policies/security[Security]
 
-== License
+== link:https://www.alchemists.io/policies/code_of_conduct[Code of Conduct]
 
-Read link:LICENSE.adoc[LICENSE] for details.
+== link:https://www.alchemists.io/policies/contributions[Contributions]
 
-== Changes
+== link:https://www.alchemists.io/projects/tocer/versions[Versions]
 
-Read link:CHANGES.adoc[CHANGES] for details.
+== link:https://www.alchemists.io/community[Community]
 
 == Credits
 

data/exe/tocer

@@ -3,5 +3,4 @@
 
 require "tocer"
 
-Process.setproctitle Tocer::Identity::VERSION_LABEL
 Tocer::CLI::Shell.new.call ARGV

data/lib/tocer/cli/actions/config.rb

@@ -5,26 +5,30 @@ module Tocer
     module Actions
       # Handles the config action.
       class Config
-        def initialize client: Configuration::Loader::CLIENT, kernel: Kernel
+        def initialize client: Configuration::Loader::CLIENT, container: Container
           @client = client
-          @kernel = kernel
+          @container = container
         end
 
-        def call action
-          case action
+        def call selection
+          case selection
             when :edit then edit
             when :view then view
-            else kernel.puts "Invalid configuration action: #{action}."
+            else logger.error { "Invalid configuration selection: #{selection}." }
           end
         end
 
         private
 
-        attr_reader :client, :kernel
+        attr_reader :client, :container
 
         def edit = kernel.system("$EDITOR #{client.current}")
 
         def view = kernel.system("cat #{client.current}")
+
+        def kernel = container[__method__]
+
+        def logger = container[__method__]
       end
     end
   end

data/lib/tocer/cli/actions/insert.rb

@@ -5,15 +5,20 @@ module Tocer
     module Actions
       # Handles the insert action.
       class Insert
-        def initialize runner: Runner.new
+        def initialize runner: Runner.new, container: Container
           @runner = runner
+          @container = container
         end
 
-        def call(configuration) = runner.call(configuration) { |path| puts "  #{path}" }
+        def call configuration
+          runner.call(configuration) { |path| logger.info { "  #{path}" } }
+        end
 
         private
 
-        attr_reader :runner
+        attr_reader :runner, :container
+
+        def logger = container[__method__]
       end
     end
   end

data/lib/tocer/cli/parser.rb

@@ -9,10 +9,10 @@ module Tocer
       CLIENT = OptionParser.new nil, 40, "  "
       SECTIONS = [Parsers::Core, Parsers::Flag].freeze # Order is important.
 
-      def initialize configuration = Configuration::Loader.call, sections: SECTIONS, client: CLIENT
-        @configuration = configuration.dup
+      def initialize sections: SECTIONS, client: CLIENT, container: Container
         @sections = sections
         @client = client
+        @configuration = container[:configuration].dup
       end
 
       def call arguments = []
@@ -25,7 +25,7 @@ module Tocer
 
       private
 
-      attr_reader :configuration, :sections, :client
+      attr_reader :sections, :client, :configuration
     end
   end
 end

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "tocer/identity"
 require "refinements/structs"
 
 module Tocer
@@ -12,13 +11,16 @@ module Tocer
 
         def self.call(...) = new(...).call
 
-        def initialize configuration = Configuration::Loader.call, client: Parser::CLIENT
+        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 = specification.labeled_summary
           client.separator "\nUSAGE:\n"
           collate
           client.parse arguments
@@ -27,7 +29,7 @@ module Tocer
 
         private
 
-        attr_reader :configuration, :client
+        attr_reader :configuration, :client, :container
 
         def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
 
@@ -65,6 +67,8 @@ module Tocer
             configuration.merge! action_help: true
           end
         end
+
+        def specification = container[__method__]
       end
     end
   end

data/lib/tocer/cli/shell.rb

@@ -6,9 +6,10 @@ module Tocer
     class Shell
       ACTIONS = {config: Actions::Config.new, insert: Actions::Insert.new}.freeze
 
-      def initialize parser: Parser.new, actions: ACTIONS
+      def initialize parser: Parser.new, actions: ACTIONS, container: Container
         @parser = parser
         @actions = actions
+        @container = container
       end
 
       def call arguments = []
@@ -19,13 +20,13 @@ module Tocer
 
       private
 
-      attr_reader :parser, :actions
+      attr_reader :parser, :actions, :container
 
       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 puts Identity::VERSION_LABEL
+          in action_version: true then logger.info { specification.labeled_version }
           else usage
         end
       end
@@ -35,6 +36,10 @@ module Tocer
       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/loader.rb

@@ -12,7 +12,7 @@ module Tocer
       using Refinements::Structs
 
       DEFAULTS = YAML.load_file(Pathname(__dir__).join("defaults.yml")).freeze
-      CLIENT = Runcom::Config.new "#{Identity::NAME}/configuration.yml", defaults: DEFAULTS
+      CLIENT = Runcom::Config.new "tocer/configuration.yml", defaults: DEFAULTS
 
       def self.call = new.call
 

data/lib/tocer/container.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "dry-container"
+require "logger"
+require "pastel"
+require "spek"
+
+module Tocer
+  # 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__}/../../tocer.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/tocer/transformers/finder.rb

@@ -12,7 +12,7 @@ module Tocer
 
       def call markdown
         transformers.find do |pattern, transformer|
-          break transformer.new(markdown) if pattern.match? markdown
+          break transformer.new markdown if pattern.match? markdown
         end
       end
 

data/lib/tocer/writer.rb

@@ -48,10 +48,10 @@ module Tocer
     end
 
     def new_lines lines, label, finish_index
-      if builder.unbuildable?(lines)
+      if builder.unbuildable? lines
         builder.comments
       else
-        content(lines[finish_index, lines.length], label)
+        content lines[finish_index, lines.length], label
       end
     end
 

data/lib/tocer.rb

@@ -4,7 +4,7 @@ require "zeitwerk"
 
 Zeitwerk::Loader.for_gem.then do |loader|
   loader.inflector.inflect "cli" => "CLI"
-  loader.ignore "#{__dir__}/rake/setup.rb"
+  loader.ignore "#{__dir__}/tocer/rake"
   loader.setup
 end
 

data/tocer.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name = "tocer"
+  spec.version = "13.2.0"
+  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.2"
+  spec.add_dependency "spek", "~> 0.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/**/*"]
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tocer
 version: !ruby/object:Gem::Version
-  version: 13.0.0
+  version: 13.2.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,36 +28,78 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2021-12-29 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: '9.0'
+        version: '9.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '9.1'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.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: '8.0'
+        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -96,8 +138,8 @@ files:
 - 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
@@ -106,13 +148,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:
 - 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:
@@ -130,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
 summary: A command line interface for generating table of contents for Markdown files.

data/lib/tocer/identity.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Tocer
-  # Gem identity information.
-  module Identity
-    NAME = "tocer"
-    LABEL = "Tocer"
-    VERSION = "13.0.0"
-    VERSION_LABEL = "#{LABEL} #{VERSION}".freeze
-    SUMMARY = "A command line interface for generating table of contents for Markdown files."
-  end
-end