tocer 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ced1fb93f4c52c60a2ea5269d5dbb26f6987fb3a
-  data.tar.gz: 9526ee10285dead69f802fbd995f48dd8c22061b
+  metadata.gz: 2f12d5a3b405216b970f03b881e0a36c00e0091f
+  data.tar.gz: 898e0ba35499767b75fe50e88f15e62f6a95bb6f
 SHA512:
-  metadata.gz: 21eb3f82c3020bc95a939f01d02f63752a5b060750606e68398f9e9cb8419f603998391dab13b71474df195771686f24742fc86c3c88737892064a0e2dbdafcf
-  data.tar.gz: b9bcc33e6ce0dbed48268305c7ea499ee765d4d614571f2497340d8264f63ce552643d35deb59c29c78a1e3edefb39cb37b0f980500a2b42790c81940f2b9d4d
+  metadata.gz: 6da1ab64f2fba3c688711ddc88e6c732e6c19e2b29f4da278f8c4d9cff7fbb6d4f028a6969b042eed9539cce04e9ab1de2407d98d71537b3c239c4d706f6219f
+  data.tar.gz: 615fa828848a718049deec38252626d94d9a4d279a618109afa2c743580e5441f9c694d38077122ceedc8a6e4aa5de455b7deacfb55da240a1b841eb64db120a

data/README.md

@@ -9,14 +9,16 @@
 
 Tocer (a.k.a. Table of Contenter) is command line interface for generating table of contents for Markdown files.
 
