hashematics 1.0.0

data/spec/examples/person.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+class Person
+  attr_accessor :dob, :first, :id, :last, :smoker
+
+  def initialize(attrs = {})
+    attrs.each do |k, v|
+      send("#{k}=", v) if respond_to?(k)
+    end
+  end
+
+  def eql?(other)
+    to_hash == other.to_hash
+  end
+
+  def ==(other)
+    eql?(other)
+  end
+
+  def to_hash
+    {
+      id: id,
+      first: first,
+      last: last,
+      smoker: smoker,
+      dob: dob
+    }
+  end
+end

data/spec/fixtures/config.yml

@@ -0,0 +1,44 @@
+types:
+  person:
+    properties:
+      :id: 'ID #'
+      :first: First
+      :last: Last
+      :smoker: Smoker
+      :dob: DOB
+  car:
+    properties:
+      id: 'Car ID #'
+      make: Make
+      model: Model
+      year: Year
+  house:
+    :properties:
+      id: 'House ID #'
+      st1: Street 1
+      st2: Street 2
+      city: City
+      st: St
+      zip: Zip
+  plate:
+    :properties:
+      id: 'Plate ID #'
+      number: Plate Number
+groups:
+  people:
+    by: 'ID #'
+    type: person
+    groups:
+      :cars:
+        by: 'Car ID #'
+        type: car
+        groups:
+          plates:
+            by: 'Plate ID #'
+            type: plate
+      houses:
+        by: 'House ID #'
+        type: house
+  cars:
+    by: 'Car ID #'
+    type: car

data/spec/fixtures/data.csv

@@ -0,0 +1,9 @@
+ID #,First,Last,Smoker,DOB,Car ID #,Make,Model,Year,House ID #,Street 1,Street 2,City,St,Zip,Plate ID #,Plate Number
+1,Matt,Rizzo,false,1902-03-04,2,Jeep,Wrangler,1964,7,555 N. Michigan Ave,Suite 203,Chicago,IL,60075,12,JEEPY123
+1,Matt,Rizzo,false,1902-03-04,3,Mercedes,Benz,1921,7,555 N. Michigan Ave,Suite 203,Chicago,IL,60075,13,BENZY456
+1,Matt,Rizzo,false,1902-03-04,2,Jeep,Wrangler,1964,8,2813 N. Drivey Ave,Apt. 399,Roanoke,GA,99998,12,JEEPY123
+1,Matt,Rizzo,false,1902-03-04,3,Mercedes,Benz,1921,8,2813 N. Drivey Ave,Apt. 399,Roanoke,GA,99998,13,BENZY4565
+2,Katie,Bunny,true,1919-09-02,4,GMC,Terrainia,1999,9,123 Happy Ln.,Apt. 45,Mayhusee,RI,53210,14,GMC394
+2,Katie,Bunny,true,1919-09-02,5,Buick,Macartha,1982,9,123 Happy Ln.,Apt. 45,Mayhusee,RI,53210,15,BUICKY93
+3,Ralphie,Dog,true,1999-12-11,6,Audi,A1,2012,10,4500 Century Ave.,Floor 3A,Pakato,ZA,093821,,
+3,Ralphie,Dog,true,1999-12-11,6,Audi,A1,2012,11,9990 Lake St.,,Pakato,ZA,093822,,

data/spec/fixtures/people.yml

