join_dependency 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f9f66a03306a91acb3a744a210b291256dfb4de6
+  data.tar.gz: 42a4ab220ec1006ab0059b64381092d89740d174
+SHA512:
+  metadata.gz: 9383a3facbd04ce15f804dc89bf9630d95d8928fbae0d561420ec71fda3b8def5e2fe0568adb56190ddc4fb584758cb4fc1a67a41e6df51917161fdbf7e0e171
+  data.tar.gz: 27ba5c103231dd348d918dacf1a82ab3c28f6354de370b4b2d6e78e21d58e4fa339342247be4dd2f1eabd1aa8b824f6d26a0497a9001503aa42b41b4ef1eb4e3

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+
+rvm:
+  - 2.4.0
+
+before_install: gem install bundler -v 1.16.1
+
+env:
+  matrix:
+    - AR=4.2.10
+    - AR=5.0.6
+    - AR=5.1.5
+    - AR=5.2.0.rc1
+    - AR=latest
+

data/Gemfile

@@ -0,0 +1,14 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in join_dependency.gemspec
+gemspec
+
+case ENV.fetch('AR', 'latest')
+when 'latest'
+  gem 'activerecord'
+when 'master'
+  gem 'activerecord', github: 'https://github.com/rails/rails'
+else
+  gem 'activerecord', ENV['AR']
+end
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Ray Zane
+
+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,23 @@
+# JoinDependency [![Build Status](https://travis-ci.org/rzane/join_dependency.svg?branch=master)](https://travis-ci.org/rzane/join_dependency)
+
+This is a module with a singular purpose. It creates an `ActiveRecord::Associations::JoinDependency` from an `ActiveRecord::Relation`. That's it.
+
+```ruby
+require 'join_dependency'
+
+relation = Post.joins(:author)
+JoinDependency.from_relation(relation)
+```
+
+And, in case you're trying to bend Active Record to your will, you can choose how certain joins get categorized:
+
+```ruby
+JoinDependency.from_relation(relation) do |join|
+  case join
+  when Polyamorous::InnerJoin, Polyamorous::OuterJoin
+    :stashed_association_join
+  end
+end
+```
+
+This library isn't meant for people. It's a library for libraries on top of other libraries that interact with libraries.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "join_dependency"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/join_dependency.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "join_dependency/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "join_dependency"
+  spec.version       = JoinDependency::VERSION
+  spec.authors       = ["Ray Zane"]
+  spec.email         = ["ray@promptworks.com"]
+
+  spec.summary       = %q{Convert an ActiveRecord::Relation to a Join Dependency}
+  spec.description   = %q{If only this were easier...}
+  spec.homepage      = "https://github.com/rzane/join_dependency"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_dependency 'activerecord', '>= 4.2.0'
+
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/join_dependency.rb

@@ -0,0 +1,67 @@
+require "active_record"
+require "join_dependency/version"
+
+module JoinDependency
+  class << self
+    def from_relation(relation, &block)
+      build(relation, collect_joins(relation, &block))
+    end
+
+    private
+
+    def collect_joins(relation, &block)
+      joins = []
+      joins += relation.joins_values
+      joins += relation.left_outer_joins_values if at_least?(5)
+
+      buckets = joins.group_by do |join|
+        case join
+        when String
+          :string_join
+        when Hash, Symbol, Array
+          :association_join
+        when Arel::Nodes::Join
+          :join_node
+        else
+          (block_given? && yield(join)) || raise("unknown class: %s" % join.class.name)
+        end
+      end
+    end
+
+    def build(relation, buckets)
+      buckets.default = []
+      association_joins         = buckets[:association_join]
+      stashed_association_joins = buckets[:stashed_join]
+      join_nodes                = buckets[:join_node].uniq
+      string_joins              = buckets[:string_join].map(&:strip).uniq
+
+      join_list =
+        if at_least?(5, 2)
+          join_nodes + relation.send(:convert_join_strings_to_ast, string_joins)
+        elsif at_least?(5)
+          join_nodes + relation.send(:convert_join_strings_to_ast, relation.table, string_joins)
+        else
+          relation.send(:custom_join_ast, relation.table.from(relation.table), string_joins)
+        end
+
+      if at_least?(5, 2)
+        alias_tracker = ::ActiveRecord::Associations::AliasTracker.create(relation.klass.connection, relation.table.name, join_list)
+        join_dependency = ::ActiveRecord::Associations::JoinDependency.new(relation.klass, relation.table, association_joins, alias_tracker)
+        join_nodes.each do |join|
+          join_dependency.send(:alias_tracker).aliases[join.left.name.downcase] = 1
+        end
+      else
+        join_dependency = ::ActiveRecord::Associations::JoinDependency.new(relation.klass, association_joins, join_list)
+        join_nodes.each do |join|
+          join_dependency.send(:alias_tracker).aliases[join.left.name.downcase] = 1
+        end
+      end
+
+      join_dependency
+    end
+
+    def at_least?(major, minor = 0)
+      ActiveRecord::VERSION::MAJOR >= major && ActiveRecord::VERSION::MINOR >= minor
+    end
+  end
+end

data/lib/join_dependency/version.rb

@@ -0,0 +1,3 @@
+module JoinDependency
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: join_dependency
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Ray Zane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: If only this were easier...
+email:
+- ray@promptworks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- join_dependency.gemspec
+- lib/join_dependency.rb
+- lib/join_dependency/version.rb
+homepage: https://github.com/rzane/join_dependency
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Convert an ActiveRecord::Relation to a Join Dependency
+test_files: []