ydl 0.2.06

data/spec/example_files/home/user/project/subproject/lawyers.ydl

@@ -0,0 +1,85 @@
+# This is a comment
+ded:
+  address:
+    street:
+      - Commerce Plaza I
+      - 7300 W. 110th Street, Suite 930
+  phone: 913-488-3342
+  bar_numbers:
+    NY: "DD-2145"
+
+rjones:
+  sex: male
+  last: Jones
+  first: Robert
+  middle: G.
+  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
+  last: Crisp
+  first: Martin
+  middle: J.
+  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
+  last: Farrell
+  first: Timothy
+  middle: R.
+  address:
+    street:
+      - Ropes & Gray LLP
+      - 191 North Wacker Drive, 32nd Floor
+    city: Chicago
+    state: IL
+    zip: "60606"
+  phone: 312-845-1209
+  fax: 312-845-5569
+  email: Timothy.Farrell@ropesgray.com
+
+dclarke:
+  sex: male
+  last: Clarke
+  first: David
+  address:
+    street:
+      - DLA Piper LLP (US)
+      - 1251 Avenue of the Americas
+    city: New York
+    state: NY
+    zip: "10020"
+  phone: 212-335-4500
+  email: john.clarke@dlapiper.com
+
+jclarke:
+  sex: male
+  last: Clarke
+  first: David
+  address:
+    street:
+      - DLA Piper LLP (US)
+      - 500 Eighth Street NW
+    city: Washington
+    state: DC
+    zip: "20004"
+  phone: 202-799-4000
+  email: david.clarke@dlapiper.com

data/spec/example_files/home/user/project/subproject/persons.ydl

@@ -0,0 +1,55 @@
+zmpef1:
+  sex: entity
+  name: ZM Private Equity Fund I, L.P.
+  address:
+    street:
+      - c/o Corporation Service Company
+      - 2711 Centerville Rd, Suite 400
+    city: Wilmington
+    state: DE
+    zip: '19808'
+
+zmpef2:
+  sex: entity
+  name: ZM Private Equity Fund II, L.P.
+  address:
+    street:
+      - c/o Corporation Service Company
+      - 2711 Centerville Rd, Suite 400
+    city: Wilmington
+    state: DE
+    zip: '19808'
+
+morgan:
+  sex: male
+  first: Quinn
+  last: Morgan
+  address:
+    street:
+      - 60 East 42nd Street
+      - Suite 1400
+    city: New York
+    state: NY
+    zip: 10165
+
+erickson:
+  sex: entity
+  name: Erickson Incorporated
+  address:
+    street:
+      - c/o The Corporation Trust Company
+      - Corporation Trust Center, 1209 Orange Street
+    city: Wilmington
+    state: DE
+    zip: '19801'
+
+zmeac:
+  sex: entity
+  name: ZM EAC LLC
+  address:
+    street:
+      - 60 East 42nd Street
+      - Suite 1400
+    city: New York
+    state: NY
+    zip: 10165

data/spec/example_files/sys/ydl/constants.ydl

@@ -0,0 +1 @@
+pi: 3.14159

data/spec/example_files/sys/ydl/junk.ydl

@@ -0,0 +1 @@
+

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+require 'bundler/setup'
+require 'ydl'
+
+require 'pry'
+require 'debug'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  # The following sets up a mock-up of a file system to use for testing under
+  # the project's spec/example_files directory.  It copies the configuration
+  # template file to a configuration file that changes where the system ydl
+  # directory is to be found.
+  begin_cwd = Dir.pwd
+  begin_home = ENV['HOME']
+  spec_sys_dir = File.join(__dir__, 'example_files', 'sys')
+  spec_home_dir = File.join(__dir__, 'example_files', 'home', 'user')
+  spec_project_dir = File.join(spec_home_dir, 'project', 'subproject')
+  cfg_template = File.join(spec_home_dir, '.ydl', 'config_template.yaml')
+  cfg_file = File.join(spec_home_dir, '.ydl', 'config.yaml')
+
+  config.before(:suite) do
+    # FileUtils.cp_r(spec_sys_dir, tmp_dir)
+    FileUtils.cp(cfg_template, cfg_file)
+    File.open(cfg_file, 'a') do |f|
+      cfg_line = <<-EOS
+
+system_ydl_dir: #{spec_sys_dir}
+
+      EOS
+      f.write(cfg_line)
+    end
+    ENV['HOME'] = spec_home_dir
+    ENV['YDL_CONFIG_FILE'] = cfg_file
+    Dir.chdir(spec_project_dir)
+  end
+
+  config.after(:suite) do
+    FileUtils.rm_rf(cfg_file)
+    # FileUtils.rm_rf(tmp_sys)
+    ENV['HOME'] = begin_home
+    Dir.chdir(begin_cwd)
+  end
+
+  config.before(:suite) do
+    @save_err = $stderr
+    @err = File.new(File.join(__dir__, 'error.out'), 'w', textmode: true)
+    $stderr = @err
+  end
+end

