acts_as_favable 1.0.0 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 76ef9fc7c2c83e7e473c9f9b4e0a64bf3ea7b4e97e2ed6766b6bce11bced0f92
+  data.tar.gz: e2958f234f376103ee033856ecf65c437fbf75d25e3a08f3796b8ca49b0f20b8
+SHA512:
+  metadata.gz: 24a9ca65d81b38fc244be954889d1a445158d73948abbf301faf1e999b591f03664708773018766ec753dde8882dbbc6465c89be99ff6003956c993c9205623a
+  data.tar.gz: 05a2db672c1ea50a38aa5f4f1a244116c81f2a11437c1dd3a8d842fe0b54ef97823d2f6a1e6a4792139d40de541786ae16d9383f1328a3302d71984a65948e55

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project are documented here.
+
+## Unreleased
+
+## 2.1.0 - 2026-09-21
+
+- Establish Rails 7.2 as the minimum supported Rails version; compatibility with it is intentional and covered by CI.
+- Define the generated `Favorite#user` association as optional by project policy, with a nullable `user_id` column.
+- Modernize Active Record integration with `ActiveSupport.on_load` and `ActiveSupport::Concern`.
+- Preserve the public `acts_as_favable` and `Favorite.find_*` APIs while using Rails' own polymorphic naming APIs for STI and namespaced models.
+- Make the generator emit the migration version for the Rails version that is actually running instead of hard-coding Rails 8.0.
+- Require a polymorphic favorite target in newly generated migrations.
+- Remove the generated `default_scope`; use `recent` and `in_order` explicitly.
+- Add real Active Record behavior tests and generator coverage.
+- Add GitHub Actions coverage for Rails 7.2, 8.0, and 8.1 across Ruby 3.1 through 4.0.
+- Modernize gem metadata, dependency bounds, packaging, and development documentation.
+- Remove obsolete Rails plugin entry points (`init.rb` and `install.rb`).
+- Upgrade CI checkout to `actions/checkout@v7`.
+- Keep Minitest 5 while Ruby 3.1 remains supported and document that compatibility constraint.
+
+## 2.0.0 - 2025-07-28
+
+- Added initial Rails 8 compatibility work.
+- Updated the gem to modern keyword arguments for `has_many` options.
+- Replaced deprecated Active Record APIs used by the original implementation.
+- Updated generated model and migration templates for then-current Rails conventions.

data/README.markdown

@@ -1,47 +1,171 @@
 Acts As Favable
 =================
 
-Allows for favorite refer to be added to multiple and different models.
+`acts_as_favable` is a small Active Record extension for adding polymorphic favorites to multiple models.
 
-## Resources
+The gem keeps its original API while modernizing the integration for current Rails applications: lazy Active Record loading, Rails-aware polymorphic type handling, a version-aware generator, automated tests, and a CI compatibility matrix.
 
-####Install(on Rails3)
+## Compatibility
 
- To install as a plugin
- 
-    rails plugin install http://github.com/yorzi/acts_as_favable.git
-   
- To install as a gem
+The minimum supported Rails version is **Rails 7.2**.
 
-    sudo gem install acts_as_favable
+The project is tested against:
 
- Generate your favorite model:
- 
-    rails generate favorite
- 
- Then migrate your database:
- 
-    rake db:migrate
+- Ruby 3.1 with Rails 7.2
+- Ruby 3.2 with Rails 8.0
+- Ruby 3.2, 3.3, 3.4, and 4.0 with Rails 8.1
+
+Rails 8.1 is the primary current target, while Rails 7.2 is an intentionally supported compatibility floor rather than a best-effort legacy lane. Changes to the gem should continue to preserve Rails 7.2 compatibility unless the minimum supported version is explicitly raised in a future release.
+
+Applications should still follow the upstream Rails maintenance policy when choosing a production Rails version.
+
+## Installation
+
+Add the gem to your application's `Gemfile`:
+
+```ruby
+gem "acts_as_favable"
+```
+
+Then install dependencies and generate the model and migration:
+
+```bash
+bundle install
+bin/rails generate favorite
+bin/rails db:migrate
+```
+
+The generator uses the migration version of the Rails version running your application. It does not hard-code a specific Rails migration version.
 
 ## Usage