@@ -0,0 +1,84 @@
+- :id: '1'
+  :first: Matt
+  :last: Rizzo
+  :smoker: 'false'
+  :dob: '1902-03-04'
+  :cars:
+  - id: '2'
+    make: Jeep
+    model: Wrangler
+    year: '1964'
+    plates:
+    - id: '12'
+      number: JEEPY123
+  - id: '3'
+    make: Mercedes
+    model: Benz
+    year: '1921'
+    plates:
+    - id: '13'
+      number: BENZY4565
+  houses:
+  - id: '7'
+    st1: 555 N. Michigan Ave
+    st2: Suite 203
+    city: Chicago
+    st: IL
+    zip: '60075'
+  - id: '8'
+    st1: 2813 N. Drivey Ave
+    st2: Apt. 399
+    city: Roanoke
+    st: GA
+    zip: '99998'
+- :id: '2'
+  :first: Katie
+  :last: Bunny
+  :smoker: 'true'
+  :dob: '1919-09-02'
+  :cars:
+  - id: '4'
+    make: GMC
+    model: Terrainia
+    year: '1999'
+    plates:
+    - id: '14'
+      number: GMC394
+  - id: '5'
+    make: Buick
+    model: Macartha
+    year: '1982'
+    plates:
+    - id: '15'
+      number: BUICKY93
+  houses:
+  - id: '9'
+    st1: 123 Happy Ln.
+    st2: Apt. 45
+    city: Mayhusee
+    st: RI
+    zip: '53210'
+- :id: '3'
+  :first: Ralphie
+  :last: Dog
+  :smoker: 'true'
+  :dob: '1999-12-11'
+  :cars:
+  - id: '6'
+    make: Audi
+    model: A1
+    year: '2012'
+    plates: []
+  houses:
+  - id: '10'
+    st1: 4500 Century Ave.
+    st2: Floor 3A
+    city: Pakato
+    st: ZA
+    zip: '093821'
+  - id: '11'
+    st1: 9990 Lake St.
+    st2: null
+    city: Pakato
+    st: ZA
+    zip: '093822'

data/spec/hashematics/category_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe ::Hashematics::Category do
+  let(:csv_rows) { csv_fixture('data.csv') }
+
+  it 'should require an id_key' do
+    expect { described_class.new(id_key: nil) }.to raise_error ArgumentError
+  end
+
+  describe '#add' do
+    context 'with id key but no parent key' do
+      specify '#records should return last unique rows as records' do
+        category = described_class.new(id_key: 'ID #')
+
+        csv_rows.each do |csv_row|
+          record = ::Hashematics::Record.new(csv_row)
+          category.add(record)
+        end
+
+        expected_records = [
+          ::Hashematics::Record.new(csv_rows[3]),
+          ::Hashematics::Record.new(csv_rows[5]),
+          ::Hashematics::Record.new(csv_rows[7])
+        ]
+
+        expect(category.records).to eq(expected_records)
+      end
+    end
+
+    context 'with parent and id keys' do
+      specify '#records should return unique rows as records specific to a parent' do
+        category = described_class.new(
+          parent_key: 'ID #',
+          id_key: 'Car ID #'
+        )
+
+        csv_rows.each do |csv_row|
+          record = ::Hashematics::Record.new(csv_row)
+          category.add(record)
+        end
+
+        expected_records = [
+          ::Hashematics::Record.new(csv_rows[2]),
+          ::Hashematics::Record.new(csv_rows[3])
+        ]
+
+        parent = ::Hashematics::Record.new(csv_rows.first)
+
+        expect(category.records(parent)).to eq(expected_records)
+      end
+    end
+  end
+end

data/spec/hashematics/graph_spec.rb