data/spec/ydl_error_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+RSpec.describe Ydl do
+  before :all do
+    require 'law_doc'
+  end
+
+  describe 'load ydl_file with errors' do
+    it 'shows file where error occurred' do
+      expect {
+        Ydl.load_file('../../../../err/person_err.ydl')
+      }.to raise_error Ydl::UserError, /person_err.*line.*column/
+    end
+  end
+end

data/spec/ydl_spec.rb

@@ -0,0 +1,184 @@
+require 'spec_helper'
+
+RSpec.describe Ydl do
+  before :all do
+    require 'law_doc'
+  end
+
+  it 'has a version number' do
+    expect(Ydl::VERSION).not_to be nil
+  end
+
+  describe 'ydl_files' do
+    it 'finds all ydl files' do
+      ydls = Ydl.ydl_files
+      expect(ydls.size).to be > 5
+      # The last element ought to contain the name of the cwd.
+      expect(ydls.last).to match(/subproject/)
+    end
+
+    it 'can ignore ydl files by string' do
+      all_ydls = Ydl.ydl_files
+      some_ydls = Ydl.ydl_files(ignore: 'lawyers')
+      expect(all_ydls.size).to be > some_ydls.size
+      expect(all_ydls.any? { |n| n =~ /lawyer/ }).to be true
+      expect(some_ydls.any? { |n| n =~ /lawyer/ }).to be false
+      expect((all_ydls - some_ydls).all? { |n| n =~ /lawyer/ }).to be true
+    end
+
+    it 'can ignore ydl files by regexp' do
+      all_ydls = Ydl.ydl_files
+      some_ydls = Ydl.ydl_files(ignore: /law/)
+      expect(all_ydls.size).to be > some_ydls.size
+      expect(all_ydls.any? { |n| n =~ /lawyer/ }).to be true
+      expect(some_ydls.any? { |n| n =~ /lawyer/ }).to be false
+      expect((all_ydls - some_ydls).all? { |n| n =~ /lawyer/ }).to be true
+    end
+
+    it 'can ignore ydl files by array of string and regexp' do
+      all_ydls = Ydl.ydl_files
+      some_ydls = Ydl.ydl_files(ignore: ['courts', /law/])
+      expect(all_ydls.size).to be > some_ydls.size
+      expect(all_ydls.any? { |n| n =~ /lawyer|court/ }).to be true
+      expect(some_ydls.any? { |n| n =~ /lawyer|court/ }).to be false
+      expect((all_ydls - some_ydls).all? { |n| n =~ /lawyer|court/ }).to be true
+    end
+  end
+
+  describe 'class instantiation' do
+    it 'should be able to find candidate classes within any module' do
+      cnds = Ydl.candidate_classes(:set)
+      expect(cnds.size).to be > 3
+      expect(cnds).to include(Set)
+      expect(cnds).to include(Psych::Set)
+      expect(cnds).to include(RSpec::Core::Set)
+    end
+
+    it 'should be able to find candidate classes within modules as string' do
+      cnds = Ydl.candidate_classes(:set, 'Psych')
+      expect(cnds.size).to eq(1)
+      expect(cnds).to include(Psych::Set)
+
+      cnds = Ydl.candidate_classes(:set, ',Psych, RSpec::Core')
+      expect(cnds.size).to eq(3)
+      expect(cnds).to include(Set)
+      expect(cnds).to include(Psych::Set)
+      expect(cnds).to include(RSpec::Core::Set)
+    end
+
+    it 'should find candidate_classes with modules as array' do
+      cnds = Ydl.candidate_classes(:set, ['', 'Psych'])
+      expect(cnds.size).to eq(2)
+      expect(cnds).to include(Set)
+      expect(cnds).to include(Psych::Set)
+    end
+
+    it 'should know how to map keys to classes' do
+      Ydl.read_config
+      expect(Ydl.class_map(:persons)).to eq(LawDoc::Person)
+      expect(Ydl.class_map(:address)).to eq(LawDoc::Address)
+      expect(Ydl.class_map(:junk)).to be nil
+    end
+
+    it 'should know init method for classes' do
+      Ydl.read_config
+      # expect(Ydl.class_init('LawDoc::Person')).to eq(:from_hash)
+      expect(Ydl.class_init('LawDoc::Address')).to eq(:new)
+    end
+  end
+
+  describe 'selective load' do
+    before :all do
+      @people = Ydl.load('persons')
+      @lawyers = Ydl.load('lawyers')
+    end
+
+    it 'should return a merged Hash keyed by symbols' do
+      expect(@people.class).to eq(Hash)
+      expect(@people.class).to eq(Hash)
+      expect(@people[:revive].class).to eq(LawDoc::Person)
+      expect(@people.keys.sort)
+        .to eq(%i[erickson mainstreet mdg morgan revive tdoherty zmeac zmpef1 zmpef2])
+
+      expect(@lawyers.class).to eq(Hash)
+      expect(@lawyers.class).to eq(Hash)
+      expect(@lawyers[:ded].class).to eq(LawDoc::Lawyer)
+      expect(@lawyers.keys.sort)
+        .to eq(%i[cjh dclarke ded jclarke mcrisp pittenger rjones tfarrell])
+    end
+
+    it 'should resolve cross references' do
+      expect(@people[:erickson].name).to eq('Erickson Incorporated')
+      expect(@lawyers[:ded].last).to eq('Doherty')
+    end
+
+    it 'should instantiate all persons' do
+      klasses = { persons: 'LawDoc::Person' }
+      klasses.each_pair do |sym, kls|
+        Ydl[sym].each_pair do |_nm, obj|
+          expect(obj.class.name).to eq(kls)
+        end
+      end
+    end
+
+    it 'should instantiate all lawyers' do
+      klasses = { lawyers: 'LawDoc::Lawyer' }
+      klasses.each_pair do |sym, kls|
+        Ydl[sym].each_pair do |_nm, obj|
+          expect(obj.class.name).to eq(kls)
+        end
+      end
+    end
+
+    it 'should allow access through Ydl[]' do
+      expect(Ydl.data[:persons].class).to eq(Hash)
+      expect(Ydl[:persons].class).to eq(Hash)
+      expect(Ydl.data[:lawyers].class).to eq(Hash)
+      expect(Ydl[:lawyers].class).to eq(Hash)
+    end
+  end
+
+  describe 'load everything' do
+    before :all do
+      @hsh = Ydl.load
+    end
+
+    it 'should return a merged Hash keyed by symbols' do
+      expect(@hsh.class).to eq(Hash)
+      expect(Ydl.data.class).to eq(Hash)
+      expect(Ydl.data[:lawyers][:ded].class).to eq(LawDoc::Lawyer)
+      expect(Ydl.data.keys.sort)
+        .to eq(%i[cases constants courts judges junk lawyers persons])
+    end
+
+    it 'should resolve cross references' do
+      expect(Ydl[:cases][:erickson].parties.first.lawyers.first.last)
+        .to eq('Doherty')
+    end
+
+    it 'should instantiate all objects' do
+      klasses = { cases: 'LawDoc::Case', courts: 'LawDoc::Court',
+                  judges: 'LawDoc::Judge', lawyers: 'LawDoc::Lawyer',
+                  persons: 'LawDoc::Person' }
+      klasses.each_pair do |sym, kls|
+        Ydl[sym].each_value do |obj|
+          expect(obj.class.name).to eq(kls)
+        end
+      end
+    end
+
+    it 'should include court in mainstreet case' do
+      mainstreet = Ydl[:cases][:mainstreet]
+      expect(mainstreet.court.state).to eq('KS')
+    end
+
+    it 'should allow access through []' do
+      expect(Ydl[:lawyers].class).to eq(Hash)
+      expect(Ydl[:lawyers][:ded].class).to eq(LawDoc::Lawyer)
+      expect(Ydl[:lawyers][:ded].address.class).to eq(LawDoc::Address)
+      ad = Ydl[:cases][:erickson].parties.first.lawyers.first.address
+      expect(ad.class).to eq(LawDoc::Address)
+      expect(ad.city).to eq('Overland Park')
+    end
+  end
+end