-#### Make your ActiveRecord model act as favable.
 
-    class Model < ActiveRecord::Base
- 	   acts_as_favable
-    end
- 
-####mark a favorite flag to a model instance
- 
-    favable = Model.create
-    favable.favorites.create(:note => "I like this and will make it one of my favorites")
+Make any Active Record model favable:
+
+```ruby
+class Article < ApplicationRecord
+  acts_as_favable
+end
+```
+
+Create favorites through the association:
+
+```ruby
+article = Article.find(1)
+article.favorites.create!(note: "Read this again")
+```
+
+### Optional user association
+
+The generated `Favorite` model intentionally defines `user` as optional:
+
+```ruby
+class Favorite < ApplicationRecord
+  include ActsAsFavable::Favorite
+
+  belongs_to :favable, polymorphic: true
+  belongs_to :user, optional: true
+end
+```
+
+This is the default gem policy. A favorite can exist without a user:
+
+```ruby
+article.favorites.create!(note: "Read this again")
+```
+
+Applications that associate favorites with users can still pass one normally:
+
+```ruby
+article.favorites.create!(
+  note: "Read this again",
+  user: current_user
+)
+```
+
+If every favorite in a particular application must belong to a user, that application can tighten the generated model to `belongs_to :user` and make `user_id` non-null in its migration before running it. The gem itself will continue to generate an optional user association by default.
+
+## Querying favorites
+
+The generated `Favorite` model includes two explicit ordering scopes:
+
+```ruby
+article.favorites.recent
+article.favorites.in_order
+```
+
+The original finder API is also supported:
+
+```ruby
+Article.find_favorites_for(article)
+Article.find_favorites_by_user(user)
+
+Favorite.find_favorites_by_user(user)
+Favorite.find_favorites_for_favable(Article.polymorphic_name, article.id)
+Favorite.find_favable(favorite.favable_type, favorite.favable_id)
+```
+
+`acts_as_favable` uses Active Record's polymorphic naming APIs, so finder behavior follows Rails' STI and namespacing rules instead of reimplementing them.
+
+## Association options
+
+Options passed to `acts_as_favable` are forwarded to the generated `has_many :favorites` association. The default is `dependent: :destroy`.
+
+```ruby
+class AuditRecord < ApplicationRecord
+  acts_as_favable dependent: :delete_all
+end
+```
+
+## Generated files
+
+`bin/rails generate favorite` creates:
+
+```text
+app/models/favorite.rb
+db/migrate/<timestamp>_create_favorites.rb
+```
+
+The migration creates indexed `favable_type`, `favable_id`, and `user_id` columns. The polymorphic target is required; `user_id` is nullable by design.
+
+## Upgrading from older versions
+
+Older versions of this project originated as a Rails plugin. Modern Rails applications do not use the historical `init.rb` or `install.rb` plugin entry points.
+
+If you are upgrading an existing application, review your existing `favorites` table and model before running the generator. The generator is intended for new installations; it should not replace an existing migration or model without review.
+
+The generated model no longer adds a `default_scope`. Use `recent` or `in_order` explicitly where ordering matters. Existing application models are not changed automatically.
+
+## Development
+
+Install dependencies and run the test suite:
+
+```bash
+bundle install
+bundle exec rake test
+```
+
+Run against a specific supported Rails series:
+
+```bash
+RAILS_VERSION=7.2 bundle exec rake test
+RAILS_VERSION=8.0 bundle exec rake test
+RAILS_VERSION=8.1 bundle exec rake test
+```
+
+Rails 7.2 is the compatibility floor and must remain represented in CI while it is a supported gem target.
+
+Build the gem locally:
+
+```bash
+bundle exec rake build
+```
 
-####Fetch favorites for a favable model:
+See `CONTRIBUTING.md` for contribution guidelines and `CHANGELOG.md` for notable changes.
 
-    favable = Model.find(1)
-    favorites = favable.favorites.recent.limit(10).all
+## License
 
-Attention: This plugin/gem is heavily influenced by Acts As Taggable and almost copied from acts_at_commentable.
+MIT. See `MIT-LICENSE`.
 
-## More
+## Credits
 
