dbee 1.0.0.pre.alpha.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b130a54954373ada660f1203488dbf1a8c7f086b7d22f6fdc3a1e5f37cbf5266
-  data.tar.gz: f6d4feef16b9bcf531bddeee8ac7628e95286e3f263c335213daad2cf889bca9
+  metadata.gz: dab2bf5eb7197181b4683180b3a3c490621d8e9fb58ee6d0edc99f39be1709ec
+  data.tar.gz: e20fc2c2d02819aa2659847c795878ee7c23a1798d5a27b4e220320987016692
 SHA512:
-  metadata.gz: 29a0abfebc532e09f81953ec8a9918887bb6ab0bbb3e50d68e1615df71b2c913af0fb9a063ab38381adbcf614df27c6322f297a16d4a90d6481a1608b02ac31b
-  data.tar.gz: ad4f0531f7bfc44e7d5461f453fecfebccb3afbbfb997d111a154030188d9ce4a4d206fdcb9d466027439a182e7c4fb3127327b104223e615be203bd9775b857
+  metadata.gz: c55baaace5f9e37d4d71a2465780ef60b20d06956ab27b45d9d91bc841757f4d393b05cfc757aead9f6acd4225b3b06a55b5521b78f6686e42cc4391fc9f72db
+  data.tar.gz: 96bcb8c21d3974b4d46608e3e80658bd6608dc588d781da4676ea335bc8dc75ffc7f6dd202e691bbc905589f3f81e8a2b00e9f770a1d21a58de1729382f0b3e2

data/.rubocop.yml

@@ -14,7 +14,7 @@ Metrics/MethodLength:
   Max: 25
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.4
 
 Metrics/AbcSize:
   Max: 16

data/.travis.yml

@@ -4,8 +4,8 @@ env:
 language: ruby
 rvm:
   # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
-  - 2.5.3
-  - 2.6.0
+  - 2.4.6
+  - 2.5.5
   - 2.6.3
 cache: bundler
 before_script:

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.0 (August 22nd, 2019)
+
+Initial release.
+
 # 1.0.0-alpha (August 18th, 2019)
 
 Added initial implementation.

data/README.md

@@ -11,7 +11,7 @@ Dbee arose out of a need for an ad-hoc reporting solution that included:
 
 Dbee provides a very simple Data Modeling and Query API's and as such it is not meant to replace a traditional ORM or your data persistence layer, but compliment them.  This library's goal is to output the SQL statement needed and **nothing** more.
 
