tocbot 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bcafde7a6c86b83780bfcc5631889dbd0b9309114aa9425661213f2875ab8b5
-  data.tar.gz: d715becc5115b56732253279ef2f6bd5c33b42e05e5873294f05c4f4518cd9d2
+  metadata.gz: 1933941f9999a3850a2216845b4cb8dfe01736d42682657fe2806d6153808a9e
+  data.tar.gz: 396434e53f923a8846aa7530780b8c5bd44df69e7c610c99313158c4fd032313
 SHA512:
-  metadata.gz: 79234107e404d2a920d7abd26dd089f46295d88fbec7853876effc8382a0f313599005f6cfe1bfb60dff5ff5cf2ff12f47218e81435ae9f3b1a602e4e3a58658
-  data.tar.gz: 678bcde4a2160fe77c1ddc86fb0af999f31c9d9daff0c48a1db00f3073ffc44a347d792d937f589af8e69405e4f02373db5c740aaee8627b4447ebeb02f12343
+  metadata.gz: b6c11c7682c8101edcfbc448df64827239ab2d6d3bf71d467c03baba66e5615c22678470b5655e2e9b593852dbfc9e80e998291058aa985d86bf790a59169003
+  data.tar.gz: d11ea043bd667213705c1539fbd3e9193fe9dd6fd0b2c0823b66d844b9f9c3d90b62cab34bdb5652e246a35c0b7493295cfc5288acafe79d304b53a03130ec74

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+
+This changelog was automatically generated using [Sonny](https://github.com/WolfSoftware/sonny) by [Wolf Software](https://github.com/WolfSoftware)
+
+### [v0.2.0](https://github.com/WolfSoftware/tocbot/compare/v0.1.0...master)
+
+> Released on February, 4th 2020
+
+- Fix rubocop errors generated by travis [`[e5be94d]`](https://github.com/WolfSoftware/tocbot/commit/e5be94df144e1ebf5f53cb0337fd71880d6ddd98) [`[TGWolf]`](https://github.com/TGWolf)
+
+- Added user specified separators, user specified starting level and user specified depth (To-Do list) [`[ad458e3]`](https://github.com/WolfSoftware/tocbot/commit/ad458e3a780eb86e1fb52368388b228e985584ca) [`[TGWolf]`](https://github.com/TGWolf)
+
+### [v0.1.0](https://github.com/WolfSoftware/tocbot/releases/v0.1.0)
+
+> Released on February, 3rd 2020
+
+- initial: Initial commit [`[7407fa4]`](https://github.com/WolfSoftware/tocbot/commit/7407fa482ee6cc04a6075dc1ee9417390c1e295e) [`[TGWolf]`](https://github.com/TGWolf)
+

data/README.md

@@ -12,24 +12,27 @@
 <a name="tocbot"></a>
 # TOCBot
 
-<!--TOC-->
+<!--TOCBot-->
 * [TOCBot](#tocbot)
      * [Introduction](#introduction)
      * [Installation](#installation)
-     * [Basic Usage](#basic-usage)
-          * [Command Line Usage](#command-line-usage)
+     * [Command Line Usage](#command-line-usage)
+          * [Basic Usage](#basic-usage)
+          * [Advanced Usage](#advanced-usage)
      * [Contributing to TOCBot](#contributing-to-tocbot)
           * [Setup](#setup)
           * [Testing](#testing)
      * [To-Do List](#to-do-list)
-<!--TOC-->
+<!--TOCBot-->
 
 <a name="introduction"></a>
 ## Introduction
 
-TOCBot is a Table of Content (TOC) creation robot. It works by reading a markdown file and identifying all of the headers (currently up to 5 levels deep) and creating a table of contents based on those headers.
+TOCBot is a Table of Content (TOC) creation robot. It works by reading a markdown file and identifying all of the headers and creating a table of contents based on those headers.
 
-It will insert the table of contents between the separators that are placed in the file. The current separator is <!--TOC-->.
+Default it includes all levels (# = level 1, ## = level 2, etc), and will include headers up to 5 levels deep.
+
+It will insert the table of contents between the separators that are placed in the file. The default separator is <!--TOCBot-->.
 
 > There must be TWO separators, one to open the table of contents and one to close it.
 
@@ -44,8 +47,19 @@ Installing TOCBot is very simple, just execute the following command.
 gem install tocbot
 ```
 
+<a name="command-line-usage"></a>
+## Command Line Usage
+
+| Option | Purpose | Default Value |
+| ------ | ------- |:-------------:|
+| -h or --help | Show the help message | N/A |
+| -d or --depth | How many levels deep to add to the TOC. | 5 |
+| -f or --filename | The name of the file to process. | README.md |
+| -l or --level | The level of heading to start with. | 1 |
+| -s or --separator | The separator used to show where to insert the TOC. | &lt;!--TOCBot--&gt; |
+
 <a name="basic-usage"></a>
-## Basic Usage
+### Basic Usage
 
 You can execute TOCBot by simple running
 
@@ -53,13 +67,15 @@ You can execute TOCBot by simple running
 tocbot
 ```
 
-<a name="command-line-usage"></a>
-### Command Line Usage
+<a name="advanced-usage"></a>
+### Advanced Usage
 
-| Option | Purpose | Default Value |
-| ------ | ------- |:-------------:|
-| -h or --help | Show the help message | N/A |
-| -f or --filename | The name of the file to process. | README.md |
+Start with level 2 headers (exclude all level 1 headers), and only include 3 levels of headers.
+
+```
+tocbot -s 2 -d 3
+```
+> The depth is measures from the start so the above example will include header levels 2, 3 &amp; 4.
 
 <a name="contributing-to-tocbot"></a>
 ## Contributing to TOCBot
@@ -82,6 +98,7 @@ For further information please refer to the [contributing](https://github.com/Wo
 <a name="to-do-list"></a>
 ## To-Do List
 
-- [ ] Allow users to specify the separator
-- [ ] Allow users to specify how deep into the headers to go
-- [ ] Allow users to specify levels to skip
+- [X] Allow users to specify the separator
+- [X] Allow users to specify how deep into the headers to go
+- [X] Allow users to specify levels to skip
+

data/TOCBot.gemspec

@@ -22,4 +22,7 @@ Gem::Specification.new do |spec|
     spec.add_development_dependency 'bundler', '>= 1.17', '< 3.0'
     spec.add_development_dependency 'rake', '~> 10.0'
     spec.add_development_dependency 'rspec', '~> 3.0'
+    spec.add_development_dependency 'tty-spinner', '~> 0.9.0'
+
+    spec.add_runtime_dependency 'tty-spinner', '~> 0.9.0'
 end

data/exe/tocbot

@@ -36,9 +36,22 @@ def process_arguments
             puts opts
             exit(1)
         end
+
+        opts.on('-d', '--depth number', 'How many levels deep to add to the TOC. [default: 5]') do |depth|
+            options[:depth] = depth.to_i
+        end
+
         opts.on('-f', '--filename string', 'The name of the file to process. [default: README.md]') do |filename|
             options[:filename] = filename
         end
+
+        opts.on('-l', '--level number', 'The level of heading to start with. [default: 1]') do |level|
+            options[:level] = level.to_i
+        end
+
+        opts.on('-s', '--separator string', 'The separator used to show where to insert the TOC. [default: <!--TOCBot-->]') do |separator|
+            options[:separator] = separator
+        end
     end
 
     begin

data/lib/TOCBot.rb

@@ -1,13 +1,19 @@
 require 'TOCBot/version'
 
+require 'tty-spinner'
+
 #
 # To follow
 #
 class TOCBot
     def initialize(options = {})
-        @separator = '<!--TOC-->'
+        @separator = '<!--TOCBot-->'
+        @level = 1
+        @depth = 5
 
         @separator = options[:separator] unless options[:separator].nil?
+        @level = options[:level].to_i unless options[:level].nil?
+        @depth = options[:depth].to_i unless options[:depth].nil?
     end
 
     def load_file(filename)
@@ -78,14 +84,21 @@ class TOCBot
             next if line.start_with?('<a name="')
 
             if line.scan(/^\#{1,}.*/m).size.positive?
+
                 m = line.match(/^(\#{1,})(.*)/)
                 hashes = m[1].length
                 text = m[2].strip
 
-                link = text.gsub(/ /, '-').downcase
+                if hashes >= @level
+                    hashes = hashes - @level + 1
 
-                toc << '     ' * (hashes - 1) + "* [#{text}](##{link})"
-                processed << "<a name=\"#{link}\"></a>"
+                    if hashes <= @depth
+                        link = text.gsub(/ /, '-').downcase
+
+                        toc << '     ' * (hashes - 1) + "* [#{text}](##{link})"
+                        processed << "<a name=\"#{link}\"></a>"
+                    end
+                end
             end
 
             #
@@ -97,10 +110,23 @@ class TOCBot
     end
 
     def process_file(filename)
+        spinners = TTY::Spinner::Multi.new("[:spinner] TOCBot is generating your Table of Contents (TOC) (Start Level: #{@level}, Depth: #{@depth})")
+
+        sp1 = spinners.register '[:spinner] Loading File'
+        sp2 = spinners.register '[:spinner] Processing File'
+        sp3 = spinners.register '[:spinner] Writing File'
+
+        sp1.auto_spin
+        sp2.auto_spin
+        sp3.auto_spin
+
         lines = load_file(filename)
+        sp1.success
 
         processed, toc = process_lines(lines)
+        sp2.success
 
         write_file(filename, processed, toc)
+        sp3.success
     end
 end

data/lib/TOCBot/version.rb

@@ -1,3 +1,3 @@
 class TOCBot
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.2.0'.freeze
 end

data/testing/tocbot

@@ -39,9 +39,22 @@ def process_arguments
             puts opts
             exit(1)
         end
+
+        opts.on('-d', '--depth number', 'How many levels deep to add to the TOC. [default: 5]') do |depth|
+            options[:depth] = depth.to_i
+        end
+
         opts.on('-f', '--filename string', 'The name of the file to process. [default: README.md]') do |filename|
             options[:filename] = filename
         end
+
+        opts.on('-l', '--level number', 'The level of heading to start with. [default: 1]') do |level|
+            options[:level] = level.to_i
+        end
+
+        opts.on('-s', '--separator string', 'The separator used to show where to insert the TOC. [default: <!--TOCBot-->]') do |separator|
+            options[:separator] = separator
+        end
     end
 
     begin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tocbot
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tim Gurney aka Wolf
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-03 00:00:00.000000000 Z
+date: 2020-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,6 +58,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 description: A gem for automatically generating a table of contents in a markdown
   file.
 email:
@@ -72,6 +100,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODEOWNERS
 - CONTRIBUTING.md
 - Gemfile