active_similar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b84485dfe06d69d270e19a691a5fac3c17256b1c75ec7a568985ec316751151d
+  data.tar.gz: c38a0965fc70a4dbeb5617d06b6997ef70fc89cbc9d25803ff75f243ac4236d9
+SHA512:
+  metadata.gz: ac4ac2655afc7135e898d1c97cb168e811e23a27546ac69521d47de6be99dc9178a657933abb610afc218e872eec04de657125d115919ae2a7acdd61e61eed20
+  data.tar.gz: 75ce8ec70f92b2063ed498887c242e4778f65518a2a48417339a8ca9c8099c4454626c4729e8dbc12c4e20c38d81b358438f5f30b0ed741d2b5786c46353fe86

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,37 @@
+# Code of Conduct
+
+All participants of this project are expected to abide by our Code of Conduct, both online and during in-person events that are hosted and/or associated with this project.
+
+## The Pledge
+
+In the interest of fostering an open and welcoming environment, we pledge to make participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## The Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Referring to people by their preferred pronouns and using gender-neutral pronouns when uncertain
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+* Dismissing or attacking inclusion-oriented requests
+
+## Enforcement
+
+Violations of the Code of Conduct may be reported by sending an email to info@hardpixel.eu. All reports will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Further details of specific enforcement policies may be posted separately.
+
+We hold the right and responsibility to remove comments or other contributions that are not aligned to this Code of Conduct, or to suspend temporarily or permanently any members for other behaviors that are inappropriate, threatening, offensive, or harmful.
+
+## Attribution
+
+This Code of Conduct is adapted from [dev.to](https://dev.to/code-of-conduct).

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Jonian Guveli
+
+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,64 @@
+# Active Similar
+
+Ruby gem to find similar Active Record models through most common associations.
+
+[![Gem Version](https://badge.fury.io/rb/active_similar.svg)](https://badge.fury.io/rb/active_similar)
+[![Build](https://github.com/hardpixel/active-similar/actions/workflows/build.yml/badge.svg)](https://github.com/hardpixel/active-similar/actions/workflows/build.yml)
+[![Maintainability](https://api.codeclimate.com/v1/badges/9070ea120ceeddbcc1d2/maintainability)](https://codeclimate.com/github/hardpixel/active-similar/maintainability)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_similar'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install active_similar
+
+## Usage
+
+```ruby
+require 'active_similar'
+
+class Post < ActiveRecord::Base
+  include ActiveSimilar
+
+  has_many :categories
+  has_many :tags
+
+  scope :published, -> { where status: 'published' }
+  scope :featured,  -> { where featured: true }
+
+  has_similar :related, through: %i[categories tags], scope: :published
+end
+
+post = Post.find(1)
+post.related # Returns similar posts to post #1
+
+similar = ActiveSimilar::Query.new(Post.published, through: %i[categories tags])
+similar.with(2) # Returns similar posts to post #2
+
+similar = ActiveSimilar::Query.new(Post.featured, through: %i[categories])
+similar.with(3) # Returns similar posts to post #3
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hardpixel/active-similar.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/active_similar/association.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ActiveSimilar
+  # Builds association subquery.
+  class Association
+    attr_reader :klass, :reflection, :other
+
+    delegate :foreign_key, :through_reflection,
+      to: :reflection
+
+    delegate :klass, :name, :table_name, :foreign_key,
+      to: :through_reflection,
+      prefix: :through
+
+    # Returns a new instance of Association.
+    # @param name [Symbol]
+    # @param klass [ActiveRecord::Base]
+    # @param other [Integer ActiveRecord::Base]
+
+    def initialize(name, klass, other)
+      @klass      = klass
+      @reflection = klass.reflect_on_association(name)
+      @other      = other
+    end
+
+    # Returns the association join scope.
+    # @return [ActiveRecord::Relation]
+    def scope
+      klass
+        .joins(through_name)
+        .where(through_table_name => { foreign_key => subquery })
+    end
+
+    private
+
+    def subquery
+      through_klass
+        .select(foreign_key)
+        .where(through_foreign_key => other)
+    end
+  end
+end

data/lib/active_similar/query.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require 'active_similar/association'
+
+module ActiveSimilar
+  # Queries similar models through most common associations.
+  class Query
+    attr_reader :scope, :through, :prefix
+
+    delegate :klass, :table, :select_values,
+      to: :scope
+
+    delegate :primary_key, :column_names,
+      to: :klass
+
+    # Returns a new instance of Query.
+    # @param scope [ActiveRecord::Relation]
+    # @param through [Symbol Array<Symbol>]
+    # @param prefix [String]
+    # @raise [TypeError] if scope has invalid type
+
+    def initialize(scope, through:, prefix: 'similar')
+      relation = ActiveRecord::Relation
+      scope.is_a?(relation) || raise(TypeError, "scope must be #{relation}")
+
+      @scope   = scope
+      @through = Array(through)
+      @prefix  = prefix
+    end
+
+    # Returns records similar to other record.
+    # @param other [Integer ActiveRecord::Base]
+    # @return [ActiveRecord::Relation]
+
+    def with(other)
+      scope
+        .merge(subquery(other))
+        .where.not(primary_key => other)
+        .select(*select_columns)
+        .group(*group_columns)
+        .order(count_column => :desc)
+    end
+
+    def inspect # :nodoc:
+      "#<#{self.class.name} model=#{klass.name} through=#{through} prefix=#{prefix}>"
+    end
+
+    private
+
+    def count_column
+      "#{prefix}_#{table.name}_count"
+    end
+
+    def columns
+      names  = column_names
+      names &= select_values.map(&:to_s) if select_values.any?
+
+      names
+    end
+
+    def group_columns
+      columns.map { |col| table[col] }
+    end
+
+    def select_columns
+      counter  = table[primary_key].count.as(count_column)
+      clauses  = [counter.to_sql]
+      clauses << table[Arel.star] if select_values.none?
+
+      clauses
+    end
+
+    def build_association(name, other)
+      assoc = Association.new(name, klass, other)
+      return assoc.scope if select_values.none?
+
+      assoc.scope.select(*group_columns)
+    end
+
+    def build_union(left, right)
+      left  = Arel::Nodes::Grouping.new(left.arel.ast)
+      right = Arel::Nodes::Grouping.new(right.arel.ast)
+
+      klass.unscoped.from(
+        Arel::Nodes::TableAlias.new(
+          Arel::Nodes::UnionAll.new(left, right),
+          table.name
+        )
+      )
+    end
+
+    def subquery(other)
+      items = through.map { |name| build_association(name, other) }
+      query = items.delete_at(0)
+
+      items.each do |item|
+        query = build_union(query, item)
+      end
+
+      query
+    end
+  end
+end

data/lib/active_similar/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveSimilar
+  VERSION = '0.1.0'
+end

data/lib/active_similar.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'active_record'
+
+require 'active_similar/query'
+require 'active_similar/version'
+
+# Find similar Active Record models through most common associations.
+module ActiveSimilar
+  extend ActiveSupport::Concern
+
+  class_methods do
+    # Defines method to retrieve similar records.
+    # @param name [Symbol]
+    # @param through [Symbol Array<Symbol>]
+    # @param class_name [ActiveRecord::Base]
+    # @param scope [Symbol]
+
+    def has_similar(name, through:, class_name: self, scope: :all)
+      klass = const_get(class_name.to_s)
+      scope = klass.send(scope)
+
+      define_method(name) do
+        similar = Query.new(scope, through: through, prefix: name)
+        similar.with(id)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: active_similar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonian Guveli
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Find similar Active Record models through most common associations.
+email:
+- jonian@hardpixel.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- lib/active_similar.rb
+- lib/active_similar/association.rb
+- lib/active_similar/query.rb
+- lib/active_similar/version.rb
+homepage: https://github.com/hardpixel/active_similar
+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.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Find similar Active Record models through their associations
+test_files: []