-Blog post..
+The original implementation was influenced by the early Rails `acts_as_*` plugin ecosystem, including `acts_as_taggable` and `acts_as_commentable`-style projects.

data/lib/acts_as_favable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsFavable
+  VERSION = "2.1.0"
+end

data/lib/acts_as_favable.rb

@@ -1,2 +1,11 @@
-require 'favable_methods'
-require 'favorite_methods'
+require "active_record"
+require "active_support"
+require "active_support/lazy_load_hooks"
+
+require_relative "acts_as_favable/version"
+require_relative "favable_methods"
+require_relative "favorite_methods"
+
+ActiveSupport.on_load(:active_record) do
+  include Acts::Favable unless ancestors.include?(Acts::Favable)
+end

data/lib/favable_methods.rb

@@ -1,44 +1,37 @@
-require 'active_record'
+require "active_support/concern"
 
-module Acts #:nodoc:
-  module Favable #:nodoc:
+module Acts
+  module Favable
+    extend ActiveSupport::Concern
 
-    def self.included(base)
-      base.extend ClassMethods  
-    end
+    class_methods do
+      def acts_as_favable(options = {})
+        association_options = { as: :favable, dependent: :destroy }.merge(options)
+        has_many :favorites, **association_options
 
-    module ClassMethods
-      def acts_as_favable(options={})
-        has_many :favorites, {:as => :favable, :dependent => :destroy}.merge(options)
         include Acts::Favable::InstanceMethods
         extend Acts::Favable::SingletonMethods
       end
     end
-    
+
     module SingletonMethods
-      def find_favorites_for(obj)
-        favable = ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
-        Favorite.find_favorites_for_favable(favable, obj.id)
+      def find_favorites_for(record)
+        Favorite.find_favorites_for_favable(polymorphic_name, record.id)
       end
-      
-      def find_favorites_by_user(user) 
-        favable = ActiveRecord::Base.send(:class_name_of_active_record_descendant, self).to_s
-        Favorite.where(["user_id = ? and favable_type = ?", user.id, favable]).order("created_at DESC")
+
+      def find_favorites_by_user(user)
+        Favorite.where(user_id: user.id, favable_type: polymorphic_name).recent
       end
     end
-    
-    # This module contains instance methods
+
     module InstanceMethods
       def favorites_ordered_by_submitted
-        Favorite.find_favorites_for_favable(self.class.name, id)
+        Favorite.find_favorites_for_favable(self.class.polymorphic_name, id)
       end
 
       def add_favorite(favorite)
         favorites << favorite
       end
     end
-    
   end
 end
-
-ActiveRecord::Base.send(:include, Acts::Favable)

data/lib/favorite_methods.rb

@@ -1,24 +1,26 @@
+require "active_support/concern"
+
 module ActsAsFavable
   module Favorite
-    
-    def self.included(favorite_model)
-      favorite_model.extend Finders
-      favorite_model.scope :in_order, favorite_model.order('created_at ASC')
-      favorite_model.scope :recent, favorite_model.order('created_at DESC')
+    extend ActiveSupport::Concern
+
+    included do
+      scope :in_order, -> { order(created_at: :asc) }
+      scope :recent, -> { order(created_at: :desc) }
     end
-    
-    module Finders
+
+    class_methods do
       def find_favorites_by_user(user)
-        where(["user_id = ?", user.id]).order("created_at DESC")
+        where(user_id: user.id).recent
       end
 
-      def find_favorites_for_favable(favable_str, favable_id)
-        where(["favable_type = ? and favable_id = ?", favable_str, favable_id]).order("created_at DESC")
+      def find_favorites_for_favable(favable_type, favable_id)
+        where(favable_type: favable_type, favable_id: favable_id).recent
       end
 
-      def find_favable(favable_str, favable_id)
-        favable_str.constantize.find(favable_id)
+      def find_favable(favable_type, favable_id)
+        ActiveRecord::Base.polymorphic_class_for(favable_type).find(favable_id)
       end
     end
   end
-end
+end

data/lib/generators/favorite/USAGE

@@ -0,0 +1,9 @@
+Description:
+    Creates a Favorite model and a version-compatible favorites migration.
+
+Example:
+    bin/rails generate favorite
+
+Generated files:
+    app/models/favorite.rb
+    db/migrate/<timestamp>_create_favorites.rb

