legal_markdown 0.4.2 → 0.4.3

data/Rakefile

@@ -7,4 +7,54 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
+desc "Push the Gem & Update Sublime Package"
+task :publish do
+  system "git push github master"
+  system "git push wsl master"
+  Dir.chdir(File.dirname(__FILE__))
+  pkg = ENV['HOME'] + "/.config/sublime-text-2/Packages/Legal Document Creator"
+  FileUtils.cp_r( File.dirname(__FILE__) + "/lib" , pkg )
+  Dir.chdir(pkg)
+  f = "lib/legal_markdown.rb"
+  c = File::read(f) + "\n\nLegalMarkdown::parse(ARGV)"
+  File.open(f, "w") { |f| f.write( c ); f.close }
+  message = "Package updated at #{Time.now.utc} to reflect changes in Gem."
+  system "git add -A"
+  system "git commit -m #{message.shellescape}"
+  system "git push github master"
+  system "git push wsl master"
+  Dir.chdir(File.dirname(__FILE__))
+end
+
+# call with rake site:publish
+desc "Publish New Version of Gem"
+task :pushit do
+  fail "Does not look like the Version file is updated!" unless `git status -s`.split("\n").include?(" M lib/legal_markdown/version.rb")
+  require Dir.pwd + "/lib/legal_markdown/version.rb"
+  tag = LegalMarkdown::VERSION
+  system "git checkout master"
+  system "git add -A"
+  system "git commit -m 'Version Bump of Gem to version #{tag}'"
+  system "git tag -a v" + tag
+  system "git push github master --tags"
+  system "git push wsl master --tags"
+  system "rake install"
+  system "gem push pkg/legal_markdown-#{tag}.gem"
+  Dir.chdir(File.dirname(__FILE__))
+  pkg = ENV['HOME'] + "/.config/sublime-text-2/Packages/Legal Document Creator"
+  FileUtils.cp_r( File.dirname(__FILE__) + "/lib" , pkg )
+  Dir.chdir(pkg)
+  f = "lib/legal_markdown.rb"
+  c = File::read(f) + "\n\nLegalMarkdown::parse(ARGV)"
+  File.open(f, "w") { |f| f.write( c ); f.close }
+  message = "Package updated at reflect changes in Gem to version #{tag}."
+  system "git add -A"
+  system "git commit -m #{message.shellescape}"
+  system "git push github master"
+  system "git push wsl master"
+  Dir.chdir(File.dirname(__FILE__))
+  system "google-chrome https://github.com/compleatang/legal-markdown/releases"
+  system "gl"
+end
+
 task :default => [:test]

data/lib/legal_markdown.rb

@@ -1,7 +1,8 @@
 #! ruby
-require File.dirname(__FILE__) + '/legal_markdown/version.rb'
-require File.dirname(__FILE__) + '/legal_markdown/make_yaml_frontmatter.rb'
-require File.dirname(__FILE__) + '/legal_markdown/legal_to_markdown.rb'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'legal_markdown/version.rb'
+require 'legal_markdown/make_yaml_frontmatter.rb'
+require 'legal_markdown/legal_to_markdown.rb'
 
 module LegalMarkdown
 

data/lib/legal_markdown/legal_to_markdown.rb

@@ -1,9 +1,10 @@
-require File.dirname(__FILE__) + '/legal_to_markdown/load_source.rb'
-require File.dirname(__FILE__) + '/legal_to_markdown/mixins.rb'
-require File.dirname(__FILE__) + '/legal_to_markdown/leaders.rb'
-require File.dirname(__FILE__) + '/legal_to_markdown/json_builder.rb'
-require File.dirname(__FILE__) + '/legal_to_markdown/writer.rb'
-require File.dirname(__FILE__) + '/roman_numerals'
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'legal_to_markdown/load_source.rb'
+require 'legal_to_markdown/mixins.rb'
+require 'legal_to_markdown/leaders.rb'
+require 'legal_to_markdown/json_builder.rb'
+require 'legal_to_markdown/writer.rb'
+require 'roman_numerals'
 
 module LegalToMarkdown
 

data/lib/legal_markdown/legal_to_markdown/mixins.rb

@@ -11,47 +11,14 @@ module LegalToMarkdown
     end
 
     def clauses_mixins
-      clauses_to_delete = []
-      clauses_to_mixin = []
+      @clauses_to_delete = []
+      @clauses_to_mixin = []
+      set_up_opt_clauses
+      backup_opt_clauses
 
