hashematics 1.0.0

data/spec/hashematics/key_spec.rb

@@ -0,0 +1,37 @@
+# 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::Key do
+  describe '#eql?' do
+    it 'should compare Key objects' do
+      expect(described_class.new('id')).to eq(described_class.new('id'))
+      expect(described_class.new('id')).to eq(described_class.new(:id))
+      expect(described_class.new(['id'])).to eq(described_class.new('id'))
+      expect(described_class.new([:id])).to eq(described_class.new('id'))
+      expect(described_class.new([:id])).to eq(described_class.new(['id']))
+    end
+
+    it 'should compare Key with string' do
+      expect(described_class.new('id')).to eq('id')
+      expect(described_class.new(:id)).to eq('id')
+    end
+
+    it 'should compare Key with symbol' do
+      expect(described_class.new('id')).to eq(:id)
+      expect(described_class.new(:id)).to eq(:id)
+    end
+
+    it 'should compare Key with array' do
+      expect(described_class.new('id')).to eq(['id'])
+      expect(described_class.new(:id)).to eq([:id])
+    end
+  end
+end

data/spec/hashematics/object_interface_spec.rb

@@ -0,0 +1,42 @@
+# 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'
+require 'examples/person'
+
+describe ::Hashematics::ObjectInterface do
+  let(:input) do
+    {
+      id: 1,
+      'first' => 'Matt'
+    }
+  end
+
+  let(:person) { Person.new(input) }
+
+  it 'should read hash indifferently' do
+    expect(described_class.get(input, :id)).to eq(input[:id])
+    expect(described_class.get(input, 'id')).to eq(input[:id])
+    expect(described_class.get(input, :first)).to eq(input['first'])
+    expect(described_class.get(input, 'first')).to eq(input['first'])
+
+    expect(described_class.get(person, 'doesnt_exist')).to eq(nil)
+    expect(described_class.get(person, :doesnt_exist)).to eq(nil)
+  end
+
+  it 'should read object if object is responsive' do
+    expect(described_class.get(person, :id)).to eq(input[:id])
+    expect(described_class.get(person, 'id')).to eq(input[:id])
+    expect(described_class.get(person, :first)).to eq(input['first'])
+    expect(described_class.get(person, 'first')).to eq(input['first'])
+
+    expect(described_class.get(person, 'doesnt_exist')).to eq(nil)
+    expect(described_class.get(person, :doesnt_exist)).to eq(nil)
+  end
+end

data/spec/hashematics/record_set_spec.rb

@@ -0,0 +1,24 @@
+# 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::RecordSet do
+  let(:csv_rows) { csv_fixture('data.csv') }
+
+  let(:record_set) { described_class.new }
+
+  subject { record_set }
+
+  specify '#rows returns the original dataset' do
+    csv_rows.each { |row| subject.add(row) }
+
+    expect(subject.rows).to eq(csv_rows)
+  end
+end

data/spec/hashematics/record_spec.rb

@@ -0,0 +1,49 @@
+# 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::Record do
+  let(:csv_rows) { csv_fixture('data.csv') }
+
+  describe '#category_id' do
+    it 'returns correct ID for specified keys' do
+      records = csv_rows.map { |row| described_class.new(row) }
+
+      keys = [
+        'ID #',
+        ['ID #', 'Car ID #'],
+        ['ID #', 'House ID #']
+      ].map { |p| ::Hashematics::Key.new(p) }
+
+      keys.each do |key|
+        records.each do |record|
+          concat_only = key.map { |p| "#{p}::#{record[p]}" }.join('::')
+          expected_id_value = ::Hashematics::Id.digest(concat_only)
+
+          actual_id_value = record.id(key).value
+
+          expect(actual_id_value).to eq(expected_id_value)
+        end
+      end
+    end
+  end
+
+  describe '#eql?' do
+    it 'should compare Record objects' do
+      expect(described_class.new(id: 1)).to eq(described_class.new(id: 1))
+      expect(described_class.new(id: 1)).not_to eq(described_class.new(id: '1'))
+    end
+
+    it 'should compare Record to Hash objects' do
+      expect(described_class.new(id: 1)).to eq(id: 1)
+      expect(described_class.new(id: 1)).not_to eq(id: '1')
+    end
+  end
+end

data/spec/hashematics/type_spec.rb