data/lib/generators/favorite/favorite_generator.rb

@@ -1,17 +1,21 @@
-require 'rails/generators/migration'
+require "active_record"
+require "rails/generators"
+require "rails/generators/migration"
 
 class FavoriteGenerator < Rails::Generators::Base
   include Rails::Generators::Migration
 
-  def self.source_root
-    @_acts_as_favable_source_root ||= File.expand_path("../templates", __FILE__)
-  end
+  source_root File.expand_path("templates", __dir__)
 
-  def self.next_migration_number(path)
-    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  def self.next_migration_number(dirname)
+    if ActiveRecord.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      format("%.3d", current_migration_number(dirname) + 1)
+    end
   end
 
-  def create_model_file
+  def create_favorite_files
     template "favorite.rb", "app/models/favorite.rb"
     migration_template "create_favorites.rb", "db/migrate/create_favorites.rb"
   end

data/lib/generators/favorite/templates/create_favorites.rb

@@ -1,18 +1,10 @@
-class CreateFavorites < ActiveRecord::Migration
-  def self.up
+class CreateFavorites < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def change
     create_table :favorites do |t|
-      t.string :note, :limit => 50, :default => "" 
-      t.references :favable, :polymorphic => true
-      t.references :user
+      t.string :note, limit: 50, default: ""
+      t.references :favable, polymorphic: true, null: false, index: true
+      t.references :user, null: true, index: true
       t.timestamps
     end
-
-    add_index :favorites, :favable_type
-    add_index :favorites, :favable_id
-    add_index :favorites, :user_id
   end
-
-  def self.down
-    drop_table :favorites
-  end
-end
+end

data/lib/generators/favorite/templates/favorite.rb

@@ -1,11 +1,6 @@
-class Favorite < ActiveRecord::Base
-
+class Favorite < ApplicationRecord
   include ActsAsFavable::Favorite
 
-  belongs_to :favable, :polymorphic => true
-
-  default_scope :order => 'created_at ASC'
-
-  # NOTE: Favorite belongs to a user
-  belongs_to :user
-end
+  belongs_to :favable, polymorphic: true
+  belongs_to :user, optional: true
+end

metadata

@@ -1,77 +1,109 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: acts_as_favable
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 2.1.0
 platform: ruby
-authors: 
+authors:
 - Andy Wang
-autorequire: acts_as_favable
 bindir: bin
 cert_chain: []
-
-date: 2010-11-29 00:00:00 +08:00
-default_executable: 
-dependencies: []
-
-description: Plugin/Gem that provides favorites functionality
-email: wangyaodi@gmail.com
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.2'
+- !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: A small Active Record extension that adds polymorphic favorite associations,
+  finders, and a Rails generator.
+email:
+- wangyaodi@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.markdown
-- MIT-LICENSE
-files: 
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
 - MIT-LICENSE
 - README.markdown
 - lib/acts_as_favable.rb
-- lib/favorite_methods.rb
+- lib/acts_as_favable/version.rb
 - lib/favable_methods.rb
+- lib/favorite_methods.rb
+- lib/generators/favorite/USAGE
 - lib/generators/favorite/favorite_generator.rb
-- lib/generators/favorite/templates/favorite.rb
 - lib/generators/favorite/templates/create_favorites.rb
-- init.rb
-- install.rb
-has_rdoc: true
+- lib/generators/favorite/templates/favorite.rb
 homepage: https://github.com/yorzi/acts_as_favable
-licenses: []
-
-post_install_message: 
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/yorzi/acts_as_favable
+  bug_tracker_uri: https://github.com/yorzi/acts_as_favable/issues
+  changelog_uri: https://github.com/yorzi/acts_as_favable/blob/main/CHANGELOG.md
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
-signing_key: 
-specification_version: 1
-summary: Plugin/gem that provides favorite functionality
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Add polymorphic favorites to Active Record models
 test_files: []
-

data/init.rb

@@ -1 +0,0 @@
-require File.join(File.dirname(__FILE__), 'rails', 'init')

data/install.rb

@@ -1,2 +0,0 @@
-puts "To create the favorite model please run:"
-puts "rails generate favorite"