dbee 1.0.0.pre.alpha → 1.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3da5072dedecfdcd75c8f1478c3a4f60bf477af59a48005044dc0e839e3a85d
-  data.tar.gz: 13bcece761321e1690907a05a87c257ad2829b9607152eab5d0f74f2b64605fa
+  metadata.gz: 985c6ab788915c22ed43fea867eb23d4dc4622a2457e814bbedbcd7c42f8d43a
+  data.tar.gz: ffbceb601e3be40c40f002eb36d8ebc7f2f401add22d18c8b4793de69330cc33
 SHA512:
-  metadata.gz: 266465af7710306656ff8dc171a89c4f1f190c6d20e1959072a50bbead4e508ab4740f4c047ee187908a4414ee5b7e6f3fba66bbba8a0f2868a449165f4a1ff2
-  data.tar.gz: '09f63b6d657888cbc33d637422632345980f44cd53a56995cdc470585291aa7f77d38c877e7fa6a9c654f3f3f61890ee7a88fddf53d9b349bdddac3d7ef80f89'
+  metadata.gz: 5a8c4b1974893e73ef057e947828305b4fcf6ea76733f88758b290b140c956c62a11a1a32de7bc9eb20d82cd70f38e052024bf78511daa2ee1913aae5307b7d1
+  data.tar.gz: 8b6212eda28dcd468bd2de7325fd635865831a0991a28a3784fad472b3f5fe719aceefa0b5200c0517cad08e47bc6380e0c9a244cf19e5715c51c05ee128ccd3

data/README.md

@@ -115,6 +115,8 @@ module ReadmeDataModels
   end
 
   class Practices < Dbee::Base
+    boolean_column :active, nullable: false
+
     association :patients, model: Patients, constraints: {
       type: :reference, name: :practice_id, parent: :id
     }
@@ -123,7 +125,10 @@ end
 
 ````
 
-*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'*
+A couple notes:
+
+* 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
 
@@ -131,6 +136,10 @@ 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/lib/dbee/base.rb

@@ -12,6 +12,10 @@ 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
 
@@ -35,6 +39,10 @@ module Dbee
         @table_name.to_s
       end
 
+      def columns_by_name
+        @columns_by_name ||= {}
+      end
+
       def associations_by_name
         @associations_by_name ||= {}
       end
@@ -47,6 +55,12 @@ module Dbee
         ''
       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)
