tocer 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 364451d192c18a68dca94f98111f91bc9497c9a2
-  data.tar.gz: 8121740b8a7a03151014009133eb1e5187bd8e21
+  metadata.gz: c3a5d9b3cbfbd48fe9e33a63d6bb64f835b41d29
+  data.tar.gz: 4bf1614edeb7da8332a07551446b0d3b9203f889
 SHA512:
-  metadata.gz: 690afd875c906b115a1a2f8e99dba18e4cddd7f22fce0cd6293e2fe30bdcbd344cb13e06ab357c5e6ad87e3415f8ce309a5a713c1fd03aa0d75e29c2f41a0dde
-  data.tar.gz: 75e09cac2a5c43f65c73ed4e03aa7c920ab2b9e08696237a2d389ca0768c773f19bdba103839217dee2f432408d7876b1c2e54366d77a79c9bd7099926cb6730
+  metadata.gz: 10030e97ee6a0f6935483700653a3ac795b7905dfb3a8da3a61d0222a694248260ca6c02ca38923bf1a50d57eab92ba213bf6565de075b82973bea719eab51e0
+  data.tar.gz: 00f5d32a47dc85d51323bf50f1af64761728071d212e653acd73e6da2a852e8da28ae78831e9f7a96e2110fbd41ae80d3953161d6fd31021020177f280462201

data/README.md

@@ -37,7 +37,7 @@ Markdown files.
     - 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 whitelist filtering. Default: ".md".
+- 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.
 
@@ -77,7 +77,7 @@ For specific `--generate` options, run `tocer --help --generate` to see the foll
     -l, [--label=LABEL]              # Label
                                      # Default: # Table of Contents
     -w, [--whitelist=one two three]  # File whitelist
-                                     # Default: [".md"]
+                                     # Default: ["README.md"]
 
 To generate the table of contents at a specific position within your Markdown files, add the
 following lines to your file(s) prior to generation:
@@ -88,7 +88,8 @@ following lines to your file(s) prior to generation:
 ```
 
 Alternatively, you can run `tocer -g <directory>` on files that do not have Tocer support and it
-will prepend the above to your file(s), complete with an auto-generated table of contents.
+will prepend the table of contents to your file(s), complete with an auto-generated table of
+contents.
 
 In the case that Tocer has already auto-generated a table of contents for a Markdown file, the
 existing table of contents has become stale, or placement of the table of contents has changed you
@@ -101,38 +102,41 @@ determined in the following order (with the last one taking top priority):
 
 0. Global: `~/.tocerrc`.
 0. Local: `<project_root>/.tocerrc`.
-0. CLI: `tocer --generate . --label "## Custom Label" --whitelist README.md`
+0. CLI: `tocer --generate . --label "## Custom Label" --whitelist CHANGES.md`
 
-Any settings provided to the CLI during runtime will 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.
+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.
 
-The `~/.tocerrc` uses the following default settings:
+The `~/.tocerrc` file uses the following default settings:
 
     :label: "# Table of Contents"
-    :whitelist: [".md"]
+    :whitelist: ["README.md"]
 
 Each `~/.tocerrc` setting 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".
+- `whitelist`: The list of *included* files. Default: "*.md".
 
 There are multiple ways the *whitelist* can be defined. Here are some examples:
 
-    # Use an empty array to include *all* files.
+    # Use an empty array to ignore all files (a key with with no value would work too).
     :whitelist: []
 
     # Use an array of wildcards for groups of files with similar extensions:
     :whitelist:
-      - .md
-      - .mkd
-      - .markdown
+      - *.md
+      - *.mkd
+      - *.markdown
 
-    # Use a mix of wild cards and relative paths to customized as necessary:
+    # Use a mix of wild cards and relative names/paths to customized as necessary:
     :whitelist:
       - README.md
       - docs/*.md
-      - .markdown
+      - *.markdown
+
+    # Use a recursive glob to traverse and update all sub-directories:
+    :whitelist:
+      - **/*.md
 
 # Tests
 
@@ -144,9 +148,9 @@ To test, run:
 
 Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
 
-- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
-- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
 - 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
 

data/lib/tocer/builder.rb

@@ -2,9 +2,18 @@
 
 module Tocer
   # Builds a table of contents for a Markdown document.
+  # :reek:TooManyInstanceVariables
   class Builder
     CODE_BLOCK_PUNCTUATION = "```"
 
