legal_markdown 0.4.4 → 0.4.5

data/.gitignore

@@ -16,3 +16,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+coverage

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 gemspec
 gem 'rake'
+
+group :development, :test do
+  gem 'coveralls', require: false
+end

data/README.md

@@ -1,6 +1,6 @@
 # Status
 
-[![Build Status](https://travis-ci.org/compleatang/legal-markdown.png)](https://travis-ci.org/compleatang/legal-markdown)[![Code Climate](https://codeclimate.com/github/compleatang/legal-markdown.png)](https://codeclimate.com/github/compleatang/legal-markdown)[![Dependency Status](https://gemnasium.com/compleatang/legal-markdown.png)](https://gemnasium.com/compleatang/legal-markdown)
+[![Build Status](https://travis-ci.org/compleatang/legal-markdown.png)](https://travis-ci.org/compleatang/legal-markdown)[![Coverage Status](https://coveralls.io/repos/compleatang/legal-markdown/badge.png?branch=master)](https://coveralls.io/r/compleatang/legal-markdown?branch=master)[![Code Climate](https://codeclimate.com/github/compleatang/legal-markdown.png)](https://codeclimate.com/github/compleatang/legal-markdown)[![Dependency Status](https://gemnasium.com/compleatang/legal-markdown.png)](https://gemnasium.com/compleatang/legal-markdown)
 
 # Introduction
 
@@ -32,7 +32,7 @@ If you install the package there is no need to install the gem, but you will sti
 
 ## How to Use This Gem?
 
-After the gem has finished its installation on your system then you can simply type `$> legal2md [filename]` where the filename is the fileyou want the gem to parse. Legal Markdown will parse the file and output the same filename.
+After the gem has finished its installation on your system then you can simply type `$> legal2md [filename]` where the filename is the file you want the gem to parse. Legal Markdown will parse the file and output the same filename.
 
 If you prefer to output as a different filename (which will allow you to keep the YAML front-matter), then you simply type `$> legal2md [input-filename] [output-filename]`.
 
@@ -79,14 +79,15 @@ In the body of your document you put the entire clause in square-brackets (as yo
 
 In the YAML Front-Matter you simply add "true" or "false" to turn that entire clause on or off. **Note**, if you do not add the mixin to your header, legal_markdown is just going to leave it as is, which is very unlikely to be what you want to see in your output file.
 
-You are able to nest optional clauses inside of other optional clauses. However, if you do so, make sure that you include all of the sub-provisions of the master provision in the YAML matter, else the gem will think that you closed your square brackets too early (which it was probably the closure of a nested clause. If you use the automatic YAML population feature either from the command line (see above) or by using the Sublime package, it will simplify this process for you greatly.
+You are able to nest optional clauses inside of other optional clauses. However, if you do so, make sure that you include all of the sub-provisions of the master provision in the YAML matter, else the gem will think that you closed your square brackets earlier than you thought the nested clause closed. If you use the automatic YAML population feature either from the command line (see above) or by using the Sublime package, it will simplify this process for you greatly.
 
 Another thing to note, if you include nested provisions, you can turn off an inside provision and leave an outside provision on, but if you turn off an outside provision the entire portion will not be produced, even if you turned an inner portion on. Usually, as long as you keep this rule in mind you can draft around it, and it is generally the case that that will be the result that you will want any way.
 
 So, this is how the body of the text would look.
 
-```md
-[{{my_optional_clause}}Both parties agree that upon material breach of this agreement by either party they will both commit suicide in homage to Kurt Cobain.]
+```lmd
+[{{my_optional_clause}}Both parties agree that upon material breach of this agreement by either
+party they will both commit suicide in homage to Kurt Cobain.]
 ```
 
 Then the YAML Front Matter would look like this
@@ -188,7 +189,7 @@ You can easily to that by doing the following steps.
 
 ### Step 1: Type the body
 
-```md
+```lmd
 l. Provision for Article 1.
 ll. Provision for Section 1.1.
 lll. Provision for 1.1.1.
@@ -292,7 +293,7 @@ no-indent: l., ll.
 
 and the body of the text looked like this:
 
-```md
+```lmd
 ...
 ll. |123| This provision will need to be referenced later.
 ll. Provision
@@ -324,11 +325,11 @@ When you are building documents sometime you simply want to put `date: @today`.
 
 ### Citations
 
-At this point legal_markdown does not have a native citation handling ability. For now, I've outsourced that to the primary processor. If you look at pandoc, it has excellent bibtex and citation support that will bluebook up everything for you. Legal Markdown does not get in the way if how pandoc does citations so it is fully compatible.
+At this point legal_markdown does not have a native citation handling ability. For now, I've outsourced that to the primary processor. If you look at pandoc, it has excellent bibtex and citation support that will bluebook up everything for you. Legal Markdown does not get in the way of how pandoc does citations so it is fully compatible.
 
 ## A Few Gotchas
 
-* 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 header portion which is enough to meet my needs - in particular, when matched with Sublime Text snippets. If you area looking for a more complete 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)
+* 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.
 
 ## Roadmap / TODO

data/bin/legal2md

@@ -2,6 +2,10 @@
 #
 # == USAGE
 #  legal2md input_file output_file
-
+if ARGV.size == 1
+  args = [:to_markdown, ARGV.first, ARGV.first]
+else
+  args = ARGV
+end
 require 'legal_markdown'
-LegalMarkdown::parse(ARGV)
+LegalMarkdown::parse(args)

data/legal_markdown.gemspec

@@ -19,7 +19,8 @@ Gem::Specification.new do |s|
   s.require_paths     = ["lib"]
   s.license           = 'MIT'
 
-  # s.add_dependency
+  # s.add_dependency('dependency')
+  s.add_development_dependency('coveralls')
 
   s.description       = <<desc
   This gem will parse YAML Front Matter of Markdown Documents. Typically, this gem would be called with a md renderer, such as Pandoc, that would turn the md into a document such as a .pdf file or a .docx file. By combining this pre-processing with a markdown renderer, you can ensure that both the structured content and the structured styles necessary for your firm or organization are more strictly enforced. Plus you won't have to deal with Word any longer, and every lawyer should welcome that. Why? Because Word is awful.

data/lib/legal_markdown.rb

@@ -8,7 +8,9 @@ require 'optparse'
 module LegalMarkdown
 
   def self.parse(*args)
-    args ||= ARGV.dup
+    if args.size == 1 && args.first.class == Array
+      args = args.first
+    end
 
     config={}
     config[:input] = {}

data/lib/legal_markdown/version.rb

@@ -1,3 +1,3 @@
 module LegalMarkdown
-  VERSION = "0.4.4"
+  VERSION = "0.4.5"
 end

data/test/legal_markdown_test.rb

@@ -1,4 +1,7 @@
-#! ruby
+#!/usr/bin/env ruby
+require 'coveralls'
+Coveralls.wear!
+
 require 'test/unit'
 require 'securerandom'
 require 'json'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: legal_markdown
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.4.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-30 00:00:00.000000000 Z
-dependencies: []
+date: 2013-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ! '  This gem will parse YAML Front Matter of Markdown Documents. Typically,
   this gem would be called with a md renderer, such as Pandoc, that would turn the
   md into a document such as a .pdf file or a .docx file. By combining this pre-processing
@@ -178,7 +194,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2539326547040470176
+      hash: 264622749286327641
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -187,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2539326547040470176
+      hash: 264622749286327641
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25