data/yaml_v_psych.rb

@@ -0,0 +1,15 @@
+#! /usr/bin/env ruby
+
+require 'benchmark'
+require 'yaml'
+require 'psych'
+require 'ydl'
+
+n = 100
+puts "Loading files #{n} times..."
+Benchmark.bm(10) do |x|
+  x.report('YAML') { n.times { YAML.load_file('/home/ded/.ydl/lawyers.ydl') } }
+  x.report('Psych') { n.times { Psych.load_file('/home/ded/.ydl/lawyers.ydl') } }
+  x.report('Ydl') { n.times { Ydl.load_file('/home/ded/.ydl/lawyers.ydl') } }
+end
+puts "Done."

data/ydl.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ydl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ydl'
+  spec.version       = Ydl::VERSION
+  spec.authors       = ['Daniel E. Doherty']
+  spec.email         = ['ded@ddoherty.net']
+
+  spec.summary       = 'Object definition and instantiation using YAML files for Ruby programs'
+  spec.description   = <<~DESC
+    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.
+  DESC
+  spec.homepage      = 'https://github.com/ddoherty03/ydl.git'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|features)/})
+  end
+  spec.bindir = 'bin'
+  # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~>6.0'
+  spec.add_dependency 'fat_core'
+  spec.add_dependency 'psych'
+
+  spec.add_development_dependency 'law_doc', '>= 0.1.15'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-doc'
+  spec.add_development_dependency 'debug', '>= 1.0.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  # spec.add_development_dependency 'law_doc'
+end

