sixarm_ruby_markdown_table_of_contents 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: da33b215d110a63b5f9153ad7d73a8ccf5199d9b09ade074b33dfc1a9bca5f48
+  data.tar.gz: '0923bbf3632d8f484468d267dd96b956219c16d17b0817f9f45359824ae0f337'
+SHA512:
+  metadata.gz: cd847cd1308214a890b7f5bb9ce05dd67e4091c58de95c0104931dc0a07a4918f66d3ec9497ef03bc9596c9e8bf78497914dedf58cf51c6a8fc2ded71aa7a87e
+  data.tar.gz: da896a88acfa9dbc7d8ebb61c92b797311b727d16723364995a5dd43ed73ad6e3fd19045a51867d83b11ef3bf7dbebe1155cafe199b509c76a5c3c5816b2f312

data/Rakefile

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+require "rake"
+require "rake/testtask"
+
+task :default => [:test]
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.pattern = "test/**/*.rb"
+end

data/bin/markdown-table-of-contents

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+require "sixarm_ruby_markdown_table_of_contents"
+begin
+  markdown_file_path = ARGV.shift
+  if nil == markdown_file_path then raise ArgumentError.new("This command needs an argument that is a markdown file path.") end
+  file = Markdown::File.new(markdown_file_path)
+  if nil == markdown_file_path then raise ArgumentError.new("This command needs a markdown file path that is a valid file.") end
+  file.rewrite_toc
+  exit 0
+rescue
+  STDERR.puts "Error! " + $!.message
+  exit 1
+end

data/lib/sixarm_ruby_markdown_table_of_contents.rb

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+Please see README
+=end
+
+require "ostruct"
+require "sixarm_ruby_file_rewrite"
+
+module Markdown; end
+
+require_relative "sixarm_ruby_markdown_table_of_contents/markdown/headline"
+require_relative "sixarm_ruby_markdown_table_of_contents/markdown/file"
+require_relative "sixarm_ruby_markdown_table_of_contents/markdown/string"

data/lib/sixarm_ruby_markdown_table_of_contents/markdown/file.rb

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+Markdown::File#refresh_toc
+=end
+
+class Markdown::File < ::File
+
+  def slurp
+    Markdown::String.new(read.scrub)
+  end
+
+  def rewrite_toc
+    rewrite(slurp.refresh_toc)
+  end
+
+end

data/lib/sixarm_ruby_markdown_table_of_contents/markdown/headline.rb

@@ -0,0 +1,24 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+Headline
+=end
+
+class Headline < OpenStruct
+
+  def to_markdown
+    indent + "* " + link + "\n"
+  end
+
+  def indent
+    level ? ("  " * (level - 2)) : ""
+  end
+
+  def link
+    "[#{text}](##{anchor})"
+  end
+
+  def anchor
+    text.downcase.gsub(/\W+/,'-')
+  end
+
+end

