similar_models 0.2.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b55aa8e2b833092a963b70b211ff10f0ee78ead0
-  data.tar.gz: 264b408ebdb78c40b31a1c7f37c99cf6a0360c76
+SHA256:
+  metadata.gz: 2bf02e51c067023b861f64a73394be810f74ed007a4299a4cc4de18fb7e8ff71
+  data.tar.gz: ae0fdceeb1388fa7a247c89d892d812c2554ffb0c7f12c1389da6b313b3b3350
 SHA512:
-  metadata.gz: b81bfa56e0a7cfad7ca1c2e3e00d67645dcf18ef2c0e1726d8f23905ffceda65e1ee7d8a617f5e1af136c62a36cb0f20b85f6e9cac5a5792423c06d277e812c6
-  data.tar.gz: b2a2d671129e2bdc1498296b8ce299d599132f96751bb5227fa5a35458026b4fb6c13e01710a29502e047f0632a8484df506fbef0f29fb21e40cd85d11857652
+  metadata.gz: 3ac48f199b64dc571a9f05caf15128429b809988d8d904750870fa30db3b74a3a5bb5a650862b3b97ce331bd5b9c250efe4efb090c96552c2610da8dbed46760
+  data.tar.gz: d0bbb042025768241fcc2b487b9767e19fbd8244f79653d213908added72df10a9368daba02f192390954ebf5f96618b035b49ae4dabbeae0d8c156a629d3dca

data/.ruby-version

@@ -1 +1 @@
-2.3.3
+3.4.2

data/README.md

@@ -1,80 +1,116 @@
 # 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.
+Adds a `similar_#{model_name.plural}` instance and class method to an active record model, but can be set to any name using `as: {method name}`.
 
