law_doc 0.1.15

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dfdd33df5942fb08182facdb203f53b222844f0f3be50132ede38383a155fade
+  data.tar.gz: cf991c3177a676c3c91a533eb6ef4318054533c048cc43c659e6789457443fef
+SHA512:
+  metadata.gz: 4bfd6a7b2bbfa183cb37ca7bb82f0a06a2c39b4bbc5db5bcfc521fbdb5cf16980e43ec8878f5176bb112158caf47e01ac574c5551d4c8732696f301760aaec17
+  data.tar.gz: 67c7cfa6dbe9857806c84f47fdb8dd0b634c887157ed08c961602bf9683485361cff0a2a9d4e64fc31ca489c582a72fe8885cdacc3308008d8122ba6c961e313

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/GPATH
+/GRTAGS
+/GTAGS
+/spec/law_doc/sample_macros.out.tex

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in law_doc.gemspec
+gemspec

data/README.org

@@ -0,0 +1,82 @@
+* LawDoc
+
+The ~law_doc~ gem provides classes meant to provide the glue between the ~ydl~
+data language and the ~lawdoc.cls~ LaTeX document class and the ~legal~ style
+files for composing legal documents. Getting ruby code executed as part of LaTeX
+pre-processing is the job of ~erbtex~, itself a ruby command-line that executes
+ruby code embedded in the LaTeX file between delimiters ~{:~ and ~:}~ before
+handing the resulting text off to LaTeX. The ~law_doc~ gem provides objects for
+such things as Person, Lawyer, Party, Court, Case, and Document, as well as
+other lower-level supporting classes such as Email and Phone. These classes know
+how to spit out LaTeX macros suitable for use in a ~lawdoc.cls~ document class.
+The classes can be constructed from the ~YAML~-like ~ydl~ files found in the
+file system simply
+
+All that is needed is a LaTeX document such as the following
+#+BEGIN_EXAMPLE
+\documentclass{lawdoc}
+
+{:=
+require 'law_doc'
+LawDoc.document do
+  title 'Brief in Support of Plaintiff\'s Motion for Summary Judgment'
+  kase Ydl[:cases][:erickson]
+  on_behalf_of 'plaintiffs'
+  signers Ydl[:lawyers][:ded], Ydl[:lawyers][:cjh]
+  sig_date '2015-11-20'
+  server signer
+  service_date sig_date
+end
+:}
+
+\begin{document}
+  \makecaption
+
+  \makefullsignature
+
+  \newpage
+  \makecertificateofservice
+\end{document}
+#+END_EXAMPLE
+
+to activate macros such as ~\makecaption~ that perform the tiresome parts of a
+legal document.
+
+The call to ~LawDoc.document~ defines the current document by reference to a
+Hash called ~Ydl~ of items defined in the ~.ydl~ files found in the file system.
+
+** Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'law_doc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install law_doc
+
+** Usage
+
+TODO: Write usage instructions here
+
+** Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+** Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ddoherty03/law_doc.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'law_doc'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/law_doc.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'law_doc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'law_doc'
+  spec.version       = LawDoc::VERSION
+  spec.authors       = ['Daniel E. Doherty']
+  spec.email         = ['ded@ddoherty.net']
+  spec.summary       = %q{Ruby classes to assist in writing LaTeX legal documents.}
+  spec.description   = <<~DESC
+
+    A set of classes for legal document elements such as Document, Case, Lawyer, Party, Court, Judge, etc.  Made to play
+    well with the ydl and erbtex gems.
+
+  DESC
+
+  spec.homepage      = 'https://github.com/ddoherty03/law_doc'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'fat_core'
+  spec.add_dependency 'activesupport', '~>6.0'
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-doc'
+  spec.add_development_dependency 'debug', '>= 1.0.0'
+end

data/lib/blankable_date.rb

