similar_models 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a937276a3ad548a1941029abfdedbb6696c14e39
+  data.tar.gz: 90d95999b118943e34ae960fce17be495918b30b
+SHA512:
+  metadata.gz: 5d0cd374a49fbc5f1ee85433d38463eabdbdad9990ad81bb94efd142caea0a922f5fb8e7d12bf7622f96718976264be6d47fd13fa6f369a7e036fdec63a59095
+  data.tar.gz: c6df39065597cbf583c8311564b15854ddee418eb5fdcee5337aa52685523f2fd12df8d5aab6079842742d1c91e97feb0f5e4bbd2485917587bb9aeb97215e39

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in similar_models.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,79 @@
+# Similar Models
+
+Adds a `similar_{model name plural}` method to an active record model, but can be set to any name using `as: {method name}`. It returns the most similar models of the same class based on associated models in common.
+
+The association(s) have to be many to many, so either habtm or 'has_many though'.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'similar_models'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install similar_models
+
+## Usage
+
+Post example
+
+    class Post < ActiveRecord::Base
+      has_many :author_posts
+      has_many :authors, through: :author_posts
+      has_and_belongs_to_many :tags
+
+      has_similar_models :authors
+      has_similar_models :tags, as: :similar_posts_by_tags
+      has_similar_models :authors, :tags, as: :similar_posts_by_author_or_tag
+    end
+
+    class Tag < ActiveRecord::Base
+    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.similar_posts
+
+The returned object is an ActiveRecord::Relation and so chaining of other query methods is possible:
+
+    post.similar_posts.where('posts.created_at > ?', 10.days.ago).limit(5)
+
+To return the posts with the most tags in common with `post` in descending order:
+
+    post.similar_posts_by_tag
+
+To return the posts with the most authors and tags in common with `post` in descending order:
+
+    post.similar_posts_by_author_and_tag
+
+The count of the associated models in common is accessible on each returned model:
+
+    post.similar_posts_model_count
+    post.similar_posts_by_tag_model_count
+    post.similar_posts_by_author_and_tag_model_count
+
+Note multiple associations do not work with sqlite.
+
+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/similar_models/version.rb

@@ -0,0 +1,3 @@
+module SimilarModels
+  VERSION = '0.1.0'
+end

data/lib/similar_models.rb

@@ -0,0 +1,58 @@
+require 'similar_models/version'
+
+module SimilarModels
+
+  def has_similar_models(*many_to_many_associations, as: nil)
+    as = "similar_#{model_name.plural}" unless as
+
+    # defaults to 'def similar_{model name}'
+    define_method as do
+      table_name = self.class.table_name
+      association_scopes = []
+
+      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}_model_count").
+        where.not(id: self.id).order("#{as}_model_count DESC")
+      group_by_clause = 'id'
+
+      # if there is only one many-to-many association no need to use UNION sql syntax
+      if association_scopes.one?
+        scope.merge(association_scopes.first).group(group_by_clause)
+      else
+        # with postgres the group by clause has to be different
+        # http://dba.stackexchange.com/questions/88988/postgres-error-column-must-appear-in-the-group-by-clause-or-be-used-in-an-aggre
+        if ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
+          group_by_clause = self.class.column_names.join(', ')
+        end
+
+        # 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 (')})) AS #{table_name}").group(group_by_clause)
+      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 SimilarModels

data/similar_models.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'similar_models/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "similar_models"
+  spec.version       = SimilarModels::VERSION
+  spec.authors       = ["Jolyon Pawlyn"]
+  spec.email         = ["jpawlyn@gmail.com"]
+  spec.description   = %q{Adds an instance method to an active record model that returns the most similar models based on associated models in common}
+  spec.summary       = %q{Returns models that have the most associated models in common}
+  spec.homepage      = "https://github.com/jpawlyn/similar_models"
+  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.required_ruby_version     = '>= 2.1'
+  spec.add_runtime_dependency     'activerecord', '~> 4.2'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'database_cleaner', '~>1.5'
+  spec.add_development_dependency 'sqlite3', '~>1.3'
+  spec.add_development_dependency 'mysql2', '~>0.4'
+  spec.add_development_dependency 'pg', '~>0.19'
+  spec.add_development_dependency 'byebug', '~>9.0'
+end

data/spec/post_spec.rb

@@ -0,0 +1,51 @@
+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.similar_posts.map(&:similar_posts_model_count)).to eq([3, 2, 1])
+      expect(post.similar_posts).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.similar_posts_by_tag.map(&:similar_posts_by_tag_model_count)).to eq([3, 2, 1])
+      expect(post.similar_posts_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
+      expect(post.similar_posts_by_author_and_tag.map(&:similar_posts_by_author_and_tag_model_count)).to eq([5, 4, 1])
+      expect(post.similar_posts_by_author_and_tag).to eq([post1, post4, post2])
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+# 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: 'postgresql', database: 'similar_models'
+# ActiveRecord::Base.establish_connection adapter: 'mysql2', database: 'similar_models'
+# ActiveRecord::Base.establish_connection adapter: 'sqlite3', database: ':memory:'
+load 'support/schema.rb'
+
+require 'similar_models'
+require 'support/models'
+require 'database_cleaner'
+require 'byebug'
+
+DatabaseCleaner.strategy = :transaction
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  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'
+
+  config.before :each do
+    DatabaseCleaner.start
+  end
+
+  config.after :each do
+    DatabaseCleaner.clean
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,20 @@
+class Post < ActiveRecord::Base
+  has_many :author_posts
+  has_many :authors, through: :author_posts
+  has_and_belongs_to_many :tags
+
+  has_similar_models :authors
+  has_similar_models :tags, as: :similar_posts_by_tag
+  has_similar_models :authors, :tags, as: :similar_posts_by_author_and_tag
+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 null: false
+  end
+
+  create_table :author_posts, force: true do |t|
+    t.integer :author_id, null: false
+    t.integer :post_id, null: false
+    t.timestamps null: false
+  end
+
+  create_table :posts, force: true do |t|
+    t.timestamps null: false
+  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

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: similar_models
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jolyon Pawlyn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-15 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: Adds an instance method to an active record model that returns the most
+  similar models based on associated models in common
+email:
+- jpawlyn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/similar_models.rb
+- lib/similar_models/version.rb
+- similar_models.gemspec
+- spec/post_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+homepage: https://github.com/jpawlyn/similar_models
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Returns models that have the most associated models in common
+test_files:
+- spec/post_spec.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb