tocer 5.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3a5d9b3cbfbd48fe9e33a63d6bb64f835b41d29
-  data.tar.gz: 4bf1614edeb7da8332a07551446b0d3b9203f889
+  metadata.gz: cc14839d2577710ed5cf36a50119597ed809581f
+  data.tar.gz: 6e0e455468f5ba1f2c9d71f1db42702ab44a7343
 SHA512:
-  metadata.gz: 10030e97ee6a0f6935483700653a3ac795b7905dfb3a8da3a61d0222a694248260ca6c02ca38923bf1a50d57eab92ba213bf6565de075b82973bea719eab51e0
-  data.tar.gz: 00f5d32a47dc85d51323bf50f1af64761728071d212e653acd73e6da2a852e8da28ae78831e9f7a96e2110fbd41ae80d3953161d6fd31021020177f280462201
+  metadata.gz: 0ee34bfa069b8aef9c0a6ce4fea96cb4f98890476e8d44dec4fb6e644eb186dccf6581a32a794789b792568a7720ffaa4f4209a43bc2fda2c52162832935fc01
+  data.tar.gz: 8c6c61f73ad832cc5f904dc1dbbd66ab2203ca1dcf0aef492e522445bb7a67b598bcc5a2265c37eb3282459bf18ae6c9186a5b13718125f8d771d96344285513

data/README.md