metadata

@@ -0,0 +1,230 @@
+--- !ruby/object:Gem::Specification
+name: ydl
+version: !ruby/object:Gem::Version
+  version: 0.2.06
+platform: ruby
+authors:
+- Daniel E. Doherty
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: fat_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: law_doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.15
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.15
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |
+  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.
+email:
+- ded@ddoherty.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.org
+- Rakefile
+- bin/console
+- bin/setup
+- examples/brief.tex
+- examples/cases.ydl
+- examples/header.rb
+- examples/lawyers.ydl
+- examples/mwe.tex
+- examples/persons.ydl
+- examples/simple.tex
+- examples/test_page.tex
+- lib/ydl.rb
+- lib/ydl/core_ext.rb
+- lib/ydl/core_ext/array.rb
+- lib/ydl/core_ext/array_refine.rb
+- lib/ydl/core_ext/boolean.rb
+- lib/ydl/core_ext/date.rb
+- lib/ydl/core_ext/hash.rb
+- lib/ydl/core_ext/numeric.rb
+- lib/ydl/core_ext/string.rb
+- lib/ydl/errors.rb
+- lib/ydl/node.rb
+- lib/ydl/top_queue.rb
+- lib/ydl/tree.rb
+- lib/ydl/version.rb
+- lib/ydl/ydl.rb
+- spec/array_spec.rb
+- spec/core_ext/array_spec.rb
+- spec/core_ext/boolean_spec.rb
+- spec/core_ext/date_spec.rb
+- spec/core_ext/hash_spec.rb
+- spec/core_ext/numeric_spec.rb
+- spec/core_ext/string_spec.rb
+- spec/example_files/err/person_err.ydl
+- spec/example_files/home/user/.ydl/config_template.yaml
+- spec/example_files/home/user/.ydl/courts/courts.ydl
+- spec/example_files/home/user/.ydl/lawyers.ydl
+- spec/example_files/home/user/.ydl/persons.ydl
+- spec/example_files/home/user/project/cases.ydl
+- spec/example_files/home/user/project/courts.ydl
+- spec/example_files/home/user/project/judges.ydl
+- spec/example_files/home/user/project/lawyers.ydl
+- spec/example_files/home/user/project/persons.ydl
+- spec/example_files/home/user/project/subproject/lawyers.ydl
+- spec/example_files/home/user/project/subproject/persons.ydl
+- spec/example_files/sys/ydl/constants.ydl
+- spec/example_files/sys/ydl/junk.ydl
+- spec/spec_helper.rb
+- spec/ydl_error_spec.rb
+- spec/ydl_spec.rb
+- yaml_v_psych.rb
+- ydl.gemspec
+homepage: https://github.com/ddoherty03/ydl.git
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Object definition and instantiation using YAML files for Ruby programs
+test_files: []