sixarm_ruby_markdown_table_of_contents 2.1.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da33b215d110a63b5f9153ad7d73a8ccf5199d9b09ade074b33dfc1a9bca5f48
-  data.tar.gz: '0923bbf3632d8f484468d267dd96b956219c16d17b0817f9f45359824ae0f337'
+  metadata.gz: a54c2cd830e7b301beaa467b0a930205dadfe364d7c64d9022a09e4000fbe857
+  data.tar.gz: fcc89b66c629c83e85f5102c7aa098b4fda4b354cfec55202181da0003c50b8a
 SHA512:
-  metadata.gz: cd847cd1308214a890b7f5bb9ce05dd67e4091c58de95c0104931dc0a07a4918f66d3ec9497ef03bc9596c9e8bf78497914dedf58cf51c6a8fc2ded71aa7a87e
-  data.tar.gz: da896a88acfa9dbc7d8ebb61c92b797311b727d16723364995a5dd43ed73ad6e3fd19045a51867d83b11ef3bf7dbebe1155cafe199b509c76a5c3c5816b2f312
+  metadata.gz: 653b33b8a22c8cff112f32df430dc9a77a612b3afde05e0abcf6a46d199e76ff598852bd8f4167f235c0fb82fdde28fd84bb479574690217796212e4fc979d8f
+  data.tar.gz: 97f3563d4639c0d81fbdfa1c21b19a14f886b971b6512e4b76ce35dec96363310cae1e35416dfd5c0aa69199c8518e65158946be037a9e4f60bd91f5d186748c

data/bin/markdown-table-of-contents

@@ -1,11 +1,15 @@
 #!/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
+  settings = SixArm::Markdown::TOC::Settings.new
+  settings.option_parsing
+  generator = SixArm::Markdown::TOC::Generator.new(settings: settings)
+  ARGV.each{|markdown_file_path| 
+    file = SixArm::Markdown::File.new(markdown_file_path)
+    input = file.slurp
+    output = generator.rewrite_toc(input)
+    file.rewrite(output)
+  }
   exit 0
 rescue
   STDERR.puts "Error! " + $!.message

data/lib/sixarm_ruby_markdown_table_of_contents.rb

@@ -5,9 +5,7 @@ Please see README
 
 require "ostruct"
 require "sixarm_ruby_file_rewrite"
+require "sixarm_ruby_markdown"
 
-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"
+require_relative "sixarm_ruby_markdown_table_of_contents/sixarm/markdown/toc/generator"
+require_relative "sixarm_ruby_markdown_table_of_contents/sixarm/markdown/toc/settings"

data/lib/sixarm_ruby_markdown_table_of_contents/sixarm/markdown/toc/generator.rb

@@ -0,0 +1,41 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+=end
+
+module SixArm; module Markdown; module TOC; end; end; end
+
+class SixArm::Markdown::TOC::Generator
+
+  attr_accessor :settings
+
+  def initialize(
+    settings: SixArm::Markdown::TOC::Settings.new
+    )
+    @settings = settings
+  end
+
+  def headline_to_markdown(headline)
+    settings.line_prefix + ("  " * (headline.level - 2)) + settings.bullet + " " + headline.link + "\n"
+  end
+
+  def scan_headlines(markdown_string)
+    headlines = []
+    markdown_string.scan(settings.headline_regexp).each{|markers, text| 
+      level = markers.length
+      if  level >= settings.headline_minimum_level && level <= settings.headline_maximum_level 
+        headlines << SixArm::Markdown::Headline.new(level: level, text: text)
+      end
+    }
+    return headlines
+  end
+
+  def create_toc(markdown_string)
+    return scan_headlines(markdown_string).map{|headline| headline_to_markdown(headline)}.join
+  end
+
+  def rewrite_toc(markdown_string)
+    m = markdown_string.match(settings.contents_regexp)
+    return m ? m.pre_match + create_toc(markdown_string) + m.post_match : nil
+  end
+
+end

data/lib/sixarm_ruby_markdown_table_of_contents/sixarm/markdown/toc/settings.rb

