legal_markdown 0.1.2 → 0.1.3

data/README.md

@@ -20,7 +20,7 @@ After the gem has finished its installation on your system then you can simply t
 
 [YAML](http://www.yaml.org/spec/1.2/spec.html) is about the easiest thing to create. At the top of your file (it MUST be at the top of the file) you simply put in three or more hyphens like so: `---` on a single line. Then on the next line you simply put in the `field` followed by a `:` (colon) followed by the `value`. For each line you put the `[field]: [value]` until you have filled everything in that you need. After you have put in all your YAML front-matter then you simply put in a single line with three more hyphens `---` to signal to the gem that it is the end of the fields. So this would look like this:
 
-    ```yaml
+    ```
     ---
     title: My Perfect Contract
     author: Watershed Legal Services
@@ -36,7 +36,7 @@ The gem will normally strip out the YAML front-matter as most markdown renderers
 
 To leave the YAML front-matter there simply pass the `value` of `true` to the `field` called `leave_yaml_front_matter`; this is how it would look in the above example. 
 
-    ```yaml
+    ```
     ---
     title: My Perfect Contract
     author: Watershed Legal Services
@@ -57,20 +57,20 @@ Mixins are straight-forward they are simple markers that can be used throughout
 
 Mixins are structured in the form of **double curly** brackets (this was taken from IFTTT). So, for a `{{court}}` mixin, the YAML front-matter would look like this:
 
-    ```yaml
+    ```
     {{court}}: Regional Court of Hargeisa
     ```
 
 Mixins can also be used to set up clauses in the alternative in your templates which can be turned on or off within a specific document simply by updating the YAML mixin to false. Example of a `{{provision12a}}{{provision12b}}` alternative structuring for a contract template. Within the template the YAML front-matter would be structured something like this:
 
-    ```yaml
+    ```
     {{provision12a}}: "For the purposes of this Agreement"
     {{provision12b}}: "This Agreement shall"
     ```
 
 Then to chose one of the two provisions you would would simply change the line to "false" but without the quotes. Example:
 
-    ```yaml
+    ```
     {{provision12a}}: false
     ```
 
@@ -82,19 +82,31 @@ In order to address this problem, I have built functionality into legal_markdown
 
 Then you can describe the functionality that you require in the YAML front-matter. In the YAML front-matter you will simply add the following fields: `level-1` and then the `: ` followed by what the format you would like it to be in. Currently there are a few possible options at this time (for those using pandoc at least): 
 
-    1. `level-1: 1.` will format that level of the list as 1. 2. 3. etc.; This is the default functionality; 
-    2. `level-1: (1)` will provide for the same numbering only within parenteticals rather than followed by a period; 
-    3. `level-1: A.` will format with capital letters followed by a period (e.g, A., B., C., etc.);
-    4. `level-1: (A)` will format the same as the above only with the capital letters in a parentetical;
-    5. `level-1: a.` will format with lowercase letters followed by a period;
-    6. `level-1: (a)` will format with lowercase letters within a parentethical;
-    7. `level-1: I.` will format with capital Roman numerals followed by a period;
-    8. `level-1: (I)` will format with capital Roman numerals within a parententical;
-    9. `level-1: i.` will format with lowercase Roman numerals followed by a period;
-    10. `level-1: (i)` will format with lowercase Roman numerals within a parententical..
+1. `level-1: 1.` will format that level of the list as 1. 2. 3. etc.; This is the default functionality; 
+2. `level-1: (1)` will provide for the same numbering only within parenteticals rather than followed by a period; 
+3. `level-1: A.` will format with capital letters followed by a period (e.g, A., B., C., etc.);
+4. `level-1: (A)` will format the same as the above only with the capital letters in a parentetical;
+5. `level-1: a.` will format with lowercase letters followed by a period;
+6. `level-1: (a)` will format with lowercase letters within a parentethical;
+7. `level-1: I.` will format with capital Roman numerals followed by a period;
+8. `level-1: (I)` will format with capital Roman numerals within a parententical;
+9. `level-1: i.` will format with lowercase Roman numerals followed by a period;
+10. `level-1: (i)` will format with lowercase Roman numerals within a parententical..
 
 Obviously you will replace `level-1` with `level-2`, etc. Although this functionality was built into the gem, it is generally not the best practice. A better practice is to let the gem make the replacements and reformat the markdown and then use your rendering system and its default reference documents to set the styles you need. 
 
+## No Reset Function
+
+Sometimes in legal documents (particularly in laws) you want to build multiple structured header levels, but you do not want to reset all of the headers when going up the tree. For example, in some laws you will have Chapters, Parts, Sections, ... and you will want to track Chapters, Parts and Sections but when you go up to Parts you will not want to reset the Sections to one. 
+
+This functionality is built in with a `no-reset` function. You simply add a `no-reset` field to your YAML header and note the headers that you do not want to reset by their l., ll. notation. Separate those levels you do not want reset with commas. Example YAML line:
+
+    ~~~
+    no-reset: l., ll., lll.
+    ~~~
+
+This will not reset level-1, level-2, or level-3 when it is parsing the document and those levels will be numbered sequentially through the entire block rather than reseting when going to a higher block, levels not in this reset, e.g., llll. and lllll. will be reset when going up a level in the tree. Obviously the level 1 headers will never reset.
+
 ## Example
 
 If you use a system like Pandoc you can establish a system wherein the styles that you establish in the reference.docx or reference.odt or the latex style references can make up for the lack of granular fuctionality. When you build your reference.odt for example and you want to have a contract look like this:
@@ -131,7 +143,7 @@ You can easily to that by doing the following steps.
 
 ### Step 2: (Optional) Fill out the YAML Front-Matter
 
-    ```yaml
+    ```
     ---
     title: Wonderful Contract
     author: Your Name
@@ -160,7 +172,7 @@ Then you would save the reference.odt as a new name perhaps contract-reference.o
 
 Now that you've been warned, here's how you use precursors. Within the text of the document nothing changes. In the YAML front matter you will leave it as it was before. All you need to do is add any word or other marker before the trigger. What `legal_markdown` will do is to look at the last two characters if the marker ends in a period or three if it ends in a paren, and then everything else it will place into a precursor. If you want to reference the preceding level (like 1.1.1 in the example above) then simply put in {pre}. I'll try to make this less fragile down the road, but for now it is what it is. So, your YAML front matter will look like this:
 
-    ```yaml
+    ```
     ---
     title: Wonderful Contract
     author: Your Name
@@ -181,21 +193,27 @@ I do not use latex to create pdfs nor do I use Word, but the functionality will
 
 ## A Few Gotchas
 
-You cannot begin the block of structured headers with a second level header. The gem searches the markdown to find a line that begins with `l.` where there is a blank line above it. This is made to be fairly precise so as to ensure that the gem does not strip out some other functionality that you want to build. 
+* When you are using structured headers of legal_markdown you should make the lists tight. Do not add blank lines in between the list levels or the gem will think you are creating a new list. If you are trying to create a new list then by all means go ahead as the blank lines will break the parsing. On the roadmap is functionality for multiple blocks, but at this point in the Gem's development it will only run one block through the modification methods. 
+* If you use the reference.odt or reference.docx to override the default formating of the list then it is not optimal add level-1 or level-2 leading text or utilize the different marker functionality (e.g., (i) or (a) and the like) to the YAML front-matter. The optimal way is to use the defaults that pandoc has or whatever renderer you use along with legal_markdown to set the spacing and then use the reference styles to build the functionality that you would like from the word processor side. The leading text and different marker systems are predominately built for html output.
+* 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)
 
-When you are using structured headers of legal_markdown you should make the lists tight. Do not add blank lines in between the list levels or the gem will think you are creating a new list. If you are trying to create a new list then by all means go ahead as the blank lines will break the parsing. 
+# TODO
 
-Also, if you use the reference.odt or reference.docx to override the default formating of the list then you do not need to add any level-1 or level-2 fields to the YAML front-matter. The best way to do it is to simply use the defaults that pandoc or your renderer will use and then use the reference styles to build the functionality that you would like. 
+[ ] Definitions. For now these can be used as mixins but that functionality needs to improve.
 
-# TODO
+[ ] Make a no-reset option for certain levels that should not reset when moving up the tree.
+
+[ ] Parsing. At this point legal_markdown cannot take a markdown document and parse it to build structured headers. Legal_markdown only works with a renderer to *create* documents but not to *import* documents. I want to build this functionality out at a later date. Legal_markdown is not meant as an importer for files types, there are other tools for that but I would like it to be able to parse text that is already in markdown. 
+
+[ ] Markdown post-processing. This will cure some of the issues (class establishment and proper list nesting of structure documents) that are currently lost when using precurors.
 
-[ ] - Definitions. For now these can be used as mixins but that functionality needs to improve.
+[ ] Different input and output files.
 
-[ ] - Parsing. At this point legal_markdown cannot take a markdown document and parse it to build structured headers. Legal_markdown only works with a renderer to *create* documents but not to *import* documents. I want to build this functionality out at a later date. Legal_markdown is not meant as an importer for files types, there are other tools for that but I would like it to be able to parse text that is already in markdown. 
+[ ] Implement partials.
 
-[ ] - Markdown post-processing. This will cure some of the issues (class establishment and proper list nesting of structure documents) that are currently lost when using precurors.
+[ ] Small capitals based on [Precedent's Syntax](https://github.com/BlackacreLabs/precedent/blob/master/SYNTAX.md).
 
-[ ] - Different input and output files
+[ ] Handle against multiple blocks in a document as this currently will not work.
 
 # Contributing
 

data/Rakefile

@@ -1,34 +1,2 @@
 require "bundler/gem_tasks"
 
-# begin
-#   require "mg"
-#   MG.new("legal_markdown.gemspec")
-# rescue LoadError
-#   nil
-# end
-
-# desc "Build standalone script"
-# task :build => [ :standalone ]
-
-# desc "Build standalone script"
-# task :standalone => :load_legal_markdown do
-#   require 'legal_markdown/standalone'
-#   LegalMarkdown::Standalone.save('legalmd')
-# end
-
-# Rake::TaskManager.class_eval do
-#   def remove_task(task_name)
-#     @tasks.delete(task_name.to_s)
-#   end
-# end
-
-# # Remove mg's install task
-# Rake.application.remove_task(:install)
-
-# desc "Install standalone script"
-# task :install => :standalone do
-#   prefix = ENV['PREFIX'] || ENV['prefix'] || '/usr/local'
-
-#   FileUtils.mkdir_p "#{prefix}/bin"
-#   FileUtils.cp "legalmd", "#{prefix}/bin"
-# end

data/bin/{legalmd → md2legal}

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 #
 # == USAGE
-#  legalmd file.md
+#  md2legal file.md
 
 require 'legal_markdown'
-LegalMarkdown.markdown_preprocess(ARGV)
+LegalMarkdown.markdown_to_legal(ARGV)

data/lib/legal_markdown/version.rb

@@ -1,3 +1,3 @@
 module LegalMarkdown
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/legal_markdown.rb

@@ -7,7 +7,7 @@ require "legal_markdown/version"
 module LegalMarkdown
   extend self
 
-  def markdown_preprocess(*args)
+  def markdown_to_legal(*args)
     # Get the Content & Yaml Data
     data = load(*args)
     parsed_content = parse_file(data[0])
@@ -157,9 +157,9 @@ module LegalMarkdown
         elsif value =~ /\([a-z]\)\z/   # type8 : {{ (a) }}
           return[:type8, value[0..-4]]
         elsif value =~ /\(\d\)\z/      # type9 : {{ (1) }}
-          return[:type9, value[0..-3]]
+          return[:type9, value[0..-4]]
         else value =~ /\d\.\z/         # type0 : {{ 1. }} ... also default
-          return[:type0, value[0..-4]]
+          return[:type0, value[0..-3]]
         end
       end
 
@@ -172,6 +172,10 @@ module LegalMarkdown
           # substitutions hash example {"ll."=>[:type8,"Article"],}
           substitutions[search]= set_the_subs_arrays(value.to_s)
         end
+        if header =~ /no-reset/
+          no_subs_array = value.split(", ")
+          no_subs_array.each{|e| substitutions[e][6] = :no_reset }
+        end
       end
 
       return substitutions
@@ -197,25 +201,35 @@ module LegalMarkdown
       def get_the_subs_arrays( value )
         # returns a new array for the replacements
         if value[0] == :type1       # :type1 : {{ I. }}
-          return[:type1, value[1], "", "I", "."] 
+          value[2..4] = [ "", "I", "." ]
+          return value
         elsif value[0] == :type2    # :type2 : {{ (I) }}
-          return[:type2, value[1], "(", "I", ")"]
+          value[2..4] = [ "(", "I", ")"]
+          return value
         elsif value[0] == :type3    # :type3 : {{ i. }}
-          return[:type3, value[1], "", "i", "."]
+          value[2..4] = [ "", "i", "."]
+          return value
         elsif value[0] == :type4    # :type4 : {{ (i) }}
-          return[:type4, value[1], "(", "i", ")"]
+          value[2..4] = [ "(", "i", ")"]
+          return value
         elsif value[0] == :type5    # :type5 : {{ A. }}
-          return[:type5, value[1], "", "A", "."]
+          value[2..4] = [ "", "A", "."]
+          return value
         elsif value[0] == :type6    # :type6 : {{ (A) }}
-          return[:type6, value[1], "(", "A", ")"]
+          value[2..4] = [ "(", "A", ")"]
+          return value
         elsif value[0] == :type7    # :type7 : {{ a. }}
-          return[:type7, value[1], "", "a", "."]
+          value[2..4] = [ "", "a", "."]
+          return value
         elsif value[0] == :type8    # :type8 : {{ (a) }}
-          return[:type8, value[1], "(", "a", ")"]
+          value[2..4] = [ "(", "a", ")"]
+          return value
         elsif value[0] == :type9    # :type9 : {{ (1) }}
-          return[:type9, value[1], "(", "1", ")"]
+          value[2..4] = [ "(", "1", ")"]
+          return value
         else value[0] == :type0     # :type0 : {{ 1. }} ... also default
-          return[:type0, value[1], "", 1, "."]
+          value[2..4] = [ "", 1, "."]
+          return value
         end
       end
 
@@ -258,11 +272,13 @@ module LegalMarkdown
         leaders_to_reset = []
         hash_of_subs.each_key{ |k| leaders_to_reset << k if k > selector }
         leaders_to_reset.each do | leader |
-          unless hash_of_subs[leader][5] == :pre
-            hash_of_subs[leader]= get_the_subs_arrays(hash_of_subs[leader])
-          else
-            hash_of_subs[leader]= get_the_subs_arrays(hash_of_subs[leader])
-            hash_of_subs[leader]= pre_setup(hash_of_subs[leader])
+          unless hash_of_subs[leader][6] == :no_reset
+            unless hash_of_subs[leader][5] == :pre
+              hash_of_subs[leader]= get_the_subs_arrays(hash_of_subs[leader])
+            else
+              hash_of_subs[leader]= get_the_subs_arrays(hash_of_subs[leader])
+              hash_of_subs[leader]= pre_setup(hash_of_subs[leader])
+            end
           end
         end
         return hash_of_subs
@@ -285,7 +301,7 @@ module LegalMarkdown
         new_block = ""
         leader_before = ""
         leader_above = ""
-        selector_before = ""
+        selector_before = "" 
         old_block.each_line do | line | 
           selector = $1.chop if line =~ /(^l+.\s)/ 
           sub_it = substitutions[selector]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: legal_markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-21 00:00:00.000000000 Z
+date: 2013-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: roman-numerals
@@ -36,7 +36,7 @@ description: ! "  This gem will parse YAML Front Matter of Markdown Documents. T
   that. Why? Because Word is awful. \n"
 email: caseykuhlman@watershedlegal
 executables:
-- legalmd
+- md2legal
 extensions: []
 extra_rdoc_files: []
 files:
@@ -45,7 +45,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/legalmd
+- bin/md2legal
 - legal_markdown.gemspec
 - lib/legal_markdown.rb
 - lib/legal_markdown/version.rb
@@ -63,7 +63,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2506371109805164331
+      hash: 1157519025930477197
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -72,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2506371109805164331
+      hash: 1157519025930477197
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25