-Other solutions considered included:
+Other solutions considered:
 
 * [Squeel](https://github.com/activerecord-hackery/squeel) - Was in production use up until Rails 5, then saw compatibility issues.
 * [BabySqueel](https://github.com/rzane/baby_squeel) - Tested with some success up until Rails 5.2.1, then saw compatibility issues.
@@ -82,7 +82,7 @@ There are two ways to model this schema using Dbee:
 
 #### Code-First Data Modeling
 
-Code-first data modeling involves creating sub-classes of Dbee::Base that describes the tables, columns, and associations.  We could model the above example as:
+Code-first data modeling involves creating sub-classes of Dbee::Base that describes the tables and associations.  We could model the above example as:
 
 ````ruby
 module ReadmeDataModels
@@ -115,8 +115,6 @@ module ReadmeDataModels
   end
 
   class Practices < Dbee::Base
-    boolean_column :active, nullable: false
-
     association :patients, model: Patients, constraints: {
       type: :reference, name: :practice_id, parent: :id
     }
@@ -125,10 +123,8 @@ end
 
 ````
 
-A couple notes:
+**Note:** the 'table' directive is optional, and if omitted, the classes name will be turned into snake_case and used.  In the above example you can see we wanted the class name of PhoneNumbers but the table is actually 'phones'
 
-* the 'table' directive is optional, and if omitted, the classes name will be turned into snake_case and used.  In the above example you can see we wanted the class name of PhoneNumbers but the table is actually 'phones'
-* it is not required that all columns be explicitly defined but it does provide value coercion.  By default, all undefined columns are of type Dbee::Model::Columns::Undefined.
 
 #### Configuration-First Data Modeling
 
@@ -136,10 +132,6 @@ You can choose to alternatively describe your data model using configuration.  T
 
 ````yaml
 name: practices
-columns:
-  - name: active
-    type: boolean
-    nullable: false
 models:
   - name: patients
     constraints:

data/dbee.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/bluemarblepayroll/dbee'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.5.3'
+  s.required_ruby_version = '>= 2.4.6'
 
   s.add_dependency('acts_as_hashable', '~>1', '>=1.1.0')
 
@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('pry', '~>0')
   s.add_development_dependency('rake', '~> 12')
   s.add_development_dependency('rspec')
-  s.add_development_dependency('rubocop', '~>0.63.1')
-  s.add_development_dependency('simplecov', '~>0.16.1')
-  s.add_development_dependency('simplecov-console', '~>0.4.2')
+  s.add_development_dependency('rubocop', '~>0.74.0')
+  s.add_development_dependency('simplecov', '~>0.17.0')
+  s.add_development_dependency('simplecov-console', '~>0.5.0')
 end

data/lib/dbee/base.rb

@@ -12,10 +12,6 @@ module Dbee
   # Model declaration.
   class Base
     class << self
-      def boolean_column(name, opts = {})
-        columns_by_name[name.to_s] = opts.merge(name: name, type: :boolean)
-      end
-
       def table(name)
         @table_name = name.to_s
 
@@ -39,10 +35,6 @@ module Dbee
         @table_name || ''
       end
 
-      def columns_by_name
-        @columns_by_name ||= {}
-      end
-
       def associations_by_name
         @associations_by_name ||= {}
       end
@@ -55,12 +47,6 @@ module Dbee
         subclasses.find(&:table_name?)&.table_name || ''
       end
 
-      def inherited_columns_by_name
-        reversed_subclasses.each_with_object({}) do |subclass, memo|
-          memo.merge!(subclass.columns_by_name)
-        end
-      end
-
       def inherited_associations_by_name
         reversed_subclasses.each_with_object({}) do |subclass, memo|
           memo.merge!(subclass.associations_by_name)
@@ -79,7 +65,6 @@ module Dbee
 
       def model_config(name, constraints)
         {
-          columns: columns,
           constraints: constraints,
           models: associations,
           name: name,
@@ -97,12 +82,6 @@ module Dbee
         inherited_table.empty? ? inflected_name : inherited_table
       end
 
-      def columns
-        inherited_columns_by_name.values.each_with_object([]) do |config, memo|
-          memo << Model::Columns.make(config)
-        end
-      end
-
       def associations
         inherited_associations_by_name.values.each_with_object([]) do |config, memo|
           model_klass             = config[:model]

data/lib/dbee/model.rb

@@ -7,7 +7,6 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'model/columns'
 require_relative 'model/constraints'
 
 module Dbee
@@ -20,18 +19,17 @@ module Dbee
 
     private_constant :JOIN_CHAR
 
-    class ModelNotFound < StandardError; end
+    class ModelNotFoundError < StandardError; end
 
     attr_reader :constraints, :name
 
-    def initialize(name:, columns: [], constraints: [], models: [], table: '')
+    def initialize(name:, constraints: [], models: [], table: '')
       raise ArgumentError, 'name is required' if name.to_s.empty?
 
-      @name             = name.to_s
-      @columns_by_name  = name_hash(Columns.array(columns))
-      @constraints      = Constraints.array(constraints)
-      @models_by_name   = name_hash(Model.array(models))
-      @table            = table.to_s
+      @name           = name.to_s
+      @constraints    = Constraints.array(constraints)
+      @models_by_name = name_hash(Model.array(models))
+      @table          = table.to_s
 
       freeze
     end
@@ -48,14 +46,6 @@ module Dbee
       models_by_name.values
     end
 
-    def columns
-      columns_by_name.values
-    end
-
-    def column(name)
-      columns_by_name[name.to_s] || Columns::Undefined.new(name: name)
-    end
-
     def ancestors(parts = [], alias_chain = [], found = {})
       return found if Array(parts).empty?
 
@@ -65,7 +55,7 @@ module Dbee
 
       model = models_by_name[model_name.to_s]
 
-      raise ModelNotFound, "Cannot traverse: #{model_name}" unless model
+      raise ModelNotFoundError, "Cannot traverse: #{model_name}" unless model
 
       new_alias_chain = alias_chain + [model_name]
 
@@ -80,13 +70,12 @@ module Dbee
       other.name == name &&
         other.table == table &&
         other.models == models &&
-        other.constraints == constraints &&
-        other.columns == columns
+        other.constraints == constraints
     end
     alias eql? ==
 
     private
 
-    attr_reader :models_by_name, :columns_by_name
+    attr_reader :models_by_name
   end
 end

data/lib/dbee/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Dbee
-  VERSION = '1.0.0-alpha.3'
+  VERSION = '1.0.0'
 end

data/spec/dbee/model_spec.rb

@@ -55,28 +55,6 @@ describe Dbee::Model do
     end
   end
 
-  describe '#column' do
-    let(:yaml_entities) { yaml_fixture('models.yaml') }
-
-    let(:entity_hash) { yaml_entities['Theaters, Members, and Movies'] }
-
-    subject { described_class.make(entity_hash) }
-
-    specify 'returns column instance if it exists' do
-      expected = Dbee::Model::Columns::Boolean.make(name: 'active', nullable: false)
-      expect(subject.column('active')).to eq(expected)
-
-      expected = Dbee::Model::Columns::Boolean.make(name: 'inspected', nullable: true)
-      expect(subject.column('inspected')).to eq(expected)
-    end
-
-    specify 'returns unknown column instance if it does not exist' do
-      expected = Dbee::Model::Columns::Boolean.make(name: 'doesnt_exist')
-
-      expect(subject.column('doesnt_exist')).to eq(expected)
-    end
-  end
-
   describe '#ancestors' do
     let(:yaml_entities) { yaml_fixture('models.yaml') }
 

data/spec/fixtures/models.rb

@@ -49,12 +49,9 @@ module Models
   end
 
   class TheatersBase < Dbee::Base
-    boolean_column :active, nullable: false
   end
 
   class Theaters < TheatersBase
-    boolean_column :inspected
-
     association :members, model: Members, constraints: [
       { type: :reference, name: :tid, parent: :id },
       { type: :reference, name: :partition, parent: :partition }
@@ -111,8 +108,6 @@ module ReadmeDataModels
   end
 
   class Practices < Dbee::Base
-    boolean_column :active, nullable: false
-
     association :patients, model: Patients, constraints: {
       type: :reference, name: :practice_id, parent: :id
     }

data/spec/fixtures/models.yaml

@@ -1,12 +1,6 @@
 Theaters, Members, and Movies:
   name: theaters
   table: theaters
-  columns:
-  - name: active
-    type: boolean
-    nullable: false
-  - name: inspected
-    type: boolean # this one is nullable
   models:
     - name: members
       table: members
@@ -66,10 +60,6 @@ Theaters, Members, and Movies:
               value: comedy
 Readme:
   name: practices
-  columns:
-    - name: active
-      type: boolean
-      nullable: false
   models:
     - name: patients
       constraints:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dbee
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Ruggio
@@ -92,42 +92,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.1
+        version: 0.74.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.63.1
+        version: 0.74.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.2
+        version: 0.5.0
 description: "    Dbee provides a simple-to-use data modeling and query API.  The
   query API can produce SQL using other ORMs, such as Arel/ActiveRecord.  The targeted
   use-case for Dbee is ad-hoc reporting, so the total SQL feature-set that Dbee supports
@@ -156,9 +156,6 @@ files:
 - lib/dbee.rb
 - lib/dbee/base.rb
 - lib/dbee/model.rb
-- lib/dbee/model/columns.rb
-- lib/dbee/model/columns/boolean.rb
-- lib/dbee/model/columns/undefined.rb
 - lib/dbee/model/constraints.rb
 - lib/dbee/model/constraints/base.rb
 - lib/dbee/model/constraints/reference.rb
@@ -183,8 +180,6 @@ files:
 - lib/dbee/query/sorter.rb
 - lib/dbee/version.rb
 - spec/dbee/base_spec.rb
-- spec/dbee/model/columns/boolean_spec.rb
-- spec/dbee/model/columns/undefined_spec.rb
 - spec/dbee/model/constraints/base_spec.rb
 - spec/dbee/model/constraints/reference_spec.rb
 - spec/dbee/model/constraints/static_spec.rb
@@ -213,12 +208,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.3
+      version: 2.4.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: 
@@ -226,8 +221,6 @@ specification_version: 4
 summary: Adhoc Reporting SQL Generator
 test_files:
 - spec/dbee/base_spec.rb
-- spec/dbee/model/columns/boolean_spec.rb
-- spec/dbee/model/columns/undefined_spec.rb
 - spec/dbee/model/constraints/base_spec.rb
 - spec/dbee/model/constraints/reference_spec.rb
 - spec/dbee/model/constraints/static_spec.rb

data/lib/dbee/model/columns.rb

@@ -1,25 +0,0 @@
-# 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_relative 'columns/boolean'
-require_relative 'columns/undefined'
-
-module Dbee
-  class Model
-    # Top-level class that allows for the making of columns.  For example, you can call this as:
-    # - Columns.make(type: :boolean, name: :something)
-    # - Columns.make(type: :undefined, name: :something_else)
-    class Columns
-      acts_as_hashable_factory
-
-      register 'boolean',   Boolean
-      register 'undefined', Undefined
-    end
-  end
-end

data/lib/dbee/model/columns/boolean.rb

@@ -1,61 +0,0 @@
-# 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_relative 'undefined'
-
-module Dbee
-  class Model
-    class Columns
-      # Describes a boolean column that can accept a wide range of values and still resolves to
-      # a boolean, such as: true, t, yes, y, 1, false, f, n, 0, nil, null.
-      class Boolean < Undefined
-        attr_reader :nullable
-
-        alias nullable? nullable
-
-        def initialize(name:, nullable: true)
-          super(name: name)
-
-          @nullable = nullable
-
-          freeze
-        end
-
-        def ==(other)
-          super && other.nullable == nullable
-        end
-        alias eql? ==
-
-        def coerce(value)
-          if nullable? && nully?(value)
-            nil
-          elsif truthy?(value)
-            true
-          else
-            false
-          end
-        end
-
-        private
-
-        def null_or_empty?(val)
-          val.nil? || val.to_s.empty?
-        end
-
-        def nully?(val)
-          null_or_empty?(val) || val.to_s.match?(/\A(nil|null)$\z/i)
-        end
-
-        def truthy?(val)
-          val.to_s.match?(/\A(true|t|yes|y|1)$\z/i)
-        end
-      end
-    end
-  end
-end

data/lib/dbee/model/columns/undefined.rb

@@ -1,37 +0,0 @@
-# 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 Dbee
-  class Model
-    class Columns
-      # Any non-configured column will automatically be this type.
-      # Also doubles as the base class for all columns specification subclasses.
-      class Undefined
-        acts_as_hashable
-
-        attr_reader :name
-
-        def initialize(name:)
-          raise ArgumentError, 'name is required' if name.to_s.empty?
-
-          @name = name.to_s
-        end
-
-        def coerce(value)
-          value
-        end
-
-        def ==(other)
-          other.name == name
-        end
-        alias eql? ==
-      end
-    end
-  end
-end

data/spec/dbee/model/columns/boolean_spec.rb

@@ -1,74 +0,0 @@
-# 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.
-#
-
-# 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::Model::Columns::Boolean do
-  specify 'equality compares attributes' do
-    config = {
-      name: :a,
-      nullable: false
-    }
-
-    column1 = described_class.make(config)
-    column2 = described_class.make(config)
-
-    expect(column1).to eq(column2)
-    expect(column1).to eql(column2)
-  end
-
-  describe '#coerce' do
-    context 'when not nullable and value is a string' do
-      subject { described_class.make(name: :active, nullable: false) }
-
-      %w[y Y yes YES Yes yEs t True TRUE T TrUe 1].each do |value|
-        it "converts #{value} to true" do
-          expect(subject.coerce(value)).to be true
-        end
-      end
-
-      %w[n N no NO No nO f F FALSE 0 nil null Nil Null NULL NIL].each do |value|
-        it "converts #{value} to true" do
-          expect(subject.coerce(value)).to be false
-        end
-      end
-    end
-
-    context 'when nullable and value is a string' do
-      subject { described_class.make(name: :active, nullable: true) }
-
-      %w[y Y yes YES Yes yEs t True TRUE T TrUe 1].each do |value|
-        it "converts #{value} to true" do
-          expect(subject.coerce(value)).to be true
-        end
-      end
-
-      %w[n N no NO No nO f F FALSE 0].each do |value|
-        it "converts #{value} to true" do
-          expect(subject.coerce(value)).to be false
-        end
-      end
-
-      %w[nil null Nil Null NULL NIL].each do |value|
-        it "converts #{value} to true" do
-          expect(subject.coerce(value)).to be nil
-        end
-      end
-    end
-  end
-end

data/spec/dbee/model/columns/undefined_spec.rb

@@ -1,38 +0,0 @@
-# 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.
-#
-
-# 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::Model::Columns::Undefined do
-  let(:config) { { name: :some_column } }
-
-  subject { described_class.make(config) }
-
-  specify 'equality compares attributes' do
-    column1 = described_class.make(config)
-    column2 = described_class.make(config)
-
-    expect(column1).to eq(column2)
-    expect(column1).to eql(column2)
-  end
-
-  specify '#coerce returns value' do
-    value = 'abc123'
-    expect(subject.coerce(value)).to eq(value)
-  end
-end