@@ -0,0 +1,104 @@
+# -*- coding: utf-8 -*-
+=begin rdoc
+=end
+
+require "optparse"
+
+module SixArm; module Markdown; module TOC; end; end; end
+
+class SixArm::Markdown::TOC:: Settings
+
+  DefaultBullet = "*"
+  DefaultLinePrefix = ""
+  DefaultHeadlineMinimumLevel = 2
+  DefaultHeadlineMaximumLevel = 6
+  DefaultHeadlineRegexp = /^(#+) +(.+)\n/
+  DefaultContentsRegexp = /(^ *\* \[.*?\]\(#.*?\) *\n)+/m
+
+  attr_accessor \
+    :bullet,
+    :line_prefix,
+    :headline_minimum_level,
+    :headline_maximum_level,
+    :headline_regexp,
+    :contents_regexp
+
+  def initialize(
+    bullet: DefaultBullet, 
+    line_prefix: DefaultLinePrefix,
+    headline_minimum_level: DefaultHeadlineMinimumLevel, 
+    headline_maximum_level: DefaultHeadlineMaximumLevel, 
+    headline_regexp: DefaultHeadlineRegexp, 
+    contents_regexp: DefaultContentsRegexp
+    )
+    self.headline_regexp = headline_regexp
+    self.contents_regexp = contents_regexp
+    self.bullet = bullet
+    self.headline_minimum_level = headline_minimum_level 
+    self.headline_maximum_level = headline_maximum_level 
+    self.line_prefix = line_prefix
+  end
+
+  def option_parsing
+
+    ::OptionParser.new do |o|  
+        
+      o.banner = "Usage: markdown-table-of-contents [options]"
+      o.separator ""
+      o.separator "Options:"
+
+      o.on("-bBULLET", "--bullet BULLET", String, 
+        "Set the bullet text",
+        "(default is \"#{DefaultBullet}\" and other typical choices are \"+\" and \"-\")"
+      ) do |x|
+        self.bullet = x
+      end
+
+      o.on("-lLINE_PREFIX", "--line-prefix LINE_PREFIX", String, 
+        "Set the line prefiix text",
+        "(default is \"#{DefaultLinePrefix}\" and other typical choices are \"  \" and \"\t\")"
+      ) do |x|
+        self.line_prefix = x
+      end
+
+      o.on("--min NUMBER", Integer, 
+        "Set the headline minimum level",
+        "(default is \"#{DefaultHeadlineMinimumLevel}\" which means use H#{DefaultHeadlineMinimumLevel} and higher)"
+      ) do |x|
+        #self.headline_minimum_level = x
+      end
+
+      o.on("--max NUMBER", Integer,
+        "Set the headline maxmium level",
+        "(default is \"#{DefaultHeadlineMaximumLevel}\" which means use up to H#{DefaultHeadlineMaximumLevel})"
+      ) do |x|
+        self.headline_maximum_level = x
+      end
+
+      o.on("--headline-regexp REGEXP", Regexp,
+        "Set the headline regular expression",
+        "(default is #{DefaultHeadlineRegexp})"
+      ) do |x|
+        self.headline_regexp = x
+      end
+      
+      o.on("--contents-regexp REGEXP", Regexp,
+        "Set the contents regular expression",
+        "(default is #{DefaultContentsRegexp})"
+      ) do |x|
+        self.contents_regexp = x
+      end
+
+      o.on_tail("-h", "--help", "Show this message") do
+        #puts "Help is TODO"  #TODO
+      end
+
+      o.on_tail("--version", "Show version") do
+        #puts "Version is TODO"  #TODO
+      end
+
+    end.parse!
+
+  end
+
+end

data/test/sixarm_ruby_markdown_table_of_contents_test/sixarm/markdown/toc/generator_test.rb

@@ -0,0 +1,138 @@
+# -*- coding: utf-8 -*-
+require "sixarm_ruby_markdown_table_of_contents_test"
+
+describe SixArm::Markdown::TOC::Generator do
+
+  include Let
+
+  let(:default_settings){ 
+    SixArm::Markdown::TOC::Settings.new 
+  }
+
+  let(:custom_settings){ 
+    SixArm::Markdown::TOC::Settings.new(
+      bullet: custom_bullet,
+      line_prefix: custom_line_prefix, 
+      headline_minimum_level: custom_headline_minimum_level, 
+      headline_maximum_level: custom_headline_maximum_level,
+    )
+  }
+
+  let(:generator_with_default_settings) { SixArm::Markdown::TOC::Generator.new(settings: default_settings) }
+  let(:generator_with_custom_settings) { SixArm::Markdown::TOC::Generator.new(settings: custom_settings) }
+
+  let(:s) { markdown_input_as_markdown_string }
+  let(:headline){ SixArm::Markdown::Headline.new(level: 3, text: "Hello World") }
+
+  describe "#headline_to_markdown" do
+
+    describe "with default settings" do
+
+      it "return the headline, with a default line prefix ``, with a two-space indent because the headline is level 3, with a default bullet `*`" do  
+        g = generator_with_default_settings
+        actual = g.headline_to_markdown(headline)
+        expect = "  * [Hello World](#hello-world)\n"
+        expect(actual).must_equal(expect)
+        end
+
+    end
+
+    describe "with custom settings" do
+
+      it "return the headline, with a custom line prefix `!`, with a two-space indent because the headline is level 3, with a custom bullet `+`" do
+        g = generator_with_custom_settings
+        actual = g.headline_to_markdown(headline)
+        expect = "!  + [Hello World](#hello-world)\n"
+        expect(actual).must_equal(expect)
+      end
+
+    end
+
+  end
+
+  describe "#scan_headlines" do
+
+    describe "with default settings" do
+
+      it "return all headlines" do
+        g = generator_with_default_settings
+        actual = g.scan_headlines(s)
+        expect = markdown_default_output_as_headlines
+        expect(actual).must_equal(expect)
+      end
+
+    end
+
+    describe "with custom settings" do
+
+      it "return the headlines that have a level greater than than or equal to the settings headline minimum level" do
+        g = generator_with_custom_settings
+        actual = g.scan_headlines(s)
+        expect = markdown_custom_output_as_headlines
+        expect(actual).must_equal(expect)
+      end
+
+      it "return the headlines that have a level less than or equal to the settings headline maximum level" do
+        g = generator_with_custom_settings
+        actual = g.scan_headlines(s)
+        expect = markdown_custom_output_as_headlines
+        expect(actual).must_equal(expect)
+      end
+
+    end
+
+  end
+
+  describe "#create_toc" do
+
+    describe "with default settings" do
+
+      it "return the toc" do
+        g = generator_with_default_settings
+        actual = g.create_toc(s)
+        expect = markdown_default_output_toc_as_markdown_string
+        expect(actual).must_equal(expect)
+      end
+
+    end
+
+    describe "with custom settings" do
+
+      it "return the toc" do
+        g = generator_with_custom_settings
+        actual = g.create_toc(s)
+        expect = markdown_custom_output_toc_as_markdown_string
+        expect(actual).must_equal(expect)
+      end
+
+    end
+
+  end
+
+  describe "#rewrite_toc" do
+
+    describe "with default settings" do
+
+      it "rewrite" do
+        g = generator_with_default_settings
+        actual = g.rewrite_toc(s)
+        expect = markdown_default_output_as_markdown_string
+        expect(actual).must_equal(expect)
+      end
+
+    end
+
+    describe "with custom settings" do
+
+      it "rewrite" do
+        g = generator_with_custom_settings
+        expect = markdown_custom_output_as_markdown_string
+        expect(g.rewrite_toc(s)).must_equal(expect)
+      end
+
+    end
+
+  end
+
+
+end

data/test/sixarm_ruby_markdown_table_of_contents_test/sixarm/markdown/toc/settings_test.rb

@@ -0,0 +1,187 @@
+# -*- coding: utf-8 -*-
+require "sixarm_ruby_markdown_table_of_contents_test"
+
+describe SixArm::Markdown::TOC::Settings do
+
+  include Let
+
+  let(:settings){ SixArm::Markdown::TOC::Settings.new }
+
+  def argv(*strings)
+    ARGV.clear.append(*strings)
+  end
+
+  describe "#initialize" do
+
+    describe "with defaults" do
+
+      it "return default headline regexp" do
+        x = SixArm::Markdown::TOC::Settings::DefaultHeadlineRegexp
+        expect(SixArm::Markdown::TOC::Settings.new.headline_regexp).must_equal x
+      end
+
+      it "return default contents regexp" do
+        x = SixArm::Markdown::TOC::Settings::DefaultContentsRegexp
+        expect(SixArm::Markdown::TOC::Settings.new.contents_regexp).must_equal x
+      end
+
+      it "return default bullet" do
+        x = SixArm::Markdown::TOC::Settings::DefaultBullet
+        expect(SixArm::Markdown::TOC::Settings.new.bullet).must_equal x
+      end
+
+      it "return default headline minimum level" do
+        x = SixArm::Markdown::TOC::Settings::DefaultHeadlineMinimumLevel
+        expect(SixArm::Markdown::TOC::Settings.new.headline_minimum_level).must_equal x
+      end
+
+      it "return default headline maximum level" do
+        x = SixArm::Markdown::TOC::Settings::DefaultHeadlineMaximumLevel
+        expect(SixArm::Markdown::TOC::Settings.new.headline_maximum_level).must_equal x
+      end
+
+      it "return default line_prefix" do
+        x = SixArm::Markdown::TOC::Settings::DefaultLinePrefix
+        expect(SixArm::Markdown::TOC::Settings.new.line_prefix).must_equal x
+      end
+
+    end
+
+    describe "with options" do
+
+      it "return custom headline regexp" do
+        x = /x/
+        expect(SixArm::Markdown::TOC::Settings.new(headline_regexp: x).headline_regexp).must_equal x
+      end
+
+      it "return custom contents regexp" do
+        x = /x/
+        expect(SixArm::Markdown::TOC::Settings.new(contents_regexp: x).contents_regexp).must_equal x
+      end
+
+      it "return custom bullet" do
+        x = custom_bullet
+        expect(SixArm::Markdown::TOC::Settings.new(bullet: x).bullet).must_equal x
+      end
+
+      it "return custom line_prefix" do
+        x = custom_line_prefix
+        expect(SixArm::Markdown::TOC::Settings.new(line_prefix: x).line_prefix).must_equal x
+      end
+
+      it "return custom headline minimum level" do
+        x = custom_headline_minimum_level
+        expect(SixArm::Markdown::TOC::Settings.new(headline_minimum_level: x).headline_minimum_level).must_equal x
+      end
+
+      it "return custom headline maximum level" do
+        x = custom_headline_maximum_level
+        expect(SixArm::Markdown::TOC::Settings.new(headline_maximum_level: x).headline_maximum_level).must_equal x
+      end
+
+    end
+
+  end
+
+  describe "#option_parsing" do 
+
+    describe "bullet" do
+
+      before do
+        @x = custom_bullet 
+      end
+
+      it "parse short" do
+        argv("-b", @x)
+        settings.option_parsing
+        expect(settings.bullet).must_equal @x
+      end
+
+      it "parse long" do
+        argv("--bullet", @x)
+        settings.option_parsing
+        expect(settings.bullet).must_equal @x
+      end
+
+    end
+
+    describe "line prefix" do
+
+      before do
+        @x = custom_line_prefix
+      end
+
+      it "parse short" do
+        argv("-l", @x)
+        settings.option_parsing
+        expect(settings.line_prefix).must_equal @x
+      end
+
+      it "parse long" do
+        argv("--line-prefix", @x)
+        settings.option_parsing
+        expect(settings.line_prefix).must_equal @x
+      end
+
+    end
+
+    describe "headline minimum level" do
+
+      before do
+        @x = custom_headline_minimum_level
+      end
+
+      it "parse" do
+        argv("--min", @x.to_s)
+        settings.option_parsing
+        #expect(settings.headline_minimum_level).must_equal @x
+      end
+      
+    end
+
+    describe "headline maxmimum level" do
+
+      before do
+        @x = custom_headline_maximum_level
+      end
+
+      it "parse" do
+        argv("--max", @x.to_s)
+        settings.option_parsing
+        expect(settings.headline_maximum_level).must_equal @x
+      end
+      
+    end
+
+    describe "help" do
+
+      it "parse short" do
+        argv("-h")
+        settings.option_parsing  #TODO remove when the line below works
+        #proc { settings.option_parsing }.must_output "hello"
+      end
+
+      it "parse long" do
+        argv("--help")
+        proc { settings.option_parsing }#.must_output "hello"  #TODO
+      end
+      
+    end
+
+    describe "version" do
+
+      it "parse short" do
+        argv("-v")
+        proc { settings.option_parsing }#.must_output /^\d+\.\d+\.\d+/  #TODO
+      end
+
+      it "parse long" do
+        argv("--version")
+        proc { settings.option_parsing }#.must_output /^\d+\.\d+\.\d+/  #TODO
+      end
+      
+    end
+    
+  end
+
+end

data/test/support/let.rb

@@ -12,29 +12,9 @@ module Let
     * [](#)
 
     ## Alpha
-
-    Lorem ipsum
-
     ### Bravo
-
-    Lorem ipsum
-
     #### Charlie
-
-    Lorem ipsum
-
-    ## Delta
-
-    Lorem ipsum
-
-    ### Echo
-
-    Lorem ipsum
-
-    #### Foxtrot
-
-    Lorem ipsum
-
+    ##### Delta
     XXX
   }
 
@@ -45,7 +25,7 @@ module Let
     XXX
   }
 
-  let(:markdown_input_toc_as_string){ 
+  let(:markdown_input_toc_match_as_string){ 
     <<~XXX
     * [](#)
     XXX
@@ -55,96 +35,97 @@ module Let
     <<~XXX
 
     ## Alpha
-
-    Lorem ipsum
-
     ### Bravo
-
-    Lorem ipsum
-
     #### Charlie
-
-    Lorem ipsum
-
-    ## Delta
-
-    Lorem ipsum
-
-    ### Echo
-
-    Lorem ipsum
-
-    #### Foxtrot
-
-    Lorem ipsum
-
+    ##### Delta
     XXX
   }
 
 
-  let(:markdown_output_as_string){
+  let(:markdown_default_output_as_string){
     <<~XXX
     # Example
 
     * [Alpha](#alpha)
       * [Bravo](#bravo)
         * [Charlie](#charlie)
-    * [Delta](#delta)
-      * [Echo](#echo)
-        * [Foxtrot](#foxtrot)
+          * [Delta](#delta)
 
     ## Alpha
-
-    Lorem ipsum
-
     ### Bravo
-
-    Lorem ipsum
-
     #### Charlie
+    ##### Delta
+    XXX
+  }
 
-    Lorem ipsum
-
-    ## Delta
-
-    Lorem ipsum
-
-    ### Echo
-
-    Lorem ipsum
-
-    #### Foxtrot
+  let(:markdown_custom_output_as_string){
+    <<~XXX
+    # Example
 
-    Lorem ipsum
+    !  + [Bravo](#bravo)
+    !    + [Charlie](#charlie)
 
+    ## Alpha
+    ### Bravo
+    #### Charlie
+    ##### Delta
     XXX
   }
 
-  let(:markdown_output_toc_as_string){
+  let(:markdown_default_output_toc_as_string){
     <<~XXX
     * [Alpha](#alpha)
       * [Bravo](#bravo)
         * [Charlie](#charlie)
-    * [Delta](#delta)
-      * [Echo](#echo)
-        * [Foxtrot](#foxtrot)
+          * [Delta](#delta)
+    XXX
+  }
+
+  let(:markdown_custom_output_toc_as_string){
+    <<~XXX
+    !  + [Bravo](#bravo)
+    !    + [Charlie](#charlie)
     XXX
   }
 
   let(:markdown_input_as_markdown_string){
-    Markdown::String.new(markdown_input_as_string)
+    SixArm::Markdown::String.new(markdown_input_as_string)
   }
 
-  let(:markdown_input_toc_as_markdown_string){
-    Markdown::String.new(markdown_input_toc_as_string)
+  let(:markdown_input_toc_match_as_markdown_string){
+    SixArm::Markdown::String.new(markdown_input_toc_match_as_string)
   }
 
-  let(:markdown_output_as_markdown_string){
-    Markdown::String.new(markdown_output_as_string)
+  let(:markdown_default_output_as_headlines){[
+    SixArm::Markdown::Headline.new(level: 2, text: "Alpha"),
+    SixArm::Markdown::Headline.new(level: 3, text: "Bravo"),
+    SixArm::Markdown::Headline.new(level: 4, text: "Charlie"),
+    SixArm::Markdown::Headline.new(level: 5, text: "Delta"),
+  ]}
+
+  let(:markdown_custom_output_as_headlines){[
+    SixArm::Markdown::Headline.new(level: 3, text: "Bravo"),
+    SixArm::Markdown::Headline.new(level: 4, text: "Charlie"),
+  ]}
+
+  let(:markdown_default_output_as_markdown_string){
+    SixArm::Markdown::String.new(markdown_default_output_as_string)
+  }
+
+  let(:markdown_default_output_toc_as_markdown_string){
+    SixArm::Markdown::String.new(markdown_default_output_toc_as_string)
   }
 
-  let(:markdown_output_toc_as_markdown_string){
-    Markdown::String.new(markdown_output_toc_as_string)
+  let(:markdown_custom_output_as_markdown_string){
+    SixArm::Markdown::String.new(markdown_custom_output_as_string)
+  }
+  let(:markdown_custom_output_toc_as_markdown_string){
+    SixArm::Markdown::String.new(markdown_custom_output_toc_as_string)
   }
 
+  let(:custom_bullet){ "+" }
+  let(:custom_line_prefix){ "!" }
+  let(:custom_headline_minimum_level){ 3 }
+  let(:custom_headline_maximum_level){ 4 }
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sixarm_ruby_markdown_table_of_contents
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.4.0
 platform: ruby
 authors:
 - SixArm
@@ -39,8 +39,28 @@ cert_chain:
   tzpk/VnZXj7Ek/earx+N/Z+Wtnl2xENm5IF8SFPeI1HFa9NH47pqtxF1YKpNIEVc
   2xa2BNHSePe7tys/2hbmZuyMu8X5ERmovsabSXB3a+YwtJh5c2jhA21wF7986s0q
   -----END CERTIFICATE-----
-date: 2018-02-06 00:00:00.000000000 Z
+date: 2018-02-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sixarm_ruby_markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: sixarm_ruby_file_rewrite
   requirement: !ruby/object:Gem::Requirement
@@ -171,13 +191,11 @@ 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
+- lib/sixarm_ruby_markdown_table_of_contents/sixarm/markdown/toc/generator.rb
+- lib/sixarm_ruby_markdown_table_of_contents/sixarm/markdown/toc/settings.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/sixarm_ruby_markdown_table_of_contents_test/sixarm/markdown/toc/generator_test.rb
+- test/sixarm_ruby_markdown_table_of_contents_test/sixarm/markdown/toc/settings_test.rb
 - test/support/let.rb
 homepage: http://sixarm.com/
 licenses:
@@ -201,7 +219,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -215,7 +233,6 @@ 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/sixarm_ruby_markdown_table_of_contents_test/sixarm/markdown/toc/generator_test.rb
+- test/sixarm_ruby_markdown_table_of_contents_test/sixarm/markdown/toc/settings_test.rb
 - test/support/let.rb

data/lib/sixarm_ruby_markdown_table_of_contents/markdown/file.rb

@@ -1,16 +0,0 @@
-# -*- 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

@@ -1,24 +0,0 @@
-# -*- 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

@@ -1,27 +0,0 @@
-# -*- 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/markdown/file_test.rb

@@ -1,54 +0,0 @@
-# -*- 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

@@ -1,60 +0,0 @@
-# -*- 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

@@ -1,34 +0,0 @@
-# -*- 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