sixarm_ruby_markdown 2.0.0 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ba8590ac0d2bd4b5794190e2c570d45a239ca642f490ef81b20fc5b2f205de6
-  data.tar.gz: aaf32b72afcfec851c5eb51870207c897dc896e2aef3428e24caa33764d80767
+  metadata.gz: af9a2722358657600dc9b1f3ef85dc514c107e2db3a2bb181c8ab72c5f402fe6
+  data.tar.gz: 91b2d23b0ceb68cff8547b08013c36c9e1babbe30e72ee37af3d2a54e913b54c
 SHA512:
-  metadata.gz: 3fcf8f64f0571e4d4818575944bc407e659f2b138a0bd11dea38fb4bd9e9b1115f62e1c9aede2b1c13928691d56162dc3d8272deb1281d4273d02d094fc9b34b
-  data.tar.gz: 0b4de1f52e4bfabe4c4a9b8dba29b95caa4c16b8c0056833b483b3864084ec0c35320a63eabd158f9e18da12dd0f94d9b717ac6fc16a914a92da4b0e96fdd7b4
+  metadata.gz: '08c993859e8ca51116cb0e1d39821e7b19adaa637972a32b951083ef9d301b82318236cd2cf6c11b534865c8890646589479ebf8a49b6742c65d1b506aa9dbd9'
+  data.tar.gz: 6efc020cfea100b66bfc95df589ed9c0246f189f370c12484256dc31e03025ffb770cb19757fb86c1214ca0367c7a8b7db4f0a8722de1baeefaaf50a1ec99c15

data/lib/sixarm_ruby_markdown.rb

@@ -4,6 +4,7 @@ Please see README
 =end
 
 require "ostruct"
+require "sixarm_ruby_equal_instance_variables"
 require "sixarm_ruby_file_rewrite"
 
 require_relative "sixarm_ruby_markdown/sixarm/markdown/headline"

data/lib/sixarm_ruby_markdown/sixarm/markdown/headline.rb

@@ -4,13 +4,57 @@
 
 module SixArm; module Markdown; end; end
 
-class SixArm::Markdown::Headline < OpenStruct
+class SixArm::Markdown::Headline
+  include EqualInstanceVariables
 
-  def link
-    "[#{text}](##{anchor})"
+  attr_accessor \
+    :text,
+    :anchor,
+    :level,
+    :link
+
+  def initialize(
+    text: nil,
+    anchor: nil,
+    level: nil,
+    link: nil
+  )
+    raise ArgumentError if !text.kind_of?(String)
+    @text = text
+    @anchor = anchor || self.class.text_to_anchor(text)
+    @level = level
+    @link = link
   end
 
   def anchor