@@ -65,6 +79,7 @@ module Dbee
 
       def model_config(name, constraints)
         {
+          columns: columns,
           constraints: constraints,
           models: associations,
           name: name,
@@ -82,6 +97,12 @@ 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/columns/boolean.rb

@@ -0,0 +1,63 @@
+# 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.  The main value here is the value is pretty pliable.
+      # For example: the value 'y' or '1' will be coerced to true.
+      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
+
+        # rubocop:disable Style/DoubleNegation
+        def nully?(val)
+          null_or_empty?(val) || !!(val.to_s =~ /(nil|null)$/i)
+        end
+
+        def truthy?(val)
+          !!(val.to_s =~ /(true|t|yes|y|1)$/i)
+        end
+        # rubocop:enable Style/DoubleNegation
+      end
+    end
+  end
+end

data/lib/dbee/model/columns/undefined.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.
+#
+
+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/lib/dbee/model/columns.rb

@@ -0,0 +1,25 @@
+# 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.rb

@@ -7,6 +7,7 @@
 # LICENSE file in the root directory of this source tree.
 #
 
+require_relative 'model/columns'
 require_relative 'model/constraints'
 
 module Dbee
@@ -21,10 +22,11 @@ module Dbee
 
     attr_reader :constraints, :name
 
-    def initialize(name:, constraints: [], models: [], table: '')
+    def initialize(name:, columns: [], 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
@@ -44,6 +46,14 @@ 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?
 
@@ -68,12 +78,13 @@ module Dbee
       other.name == name &&
         other.table == table &&
         other.models == models &&
-        other.constraints == constraints
+        other.constraints == constraints &&
+        other.columns == columns
     end
     alias eql? ==
 
     private
 
-    attr_reader :models_by_name
+    attr_reader :models_by_name, :columns_by_name
   end
 end

data/lib/dbee/version.rb

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

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

@@ -0,0 +1,74 @@
+# 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

@@ -0,0 +1,38 @@
+# 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

data/spec/dbee/model/constraints_spec.rb

@@ -10,14 +10,14 @@
 require 'spec_helper'
 
 describe Dbee::Model::Constraints do
-  CONFIG = { name: :a }.freeze
+  CONSTRAINT_CONFIG = { name: :a }.freeze
 
-  FACTORIES = {
-    Dbee::Model::Constraints::Reference => CONFIG.merge(parent: :b, type: :reference),
-    Dbee::Model::Constraints::Static => CONFIG.merge(value: :b, type: :static)
+  CONSTRAINT_FACTORIES = {
+    Dbee::Model::Constraints::Reference => CONSTRAINT_CONFIG.merge(parent: :b, type: :reference),
+    Dbee::Model::Constraints::Static => CONSTRAINT_CONFIG.merge(value: :b, type: :static)
   }.freeze
 
-  FACTORIES.each_pair do |constant, config|
+  CONSTRAINT_FACTORIES.each_pair do |constant, config|
     it "should instantiate #{constant} objects" do
       expect(described_class.make(config)).to be_a(constant)
     end

data/spec/dbee/model_spec.rb

@@ -55,6 +55,28 @@ 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/dbee/query/filters_spec.rb

@@ -10,22 +10,24 @@
 require 'spec_helper'
 
 describe Dbee::Query::Filters do
-  CONFIG = { key_path: 'a.b.c', value: :d }.freeze
+  FILTERS_CONFIG = { key_path: 'a.b.c', value: :d }.freeze
 
-  FACTORIES = {
-    Dbee::Query::Filters::Contains => CONFIG.merge(type: :contains),
-    Dbee::Query::Filters::Equals => CONFIG.merge(type: :equals),
-    Dbee::Query::Filters::GreaterThanOrEqualTo => CONFIG.merge(type: :greater_than_or_equal_to),
-    Dbee::Query::Filters::GreaterThan => CONFIG.merge(type: :greater_than),
-    Dbee::Query::Filters::LessThanOrEqualTo => CONFIG.merge(type: :less_than_or_equal_to),
-    Dbee::Query::Filters::LessThan => CONFIG.merge(type: :less_than),
-    Dbee::Query::Filters::NotContain => CONFIG.merge(type: :not_contain),
-    Dbee::Query::Filters::NotEquals => CONFIG.merge(type: :not_equals),
-    Dbee::Query::Filters::NotStartWith => CONFIG.merge(type: :not_start_with),
-    Dbee::Query::Filters::StartsWith => CONFIG.merge(type: :starts_with)
+  FILTER_FACTORIES = {
+    Dbee::Query::Filters::Contains => FILTERS_CONFIG.merge(type: :contains),
+    Dbee::Query::Filters::Equals => FILTERS_CONFIG.merge(type: :equals),
+    Dbee::Query::Filters::GreaterThanOrEqualTo => FILTERS_CONFIG.merge(
+      type: :greater_than_or_equal_to
+    ),
+    Dbee::Query::Filters::GreaterThan => FILTERS_CONFIG.merge(type: :greater_than),
+    Dbee::Query::Filters::LessThanOrEqualTo => FILTERS_CONFIG.merge(type: :less_than_or_equal_to),
+    Dbee::Query::Filters::LessThan => FILTERS_CONFIG.merge(type: :less_than),
+    Dbee::Query::Filters::NotContain => FILTERS_CONFIG.merge(type: :not_contain),
+    Dbee::Query::Filters::NotEquals => FILTERS_CONFIG.merge(type: :not_equals),
+    Dbee::Query::Filters::NotStartWith => FILTERS_CONFIG.merge(type: :not_start_with),
+    Dbee::Query::Filters::StartsWith => FILTERS_CONFIG.merge(type: :starts_with)
   }.freeze
 
-  FACTORIES.each_pair do |constant, config|
+  FILTER_FACTORIES.each_pair do |constant, config|
     it "should instantiate #{constant} objects" do
       expect(described_class.make(config)).to be_a(constant)
     end

data/spec/fixtures/models.rb

@@ -49,9 +49,12 @@ 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 }
@@ -108,6 +111,8 @@ 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,6 +1,12 @@
 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
@@ -60,6 +66,10 @@ Theaters, Members, and Movies:
               value: comedy
 Readme:
   name: practices
+  columns:
+    - name: active
+      type: boolean
+      nullable: false
   models:
     - name: patients
       constraints:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbee
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha
+  version: 1.0.0.pre.alpha.1
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2019-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -156,6 +156,9 @@ 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
@@ -180,6 +183,8 @@ 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
@@ -221,6 +226,8 @@ 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