most_related 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f43d6f1133f821173a90f7acfbe012d5d9e74185
+  data.tar.gz: 711e311cf7fe8e068710bdef6143599cae2716e4
+SHA512:
+  metadata.gz: a886a99974f9ec4eb0708b06b69e7eff11a4a94cdc5f0270910d60d3a298434b61a2f8d0c2c3588c33d3cafc47de52eb389f0f0b6f60d6891685cb0a4fd44463
+  data.tar.gz: 8d3f4bb699c3223b112165a8754aa23e3e61e2515a6638c165d4493f2f588977fcef8634d04de323a8412b22e07ee19ecad23a35bdc46582586e070987dd12cb

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in most_related.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jolyon Pawlyn
+
+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,69 @@
+# MostRelated
+
+`most_related` returns models that have the most many to many associated models in common
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'most_related'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install most_related
+
+## Usage
+
+Post example
+
+    class Post < ActiveRecord::Base
+      has_most_related :authors
+      has_most_related :tags, as: :most_related_by_tags
+      has_most_related [:authors, :tags], as: :most_related_by_author_or_tag
+
+      has_many :author_posts
+      has_many :authors, through: :author_posts
+    end
+
+    class Author < ActiveRecord::Base
+      has_many :author_posts
+    end
+
+    class AuthorPosts < ActiveRecord::Base
+      belongs_to :author
+      belongs_to :post
+    end
+
+To return the posts with the most authors in common with post, in descending order:
+
+    post.most_related
+
+To return the posts with the most tags in common with post, in descending order:
+
+    post.most_related_by_tag
+
+To return the posts with the most authors and tags in common with post, in descending order:
+
+    post.most_related_by_author_or_tag
+
+The count of the many to many associated models in common is accessible on each returned model
+
+    post.most_related_count
+    post.most_related_by_tag_count
+    post.most_related_by_author_or_tag
+
+If multiple many to many associations are used, the syntax is specific to MySql.
+
+Because of the use of 'group', pagination is not supported.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/most_related/version.rb

@@ -0,0 +1,3 @@
+module MostRelated
+  VERSION = "0.0.2"
+end

data/lib/most_related.rb

@@ -0,0 +1,91 @@
+require "most_related/version"
+
+module MostRelated
+
+  # `most_related` returns those models that have the most
+  # many to many associated models in common
+  #
+  # Post example:
+  #
+  #   class Post < ActiveRecord::Base
+  #     has_most_related :authors
+  #     has_most_related :tags, as: :most_related_by_tags
+  #     has_most_related [:authors, :tags], as: :most_related_by_author_or_tag
+  #
+  #     has_many :author_posts
+  #     has_many :authors, through: :author_posts
+  #   end
+  #
+  #   class Author < ActiveRecord::Base
+  #     has_many :author_posts
+  #   end
+  #
+  #   class AuthorPosts < ActiveRecord::Base
+  #     belongs_to :author
+  #     belongs_to :post
+  #   end
+  #
+  # To return the posts with the most authors in common with post, in descending order:
+  #   post.most_related
+  #
+  # To return the posts with the most tags in common with post, in descending order:
+  #   post.most_related_by_tag
+  #
+  # To return the posts with the most authors and tags in common with post, in descending order:
+  #   post.most_related_by_author_or_tag
+  #
+  # The count of the many to many associated models in common is accessible on each returned model
+  #   eg post.most_related_count, post.most_related_by_tag_count and post.most_related_by_author_or_tag
+  #
+  def has_most_related(many_to_many_associations, as: :most_related)
+
+    # defaults to 'def most_related'
+    define_method as do
+      table_name = self.class.table_name
+      association_scopes = []
+
+      many_to_many_associations = if many_to_many_associations.is_a?(Array)
+        many_to_many_associations
+      else
+        [many_to_many_associations]
+      end
+
+      many_to_many_associations.each do |many_to_many_association|
+        assocation = self.class.reflect_on_association(many_to_many_association)
+        join_table, foreign_key, association_foreign_key = self.class.join_table_values(assocation)
+
+        association_scopes << self.class.where("#{join_table}.#{association_foreign_key} IN " +
+          "(select #{join_table}.#{association_foreign_key} from #{join_table} " +
+          "where #{join_table}.#{foreign_key} = :foreign_key)", foreign_key: self.id).
+          joins("INNER JOIN #{join_table} ON #{join_table}.#{foreign_key} = #{table_name}.id")
+      end
+
+      scope = self.class.select("#{table_name}.*, count(#{table_name}.id) AS #{as}_count").
+        where.not(id: self.id).group("#{table_name}.id").order("#{as}_count DESC")
+
+      # if there is only one many-to-many association no need to use UNION sql syntax
+      if association_scopes.size == 1
+        scope.merge(association_scopes.first)
+      else
+        # see http://blog.ubersense.com/2013/09/27/tech-talk-unioning-scoped-queries-in-rails/
+        scope.from("((#{association_scopes.map(&:to_sql).join(') UNION ALL (')})) #{table_name}")
+      end
+    end
+
+    def self.join_table_values(many_to_many_assocation)
+      if many_to_many_assocation.macro == :has_and_belongs_to_many
+        join_table = many_to_many_assocation.join_table
+        foreign_key = many_to_many_assocation.foreign_key
+        association_foreign_key = many_to_many_assocation.association_foreign_key
+      elsif many_to_many_assocation.macro == :has_many
+        join_table = many_to_many_assocation.through_reflection.table_name
+        foreign_key = many_to_many_assocation.through_reflection.foreign_key
+        association_foreign_key = many_to_many_assocation.foreign_key
+      end
+      [join_table, foreign_key, association_foreign_key]
+    end
+  end
+end
+
+# Extend ActiveRecord functionality
+ActiveRecord::Base.extend MostRelated

