tocer 8.2.1 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de08def15c7da9f0e9f3fc337decee184eec685edd94395d5047741a923c0983
-  data.tar.gz: 40b60a857bce2e4e5ab1b7a5c416b8040b644ae7edad35c2ef6554bd8f8f52de
+  metadata.gz: a3c9b3dae9b9556720306f6c34cc8f516f447e3cca5e461949c4f417c24e9e7f
+  data.tar.gz: c41d9489fc0f358d580e7e002fda5ab52cca4bd169000de3a9aa0f76edd5381e
 SHA512:
-  metadata.gz: 9451bde0737ece398e55010f999010389bef5bb5d57ae9a314aa4d3004178962c4c8d5924432282d6144e1b037dfe5a8506aab812787bee35ee68ee2c0c44683
-  data.tar.gz: f64b8781b9acb5ed881125026705ff809d31e7f757cb2c5d50288155f6c3c2f59b8d0015600067661449d52373db51534519c3eaa7b1307dc5623a3b8373bfca
+  metadata.gz: 57c8ebbfdc73807bf818b4f871e5aea7631c2a8b1be6739ee677a670ee52ff7541bc4070785b3ef09f29e79d8c3727d83650020ec19d3e93e9d44b83ff399a5c
+  data.tar.gz: 3137ddfc17abba4c07ce2cbce0558809cb8c2eb0eb04b5ed40d3953c454683bc86d292375d8dc19c04f8a06b7421a095090a9ddf880d9a12645b617c3a29a8df

data/README.md