-The association(s) have to be many to many, so either [habtm](http://guides.rubyonrails.org/association_basics.html#the-has-and-belongs-to-many-association) or [has_many :through](http://guides.rubyonrails.org/association_basics.html#the-has-many-through-association).
+The instance method returns models that have associated models in common ordered by most in common first.
+
+The class method returns models ordered by most associated models in common.
+
+If the commonality count is the same then a second order clause of `created_at` if present takes precedence.
+
+The association(s) have to be many to many, so either [habtm](https://guides.rubyonrails.org/association_basics.html#has-and-belongs-to-many) or [has_many :through](https://guides.rubyonrails.org/association_basics.html#has-many-through).
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'similar_models'
+```sh
+gem 'similar_models'
+```
 
 And then execute:
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install similar_models
+```sh
+$ bundle
+```
 
 ## Usage
 
 Post example
 
-    class Post < ActiveRecord::Base
-      has_many :author_posts
-      has_many :authors, through: :author_posts
-      has_and_belongs_to_many :tags
+```ruby
+class Post < ApplicationRecord
+  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
+  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 Tag < ApplicationRecord
+end
 
-    class Author < ActiveRecord::Base
-      has_many :author_posts
-    end
+class Author < ApplicationRecord
+  has_many :author_posts
+end
 
-    class AuthorPosts < ActiveRecord::Base
-      belongs_to :author
-      belongs_to :post
-    end
+class AuthorPosts < ApplicationRecord
+  belongs_to :author
+  belongs_to :post
+end
+```
 
-To return the posts with the most authors in common with `post` in descending order:
+To return posts with authors in common with the `post` model by most in common first:
 
-    post.similar_posts
+```ruby
+post.similar_posts
+```
+
+To return posts ordered by most authors in common:
+```ruby
+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)
+```ruby
+post.similar_posts.where(created_at: 10.days.ago..).limit(5)
+```
+
+To return posts with tags in common with the `post` model by most in common first:
+
+```ruby
+post.similar_posts_by_tag
+```
+
+To return posts ordered by most tags in common:
+```ruby
+Post.similar_posts_by_tag
+```
 
-To return the posts with the most tags in common with `post` in descending order:
+To return posts with the authors and tags in common with the `post` model by most in common first:
 
-    post.similar_posts_by_tag
+```ruby
+post.similar_posts_by_author_and_tag
+```
 
-To return the posts with the most authors and tags in common with `post` in descending order:
+To return posts ordered by most authors and tags in common:
 
-    post.similar_posts_by_author_and_tag
+```ruby
+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
+```ruby
+post.similar_posts_commonality_count
+post.similar_posts_by_tag_commonality_count
+post.similar_posts_by_author_and_tag_commonality_count
+```
 
-Note multiple associations do not work with sqlite.
+**Note multiple associations for the instance method do not work with sqlite.**
 
-Because of the use of `group`, pagination is not supported.
+**Pagination is not supported on the instance method due to the use of `group by`.**
 
 ## In conjunction with acts-as-taggable-on
 
-If you use https://github.com/mbleigh/acts-as-taggable-on/#usage and want to find related users say across multiple contexts:
+If you use [mbleigh/acts-as-taggable-on](https://github.com/mbleigh/acts-as-taggable-on/#usage) and want to find related users say across multiple contexts:
 
-    user.similar_users.where(taggings: { context: %w(skills interests) })
+```ruby
+user.similar_users.where(taggings: { context: %w(skills interests) })
+```
 
 ## Contributing
 

data/lib/similar_models/version.rb

@@ -1,3 +1,3 @@
 module SimilarModels
-  VERSION = '0.2.1'
+  VERSION = '0.4.0'
 end

data/lib/similar_models.rb

@@ -3,9 +3,45 @@ require 'similar_models/version'
 module SimilarModels
 
   def has_similar_models(*many_to_many_associations, as: nil)
-    as = "similar_#{model_name.plural}" unless as
+    as ||= "similar_#{model_name.plural}"
 
-    # defaults to 'def similar_{model name}'
+    # example sql query for one many to many association:
+    #
+    # SELECT posts.*,
+    #   (select count(*) from author_posts where post_id != posts.alt_id and author_id in
+    #     (select author_id from author_posts where post_id = posts.alt_id)) AS similar_posts_commonality_count
+    #   FROM "posts"
+    #   ORDER BY similar_posts_commonality_count DESC, created_at DESC
+    #
+    define_singleton_method as do
+      primary_key_ref = "#{table_name}.#{primary_key}"
+      similarity_counts = []
+
+      many_to_many_associations.each do |many_to_many_association|
+        association = reflect_on_association(many_to_many_association)
+        join_table, foreign_key, association_foreign_key = join_table_values(association)
+
+        similarity_counts <<
+          "(select count(*) from #{join_table} where #{foreign_key} != #{primary_key_ref} and " \
+          "#{association_foreign_key} in " \
+          "(select #{association_foreign_key} from #{join_table} where #{foreign_key} = #{primary_key_ref}))"
+      end
+
+      order_clause = "#{as}_commonality_count DESC"
+      order_clause += ", created_at DESC" if column_names.include?('created_at')
+      select("#{table_name}.*, #{similarity_counts.join(' + ')} AS #{as}_commonality_count").order(order_clause)
+    end
+
+    # example sql query for one many to many association:
+    #
+    # SELECT posts.*, count(posts.alt_id) AS similar_posts_commonality_count
+    #   FROM "posts"
+    #   INNER JOIN author_posts ON author_posts.post_id = posts.alt_id
+    #     WHERE "posts"."alt_id" != ? AND
+    #       author_posts.author_id IN (select author_posts.author_id from author_posts where author_posts.post_id = ?)
+    #   GROUP BY posts.alt_id, posts.created_at, posts.updated_at
+    #   ORDER BY similar_posts_commonality_count DESC, created_at DESC
+    #
     define_method as do
       table_name = self.class.table_name
       primary_key = self.class.primary_key
@@ -13,8 +49,8 @@ module SimilarModels
       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 = self.class.reflect_on_association(many_to_many_association)
+        join_table, foreign_key, association_foreign_key = self.class.join_table_values(association)
 
         association_scopes << self.class.where(
           "#{join_table}.#{association_foreign_key} IN \
@@ -23,15 +59,16 @@ module SimilarModels
         ).joins("INNER JOIN #{join_table} ON #{join_table}.#{foreign_key} = #{primary_key_ref}")
       end
 
-      scope = self.class.select("#{table_name}.*, count(#{primary_key_ref}) AS #{as}_model_count").
-        where.not(primary_key => self.id).order("#{as}_model_count DESC")
+      order_clause = "#{as}_commonality_count DESC"
+      order_clause += ", created_at DESC" if self.class.column_names.include?('created_at')
+      scope = self.class.select("#{table_name}.*, count(#{primary_key_ref}) AS #{as}_commonality_count").
+        where.not(primary_key => self.id).order(order_clause)
       group_by_clause = self.class.column_names.map { |column| "#{table_name}.#{column}"}.join(', ')
 
       # 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
-        # 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

data/similar_models.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   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.description   = %q{Adds a `similar_#{model_name.plural}` instance and class method to an active record model and returns models based on associated models in common ordered by most in common first}
+  spec.summary       = %q{Returns models that have associated models in common ordered by most in common first}
   spec.homepage      = "https://github.com/jpawlyn/similar_models"
   spec.license       = "MIT"
 
@@ -18,13 +18,12 @@ Gem::Specification.new do |spec|
   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.16'
+  spec.required_ruby_version     = '>= 3.1'
+  spec.add_runtime_dependency     'activerecord', '>= 7.2'
   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 'sqlite3', '~>2.6'
   spec.add_development_dependency 'mysql2', '~>0.5'
-  spec.add_development_dependency 'pg', '~>1.0'
-  spec.add_development_dependency 'byebug', '~>9.0'
+  spec.add_development_dependency 'pg', '~>1.5'
+  spec.add_development_dependency 'debug', '~>1.0'
 end

data/spec/post_spec.rb

@@ -5,34 +5,52 @@ describe Post do
   let(:author2) { Author.create! }
   let(:author3) { Author.create! }
   let(:author4) { Author.create! }
+  let(:author5) { 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])
+    let!(:post)  { Post.create! authors: [author1, author2, author3] }
+    let!(:post1) { Post.create! authors: [author1] }
+    let!(:post2) { Post.create! authors: [author4] }
+    let!(:post3) { Post.create! authors: [author1, author2, author3, author4] }
+    let!(:post4) { Post.create! authors: [author5] }
+
+    describe '.similar_posts' do
+      it 'return posts ordered by most authors in common' do
+        expect(described_class.similar_posts.map(&:similar_posts_commonality_count)).to eq([5, 4, 2, 1, 0])
+        expect(described_class.similar_posts).to eq([post3, post, post1, post2, post4])
+      end
+    end
+
+    describe '#similar_posts' do
+      it 'return posts that have authors in common with `post` ordered by most in common first' do
+        expect(post.similar_posts.map(&:similar_posts_commonality_count)).to eq([3, 1])
+        expect(post.similar_posts).to eq([post3, post1])
+      end
     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])
