activerecord-pull-alpha 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a600203d416c9166308cc5685dfce526d73e4b5528a385de114eb7a63b4aef6b
+  data.tar.gz: c47287ef5de25b8f086bbe04449c1167757130b2648fb3311a02d1f2bb49809f
+SHA512:
+  metadata.gz: 4764f99abb758043709052752442c3e66743d833dcb9039c4bb34c609ee20504e578155db033bb31a600c9b4032463c649a6a5c34e8d6d59c7a251d8a292acc7
+  data.tar.gz: 1537a8dde666ecd2e9cba6c0039b5e3fed877ee09c1033900411232191abb2c6884622548f9605e8b6423e87bf7a839c46dc338ba8103d31f9c41d0db2850d9e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+tags

data/.rspec

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in activerecord-pull.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Delon Newman
+
+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,76 @@
+# ActiveRecord::Pull::Alpha
+
+A simple query interface for pulling deeply nested data from records.
+
+## Synopsis
+
+```ruby
+  class Survey < ActiveRecord::Base
+    has_many :questions
+    has_many :responses
+  end
+
+  class Question < ActiveRecord::Base
+    has_many :answers
+  end
+
+  class Answer < ActiveRecord::Base
+    belongs_to :reply
+    belongs_to :question
+  end
+
+  class Response < ActiveRecord::Base
+    belongs_to :survey
+    has_many :answers
+  end
+
+  Survey.find(34).pull(:name, questions: [:text, answers: [:created_at]])
+  Response.where('created_at < ?', Date.new(2018, 7, 5)).pull({ survey: :name }, { answers: :value }) 
+```
+
+## 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)
+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 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!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-pull-alpha'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-pull-alpha
+
+## See Also
+
+- [Ancestry](https://github.com/stefankroes/ancestry)
+- [Graphiti](https://www.graphiti.dev/)
+- [Datomic][datomic]
+- [GraphQL](https://graphql.org/)
+- [Entity Attribute Value Model][eav-model]
+- [RDF][rdf]
+
+## 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
+[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)
+[graph]: https://en.wikipedia.org/wiki/Graph_(abstract_data_type)
+[ontology]: https://en.wikipedia.org/wiki/Ontology_(information_science)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/activerecord-pull-alpha.gemspec

@@ -0,0 +1,40 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "activerecord/pull/alpha/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-pull-alpha"
+  spec.version       = Activerecord::Pull::Alpha::VERSION
+  spec.authors       = ["Delon Newman"]
+  spec.email         = ["contact@delonnewman.name"]
+
+  spec.summary       = %q{A simple query interface for pulling deeply nested data from records.}
+  spec.homepage      = "https://github.com/delonnewman/activerecord-pull"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = "#{spec.homepage}#changelog"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  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 "rspec", "~> 3.0"
+end

data/lib/activerecord/pull/alpha.rb

@@ -0,0 +1,16 @@
+require "activerecord/pull/alpha/core"
+require "activerecord/pull/alpha/version"
+
+module ActiveRecord
+  class Base
+    def pull(*pattern)
+      ActiveRecord::Pull::Alpha::Core.pull(self, pattern)
+    end
+  end
+
+  class Relation
+    def pull(*pattern)
+      ActiveRecord::Pull::Alpha::Core.pull_many(self, pattern)
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+module ActiveRecord
+  module Pull
+    module Alpha
+      module Core
+        class << self
+          def pull_many(records, q)
+            records.map { |r| pull(r, q) }
+          end
+      
+          def pull(record, q)
+            case q
+            when :*, '*'
+              pull_all(record)
+            when Symbol, String
+              pull_symbol(record, q)
+            when Hash
+              pull_hash(record, q)
+            when Array
+              q.map { |pat| pull(record, pat) }.reduce(&:merge)
+            else
+              raise "Invalid pull syntax: #{q.inspect}"
+            end
+          end
+        
+          private
+      
+          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
+            else
+              nil
+            end
+          end
+        
+          def ref_type?(value)
+            value.is_a?(ActiveRecord::Relation) || value.is_a?(ActiveRecord::Base)
+          end
+        
+          def pull_symbol(record, attr)
+            val = resolved_value(record, attr)
+            if ref_type?(val) && val.is_a?(Enumerable)
+              { attr => val.map { |v| pull_all(v) } }
+            elsif ref_type?(val)
+              { attr => pull_all(val) }
+            else
+              { attr => val }
+            end
+          end
+        
+          def pull_hash(record, hash)
+            hash.reduce({}) do |h, (attr, pat)|
+              val = resolved_value(record, attr)
+              if val.nil?
+                h
+              elsif ref_type?(val) && val.is_a?(Enumerable)
+                h.merge!(attr => val.map { |v| pull(v, pat) })
+              elsif ref_type?(val)
+                h.merge!(attr => pull(val, pat))
+              else
+                h.merge!(attr => val)
+              end
+            end
+          end
+        
+          # TODO: this should pull all associations
+          def pull_all(record)
+            names  = record.class.attribute_names
+            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
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Activerecord
+  module Pull
+    module Alpha
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-pull-alpha
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Delon Newman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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'
+description: 
+email:
+- contact@delonnewman.name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-pull-alpha.gemspec
+- lib/activerecord/pull/alpha.rb
+- lib/activerecord/pull/alpha/core.rb
+- lib/activerecord/pull/alpha/version.rb
+homepage: https://github.com/delonnewman/activerecord-pull
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  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: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A simple query interface for pulling deeply nested data from records.
+test_files: []