tocer 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bdb2805ce0350fce832d1be825451d10055c67bd
-  data.tar.gz: bdfdf2cd1ee2a94b4d49618d58e6571a23e392d7
+  metadata.gz: 5b7d0d42ffc60ae31c41a13f98571d2aa60b692b
+  data.tar.gz: 2b3ee230d78cb78aaf77664bb2c3e1f0dae61fb5
 SHA512:
-  metadata.gz: 76f95274217283cd4d8269cbfbff4123f6a303bdf0a49e95dc1bcf66315318f6ebafa43206d8ced740e1316af9252348120e27dc69710d4629db1ffcccce0208
-  data.tar.gz: 3136586c43d3bced44276603c337aa52a803ec5b4c28f46fca94b5c7749c4b16067e660b68d3020a69e705ecb4f3f8c9ae7bae890a7344f685d621fb257d235b
+  metadata.gz: f6cb3b159d8a724a0f6384ae1611d77cd1466b6655be90e1f9ad6f32fea7b4501604b29af09996f921dce886c3382583fe9d6629ccc5fe1b263301d83bd9bb74
+  data.tar.gz: 3b081110b49be864e15c4c4ba06c5596bba1c890e75634e448221aa77c61f91ab416861099f1fb7d5b7e7bd5906273a067d662ff7523845d369b33a23a9ec23e

checksums.yaml.gz.sig

@@ -1 +1 @@
-G�_.�L�s��w�O�E}��}��sޓ�oK� �a㨨�1����ͪq�ר&������cm��>���<W�1�eAO�D&�kknku(�*I#CT��?p����MU$������%�ʰix���\��9,ώ�8�O_�Sa��}l\p�j��>����enfM��v,�#���-�
+������}=IG�u�y]�wz����8$E�������x�]�� �,�k&�p�*u

data.tar.gz.sig

