dbee-active_record 1.0.0.pre.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9a9c401d5b1bb61ca60f0ee1c1fd6c6f76d68fc768b7e35d0d885e5d66c1bcb9
+  data.tar.gz: 102ab3f38c5074992cde4a8e0a059a09fff22face4dc392bf7633fbbb1a00aad
+SHA512:
+  metadata.gz: fd65b523a86d65171ee3f603ac92a773ff5a29d6bc73706168048d01b1db7a28892c6534feb7e9603a8d1b6e7ba58e8c6bf801f0d870d5e0d616d009c330684b
+  data.tar.gz: c916e056d09e1564a43a1f4306b2671cff7b62f94efbf40ca2fcf32443bc6aceed083cc249fdbf778c6dbef423c28039a3cab98974e71828fb704442720a9f57

data/.editorconfig

@@ -0,0 +1,8 @@
+# See http://editorconfig.org/
+
+[*]
+trim_trailing_whitespace = true
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+end_of_line = lf

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+*.gem
+/tmp
+/coverage
+Gemfile.lock
+/pkg
+/spec/config/database.yaml

data/.rubocop.yml

@@ -0,0 +1,27 @@
+Metrics/LineLength:
+  Max: 100
+
+Metrics/BlockLength:
+  ExcludedMethods:
+    - let
+    - it
+    - describe
+    - context
+    - specify
+    - define
+
+Metrics/MethodLength:
+  Max: 25
+  Exclude:
+    - spec/db_helper.rb
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/AbcSize:
+  Max: 16
+  Exclude:
+    - spec/db_helper.rb
+
+Metrics/ClassLength:
+  Max: 125

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -0,0 +1,30 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=036a8fd92cf0c323c9704c041015837d14889e47de936bab18287626ff3372c1
+language: ruby
+services:
+  - mysql
+rvm:
+  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
+  - 2.6.3
+cache: bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+  - cp spec/config/database.yaml.ci spec/config/database.yaml
+  - mysql -e 'CREATE DATABASE IF NOT EXISTS dbee_test;'
+script:
+  - bundle exec rubocop
+  - bundle exec rspec spec --format documentation
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+addons:
+  # https://docs.travis-ci.com/user/uploading-artifacts/
+  artifacts:
+    paths:
+      - Gemfile.lock

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 1.0.0-alpha (August 20th, 2019)
+
+Added initial implementation.
+
+# 0.0.1 (August 18th, 2019)
+
+Initial library shell published.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at oss@bluemarblepayroll.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+guard :rspec, cmd: 'DISABLE_SIMPLECOV=true bundle exec rspec --format=documentation' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2019 Blue Marble Payroll, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,75 @@
+# Dbee Active Record Provider
+
+[![Gem Version](https://badge.fury.io/rb/dbee-active_record.svg)](https://badge.fury.io/rb/dbee-active_record) [![Build Status](https://travis-ci.org/bluemarblepayroll/dbee-active_record.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/dbee-active_record) [![Maintainability](https://api.codeclimate.com/v1/badges/7f74a4e546bebb603cce/maintainability)](https://codeclimate.com/github/bluemarblepayroll/dbee-active_record/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/7f74a4e546bebb603cce/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/dbee-active_record/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+Dbee does not ship with a SQL generator by default.  This library plugs into Dbee to provide SQL generation via ActiveRecord.  Technically speaking: this library does not use ActiveRecord for anything except connection information.  All actual SQL generation is performed using Arel.  There is no actual coupling of your domain ActiveRecord subclasses to Dbee.
+
+This library is a plugin for [Dbee](https://github.com/bluemarblepayroll/dbee).  The Dbee repositories README file contains information about how to use the Data Model and Query API's.
+
+## Installation
+
+To install through Rubygems:
+
+````
+gem install install dbee-active_record
+````
+
+You can also add this to your Gemfile:
+
+````
+bundle add dbee-active_record
+````
+
+## Contributing
+
+### Development Environment Configuration
+
+Basic steps to take to get this repository compiling:
+
+1. Install [Ruby](https://www.ruby-lang.org/en/documentation/installation/) (check dbee-active_record.gemspec for versions supported)
+2. Install bundler (gem install bundler)
+3. Clone the repository (git clone git@github.com:bluemarblepayroll/dbee-active_record.git)
+4. Navigate to the root folder (cd dbee-active_record)
+5. Install dependencies (bundle)
+6. Copy spec/config/database.yaml.ci to spec/config/database.yaml. Customize both sqlite and mysql connections per your local environment.
+
+### Running Tests
+
+To execute the test suite run:
+
+````bash
+bundle exec rspec spec --format documentation
+````
+
+Alternatively, you can have Guard watch for changes:
+
+````bash
+bundle exec guard
+````
+
+Also, do not forget to run Rubocop:
+
+````bash
+bundle exec rubocop
+````
+
+### Publishing
+
+Note: ensure you have proper authorization before trying to publish new versions.
+
+After code changes have successfully gone through the Pull Request review process then the following steps should be followed for publishing new versions:
+
+1. Merge Pull Request into master
+2. Update `lib/dbee-active_record/version.rb` using [semantic versioning](https://semver.org/)
+3. Install dependencies: `bundle`
+4. Update `CHANGELOG.md` with release notes
+5. Commit & push master to remote and ensure CI builds master successfully
+6. Run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Code of Conduct
+
+Everyone interacting in this codebase, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/bluemarblepayroll/dbee-active_record/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+This project is MIT Licensed.

data/Rakefile

@@ -0,0 +1,15 @@
+# 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 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# 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 'bundler/setup'
+require 'dbee/providers/active_record_provider'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start

data/dbee-active_record.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require './lib/dbee/providers/active_record_provider/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'dbee-active_record'
+  s.version     = Dbee::Providers::ActiveRecordProvider::VERSION
+  s.summary     = 'Plugs in ActiveRecord so Dbee can use Arel for SQL generation.'
+
+  s.description = <<-DESCRIPTION
+    By default Dbee ships with no underlying SQL generator.  This library will plug in ActiveRecord into Dbee and Dbee will use it for SQL generation.
+  DESCRIPTION
+
+  s.authors     = ['Matthew Ruggio']
+  s.email       = ['mruggio@bluemarblepayroll.com']
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.homepage    = 'https://github.com/bluemarblepayroll/dbee-active_record'
+  s.license     = 'MIT'
+
+  s.required_ruby_version = '>= 2.3.8'
+
+  s.add_dependency('activerecord', '~>5', '>=5.2.1')
+  s.add_dependency('dbee', '>=1.0.0.pre.alpha.1')
+
+  s.add_development_dependency('guard-rspec', '~>4.7')
+  s.add_development_dependency('mysql2', '~>0.5')
+  s.add_development_dependency('pry', '~>0')
+  s.add_development_dependency('rake', '~> 12')
+  s.add_development_dependency('rspec', '~> 3.8')
+  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('sqlite3', '~>1')
+end

data/lib/dbee/providers/active_record_provider/expression_builder/constraint_maker.rb

@@ -0,0 +1,50 @@
+# 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
+  module Providers
+    class ActiveRecordProvider
+      class ExpressionBuilder
+        # Can derive constraints for Arel table JOIN statements.
+        class ConstraintMaker
+          CONCAT_METHOD = lambda do |on, arel_column, value|
+            on ? on.and(arel_column.eq(value)) : arel_column.eq(value)
+          end
+
+          METHODS = {
+            Model::Constraints::Reference => lambda do |constraint, on, table, previous_table|
+              name    = constraint.name
+              parent  = constraint.parent
+
+              CONCAT_METHOD.call(on, table[name], previous_table[parent])
+            end,
+            Model::Constraints::Static => lambda do |constraint, on, table, _previous_table|
+              name  = constraint.name
+              value = constraint.value
+
+              CONCAT_METHOD.call(on, table[name], value)
+            end
+          }.freeze
+
+          private_constant :METHODS
+
+          def make(constraints, table, previous_table)
+            constraints.inject(nil) do |memo, constraint|
+              method = METHODS[constraint.class]
+
+              raise ArgumentError, "constraint unhandled: #{constraint.class.name}" unless method
+
+              method.call(constraint, memo, table, previous_table)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dbee/providers/active_record_provider/expression_builder/order_maker.rb

@@ -0,0 +1,23 @@
+# 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
+  module Providers
+    class ActiveRecordProvider
+      class ExpressionBuilder
+        # Derives Arel#order predicates.
+        class OrderMaker
+          def make(sorter, arel_column)
+            sorter.ascending? ? arel_column : arel_column.desc
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dbee/providers/active_record_provider/expression_builder/select_maker.rb

@@ -0,0 +1,31 @@
+# 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
+  module Providers
+    class ActiveRecordProvider
+      class ExpressionBuilder
+        # Derives Arel#project predicates.
+        class SelectMaker
+          def make(column, arel_column, alias_maker)
+            column_alias = quote(alias_maker.make(column.display))
+
+            arel_column.as(column_alias)
+          end
+
+          private
+
+          def quote(value)
+            ActiveRecord::Base.connection.quote(value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dbee/providers/active_record_provider/expression_builder/where_maker.rb

@@ -0,0 +1,54 @@
+# 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
+  module Providers
+    class ActiveRecordProvider
+      class ExpressionBuilder
+        # Derives Arel#where predicates.
+        class WhereMaker
+          METHODS = {
+            Query::Filters::Contains => ->(column, val) { column.matches("%#{val}%") },
+            Query::Filters::Equals => ->(column, val) { column.eq(val) },
+            Query::Filters::GreaterThan => ->(column, val) { column.gt(val) },
+            Query::Filters::GreaterThanOrEqualTo => ->(column, val) { column.gteq(val) },
+            Query::Filters::LessThan => ->(column, val) { column.lt(val) },
+            Query::Filters::LessThanOrEqualTo => ->(column, val) { column.lteq(val) },
+            Query::Filters::NotContain => ->(column, val) { column.does_not_match("%#{val}%") },
+            Query::Filters::NotEquals => ->(column, val) { column.not_eq(val) },
+            Query::Filters::NotStartWith => ->(column, val) { column.does_not_match("#{val}%") },
+            Query::Filters::StartsWith => ->(column, val) { column.matches("#{val}%") }
+          }.freeze
+
+          private_constant :METHODS
+
+          def make(filter, arel_column, model_column)
+            coerced_values = Array(filter.value).map { |v| model_column.coerce(v) }
+
+            predicates = coerced_values.map do |coerced_value|
+              method = METHODS[filter.class]
+
+              raise ArgumentError, "cannot compile filter: #{filter}" unless method
+
+              method.call(arel_column, coerced_value)
+            end
+
+            clause = predicates.shift
+
+            predicates.each do |predicate|
+              clause = clause.or(predicate)
+            end
+
+            clause
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dbee/providers/active_record_provider/expression_builder.rb

@@ -0,0 +1,169 @@
+# 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 'expression_builder/constraint_maker'
+require_relative 'expression_builder/order_maker'
+require_relative 'expression_builder/select_maker'
+require_relative 'expression_builder/where_maker'
+
+module Dbee
+  module Providers
+    class ActiveRecordProvider
+      # This class can generate an Arel expression tree.
+      class ExpressionBuilder
+        extend Forwardable
+
+        def_delegators :statement, :to_sql
+
+        def initialize(model, table_alias_maker, column_alias_maker)
+          @model              = model
+          @table_alias_maker  = table_alias_maker
+          @column_alias_maker = column_alias_maker
+
+          @base_table = Arel::Table.new(model.table)
+          @base_table.table_alias = table_alias_maker.make(model.name)
+
+          @statement = base_table
+        end
+
+        def add(query)
+          query.fields.each   { |field| add_field(field) }
+          query.sorters.each  { |sorter| add_sorter(sorter) }
+          query.filters.each  { |filter| add_filter(filter) }
+
+          add_limit(query.limit)
+
+          self
+        end
+
+        private
+
+        attr_reader :base_table,
+                    :statement,
+                    :model,
+                    :table_alias_maker,
+                    :column_alias_maker
+
+        def tables
+          @tables ||= {}
+        end
+
+        def key_paths_to_arel_columns
+          @key_paths_to_arel_columns ||= {}
+        end
+
+        def key_paths_to_model_columns
+          @key_paths_to_model_columns ||= {}
+        end
+
+        def where_maker
+          @where_maker ||= WhereMaker.new
+        end
+
+        def order_maker
+          @order_maker ||= OrderMaker.new
+        end
+
+        def select_maker
+          @select_maker ||= SelectMaker.new
+        end
+
+        def constraint_maker
+          @constraint_maker ||= ConstraintMaker.new
+        end
+
+        def add_filter(filter)
+          add_key_path(filter.key_path)
+
+          key_path      = filter.key_path
+          arel_column   = key_paths_to_arel_columns[key_path]
+          model_column  = key_paths_to_model_columns[key_path]
+
+          predicate = where_maker.make(filter, arel_column, model_column)
+
+          @statement = statement.where(predicate)
+
+          self
+        end
+
+        def add_sorter(sorter)
+          add_key_path(sorter.key_path)
+
+          key_path = sorter.key_path
+          arel_column = key_paths_to_arel_columns[key_path]
+
+          predicate = order_maker.make(sorter, arel_column)
+
+          @statement = statement.order(predicate)
+
+          self
+        end
+
+        def add_field(field)
+          add_key_path(field.key_path)
+
+          key_path = field.key_path
+          arel_column = key_paths_to_arel_columns[key_path]
+
+          predicate = select_maker.make(field, arel_column, column_alias_maker)
+
+          @statement = statement.project(predicate)
+
+          self
+        end
+
+        def add_limit(limit)
+          @limit = limit ? limit.to_i : nil
+
+          @statement = @statement.take(limit) if limit
+
+          self
+        end
+
+        def model_column(ancestors, key_path)
+          model_column = (ancestors.values.last || model).column(key_path.column_name)
+          key_paths_to_model_columns[key_path] = model_column
+        end
+
+        def table(name, model, previous_table)
+          table = Arel::Table.new(model.table)
+          table.table_alias = table_alias_maker.make(name)
+
+          on = constraint_maker.make(model.constraints, table, previous_table)
+
+          @statement = statement.join(table, ::Arel::Nodes::OuterJoin)
+          @statement = statement.on(on) if on
+
+          tables[name] = table
+        end
+
+        def traverse_ancestors(ancestors)
+          ancestors.each_pair.inject(base_table) do |memo, (name, model)|
+            tables.key?(name) ? tables[name] : table(name, model, memo)
+          end
+        end
+
+        def add_key_path(key_path)
+          return if key_paths_to_arel_columns.key?(key_path)
+
+          ancestors = model.ancestors(key_path.ancestor_names)
+
+          model_column(ancestors, key_path)
+
+          table = traverse_ancestors(ancestors)
+
+          arel_column = table[key_path.column_name]
+          key_paths_to_arel_columns[key_path] = arel_column
+
+          self
+        end
+      end
+    end
+  end
+end