dbee 1.0.0.pre.alpha

data/spec/dbee/query/sorter_spec.rb

@@ -0,0 +1,72 @@
+# 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 Dbee::Query::Sorter do
+  it 'should act as hashable' do
+    expect(described_class).to respond_to(:make)
+    expect(described_class).to respond_to(:array)
+  end
+
+  context '#initialize' do
+    specify 'key_path is required' do
+      expect { described_class.new(key_path: '') }.to   raise_error(ArgumentError)
+      expect { described_class.new(key_path: nil) }.to  raise_error(ArgumentError)
+      expect { described_class.new }.to                 raise_error(ArgumentError)
+    end
+  end
+
+  context 'equality' do
+    let(:config) { { key_path: 'a.b.c', direction: :descending } }
+
+    subject { described_class.new(config) }
+
+    specify '#hash produces same output as concatenated string hash of key_path and direction' do
+      expect(subject.hash).to eq("#{config[:key_path]}#{config[:direction]}".hash)
+    end
+
+    specify '#== and #eql? compare attributes' do
+      object2 = described_class.new(config)
+
+      expect(subject).to eq(object2)
+      expect(subject).to eql(object2)
+    end
+  end
+
+  describe 'direction helpers' do
+    context 'when direction is ascending' do
+      let(:config) { { key_path: 'a.b.c' } }
+
+      subject { described_class.new(config) }
+
+      it '#ascending? is true' do
+        expect(subject.ascending?).to be true
+      end
+
+      it '#descending? is false' do
+        expect(subject.descending?).to be false
+      end
+    end
+
+    context 'when direction is descending' do
+      let(:config) { { key_path: 'a.b.c', direction: :descending } }
+
+      subject { described_class.new(config) }
+
+      it '#ascending? is false' do
+        expect(subject.ascending?).to be false
+      end
+
+      it '#descending? is true' do
+        expect(subject.descending?).to be true
+      end
+    end
+  end
+end

data/spec/dbee/query_spec.rb

@@ -0,0 +1,94 @@
+# 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 Dbee::Query do
+  let(:config) do
+    {
+      fields: [
+        { key_path: 'matt.nick.sam', display: 'some display' },
+        { key_path: 'katie' },
+        { key_path: 'jordan.pippen' }
+      ],
+      sorters: [
+        { key_path: :sort_me },
+        { key_path: :sort_me_too, direction: :descending }
+      ],
+      limit: 125
+    }
+  end
+
+  subject { described_class.make(config) }
+
+  specify '#eql? compares attributes' do
+    expect(subject).to eq(described_class.make(config))
+  end
+
+  context 'README examples' do
+    EXAMPLES = {
+      'Get all practices' => {
+        fields: [
+          { key_path: 'id' },
+          { key_path: 'active' },
+          { key_path: 'name' }
+        ]
+      },
+      'Get all practices, limit to 10, and sort by name (descending) then id (ascending)' => {
+        fields: [
+          { key_path: 'id' },
+          { key_path: 'active' },
+          { key_path: 'name' }
+        ],
+        sorters: [
+          { key_path: 'name', direction: :descending },
+          { key_path: 'id' }
+        ],
+        limit: 10
+      },
+      "Get top 5 active practices and patient whose name start with 'Sm':" => {
+        fields: [
+          { key_path: 'name', display: 'Practice Name' },
+          { key_path: 'patients.first', display: 'Patient First Name' },
+          { key_path: 'patients.middle', display: 'Patient Middle Name' },
+          { key_path: 'patients.last', display: 'Patient Last Name' }
+        ],
+        filters: [
+          { type: :equals, key_path: 'active', value: true },
+          { type: :starts_with, key_path: 'patients.last', value: 'Sm' }
+        ],
+        limit: 5
+      },
+      'Get practice IDs, patient IDs, names, and cell phone numbers that starts with 555' => {
+        fields: [
+          { key_path: 'id', display: 'Practice ID #' },
+          { key_path: 'patients.id', display: 'Patient ID #' },
+          { key_path: 'patients.first', display: 'Patient First Name' },
+          { key_path: 'patients.middle', display: 'Patient Middle Name' },
+          { key_path: 'patients.last', display: 'Patient Last Name' },
+          { key_path: 'patients.cell_phone_numbers.phone_number', display: 'Patient Cell #' }
+        ],
+        filters: [
+          { type: :equals, key_path: 'active', value: true },
+          {
+            type: :starts_with,
+            key_path: 'patients.cell_phone_numbers.phone_number',
+            value: '555'
+          }
+        ]
+      }
+    }.freeze
+
+    EXAMPLES.each_pair do |name, query|
+      specify name do
+        expect(described_class.make(query)).to be_a(described_class)
+      end
+    end
+  end
+end