data/lib/sixarm_ruby_markdown_table_of_contents/markdown/string.rb

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+Markdown::String#refresh_toc
+=end
+
+module Markdown
+
+  class String < ::String
+
+    def generate_toc
+      return scan(/^(##+) +(.+)\n/).map{|level, text| 
+        Headline.new(level: level.length, text: text).to_markdown 
+      }.join
+    end
+
+    def match_toc
+      /(^ *\* \[.*?\]\(#.*?\) *\n)+/m
+    end
+
+    def refresh_toc
+      m = match(match_toc)
+      return m ? m.pre_match + generate_toc + m.post_match : nil
+    end
+
+  end
+
+end

data/test/sixarm_ruby_markdown_table_of_contents_test.rb

@@ -0,0 +1,14 @@
+# -*- coding: utf-8 -*-
+require "minitest/autorun"
+#require "minitest/benchmark" if ENV["BENCH"]
+require "coveralls"
+require "simplecov"
+Coveralls.wear!
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new([
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+])
+SimpleCov.start
+require "sixarm_ruby_markdown_table_of_contents"
+
+require_relative "support/let"

data/test/sixarm_ruby_markdown_table_of_contents_test/markdown/file_test.rb

@@ -0,0 +1,54 @@
+# -*- coding: utf-8 -*-
+require "sixarm_ruby_markdown_table_of_contents_test"
+
+describe Markdown::File do
+
+  include Let
+  let(:dir){ File.expand_path File.dirname(__FILE__) }
+  let(:file_path){ dir + "tempfile"}
+  let(:text){ "foo" }
+
+  describe "#slurp" do
+
+    before do
+      file = Markdown::File.new(file_path, "w")
+      file.write(text)
+      file.close      
+    end
+
+    it "read and scrub, and return a Markdown::String" do
+      file = Markdown::File.new(file_path)
+      s = file.slurp
+      expect(s).must_equal text
+      expect(s).must_be_kind_of Markdown::String
+    end
+
+    after do
+      File.delete(file_path)
+    end
+
+  end
+
+  describe "#rewrite_toc" do
+
+    before do
+      file =  Markdown::File.new(file_path, "w")
+      file.write markdown_input_as_markdown_string
+      file.close
+    end
+
+    it "rewrite" do
+      file = Markdown::File.new(file_path)
+      file.rewrite_toc
+      file = Markdown::File.new(file_path)
+      expect(file.slurp).must_equal(markdown_output_as_markdown_string)      
+      file.close
+    end
+
+    after do
+      File.delete(file_path)
+    end
+
+  end
+
+end

data/test/sixarm_ruby_markdown_table_of_contents_test/markdown/headline_test.rb

@@ -0,0 +1,60 @@
+# -*- coding: utf-8 -*-
+require "sixarm_ruby_markdown_table_of_contents_test"
+
+describe Headline do
+
+  include Let
+
+  let(:level){ 3 }
+  let(:text){ "Hello World" }
+  let(:headline){ Headline.new(level: level, text: text) }
+
+  describe "#text" do
+
+    it "return text" do
+      expect(headline.text).must_equal "Hello World"
+    end
+
+  end
+
+  describe "#level" do
+
+    it "return level" do
+      expect(headline.text).must_equal "Hello World"
+    end
+
+  end
+
+  describe "#indent" do
+
+    it "return indent, which is two spaces per level greater than H2" do
+      expect(headline.indent).must_equal "  "
+    end
+
+  end
+
+  describe "#anchor" do
+
+    it "return anchor, which is the text as lowercase, and replacing every run of non-word characters with a dash" do
+      expect(headline.anchor).must_equal "hello-world"
+    end
+
+  end
+
+  describe "#link" do
+
+    it "return link, which is the Markdown formatting of the text and anchor" do
+      expect(headline.link).must_equal "[Hello World](#hello-world)"
+    end
+
+  end
+
+  describe "#to_markdown" do
+
+    it "return the headline table of contents entry, which is a bullet link, and ending newline" do
+      expect(headline.to_markdown).must_equal "  * [Hello World](#hello-world)\n"
+    end
+
+  end
+
+end

data/test/sixarm_ruby_markdown_table_of_contents_test/markdown/string_test.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+require "sixarm_ruby_markdown_table_of_contents_test"
+
+describe Markdown::String do
+
+  include Let
+
+  let(:s) { markdown_input_as_markdown_string }
+
+  describe "#generate_toc" do
+
+    it "return the toc" do
+      expect(s.generate_toc).must_equal(markdown_output_toc_as_markdown_string)
+    end
+
+  end
+
+  describe "#match_toc" do
+
+    it "match on the first occurance of lines that look like a table of contents" do
+      expect(s.match_toc).must_equal /(^ *\* \[.*?\]\(#.*?\) *\n)+/m
+    end
+
+  end
+
+  describe "#refresh_toc" do
+
+    it "refresh" do
+      expect(s.refresh_toc).must_equal(markdown_output_as_markdown_string)
+    end
+
+  end
+
+end

data/test/support/let.rb

@@ -0,0 +1,150 @@
+# -*- coding: utf-8 -*-
+require 'minitest/spec'
+
+module Let
+
+  extend Minitest::Spec::DSL
+
+  let(:markdown_input_as_string){ 
+    <<~XXX
+    # Example
+
+    * [](#)
+
+    ## Alpha
+
+    Lorem ipsum
+
+    ### Bravo
+
+    Lorem ipsum
+
+    #### Charlie
+
+    Lorem ipsum
+
+    ## Delta
+
+    Lorem ipsum
+
+    ### Echo
+
+    Lorem ipsum
+
+    #### Foxtrot
+
+    Lorem ipsum
+
+    XXX
+  }
+
+  let(:markdown_input_pre_match_as_string){ 
+    <<~XXX
+    # Example
+    
+    XXX
+  }
+
+  let(:markdown_input_toc_as_string){ 
+    <<~XXX
+    * [](#)
+    XXX
+  }
+
+  let(:markdown_input_post_match_as_string){ 
+    <<~XXX
+
+    ## Alpha
+
+    Lorem ipsum
+
+    ### Bravo
+
+    Lorem ipsum
+
+    #### Charlie
+
+    Lorem ipsum
+
+    ## Delta
+
+    Lorem ipsum
+
+    ### Echo
+
+    Lorem ipsum
+
+    #### Foxtrot
+
+    Lorem ipsum
+
+    XXX
+  }
+
+
+  let(:markdown_output_as_string){
+    <<~XXX
+    # Example
+
+    * [Alpha](#alpha)
+      * [Bravo](#bravo)
+        * [Charlie](#charlie)
+    * [Delta](#delta)
+      * [Echo](#echo)
+        * [Foxtrot](#foxtrot)
+
+    ## Alpha
+
+    Lorem ipsum
+
+    ### Bravo
+
+    Lorem ipsum
+
+    #### Charlie
+
+    Lorem ipsum
+
+    ## Delta
+
+    Lorem ipsum
+
+    ### Echo
+
+    Lorem ipsum
+
+    #### Foxtrot
+
+    Lorem ipsum
+
+    XXX
+  }
+
+  let(:markdown_output_toc_as_string){
+    <<~XXX
+    * [Alpha](#alpha)
+      * [Bravo](#bravo)
+        * [Charlie](#charlie)
+    * [Delta](#delta)
+      * [Echo](#echo)
+        * [Foxtrot](#foxtrot)
+    XXX
+  }
+
+  let(:markdown_input_as_markdown_string){
+    Markdown::String.new(markdown_input_as_string)
+  }
+
+  let(:markdown_input_toc_as_markdown_string){
+    Markdown::String.new(markdown_input_toc_as_string)
+  }
+
+  let(:markdown_output_as_markdown_string){
+    Markdown::String.new(markdown_output_as_string)
+  }
+
+  let(:markdown_output_toc_as_markdown_string){
+    Markdown::String.new(markdown_output_toc_as_string)
+  }
+
+end

metadata

@@ -0,0 +1,221 @@
+--- !ruby/object:Gem::Specification
+name: sixarm_ruby_markdown_table_of_contents
+version: !ruby/object:Gem::Version
+  version: 2.1.0
+platform: ruby
+authors:
+- SixArm
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIFPDCCAyQCCQDx7Y5LWGuPPzANBgkqhkiG9w0BAQsFADBgMQswCQYDVQQGEwJV
+  UzETMBEGA1UECAwKQ2FsaWZvcm5pYTEWMBQGA1UEBwwNU2FuIEZyYW5jaXNjbzEP
+  MA0GA1UECgwGU2l4QXJtMRMwEQYDVQQDDApzaXhhcm0uY29tMB4XDTE4MDExMzIy
+  NDYyM1oXDTIwMTAwOTIyNDYyM1owYDELMAkGA1UEBhMCVVMxEzARBgNVBAgMCkNh
+  bGlmb3JuaWExFjAUBgNVBAcMDVNhbiBGcmFuY2lzY28xDzANBgNVBAoMBlNpeEFy
+  bTETMBEGA1UEAwwKc2l4YXJtLmNvbTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCC
+  AgoCggIBAMMPPjYWd77gRmOEkMb+1H9+ckIHlA325OkES2g5Y58hIDzZYTGIxjSP
+  3N7uYx5qR8qZvuO4F1McGJ/NES2robjQcV/aIRXD+5RjbokyYYGJlJujm5c/wZme
+  Us7pOzQxc8QcogsdInwQ6O9hTQ4zBdOFZt6YBp5y9ycXVIApBnxJHBU3W6Ir1hl6
+  3v6RYBgHFd3g0dCwuBoaYZE5MU/4q91vc48XhioqXdJlaDyw1ZMyvE+loi+8quVg
+  bpUadC/QUZukABYCu6rS6fiRLffmMy/Db7d8b1fP+J1i4bL5atF4xz8c1BDwc2x1
+  mXJDUBznMSDpmjAkUwDjh+330tYT/VTioqobCMSLfwgJI2Uqrr8H8N9yeSsOMAup
+  nJKnJHXeZPEGAr2LBCcok2KUcdugdYq/0C+ec1bU8BHDDoEOM54rhPKKmCJentO6
+  KJRoJfu0ovQj1/BvSksUUWdvhy6jzXviyQq44GKEwsJix6sdNKEpndVDQGOvHPg5
+  gcakte7KrpK2Udwy+dK+caHJWXOouHPPFfdZWr5U9DkNjtvvQrwQUsMxECoByKYA
+  7wmX3SwzodtuzAPGzxuwkqwy1RtHAfbrFINFBxP35G/f16x2mtwEpqsdS4LE+c0C
+  l3eEQ8xIv3ijKUZek87Uxk7/JH76C3/9tSQeFkt0NkEduHOR1H7RAgMBAAEwDQYJ
+  KoZIhvcNAQELBQADggIBALIBNN7zUhFldUaXWGwv6032ZwM2Sm1U8VF8YaH71NLg
+  FhlcuJ0JLkGlxT0/68acS0EwoqOEgaHyPx8eodjyDv2MuJlWJGXIgHgLD66Tu0VA
+  Wt1sgA823Rl35WVSMqiyoxwsrGFwMtayNrrlpdhB8Ny8CMA2NfKyEJkh4+xlE72a
+  D8Eu8NFr9Tt5lHWXdZBI5BhzhQxPPxeIuw0wZ3+kiwxRie7K4XhKsOIrPmu2i6QV
+  Yl/663wZgWpqrroSnc3PE3lsuTW7quUvayjtqMTU2qrh7i21oB+/Nn+I6gcxYJZb
+  UlK+tvsqoM94U6sFTjw9mDt62MLQGrJtHShS+ZZiGmWj1sKreuwGJnCVDoBk15xa
+  oqlvfvLAMBCqlfrHhvGUfbIMgzb9uXNmCjzYMsQxuIgF6IMis6Kq02NBAR91HPMe
+  2RoY7CdBHMxW+O0tgS2xoQbOwb+ti1j4MbsWpCqS9Mteck0Z7jZpRRrUDjXU+/7Z
+  RmW9HX0oLIoCBDChCcEKG0Ma4IvHUgjv47f5iYpkXuhifiK4xMG/s+T5Euw3Wg9J
+  tzpk/VnZXj7Ek/earx+N/Z+Wtnl2xENm5IF8SFPeI1HFa9NH47pqtxF1YKpNIEVc
+  2xa2BNHSePe7tys/2hbmZuyMu8X5ERmovsabSXB3a+YwtJh5c2jhA21wF7986s0q
+  -----END CERTIFICATE-----
+date: 2018-02-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sixarm_ruby_file_rewrite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: sixarm_ruby_minitest_extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Generate a Markdown table of contents via headlines, links, and anchors
+email: sixarm@sixarm.com
+executables:
+- markdown-table-of-contents
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- bin/markdown-table-of-contents
+- lib/sixarm_ruby_markdown_table_of_contents.rb
+- lib/sixarm_ruby_markdown_table_of_contents/markdown/file.rb
+- lib/sixarm_ruby_markdown_table_of_contents/markdown/headline.rb
+- lib/sixarm_ruby_markdown_table_of_contents/markdown/string.rb
+- test/sixarm_ruby_markdown_table_of_contents_test.rb
+- test/sixarm_ruby_markdown_table_of_contents_test/markdown/file_test.rb
+- test/sixarm_ruby_markdown_table_of_contents_test/markdown/headline_test.rb
+- test/sixarm_ruby_markdown_table_of_contents_test/markdown/string_test.rb
+- test/support/let.rb
+homepage: http://sixarm.com/
+licenses:
+- Apache-2.0
+- Artistic-2.0
+- BSD-3-Clause
+- CC-BY-NC-SA-4.0
+- AGPL-3.0
+- GPL-2.0
+- GPL-3.0
+- LGPL-3.0
+- MIT
+- MPL-2.0
+- Ruby
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: SixArm.com → Ruby → Mardown table of contents
+test_files:
+- test/sixarm_ruby_markdown_table_of_contents_test.rb
+- test/sixarm_ruby_markdown_table_of_contents_test/markdown/file_test.rb
+- test/sixarm_ruby_markdown_table_of_contents_test/markdown/headline_test.rb
+- test/sixarm_ruby_markdown_table_of_contents_test/markdown/string_test.rb
+- test/support/let.rb