consyncful-tree 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8f9dfd640ea20ac184288e3af655a3def80755429ca2d0880d3d05af4848bd3f
+  data.tar.gz: e523aa66dcc6f005f661eb4bba23644f52b83b0a48d6fb0b6774ec631b760fc9
+SHA512:
+  metadata.gz: 3f68b3fef751d66d2e3ae02d4a21819fda521a1bbd3ae49bbc5a5c78eb81826ed37d5bc83a11c094ce232995d465443000fdca03585303be7dfcf6a7d40735ce
+  data.tar.gz: 98a49750eb6a42057da56e97e92b36cce1ac9fb9d8618428b62fcc95232b3f4f52150cca265fde4bbf5376f88f8f0bffb4f58ca28ae829b6001faf43c010e3b6

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [1.0.0] - 2022-06-14
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in consyncful-tree.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,134 @@
+PATH
+  remote: .
+  specs:
+    consyncful-tree (1.0.0)
+      consyncful (~> 0.7.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.3)
+      activesupport (= 7.0.3)
+    activesupport (7.0.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    bson (4.15.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    consyncful (0.7.0)
+      contentful (>= 2.11.1, < 3.0.0)
+      hooks (>= 0.4.1)
+      mongoid (>= 7.0.2, < 8.0.0)
+      rainbow
+    contentful (2.16.3)
+      http (> 0.8, < 5.0)
+      multi_json (~> 1)
+    database_cleaner-core (2.0.1)
+    database_cleaner-mongoid (2.0.1)
+      database_cleaner-core (~> 2.0.0)
+      mongoid
+    diff-lcs (1.5.0)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    hooks (0.4.1)
+      uber (~> 0.0.14)
+    http (4.4.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.2)
+      http-parser (~> 1.2.0)
+    http-cookie (1.0.5)
+      domain_name (~> 0.5)
+    http-form_data (2.3.0)
+    http-parser (1.2.3)
+      ffi-compiler (>= 1.0, < 2.0)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    mongo (2.17.1)
+      bson (>= 4.8.2, < 5.0.0)
+    mongoid (7.4.0)
+      activemodel (>= 5.1, < 7.1, != 7.0.0)
+      mongo (>= 2.10.5, < 3.0.0)
+      ruby2_keywords (~> 0.0.5)
+    multi_json (1.15.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    uber (0.0.15)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.8.2)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2)
+  consyncful-tree!
+  database_cleaner-mongoid (~> 2.0)
+  pry-byebug
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.3.7

data/README.md

@@ -0,0 +1,64 @@
+# Consyncful::Tree
+
+For those already using the `consyncful` gem, `consyncful-tree` provides a few additional concerns to help with Consyncful models nested in a tree structure.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'consyncful-tree'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install consyncful-tree
+
+## Usage
+
+### Parent
+Include the Consyncful::Tree::Parent concern in a Consyncful model that you want to keep track of the dependencies of.
+
+```
+class ModelName < Consyncful::Base
+  include Consyncful::Tree::Parent
+
+  ...
+end
+```
+
+This will give you the following three methods that recursively traverse the `references_one` + `references_many` relationships:
+```
+lookup_child_model_ids
+
+lookup_child_models
+
+with_child_class_of?
+```
+
+### Child
+
+Include the Consyncful::Tree::Child concern in any Consyncful model that is a dependency of a Consyncful::Tree::Parent and that should touch that parent when it is updated.
+
+```
+class ModelName < Consyncful::Base
+  include Consyncful::Tree::Child
+
+  ...
+end
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).  You'll need an account on [rubygems.org](https://rubygems.org), you'll also need a current owner of the gem to add you as an owner.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DigitalNZ/consyncful-tree.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/consyncful-tree.gemspec

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative "lib/consyncful/tree/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "consyncful-tree"
+  spec.version = Consyncful::Tree::VERSION
+  spec.authors = ["DigitalNZ"]
+  spec.email = ["info@digitalnz.org"]
+
+  spec.summary = "Code to help with adding a tree structure to Contentful models."
+  spec.description = "Code to help with adding a tree structure to Contentful models."
+  spec.homepage = "https://github.com/DigitalNZ/consyncful-tree"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/DigitalNZ/consyncful-tree"
+  spec.metadata["changelog_uri"] = "https://github.com/DigitalNZ/consyncful-tree/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "database_cleaner-mongoid", "~> 2.0"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rake"
+  spec.add_development_dependency "rubocop-rspec"
+
+  spec.add_dependency "consyncful", "~> 0.7.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

data/lib/consyncful/tree/concerns/child.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Consyncful
+  module Tree
+    module Child
+      extend ActiveSupport::Concern
+
+      included do
+        after_save do
+          parents.map(&:touch)
+        end
+
+        def parents
+          Consyncful::Base.where(child_model_ids: id)
+        end
+      end
+    end
+  end
+end

data/lib/consyncful/tree/concerns/parent.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+# Parent module is included to parent Consyncful models
+# This module allows the current parent class to lookup its children no matter where they are.
+module Consyncful
+  module Tree
+    module Parent
+      extend ActiveSupport::Concern
+
+      included do
+        references_many :child_models
+
+        before_save do
+          self.child_model_ids = lookup_child_model_ids
+        end
+      end
+
+      def lookup_child_model_ids(context: self)
+        context.relations.map do |key, val|
+          child_ids = context[val.foreign_key]
+          child_ids = Array.wrap(child_ids)
+
+          next if key == "child_models" || child_ids.empty?
+
+          child_ids + lookup_child_objects(child_ids)
+        end.flatten.compact
+      end
+
+      def lookup_child_objects(child_ids)
+        return [] if child_ids.empty?
+
+        child_ids.map do |id|
+          obj = Consyncful::Base.where(id: id).first
+
+          next if obj.nil?
+
+          lookup_child_model_ids(context: obj) if classes_with_parent_concern.exclude?(obj.class.to_s)
+        end.flatten.compact
+      end
+
+      # Returns true/false if the parent has a child model with a specific class.
+      # This is useful if you want to trace a child's class on a specific parent.
+      def with_child_class_of?(klass)
+        return false if klass.nil?
+
+        klasses = child_models.map(&:class).uniq.map(&:to_s)
+
+        klasses.include?(klass.to_s)
+      end
+
+      private
+
+      def classes_with_parent_concern
+        # ObjectSpace lets you interact with garbage collection and traverse alive objects.
+        # This will iterate through all the classes for objects that are alive.
+        #
+        # NOTE: when a Rails app is running, it will have all the classes loaded, but in tests or the console
+        # for this Gem, it will just be the ones used in the test.
+        ObjectSpace.each_object(Class).select { |c| c.included_modules.include?(Consyncful::Tree::Parent) }
+      end
+    end
+  end
+end

data/lib/consyncful/tree/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Consyncful
+  module Tree
+    VERSION = "1.0.0"
+  end
+end

data/lib/consyncful/tree.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "consyncful/tree/version"
+require "consyncful/tree/concerns/child"
+require "consyncful/tree/concerns/parent"
+
+module Consyncful
+  module Tree
+  end
+end

data/sig/consyncful_tree.rbs

@@ -0,0 +1,4 @@
+module Consyncful::Tree
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,185 @@
+--- !ruby/object:Gem::Specification
+name: consyncful-tree
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- DigitalNZ
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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-rake
+  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-rspec
+  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: consyncful
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: Code to help with adding a tree structure to Contentful models.
+email:
+- info@digitalnz.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- consyncful-tree.gemspec
+- lib/consyncful/tree.rb
+- lib/consyncful/tree/concerns/child.rb
+- lib/consyncful/tree/concerns/parent.rb
+- lib/consyncful/tree/version.rb
+- sig/consyncful_tree.rbs
+homepage: https://github.com/DigitalNZ/consyncful-tree
+licenses: []
+metadata:
+  homepage_uri: https://github.com/DigitalNZ/consyncful-tree
+  source_code_uri: https://github.com/DigitalNZ/consyncful-tree
+  changelog_uri: https://github.com/DigitalNZ/consyncful-tree/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Code to help with adding a tree structure to Contentful models.
+test_files: []