parentry 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9ed402972198361a4692bb08c0e37de6c5ab2def
-  data.tar.gz: db76e44d21d704adfdab3acb58db9eb695be6a96
+SHA256:
+  metadata.gz: 66be4e773ca40d1773b87815cf33bd8d6f8cb4796718d64e4bec62ddeb53b3e5
+  data.tar.gz: 45039c18a5c69ebc0277cf38a48e46d3f17520be92e0409e6d1a4d5872f0b120
 SHA512:
-  metadata.gz: f026004b8d0a07e24c7f104fb5a5f7368b5864af578089c20e0babda9540b716b027c13e9d0d671db27b433a9c8a1bc434e166f66a867e54fc951a91c66e55da
-  data.tar.gz: 821a2c44e758aac123bd7f875abf1085ed18931a386ec533253ca365053cb9bb58cb3dd42d0fba2d6b31d81aaa395a2221fbbe9855d24f226e2aa8beeb148dac
+  metadata.gz: '000976a1fecf1bf1b004f44a1943d8f85e6d80b5835a3bb6a50efebd3735e6ee1cd116e8789759fce424130bab1b796a5992526112cf165f1556621c67c2b33f'
+  data.tar.gz: 136945945ecb766008a7545cadbd68b3d68a7d5bf151168991457831c0ddc1185dd87f89f1f5a78a1711afc046de60d08dd84452999eaec08acbbe30e5c53cb5

data/.github/workflows/ruby.yml

@@ -0,0 +1,72 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby:
+          - 2.5.x
+          - 2.6.x
+          - 2.7.x
+        activerecord:
+          - 5.1.5
+          - 5.2.0
+          - 6.0.0
+          - 6.1.0
+        strategy:
+          - array
+          - ltree
+
+    env:
+      BUNDLE_GEMFILE: ${{ github.workspace }}/gemfiles/activerecord_${{ matrix.activerecord }}.gemfile
+
+    services:
+      postgres:
+        image: postgres:12.4
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: parentry_test
+        ports:
+          - 5432:5432
+        # needed because the postgres container does not provide a healthcheck
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gems-${{ hashFiles(format('gemfiles/activerecord_{0}.gemfile.lock', matrix.activerecord)) }}
+          restore-keys: |
+            ${{ runner.os }}-gems-
+
+      - name: Install PostgreSQL client
+        run: |
+          sudo apt-get -yqq install libpq-dev
+
+      - name: Configure Bundler
+        run: |
+          gem install bundler:2.1.4 --no-document
+          bundle config set path 'vendor/bundle'
+          bundle install --jobs 4 --retry 3
+
+      - name: Run tests with RSpec
+        uses: paambaati/codeclimate-action@v2.5.4
+        env:
+          CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
+          STRATEGY: ${{ matrix.strategy }}
+        with:
+          coverageCommand: bundle exec rspec
+          debug: false

data/.gitignore

@@ -11,3 +11,4 @@
 .ruby-gemset
 .ruby-version
 /vendor/