@@ -0,0 +1,104 @@
+# 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'
+require 'examples/person'
+
+describe ::Hashematics::Type do
+  let(:input) do
+    {
+      id: 1,
+      first: 'Matt',
+      middle: 'Elfy',
+      last: 'Rizzo'
+    }
+  end
+
+  let(:person) { Person.new(input) }
+
+  context 'when input is an object' do
+    context 'with no properties and object does not respond to keys' do
+      specify '#convert makes blank object' do
+        type = described_class.new
+
+        actual = type.convert(person)
+
+        expect(actual).to eq({})
+      end
+    end
+  end
+
+  context 'when input is a hash' do
+    context 'with no properties but object responds to keys' do
+      specify '#convert makes object' do
+        type = described_class.new
+
+        actual = type.convert(input)
+
+        expect(actual).to eq(input)
+      end
+    end
+
+    context 'with property array' do
+      let(:properties) { [:id, 'first', :last] }
+
+      context 'with proc/lambda object_class' do
+        let(:expected) do
+          {
+            id: '1 - Processed',
+            'first' => 'Matt - Processed',
+            last: 'Rizzo - Processed'
+          }
+        end
+
+        let(:object_class) do
+          lambda do |h|
+            h.map { |k, v| [k, "#{v} - Processed"] }.to_h
+          end
+        end
+
+        specify '#convert makes object' do
+          type = described_class.new(properties: properties, object_class: object_class)
+
+          actual = type.convert(input)
+
+          expect(actual).to eq(expected)
+        end
+      end
+
+      context 'with class object_class' do
+        specify '#convert makes object' do
+          type = described_class.new(properties: properties, object_class: Person)
+
+          actual = type.convert(input)
+
+          expect(actual).to eq(person)
+        end
+      end
+
+      context 'with nil object_class' do
+        let(:expected) do
+          {
+            id: 1,
+            'first' => 'Matt',
+            last: 'Rizzo'
+          }
+        end
+
+        specify '#convert makes object' do
+          type = described_class.new(properties: properties)
+
+          actual = type.convert(input)
+
+          expect(actual).to eq(expected)
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2018-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 'pry'
+require 'csv'
+
+require 'simplecov'
+require 'simplecov-console'
+SimpleCov.formatter = SimpleCov::Formatter::Console
+SimpleCov.start
+
+require './lib/hashematics'
+
+def fixture_path(*filename)
+  File.join('spec', 'fixtures', filename)
+end
+
+def csv_fixture(*filename)
+  CSV.new(fixture(*filename), headers: true).map(&:to_h)
+end
+
+def yaml_fixture(*filename)
+  # rubocop:disable Security/YAMLLoad
+  YAML.load(fixture(*filename))
+  # rubocop:enable Security/YAMLLoad
+end
+
+def fixture(*filename)
+  # Excel adds a Byte Order Mark to the beginning of the file. Let Ruby
+  # know about this so that the first 'id' column is correctly parsed.
+  # More info about the Excel Byte Order Mark and Ruby is available at:
+  # https://estl.tech/of-ruby-and-hidden-csv-characters-ef482c679b35 .
+  file = File.open(fixture_path(*filename), 'r:bom|utf-8')
+
+  file.read
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: hashematics
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthew Ruggio
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pdf-inspector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.63.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.1
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+description: "    Hashematics is a configuration-based object graphing tool which
+  can turn a flat, single dimensional dataset into a structure of deeply nested objects.\n"
+email:
+- mruggio@bluemarblepayroll.com
+executables:
+- benchmark
+- console
+extensions: []
+extra_rdoc_files: []
+files:
+- ".editorconfig"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- LICENSE
+- README.md
+- bin/benchmark
+- bin/console
+- hashematics.gemspec
+- lib/hashematics.rb
+- lib/hashematics/category.rb
+- lib/hashematics/configuration.rb
+- lib/hashematics/dictionary.rb
+- lib/hashematics/graph.rb
+- lib/hashematics/group.rb
+- lib/hashematics/hashematics.rb
+- lib/hashematics/id.rb
+- lib/hashematics/key.rb
+- lib/hashematics/object_interface.rb
+- lib/hashematics/record.rb
+- lib/hashematics/record_set.rb
+- lib/hashematics/type.rb
+- lib/hashematics/version.rb
+- lib/hashematics/visitor.rb
+- spec/examples/person.rb
+- spec/fixtures/config.yml
+- spec/fixtures/data.csv
+- spec/fixtures/people.yml
+- spec/hashematics/category_spec.rb
+- spec/hashematics/graph_spec.rb
+- spec/hashematics/key_spec.rb
+- spec/hashematics/object_interface_spec.rb
+- spec/hashematics/record_set_spec.rb
+- spec/hashematics/record_spec.rb
+- spec/hashematics/type_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bluemarblepayroll/hashematics
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Configurable Data Shaper
+test_files:
+- spec/examples/person.rb
+- spec/fixtures/config.yml
+- spec/fixtures/data.csv
+- spec/fixtures/people.yml
+- spec/hashematics/category_spec.rb
+- spec/hashematics/graph_spec.rb
+- spec/hashematics/key_spec.rb
+- spec/hashematics/object_interface_spec.rb
+- spec/hashematics/record_set_spec.rb
+- spec/hashematics/record_spec.rb
+- spec/hashematics/type_spec.rb
+- spec/spec_helper.rb