+    let!(:post) { Post.create! tags: [tag1, tag2, tag3] }
+    let!(:post1) { Post.create! tags: [tag1, tag4] }
+    let!(:post2) { Post.create! tags: [tag2] }
+    let!(:post3) { Post.create! tags: [tag2, tag3] }
+
+    describe '.similar_posts_by_tag' do
+      it 'return posts ordered by most tags in common' do
+        expect(described_class.similar_posts_by_tag.map(&:similar_posts_by_tag_commonality_count)).to eq([4, 3, 2, 1])
+        expect(described_class.similar_posts_by_tag).to eq([post, post3, post2, post1])
+      end
+    end
+
+    describe '#similar_posts_by_tag' do
+      it 'return posts that have tags in common with `post` ordered by most in common first' do
+        expect(post.similar_posts_by_tag.map(&:similar_posts_by_tag_commonality_count)).to eq([2, 1, 1])
+        expect(post.similar_posts_by_tag).to eq([post3, post2, post1])
+      end
     end
   end
 
@@ -43,9 +61,19 @@ describe Post do
     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])
+    describe '.similar_posts_by_author_and_tag' do
+      it 'return posts ordered by most authors and tags in common' do
+        expect(described_class.similar_posts_by_author_and_tag.map(&:similar_posts_by_author_and_tag_commonality_count))
+          .to eq([10, 10, 8, 3, 1])
+        expect(described_class.similar_posts_by_author_and_tag).to eq([post1, post, post4, post2, post3])
+      end
+    end
+
+    describe '#similar_posts_by_author_and_tag' do
+      it 'return posts that have authors and tags in common with `post` ordered by most in common first' do
+        expect(post.similar_posts_by_author_and_tag.map(&:similar_posts_by_author_and_tag_commonality_count)).to eq([5, 4, 1])
+        expect(post.similar_posts_by_author_and_tag).to eq([post1, post4, post2])
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -15,7 +15,7 @@ load 'support/schema.rb'
 require 'similar_models'
 require 'support/models'
 require 'database_cleaner'
-require 'byebug'
+require 'debug'
 
 DatabaseCleaner.strategy = :transaction
 

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: similar_models
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Jolyon Pawlyn
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-10 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,28 +15,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '7.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.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +57,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -100,30 +85,31 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '1.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
+        version: '1.0'
+description: Adds a `similar_#{model_name.plural}` instance and class method to an
+  active record model and returns models based on associated models in common ordered
+  by most in common first
 email:
 - jpawlyn@gmail.com
 executables: []
@@ -147,7 +133,6 @@ homepage: https://github.com/jpawlyn/similar_models
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -155,18 +140,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '3.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: 
+rubygems_version: 3.6.5
 specification_version: 4
-summary: Returns models that have the most associated models in common
+summary: Returns models that have associated models in common ordered by most in common
+  first
 test_files:
 - spec/post_spec.rb
 - spec/spec_helper.rb