+/spec/internal/log/*

data/.rubocop.yml

@@ -0,0 +1,38 @@
+inherit_mode:
+  merge:
+    - Exclude
+
+AllCops:
+  TargetRubyVersion: 2.6
+  Exclude:
+    - gemfiles/**
+
+Layout/LineLength:
+  Max: 120
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented_relative_to_receiver
+
+Naming/PredicateName:
+  AllowedMethods:
+    - has_many
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+Style/FormatStringToken:
+  EnforcedStyle: template
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: ()
+    '%w': '()'
+    '%W': '()'
+    '%i': '()'
+    '%I': '()'

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.7.2

data/Appraisals

@@ -1,3 +1,15 @@
-appraise 'activerecord-5.1' do
-  gem 'activerecord', '~> 5.1.0'
+appraise 'activerecord-5.1.5' do
+  gem 'activerecord', '5.1.5'
+end
+
+appraise 'activerecord-5.2.0' do
+  gem 'activerecord', '5.2.0'
+end
+
+appraise 'activerecord-6.0.0' do
+  gem 'activerecord', '6.0.0'
+end
+
+appraise 'activerecord-6.1.0' do
+  gem 'activerecord', '6.0.0'
 end

data/README.md

@@ -1,4 +1,5 @@
-[![Build Status](https://travis-ci.org/hasghari/parentry.svg?branch=master)](https://travis-ci.org/hasghari/parentry)
+![](https://github.com/hasghari/parentry/workflows/Ruby/badge.svg)
+[![Maintainability](https://api.codeclimate.com/v1/badges/cc7180328fffcbdea2bb/maintainability)](https://codeclimate.com/github/hasghari/parentry/maintainability)
 
 # Parentry
 
@@ -24,11 +25,26 @@ Or install it yourself as:
 
 ## Usage
 
-This gem requires 2 columns for each table: `parentry` and `parent_id`. A sample migration would look like:
+This gem requires 2 columns for each table: `parentry` and `parent_id`, and can leverage either the `ltree` postgresql extension, or else postgres `array` columns. A sample migration would look like:
 
 ```ruby
-add_column :my_table, :parentry, :ltree
+enable_extension 'ltree' # ltree is not turned on by default; skip if you use the array strategy
+
 add_column :my_table, :parent_id, :integer
+
+add_column :my_table, :parentry, :ltree
+add_column :my_table, :parentry_depth, :integer, default: 0 # optional
+
+add_index :my_table, :parentry, using: :gist
+```
+
+```ruby
+class MyTable < ApplicationRecord
+  include Parentry
+  parentry cache_depth: true
+  # to change strategy to array, and avoid dependency on ltree
+  # parentry strategy: :array
+end
 ```
 
 ## Contributing

data/Rakefile

@@ -6,4 +6,4 @@ require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/gemfiles/{activerecord_5.1.gemfile → activerecord_5.1.5.gemfile}

@@ -3,6 +3,6 @@
 source "https://rubygems.org"
 
 gem "appraisal"
-gem "activerecord", "~> 5.1.0"
+gem "activerecord", "5.1.5"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/activerecord_5.1.5.gemfile.lock

@@ -0,0 +1,143 @@
+PATH
+  remote: ..
+  specs:
+    parentry (1.3.0)
+      activerecord (>= 5.1, < 6.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.1.5)
+      actionview (= 5.1.5)
+      activesupport (= 5.1.5)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.5)
+      activesupport (= 5.1.5)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.1.5)
+      activesupport (= 5.1.5)
+    activerecord (5.1.5)
+      activemodel (= 5.1.5)
+      activesupport (= 5.1.5)
+      arel (~> 8.0)
+    activesupport (5.1.5)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (8.0.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    combustion (1.1.1)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.0.5)
+    crass (1.0.3)
+    database_cleaner (1.6.2)
+    diff-lcs (1.3)
+    docile (1.3.0)
+    erubi (1.7.1)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    json (2.3.1)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pg (1.2.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.4)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.1.5)
+      actionpack (= 5.1.5)
+      activesupport (= 5.1.5)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-rails (3.7.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.37.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 5.1.5)
+  appraisal
+  bundler (~> 2.1)
+  combustion (~> 1.1)
+  database_cleaner (~> 1.6)
+  parentry!
+  pg (~> 1.2)
+  pry (~> 0.10)
+  rake (~> 12.3)
+  rspec-rails (~> 3.7)
+  rubocop-rspec (~> 1.37)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   2.1.4

data/gemfiles/activerecord_5.2.0.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal"
+gem "activerecord", "5.2.0"
+
+gemspec path: "../"

data/gemfiles/activerecord_5.2.0.gemfile.lock

@@ -0,0 +1,143 @@
+PATH
+  remote: ..
+  specs:
+    parentry (1.3.0)
+      activerecord (>= 5.1, < 6.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.0)
+      activesupport (= 5.2.0)
+    activerecord (5.2.0)
+      activemodel (= 5.2.0)
+      activesupport (= 5.2.0)
+      arel (>= 9.0)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    arel (9.0.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    coderay (1.1.2)
+    combustion (1.1.1)
+      activesupport (>= 3.0.0)
+      railties (>= 3.0.0)
+      thor (>= 0.14.6)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    database_cleaner (1.6.2)
+    diff-lcs (1.3)
+    docile (1.3.0)
+    erubi (1.7.1)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    json (2.3.1)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.7)
+      mini_portile2 (~> 2.4.0)
+    parallel (1.19.1)
+    parser (2.7.0.2)
+      ast (~> 2.4.0)
+    pg (1.2.2)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.4)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.0)
+      actionpack (= 5.2.0)
+      activesupport (= 5.2.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-rails (3.7.2)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.79.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-rspec (1.37.1)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (= 5.2.0)
+  appraisal
+  bundler (~> 2.1)
+  combustion (~> 1.1)
+  database_cleaner (~> 1.6)
+  parentry!
+  pg (~> 1.2)
+  pry (~> 0.10)
+  rake (~> 12.3)
+  rspec-rails (~> 3.7)
+  rubocop-rspec (~> 1.37)
+  simplecov (~> 0.16)
+
+BUNDLED WITH
+   2.1.4