sequel-association-filtering 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 650d4f992d2994676afd8b8cab81c98522dcd3a7f3c7700702fe2eeab78f7f64
+  data.tar.gz: dc67094e11cdefd1b267524de4cecc4fe7729025eb9bdcadd9cfd8aaf72e4794
+SHA512:
+  metadata.gz: 8c07e15a8e8c2f0160cc98c3ccbc0292e6257d1d70ebeb914209d7d4288179f5030689ec6159d7f26ba52f1e449b38c3d3f2c03824d48e07030d2c6ffd0bf6c9
+  data.tar.gz: 72490ad79e2f0b1a8cadb2150dccc0a9544f3c0ab018298407f4bce4deb549cd62935a505279c139b955c74b84fabb460e641fc2ada8d9e7025e95dff2e5fe3c

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'minitest',    '5.5.1'
+  gem 'minitest-rg', '5.1.0'
+
+  gem 'pry'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Chris Hanks
+
+MIT License
+
+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,7 @@
+# Sequel::Plugins::AssociationFiltering
+
+This gem provides support for simple filtering through associations to Sequel.
+
+### Caveats
+
+The gem is tested on PostgreSQL. It may or may not work for other databases.

data/Rakefile

@@ -0,0 +1,3 @@
+require 'bundler/gem_tasks'
+
+Dir["./tasks/*.rb"].sort.each &method(:require)

data/lib/sequel-association-filtering.rb

@@ -0,0 +1 @@
+require 'sequel/plugins/association_filtering'

data/lib/sequel/plugins/association_filtering.rb

@@ -0,0 +1,62 @@
+require 'sequel'
+require 'sequel/plugins/association_filtering/version'
+
+module Sequel
+  module Plugins
+    module AssociationFiltering
+      class Error < StandardError; end
+
+      module ClassMethods
+        Plugins.def_dataset_methods(self, :association_filter)
+      end
+
+      module DatasetMethods
+        def association_filter(association_name)
+          reflection =
+            model.association_reflections.fetch(association_name) do
+              raise Error, "association #{association_name} not found on model #{model}"
+            end
+
+          if block_given?
+            ds = yield(_association_filter_dataset(reflection))
+            where(ds.exists)
+          else
+            cached_dataset(_association_filter_cache_key(reflection, suffix: :bare)) do
+              where(_association_filter_dataset(reflection).exists)
+            end
+          end
+        end
+
+        private
+
+        def _association_filter_dataset(reflection)
+          cache_key = _association_filter_cache_key(reflection)
+
+          ds = reflection.associated_dataset
+
+          ds.send(:cached_dataset, cache_key) do
+            case t = reflection[:type]
+            when :one_to_many
+              local_keys  = reflection.qualified_primary_key
+              remote_keys = reflection.predicate_key
+            when :many_to_one
+              local_keys  = reflection[:qualified_key]
+              remote_keys = reflection.qualified_primary_key
+            when :many_to_many
+              local_keys  = reflection.qualify_cur(reflection[:left_primary_key])
+              remote_keys = reflection.qualified_left_key
+            else
+              raise Error, "Unsupported reflection type: #{t}"
+            end
+
+            ds.where(remote_keys => local_keys).select(1)
+          end
+        end
+
+        def _association_filter_cache_key(reflection, suffix: nil)
+          :"_association_filter_#{reflection[:model]}_#{reflection[:name]}_#{suffix}"
+        end
+      end
+    end
+  end
+end

data/lib/sequel/plugins/association_filtering/version.rb

@@ -0,0 +1,7 @@
+module Sequel
+  module Plugins
+    module AssociationFiltering
+      VERSION = '0.0.1'
+    end
+  end
+end

data/sequel-association-filtering.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sequel/plugins/association_filtering/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sequel-association-filtering'
+  spec.version       = Sequel::Plugins::AssociationFiltering::VERSION
+  spec.authors       = ["Chris Hanks"]
+  spec.email         = ['christopher.m.hanks@gmail.com']
+  spec.summary       = %q{Easy filtering through Sequel associations.}
+  spec.description   = %q{Easily filter records by the presence/absence of associated records.}
+  spec.homepage      = 'https://github.com/chanks/sequel-association-filtering'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'pg'
+
+  spec.add_dependency 'sequel', '~> 5.0'
+end

data/spec/basic_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+class BasicSpec < AssociationFilteringSpecs
+  describe "association_filter" do
+    it "with an unknown association should throw an error" do
+      error =
+        assert_raises(Sequel::Plugins::AssociationFiltering::Error) do
+          Album.association_filter(:widgets)
+        end
+
+      assert_equal "association widgets not found on model Album", error.message
+    end
+  end
+end