@@ -0,0 +1,239 @@
+# Allow dates to blankify day, month, or year component
+class BlankableDate < Date
+  cattr_accessor :blanks, :valid_styles, :default_style
+
+  self.default_style = :tex_dots
+  self.valid_styles = []
+
+  self.blanks = {}
+  blanks[:tex_dots] = {}
+  blanks[:tex_rules] = {}
+  blanks[:ascii_dots] = {}
+  blanks[:ascii_rules] = {}
+
+  #######################################################################
+  # Set blank styles
+  #######################################################################
+
+  class << self
+    # Use TeX \dotfill macro to represent blanks
+    def set_tex_dots
+      style = :tex_dots
+      valid_styles.push(style)
+      blanks[style][:long] = '\\leavevmode\\hbox to 9em{\\dotfill}}'
+      blanks[style][:medium] = '\\leavevmode\\hbox to 4em{\\dotfill}}'
+      blanks[style][:short] = '\\leavevmode\\hbox to 2em{\\dotfill}}'
+    end
+
+    # Use TeX \hrulefill macro to represent blanks
+    def set_tex_rules
+      style = :tex_rules
+      valid_styles.push(style)
+      blanks[style][:long] = '\\leavevmode\\hbox to 9em{\\hrulefill}}'
+      blanks[style][:medium] = '\\leavevmode\\hbox to 4em{\\hrulefill}}'
+      blanks[style][:short] = '\\leavevmode\\hbox to 2em{\\hrulefill}}'
+    end
+
+    # Use a series of acsii '.' to represent blanks
+    def set_ascii_dots
+      style = :ascii_dots
+      valid_styles.push(style)
+      blanks[style][:long] = '.........'
+      blanks[style][:medium] = '....'
+      blanks[style][:short] = '..'
+    end
+
+    # Use a series of acsii '_' to represent blanks
+    def set_ascii_rules
+      style = :ascii_rules
+      valid_styles.push(style)
+      blanks[style][:long] = '_________'
+      blanks[style][:medium] = '____'
+      blanks[style][:short] = '__'
+    end
+  end
+
+  set_tex_dots
+  set_tex_rules
+  set_ascii_dots
+  set_ascii_rules
+end
+
+class BlankableDate < Date
+  attr_reader :style
+
+  # Initialize a BlankableDate in the same way as Date.new but allow blank
+  # components to be declared with keyword arguments ~blank_day~, ~blank_month~,
+  # and ~blank_year~. By default, none of the components is blank, so a
+  # BlankableDate acts just like a Date. However, when converted to a string
+  # with #strftime, the blank components are replaced with strings representing
+  # blanks.
+  def self.new(year, month, day,
+               blank_day: false,
+               blank_month: false,
+               blank_year: false)
+    obj = super(year, month, day)
+    obj.instance_variable_set(:@day_blank, blank_day)
+    obj.instance_variable_set(:@month_blank, blank_month)
+    obj.instance_variable_set(:@year_blank, blank_year)
+    obj.instance_variable_set(:@style, default_style)
+    obj
+  end
+
+  def self.parse(str)
+    dt = super
+    new(dt.year, dt.month, dt.day)
+  end
+
+  ##########################################################################
+  # Constructors
+  ##########################################################################
+
+  # Return today as a BlankableDate
+  def self.today
+    today = Date.today
+    new(today.year, today.month, today.day)
+  end
+
+  # A date this month with the day blank
+  def self.this_month
+    day = Date.today
+    new(day.year, day.month, day.day).blank_day
+  end
+
+  # A date this year with the month and day blank
+  def self.this_year
+    day = Date.today
+    new(day.year, day.month, day.day)
+      .blank_month
+      .blank_day
+  end
+
+  # A date last month with the day blank
+  def self.last_month
+    day = Date.today - 1.month
+    new(day.year, day.month, day.day).blank_day
+  end
+
+  # A date last year with the month and day blank
+  def self.last_year
+    day = Date.today
+    new(day.year - 1, day.month, day.day)
+      .blank_month
+      .blank_day
+  end
+
+  # A date next month with the day blank
+  def self.next_month
+    day = Date.today + 1.month
+    new(day.year, day.month, day.day)
+      .blank_day
+  end
+
+  # A date next year with the month and day blank
+  def self.next_year
+    day = Date.today
+    new(day.year + 1, day.month, day.day)
+      .blank_month
+      .blank_day
+  end
+
+  #######################################################################
+  # Blanking commands
+  #######################################################################
+
+  # Set the blank style for this BlankableDate.
+  def styled(style)
+    style = style.to_sym
+    unless self.class.valid_styles.include?(style)
+      raise ArgumentError, "invalid style: '#{style}'"
+    end
+    @style = style
+    self
+  end
+
+  # Set the day component blank
+  def blank_day
+    @day_blank = true
+    self
+  end
+
+  # Set the month component blank
+  def blank_month
+    @month_blank = true
+    self
+  end
+
+  # Set the year component blank
+  def blank_year
+    @year_blank = true
+    self
+  end
+
+  #######################################################################
+  # Query blank components
+  #######################################################################
+
+  # Return true if the day is blank
+  def day_blank?
+    @day_blank
+  end
+
+  # Return true if the month is blank
+  def month_blank?
+    @month_blank
+  end
+
+  # Return true if the year is blank
+  def year_blank?
+    @year_blank
+  end
+
+  def any_blank?
+    day_blank? || month_blank? || year_blank?
+  end
+
+  #######################################################################
+  # Formatting
+  #######################################################################
+
+  def strftime(fmt = '%F')
+    # Preserve literal percents
+    fmt = fmt.gsub(/%%/, '<++++>')
+    # Expand combinations
+    fmt = fmt.gsub(/%F/, '%Y-%m-%d') if fmt =~ /%F/
+    fmt = fmt.gsub(/%c/, '%a %b %e %T %Y') if fmt =~ /%c/
+    fmt = fmt.gsub(/%[Dx]/, '%m/%d/%y') if fmt =~ /%[Dx]/
+    fmt = fmt.gsub(/%v/, '%e-%b-%Y') if fmt =~ /%v/
+    fmt = fmt.gsub(/%\+/, '%a %b %e %H:%M:%S %Z %Y') if fmt =~ /%\+/
+    # Replace individual components
+    fmt = fmt.gsub(/%-?[ed]/, short_blank) if day_blank?
+    fmt = fmt.gsub(/%[-_]?m/, short_blank) if month_blank?
+    fmt = fmt.gsub(/%[y]/, short_blank) if year_blank?
+    fmt = fmt.gsub(/%^?[bh]/, medium_blank) if month_blank?
+    fmt = fmt.gsub(/%j/, medium_blank) if day_blank? || month_blank?
+    fmt = fmt.gsub(/%[Y]/, medium_blank) if year_blank?
+    fmt = fmt.gsub(/%^?B/, long_blank) if month_blank?
+    fmt = fmt.gsub(/%^?A/, long_blank) if any_blank?
+    fmt = fmt.gsub(/%^?a/, medium_blank) if any_blank?
+    fmt = fmt.gsub(/%[uw]/, short_blank) if any_blank?
+    fmt = fmt.gsub(/%C/, "#{(year / 100).floor}#{short_blank}") if year_blank?
+    # Restore literal percents
+    fmt = fmt.gsub('<++++>', '%%')
+    super(fmt)
+  end
+
+  private
+
+  def short_blank
+    self.class.blanks[@style][:short]
+  end
+
+  def medium_blank
+    self.class.blanks[@style][:medium]
+  end
+
+  def long_blank
+    self.class.blanks[@style][:long]
+  end
+end

