markdown_section_numbering 0.9.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bd695f991b84fd57e45afaca3e03f4135b2931c
+  data.tar.gz: ecfd26b2b8bb24f953d373507fe38ac46701e5ba
+SHA512:
+  metadata.gz: e6860f7d55dbcbcec2a16207f7725d861d3d6f2576b80cdde66e6355543d7163fa35bd0e781d648b112b92fa42255f8c761601d4ab616ab6ad338cb95d71ff6a
+  data.tar.gz: dbb514c7dc2c1f85a353bcdf0061157355d87606b6e1caf4c3d74e8c4024bedaf8c65d60b9ac7487e5f9c348103ab6b21a40e0c9ee47a10c1687210be144806d

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--color --format doc

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+  gem 'rspec'
+end
+
+# Specify your gem's dependencies in markdown_section_numbering.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 SET_ME_LOCALLY
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# MarkdownSectionNumbering
+
+`MarkdownSectionNumbering` adds section numbers to markdown headings written in "#" style.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'markdown_section_numbering'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install markdown_section_numbering
+
+## Usage
+
+```ruby
+require "markdown_section_numbering"
+
+markdown = <<MD
+# a
+## b
+
+foo bar
+
+## c
+
+- list
+- list
+- list
+MD
+
+puts MarkdownSectionNumbering.convert(markdown)
+```
+
+This code produces the following results.
+
+```
+# 1 a
+## 1.1 b
+
+foo bar
+
+## 1.2 c
+
+- list
+- list
+- list
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/markdown_section_numbering/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/example/example.rb

@@ -0,0 +1,19 @@
+require "rubygems"
+
+$:.unshift File.expand_path("../lib", File.dirname(__FILE__))
+require "markdown_section_numbering"
+
+markdown = <<MD
+# a
+## b
+
+foo bar
+
+## c
+
+- list
+- list
+- list
+MD
+
+puts MarkdownSectionNumbering.convert(markdown)

data/lib/markdown_section_numbering.rb

@@ -0,0 +1,55 @@
+require "markdown_section_numbering/version"
+
+class MarkdownSectionNumbering
+  class << self
+
+    def config(max_level)
+      @max_level = max_level
+    end
+
+    def convert(input)
+      @section_index = [-1] + [0] * max_level
+      
+      input.lines.map do |line|
+        convert_line(line)
+      end.join("\n")+"\n"
+    end
+
+  private
+
+    def max_level
+      @max_level || 10
+    end
+
+    def convert_line(line)
+      line.chomp!
+      if not match = line.match(/^#+/)
+        line
+      else
+        level = match[0].length
+        add_section_number(line, level)
+      end
+    end
+
+    def add_section_number(line, target_level)
+      return line if target_level > max_level
+      
+      header_sign = "#" * target_level
+      regex = Regexp.new("^#{header_sign}\s*(.+)")
+      match = line.match(regex)
+
+      number = calc_section_number(target_level)
+      
+      "#{header_sign} #{number} #{match[1]}"
+    end
+
+    def calc_section_number(target_level)
+      @section_index[target_level] += 1
+      (target_level+1 .. max_level).each do |child_level|
+        @section_index[child_level] = 0
+      end
+      (1..target_level).map {|level| @section_index[level].to_s }.join(".")
+    end
+    
+  end
+end

data/lib/markdown_section_numbering/version.rb

@@ -0,0 +1,3 @@
+class MarkdownSectionNumbering
+  VERSION = "0.9.0"
+end

data/markdown_section_numbering.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'markdown_section_numbering/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "markdown_section_numbering"
+  spec.version       = MarkdownSectionNumbering::VERSION
+  spec.authors       = ["xoyip"]
+  spec.email         = ["xoyip@piyox.info"]
+  spec.summary       = %q{Add section numbers to markdown headings.}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/xoyip/markdown_section_numbering"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/spec/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/spec/fixtures/input1.md

@@ -0,0 +1,23 @@
+# a
+## b 
+### c
+## d
+### e
+### f
+
+# g
+## h
+
+### i
+### j
+## k 
+### l
+### m
+### n
+## o
+### p
+### q
+
+# r
+
+# s

data/spec/fixtures/input2.md

@@ -0,0 +1,23 @@
+#a
+##b 
+###        c
+## d
+### e
+### f
+
+#                   g
+## h
+
+### i
+### j
+##          k 
+###     l
+### m
+###   n
+## o
+###p
+###q
+
+#r
+
+#s

data/spec/fixtures/output1.md

@@ -0,0 +1,23 @@
+# 1 a
+## 1.1 b 
+### 1.1.1 c
+## 1.2 d
+### 1.2.1 e
+### 1.2.2 f
+
+# 2 g
+## 2.1 h
+
+### 2.1.1 i
+### 2.1.2 j
+## 2.2 k 
+### 2.2.1 l
+### 2.2.2 m
+### 2.2.3 n
+## 2.3 o
+### 2.3.1 p
+### 2.3.2 q
+
+# 3 r
+
+# 4 s

data/spec/fixtures/output2.md

@@ -0,0 +1,23 @@
+# 1 a
+## 1.1 b 
+### c
+## 1.2 d
+### e
+### f
+
+# 2 g
+## 2.1 h
+
+### i
+### j
+## 2.2 k 
+### l
+### m
+### n
+## 2.3 o
+### p
+### q
+
+# 3 r
+
+# 4 s

data/spec/markdown_section_numbering_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+
+describe MarkdownSectionNumbering do
+  specify "convert correctly" do
+    input = fixture("input1.md")
+    expected = fixture("output1.md")
+    output = MarkdownSectionNumbering.convert(input)
+    expect(output).to eq(expected)
+  end
+  
+  specify "ignore spaces after header sign('#')" do
+    input = fixture("input2.md")
+    expected = fixture("output1.md")
+    output = MarkdownSectionNumbering.convert(input)
+    expect(output).to eq(expected)
+  end
+
+  specify "when max level is set to 2, headings deeper than 2 are not converted" do
+    input = fixture("input1.md")
+    expected = fixture("output2.md")
+    MarkdownSectionNumbering.config(2)
+    output = MarkdownSectionNumbering.convert(input)
+    expect(output).to eq(expected)
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require "markdown_section_numbering"
+
+RSpec.configure do |config|
+end
+
+def fixture_path
+  File.expand_path("../fixtures", __FILE__)
+end
+
+def fixture(file)
+  open(File.join(fixture_path, file)).read
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: markdown_section_numbering
+version: !ruby/object:Gem::Version
+  version: 0.9.0
+platform: ruby
+authors:
+- xoyip
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- xoyip@piyox.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/example.rb
+- lib/markdown_section_numbering.rb
+- lib/markdown_section_numbering/version.rb
+- markdown_section_numbering.gemspec
+- spec/.rspec
+- spec/fixtures/input1.md
+- spec/fixtures/input2.md
+- spec/fixtures/output1.md
+- spec/fixtures/output2.md
+- spec/markdown_section_numbering_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/xoyip/markdown_section_numbering
+licenses:
+- MIT
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Add section numbers to markdown headings.
+test_files:
+- spec/.rspec
+- spec/fixtures/input1.md
+- spec/fixtures/input2.md
+- spec/fixtures/output1.md
+- spec/fixtures/output2.md
+- spec/markdown_section_numbering_spec.rb
+- spec/spec_helper.rb