ydl 0.2.06

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 65a1dba2219dd34c0d14ae1bd509e453b4b9f4edb2965320150bc9a40b612887
+  data.tar.gz: 938b868e021730cf50941ec0dc4af022911e550db5b814f32782bc52b079cb40
+SHA512:
+  metadata.gz: 83500294f866584f4a2b0c0800104a2b961629e436239a5d61a11b19c3d55d3f950a4f3ac67ec70b2c357c437e45c94eb4128a9d57cd9a9e0233b36ec122089d
+  data.tar.gz: 9cd25bae84a0241f5f37a4c6bf3430f653d0140ee049c0354599dbd066626b503da4a0a34fd5615b1e568945691ff68bd400050656e43a2a9855c9e0c649d809

data/.gitignore

@@ -0,0 +1,23 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/GPATH
+/GRTAGS
+/GTAGS
+*synctex.gz
+examples/*.idx
+examples/*.ilg
+examples/*.ind
+examples/*.pdf
+examples/_region_*
+/examples/brief.out
+.local/
+.lesshst

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5
+  - 2.6

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    ydl (0.2.06)
+      activesupport (~> 6.0)
+      fat_core
+      psych
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.4.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    damerau-levenshtein (1.3.3)
+    debug (1.4.0)
+      irb (>= 1.3.6)
+      reline (>= 0.2.7)
+    diff-lcs (1.5.0)
+    fat_core (4.9.2)
+      activesupport
+      damerau-levenshtein
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    io-console (0.5.11)
+    irb (1.4.1)
+      reline (>= 0.3.0)
+    law_doc (0.1.15)
+      activesupport (~> 6.0)
+      fat_core
+    method_source (1.0.0)
+    minitest (5.15.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-doc (1.2.0)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    psych (4.0.3)
+      stringio
+    rake (13.0.6)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    stringio (3.0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
+    zeitwerk (2.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  debug (>= 1.0.0)
+  law_doc (>= 0.1.15)
+  pry
+  pry-doc
+  rake
+  rspec (~> 3.0)
+  ydl!
+
+BUNDLED WITH
+   2.3.4

data/README.org

@@ -0,0 +1,208 @@
+* Ydl
+
+Ydl provides a way to supply a ruby app with initialized objects by allowing
+the user to supply the data about the objects in a hierarchical series of
+"data definition files" with the extension ~.ydl~. In particular, the ~ydl~
+command ~Ydl.load~ finds all files with the extension ~.ydl~ in the following
+locations and uses the data in them to instantiate ~Ruby~ objects:
+
+1. all ~.ydl~ files a configurable system-wide directory, by default ~/etc/ydl~
+2. all ~.ydl~ files in the user's directory ~/home/user/.ydl~ and all
+   directories under that directory, recursively, and
+3. all ~.ydl~ files in each directory starting at the user's home directory
+   (or the root directory if the current directory is not directly or
+   indirectly underneath the user's home directory) and continuing to the
+   current working directory,
+
+After calling ~Ydl.load~, you can access all the objects described by the
+~.ydl~ files from a hierarchical tree of nested hashes via the global hash
+Ydl.data[<key] (or, more concisely, ~Ydl[<key]~).
+
+The ~.ydl~ files are in YAML format, with a couple of twists. One twist is
+that you can use cross-references of the form ~ydl:/path/to/other/node~ to set
+the value of one node to its value at another place in the data hierarchy. The
+second twist is that nodes having names of classes that you specify in your
+config are automatically instantiated into Ruby objects of that class and made
+available in the ~ydl~ data tree.
+
+** Installation
+
+Add this line to your application's Gemfile:
+#+BEGIN_SRC ruby
+  gem 'ydl'
+#+END_SRC
+
+And then execute:
+
+#+BEGIN_SRC shell
+  $ bundle
+#+END_SRC
+
+Or install it yourself as:
+
+#+BEGIN_SRC shell
+  $ gem install ydl
+#+END_SRC
+
+** Usage
+
+Ydl allows you to build a Hash, available as ~Ydl.data~, containing all the
+items defined in the data definition files:
+
+#+BEGIN_SRC ruby
+  require 'ydl'
+
+  Ydl.load
+  Ydl.data.class     #=> Hash
+  Ydl.data[:persons] #=> { joe: {....}, mary: {....} }
+  Ydl.data[:lawyers] #=> { anne: {....}, will: {....} }
+#+END_SRC
+
+You can load only files with a given base name.  ~Ydl.load~ then returns a Hash
+just of the objects from files with the given base name, but also adds them to
+the global ~Ydl.data~ variable as well.
+
+#+BEGIN_SRC ruby
+  require 'ydl'
+
+  people = Ydl.load('persons')
+  people.class        #=> Hash
+  people              #=> { joe: {....}, mary: {....} }
+  people[:joe].class  #=> Person
+  Ydl.data[:persons][:joe].class  #=> Person
+
+  lawyers = Ydl.load('lawyers')
+  lawyers.class        #=> Hash
+  lawyers              #=> { will: {....}, anne: {....} }
+  lawyers[:will].class  #=> Lawyer
+  Ydl.data[:lawyers][:will].class  #=> Lawyer
+#+END_SRC
+
+*** Data Definition Files
+
+The data definition files have the extension ~.ydl~ and are read from the
+following places:
+
+- from a system wide directory that is by default, ~/etc/ydl~, including all its
+  subdirectories,
+- from a user-specific directory in the user's HOME directory that is by
+  default, =~/.ydl=, including all its subdirectories,
+- in the current working directory and all directories above the current
+  directory up to the user's home directory or the root directory, whichever it
+  hits first.
+
+The data definitions are read in the same order given above, except that the
+third category reads files in the HOME directory first, then in each directory
+from there to the current directory in order. In other words, directories closer
+to the current directory take priority over those higher up in the directory
+hierarchy.
+
+In each case, all files with the extension '.ydl' are read and /only/ those
+files. Definitions in files read later are merged into those read earlier,
+overwriting any data having the same key or appending to array data having the
+same key.
+
+The base name of each file is used as an outer key for the contents of the file.
+For example, a file ~'persons.ydl'~ in the current directory will be treated as
+the value of a Hash with the key ~:persons~.
+
+*** Automatic Instantiation of Classes
+
+If, when the files are read in, there is a class whose name is the camelized and
+singularized version of a hash key, and if the value of that key is itself a
+hash, an instance of the class is initialized using the hash values as
+initializers. So if there is a class defined whose last component is Person, the
+contents of the file ~person.ydl~ will instantiate objects of that class. This
+process is recursive, so values that are hashes with keys matching class names
+are instantiated as well. If there is more than one such class, an exception is
+raised.
+
+You can restrict the classes searched for by setting the ~class_modules~ config
+setting to a string or a list of strings of class prefixes to be consulted. If
+~class_modules~ is set to 'Company::Engineers', only the class
+~Company::Engineers::Person~ will be instantiated for objects under the
+~:persons~ hierarchy.  By default all modules will be consulted.
+
+In order for this to work, the initialize method for the classes must be able to
+take a Hash as an argument to ~.new~. A different initializer method can be
+specified for each class with the ~class_init~ option in the configuration file.
+
+If no class is found, the item is left as a Hash.
+
+*** Cross References
+
+String values can have the form ~ydl:/person/smith/address/city~ or
+~ydl:person/smith/address/city~ (the presence of the leading '/' is optional
+and has no meaning), that is, the 'ydl:' specifier followed by a "data path",
+much like a file name path, will, upon resolution, look up the value of the
+given item and return it as the value of that element. Resolution of ~ydl:~
+elements is deferred until all files have been read in so that forward
+references are possible. However, ~Ydl~ will not look outside the files being
+loaded to find a cross-reference, so if you selectively load files, you may
+not be able to resolve some cross-references.  Circular cross-references raise
+a ~Ydl::CircularReference~ error.
+
+*** Configuration
+
+Ydl looks for a configuration file in ~.ydl/config.yaml~ of your ~HOME~
+directory.  Here is the sample configuration that explains the options
+available:
+
+#+BEGIN_EXAMPLE
+# You can set the system-wide ydl directory here; otherwise it defaults to
+# /usr/local/share/ydl.
+
+# system_ydl_dir: /usr/local/share/ydl
+
+# For automatic instantiation, search for classes prefixed by the given modules
+# in the order given. For example, if the key 'breed' is to be instantiated, you
+# can restrict the search for classes named 'Breed' only in modules, 'Dog' and
+# 'Cat' with this:
+#
+#   class_modules:
+#     - Dog
+#     - Cat
+#
+# then, only Dog::Breed and Cat::Breed will be searched for an existing breed
+# class. Otherwise, any class ending in Breed could be used, and they will be
+# searched in alphabetical order, and the first found will be used.
+#
+# A blank value means to consider classes in the main, global module level. You
+# can always disambiguate the class selected with the class_map option below.
+
+class_modules:
+  -
+  - LawDoc
+  - Company::Employee
+
+# By default, each key will be camelized and singularized to find the matching
+# class. So, the key 'dogs' will look for a class named 'Dog', and 'dog_faces'
+# will look for a class 'DogFace'. You can override this heuristic here by
+# saying exactly which class a given key should map to.
+class_map:
+  address: LawDoc::Address
+  persons: LawDoc::Person
+  fax: LawDoc::Phone
+
+# Specify constructors for classes whose .new method will not take a Hash as an
+# argument to initialize the class.
+class_init:
+  LawDoc::Person: from_hash
+#+END_EXAMPLE
+
+** 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/ydl.

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,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'ydl'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+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/examples/brief.tex

@@ -0,0 +1,43 @@
+\documentclass[sign]{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
+:}
+
+% \overfullrule=10pt
+% \geometry{showframe}
+\begin{document}
+  \maketitlepage
+
+  \makefullcaption
+
+  \makecaption
+
+  \section{Our Lawyers}
+
+  \makeourlawyersblock
+
+  \section{Their Lawyers}
+
+  \maketheirlawyersblock
+
+  \section{Full Signature}
+
+  \makefullsignature
+
+  \section{Signature}
+
+  \makesignature
+
+  \makecertificateofservice
+\end{document}

data/examples/cases.ydl

@@ -0,0 +1,79 @@
+erickson:
+  court: ydl:/courts/sdny
+  judge: ydl:/judges/forrest
+  number: 14-CV-09061
+  parties:
+    -
+      person: ydl:/persons/lag
+      role: Plaintiff
+      lawyer:
+        - ydl:/lawyers/ded
+        - ydl:/lawyers/cjh
+    -
+      person: ydl:/persons/revive
+      role: Plaintiff
+      lawyer:
+        - ydl:/lawyers/ded
+        - ydl:/lawyers/cjh
+    -
+      person: ydl:/persons/erickson
+      role: Nominal Defendant
+      lawyers:
+        - ydl:/lawyers/dclarke
+        - ydl:/lawyers/jclarke
+    -
+      name: Quinn Morgan
+      role: Defendant
+      address:
+        street:
+          - 60 East 42nd Street
+          - Suite 1400
+        city: New York
+        state: NY
+        zip: 10165
+      lawyers:
+        - ydl:/lawyers/rjones
+        - ydl:/lawyers/mcrisp
+        - ydl:/lawyers/tfarrell
+    -
+      name: ZM Private Equity Fund I
+      role: Defendant
+      address:
+        street:
+          - c/o Corporation Service Company
+          - 2711 Centerville Rd, Suite 400
+        city: Wilmington
+        state: DE
+        zip: 19808
+      lawyers:
+        - ydl:/lawyers/rjones
+        - ydl:/lawyers/mcrisp
+        - ydl:/lawyers/tfarrell
+    -
+      name: ZM Private Equity Fund II
+      role: Defendant
+      address:
+        street:
+          - c/o Corporation Service Company
+          - 2711 Centerville Rd, Suite 400
+        city: Wilmington
+        state: DE
+        zip: 19808
+      lawyers:
+        - ydl:/lawyers/rjones
+        - ydl:/lawyers/mcrisp
+        - ydl:/lawyers/tfarrell
+    -
+      name: ZM EAC LLC
+      role: Defendant
+      address:
+        street:
+          - 60 East 42nd Street
+          - Suite 1400
+        city: New York
+        state: NY
+        zip: 10165
+      lawyers:
+        - ydl:/lawyers/rjones
+        - ydl:/lawyers/mcrisp
+        - ydl:/lawyers/tfarrell

data/examples/header.rb

@@ -0,0 +1,12 @@
+require 'law_doc'
+require 'pry'
+
+LawDoc.document do
+  title 'Brief in Support of Plaintiff\'s Motion for Summary Judgment'
+  kase Ydl[:cases][:erickson]
+  on_behalf_of 'plaintiffs', 'nominal'
+  signer Ydl[:lawyers][:ded]
+  sig_date '2015-11-20'
+  server signer
+  service_date sig_date
+end

data/examples/lawyers.ydl

@@ -0,0 +1,65 @@
+dclarke:
+  name: David Clarke
+  sex: male
+  address:
+    street:
+      - DLA Piper LLP (US)
+      - 500 Eighth Street NW
+    city: Washington
+    state: DC
+    zip: 20004
+  email: david.clarke@dlapiper.com
+
+jclarke:
+  name: John J. Clarke
+  sex: male
+  address:
+    street:
+      - DLA Piper LLP (US)
+      - 1251 Avenue of the Americas
+    city: New York
+    state: NY
+    zip: 10020
+  email: john.clarke@dlapiper.com
+
+rjones:
+  sex: male
+  name: Robert G. Jones
+  address:
+    street:
+      - Ropes & Gray LLP
+      - 800 Boylston Street
+    city: Boston
+    state: MA
+    zip: 02199
+    phone: 617-951-7000
+    fax: 617-951-7050
+    email: robert.jones@ropesgray.com
+
+mcrisp:
+  sex: male
+  name: Martin J. Crisp
+  address:
+    street:
+      - Ropes & Gray LLP
+      - 1211 Avenue of the Americas
+    city: New York
+    state: NY
+    zip: 10036-8704
+  phone: 212-596-9000
+  fax: 212-596-9090
+  email: martin.crisp@ropesgray.com
+
+tfarrell:
+  sex: male
+  name: Timothy R. Farrell
+  address:
+    street:
+      - Ropes & Gray LLP
+      - 191 North Wacker Drive, 32nd Floor
+    city: Chicago
+    state: IL
+    zip: 60606
+  email: Timothy.Farrell@ropesgray.com
+  phone: 312-845-1209
+  fax: 312-845-5569

data/examples/mwe.tex

@@ -0,0 +1,67 @@
+\documentclass{article}
+
+\usepackage{array}
+\usepackage{longtable}
+\usepackage{calc}
+
+\begin{document}
+
+% A bit less than half the page width
+\newlength{\halfwd}
+\setlength{\halfwd}{((\textwidth) * \real{0.95} - \columnsep)/2}%
+
+% A longtable that I want as one of the page components
+\def\lt{%
+  \setlength\extrarowheight{12pt}%
+  \begin{longtable}{cc}%
+    \parbox[t]{\halfwd}{%
+    11111111111111111\\
+    11111111111111111111\\
+    11111111111111111111}&
+    \parbox[t]{\halfwd}{22222222222222222222\\
+    22222222222222222\\
+    22222222222222222222}\\
+
+    \parbox[t]{\halfwd}{33333333333333333333\\
+    33333333333333333333\\
+    33333333333333333333}&
+    \parbox[t]{\halfwd}{44444444444444444444\\
+    44444444444444444444\\
+    44444444444444444444}\\
+
+    \parbox[t]{\halfwd}{55555555555555555555\\
+    55555555555555555555\\
+    55555555555555555555}&
+    \parbox[t]{\halfwd}{66666666666666666666\\
+    66666666666666666666\\
+    66666666666666666666}\\
+  \end{longtable}
+}
+
+% I expect each part of the page to be equally spaced and all the parts together
+% to fill up the whole page.
+  \begin{center}
+    \hrule
+    Part I
+
+    \vfill
+    \hrule
+    \vfill
+    Part II
+
+    \vfill
+    \hrule
+    \vfill
+
+    Part III
+
+    {\ttfamily \lt}
+    \vfill
+    \hrule
+    \vfill
+    Part IV
+
+    \vfill
+    \hrule
+  \end{center}
+\end{document}

data/examples/persons.ydl

@@ -0,0 +1,10 @@
+erickson:
+  name: Erickson Incorporated
+  address:
+    street:
+      - c/o The Corporation Trust Company
+      - Corporation Trust Center
+      - 1209 Orange St.
+    city: Wilmington
+    state: DE
+    zip: 19801

data/examples/simple.tex

@@ -0,0 +1,23 @@
+\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
+
+  \makesignature
+
+  \newpage
+  \makecertificateofservice
+\end{document}