+    def self.transformer header
+      if header.match?(/\[.+\]\(.+\)/)
+        Transformers::Link.new header
+      else
+        Transformers::Text.new header
+      end
+    end
+
     def initialize lines, label: "# Table of Contents", comment_block: Elements::CommentBlock
       @lines = lines
       @label = label
@@ -41,22 +50,16 @@ module Tocer
       self.code_block = !code_block
     end
 
-    def acquire_transfomer header
-      if header.match?(/\[.+\]\(.+\)/)
-        Transformers::Link.new header
-      else
-        Transformers::Text.new header
-      end
-    end
-
     def url_suffix url
-      url_count[url].zero? ? "" : url_count[url]
+      count = url_count[url]
+      count.zero? ? "" : count
     end
 
     def transform header
-      transformer = acquire_transfomer header
-      link = transformer.transform url_suffix: url_suffix(transformer.url)
-      url_count[transformer.url] += 1
+      transformer = self.class.transformer header
+      url = transformer.url
+      link = transformer.transform url_suffix: url_suffix(url)
+      url_count[url] += 1
       link
     end
 

data/lib/tocer/cli.rb

@@ -16,7 +16,7 @@ module Tocer
     def self.configuration
       Runcom::Configuration.new file_name: Identity.file_name, defaults: {
         label: "# Table of Contents",
-        whitelist: %w[.md]
+        whitelist: ["README.md"]
       }
     end
 
@@ -36,13 +36,15 @@ module Tocer
                   desc: "File whitelist",
                   type: :array,
                   default: configuration.to_h.fetch(:whitelist)
-    def generate path
-      configuration = build_configuration path, options.label, options.whitelist
-      runner = build_runner path, configuration
+    # :reek:TooManyStatements
+    def generate path = "."
+      configuration = self.class.configuration.merge label: options.label,
+                                                     whitelist: options.whitelist
+      runner = Runner.new path, configuration: configuration
       files = runner.files
 
-      runner.run
       return if files.empty?
+      runner.run
 
       say "Processed table of contents for:"
       files.each { |file| say "  #{file}" }
@@ -78,24 +80,5 @@ module Tocer
     def help task = nil
       say and super
     end
-
-    private
-
-    def build_configuration path, label, whitelist
-      if Pathname(path).file?
-        warn "[DEPRECATION]: File paths are deprecated, use directory paths instead."
-        self.class.configuration.merge label: label, whitelist: [path]
-      else
-        self.class.configuration.merge label: label, whitelist: whitelist
-      end
-    end
-
-    def build_runner path, configuration
-      if Pathname(path).file?
-        Runner.new ".", configuration: configuration
-      else
-        Runner.new path, configuration: configuration
-      end
-    end
   end
 end

data/lib/tocer/elements/comment_block.rb

@@ -4,6 +4,10 @@ module Tocer
   module Elements
     # Represents a table of contents start and finish comment block.
     class CommentBlock
