activerecord-pull-alpha 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a600203d416c9166308cc5685dfce526d73e4b5528a385de114eb7a63b4aef6b
-  data.tar.gz: c47287ef5de25b8f086bbe04449c1167757130b2648fb3311a02d1f2bb49809f
+  metadata.gz: ccb0237045bd530e776a70c9e54572c9914cbb14a62c9a1e2c33ef26ca78a989
+  data.tar.gz: fe01b85e846a4ed2860a16c18c8ed235877098e68e460ed618a131bc360ec615
 SHA512:
-  metadata.gz: 4764f99abb758043709052752442c3e66743d833dcb9039c4bb34c609ee20504e578155db033bb31a600c9b4032463c649a6a5c34e8d6d59c7a251d8a292acc7
-  data.tar.gz: 1537a8dde666ecd2e9cba6c0039b5e3fed877ee09c1033900411232191abb2c6884622548f9605e8b6423e87bf7a839c46dc338ba8103d31f9c41d0db2850d9e
+  metadata.gz: 53416aabcb2c4e20bbb51fbc771914bb641cba6d6330cc8d8ad0de105c31495d50c5d4e54bb6ce2f15ae9fc611096ea2d7c9c9b48f7d8147493d5cbe4dc3a3ee
+  data.tar.gz: 215519fe1cb05dbe49ebac256de0961dc355aec22cf4c382782509b58a8f48168362d8acb1273876b118f26d3a838cb4c7762092072a9bc90b173b9b25692071

data/.github/workflows/ruby.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@2b019609e2b0f1ea1a2bc8ca11cb82ab46ada124
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -10,3 +10,7 @@
 # rspec failure tracking
 .rspec_status
 tags
+/.idea/
+/.DS_Store
+/.clj-kondo/
+/.lsp/

data/Gemfile

@@ -4,3 +4,9 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in activerecord-pull.gemspec
 gemspec
