dbee 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b8250c307ad60bdb8bc51e19fdb93b2c9eb3db0cccfb5daad0a2e621aab57cb
-  data.tar.gz: db66f66f4a56dd40bbaa347218d0827291c789733b9c3f7086ca416e85a09246
+  metadata.gz: 234c40439102547cc3c8b78cbde5bc3755fcf49d8515c81eed7c7942f1c6a526
+  data.tar.gz: b9bb06a2e773786bb7e19b541f1dd6f104909baeea93148bbde78f9c5965ced8
 SHA512:
-  metadata.gz: '0085b06c34404de9b93b728713fd118189a2693920668685e66574c2bd23b8cb2009d0ab4a047dbbc8b4e7c69084a3ec595d1fa80aaf6de06bce023d5fff3d1a'
-  data.tar.gz: a295c963939ce9df84689bd3ab34852df111a7c57e685ac07abdb661498dc269fe85e661fae49b77826e43054030fb09c18fe7da648a1cdc78020024bac15a52
+  metadata.gz: 3484318a258c8788fa7b08533cb3b27679fc52903e70f2914d4ab8ddd36921fcf628d3f934dbc0704fbf38f1d49c03c087a3c656121d0266083c3c98e41cde75
+  data.tar.gz: 53c8425f56c659f222d729c71855d4c1ecaaa3dd90d21ced647152d49c00bdc5ed2bc550bae7c307f098835a13d165c423685033df6ffee62e3867bfc32c0224

data/.circleci/config.yml

@@ -0,0 +1,71 @@
+version: 2.1
+
+orbs:
+  status_to_ms_teams: bluemarblepayroll/status_to_ms_teams_pure_bash@1.0.0
+
+jobs:
+  build:
+    parameters:
+      use-bundler-cache:
+        type: boolean
+        default: true
+
+    docker:
+      - image: circleci/ruby:2.6.6-buster
+        environment:
+          FORBID_FOCUSED_SPECS: 1
+    working_directory: ~/dbee
+    steps:
+      - checkout
+
+      # TODO: wrap bundler caching logic into an Orb:
+      - when:
+          condition: << parameters.use-bundler-cache >>
+          steps:
+            - restore_cache:
+                key: v1.0.0-build-ruby-dependency-cache-{{ checksum "dbee.gemspec" }}-{{ checksum "Gemfile" }}-{{ checksum ".ruby-version" }}
+
+      - run: bundle install --path vendor/bundle
+
+      - when:
+          condition: << parameters.use-bundler-cache >>
+          steps:
+            - save_cache:
+                key: v1.0.0-build-ruby-dependency-cache-{{ checksum "dbee.gemspec" }}-{{ checksum "Gemfile" }}-{{ checksum ".ruby-version" }}
+                paths:
+                  - vendor/bundle
+
+      - store_artifacts:
+          path: Gemfile.lock
+
+      - run: bundle exec rubocop
+
+      - run: COVERAGE=true bundle exec rspec -r rspec_junit_formatter --format progress --format RspecJunitFormatter -o test-results/rspec/results.xml
+
+      - store_test_results:
+          path: test-results
+
+      - store_artifacts:
+          path: coverage
+
+      - status_to_ms_teams/report:
+          webhook_url: $MS_TEAMS_WEBHOOK_URL
+
+workflows:
+  version: 2.1
+  build:
+    jobs:
+      - build:
+          context: org-global
+  monthly-gem-dependency-refresh-check:
+    triggers:
+      - schedule:
+          cron: '0 0 1 * *'
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - build:
+          context: org-global
+          use-bundler-cache: false

data/.rubocop.yml

@@ -6,7 +6,7 @@ Layout/LineLength:
   Max: 100
 
 Metrics/AbcSize:
-  Max: 16
+  Max: 20
 
 Metrics/BlockLength:
   IgnoredMethods:

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.6

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 3.1.0 (October 4th, 2021)
+
+Additions
+
+* Added Query#offset to help with callers needing paging support.
 # 3.0.0 (March 11th, 2021)
 
 ### Additions

data/README.md

@@ -1,6 +1,6 @@
 # Dbee
 