-<!-- START doctoc generated TOC please keep comment here to allow auto update -->
-<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+<!-- Tocer[start]: Auto-generated, don't remove. -->
+
 # Table of Contents
 
 - [Features](#features)
 - [Requirements](#requirements)
 - [Setup](#setup)
 - [Usage](#usage)
+  - [Command Line Interface (CLI)](#command-line-interface-cli)
+  - [Customization](#customization)
 - [Tests](#tests)
 - [Versioning](#versioning)
 - [Code of Conduct](#code-of-conduct)
@@ -25,13 +27,13 @@ Tocer (a.k.a. Table of Contenter) is command line interface for generating table
 - [History](#history)
 - [Credits](#credits)
 
-<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+<!-- Tocer[finish]: Auto-generated, don't remove. -->
 
 # Features
 
 - Supports Markdown ATX-style headers. Example: `# Header`.
     - Does not support header suffixes. Example: `# Header #`.
-    - Does not support header previxes without spaces. Example: `#Header`.
+    - Does not support header prefixes without spaces. Example: `#Header`.
 - Prepends table of contents to Markdown documents that don't have table of contents.
 - Replaces/updates Markdown documents that have existing table of contents.
 
@@ -56,6 +58,8 @@ For an insecure install, type the following (not recommended):
 
 # Usage
 
+## Command Line Interface (CLI)
+
 From the command line, type: `tocer help`
 
     tocer -e, [--edit]               # Edit Tocer settings in default editor.
@@ -66,8 +70,8 @@ From the command line, type: `tocer help`
 To add Tocer support, add the following at the correct position within your Markdown files:
 
 ```
-<!-- Tocer[start]: Auto-generated, don't remove. -->
-<!-- Tocer[finish]: Auto-generated, don't remove. -->
+<!-- Tocer[start] -->
+<!-- Tocer[finish] -->
 ```
 
 Alternatively, you can run `tocer -g <file_path>` on a file that does not have Tocer support and it will prepend the above
@@ -77,6 +81,25 @@ In the case that Tocer has already auto-generated a table of contents for a Mark
 contents has become stale, or placement of the table of contents has changed you can re-run Tocer on that file to auto-
 update it with new table of contents.
 
+## Customization
+
+If desired, this gem supports global customization via the `~/.tocerrc` file. Order of precedence is determined in the
+following order (with the last one taking top priority):
+
+0. Global `~/.tocerrc`.
+0. CLI option. Example: `tocer --generate README.md --label "Custom Label"`
+
+Any setting provided to the CLI during runtime would trump the global setting. The global setting is the weakest of all
+but great for situations where custom settings should be applied to *all* projects.
+
+The `~/.tocerrc` uses the following default settings:
+
+    :label: "# Table of Contents"
+
+Each `~/.tocerrc` setting can be configured as follows:
+
+- `label`: The header label for the table of contents. Default: "# Table of Contents".
+
 # Tests
 
 To test, run:

data/lib/tocer.rb

@@ -1,5 +1,8 @@
+require "tocer/elements/comment_block"
+require "tocer/parsers/header"
+require "tocer/transformers/link"
+require "tocer/transformers/text"
 require "tocer/builder"
-require "tocer/commenter"
+require "tocer/configuration"
 require "tocer/identity"
-require "tocer/transformer"
 require "tocer/writer"

data/lib/tocer/builder.rb

@@ -1,32 +1,52 @@
 module Tocer
-  # Builds table of contents for a document in Markdown.
+  # Builds a table of contents for a Markdown document.
   class Builder
-    def initialize lines, label: "# Table of Contents", transformer: Transformer, commenter: Commenter
+    def initialize lines, label: "# Table of Contents", comment_block: Elements::CommentBlock
       @lines = lines
       @label = label
-      @transformer = transformer
-      @commenter = commenter.new
+      @comment_block = comment_block.new
+      @url_count = Hash.new { |hash, key| hash[key] = 0 }
     end
 
     def headers
-      lines.select { |line| line.start_with? "#" }
+      lines.select { |line| line.start_with? Parsers::Header.punctuation }
     end
 
     def build
       return "" if headers.empty?
 
-      content = "#{commenter.start}\n\n"
+      content = "#{comment_block.start}\n\n"
       content << "#{label}\n\n"
       content << headers_as_links.join("\n")
-      content << "\n\n#{commenter.finish}\n\n"
+      content << "\n\n#{comment_block.finish}\n\n"
     end
 
     private
 
-    attr_reader :lines, :label, :transformer, :commenter
+    attr_reader :lines, :label, :comment_block, :url_count
+
+    def acquire_transfomer header
+      case
+        when header =~ /\[.+\]\(.+\)/
+          Transformers::Link.new header
+        else
+          Transformers::Text.new header
+      end
+    end
+
+    def url_suffix url
+      url_count[url].zero? ? "" : url_count[url]
+    end
+
+    def transform header
+      transformer = acquire_transfomer header
+      link = transformer.transform url_suffix: url_suffix(transformer.url)
+      url_count[transformer.url] += 1
+      link
+    end
 
     def headers_as_links
-      headers.map { |header| transformer.new(header).transform }
+      headers.map { |header| transform header }
     end
   end
 end

data/lib/tocer/cli.rb

@@ -13,13 +13,15 @@ module Tocer
 
     def initialize args = [], options = {}, config = {}
       super args, options, config
+      @configuration = Configuration.new
     end
 
     desc "-g, [--generate=GENERATE]", "Generate table of contents."
     map %w(-g --generate) => :generate
+    method_option :label, aliases: "-l", desc: "Custom label", type: :string, default: "# Table of Contents"
     def generate file_path
-      writer = Writer.new file_path
-      writer.write
+      update_configuration! options
+      Writer.new(file_path, label: configuration.label).write
       say "Generated table of contents: #{file_path}."
     end
 
@@ -42,5 +44,14 @@ module Tocer
     def help task = nil
       say && super
     end
+
+    private
+
+    attr_reader :configuration
+
+    def update_configuration! options
+      return if options[:label] == "# Table of Contents"
+      configuration.label = options[:label]
+    end
   end
 end

data/lib/tocer/configuration.rb

@@ -0,0 +1,26 @@
+module Tocer
+  # Default configuration for gem with support for custom settings.
+  class Configuration
+    attr_reader :file_path
+    attr_writer :label
+
+    def initialize file_path: File.join(ENV["HOME"], Identity.file_name)
+      @file_path = file_path
+      @settings = load_settings
+    end
+
+    def label
+      @label ||= settings.fetch(:label, "# Table of Contents")
+    end
+
+    private
+
+    attr_reader :settings
+
+    def load_settings
+      return {} unless File.exist?(file_path)
+      yaml = YAML.load_file file_path
+      yaml.is_a?(Hash) ? yaml : {}
+    end
+  end
+end

data/lib/tocer/elements/comment_block.rb

@@ -0,0 +1,40 @@
+module Tocer
+  module Elements
+    # Represents a table of contents start and finish comment block.
+    class CommentBlock
+      def initialize start_id: "Tocer[start]", finish_id: "Tocer[finish]", message: "Auto-generated, don't remove."
+        @start_id = start_id
+        @finish_id = finish_id
+        @message = message
+      end
+
+      def start
+        comment start_id, message
+      end
+
+      def start_index collection
+        index collection, start_id
+      end
+
+      def finish
+        comment finish_id, message
+      end
+
+      def finish_index collection
+        index collection, finish_id
+      end
+
+      private
+
+      attr_reader :start_id, :finish_id, :message
+
+      def comment id, message
+        "<!-- #{id}: #{message} -->"
+      end
+
+      def index collection, id
+        collection.index { |line| line =~ /\<\!\-\-.*#{Regexp.escape id}.*\-\-\>/ }
+      end
+    end
+  end
+end

data/lib/tocer/identity.rb

@@ -10,7 +10,7 @@ module Tocer
     end
 
     def self.version
-      "0.1.0"
+      "1.0.0"
     end
 
     def self.version_label

data/lib/tocer/parsers/header.rb

@@ -0,0 +1,26 @@
+module Tocer
+  module Parsers
+    # Represents a Markdown header.
+    class Header
+      def self.punctuation
+        "#"
+      end
+
+      def initialize markdown
+        @markdown = markdown
+      end
+
+      def prefix
+        String markdown[/#{self.class.punctuation}{1,}/]
+      end
+
+      def content
+        markdown[prefix.length + 1, markdown.length].strip
+      end
+
+      private
+
+      attr_reader :markdown
+    end
+  end
+end

data/lib/tocer/transformers/link.rb

@@ -0,0 +1,51 @@
+require "refinements/array_extensions"
+
+module Tocer
+  module Transformers
+    # Transforms a Markdown header (embedded link) into a table of contents link.
+    class Link
+      using Refinements::ArrayExtensions
+
+      def initialize text, header: Parsers::Header
+        @header = header.new text
+      end
+
+      def label
+        header.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})"
+      end
+
+      private
+
+      attr_reader :header
+
+      def embedded_link_label
+        header.content[/\[(.*)\]/, 1]
+      end
+
+      def embedded_link_url
+        header.content[/\((.*)\)/, 1]
+      end
+
+      def embedded_link
+        "[#{embedded_link_label}](#{embedded_link_url})"
+      end
+
+      def prefix_to_spaces
+        Array.new(header.prefix.length, "  ").join
+      end
+
+      def indented_bullet
+        prefix_to_spaces.gsub(/\s{2}$/, "- ")
+      end
+    end
+  end
+end

data/lib/tocer/transformers/text.rb

@@ -0,0 +1,39 @@
+require "refinements/array_extensions"
+
+module Tocer
+  module Transformers
+    # Transforms a Markdown header (plain text) into a table of contents link.
+    class Text
+      using Refinements::ArrayExtensions
+
+      def initialize text, header: Parsers::Header
+        @header = header.new text
+      end
+
+      def label
+        header.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})"
+      end
+
+      private
+
+      attr_reader :header
+
+      def prefix_to_spaces
+        Array.new(header.prefix.length, "  ").join
+      end
+
+      def indented_bullet
+        prefix_to_spaces.gsub(/\s{2}$/, "- ")
+      end
+    end
+  end
+end

data/lib/tocer/writer.rb

@@ -1,11 +1,12 @@
 module Tocer
   # Writes table of contents to a Markdown document.
   class Writer
-    def initialize file_path, builder: Builder, commenter: Commenter
+    def initialize file_path, label: "# Table of Contents", builder: Builder, comment_block: Elements::CommentBlock
       @file_path = file_path
       @file_lines = File.open(file_path).to_a
+      @label = label
       @builder = builder
-      setup_indexes commenter.new, @file_lines
+      setup_indexes comment_block.new, @file_lines
     end
 
     def write
@@ -15,15 +16,15 @@ module Tocer
 
     private
 
-    attr_reader :file_path, :file_lines, :start_index, :finish_index, :builder, :commenter
+    attr_reader :file_path, :file_lines, :label, :start_index, :finish_index, :builder, :comment_block
 
-    def setup_indexes commenter, lines
-      @start_index = commenter.start_index lines
-      @finish_index = commenter.finish_index lines
+    def setup_indexes comment_block, lines
+      @start_index = comment_block.start_index lines
+      @finish_index = comment_block.finish_index lines
     end
 
     def content lines
-      builder.new(lines).build
+      builder.new(lines, label: label).build
     end
 
     def remove_toc lines

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tocer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,36 +30,50 @@ cert_chain:
   aSif+qBc6oHD7EQWPF5cZkzkIURuwNwPBngZGxIKaMAgRhjGFXzUMAaq++r59cS9
   xTfQ4k6fglKEgpnLAXiKdo2c8Ym+X4rIKFfedQ==
   -----END CERTIFICATE-----
-date: 2015-11-15 00:00:00.000000000 Z
+date: 2015-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.19'
 - !ruby/object:Gem::Dependency
   name: thor_plus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: refinements
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -301,13 +315,16 @@ files:
 - lib/tocer.rb
 - lib/tocer/builder.rb
 - lib/tocer/cli.rb
-- lib/tocer/commenter.rb
+- lib/tocer/configuration.rb
+- lib/tocer/elements/comment_block.rb
 - lib/tocer/identity.rb
+- lib/tocer/parsers/header.rb
 - lib/tocer/tasks/rspec.rake
 - lib/tocer/tasks/rubocop.rake
-- lib/tocer/transformer.rb
+- lib/tocer/transformers/link.rb
+- lib/tocer/transformers/text.rb
 - lib/tocer/writer.rb
-homepage: https://www.alchemists.io
+homepage: https://github.com/bkuhlmann/tocer
 licenses:
 - MIT
 metadata: {}

data/lib/tocer/commenter.rb

@@ -1,38 +0,0 @@
-module Tocer
-  # Represents table of contents start and finish comments.
-  class Commenter
-    def initialize start_id: "Tocer[start]", finish_id: "Tocer[finish]", message: "Auto-generated, don't remove."
-      @start_id = start_id
-      @finish_id = finish_id
-      @message = message
-    end
-
-    def start
-      comment start_id, message
-    end
-
-    def start_index collection
-      index collection, start
-    end
-
-    def finish
-      comment finish_id, message
-    end
-
-    def finish_index collection
-      index collection, finish
-    end
-
-    private
-
-    attr_reader :start_id, :finish_id, :message
-
-    def comment id, message
-      "<!-- #{id}: #{message} -->"
-    end
-
-    def index collection, text
-      collection.index { |line| line =~ /#{Regexp.escape text}/ }
-    end
-  end
-end

data/lib/tocer/transformer.rb

@@ -1,38 +0,0 @@
-module Tocer
-  # Transforms Markdown headers into anchored links.
-  class Transformer
-    def initialize text
-      @text = text
-    end
-
-    def pounds
-      String text[/\#{1,}/]
-    end
-
-    def label
-      return "" if text.empty?
-      text[pounds.length + 1, text.length].strip
-    end
-
-    def bullet
-      return "" if pounds.empty?
-      pounds_to_spaces(pounds).gsub(/\s{2}$/, "- ")
-    end
-
-    def url
-      label.downcase.gsub(/\s/, "-").gsub(/[^\w\-\+\&]+/, "")
-    end
-
-    def transform
-      "#{bullet}[#{label}](##{url})"
-    end
-
-    private
-
-    attr_reader :text
-
-    def pounds_to_spaces pounds
-      Array.new(pounds.length, "  ").join
-    end
-  end
-end