+
+gem 'activerecord', require: 'active_record'
+gem 'pry'
+gem 'rubocop'
+gem 'rubocop-rspec'
+gem 'sqlite3'

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    activerecord-pull-alpha (0.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.6.1)
+      activesupport (= 6.1.6.1)
+    activerecord (6.1.6.1)
+      activemodel (= 6.1.6.1)
+      activesupport (= 6.1.6.1)
+    activesupport (6.1.6.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    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.28.2)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-rspec (2.10.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    sqlite3 (1.4.4)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  -darwin-21
+  arm64-darwin-21
+  arm64-darwin-22
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord
+  activerecord-pull-alpha!
+  bundler (~> 2.2)
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop
+  rubocop-rspec
+  sqlite3
+
+BUNDLED WITH
+   2.3.8

data/README.md

@@ -1,3 +1,5 @@
+[![Ruby](https://github.com/delonnewman/activerecord-pull/actions/workflows/ruby.yml/badge.svg)](https://github.com/delonnewman/activerecord-pull/actions/workflows/ruby.yml)
+
 # ActiveRecord::Pull::Alpha
 
 A simple query interface for pulling deeply nested data from records.
@@ -30,13 +32,18 @@ A simple query interface for pulling deeply nested data from records.
 
 ## Why?
 
-Modeling [trees][tree] and [ontologies][ontology] are and excercise in relational database design when using a SQL database.
-Unfortunalty, when dealing with deeply nested and overlapping data (e.g. medical records, social graphs)
+When using an SQL database modeling [trees][tree] and [ontologies][ontology] is an exercise in relational database design.
+Unfortunately, when dealing with deeply nested and *overlapping* data (e.g. medical records and social graphs)
 trees and ontologies won't do. We need to model graphs, a much more sparsely structured data model, but
-this leads to very complex table structures and very complex SQL queries.
+this leads to very complex (or sparse) table structures and very complex SQL queries.
+
+Alternatives to SQL databases like [Datomic][datomic], [RDF][rdf] and graph databases resolve this problem in the general case,
+but sometimes those solutions are not a viable option for one reason or another. This gem attempts to provide some of the
+convenience of these solutions as an extension to ActiveRecord. As a bonus it makes querying trees and ontologies simple too!
+
+## Pull Syntax
 
-This pull syntax is inspired by the pull syntax that is used in [Datomic][datomic-pull], a database that is designed to model
-graph-like structures. This gem plugs that syntax into ActiveRecord. As a bonus it makes querying trees and ontologies simple too!
+The pull syntax is inspired by the pull syntax that is used in [Datomic][datomic-pull].
 
 ## Installation
 
@@ -62,13 +69,14 @@ Or install it yourself as:
 - [GraphQL](https://graphql.org/)
 - [Entity Attribute Value Model][eav-model]
 - [RDF][rdf]
+- [A City is Not a Tree](https://www.patternlanguage.com/archive/cityisnotatree.html)
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 [datomic]: https://www.datomic.com/
-[datomic-pull]: https://docs.datomic.com/on-prem/pull.html
+[datomic-pull]: https://docs.datomic.com/on-prem/pull.html#pull-grammar
 [eav-model]: https://en.wikipedia.org/wiki/Entity%E2%80%93attribute%E2%80%93value_model
 [rdf]: https://en.wikipedia.org/wiki/Resource_Description_Framework
 [tree]: https://en.wikipedia.org/wiki/Tree_(data_structure)

data/activerecord-pull-alpha.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.17"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/activerecord/pull/alpha/core.rb

@@ -1,54 +1,89 @@
+# frozen_string_literal: true
+
 module ActiveRecord
   module Pull
     module Alpha
+      class SyntaxError < RuntimeError; end
+      class ReflectionError < RuntimeError; end
+
       module Core
         class << self
-          def pull_many(records, q)
-            records.map { |r| pull(r, q) }
+          # Apply the pull query to a collection of records.
+          #
+          # @param records [Enumerable<ActiveRecord::Base>]
+          # @param query [Symbol, String, Hash, Array]
+          #
+          # @return [Array<Hash>]
+          def pull_many(records, query)
+            records.map { |r| pull(r, query) }
           end
-      
-          def pull(record, q)
-            case q
+
+          # Apply the pull query to the given record.
+          #
+          # @param record [ActiveRecord::Base]
+          # @param query [Symbol, String, Hash, Array]
+          #
+          # @return [Hash]
+          def pull(record, query)
+            case query
             when :*, '*'
               pull_all(record)
             when Symbol, String
-              pull_symbol(record, q)
+              pull_symbol(record, query)
             when Hash
-              pull_hash(record, q)
+              pull_hash(record, query)
             when Array
-              q.map { |pat| pull(record, pat) }.reduce(&:merge)
+              # TODO: add filter_map as a core extension for older Ruby implementations
+              query.map { |pat| pull(record, pat) }.reduce(&:merge)
             else
-              raise "Invalid pull syntax: #{q.inspect}"
+              raise SyntaxError, "invalid pull syntax: #{query.inspect}"
             end
           end
-        
+
           private
-      
+
+          EMPTY_HASH = {}.freeze
+          private_constant :EMPTY_HASH
+
+          R = ActiveRecord::Reflection
+          private_constant :R
+
+          # @param record [#[]]
+          # @param attr [Symbol, String]
+          #
+          # @return [ActiveRecord::Base, ActiveRecord::Relation, Object, nil]
           def resolved_value(record, attr)
-            if !(val = record[attr]).nil?
-              val
-            elsif val.nil? and !(reflection = record.class.reflect_on_association(attr)).nil?
-              model = reflection.class_name.constantize
-              p model
-              case reflection
-              when ActiveRecord::Reflection::HasManyReflection, ActiveRecord::Reflection::HasAndBelongsToManyReflection
-                model.where(reflection.foreign_key => record[record.class.primary_key])
-              when ActiveRecord::Reflection::BelongsToReflection
-                model.find_by(model.primary_key => record[reflection.foreign_key])
-              else
-                raise "Don't know how to resolve value for reflection: #{reflection.inspect}"
-              end
+            val = record[attr]
+            return val unless val.nil?
+
+            reflection = record.class.reflect_on_association(attr)
+            return if reflection.nil?
+
+            model = reflection.class_name.constantize
+
+            case reflection
+            when R::HasManyReflection, R::HasAndBelongsToManyReflection
+              model.where(reflection.foreign_key => record[record.class.primary_key])
+            when R::BelongsToReflection
+              model.find_by(model.primary_key => record[reflection.foreign_key])
             else
-              nil
+              raise ReflectionError, "don't know how to resolve value for reflection: #{reflection.inspect}"
             end
           end
-        
+
           def ref_type?(value)
             value.is_a?(ActiveRecord::Relation) || value.is_a?(ActiveRecord::Base)
           end
-        
+
+          # @param record [#[]]
+          # @param attr [Symbol, String]
+          #
+          # @return [Hash]
           def pull_symbol(record, attr)
-            val = resolved_value(record, attr)
+            attr = attr.to_sym
+            val  = resolved_value(record, attr)
+            return EMPTY_HASH if val.nil?
+
             if ref_type?(val) && val.is_a?(Enumerable)
               { attr => val.map { |v| pull_all(v) } }
             elsif ref_type?(val)
@@ -57,7 +92,11 @@ module ActiveRecord
               { attr => val }
             end
           end
-        
+
+          # @param record [#[]]
+          # @param hash [Hash{Symbol, String => Symbol, String, Hash, Array}]
+          #
+          # @return [Hash]
           def pull_hash(record, hash)
             hash.reduce({}) do |h, (attr, pat)|
               val = resolved_value(record, attr)
@@ -72,25 +111,25 @@ module ActiveRecord
               end
             end
           end
-        
-          # TODO: this should pull all associations
+
+          # @param [ActiveRecord::Base]
+          #
+          # @return [Hash]
           def pull_all(record)
-            names  = record.class.attribute_names
+            names  = record.class.attribute_names.map(&:to_sym)
             nested = record.class.nested_attributes_options
             attrs  = pull(record, names)
-        
-            if nested.empty?
-              attrs
-            else
-              nested.keys.reduce(attrs) do |h, assoc|
-                assoc_val = record.send(assoc)
-                if assoc_val.nil? || assoc_val.is_a?(Enumerable) && assoc_val.empty?
-                  h
-                elsif assoc_val.is_a?(Enumerable)
-                  h.merge!(assoc => assoc_val.map { |rec| pull_all(rec) }.reject(&:nil?))
-                else
-                  h.merge!(assoc => pull_all(assoc_val))
-                end
+
+            return attrs if nested.empty?
+
+            nested.keys.reduce(attrs) do |h, assoc|
+              assoc_val = record.send(assoc)
+              if assoc_val.nil? || assoc_val.is_a?(Enumerable) && assoc_val.empty?
+                h
+              elsif assoc_val.is_a?(Enumerable)
+                h.merge!(assoc => assoc_val.filter_map { |rec| pull_all(rec) })
+              else
+                h.merge!(assoc => pull_all(assoc_val))
               end
             end
           end

data/lib/activerecord/pull/alpha/core_ext.rb

@@ -0,0 +1,13 @@
+require 'activerecord/pull/alpha/core'
+
+module Enumerable
+  def pull(*pattern)
+    ActiveRecord::Pull::Alpha::Core.pull_many(self, pattern)
+  end
+end
+
+class Object
+  def pull(*pattern)
+    ActiveRecord::Pull::Alpha::Core.pull(self, pattern)
+  end
+end

data/lib/activerecord/pull/alpha/version.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Activerecord
   module Pull
     module Alpha
-      VERSION = "0.1.0"
+      VERSION = "0.1.2"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-pull-alpha
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Delon Newman
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-21 00:00:00.000000000 Z
+date: 2023-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -52,22 +52,25 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - contact@delonnewman.name
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - activerecord-pull-alpha.gemspec
 - lib/activerecord/pull/alpha.rb
 - lib/activerecord/pull/alpha/core.rb
+- lib/activerecord/pull/alpha/core_ext.rb
 - lib/activerecord/pull/alpha/version.rb
 homepage: https://github.com/delonnewman/activerecord-pull
 licenses:
@@ -77,7 +80,7 @@ metadata:
   homepage_uri: https://github.com/delonnewman/activerecord-pull
   source_code_uri: https://github.com/delonnewman/activerecord-pull
   changelog_uri: https://github.com/delonnewman/activerecord-pull#changelog
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -92,8 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.4.17
+signing_key:
 specification_version: 4
 summary: A simple query interface for pulling deeply nested data from records.
 test_files: []