data/most_related.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'most_related/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "most_related"
+  spec.version       = MostRelated::VERSION
+  spec.authors       = ["Jolyon Pawlyn"]
+  spec.email         = ["jolyon.pawlyn@unboxedconsulting.com"]
+  spec.description   = %q{Adds an instance method to a active record model that returns the most related models based on many to many associated models in common}
+  spec.summary       = %q{Returns models that have the most many to many associated models in common}
+  spec.homepage      = "https://github.com/jpawlyn/most_related"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rspec', '~> 2.14.1"
+  spec.add_development_dependency "activerecord", "~> 4.0.0"
+  spec.add_development_dependency "sqlite3"
+end

data/spec/post_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe Post do
+  let(:author1) { Author.create! }
+  let(:author2) { Author.create! }
+  let(:author3) { Author.create! }
+  let(:author4) { Author.create! }
+  let(:tag1) { Tag.create! }
+  let(:tag2) { Tag.create! }
+  let(:tag3) { Tag.create! }
+  let(:tag4) { Tag.create! }
+
+  context 'has_many through:' do
+    it 'return posts that have the most authors in common with post' do
+      post = Post.create! authors: [author1, author2, author3]
+      post1 = Post.create! authors: [author1, author4]
+      post2 = Post.create! authors: [author1, author2]
+      post3 = Post.create! authors: [author4]
+      post4 = Post.create! authors: [author1, author2, author3]
+
+      expect(post.most_related.map(&:most_related_count)).to eq([3, 2, 1])
+      expect(post.most_related).to eq([post4, post2, post1])
+    end
+  end
+
+  context 'has_and_belongs_to_many' do
+    it 'return posts that have the most tags in common with post' do
+      post = Post.create! tags: [tag1, tag2, tag3]
+      post1 = Post.create! tags: [tag1, tag4]
+      post2 = Post.create! tags: [tag1, tag2]
+      post3 = Post.create! tags: [tag4]
+      post4 = Post.create! tags: [tag1, tag2, tag3]
+
+      expect(post.most_related_by_tag.map(&:most_related_by_tag_count)).to eq([3, 2, 1])
+      expect(post.most_related_by_tag).to eq([post4, post2, post1])
+    end
+  end
+
+  context "combination of 'has_many through:' and habtm" do
+    let(:post)  { Post.create! authors: [author1, author2, author3], tags: [tag1, tag2, tag3] }
+    let(:post1) { Post.create! authors: [author1, author2, author3], tags: [tag1, tag2, tag4] }
+    let(:post2) { Post.create! authors: [author1, author4] }
+    let(:post3) { Post.create! tags: [tag4] }
+    let(:post4) { Post.create! authors: [author1], tags: [tag1, tag2, tag3] }
+
+    it 'return posts that have the most authors and tags in common with post' do
+      pending 'Does not work with sqlite - mysql only perhaps?'
+      expect(post.most_related_by_author_or_tag.map(&:most_related_by_author_or_tag_count)).to eq([5, 4, 1])
+      expect(post.most_related_by_author_or_tag).to eq([post1, post4, post2])
+    end
+
+    it 'sql check' do
+      expect(post.most_related_by_author_or_tag.where_clauses).to eq(["(\"posts\".\"id\" != #{post.id})"])
+      expect(post.most_related_by_author_or_tag.order_clauses).to eq(["most_related_by_author_or_tag_count DESC"])
+      sql = <<-eos
+        SELECT posts.*, count(posts.id) AS most_related_by_author_or_tag_count FROM
+          ((SELECT \"posts\".* FROM \"posts\" INNER JOIN author_posts ON author_posts.post_id = posts.id WHERE
+            (author_posts.author_id IN (select author_posts.author_id from author_posts where author_posts.post_id = #{post.id})))
+          UNION ALL (SELECT \"posts\".* FROM \"posts\" INNER JOIN posts_tags ON posts_tags.post_id = posts.id WHERE
+            (posts_tags.tag_id IN (select posts_tags.tag_id from posts_tags where posts_tags.post_id = #{post.id})))) posts
+        WHERE (\"posts\".\"id\" != #{post.id}) GROUP BY posts.id  ORDER BY most_related_by_author_or_tag_count DESC
+      eos
+      expect(post.most_related_by_author_or_tag.to_sql.squish!).to eq(sql.squish!)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+
+# see http://blog.markstarkman.com/blog/2013/01/23/using-sqlite-to-test-active-record-models/
+require 'active_record'
+ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+load 'support/schema.rb'
+
+require 'most_related'
+require 'support/models'
+require 'support/string'
+
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/support/models.rb

@@ -0,0 +1,20 @@
+class Post < ActiveRecord::Base
+  has_most_related :authors
+  has_most_related :tags, as: :most_related_by_tag
+  has_most_related [:authors, :tags], as: :most_related_by_author_or_tag
+
+  has_and_belongs_to_many :tags
+  has_many :author_posts
+  has_many :authors, through: :author_posts
+end
+
+class Tag < ActiveRecord::Base
+end
+
+class Author < ActiveRecord::Base
+end
+
+class AuthorPost < ActiveRecord::Base
+  belongs_to :author
+  belongs_to :post
+end

data/spec/support/schema.rb

@@ -0,0 +1,25 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :authors, force: true do |t|
+    t.timestamps
+  end
+
+  create_table :author_posts, force: true do |t|
+    t.integer :author_id, null: false
+    t.integer :post_id, null: false
+    t.timestamps
+  end
+
+  create_table :posts, force: true do |t|
+    t.timestamps
+  end
+
+  create_table :posts_tags, force: true do |t|
+    t.integer :post_id, null: false
+    t.integer :tag_id, null: false
+  end
+
+  create_table :tags, force: true do |t|
+  end
+end

data/spec/support/string.rb

@@ -0,0 +1,8 @@
+class String
+  def squish!
+    gsub!(/\A[[:space:]]+/, '')
+    gsub!(/[[:space:]]+\z/, '')
+    gsub!(/[[:space:]]+/, ' ')
+    self
+  end
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: most_related
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Jolyon Pawlyn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec', '~> 2.14.1
+  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: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.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'
+description: Adds an instance method to a active record model that returns the most
+  related models based on many to many associated models in common
+email:
+- jolyon.pawlyn@unboxedconsulting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/most_related.rb
+- lib/most_related/version.rb
+- most_related.gemspec
+- spec/post_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+- spec/support/string.rb
+homepage: https://github.com/jpawlyn/most_related
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Returns models that have the most many to many associated models in common
+test_files:
+- spec/post_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+- spec/support/string.rb