@@ -0,0 +1,572 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2019-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require 'spec_helper'
+
+describe ::Hashematics::Graph do
+  let(:csv_rows) { csv_fixture('data.csv') }
+
+  let(:configuration) { yaml_fixture('config.yml') }
+
+  let(:people) { yaml_fixture('people.yml') }
+
+  let(:groups) { ::Hashematics::Configuration.new(configuration).groups }
+
+  describe '#children' do
+    it 'returns list of child group names' do
+      graph = described_class.new(groups).add(csv_rows)
+
+      actual_children = graph.children
+
+      expected_children = groups.map(&:name)
+
+      expect(actual_children).to eq(expected_children)
+    end
+  end
+
+  describe '#data' do
+    context 'with no object_class specifications' do
+      it 'should parse configuration and return object graph' do
+        graph = described_class.new(groups).add(csv_rows)
+
+        actual_people = graph.data('people')
+
+        # binding.pry
+
+        expect(actual_people).to eq(people)
+      end
+    end
+
+    context 'with object_class open_struct specifications' do
+      let(:modified_configuration) do
+        yaml_fixture('config.yml').tap do |c|
+          c.dig('types', 'person')['object_class'] = 'open_struct'
+        end
+      end
+
+      let(:modified_groups) do
+        ::Hashematics::Configuration.new(modified_configuration).groups
+      end
+
+      let(:modified_people) do
+        yaml_fixture('people.yml').map { |h| OpenStruct.new(h) }
+      end
+
+      it 'should parse configuration and return object graph' do
+        graph = described_class.new(modified_groups).add(csv_rows)
+
+        actual_people = graph.data(:people)
+
+        expect(actual_people).to eq(modified_people)
+      end
+    end
+  end
+
+  describe 'README examples' do
+    specify 'Getting Started should work' do
+      rows = [
+        {
+          id: 1,
+          first: 'Bruce',
+          last: 'Banner'
+        },
+        {
+          id: 2,
+          first: 'Tony',
+          last: 'Stark'
+        }
+      ]
+
+      graph = ::Hashematics.graph(rows: rows)
+      objects = graph.rows
+
+      expect(objects).to eq(rows)
+    end
+
+    specify 'Introduction to Shaping should work' do
+      config = {
+        types: {
+          person: {
+            properties: %i[id first]
+          }
+        },
+        groups: {
+          avengers: {
+            by: :id,
+            type: :person
+          }
+        }
+      }
+
+      rows = [
+        {
+          id: 1,
+          first: 'Bruce',
+          last: 'Banner'
+        },
+        {
+          id: 2,
+          first: 'Tony',
+          last: 'Stark'
+        }
+      ]
+
+      graph = ::Hashematics.graph(config: config, rows: rows)
+      objects = graph.data(:avengers)
+
+      expected = [
+        {
+          id: 1,
+          first: 'Bruce'
+        },
+        {
+          id: 2,
+          first: 'Tony'
+        }
+      ]
+
+      expect(objects).to eq(expected)
+    end
+
+    specify 'Cross-Mapping Shape Attribute Names should work' do
+      config = {
+        types: {
+          person: {
+            properties: {
+              id_number: :id,
+              first_name: :first
+            }
+          }
+        },
+        groups: {
+          avengers: {
+            by: :id,
+            type: :person
+          }
+        }
+      }
+
+      rows = [
+        {
+          id: 1,
+          first: 'Bruce',
+          last: 'Banner'
+        },
+        {
+          id: 2,
+          first: 'Tony',
+          last: 'Stark'
+        }
+      ]
+
+      graph   = ::Hashematics.graph(config: config, rows: rows)
+      objects = graph.data(:avengers)
+
+      expected = [
+        {
+          id_number: 1,
+          first_name: 'Bruce'
+        },
+        {
+          id_number: 2,
+          first_name: 'Tony'
+        }
+      ]
+
+      expect(objects).to eq(expected)
+    end
+
+    specify 'Nested Shaping should work' do
+      config = {
+        types: {
+          person: {
+            properties: {
+              id: 'ID #',
+              first: 'First Name',
+              last: 'Last Name'
+            }
+          },
+          costume: {
+            properties: {
+              id: 'Costume ID #',
+              name: 'Costume Name',
+              color: 'Costume Color'
+            }
+          }
+        },
+        groups: {
+          avengers: {
+            by: 'ID #',
+            type: :person,
+            groups: {
+              costumes: {
+                by: 'Costume ID #',
+                type: :costume
+              }
+            }
+          }
+        }
+      }
+
+      rows = [
+        {
+          'ID #' => 1,
+          'First Name' => 'Bruce',
+          'Last Name' => 'Banner',
+          'Costume ID #' => 3,
+          'Costume Name' => 'Basic Hulk',
+          'Costume Color' => 'Green'
+        },
+        {
+          'ID #' => 1,
+          'First Name' => 'Bruce',
+          'Last Name' => 'Banner',
+          'Costume ID #' => 4,
+          'Costume Name' => 'Mad Hulk',
+          'Costume Color' => 'Red'
+        },
+        {
+          'ID #' => 2,
+          'First Name' => 'Tony',
+          'Last Name' => 'Stark',
+          'Costume ID #' => 5,
+          'Costume Name' => 'Mark I',
+          'Costume Color' => 'Gray'
+        },
+        {
+          'ID #' => 2,
+          'First Name' => 'Tony',
+          'Last Name' => 'Stark',
+          'Costume ID #' => 6,
+          'Costume Name' => 'Mark IV',
+          'Costume Color' => 'Red'
+        },
+        {
+          'ID #' => 2,
+          'First Name' => 'Tony',
+          'Last Name' => 'Stark',
+          'Costume ID #' => 7,
+          'Costume Name' => 'Mark VI',
+          'Costume Color' => 'Nano-Blue'
+        }
+      ]
+
+      graph   = ::Hashematics.graph(config: config, rows: rows)
+      objects = graph.data(:avengers)
+
+      expected = [
+        {
+          id: 1,
+          first: 'Bruce',
+          last: 'Banner',
+          costumes: [
+            { id: 3, name: 'Basic Hulk', color: 'Green' },
+            { id: 4, name: 'Mad Hulk', color: 'Red' }
+          ]
+        },
+        {
+          id: 2,
+          first: 'Tony',
+          last: 'Stark',
+          costumes: [
+            { id: 5, name: 'Mark I', color: 'Gray' },
+            { id: 6, name: 'Mark IV', color: 'Red' },
+            { id: 7, name: 'Mark VI', color: 'Nano-Blue' }
+          ]
+        }
+      ]
+
+      expect(objects).to eq(expected)
+    end
+
+    specify 'Multiple Top-Level Graphs should work' do
+      config = {
+        types: {
+          person: {
+            properties: {
+              id: 'ID #',
+              first: 'First Name',
+              last: 'Last Name'
+            }
+          },
+          costume: {
+            properties: {
+              id: 'Costume ID #',
+              name: 'Costume Name',
+              color: 'Costume Color'
+            }
+          }
+        },
+        groups: {
+          avengers: {
+            by: 'ID #',
+            type: :person,
+            groups: {
+              costumes: {
+                by: 'Costume ID #',
+                type: :costume
+              }
+            }
+          },
+          costumes: {
+            by: 'Costume ID #',
+            type: :costume
+          }
+        }
+      }
+
+      rows = [
+        {
+          'ID #' => 1,
+          'First Name' => 'Bruce',
+          'Last Name' => 'Banner',
+          'Costume ID #' => 3,
+          'Costume Name' => 'Basic Hulk',
+          'Costume Color' => 'Green'
+        },
+        {
+          'ID #' => 1,
+          'First Name' => 'Bruce',
+          'Last Name' => 'Banner',
+          'Costume ID #' => 4,
+          'Costume Name' => 'Mad Hulk',
+          'Costume Color' => 'Red'
+        },
+        {
+          'ID #' => 2,
+          'First Name' => 'Tony',
+          'Last Name' => 'Stark',
+          'Costume ID #' => 5,
+          'Costume Name' => 'Mark I',
+          'Costume Color' => 'Gray'
+        },
+        {
+          'ID #' => 2,
+          'First Name' => 'Tony',
+          'Last Name' => 'Stark',
+          'Costume ID #' => 6,
+          'Costume Name' => 'Mark IV',
+          'Costume Color' => 'Red'
+        },
+        {
+          'ID #' => 2,
+          'First Name' => 'Tony',
+          'Last Name' => 'Stark',
+          'Costume ID #' => 7,
+          'Costume Name' => 'Mark VI',
+          'Costume Color' => 'Nano-Blue'
+        }
+      ]
+
+      graph   = ::Hashematics.graph(config: config, rows: rows)
+      objects = graph.data(:costumes)
+
+      expected = [
+        { id: 3, name: 'Basic Hulk', color: 'Green' },
+        { id: 4, name: 'Mad Hulk', color: 'Red' },
+        { id: 5, name: 'Mark I', color: 'Gray' },
+        { id: 6, name: 'Mark IV', color: 'Red' },
+        { id: 7, name: 'Mark VI', color: 'Nano-Blue' }
+      ]
+
+      expect(objects).to eq(expected)
+    end
+
+    specify 'Handling Blanks (skip - default) should work' do
+      config = {
+        types: {
+          person: {
+            properties: {
+              id: 'ID #',
+              first: 'First Name',
+              last: 'Last Name'
+            }
+          },
+          costume: {
+            properties: {
+              id: 'Costume ID #',
+              name: 'Costume Name',
+              color: 'Costume Color'
+            }
+          }
+        },
+        groups: {
+          avengers: {
+            by: 'ID #',
+            type: :person,
+            groups: {
+              costumes: {
+                by: 'Costume ID #',
+                type: :costume
+              }
+            }
+          },
+          costumes: {
+            by: 'Costume ID #',
+            type: :costume
+          }
+        }
+      }
+
+      rows = [
+        {
+          'ID #' => 1,
+          'First Name' => 'Bruce',
+          'Last Name' => 'Banner',
+          'Costume ID #' => 3,
+          'Costume Name' => 'Basic Hulk',
+          'Costume Color' => 'Green'
+        },
+        {
+          'ID #' => 2,
+          'First Name' => 'Tony',
+          'Last Name' => 'Stark',
+          'Costume ID #' => '',
+          'Costume Name' => '',
+          'Costume Color' => ''
+        },
+        {
+          'Costume ID #' => 4,
+          'Costume Name' => 'Undercover',
+          'Costume Color' => 'Purple'
+        }
+      ]
+
+      graph    = ::Hashematics.graph(config: config, rows: rows)
+      avengers = graph.data(:avengers)
+      costumes = graph.data(:costumes)
+
+      expected_avengers = [
+        {
+          id: 1,
+          first: 'Bruce',
+          last: 'Banner',
+          costumes: [
+            { id: 3, name: 'Basic Hulk', color: 'Green' }
+          ]
+        },
+        {
+          id: 2,
+          first: 'Tony',
+          last: 'Stark',
+          costumes: []
+        }
+      ]
+
+      expected_costumes = [
+        { id: 3, name: 'Basic Hulk', color: 'Green' },
+        { id: 4, name: 'Undercover', color: 'Purple' }
+      ]
+
+      expect(avengers).to eq(expected_avengers)
+      expect(costumes).to eq(expected_costumes)
+    end
+
+    specify 'Handling Blanks (include) should work' do
+      config = {
+        types: {
+          person: {
+            properties: {
+              id: 'ID #',
+              first: 'First Name',
+              last: 'Last Name'
+            }
+          },
+          costume: {
+            properties: {
+              id: 'Costume ID #',
+              name: 'Costume Name',
+              color: 'Costume Color'
+            }
+          }
+        },
+        groups: {
+          avengers: {
+            by: 'ID #',
+            include_blank: true,
+            type: :person,
+            groups: {
+              costumes: {
+                by: 'Costume ID #',
+                type: :costume
+              }
+            }
+          },
+          costumes: {
+            by: 'Costume ID #',
+            include_blank: true,
+            type: :costume
+          }
+        }
+      }
+
+      rows = [
+        {
+          'ID #' => 1,
+          'First Name' => 'Bruce',
+          'Last Name' => 'Banner',
+          'Costume ID #' => 3,
+          'Costume Name' => 'Basic Hulk',
+          'Costume Color' => 'Green'
+        },
+        {
+          'ID #' => 2,
+          'First Name' => 'Tony',
+          'Last Name' => 'Stark',
+          'Costume ID #' => '',
+          'Costume Name' => '',
+          'Costume Color' => ''
+        },
+        {
+          'Costume ID #' => 4,
+          'Costume Name' => 'Undercover',
+          'Costume Color' => 'Purple'
+        }
+      ]
+
+      graph    = ::Hashematics.graph(config: config, rows: rows)
+      avengers = graph.data(:avengers)
+      costumes = graph.data(:costumes)
+
+      expected_avengers = [
+        {
+          id: 1,
+          first: 'Bruce',
+          last: 'Banner',
+          costumes: [
+            { id: 3, name: 'Basic Hulk', color: 'Green' }
+          ]
+        },
+        {
+          id: 2,
+          first: 'Tony',
+          last: 'Stark',
+          costumes: []
+        },
+        {
+          id: nil,
+          first: nil,
+          last: nil,
+          costumes: [
+            { id: 4, name: 'Undercover', color: 'Purple' }
+          ]
+        }
+      ]
+
+      expected_costumes = [
+        { id: 3, name: 'Basic Hulk', color: 'Green' },
+        { id: '', name: '', color: '' },
+        { id: 4, name: 'Undercover', color: 'Purple' }
+      ]
+
+      expect(avengers).to eq(expected_avengers)
+      expect(costumes).to eq(expected_costumes)
+    end
+  end
+end