data/spec/many_to_many_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+class AssociationFilteringSpec < AssociationFilteringSpecs
+  describe "association_filter through a many_to_many_association" do
+    it "should support an empty filter that checks for existence" do
+      expected_count = DB[:album_genres].distinct(:album_id).count
+
+      ds = Album.association_filter(:genres)
+      assert_equal %(SELECT * FROM "albums" WHERE (EXISTS (SELECT 1 FROM "genres" INNER JOIN "album_genres" ON ("album_genres"."genre_id" = "genres"."id") WHERE ("album_genres"."album_id" = "albums"."id")))), ds.sql
+      assert_equal expected_count, ds.count
+
+      album_id_to_delete = DB[:album_genres].order_by{random.function}.get(:album_id)
+
+      DB[:album_genres].where(album_id: album_id_to_delete).delete
+      assert_equal expected_count - 1, ds.count
+    end
+
+    it "should support a simple filter" do
+      expected_count = DB[:album_genres].where(genre_id: 5).distinct(:album_id).count
+
+      ds = Album.association_filter(:genres){|t| t.where(Sequel[:genres][:id] =~ 5)}
+      assert_equal expected_count, ds.count
+      assert_equal %(SELECT * FROM \"albums\" WHERE (EXISTS (SELECT 1 FROM "genres" INNER JOIN "album_genres" ON ("album_genres"."genre_id" = "genres"."id") WHERE (("album_genres"."album_id" = "albums"."id") AND ("genres"."id" = 5))))), ds.sql
+
+      record = ds.first!
+      assert_includes record.genres.map(&:id), 5
+    end
+  end
+end

data/spec/many_to_one_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+class AssociationFilteringSpec < AssociationFilteringSpecs
+  describe "association_filter through a many_to_one association" do
+    it "should support a simple filter" do
+      ds = Album.association_filter(:artist){|a| a.where{mod(id, 5) =~ 0}}
+      assert_equal 20, ds.count
+      assert_equal %(SELECT * FROM "albums" WHERE (EXISTS (SELECT 1 FROM "artists" WHERE (("artists"."id" = "albums"."artist_id") AND (mod("id", 5) = 0)) LIMIT 1))), ds.sql
+
+      record = ds.order_by{random.function}.first
+      assert_includes [5, 10], record.artist_id
+    end
+  end
+end

data/spec/one_to_many_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+class AssociationFilteringSpec < AssociationFilteringSpecs
+  describe "association_filter through a one_to_many association" do
+    it "should support a simple filter" do
+      ds = Album.association_filter(:tracks){|t| t.where(id: 40)}
+      assert_equal 1, ds.count
+      assert_equal %(SELECT * FROM "albums" WHERE (EXISTS (SELECT 1 FROM "tracks" WHERE (("tracks"."album_id" = "albums"."id") AND ("id" = 40))))), ds.sql
+
+      record = ds.first!
+      assert_includes record.tracks.map(&:id), 40
+    end
+
+    it "should support an empty filter that checks for existence" do
+      ds = Album.association_filter(:tracks)
+      assert_equal 100, ds.count
+      assert_equal %(SELECT * FROM "albums" WHERE (EXISTS (SELECT 1 FROM "tracks" WHERE ("tracks"."album_id" = "albums"."id")))), ds.sql
+
+      Track.where(album_id: 50).delete
+      assert_equal 99, ds.count
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,74 @@
+require 'sequel'
+
+require './lib/sequel-association-filtering'
+
+Sequel::Model.plugin :association_filtering
+
+DB = Sequel.connect "postgres:///sequel-association-filtering-test"
+
+DB.drop_table? :album_genres, :genres, :tracks, :albums, :artists
+
+DB.create_table :artists do
+  primary_key :id
+end
+
+DB.create_table :albums do
+  primary_key :id
+  foreign_key :artist_id, :artists
+end
+
+DB.create_table :tracks do
+  primary_key :id
+  foreign_key :album_id, :albums
+end
+
+DB.create_table :genres do
+  primary_key :id
+end
+
+DB.create_table :album_genres do
+  primary_key :id
+  foreign_key :album_id, :albums
+  foreign_key :genre_id, :genres
+
+  unique [:album_id, :genre_id]
+end
+
+class Artist < Sequel::Model
+  one_to_many :albums
+end
+
+class Album < Sequel::Model
+  many_to_one :artist
+  one_to_many :tracks
+
+  many_to_many :genres, join_table: :album_genres
+end
+
+class Track < Sequel::Model
+  many_to_one :album
+end
+
+class Genre < Sequel::Model
+  many_to_many :albums, join_table: :album_genres
+end
+
+DB.run <<-SQL
+  INSERT INTO artists SELECT i FROM generate_series(1, 10) i;
+  INSERT INTO albums (artist_id) SELECT (i % 10) + 1 FROM generate_series(1, 100) i;
+  INSERT INTO tracks (album_id) SELECT (i % 100) + 1 FROM generate_series(1, 1000) i;
+  INSERT INTO genres SELECT i FROM generate_series(1, 10) i;
+
+  INSERT INTO album_genres (album_id, genre_id)
+    SELECT DISTINCT ceil(random() * 100), ceil(random() * 10) FROM generate_series(1, 300);
+SQL
+
+require 'pry'
+require 'minitest/autorun'
+require 'minitest/pride'
+
+class AssociationFilteringSpecs < Minitest::Spec
+  def around
+    DB.transaction(rollback: :always) { super }
+  end
+end

data/tasks/specs.rb

@@ -0,0 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new :default do |t|
+  t.libs = ['spec']
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :spec => :default
+task :test => :default

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: sequel-association-filtering
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Chris Hanks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: 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: 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: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Easily filter records by the presence/absence of associated records.
+email:
+- christopher.m.hanks@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sequel-association-filtering.rb
+- lib/sequel/plugins/association_filtering.rb
+- lib/sequel/plugins/association_filtering/version.rb
+- sequel-association-filtering.gemspec
+- spec/basic_spec.rb
+- spec/many_to_many_spec.rb
+- spec/many_to_one_spec.rb
+- spec/one_to_many_spec.rb
+- spec/spec_helper.rb
+- tasks/specs.rb
+homepage: https://github.com/chanks/sequel-association-filtering
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Easy filtering through Sequel associations.
+test_files:
+- spec/basic_spec.rb
+- spec/many_to_many_spec.rb
+- spec/many_to_one_spec.rb
+- spec/one_to_many_spec.rb
+- spec/spec_helper.rb