sequel-through 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f97ae5f870b6431b6a0d8186421ad8422ce24b58de83205b377e0c854d832578
-  data.tar.gz: 7eba0d88aa13b1908dbc2a39e48b2c2b43879a623ca51d7f933519a008bf12e4
+  metadata.gz: 052c754323070df67e30e29c408efacdd3fc04da4a973e84551fe0d3ee6ed730
+  data.tar.gz: 1f8ab70b4bb87ed7889e2fd9339c56328e09fbe1f4e7c493cc5fb799955db37e
 SHA512:
-  metadata.gz: 52aa46a33e6162b18d0df2b5e3d401010fc32ac0984d776bb25db4ce3d7dc5672b94ec8a789c91dafa199018160e7a6a76a6804557a7b886fc88614b412f159f
-  data.tar.gz: cd274aa38361bda1aba76e5e779d647262efbeaefcfb9015b8fde65c6b27d846348ae9bd64647a27e09687657a2b1127e138db0c5149ada8744ce17fc4865241
+  metadata.gz: c6264ff5cb4701d009e11e5cfaec4bc8e5d02696f5bd634605b2e3f3eff5aeaae505be0495c806ccd4daf6e489a205dadeca19341fe4bec985d1fbb28e167c09
+  data.tar.gz: 5f749f13768fb60fa0c1dabbc56de70f6adaab0db284cbc3a0ac2988a3b6fb887fa809ae205cbf2dce06d1d7b81267ce14772d7e71c951f747ff8651a4e8a7a3

data/README.md