-      @headers.each do | mixin, replacer |
-        replacer = replacer.to_s.downcase
-        clauses_to_delete << mixin if replacer == "false"
-        clauses_to_mixin << mixin if replacer == "true"
-      end
-
-      clauses_to_delete.each { |m| @headers.delete(m) }
-      clauses_to_mixin.each { |m| @headers.delete(m) }
-
-      until clauses_to_delete.size == 0
-        clauses_to_delete.each do | mixin |
-          pattern = /(\[\{\{#{mixin}\}\}\s*?)(.*?\n*?)(\])/m
-          sub_pattern = /\[\{\{(\S+?)\}\}\s*?/
-          @content[pattern]
-          get_it_all = $& || ""
-          sub_clause = $2 || ""
-          if sub_clause[sub_pattern] && clauses_to_delete.include?($1)
-            next
-          elsif sub_clause[sub_pattern]
-            pattern = /\[\{\{#{mixin}\}\}\s*?.*?\n*?\].*?\n*?\]/m
-            @content[pattern]; get_it_all = $& || ""
-          end
-          @content = @content.gsub( get_it_all, "" )
-          clauses_to_delete.delete( mixin ) unless @content[pattern]
-        end
-      end
-
-      until clauses_to_mixin.size == 0
-        clauses_to_mixin.each do | mixin |
-          pattern = /(\[\{\{#{mixin}\}\}\s*?)(.*?\n*?)(\])/m
-          sub_pattern = /\[\{\{(\S+?)\}\}\s*?/
-          @content[pattern]
-          get_it_all = $& || ""
-          sub_clause = $2 || ""
-          next if sub_clause[sub_pattern] && clauses_to_mixin.include?($1)
-          @content = @content.gsub( get_it_all, sub_clause.lstrip )
-          clauses_to_mixin.delete( mixin ) unless @content[pattern]
-        end
+      until @clauses_added.size == 0 && @clauses_deleted.size == 0
+        clauses_churn_add
+        clauses_churn_delete
       end
     end
 
@@ -71,5 +38,46 @@ module LegalToMarkdown
       @content.squeeze!(" ")
       @headers = nil if @headers.empty?
     end
+
+    def set_up_opt_clauses
+      @headers.each do | mixin, replacer |
+        replacer = replacer.to_s.downcase
+        @clauses_to_delete << mixin if replacer == "false"
+        @clauses_to_mixin << mixin if replacer == "true"
+      end
+    end
+
+    def backup_opt_clauses
+      @clauses_to_delete.each { |m| @headers.delete(m) }
+      @clauses_to_mixin.each { |m| @headers.delete(m) }
+      @clauses_deleted = @clauses_to_delete.dup
+      @clauses_added = @clauses_to_mixin.dup
+    end
+
+    def clauses_churn_add
+      @clauses_added.each do | mixin |
+        pattern = /(\[\{\{#{mixin}\}\}\s*?)(.*?\n*?)(\])/m
+        sub_pattern = /\[\{\{(\S+?)\}\}\s*?/
+        @content[pattern]
+        get_it_all = $& || ""
+        sub_clause = $2 || ""
+        next if sub_clause[sub_pattern] && ( @clauses_to_mixin.include?($1) || @clauses_to_delete.include?($1) )
+        @content = @content.gsub( get_it_all, sub_clause.lstrip )
+        @clauses_added.delete( mixin ) unless @content[pattern]
+      end
+    end
+
+    def clauses_churn_delete
+      @clauses_deleted.each do | mixin |
+        pattern = /(\[\{\{#{mixin}\}\}\s*?)(.*?\n*?)(\])/m
+        sub_pattern = /\[\{\{(\S+?)\}\}\s*?/
+        @content[pattern]
+        get_it_all = $& || ""
+        sub_clause = $2 || ""
+        next if sub_clause[sub_pattern] && ( @clauses_to_mixin.include?($1) || @clauses_to_delete.include?($1) )
+        @content = @content.gsub( get_it_all, "" )
+        @clauses_deleted.delete( mixin ) unless @content[pattern]
+      end
+    end
   end
 end

data/lib/legal_markdown/make_yaml_frontmatter.rb

@@ -3,17 +3,16 @@ require 'yaml'
 
 class MakeYamlFrontMatter
 
-  def initialize(*args)
-    data = load(*args)
-    parsed_file = find_yaml_if_yaml(data)
-    new_yaml_as_array = scan_and_filter_yaml(parsed_file[0], parsed_file[1])
-    new_yaml = build_new_yaml_frontmatter(new_yaml_as_array)
-    write_it( new_yaml + parsed_file[1] )
+  def initialize(args)
+    find_yaml_if_yaml(load(args))
+    scan_and_filter_yaml
+    build_new_yaml_frontmatter unless @yaml_data_as_array == [{},{},{},{}]
+    write_it
   end
 
-  def load(*args)
+  def load(args)
     begin
-      @file = ARGV[-1]
+      @file = args[-1]
       if @file != "-"
         source_file = File::read(@file) if File::exists?(@file) && File::readable?(@file)
       else
@@ -33,83 +32,81 @@ class MakeYamlFrontMatter
   end
 
   def find_yaml_if_yaml( source )
-    begin
-      yaml_pattern = /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
-      parts = source.partition( yaml_pattern )
-      if parts[1] != ""
-        headers = YAML.load(parts[1])
-        content = parts[2]
-      else
-        headers = {}
-        content = source
-      end
-    rescue => e
-      puts "Sorry, something went wrong when I was loading the YAML front matter: #{e.message}."
+    yaml_pattern = /\A(---\s*\n.*?\n?)^(---\s*$\n?)/m
+    parts = source.partition( yaml_pattern )
+    if parts[1] != ""
+      @headers = YAML.load(parts[1])
+      @content = parts[2]
+    else
+      @headers = {}
+      @content = source
     end
-    return [headers, content]
   end
 
-  def scan_doc(content, pattern)
-    headers = content.scan(pattern).uniq.sort.flatten
-    if pattern == @structured_headers_pattern
-      headers = convert_ll_to_level_two(headers)
+  def scan_and_filter_yaml
+    mixin_pattern = /[^\[]{{(\S+)}}/
+    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 << ( @yaml_data_as_array.last.empty? ? {} : filter_yaml(%w{no-indent no-reset level-style}) )
+  end
+
+  def build_new_yaml_frontmatter
+    @content = "\n---\n\n" + @content
+    replacers = {0=>"Mixins", 1=>"Optional Clauses", 2=>"Structured Headers", 3=>"Properties"}
+    stringy = @yaml_data_as_array.inject("") do |string, section|
+      unless section.empty?
+        string << "\n\# " + replacers[@yaml_data_as_array.index(section)] + "\n"
+        string << sink_it(section)
+      end
+      string
     end
-    return headers
+    @content = stringy + @content
+    @content = "---\n" + @content
   end
 
-  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+)./]; arr << "level-" + $1.length.to_s}
+  def write_it
+    @content.scan(/(\[PARTIALSTART\].*?\[PARTIALENDS\]\[(.*?)\])/m).each do |set|
+      replacer = set[1]
+      to_replace = set[0]
+      @content.gsub!(to_replace, replacer)
+    end
+    if @file != "-"
+      File.open(@file, "w") {|f| f.write( @content ); f.close }
+    else
+      STDOUT.write @content
+    end
   end
 
-  def filter_yaml(yaml_data, stuff)
-    # yaml_data will be a hash, stuff is an array, returns a filtered hash
-    stuff_in_yaml = stuff.inject({}) do |hash, elem|
-      yaml_data.has_key?(elem) ? hash.merge({elem => yaml_data[elem]}) : hash.merge({elem => ""})
+  def scan_doc(pattern)
+    found = @content.scan(pattern).uniq.sort.flatten
+    if pattern == @structured_headers_pattern
+      found = convert_ll_to_level_two found
     end
+    found
   end
 
-  def scan_and_filter_yaml(yaml_data, content)
-    mixin_pattern = /[^\[]{{(\S+)}}/
-    opt_clauses_pattern = /\[{{(\S+)}}/
-    @structured_headers_pattern = /(^l+.)/
-    mixins = filter_yaml(yaml_data, scan_doc(content, mixin_pattern))
-    opt_clauses = filter_yaml(yaml_data, scan_doc(content, opt_clauses_pattern))
-    levels = filter_yaml(yaml_data, scan_doc(content, @structured_headers_pattern))
-    extras = filter_yaml(yaml_data, %w{no-indent no-reset level-style})
-    return [mixins, opt_clauses, levels, extras]
+  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 build_new_yaml_frontmatter(yaml_data_as_array)
-    front = "---\n\n"
-    if yaml_data_as_array[0]
-      front << "\# Mixins\n"
-      yaml_data_as_array[0].each{ |head, val| front << head + ": " + val.to_s + "\n" }
-    end
-    if yaml_data_as_array[1]
-      front << "\n\# Optional Clauses\n"
-      yaml_data_as_array[1].each{ |head, val| front << head + ": " + val.to_s + "\n" }
-    end
-    if yaml_data_as_array[2]
-      front << "\n\# Structured Headers\n"
-      yaml_data_as_array[2].each{ |head, val| front << head + ": \"" + val.to_s + "\"\n" }
-    end
-    if yaml_data_as_array[3]
-      yaml_data_as_array[3].each{ |head, val| front << head + ": " + val.to_s + "\n" }
+  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 => ""})
+      end
     end
-    front << "\n---\n\n"
   end
 
-  def write_it( final_content )
-    final_content.scan(/(\[PARTIALSTART\].*?\[PARTIALENDS\]\[(.*?)\])/m).each do |set|
-      replacer = set[1]
-      to_replace = set[0]
-      final_content.gsub!(to_replace, replacer)
-    end
-    if @file != "-"
-      File.open(@file, "w") {|f| f.write( final_content ) }
-    else
-      STDOUT.write final_content
+  def sink_it(section)
+    section.inject("") do |string, head|
+      string << head[0] + ": \"" + ( head[1].to_s.gsub("\"", "\\\"") || "" ) + "\"\n"
+      string
     end
   end
 end

data/lib/legal_markdown/roman_numerals.rb

@@ -52,15 +52,7 @@ module RomanNumerals
   end
 
   def self.to_roman_lower(value)
-    value = value.to_i
-    result = ''
-    @base_digits.keys.reverse.each do |decimal|
-      while value >= decimal
-        value -= decimal
-        result += @base_digits[decimal]
-      end
-    end
-    result.downcase
+    self.to_roman_upper(value).downcase
   end
 
   def self.to_decimal_string(value)

data/lib/legal_markdown/version.rb

@@ -1,3 +1,3 @@
 module LegalMarkdown
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/test/test_legal_markdown_to_markdown.rb

@@ -1,6 +1,6 @@
 #! ruby
 require 'test/unit'
-require 'tempfile'
+require 'securerandom'
 require 'json'
 require 'legal_markdown'
 
@@ -18,22 +18,12 @@ class TestLegalMarkdownToMarkdown < Test::Unit::TestCase
   end
 
   def get_file ( filename )
-    begin
-      contents = File::read( filename ) if File::exists?(filename) && File::readable?(filename)
-    rescue => e
-      raise "Could not find file #{filename}: #{e.message}."
-      contents = ""
-    end
-    if contents && contents != ""
-      return contents.rstrip
-    else
-      return ""
-    end
+    contents = IO.read(filename)
+    contents.rstrip
   end
 
   def create_temp
-    temp_file = Tempfile.new('lmd_tests')
-    return temp_file.path
+    temp_file = "/tmp/lmdtests-" + SecureRandom.hex
   end
 
   def destroy_temp ( temp_file )
@@ -45,7 +35,7 @@ class TestLegalMarkdownToMarkdown < Test::Unit::TestCase
   end
 
   def test_markdown_files
-    puts "\n\nTesting lmd to markdown files.\n\n"
+    puts "Testing lmd to markdown files.\n\n"
     @lmdfiles.each do | lmd_file |
       puts "Testing => #{lmd_file}"
       temp_file = create_temp
@@ -56,8 +46,8 @@ class TestLegalMarkdownToMarkdown < Test::Unit::TestCase
     end
   end
 
-  def test_json_files
-    puts "Testing lmd to json files.\n\n"
+  def test_the_json_files
+    puts "\n\nTesting lmd to json files.\n\n"
     @lmdfiles.each do | lmd_file |
       puts "Testing => #{lmd_file}"
       temp_file = create_temp
@@ -73,4 +63,16 @@ class TestLegalMarkdownToMarkdown < Test::Unit::TestCase
       destroy_temp temp_file
     end
   end
+
+  def test_yaml_headers
+      puts "\n\nTesting Make YAML Frontmatter.\n\n"
+      @lmdfiles.each do | lmd_file |
+        puts "Testing => #{lmd_file}"
+        temp_file = create_temp
+        benchmark_file = File.basename(lmd_file, ".lmd") + ".headers"
+        `cat #{lmd_file} | legal2md --headers - > #{temp_file}`
+        assert_equal(get_file(benchmark_file), get_file(temp_file), "This file threw an exception => #{lmd_file}")
+        destroy_temp temp_file
+      end
+    end
 end