+    @anchor || self.class.text_to_anchor(text)
+  end
+
+  def level
+    @level || 1
+  end
+
+  def link
+    @link || "[#{text}](##{anchor})"
+  end
+
+  def self.parse_line(line)
+    level = parse_line_level(line)
+    text = trim_line(line)
+    # TODO Add parser for anchor
+    # TODO Add parser for Unicode normalization
+    return SixArm::Markdown::Headline.new(text: text, level: level)
+  end
+
+  def self.parse_line_level(line)
+    return line =~/^\s*([#=]+)/ ? $1.length : nil
+  end
+
+  def self.trim_line(line)
+    line.sub(/^\s*[#=]+\s+/, '').sub(/\s+[#=]+\s*$/, '')
+  end
+
+  def self.text_to_anchor(text)
     text.downcase.gsub(/\W+/,'-')
   end
 

data/test/sixarm_ruby_markdown_test/sixarm/markdown/headline_test.rb

@@ -3,38 +3,142 @@ require "sixarm_ruby_markdown_test"
 
 describe SixArm::Markdown::Headline do
 
-  let(:level){ 3 }
-  let(:text){ "Hello World" }
-  let(:headline){ SixArm::Markdown::Headline.new(level: level, text: text) }
+  let(:text){ "Foo Goo Hoo" }
+  let(:anchor_default) { "foo-goo-hoo"}
+  let(:anchor_custom) { "bar-car-dar"}
+  let(:level_default){ 1 }
+  let(:level_custom){ 3 }
+  let(:link_default){ "[Foo Goo Hoo](#foo-goo-hoo)" }
+  let(:link_custom){ "[My Link Text](#my-link-anchor)" }
+  let(:headline){ SixArm::Markdown::Headline.new(text: text) }
 
-  describe "#level" do
+  describe "#text" do
 
-    it "return level" do
-      expect(headline.level).must_equal level
+    it "return text" do
+      expect(headline.text).must_equal text
     end
 
   end
 
-  describe "#text" do
+  describe "#anchor" do
+
+    describe "with default, which is no anchor, thus uses autogeneration" do
+
+      it "return default anchor" do
+        headline = SixArm::Markdown::Headline.new(text: text) 
+        expect(headline.anchor).must_equal anchor_default
+      end
+
+    end
+
+    describe "with custom anchor" do
+
+      it "return custom anchor" do
+        headline = SixArm::Markdown::Headline.new(text: text, anchor: anchor_custom) 
+        expect(headline.anchor).must_equal anchor_custom
+      end
 
-    it "return text" do
-      expect(headline.text).must_equal text
     end
 
   end
 
-  describe "#anchor" do
+  describe "#level" do
+
+    describe "with default, which is no level, thus uses default level which is 1" do
+
+      it "return default level, which is 1 i.e. suitable for HTML H1" do
+        headline = SixArm::Markdown::Headline.new(text: text) 
+        expect(headline.level).must_equal level_default
+      end
+
+    end
+
+    describe "with custom level" do
+
+      it "return custom level" do
+        headline = SixArm::Markdown::Headline.new(text: text, level: level_custom) 
+        expect(headline.level).must_equal level_custom
+      end
 
-    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)"
+    describe "with default, which is no link, thus uses autogeneration" do
+
+      it "return default link, which is the Markdown formatting of the text and anchor" do
+        expect(headline.link).must_equal link_default
+      end
+
+    end
+
+    describe "with custom link" do
+
+      it "return custom link" do
+        headline = SixArm::Markdown::Headline.new(text: text, link: link_custom) 
+        expect(headline.link).must_equal link_custom
+      end
+
+    end
+
+  end
+
+  describe ".parse_line" do
+
+    it "parse a headline that starts with hash characters" do
+      line = "### Hello"
+      headline = SixArm::Markdown::Headline::parse_line(line)
+      expect(headline.text).must_equal "Hello"
+      expect(headline.level).must_equal 3
+    end
+
+    it "parse a headline that starts with equal characters" do
+      line = "=== Hello"
+      headline = SixArm::Markdown::Headline::parse_line(line)
+      expect(headline.text).must_equal "Hello"
+      expect(headline.level).must_equal 3
+    end
+
+    it "trim extraneous characters i.e. leading/trailing whitespace and leading/trailing hashes" do
+      line = "   ###   Hello   ###   \n"
+      headline = SixArm::Markdown::Headline::parse_line(line)
+      expect(headline.text).must_equal "Hello"
+      expect(headline.level).must_equal 3
+    end
+
+  end
+
+  describe ".parse_line_level" do
+
+    it "return level" do
+      line = "### Hello"
+      expect = 3
+      actual = SixArm::Markdown::Headline::parse_line_level(line)
+      expect(actual).must_equal expect
+    end
+
+  end
+
+  describe ".trim_line" do
+
+    it "trim extraneous characters i.e. leading/trailing spaces and leading/trailing hashes" do
+      line = "   ###   Hello   ###   "
+      expect = "Hello"
+      actual = SixArm::Markdown::Headline::trim_line(line)
+      expect(actual).must_equal actual
+    end
+
+  end
+
+  describe ".text_to_anchor" do
+
+    it "return anchor, which is the text as lowercase, and replacing every run of non-word characters with a dash" do
+      text = "Foo ! Goo ! Hoo"
+      expect = "foo-goo-hoo"
+      actual = SixArm::Markdown::Headline::text_to_anchor(text)
+      expect(actual).must_equal expect
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sixarm_ruby_markdown
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.3
 platform: ruby
 authors:
 - SixArm
@@ -39,8 +39,28 @@ cert_chain:
   tzpk/VnZXj7Ek/earx+N/Z+Wtnl2xENm5IF8SFPeI1HFa9NH47pqtxF1YKpNIEVc
   2xa2BNHSePe7tys/2hbmZuyMu8X5ERmovsabSXB3a+YwtJh5c2jhA21wF7986s0q
   -----END CERTIFICATE-----
-date: 2018-02-11 00:00:00.000000000 Z
+date: 2018-02-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: sixarm_ruby_equal_instance_variables
+  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: sixarm_ruby_file_rewrite
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +203,7 @@ licenses:
 - BSD-3-Clause
 - CC-BY-NC-SA-4.0
 - AGPL-3.0
+- EPL-1.0
 - GPL-2.0
 - GPL-3.0
 - LGPL-3.0