eagerbeaver 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c558246984c62a7470ea996b956053150d58ec50
+  data.tar.gz: 5d8a81bb64fed4f171dc327604b9c06253bd5323
+SHA512:
+  metadata.gz: 646386f43d5f2c9510121878dd95fc7c5b94221ee3337a0ef168d93d5e9e9150eae592bf01d61737a716da45adb622b4905ff4b20ff756bb9668b5ad78fcc4d6
+  data.tar.gz: ad9f291388b5b039c0f25d94993e2f178b87a537cbbfea74e5633efdfc851bfb830b2d4abd5673217e65d84cd138cd9550cc5f8c9e09d0e7fadf6d4a174235bb

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Danny Park
+
+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,73 @@
+# EagerBeaver
+
+Rails `eager_load`, `includes`, `preload` can break when changing table or association names. These breaking changes are often discovered in production due to the tricky nature of testing the existence of all the associations listed in the `includes`. Proper testing is error prone because it requires that all of the listed associations are built during the tests. This gem makes it trivial to test that the associations exist so that you can quickly find the `includes` to fix when refactoring data models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eagerbeaver'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eagerbeaver
+
+## Usage
+
+The constructor takes the model as the first parameter and the `includes` array as the second parameter:
+`EagerBeaver.new(MyModel, [:association1, :association2, assoc3: { foo: :bar }])`
+
+The instance has one public method, `.errors`, which returns an array of error messages describing unknown associations.
+
+Imagine we have the following class:
+```ruby
+class Lease < ActiveRecord::Base
+  has_many :lease_terms
+  has_many :spaces, through: :lease_terms
+  belongs_to :tenant
+end
+```
+
+with the corresponding controller:
+```ruby
+class LeasesController < ApplicationController
+  def index
+    leases = Lease.all.includes(self.class.lease_includes)
+    # do some stuff
+  end
+
+  def self.lease_includes
+    [
+      :lease_terms,
+      :spaces,
+      :tenant,
+      :foobar
+    ]
+  end
+end
+```
+
+We can ensure that our `lease_includes` is valid by testing it:
+```ruby
+describe LeasesController do
+  describe 'includes' do
+    it 'is valid' do
+      expect(EagerBeaver.new(Lease, LeasesController.lease_includes).errors).to be_empty
+    end
+  end
+end
+```
+
+This expectation would fail, because `.errors` will return `['foobar is not an association of Lease']`.
+
+EagerBeaver works with nested `includes` as well. Check out the specs to see more examples.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/eagerbeaver.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "eagerbeaver/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "eagerbeaver"
+  spec.version       = Eagerbeaver::VERSION
+  spec.authors       = ["Danny Park"]
+  spec.email         = ["dannypark92@gmail.com"]
+
+  spec.summary       = "Validates associations listed in rails includes"
+  spec.description   = "Validates associations listed in rails includes"
+  spec.homepage      = "http://github.com/viewthespace/eagerbeaver"
+  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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'combustion', '~> 0.7.0'
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency "pry-byebug"
+end

data/lib/eagerbeaver.rb

@@ -0,0 +1,36 @@
+require "eagerbeaver/version"
+
+class EagerBeaver
+  def initialize(model, preloads)
+    @model = model
+    @preloads = Array(preloads)
+  end
+
+  def errors
+    trace(model, preloads).flatten.compact
+  end
+
+  private
+
+  def trace(model, assoc)
+    model_string = model.to_s.singularize.classify
+
+    if assoc.is_a?(Array)
+      assoc.map { |a| trace(model, a) }
+    elsif assoc.is_a?(Hash)
+      val = Array(trace(association_name(model_string, assoc.keys.first), assoc.values.first))
+      val << trace(model, assoc.keys.first)
+    elsif assoc.is_a?(Symbol) && !model_string.constantize.reflect_on_all_associations.map(&:name).include?(assoc)
+      "#{assoc} is not an association of #{model_string}"
+    end
+  end
+
+  def association_name(model_string, association_name_or_alias)
+    association = model_string.constantize.reflect_on_all_associations.find { |a| a.name == association_name_or_alias }
+    association.try(:source_reflection_name) ||
+      association.try(:options).try(:[], :class_name) ||
+      association_name_or_alias
+  end
+
+  attr_reader :model, :preloads
+end

data/lib/eagerbeaver/version.rb

@@ -0,0 +1,3 @@
+module Eagerbeaver
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: eagerbeaver
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Park
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: combustion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: pg
+  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: 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'
+description: Validates associations listed in rails includes
+email:
+- dannypark92@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- eagerbeaver.gemspec
+- lib/eagerbeaver.rb
+- lib/eagerbeaver/version.rb
+homepage: http://github.com/viewthespace/eagerbeaver
+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.13
+signing_key: 
+specification_version: 4
+summary: Validates associations listed in rails includes
+test_files: []