@@ -1,4 +1,2 @@
-b�^���7oi3�	r���r��J�0�R��]�O��S���	�H���'��4ŅK~VN,������=�����&{�D,b��R��
-����a-�v�B ܑ�_09J
-
-��J�*�>�~x�+�{E�@
+�[���i�
+�b�����7�EsU�S����0#4��S�]��F�%fd�i�g��M+X�׫c�[���B�.���_d�#�@��i�y���3�G�@�Ntb*�O

data/README.md

@@ -35,8 +35,11 @@ Markdown files.
 - 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 whitelist filtering. Default: ".md".
 - Prepends table of contents to Markdown documents that don't have table of contents.
-- Replaces/updates Markdown documents that have existing table of contents.
+- Rebuilds Markdown documents that have existing table of contents.
 
 # Requirements
 
@@ -62,22 +65,30 @@ For an insecure install, type the following (not recommended):
 
 ## Command Line Interface (CLI)
 
-From the command line, type: `tocer help`
+From the command line, type: `tocer --help`
 
     tocer -c, [--config]         # Manage gem configuration.
     tocer -g, [--generate=PATH]  # Generate table of contents.
     tocer -h, [--help=COMMAND]   # Show this message or get help for a command.
     tocer -v, [--version]        # Show gem version.
 
-To add Tocer support, add the following at the correct position within your Markdown files:
+For specific `--generate` options, run `tocer --help --generate` to see the following:
+
+    -l, [--label=LABEL]              # Label
+                                     # Default: # Table of Contents
+    -w, [--whitelist=one two three]  # File whitelist
+                                     # Default: [".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:
 
 ```
 <!-- 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 to your file, complete with an auto-generated table of contents.
+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.
 
 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
@@ -88,20 +99,40 @@ can re-run Tocer on that file to auto-update it with new table of contents.
 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"`
+0. Global: `~/.tocerrc`.
+0. Local: `<project_root>/.tocerrc`.
+0. CLI: `tocer --generate . --label "## Custom Label" --whitelist README.md`
 
-Any setting provided to the CLI during runtime would trump the global setting. The global setting is
+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.
 
 The `~/.tocerrc` uses the following default settings:
 
     :label: "# Table of Contents"
+    :whitelist: [".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".
+
+There are multiple ways the *whitelist* can be defined. Here are some examples:
+
+    # Use an empty array to include *all* files.
+    :whitelist: []
+
+    # Use an array of wildcards for groups of files with similar extensions:
+    :whitelist:
+      - .md
+      - .mkd
+      - .markdown
+
+    # Use a mix of wild cards and relative paths to customized as necessary:
+    :whitelist:
+      - README.md
+      - docs/*.md
+      - .markdown
 
 # Tests
 

data/lib/tocer.rb

@@ -7,4 +7,5 @@ require "tocer/transformers/link"
 require "tocer/transformers/text"
 require "tocer/builder"
 require "tocer/writer"
+require "tocer/runner"
 require "tocer/cli"

data/lib/tocer/builder.rb

@@ -3,15 +3,21 @@
 module Tocer
   # Builds a table of contents for a Markdown document.
   class Builder
+    CODE_BLOCK_PUNCTUATION = "```"
+
     def initialize lines, label: "# Table of Contents", comment_block: Elements::CommentBlock
       @lines = lines
       @label = label
       @comment_block = comment_block.new
       @url_count = Hash.new { |hash, key| hash[key] = 0 }
+      @code_block = false
     end
 
     def headers
-      lines.select { |line| line.start_with? Parsers::Header.punctuation }
+      lines.select do |line|
+        toggle_code_block line
+        line.start_with?(Parsers::Header::PUNCTUATION) && !code_block
+      end
     end
 
     def build
@@ -28,6 +34,12 @@ module Tocer
     private
 
     attr_reader :lines, :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 acquire_transfomer header
       if header =~ /\[.+\]\(.+\)/

data/lib/tocer/cli.rb

@@ -15,7 +15,8 @@ module Tocer
 
     def self.configuration
       Runcom::Configuration.new file_name: Identity.file_name, defaults: {
-        label: "# Table of Contents"
+        label: "# Table of Contents",
+        whitelist: %w[.md]
       }
     end
 
@@ -25,10 +26,26 @@ module Tocer
 
     desc "-g, [--generate=PATH]", "Generate table of contents."
     map %w[-g --generate] => :generate
-    method_option :label, aliases: "-l", desc: "Label", type: :string, default: configuration.to_h.fetch(:label)
+    method_option :label,
+                  aliases: "-l",
+                  desc: "Label",
+                  type: :string,
+                  default: configuration.to_h.fetch(:label)
+    method_option :whitelist,
+                  aliases: "-w",
+                  desc: "File whitelist",
+                  type: :array,
+                  default: configuration.to_h.fetch(:whitelist)
     def generate path
-      Writer.new(path, label: options.label).write
-      say "Generated table of contents: #{path}."
+      configuration = build_configuration path, options.label, options.whitelist
+      runner = build_runner path, configuration
+      files = runner.files
+
+      runner.run
+      return if files.empty?
+
+      say "Processed table of contents for:"
+      files.each { |file| say "  #{file}" }
     end
 
     desc "-c, [--config]", %(Manage gem configuration ("#{configuration.computed_path}").)
@@ -64,9 +81,21 @@ module Tocer
 
     private
 
-    def compute_label label
-      configured_label = self.class.configuration.to_h.fetch :label
-      label == configured_label ? label : configured_label
+    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/identity.rb

@@ -12,7 +12,7 @@ module Tocer
     end
 
     def self.version
-      "3.1.1"
+      "3.2.0"
     end
 
     def self.version_label

data/lib/tocer/parsers/header.rb

@@ -4,16 +4,14 @@ module Tocer
   module Parsers
     # Represents a Markdown header.
     class Header
-      def self.punctuation
-        "#"
-      end
+      PUNCTUATION = "#"
 
       def initialize markdown
         @markdown = markdown
       end
 
       def prefix
-        String markdown[/#{self.class.punctuation}{1,}/]
+        String markdown[/#{PUNCTUATION}{1,}/]
       end
 
       def content

data/lib/tocer/runner.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module Tocer
+  # Generates/updates Table of Contents for files in given path.
+  class Runner
+    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?)
+    end
+
+    def run
+      files.each { |file| writer.new(file, label: configuration.fetch(:label)).write }
+    end
+
+    private
+
+    attr_reader :path, :configuration, :writer
+
+    def whitelist
+      Array configuration.fetch(:whitelist)
+    end
+  end
+end

data/lib/tocer/writer.rb

@@ -46,7 +46,7 @@ module Tocer
     end
 
     def prepend_toc
-      content(file_lines) << file_lines.join
+      content(file_lines).dup << file_lines.join
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tocer
 version: !ruby/object:Gem::Version
-  version: 3.1.1
+  version: 3.2.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,7 +30,7 @@ cert_chain:
   n/LUZ1dKhIHzfKx1B4+TEIefArObGfkLIDM8+Dq1RX7TF1k81Men7iu4MgE9bYBn
   3dE+xI3FdB5gWcdWxdtgRCmWjtXeYYyb4z6NQQ==
   -----END CERTIFICATE-----
-date: 2016-11-13 00:00:00.000000000 Z
+date: 2016-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -108,14 +108,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -320,6 +320,7 @@ files:
 - lib/tocer/elements/comment_block.rb
 - lib/tocer/identity.rb
 - lib/tocer/parsers/header.rb
+- lib/tocer/runner.rb
 - lib/tocer/transformers/link.rb
 - lib/tocer/transformers/text.rb
 - lib/tocer/writer.rb

metadata.gz.sig

@@ -1,4 +1 @@
-�����WdL��Tq :�E��f�[ޫמּ�Jk��A��?�wa2x(��(��|���	��=�H����1=����$�Ɗ�f��t�Uk7�d��s���6�]�1
-�IRʰ��UF�G�i�$��[�;��d�R}Mn�íԽ��u�|���Օ6{Ht�N�(.l
-Yb
-�с�b���HZ��*�����p>�&�hxC�=m���%�
+N��𴢘>N�^5&!&(�p�4MW�\G