+      def self.index lines, id
+        (lines.index { |line| line =~ /\<\!\-\-.*#{Regexp.escape id}.*\-\-\>/ }).to_i
+      end
+
       def initialize start_id: "Tocer[start]",
                      finish_id: "Tocer[finish]",
                      message: "Auto-generated, don't remove."
@@ -17,16 +21,16 @@ module Tocer
         comment start_id, message
       end
 
-      def start_index collection
-        index collection, start_id
+      def start_index lines
+        self.class.index lines, start_id
       end
 
       def finish
         comment finish_id, message
       end
 
-      def finish_index collection
-        index collection, finish_id
+      def finish_index lines
+        self.class.index lines, finish_id
       end
 
       private
@@ -36,10 +40,6 @@ module Tocer
       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

@@ -12,7 +12,7 @@ module Tocer
     end
 
     def self.version
-      "4.0.0"
+      "5.0.0"
     end
 
     def self.version_label

data/lib/tocer/runner.rb

@@ -5,16 +5,15 @@ require "pathname"
 module Tocer
   # Generates/updates Table of Contents for files in given path.
   class Runner
-    def initialize path = "", configuration: {}, writer: Writer
+    def initialize path = ".", configuration: {}, writer: Writer
       @path = Pathname path
       @configuration = configuration
       @writer = writer
     end
 
     def files
-      return [] unless path.exist?
-      glob = whitelist.empty? ? %(#{path}/**/*) : %(#{path}/**/*{#{whitelist.join ","}})
-      Pathname.glob(glob).select(&:file?)
+      return [] unless path.exist? && path.directory? && !whitelist.empty?
+      Pathname.glob(%(#{path}/{#{whitelist.join ","}})).select(&:file?)
     end
 
     def run
@@ -26,7 +25,7 @@ module Tocer
     attr_reader :path, :configuration, :writer
 
     def whitelist
-      Array configuration.fetch(:whitelist)
+      Array configuration[:whitelist]
     end
   end
 end

data/lib/tocer/writer.rb

@@ -2,6 +2,7 @@
 
 module Tocer
   # Writes table of contents to a Markdown document.
+  # :reek:TooManyInstanceVariables
   class Writer
     # rubocop:disable Metrics/ParameterLists
     def initialize file_path,
@@ -10,14 +11,14 @@ module Tocer
                    comment_block: Elements::CommentBlock
 
       @file_path = file_path
-      @file_lines = File.open(file_path).to_a
+      @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 ? replace_toc : prepend_toc
+      body = start_index.zero? ? prepend_toc : replace_toc
       File.open(file_path, "w") { |file| file.write body }
     end
 

metadata

@@ -1,36 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tocer
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
 autorequire: 
 bindir: bin
-cert_chain:
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMQ8wDQYDVQQDDAZicm9v
-  a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
-  aW8wHhcNMTYxMDE5MTY0NDEzWhcNMTcxMDE5MTY0NDEzWjBBMQ8wDQYDVQQDDAZi
-  cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
-  GRYCaW8wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCgryPL4/IbWDcL
-  fnqpnoJALqj+ega7hSsvvD8sac57HPNLeKcOmSafFiQLAnTmmE132ZlFc8kyZRVn
-  zmqSESowO5jd+ggFuy1ySqQJXhwgik04KedKRUjpIDZePrjw+M5UJT1qzKCKL2xI
-  nx5cOKP1fSWJ1RRu8JhaDeSloGtYMdw2c28wnKPNIsWDood4xhbLcY9IqeISft2e
-  oTAHTHandHbvt24X3/n67ceNjLBbsVZPXCC1C8C8ccjHjA4Tm2uiFoDwThMcPggg
-  90H6fh0vLFcNAobdPEchbge8tWtfmMPz2+C4yklANn81GA+ANsBS1uwx6mxJoMQU
-  BNVp0aLvAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBRS85Rn1BaqeIONByw4t46DMDMzHDAfBgNVHREEGDAWgRRicm9va2VAYWxjaGVt
-  aXN0cy5pbzAfBgNVHRIEGDAWgRRicm9va2VAYWxjaGVtaXN0cy5pbzANBgkqhkiG
-  9w0BAQUFAAOCAQEAZMb57Y4wdpbX8XxTukEO7VC1pndccUsxdbziGsAOiuHET3Aq
-  ygLvrfdYrN88/w+qxncW5bxbO3a6UGkuhIFUPM8zRSE/rh6bCcJljTJrExVt42eV
-  aYCb7WJNsx3eNXHn3uQodq3tD+lmNJzz2bFeT3smGSKEnALBjqorO/2mpDh4FJ3S
-  4CcDYsJ1ywep8LDJDBBGdKz9moL+axryzpeTpgTT/fFYFzRzWrURPyDvPOikh9TX
-  n/LUZ1dKhIHzfKx1B4+TEIefArObGfkLIDM8+Dq1RX7TF1k81Men7iu4MgE9bYBn
-  3dE+xI3FdB5gWcdWxdtgRCmWjtXeYYyb4z6NQQ==
-  -----END CERTIFICATE-----
-date: 2017-01-22 00:00:00.000000000 Z
+cert_chain: []
+date: 2017-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -52,42 +30,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: refinements
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: runcom
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +80,20 @@ 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
@@ -206,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -234,42 +226,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '4.6'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.48'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.47'
+        version: '0.48'
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
@@ -327,7 +319,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.9
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A command line interface for generating table of contents for Markdown files.

checksums.yaml.gz.sig

@@ -1 +0,0 @@
-��|��JD��0�3���v�o��.OtH�ԊX�v_�����A�ˋb

data.tar.gz.sig

@@ -1,2 +0,0 @@
-N�^}�7~�
-�4