data/spec/dbee_spec.rb

@@ -0,0 +1,60 @@
+# 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 'fixtures/models'
+
+describe Dbee do
+  describe '#sql' do
+    let(:provider) { Dbee::Providers::NullProvider.new }
+
+    let(:query) { {} }
+
+    it 'accepts a hash as a model and passes a Model instance to provider#sql' do
+      model = { name: 'something' }
+
+      expect(provider).to receive(:sql).with(Dbee::Model.make(model), Dbee::Query.make(query))
+
+      described_class.sql(model, query, provider)
+    end
+
+    it 'accepts a Dbee::Model instance as a model and passes a Model instance to provider#sql' do
+      model = Dbee::Model.make(name: 'something')
+
+      expect(provider).to receive(:sql).with(Dbee::Model.make(model), Dbee::Query.make(query))
+
+      described_class.sql(model, query, provider)
+    end
+
+    it 'accepts a Dbee::Base constant as a model and passes a Model instance to provider#sql' do
+      model = Models::Theaters
+
+      expect(provider).to receive(:sql).with(model.to_model, Dbee::Query.make(query))
+
+      described_class.sql(model, query, provider)
+    end
+
+    it 'accepts a Dbee::Query instance as a query and passes a Query instance to provider#sql' do
+      model = Models::Theaters
+      query = Dbee::Query.make(query)
+
+      expect(provider).to receive(:sql).with(model.to_model, Dbee::Query.make(query))
+
+      described_class.sql(model, query, provider)
+    end
+
+    it 'accepts a hash as a query and passes a Query instance to provider#sql' do
+      model = Models::Theaters
+
+      expect(provider).to receive(:sql).with(model.to_model, Dbee::Query.make(query))
+
+      described_class.sql(model, query, provider)
+    end
+  end
+end

data/spec/fixtures/models.rb

@@ -0,0 +1,115 @@
+# 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.
+#
+
+module Models
+  class Movies < Dbee::Base
+  end
+
+  class PhoneNumbers < Dbee::Base
+  end
+
+  class Demographics < Dbee::Base
+    association :phone_numbers, model: PhoneNumbers,
+                                constraints: {
+                                  type: :reference,
+                                  name: :demographic_id,
+                                  parent: :id
+                                }
+  end
+
+  class MembersBase < Dbee::Base
+    association :demos, model: Demographics,
+                        constraints: { type: :reference, name: :member_id, parent: :id }
+
+    association :movies, model: Movies,
+                         constraints: { type: :reference, name: :member_id, parent: :id }
+  end
+
+  class Members < MembersBase
+    association :favorite_comic_movies, model: Movies, constraints: [
+      { type: :reference, name: :member_id, parent: :id },
+      { type: :static, name: :genre, value: 'comic' }
+    ]
+
+    association :favorite_mystery_movies, model: Movies, constraints: [
+      { type: :reference, name: :member_id, parent: :id },
+      { type: :static, name: :genre, value: 'mystery' }
+    ]
+
+    association :favorite_comedy_movies, model: Movies, constraints: [
+      { type: :reference, name: :member_id, parent: :id },
+      { type: :static, name: :genre, value: 'comedy' }
+    ]
+  end
+
+  class TheatersBase < Dbee::Base
+  end
+
+  class Theaters < TheatersBase
+    association :members, model: Members, constraints: [
+      { type: :reference, name: :tid, parent: :id },
+      { type: :reference, name: :partition, parent: :partition }
+    ]
+  end
+
+  class A < Dbee::Base
+    table 'table_set_to_a'
+  end
+
+  class B < A
+    table 'table_set_to_b'
+  end
+
+  class C < A
+  end
+
+  class D < A
+    table ''
+  end
+
+  class E < B
+    table 'table_set_to_e'
+  end
+end
+
+module ReadmeDataModels
+  class PhoneNumbers < Dbee::Base
+    table :phones
+  end
+
+  class Notes < Dbee::Base
+  end
+
+  class Patients < Dbee::Base
+    association :notes, model: Notes, constraints: {
+      type: :reference, name: :patient_id, parent: :id
+    }
+
+    association :work_phone_number, model: PhoneNumbers, constraints: [
+      { type: :reference, name: :patient_id, parent: :id },
+      { type: :static, name: :phone_number_type, value: 'work' }
+    ]
+
+    association :cell_phone_number, model: PhoneNumbers, constraints: [
+      { type: :reference, name: :patient_id, parent: :id },
+      { type: :static, name: :phone_number_type, value: 'cell' }
+    ]
+
+    association :fax_phone_number, model: PhoneNumbers, constraints: [
+      { type: :reference, name: :patient_id, parent: :id },
+      { type: :static, name: :phone_number_type, value: 'fax' }
+    ]
+  end
+
+  class Practices < Dbee::Base
+    association :patients, model: Patients, constraints: {
+      type: :reference, name: :practice_id, parent: :id
+    }
+  end
+end

