legal_markdown 0.4.10 → 0.4.11

data/Gemfile

@@ -4,5 +4,7 @@ gemspec
 gem 'rake'
 
 group :development, :test do
-  gem 'coveralls', require: false
+  gem 'rspec', '~> 2.14.0', :require => 'spec'
+  gem 'pry'
+  gem 'coveralls'
 end

data/README.md

@@ -331,6 +331,7 @@ At this point legal_markdown does not have a native citation handling ability. F
 
 * Legal_markdown is optimized primarily for contracts, legislation, and regulations. It is not optimized for cases. For memoranda and filings I use the mixin portion but not the structured headers functionality which is enough to meet my needs - in particular, when matched with Sublime Text snippets. If you area looking for a solution for cases and filings I would recommend the [Precedent Gem](https://github.com/BlackacreLabs/precedent) built by [Kyle Mitchell](https://github.com/kemitchell) for [Blackacre Labs](https://github.com/BlackacreLabs)
 * At this point, you cannot have more than 9 levels for headers, but if you have more than 9 levels of headers you have some insane case study which will require more than this tool to cope with.
+* If you are using windows `legal_markdown` *should* be able to deal with most of the file types, but to be safe it is preferable to save your files with UTF-8 encoding. In Notepad and Notepad++ you can select the encoding from the drop down dialog at the bottom of the Save window.
 
 ## Roadmap / TODO
 

data/Rakefile

@@ -1,5 +1,6 @@
+# -*- encoding: utf-8 -*-
+
 require 'bundler'
-require 'bundler/gem_tasks'
 begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
@@ -7,26 +8,35 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
-require 'rake/testtask'
+require 'rake'
+require 'rspec'
+require 'rspec/core/rake_task'
+Bundler::GemHelper.install_tasks
 
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/*test*.rb']
-  t.verbose = true
+desc "Run all RSpec test examples"
+task :spec do
+  RSpec::Core::RakeTask.new do |spec|
+    spec.rspec_opts = ["-c", "-f progress"]
+    spec.pattern = 'spec/**/*_spec.rb'
+  end
 end
 
-desc "Push the Gem & Update Sublime Package"
-task :publish do
-  system "git push github master"
-  system "git push wsl master"
+desc "Update Sublime Package"
+task :sublime do
+  begin
+    tag = LegalMarkdown::VERSION
+  rescue
+    require Dir.pwd + "/lib/legal_markdown/version.rb"
+    tag = LegalMarkdown::VERSION
+  end
   Dir.chdir(File.dirname(__FILE__))
-  pkg = ENV['HOME'] + "/.config/sublime-text-2/Packages/Legal Document Creator"
+  pkg = ENV['HOME'] + "/sites/sublime/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."
+  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"
@@ -34,9 +44,8 @@ task :publish do
   Dir.chdir(File.dirname(__FILE__))
 end
 
-# call with rake site:publish
-desc "Publish New Version of Gem"
-task :pushit do
+desc "Publish New Version of Gem & Update Sublime Package"
+task :publish 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
@@ -48,20 +57,8 @@ task :pushit do
   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__))
+  Rake::Task["build"].invoke
   system "google-chrome https://github.com/compleatang/legal-markdown/releases"
 end
 
-task :default => [:test]
+task :default => :spec

data/legal_markdown.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.license           = 'MIT'
 
   s.add_dependency('paint')
+  s.add_development_dependency('rspec')
   s.add_development_dependency('coveralls')
 
   s.description       = <<desc

data/lib/legal_markdown.rb

@@ -21,13 +21,13 @@ module LegalMarkdown
     if args.size >= 1
       caller args, config
     else
-      puts opt_parser
+      puts @opt_parser
     end
 
   end
 
   def self.optsparse args, config
-    opt_parser = OptionParser.new do |opt|
+    @opt_parser = OptionParser.new do |opt|
       optsheaders opt
       optsmarkdown opt, config, args
       optsjason opt, config, args
@@ -36,7 +36,7 @@ module LegalMarkdown
       optsfooters opt
     end
 
-    opt_parser.parse!(args)
+    @opt_parser.parse!(args)
     return args, config
   end
 
@@ -104,7 +104,7 @@ module LegalMarkdown
   def self.optsmakeother opt, config, args
 
     config[:verbose] = false