-[![Gem Version](https://badge.fury.io/rb/dbee.svg)](https://badge.fury.io/rb/dbee) [![Build Status](https://travis-ci.org/bluemarblepayroll/dbee.svg?branch=master)](https://travis-ci.org/bluemarblepayroll/dbee) [![Maintainability](https://api.codeclimate.com/v1/badges/208b36a1d13751687df9/maintainability)](https://codeclimate.com/github/bluemarblepayroll/dbee/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/208b36a1d13751687df9/test_coverage)](https://codeclimate.com/github/bluemarblepayroll/dbee/test_coverage) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![CircleCI](https://circleci.com/bb/bluemarble-ondemand/dbee/tree/master.svg?style=svg&circle-token=7f7afbea94912b2b75a889cae3e2c46a3a869d21)](https://circleci.com/bb/bluemarble-ondemand/dbee/tree/master)
 
 Dbee arose out of a need for an ad-hoc reporting solution that included:
 
@@ -25,7 +25,7 @@ This specific library is the core modeling component of the Dbee framework, but
 To install through Rubygems:
 
 ````
-gem install install dbee
+gem install dbee
 ````
 
 You can also add this to your Gemfile:
@@ -310,7 +310,7 @@ query = {
 }
 ````
 
-Get all practices, limit to 10, and sort by name (descending) then id (ascending):
+Get all practices, limit to 2, offset by 3, and sort by name (descending) then id (ascending):
 
 ````ruby
 query = {
@@ -324,7 +324,8 @@ query = {
     { key_path: 'name', direction: :descending },
     { key_path: 'id' }
   ],
-  limit: 10
+  limit: 2,
+  offset: 3
 }
 ````
 
@@ -661,7 +662,7 @@ 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/version.rb` using [semantic versioning](https://semver.org/)
+2. Update `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

data/dbee.gemspec

@@ -17,15 +17,7 @@ Gem::Specification.new do |s|
   s.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.bindir      = 'exe'
   s.executables = []
-  s.homepage    = 'https://github.com/bluemarblepayroll/dbee'
   s.license     = 'MIT'
-  s.metadata    = {
-    'bug_tracker_uri' => 'https://github.com/bluemarblepayroll/dbee/issues',
-    'changelog_uri' => 'https://github.com/bluemarblepayroll/dbee/blob/master/CHANGELOG.md',
-    'documentation_uri' => 'https://www.rubydoc.info/gems/dbee',
-    'homepage_uri' => s.homepage,
-    'source_code_uri' => s.homepage
-  }
 
   s.required_ruby_version = '>= 2.5'
 
@@ -37,6 +29,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('pry-byebug')
   s.add_development_dependency('rake', '~> 13')
   s.add_development_dependency('rspec')
+  s.add_development_dependency('rspec_junit_formatter')
   s.add_development_dependency('rubocop', '~> 1')
   s.add_development_dependency('rubocop-rake')
   s.add_development_dependency('rubocop-rspec')

data/lib/dbee/dsl_schema_builder.rb

@@ -37,7 +37,7 @@ module Dbee
 
     private
 
-    def model_config(dsl_model) #:nodoc:
+    def model_config(dsl_model) # :nodoc:
       {
         name: dsl_model.inflected_class_name,
         partitioners: dsl_model.inherited_partitioners,

data/lib/dbee/query.rb

@@ -25,6 +25,7 @@ module Dbee
                 :filters,
                 :from,
                 :limit,
+                :offset,
                 :sorters
 
     def_delegator :fields,   :sort, :sorted_fields
@@ -36,12 +37,14 @@ module Dbee
       from: nil,
       filters: [],
       limit: nil,
+      offset: nil,
       sorters: []
     )
       @fields  = Field.array(fields)
       @filters = Filters.array(filters).uniq
       @from    = from.to_s
       @limit   = limit.to_s.empty? ? nil : limit.to_i
+      @offset  = offset.to_s.empty? ? nil : offset.to_i
       @sorters = Sorters.array(sorters).uniq
 
       freeze
@@ -50,6 +53,7 @@ module Dbee
     def ==(other)
       other.instance_of?(self.class) &&
         other.limit == limit &&
+        other.offset == offset &&
         other.from == from &&
         other.sorted_fields == sorted_fields &&
         other.sorted_filters == sorted_filters &&

data/lib/dbee/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Dbee
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 end

data/spec/dbee/query_spec.rb

@@ -17,7 +17,7 @@ README_EXAMPLES = {
       { key_path: 'name' }
     ]
   },
-  'Get all practices, limit to 10, and sort by name (descending) then id (ascending)' => {
+  'Get practices, limit to 2, offset by 3, and sort by name (descending) then id (ascending)' => {
     fields: [
       { key_path: 'id' },
       { key_path: 'active' },
@@ -27,7 +27,8 @@ README_EXAMPLES = {
       { key_path: 'name', direction: :descending },
       { key_path: 'id' }
     ],
-    limit: 10
+    limit: 2,
+    offset: 3
   },
   "Get top 5 active practices and patient whose name start with 'Sm':" => {
     fields: [

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dbee
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-11 00:00:00.000000000 Z
+date: 2021-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -114,6 +114,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec_junit_formatter
+  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: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -194,11 +208,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".editorconfig"
 - ".gitignore"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
+- ".tool-versions"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -277,15 +292,10 @@ files:
 - spec/fixtures/models.rb
 - spec/fixtures/models.yaml
 - spec/spec_helper.rb
-homepage: https://github.com/bluemarblepayroll/dbee
+homepage:
 licenses:
 - MIT
-metadata:
-  bug_tracker_uri: https://github.com/bluemarblepayroll/dbee/issues
-  changelog_uri: https://github.com/bluemarblepayroll/dbee/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/dbee
-  homepage_uri: https://github.com/bluemarblepayroll/dbee
-  source_code_uri: https://github.com/bluemarblepayroll/dbee
+metadata: {}
 post_install_message:
 rdoc_options: []
 require_paths:

data/.travis.yml

@@ -1,25 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=e7db23dad7560a076e48357331b0362db3741b62dbdd537bc30de27fa9cab69b
-    - DISABLE_RSPEC_FOCUS=true
-language: ruby
-rvm:
-  # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
-  - 2.5.8
-  - 2.6.6
-  - 2.7.2
-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
-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