data/spec/fixtures/models.yaml

@@ -0,0 +1,101 @@
+Theaters, Members, and Movies:
+  name: theaters
+  table: theaters
+  models:
+    - name: members
+      table: members
+      constraints:
+        - type: reference
+          parent: id
+          name: tid
+        - type: reference
+          parent: partition
+          name: partition
+      models:
+        - name: demos
+          table: demographics
+          constraints:
+            - type: reference
+              parent: id
+              name: member_id
+          models:
+            - name: phone_numbers
+              table: phone_numbers
+              constraints:
+                - type: reference
+                  parent: id
+                  name: demographic_id
+        - name: movies
+          table: movies
+          constraints:
+            - type: reference
+              parent: id
+              name: member_id
+        - name: favorite_comic_movies
+          table: movies
+          constraints:
+            - type: reference
+              parent: id
+              name: member_id
+            - type: static
+              name: genre
+              value: comic
+        - name: favorite_mystery_movies
+          table: movies
+          constraints:
+            - type: reference
+              parent: id
+              name: member_id
+            - type: static
+              name: genre
+              value: mystery
+        - name: favorite_comedy_movies
+          table: movies
+          constraints:
+            - type: reference
+              parent: id
+              name: member_id
+            - type: static
+              name: genre
+              value: comedy
+Readme:
+  name: practices
+  models:
+    - name: patients
+      constraints:
+        - type: reference
+          name: practice_id
+          parent: id
+      models:
+        - name: notes
+          constraints:
+            - type: reference
+              name: patient_id
+              parent: id
+        - name: work_phone_number
+          table: phones
+          constraints:
+            - type: reference
+              name: patient_id
+              parent: id
+            - type: static
+              name: phone_number_type
+              value: work
+        - name: cell_phone_number
+          table: phones
+          constraints:
+            - type: reference
+              name: patient_id
+              parent: id
+            - type: static
+              name: phone_number_type
+              value: cell
+        - name: fax_phone_number
+          table: phones
+          constraints:
+            - type: reference
+              name: patient_id
+              parent: id
+            - type: static
+              name: phone_number_type
+              value: fax

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+# 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 'yaml'
+require 'pry'
+
+unless ENV['DISABLE_SIMPLECOV'] == 'true'
+  require 'simplecov'
+  require 'simplecov-console'
+
+  SimpleCov.formatter = SimpleCov::Formatter::Console
+  SimpleCov.start do
+    add_filter %r{\A/spec/}
+  end
+end
+
+require './lib/dbee'
+
+def fixture_path(*filename)
+  File.join('spec', 'fixtures', filename)
+end
+
+def yaml_fixture(*filename)
+  YAML.safe_load(fixture(*filename))
+end
+
+def fixture(*filename)
+  File.open(fixture_path(*filename), 'r:bom|utf-8').read
+end
+
+def yaml_fixture_files(*directory)
+  Dir[File.join('spec', 'fixtures', *directory, '*.yaml')].map do |filename|
+    [
+      filename,
+      yaml_file_read(filename)
+    ]
+  end.to_h
+end
+
+def yaml_file_read(*filename)
+  YAML.safe_load(file_read(*filename))
+end
+
+def file_read(*filename)
+  File.open(File.join(*filename), 'r:bom|utf-8').read
+end