-    opt.on('--verbose', 'Debug legal_markdown. Only works with output options, not with headers switch.') do
+    opt.on('--debug', 'Debug legal_markdown. **Only works with output options, not with headers switch.**') do
       config[:verbose] = true
     end
 
@@ -114,7 +114,7 @@ module LegalMarkdown
     end
 
     opt.on( '-h', '--help', 'Display this screen at any time.' ) do
-      puts opt_parser
+      puts @opt_parser
       exit
     end
 
@@ -129,6 +129,7 @@ module LegalMarkdown
     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 ""
+    opt
   end
 end
 

data/lib/legal_markdown/legal_to_markdown.rb

@@ -3,6 +3,7 @@ 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/meta.rb'
 require 'legal_to_markdown/writer.rb'
 require 'roman_numerals'
 require 'paint'
@@ -35,6 +36,7 @@ module LegalToMarkdown
     verbose_after_process source, 'mixins'
     source.run_leaders if source.leaders
     verbose_after_process source, 'headers'
+    source.run_meta if source.docinfo
     source.build_jason if source.writer == :jason
     write_it(source.content, source.writer)
   end

data/lib/legal_markdown/legal_to_markdown/json_builder.rb

@@ -50,6 +50,10 @@ module LegalToMarkdown
 
     def build_front_portion
       document_hash = { "document" => { "title" => "", "abstract" => "", "views" => ["content"] }}
+      if @docinfo.is_a?(Hash)
+        document_hash = { "document" => document_hash['document'].merge(@docinfo) }
+      end
+      document_hash
     end
 
     def build_header_and_text_hashs( text_block )

data/lib/legal_markdown/legal_to_markdown/load_source.rb

@@ -3,11 +3,12 @@ module LegalToMarkdown
 
   class FileToParse
 
-    attr_accessor :headers, :content, :mixins, :leaders, :writer
+    attr_accessor :headers, :content, :mixins, :leaders, :docinfo, :writer
 
     def initialize(file, output)
       @input_file = file; @headers = nil; @content = ""; @writer = output
       load; get_the_partials; parse; set_the_parsers
+      @orig_headers = @headers.clone if @headers
     end
 
     private
@@ -56,6 +57,10 @@ module LegalToMarkdown
         self.extend LegalToMarkdown::Leaders
         @leaders = true
       end
+      if @headers && ! @headers.keys.select{|k| k.to_s[/meta/] }.empty?
+        self.extend LegalToMarkdown::Meta
+        @docinfo = true
+      end
       if @writer == :jason
         self.extend LegalToMarkdown::JasonBuilder
       end
@@ -64,8 +69,11 @@ module LegalToMarkdown
     def get_file( file )
       begin
         f = File::read(file)
+        if f[1] == "\u0000" then f = f.force_encoding('utf-16le').encode('utf-8') end
         f.gsub!("\xEF\xBB\xBF".force_encoding("UTF-8"), '')
         f.gsub!("\xC3\xAF\xC2\xBB\xC2\xBF".force_encoding("UTF-8"), '')
+        f.gsub!("\r", '')
+        f.force_encoding("UTF-8")
         f
       rescue => e
         puts "Sorry, I could not read the file #{file}: #{e.message}."

data/lib/legal_markdown/legal_to_markdown/meta.rb

@@ -0,0 +1,43 @@
+module LegalToMarkdown
+  extend self
+
+  module Meta
+
+    def run_meta
+      default_output
+      yaml_output if @writer == :markdown
+      json_output if @writer == :jason
+      no_output
+    end
+
+    def default_output
+      case @writer
+      when :markdown
+        default = 'meta-yaml-output'
+      when :jason
+        default = 'meta-json-output'
+      end
+      if @orig_headers['meta']
+        @orig_headers[default] = @orig_headers['meta']
+        @orig_headers.delete('meta')
+      end
+    end
+
+    def yaml_output
+      if adder = @orig_headers['meta-yaml-output']
+        adder = YAML.dump(adder)
+        @content = adder + "---\n\n" + @content
+      end
+    end
+
+    def json_output
+      if adder = @orig_headers['meta-json-output']
+        @docinfo = adder
+      end
+    end
+
+    def no_output
+      #hook for later processing
+    end
+  end
+end

data/lib/legal_markdown/legal_to_markdown/mixins.rb