@@ -22,6 +22,7 @@ Markdown files.
   - [Usage](#usage)
     - [Command Line Interface (CLI)](#command-line-interface-cli)
     - [Customization](#customization)
+    - [Rake](#rake)
   - [Tests](#tests)
   - [Versioning](#versioning)
   - [Code of Conduct](#code-of-conduct)
@@ -109,7 +110,7 @@ Feel free to take this default configuration, modify, and save as your own custo
 The `configuration.yml` file can be configured as follows:
 
 - `label`: The header label for the table of contents. Default: "# Table of Contents".
-- `includes`: The list of included files. Default: "*.md".
+- `includes`: The list of included files. Default: "\*.md".
 
 There are multiple ways the include list can be defined. Here are some examples:
 
@@ -132,6 +133,20 @@ There are multiple ways the include list can be defined. Here are some examples:
     :includes:
       - "**/*.md"
 
+### Rake
+
+You can add Rake support by adding the following to your `Rakefile`:
+
+    begin
+      require "tocer/rake/setup"
+    rescue LoadError => error
+      puts error.message
+    end
+
+Once configured, the following tasks will be available (i.e. `bundle exec rake -T`):
+
+    rake toc[label,includes]   # Add/Update Table of Contents (README)
+
 ## Tests
 
 To test, run:

data/lib/tocer.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
 require "tocer/identity"
+require "tocer/configuration"
 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"

data/lib/tocer/builder.rb

@@ -11,22 +11,14 @@ module Tocer
 
     def_delegators :comment_block, :start_index, :finish_index, :prependable?
 
-    def self.transformer header
-      if header.match?(/\[.+\]\(.+\)/)
-        Transformers::Link.new header
-      else
-        Transformers::Text.new header
-      end
-    end
-
     def initialize label: "## Table of Contents", comment_block: Elements::CommentBlock.new
       @label = label
       @comment_block = comment_block
-      @url_count = Hash.new { |hash, key| hash[key] = 0 }
+      @url_count = Hash.new 0
       @code_block = false
     end
 
-    def build lines
+    def call lines
       return "" if headers(lines).empty?
 
       [
@@ -42,23 +34,8 @@ module Tocer
     attr_reader :label, :comment_block, :url_count
     attr_accessor :code_block
 
-    def toggle_code_block line
-      return unless line.start_with? CODE_BLOCK_PUNCTUATION
-
-      self.code_block = !code_block
-    end
-
-    def url_suffix url
-      count = url_count[url]
-      count.zero? ? "" : count
-    end
-
-    def transform header
-      transformer = self.class.transformer header
-      url = transformer.url
-      link = transformer.transform url_suffix: url_suffix(url)
-      url_count[url] += 1
-      link
+    def links lines
+      headers(lines).map { |markdown| transform markdown }
     end
 
     def headers lines
@@ -68,8 +45,23 @@ module Tocer
       end
     end
 
-    def links lines
-      headers(lines).map { |header| transform header }
+    def toggle_code_block line
+      return unless line.start_with? CODE_BLOCK_PUNCTUATION
+
+      self.code_block = !code_block
+    end
+
+    def transform markdown
+      Transformers::Finder.call(markdown).then do |transformer|
+        url = transformer.url
+        link = transformer.call url_suffix: url_suffix(url)
+        url_count[url] += 1
+        link
+      end
+    end
+
+    def url_suffix url
+      url_count[url].then { |count| count.zero? ? "" : count }
     end
   end
 end

data/lib/tocer/cli.rb

@@ -11,17 +11,9 @@ module Tocer
 
     package_name Identity.version_label
 
-    def self.configuration
-      Runcom::Config.new Identity.name,
-                         defaults: {
-                           label: "## Table of Contents",
-                           includes: ["README.md"]
-                         }
-    end
-
     def initialize args = [], options = {}, config = {}
       super args, options, config
-      @configuration = self.class.configuration
+      @configuration = Tocer::Configuration.default
     rescue Runcom::Errors::Base => error
       abort error.message
     end
@@ -32,12 +24,12 @@ module Tocer
                   aliases: "-l",
                   desc: "Label",
                   type: :string,
-                  default: configuration.to_h.fetch(:label)
+                  default: Tocer::Configuration.default.to_h.fetch(:label)
     method_option :includes,
                   aliases: "-i",
                   desc: "File include list",
                   type: :array,
-                  default: configuration.to_h.fetch(:includes)
+                  default: Tocer::Configuration.default.to_h.fetch(:includes)
     # :reek:TooManyStatements
     def generate path = "."
       updated_configuration = configuration.merge label: options.label, includes: options.includes
@@ -46,7 +38,7 @@ module Tocer
 
       return if files.empty?
 
-      runner.run
+      runner.call
 
       say "Processed table of contents for:"
       files.each { |file| say "  #{file}" }

data/lib/tocer/configuration.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "runcom"
+
+module Tocer
+  module Configuration
+    def self.default
+      Runcom::Config.new Identity.name,
+                         defaults: {
+                           label: "## Table of Contents",
+                           includes: ["README.md"]
+                         }
+    end
+  end
+end

data/lib/tocer/identity.rb

@@ -12,7 +12,7 @@ module Tocer
     end
 
     def self.version
-      "8.2.1"
+      "9.0.0"
     end
 
     def self.version_label

data/lib/tocer/rake/setup.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "tocer/rake/tasks"
+Tocer::Rake::Tasks.setup

data/lib/tocer/rake/tasks.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "rake"
+
+module Tocer
+  module Rake
+    class Tasks
+      include ::Rake::DSL
+
+      def self.setup
+        new.install
+      end
+
+      def initialize configuration: Tocer::Configuration.default, runner: Runner
+        @configuration = configuration
+        @runner = runner
+      end
+
+      def install
+        desc "Add/Update Table of Contents (README)"
+        task :toc, %i[label includes] do |_task, arguments|
+          inputs = {label: arguments[:label], includes: arguments[:includes]}.compact
+          updated_configuration = configuration.merge inputs
+          runner.new(configuration: updated_configuration.to_h).call
+        end
+      end
+
+      private
+
+      attr_reader :configuration, :runner
+    end
+  end
+end

data/lib/tocer/runner.rb

@@ -17,8 +17,8 @@ module Tocer
       Pathname.glob(%(#{path}/{#{includes.join ","}})).select(&:file?)
     end
 
-    def run
-      files.each { |file| writer.new(file, label: configuration.fetch(:label)).write }
+    def call
+      files.each { |file| writer.new(file, label: configuration.fetch(:label)).call }
     end
 
     private

data/lib/tocer/transformers/finder.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Tocer
+  module Transformers
+    # Finds appropriate header transformer for matching pattern.
+    class Finder
+      TRANSFORMERS = {
+        /\[.+\]\(.+\)/ => Transformers::Link,
+        /.*/ => Transformers::Text
+      }.freeze
+
+      def self.call markdown
+        TRANSFORMERS.find { |pattern, transformer| break transformer if pattern.match? markdown }
+                    .then { |transformer| transformer.new markdown }
+      end
+    end
+  end
+end

data/lib/tocer/transformers/link.rb

@@ -8,46 +8,49 @@ module Tocer
     class Link
       using Refinements::Arrays
 
-      def initialize text, header: Parsers::Header
-        @header = header.new text
+      def initialize text, parser: Parsers::Header
+        @parser = parser.new text
       end
 
       def label
-        header.content.gsub embedded_link, embedded_link_label
+        parser.content.gsub embedded_link, embedded_link_label
       end
 
       def url
         label.downcase.gsub(/\s/, "-").gsub(/[^\w\-]+/, "")
       end
 
-      def transform url_suffix: ""
-        modified_url = [url, url_suffix.to_s].compress.join "-"
-        "#{indented_bullet}[#{label}](##{modified_url})"
+      def call url_suffix: ""
+        "#{indented_bullet}[#{label}](##{computed_url url_suffix})"
       end
 
       private
 
-      attr_reader :header
+      attr_reader :parser
 
-      def embedded_link_label
-        header.content[/\[(.*)\]/, 1]
-      end
-
-      def embedded_link_url
-        header.content[/\((.*)\)/, 1]
+      def computed_url suffix = ""
+        [url, suffix.to_s].compress.join "-"
       end
 
       def embedded_link
         "[#{embedded_link_label}](#{embedded_link_url})"
       end
 
-      def prefix_to_spaces
-        Array.new(header.prefix.length, "  ").join
+      def embedded_link_label
+        parser.content[/\[(.*)\]/, 1]
+      end
+
+      def embedded_link_url
+        parser.content[/\((.*)\)/, 1]
       end
 
       def indented_bullet
         prefix_to_spaces.gsub(/\s{2}$/, "- ")
       end
+
+      def prefix_to_spaces
+        Array.new(parser.prefix.length, "  ").join
+      end
     end
   end
 end

data/lib/tocer/transformers/text.rb

@@ -8,34 +8,37 @@ module Tocer
     class Text
       using Refinements::Arrays
 
-      def initialize text, header: Parsers::Header
-        @header = header.new text
+      def initialize text, parser: Parsers::Header
+        @parser = parser.new text
       end
 
       def label
-        header.content
+        parser.content
       end
 
       def url
         label.downcase.gsub(/\s/, "-").gsub(/[^\w\-]+/, "")
       end
 
-      def transform url_suffix: ""
-        modified_url = [url, url_suffix.to_s].compress.join "-"
-        "#{indented_bullet}[#{label}](##{modified_url})"
+      def call url_suffix: ""
+        "#{indented_bullet}[#{label}](##{computed_url url_suffix})"
       end
 
       private
 
-      attr_reader :header
+      attr_reader :parser
 
-      def prefix_to_spaces
-        Array.new(header.prefix.length, "  ").join
+      def computed_url suffix = ""
+        [url, suffix.to_s].compress.join "-"
       end
 
       def indented_bullet
         prefix_to_spaces.gsub(/\s{2}$/, "- ")
       end
+
+      def prefix_to_spaces
+        Array.new(parser.prefix.length, "  ").join
+      end
     end
   end
 end

data/lib/tocer/writer.rb

@@ -18,7 +18,7 @@ module Tocer
       @builder = builder
     end
 
-    def write
+    def call
       lines = File.readlines file_path
       body = builder.prependable?(lines) ? prepend(lines) : replace(lines)
       File.open(file_path, "w") { |file| file.write body }
@@ -29,7 +29,7 @@ module Tocer
     attr_reader :file_path, :builder
 
     def content lines
-      builder.build lines
+      builder.call lines
     end
 
     def replace lines

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tocer
 version: !ruby/object:Gem::Version
-  version: 8.2.1
+  version: 9.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,7 +28,7 @@ cert_chain:
   dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
   y84=
   -----END CERTIFICATE-----
-date: 2019-05-02 00:00:00.000000000 Z
+date: 2019-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: refinements
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -128,34 +128,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: gemsmith
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: git-cop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -232,14 +204,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -260,42 +232,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.67'
+        version: '0.69'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.67'
+        version: '0.69'
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.30'
+        version: '1.33'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.30'
+        version: '1.33'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -340,10 +312,14 @@ files:
 - lib/tocer.rb
 - lib/tocer/builder.rb
 - lib/tocer/cli.rb
+- lib/tocer/configuration.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
 - lib/tocer/runner.rb
+- lib/tocer/transformers/finder.rb
 - lib/tocer/transformers/link.rb
 - lib/tocer/transformers/text.rb
 - lib/tocer/writer.rb