data/lib/law_doc/address.rb

@@ -0,0 +1,49 @@
+module LawDoc
+  class Address
+    attr_reader :street, :city, :state, :zip, :country
+
+    include Comparable
+
+    def initialize(street: nil, streets: nil, city: nil,
+                   state: nil, zip: nil, country: 'United States')
+      street ||= streets
+      case street
+      when String
+        @street = [street.to_s]
+      when Array
+        @street = street.map(&:to_s)
+      end
+      @city = city
+      @state = state
+      @zip = zip.to_s
+      @country = country
+    end
+
+    def to_h
+      { street: street, city: city, state: state, zip: zip, country: country }
+    end
+
+    def <=>(other)
+      to_h <=> other.to_h
+    end
+
+    # Return a TeX string with components separated by sep.
+    def tex_info(sep = ' ')
+      st = nil
+      st = street.map(&:tex_quote) if street && !street.empty?
+      [st, "#{@city.tex_quote}, #{@state.tex_quote} #{@zip.tex_quote}"]
+        .join(sep)
+    end
+
+    # Return a multi-line TeX string
+    def tex_block
+      tex_info("\\\\\n")
+    end
+
+    # Return an in-line TeX string
+    def tex_inline
+      tex_info(', ')
+    end
+    alias to_s tex_inline
+  end
+end