@@ -4,7 +4,6 @@ module LegalToMarkdown
   module Mixins
 
     def run_mixins
-      @orig_headers = @headers.clone if @writer == :jason
       clauses_mixins
       text_mixins
       clean_up_mixins

data/lib/legal_markdown/make_yaml_frontmatter.rb

@@ -8,7 +8,7 @@ class MakeYamlFrontMatter
     @output_file = args[-1]
     find_yaml_if_yaml load
     scan_and_filter_yaml
-    build_new_yaml_frontmatter unless @yaml_data_as_array == [{},{},{},{}]
+    build_new_yaml_frontmatter unless @yaml_data_as_array == [{},{},{},{},{}]
     write_it
   end
 
@@ -18,8 +18,11 @@ class MakeYamlFrontMatter
     begin
       source_file = @input_file == "-" ? STDIN.read : File::read(@input_file)
       source_file = guard_partials_start source_file
+      if source_file[1] == "\u0000" then source_file = source_file.force_encoding('utf-16le').encode('utf-8') end
       source_file.gsub!("\xEF\xBB\xBF".force_encoding("UTF-8"), '')
       source_file.gsub!("\xC3\xAF\xC2\xBB\xC2\xBF".force_encoding("UTF-8"), '')
+      source_file.gsub!("\r", '')
+      source_file.force_encoding("UTF-8")
       source_file
     rescue
       puts "Sorry, I could not read the input file #{@input_file}."
@@ -49,15 +52,20 @@ class MakeYamlFrontMatter
     @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}) )
+    @yaml_data_as_array << ( filter_meta )
   end
 
   def build_new_yaml_frontmatter
     @content = "\n---\n\n" + @content
-    replacers = {0=>"Mixins", 1=>"Optional Clauses", 2=>"Structured Headers", 3=>"Properties"}
+    replacers = {0=>"Mixins", 1=>"Optional Clauses", 2=>"Structured Headers", 3=>"Properties", 4=>"Document Meta-Data"}
     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)
+        unless @yaml_data_as_array.index(section) == 4
+          string << sink_it(section)
+        else
+          string << YAML.dump(section).gsub("---\n", '')
+        end
       end
       string
     end
@@ -84,6 +92,17 @@ class MakeYamlFrontMatter
     end
   end
 
+  def filter_meta
+    meta_tags = %w(meta meta-yaml-output meta-json-output meta-no-output)
+    meta_in_yaml = meta_tags.inject({}) do |hash, elem|
+      if @headers.has_key?(elem)
+        hash[elem] = @headers[elem]
+      end
+      hash
+    end
+    meta_in_yaml
+  end
+
   def scan_doc pattern
     found = @content.scan(pattern).uniq.sort.flatten
     if pattern == @structured_headers_pattern

data/lib/legal_markdown/version.rb

@@ -1,3 +1,3 @@
 module LegalMarkdown
-  VERSION = "0.4.10"
+  VERSION = "0.4.11"
 end

data/{test/tests → spec/fixtures}/01.load_partial_no_action.headers

@@ -5,7 +5,7 @@ consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
 cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
 proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 
-@include partials/z.partial1
+@include spec/fixtures/partials/z.partial1
 
 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
 tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,

data/{test/tests → spec/fixtures}/01.load_partial_no_action.lmd

@@ -5,7 +5,7 @@ consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
 cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
 proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 
-@include partials/z.partial1
+@include spec/fixtures/partials/z.partial1
 
 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
 tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,

data/{test/tests → spec/fixtures}/02.load_partials_no_action.headers

@@ -5,7 +5,7 @@ consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
 cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
 proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 
-@include partials/z.partial1
+@include spec/fixtures/partials/z.partial1
 
 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
 tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
@@ -14,7 +14,7 @@ consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
 cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
 proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 
-@include partials/z.partial2
+@include spec/fixtures/partials/z.partial2
 
 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
 tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,

data/{test/tests → spec/fixtures}/02.load_partials_no_action.lmd

@@ -5,7 +5,7 @@ consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
 cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
 proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 
-@include partials/z.partial1
+@include spec/fixtures/partials/z.partial1
 
 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
 tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
@@ -14,7 +14,7 @@ consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
 cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
 proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 
-@include partials/z.partial2
+@include spec/fixtures/partials/z.partial2
 
 Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
 tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,