@@ -4,7 +4,7 @@
 [![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/tocer.svg)](https://codeclimate.com/github/bkuhlmann/tocer)
 [![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/tocer/coverage.svg)](https://codeclimate.com/github/bkuhlmann/tocer)
 [![Gemnasium Status](https://gemnasium.com/bkuhlmann/tocer.svg)](https://gemnasium.com/bkuhlmann/tocer)
-[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/tocer.svg)](https://travis-ci.org/bkuhlmann/tocer)
+[![Circle CI Status](https://circleci.com/gh/bkuhlmann/tocer.svg?style=svg)](https://circleci.com/gh/bkuhlmann/tocer)
 [![Patreon](https://img.shields.io/badge/patreon-donate-brightgreen.svg)](https://www.patreon.com/bkuhlmann)
 
 Tocer (a.k.a. Table of Contenter) is a command line interface for generating table of contents for
@@ -12,41 +12,41 @@ Markdown files.
 
 <!-- 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)
-- [Contributions](#contributions)
-- [License](#license)
-- [History](#history)
-- [Credits](#credits)
+## 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)
+  - [Contributions](#contributions)
+  - [License](#license)
+  - [History](#history)
+  - [Credits](#credits)
 
 <!-- Tocer[finish]: Auto-generated, don't remove. -->
 
-# Features
+## Features
 
 - Supports Markdown ATX-style headers. Example: `# Header`.
     - Does not support header suffixes. Example: `# Header #`.
     - Does not support header prefixes without spaces. Example: `#Header`.
 - Supports table of contents generation for single or multiple files.
-- Supports custom label. Default: "# Table of Contents".
+- Supports custom label. Default: "## Table of Contents".
 - Supports whitelist filtering. Default: "README.md".
 - Prepends table of contents to Markdown documents that don't have table of contents.
 - Rebuilds Markdown documents that have existing table of contents.
 
-# Requirements
+## Requirements
 
 0. A UNIX-based system.
 0. [Ruby 2.4.x](https://www.ruby-lang.org).
 
-# Setup
+## Setup
 
 For a secure install, type the following (recommended):
 
@@ -61,9 +61,9 @@ For an insecure install, type the following (not recommended):
 
     gem install tocer
 
-# Usage
+## Usage
 
-## Command Line Interface (CLI)
+### Command Line Interface (CLI)
 
 From the command line, type: `tocer --help`
 
@@ -95,24 +95,24 @@ In the case that Tocer has already auto-generated a table of contents for a Mark
 existing table of 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
+### 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):
+This gem can be configured via a global configuration:
 
-0. Global: `~/.tocerrc`.
-0. Local: `<project_root>/.tocerrc`.
-0. CLI: `tocer --generate . --label "## Custom Label" --whitelist CHANGES.md`
+    ~/.config/tocer/configuration.yml
 
-Settings provided to the CLI during runtime will trump the global setting. The global settings are
-weakest of all but great for situations where custom settings should be applied to *all* projects.
+It can also be configured via [XDG environment variables](https://github.com/bkuhlmann/runcom#xdg)
+as provided by the [Runcom](https://github.com/bkuhlmann/runcom) gem.
 
-The `~/.tocerrc` file uses the following default settings:
+The default configuration is as follows:
 
-    :label: "# Table of Contents"
+    :label: "## Table of Contents"
     :whitelist: ["README.md"]
 
-Each `~/.tocerrc` setting can be configured as follows:
+Feel free to take this default configuration, modify, and save as your own custom
+`configuration.yml`.
+
+The `configuration.yml` file can be configured as follows:
 
 - `label`: The header label for the table of contents. Default: "# Table of Contents".
 - `whitelist`: The list of *included* files. Default: "*.md".
@@ -138,13 +138,13 @@ There are multiple ways the *whitelist* can be defined. Here are some examples:
     :whitelist:
       - **/*.md
 
-# Tests
+## Tests
 
 To test, run:
 
     bundle exec rake
 
-# Versioning
+## Versioning
 
 Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 
@@ -152,26 +152,26 @@ Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 - 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
+## Code of Conduct
 
 Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
 participating in this project you agree to abide by its terms.
 
-# Contributions
+## Contributions
 
 Read [CONTRIBUTING](CONTRIBUTING.md) for details.
 
-# License
+## License
 
 Copyright (c) 2015 [Alchemists](https://www.alchemists.io).
 Read [LICENSE](LICENSE.md) for details.
 
-# History
+## History
 
 Read [CHANGES](CHANGES.md) for details.
 Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
 
-# Credits
+## Credits
 
 Developed by [Brooke Kuhlmann](https://www.alchemists.io) at
 [Alchemists](https://www.alchemists.io).

data/lib/tocer/builder.rb

@@ -1,11 +1,16 @@
 # frozen_string_literal: true
 
+require "forwardable"
+
 module Tocer
   # Builds a table of contents for a Markdown document.
-  # :reek:TooManyInstanceVariables
   class Builder
+    extend Forwardable
+
     CODE_BLOCK_PUNCTUATION = "```"
 
+    def_delegators :comment_block, :start_index, :finish_index, :prependable?
+
     def self.transformer header
       if header.match?(/\[.+\]\(.+\)/)
         Transformers::Link.new header
@@ -14,35 +19,27 @@ module Tocer
       end
     end
 
-    def initialize lines, label: "# Table of Contents", comment_block: Elements::CommentBlock
-      @lines = lines
+    def initialize label: "## Table of Contents", comment_block: Elements::CommentBlock.new
       @label = label
-      @comment_block = comment_block.new
+      @comment_block = comment_block
       @url_count = Hash.new { |hash, key| hash[key] = 0 }
       @code_block = false
     end
 
-    def headers
-      lines.select do |line|
-        toggle_code_block line
-        line.start_with?(Parsers::Header::PUNCTUATION) && !code_block
-      end
-    end
-
-    def build
-      return "" if headers.empty?
+    def build lines
+      return "" if headers(lines).empty?
 
       [
-        "#{comment_block.start}\n\n",
+        "#{comment_block.start_tag}\n\n",
         "#{label}\n\n",
-        headers_as_links.join("\n"),
-        "\n\n#{comment_block.finish}\n\n"
+        links(lines).join("\n"),
+        "\n\n#{comment_block.finish_tag}\n"
       ].join
     end
 
     private
 
-    attr_reader :lines, :label, :comment_block, :url_count
+    attr_reader :label, :comment_block, :url_count
     attr_accessor :code_block
 
     def toggle_code_block line
@@ -63,8 +60,15 @@ module Tocer
       link
     end
 
-    def headers_as_links
-      headers.map { |header| transform header }
+    def headers lines
+      lines.select do |line|
+        toggle_code_block line
+        line.start_with?(Parsers::Header::PUNCTUATION) && !code_block
+      end
+    end
+
+    def links lines
+      headers(lines).map { |header| transform header }
     end
   end
 end

data/lib/tocer/cli.rb

@@ -14,8 +14,8 @@ module Tocer
     package_name Identity.version_label
 
     def self.configuration
-      Runcom::Configuration.new file_name: Identity.file_name, defaults: {
-        label: "# Table of Contents",
+      Runcom::Configuration.new project_name: Identity.name, defaults: {
+        label: "## Table of Contents",
         whitelist: ["README.md"]
       }
     end
@@ -50,7 +50,7 @@ module Tocer
       files.each { |file| say "  #{file}" }
     end
 
-    desc "-c, [--config]", %(Manage gem configuration ("#{configuration.computed_path}").)
+    desc "-c, [--config]", "Manage gem configuration."
     map %w[-c --config] => :config
     method_option :edit,
                   aliases: "-e",
@@ -61,10 +61,11 @@ module Tocer
                   desc: "Print gem configuration.",
                   type: :boolean, default: false
     def config
-      path = self.class.configuration.computed_path
+      path = self.class.configuration.path
 
       if options.edit? then `#{editor} #{path}`
-      elsif options.info? then say(path)
+      elsif options.info?
+        path ? say(path) : say("Configuration doesn't exist.")
       else help(:config)
       end
     end

data/lib/tocer/elements/comment_block.rb

@@ -17,22 +17,26 @@ module Tocer
         @message = message
       end
 
-      def start
-        comment start_id, message
-      end
-
       def start_index lines
         self.class.index lines, start_id
       end
 
-      def finish
-        comment finish_id, message
+      def start_tag
+        comment start_id, message
       end
 
       def finish_index lines
         self.class.index lines, finish_id
       end
 
+      def finish_tag
+        comment finish_id, message
+      end
+
+      def prependable? lines
+        start_index(lines).zero? && finish_index(lines).zero?
+      end
+
       private
 
       attr_reader :start_id, :finish_id, :message

data/lib/tocer/identity.rb

@@ -12,15 +12,11 @@ module Tocer
     end
 
     def self.version
-      "5.0.0"
+      "6.0.0"
     end
 
     def self.version_label
       "#{label} #{version}"
     end
-
-    def self.file_name
-      ".#{name}rc"
-    end
   end
 end

data/lib/tocer/writer.rb

@@ -2,63 +2,50 @@
 
 module Tocer
   # Writes table of contents to a Markdown document.
-  # :reek:TooManyInstanceVariables
   class Writer
-    # rubocop:disable Metrics/ParameterLists
-    def initialize file_path,
-                   label: "# Table of Contents",
-                   builder: Builder,
-                   comment_block: Elements::CommentBlock
+    def self.add start_index:, old_lines:, new_lines:
+      computed_new_lines = start_index.zero? ? new_lines : new_lines + "\n"
+      old_lines.insert start_index, *computed_new_lines
+    end
+
+    def self.remove start_index, finish_index, lines
+      range = (start_index - 1)..finish_index
+      lines.reject.with_index { |_, index| range.include? index }
+    end
 
+    def initialize file_path, label: "## Table of Contents", builder: Builder.new(label: label)
       @file_path = file_path
-      @file_lines = File.open(file_path, &:to_a)
-      @label = label
       @builder = builder
-      setup_indexes comment_block.new, @file_lines
     end
 
     def write
-      body = start_index.zero? ? prepend_toc : replace_toc
+      lines = File.readlines file_path
+      body = builder.prependable?(lines) ? unshift(lines) : replace(lines)
       File.open(file_path, "w") { |file| file.write body }
     end
 
     private
 
-    attr_reader :file_path,
-                :file_lines,
-                :label,
-                :start_index,
-                :finish_index,
-                :builder,
-                :comment_block
-
-    def setup_indexes comment_block, lines
-      @start_index = comment_block.start_index lines
-      @finish_index = comment_block.finish_index lines
-    end
+    attr_reader :file_path, :builder
 
     def content lines
-      builder.new(lines, label: label).build
-    end
-
-    def remove_toc lines
-      toc_range = ((start_index - 1)..finish_index)
-      lines.reject.with_index { |_, index| toc_range.include? index }
-    end
-
-    def add_toc old_lines, new_lines
-      old_lines.insert start_index, new_lines
+      builder.build lines
     end
 
-    def replace_toc
-      old_lines = remove_toc file_lines
-      new_lines = content file_lines[finish_index, file_lines.length]
+    def replace lines
+      start_index = builder.start_index lines
+      finish_index = builder.finish_index lines
+      klass = self.class
 
-      add_toc(old_lines, new_lines).join
+      klass.add(
+        start_index: start_index,
+        old_lines: klass.remove(start_index, finish_index, lines),
+        new_lines: content(lines[finish_index, lines.length])
+      ).join
     end
 
-    def prepend_toc
-      content(file_lines).dup << file_lines.join
+    def unshift lines
+      content(lines) + "\n" + lines.join
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tocer
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-07 00:00:00.000000000 Z
+date: 2017-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.0'
-- !ruby/object:Gem::Dependency
-  name: gemsmith
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.4'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -240,28 +226,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.6'
+        version: '4.7'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.48'
+        version: '0.49'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.48'
+        version: '0.49'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement