legal_markdown 0.4.7 → 0.4.8

data/legal_markdown.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.require_paths     = ["lib"]
   s.license           = 'MIT'
 
-  # s.add_dependency('dependency')
+  s.add_dependency('paint')
   s.add_development_dependency('coveralls')
 
   s.description       = <<desc

data/lib/legal_markdown.rb

@@ -19,8 +19,8 @@ module LegalMarkdown
     opt_parser = OptionParser.new do |opt|
       opt.banner = "Usage: legal2md [commands] [input_file] [output_file]"
       opt.separator ""
-      opt.separator "[input_file] can be a file, or use \"-\" for STDIN"
-      opt.separator "[output_file] can be a file, or use \"-\" for STDOUT"
+      opt.separator "[input_file] can be a file or use \"-\" for STDIN"
+      opt.separator "[output_file] can be a file or use \"-\" for STDOUT"
       opt.separator ""
       opt.separator "Specific Commands:"
 
@@ -34,6 +34,11 @@ module LegalMarkdown
         config[:output][:jason] = true
       end
 
+      config[:verbose] = false
+      opt.on('--verbose', 'Debug legal_markdown. Only works with output options, not with headers switch.') do
+        config[:verbose] = true
+      end
+
       config[:headers] = false
       opt.on( '-d', '--headers', 'Make the YAML Frontmatter automatically.' ) do
         config[:headers] = true
@@ -49,7 +54,7 @@ module LegalMarkdown
         args.delete(:to_json) if args.include?( :to_json )
       end
 
-      if args.include? :to_markdown
+      if args.include? :to_markdown || (begin args[-1][/\.md|\.markdown/]; rescue; end;)
         config[:output][:markdown] = true
         args.delete :markdown
       end
@@ -68,18 +73,22 @@ module LegalMarkdown
       opt.separator "Notes:"
       opt.separator "If the command is --headers or with --to-markdown you can enter one file to be parsed if you wish."
       opt.separator "When these commands are called with only one file I will set the input_file and the output_file to be the same."
-      opt.separator "The other commands will require the original legal_markdown file and the output format."
+      opt.separator "The other commands will require the original legal_markdown file and the output file."
       opt.separator "There is no need to explicitly enter the --to-json if your output_file is *.json I can handle it."
+      opt.separator "There is no need to explicitly enter the --to-markdown if your output_file is *.md or *.markdown I can handle it."
       opt.separator ""
     end
+
     opt_parser.parse!(args)
 
-    if config[:headers]
-      MakeYamlFrontMatter.new(args)
-    elsif config[:output][:jason]
-      LegalToMarkdown.parse_jason(args)
-    elsif config[:output][:markdown] || args.size <= 2
-      LegalToMarkdown.parse_markdown(args)
+    if args.size >= 1
+      if config[:headers]
+        MakeYamlFrontMatter.new(args)
+      elsif config[:output][:jason]
+        LegalToMarkdown.parse_jason(args, config[:verbose])
+      elsif config[:output][:markdown] || args.size <= 2
+        LegalToMarkdown.parse_markdown(args, config[:verbose])
+      end
     else
       puts opt_parser
     end

data/lib/legal_markdown/legal_to_markdown.rb

@@ -5,25 +5,83 @@ require 'legal_to_markdown/leaders.rb'
 require 'legal_to_markdown/json_builder.rb'
 require 'legal_to_markdown/writer.rb'
 require 'roman_numerals'
+require 'paint'
 
 module LegalToMarkdown
 
-  def parse_markdown(args)
-    @input_file = args[-2] ? args[-2] : args[-1]
-    @output_file = args[-1]
-    source = FileToParse.new(@input_file, "markdown")
-    source.run_mixins if source.mixins
-    source.run_leaders if source.leaders
-    write_it(source.content, source.writer)
+  def parse_markdown args, verbosity
+    parse_setup args, verbosity
+    source = FileToParse.new(@input_file, :markdown)
+    parse_controller source
+  end
+
+  def parse_jason args, verbosity
+    parse_setup args, verbosity
+    source = FileToParse.new(@input_file, :jason)
+    parse_controller source
   end
 
-  def parse_jason(args)
+  private
+
+  def parse_setup args, verbosity
     @input_file = args[-2] ? args[-2] : args[-1]
     @output_file = args[-1]
-    source = FileToParse.new(@input_file, "jason")
+    @verbose = true if verbosity
+  end
+
+  def parse_controller source
+    verbose_after_load source if @verbose
     source.run_mixins if source.mixins
+    verbose_after_mixins source if @verbose
     source.run_leaders if source.leaders
-    source.build_jason
+    verbose_after_leaders source if @verbose
+    source.build_jason if source.writer == :jason
     write_it(source.content, source.writer)
   end
+
+  def verbose_after_load source
+    puts
+    puts
+    puts Paint["Here's what I found after loading.", :blue, :bold]
+    puts Paint['==================================', :blue]
+    puts
+    puts Paint["The Headers I found are:", :green, :bold]
+    puts Paint['------------------------', :green]
+    puts Paint[(source.headers), :magenta]
+    puts
+    puts Paint["The Content I found is:", :green, :bold]
+    puts Paint['-----------------------', :green]
+    puts Paint[(source.content), :yellow]
+    puts
+    puts Paint["There are MIXINS to be parsed.", :red, :bold] if source.mixins
+    puts Paint["There are STRUCTURED HEADERS to be parsed.", :red, :bold] if source.leaders
+  end
+
+  def verbose_after_mixins source
+    puts
+    puts Paint["Here's what I found after the mixins.", :blue, :bold]
+    puts Paint['=====================================', :blue]
+    puts
+    puts Paint["The Headers I found are:", :green, :bold]
+    puts Paint['------------------------', :green]
+    puts Paint[(source.headers), :magenta]
+    puts
+    puts Paint["The Content I found is:", :green, :bold]
+    puts Paint['-----------------------', :green]
+    puts Paint[(source.content), :yellow]
+  end
+
+  def verbose_after_leaders source
+    puts
+    puts Paint["Here's what I found after the headers.", :blue, :bold]
+    puts Paint['=====================================', :blue]
+    puts
+    puts Paint["The Headers I found are:", :green, :bold]
+    puts Paint['------------------------', :green]
+    puts Paint[(source.headers), :magenta]
+    puts
+    puts Paint["The Content I found is:", :green, :bold]
+    puts Paint['-----------------------', :green]
+    puts Paint[(source.content), :yellow]
+  end
 end

data/lib/legal_markdown/legal_to_markdown/load_source.rb

@@ -6,7 +6,7 @@ module LegalToMarkdown
     attr_accessor :headers, :content, :mixins, :leaders, :writer
 
     def initialize(file, output)
-      @input_file = file; @headers = nil; @content = ""; @writer = output.to_sym
+      @input_file = file; @headers = nil; @content = ""; @writer = output
       load; get_the_partials; parse; set_the_parsers
     end
 
@@ -41,6 +41,7 @@ module LegalToMarkdown
       yaml_pattern = /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
       parts = @content.partition yaml_pattern
       if parts[1] != ""
+        parts[1] = string_guard parts[1]
         @headers = YAML.load parts[1]
         @content = parts[2]
       end
@@ -74,5 +75,12 @@ module LegalToMarkdown
       d = Date.today.strftime("%-d %B, %Y")
       @content.gsub!(/@today/, d)
     end
+
+    def string_guard strings
+      if strings =~ /(:\s*(\d+\.))$/
+        strings = strings.gsub($1, ": \"" + $2 + "\"" )
+      end
+      strings
+    end
   end
 end

data/lib/legal_markdown/legal_to_markdown/writer.rb

@@ -6,7 +6,7 @@ module LegalToMarkdown
     require 'json' if writer == :jason
     if @output_file && @output_file != "-"
       File.open(@output_file, "w") {|f| f.write( final_content ); f.close } if writer == :markdown
-      File.open(@output_file, "w") { |f| JSON.dump(final_content, f); f.close } if writer == :jason
+      File.open(@output_file, "w") { |f| IO.write( f, JSON.pretty_generate( final_content ) ); f.close } if writer == :jason
     else
       STDOUT.write final_content
     end

data/lib/legal_markdown/make_yaml_frontmatter.rb

@@ -4,39 +4,32 @@ require 'yaml'
 class MakeYamlFrontMatter
 
   def initialize(args)
-    find_yaml_if_yaml(load(args))
+    @input_file = args[-2] ? args[-2] : args[-1]
+    @output_file = args[-1]
+    find_yaml_if_yaml load
     scan_and_filter_yaml
     build_new_yaml_frontmatter unless @yaml_data_as_array == [{},{},{},{}]
     write_it
   end
 
-  def load(args)
+  private
+
+  def load
     begin
-      @input_file = args[-2] ? args[-2] : args[-1]
-      @output_file = args[-1]
-      if @input_file != "-"
-        source_file = File::read(@input_file) if File::exists?(@input_file) && File::readable?(@input_file)
-      else
-        source_file = STDIN.read
-      end
-      source_file.scan(/(@include (.+)$)/).each do |set|
-        partial_file = set[1]
-        to_replace = set[0]
-        partial_contents = File::read(partial_file) if File::exists?(partial_file) && File::readable?(partial_file)
-        source_file.gsub!(to_replace, "[PARTIALSTART]\n" + partial_contents + "\n[PARTIALENDS][#{to_replace}]")
-      end
-      return source_file
-    rescue => e
-      puts "Sorry, I could not read the input file #{@input_file}: #{e.message}."
+      source_file = @input_file == "-" ? STDIN.read : File::read(@input_file)
+      source_file = guard_partials_start source_file
+    rescue
+      puts "Sorry, I could not read the input file #{@input_file}."
       exit 0
     end
   end
 
-  def find_yaml_if_yaml( source )
+  def find_yaml_if_yaml source
     yaml_pattern = /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
-    parts = source.partition( yaml_pattern )
-    if parts[1] != ""
-      @headers = YAML.load(parts[1])
+    parts = source.partition yaml_pattern
+    if ! parts[1].empty?
+      parts[1] = guard_strings parts[1]
+      @headers = YAML.load parts[1]
       @content = parts[2]
     else
       @headers = {}
@@ -49,9 +42,9 @@ class MakeYamlFrontMatter
     opt_clauses_pattern = /\[{{(\S+)}}/
     @structured_headers_pattern = /(^l+.|^l\d+.)/
     @yaml_data_as_array = []
-    @yaml_data_as_array << ( filter_yaml(scan_doc(mixin_pattern)) || {} )
-    @yaml_data_as_array << ( filter_yaml(scan_doc(opt_clauses_pattern)) || {} )
-    @yaml_data_as_array << ( filter_yaml(scan_doc(@structured_headers_pattern)) || {} )
+    @yaml_data_as_array << ( filter_yaml mixin_pattern || {} )
+    @yaml_data_as_array << ( filter_yaml opt_clauses_pattern || {} )
+    @yaml_data_as_array << ( filter_yaml @structured_headers_pattern || {} )
     @yaml_data_as_array << ( @yaml_data_as_array.last.empty? ? {} : filter_yaml(%w{no-indent no-reset level-style}) )
   end
 
@@ -70,11 +63,7 @@ class MakeYamlFrontMatter
   end
 
   def write_it
-    @content.scan(/(\[PARTIALSTART\].*?\[PARTIALENDS\]\[(.*?)\])/m).each do |set|
-      replacer = set[1]
-      to_replace = set[0]
-      @content.gsub!(to_replace, replacer)
-    end
+    guard_partials_finish
     if @output_file && @output_file != "-"
       File.open(@output_file, "w") {|f| f.write( @content ); f.close }
     else
@@ -82,7 +71,17 @@ class MakeYamlFrontMatter
     end
   end
 
-  def scan_doc(pattern)
+  def filter_yaml pattern
+    # @headers will be a hash, stuff is an array, returns a filtered hash
+    stuff = pattern.is_a?(Regexp) ? scan_doc(pattern) : pattern
+    if stuff
+      stuff_in_yaml = stuff.inject({}) do |hash, elem|
+        @headers.has_key?(elem) ? hash.merge({elem => @headers[elem]}) : hash.merge({elem => ""})
+      end
+    end
+  end
+
+  def scan_doc pattern
     found = @content.scan(pattern).uniq.sort.flatten
     if pattern == @structured_headers_pattern
       found = convert_ll_to_level_two found
@@ -90,24 +89,47 @@ class MakeYamlFrontMatter
     found
   end
 
-  def convert_ll_to_level_two(levels)
+  def convert_ll_to_level_two levels
     # receives an array in form ["l.", "ll.", "lll."] returns array in form ["level-1", "level-2"]
-    levels.inject([]){|arr, level| level[/((l+)\.)|(l(\d+)\.*)/]; $2 ? arr << "level-" + $2.length.to_s : arr << "level-" + $&.delete("l")}
-  end
-
-  def filter_yaml(stuff)
-    # @headers will be a hash, stuff is an array, returns a filtered hash
-    if stuff
-      stuff_in_yaml = stuff.inject({}) do |hash, elem|
-        @headers.has_key?(elem) ? hash.merge({elem => @headers[elem]}) : hash.merge({elem => ""})
+    levels.inject([]) do |arr, level|
+      level[/((l+)\.)|(l(\d+)\.*)/]
+      if $2
+        arr << "level-" + $2.length.to_s
+      else
+        arr << "level-" + $&.delete("l")
       end
     end
   end
 
-  def sink_it(section)
+  def sink_it section
     section.inject("") do |string, head|
       string << head[0] + ": \"" + ( head[1].to_s.gsub("\"", "\\\"") || "" ) + "\"\n"
       string
     end
   end
+
+  def guard_partials_start source_file
+    source_file.scan(/(@include (.+)$)/).each do |set|
+      partial_file = set[1]
+      to_replace = set[0]
+      partial_contents = File::read(partial_file) if File::exists?(partial_file) && File::readable?(partial_file)
+      source_file.gsub!(to_replace, "[PARTIALSTART]\n" + partial_contents + "\n[PARTIALENDS][#{to_replace}]")
+    end
+    source_file
+  end
+
+  def guard_strings strings
+    if strings =~ /(:\s*(\d+\.))$/
+      strings = strings.gsub($1, ": \"" + $2 + "\"" )
+    end
+    strings
+  end
+
+  def guard_partials_finish
+    @content.scan(/(\[PARTIALSTART\].*?\[PARTIALENDS\]\[(.*?)\])/m).each do |set|
+      replacer = set[1]
+      to_replace = set[0]
+      @content.gsub!(to_replace, replacer)
+    end
+  end
 end

data/lib/legal_markdown/version.rb

@@ -1,3 +1,3 @@
 module LegalMarkdown
-  VERSION = "0.4.7"
+  VERSION = "0.4.8"
 end

data/test/legal_markdown_test.rb

@@ -41,6 +41,41 @@ class TestLegalMarkdownToMarkdown < Test::Unit::TestCase
     hash["nodes"].each_value.collect{|v| v["data"]["content"] if v["data"] && v["data"]["content"]}.select{|v| v}
   end
 
+  def test_bad_command_line_calls
+    puts "Testing bad file name.\n\n"
+    puts "Testing => legal2md -m 12345.lmd 12345.md"
+    cmd = `legal2md -m 12345.lmd 12345.md`
+    assert_equal( cmd, "Sorry, I could not read the file 12345.lmd: No such file or directory - 12345.lmd.\n" )
+    puts "Testing => legal2md -m"
+    cmd = `legal2md -m`
+    if RUBY_VERSION == "2.0.0"
+      response = "Sorry, I could not read the file to_markdown: no implicit conversion of Symbol into String.\n"
+    else
+      response = "Sorry, I could not read the file to_markdown: can't convert Symbol into String.\n"
+    end
+    assert_equal( cmd, response )
+    puts "Testing => legal2md 12345.md"
+    cmd = `legal2md 12345.md`
+    assert_equal( cmd, "Sorry, I could not read the file 12345.md: No such file or directory - 12345.md.\n" )
+   end
+
+  def test_good_command_line_calls
+    puts "\n\nTesting the command line caller.\n\n"
+    cmds = [ "--headers", "--to-markdown", "--to-json", '', '' ]
+    file = "00.load_write_no_action.lmd"
+    output = ['', create_temp('.md'), create_temp('.json'), create_temp('.md'), create_temp('.json')]
+    puts "Testing => cat 00.load_write_no_action.lmd | legal2md - -"
+    stdin_out_only = `cat 00.load_write_no_action.lmd | legal2md - -`
+    assert_equal(get_file(file), stdin_out_only)
+    cmds = cmds.each{|l| l << (" " + file) }.zip(output)
+    cmds.each do |cmd|
+      cmd = 'legal2md ' + cmd.join(' ')
+      puts "Testing => #{cmd}"
+      `#{cmd}`
+      assert_equal(get_file(file), get_file('00.load_write_no_action.md'))
+    end
+  end
+
   def test_markdown_files
     puts "\n\nTesting lmd to markdown files.\n\n"
     @lmdfiles.each do | lmd_file |
@@ -83,26 +118,13 @@ class TestLegalMarkdownToMarkdown < Test::Unit::TestCase
     end
   end
 
-  def test_command_line
-    puts "\n\nTesting the command line caller.\n\n"
-    cmds = [ "--headers", "--to-markdown", "--to-json", '', '' ]
-    file = "00.load_write_no_action.lmd"
-    output = ['', create_temp('.md'), create_temp('.json'), create_temp('.md'), create_temp('.json')]
-    puts "Testing => cat 00.load_write_no_action.lmd | legal2md - -"
-    stdin_out_only = `cat 00.load_write_no_action.lmd | legal2md - -`
-    assert_equal(get_file(file), stdin_out_only)
-    cmds = cmds.each{|l| l << (" " + file) }.zip(output)
-    cmds.each do |cmd|
-      cmd = 'legal2md ' + cmd.join(' ')
-      puts "Testing => #{cmd}"
-      `#{cmd}`
-      assert_equal(get_file(file), get_file('00.load_write_no_action.md'))
-    end
-  end
-
-  def test_bad_filename
-    puts "Testing bad file name.\n\n"
-    cmd = `legal2md -m 12345.lmd 12345.md`
-    assert_equal( cmd, "Sorry, I could not read the file 12345.lmd: No such file or directory - 12345.lmd.\n" )
+  def test_zee_verbosity_engine
+    puts "\n\nTesting Verbose.\n\n"
+    temp_file = create_temp('.md')
+    benchmark_file = '45.all_features_speed_ratchet.debug'
+    puts "Testing => legal2md --verbose 45.all_features_speed_ratchet.lmd - > #{temp_file}"
+    `legal2md --verbose 45.all_features_speed_ratchet.lmd - > #{temp_file}`
+    assert_equal( get_file(benchmark_file), get_file(temp_file) )
+    destroy_temp temp_file
   end
 end

data/test/tests/20.block_no_addons.lmd

@@ -3,7 +3,7 @@
 # Structured Headers
 level-1: "Article 1."
 level-2: "Section 1."
-level-3: "1."
+level-3: 1.
 
 ---