@@ -24,7 +24,40 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+# Load the plugin
+Sequel::Model.plugin :cyclical_through_associations
+
+class User < Sequel::Model
+  one_to_many :user_has_security_groups
+  one_to_many :security_groups, through: :user_has_security_groups
+  one_to_many :privileges, through: :security_groups
+end
+class SecurityGroup < Sequel::Model
+  one_to_many :security_group_has_privileges
+  one_to_many :privileges, through: :security_group_has_privileges
+end
+class Privilege < Sequel::Model
+end
+class UserHasSecurityGroup < Sequel::Model
+  many_to_one :user
+  many_to_one :security_group
+  one_to_many :privileges, through: :security_group
+end
+class SecurityGroupHasPrivilege < Sequel::Model
+  many_to_one :security_group
+  many_to_one :privilege
+end
+
+# Solve any cyclical dependencies (when :cyclical_through_associations is used)
+Sequel::Model.solve_cyclical_associations!
+
+# Use the intermediate associations
+User.first.security_groups # => [#<SecurityGroup 1>, #<SecurityGroup 2> ...]
+User.first.privileges # => [#<Privilege A>, #<Privilege B> ...]
+```
+
+This plugin adds an optional `:through` key for `*_to_one` and `*_to_many` associations. When `:through` is provided,  intermediary associations are traversed and a single `one_through_many` or `many_through_many` association is added to the base model using a JOIN structure calculated from the associations traversed.
 
 ## Development
 

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
 require "bundler/setup"
-require "sequel/through"
+require_relative "../test/test_helper"
 
 # 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.

data/lib/sequel/plugins/{cyclical_association_solver.rb → cyclical_through_associations.rb}

@@ -1,10 +1,10 @@
 module Sequel
   module Plugins
-    module CyclicalAssociationSolver
+    module CyclicalThroughAssociations
 
       # Ensure through associations are loaded
       def self.apply mod
-        mod.plugin(:through_associations)
+        mod.plugin :through_associations
       end
 
       module ClassMethods
@@ -25,7 +25,7 @@ module Sequel
             # Attempt to solve remaining cyclical associations
             @@_resolver_stack = []
             stack.each do |klass, assoc_type, name, opts, block|
-              klass.send(assoc_type, name, **opts, &block)
+              klass.send assoc_type, name, **opts, &block
             end
 
           end
@@ -33,13 +33,13 @@ module Sequel
           # Output errors for any unsolved associations
           @@_resolving = true
           @@_resolver_stack.each do |klass, assoc_type, name, opts, block|
-            klass.send(assoc_type, name, **opts, &block)
+            klass.send assoc_type, name, **opts, &block
           end
           @@_resolving = false
 
         end
 
-        def associate_through(type, name, opts, &block)
+        def associate_through type, name, opts, &block
           begin
             result = super
           rescue \
@@ -52,7 +52,7 @@ module Sequel
 
             # Otherwise, attempt to resolve later
             unless result
-              @@_resolver_stack.push([self, type, name, opts, block])
+              @@_resolver_stack.push [self, type, name, opts, block]
               return
             end
 

data/lib/sequel/plugins/through_associations.rb

@@ -3,10 +3,10 @@ module Sequel
     module ThroughAssociations
 
       ASSOCIATION_THROUGH_TYPES = {
-        :one_to_many => :one_through_many,
+        :one_to_one => :one_through_many,
+        :one_to_many => :many_through_many,
         :many_to_one => :one_through_many,
         :many_to_many => :many_through_many
-        # one_to_one
         # many_to_pg_array
         # pg_array_to_many
       }
@@ -16,6 +16,7 @@ module Sequel
 
       # Ensure associations are loaded
       def self.apply mod
+        Sequel.extension :inflector unless "".respond_to?(:pluralize)
         mod.plugin :many_through_many
       end
 
@@ -37,7 +38,7 @@ module Sequel
         def associate_through type, name, opts, &block
           raise Error, "#{type} does not support through associations" unless assoc_type = Sequel.synchronize{ASSOCIATION_THROUGH_TYPES[type]}
 
-          result = find_association_path **opts, name: name, models: self, from_through: true
+          result = find_association_path(**opts, name: name, models: self, from_through: true)
 
           # Remove the last table if it matches the destination table
           dest_model = result[:models].pop
@@ -51,7 +52,7 @@ module Sequel
           end
 
           # Create the association
-          if assoc_type.to_s.ends_with? "_through_many"
+          if assoc_type.to_s.end_with? "_through_many"
             # *_through_many has a path argument
             self.send(assoc_type,
               name,
@@ -78,7 +79,7 @@ module Sequel
         end
 
         # Recurses through associations until a path to the destination is completed
-        def find_association_path opts
+        def find_association_path **opts
 
           # Initialize arguments
           [:tables, :keys, :through, :models, :assocs].each do |k|
@@ -125,7 +126,7 @@ module Sequel
           opts[:assocs].push assoc
 
           # Handle *_through_many associations
-          if assoc[:type].to_s.ends_with? "_through_many"
+          if assoc[:type].to_s.end_with? "_through_many"
 
             opts[:through].push assoc[:originally_through]
             opts[:from_through] = true
@@ -138,7 +139,7 @@ module Sequel
             return begin
               model = search.shift
               raise NoAssociationPath, opts unless model
-              self.find_association_path **opts, models: opts[:models] + [model]
+              self.find_association_path(**opts, models: opts[:models] + [model])
             rescue MissingAssociation
               # Try the next model in the search path
               retry
@@ -154,7 +155,7 @@ module Sequel
             opts[:through].push assoc[:using] || assoc[:through]
             opts[:from_through] = true
             opts[:using] = nil
-            return self.find_association_path **opts
+            return self.find_association_path(**opts)
           end
 
           # Otherwise, add the new table to the stack
@@ -187,7 +188,7 @@ module Sequel
           # Check for a source association
           opts[:through].push opts[:using] || opts[:name]
           opts[:from_through] = false
-          return self.find_association_path **opts
+          return self.find_association_path(**opts)
 
         end
 

data/lib/sequel/through.rb

@@ -1,3 +1,3 @@
 require "sequel"
 require "sequel/plugins/through_associations"
-require "sequel/plugins/cyclical_association_solver"
+require "sequel/plugins/cyclical_through_associations"

data/sequel-through.gemspec

@@ -3,7 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "sequel-through"
-  spec.version       = "0.3.0"
+  spec.version       = "0.3.1"
   spec.authors       = ["Kenaniah Cerny"]
   spec.email         = ["kenaniah@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sequel-through
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Kenaniah Cerny
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-04 00:00:00.000000000 Z
+date: 2019-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -81,7 +81,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/sequel/plugins/cyclical_association_solver.rb
+- lib/sequel/plugins/cyclical_through_associations.rb
 - lib/sequel/plugins/through_associations.rb
 - lib/sequel/through.rb
 - sequel-through.gemspec