public_activity 1.6.3 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59556848ec6a88c2e369638d453fcea77933ff8f208bf7ee24bce3ba7e348698
-  data.tar.gz: 01e57534e8c82d19d6894831f9d14ec9436b80a312f7098b3b32d319c7715efd
+  metadata.gz: f12beefe37e1f8d3c8fbaada9d0318de0838dd8514c1b32c93d47b97d7af6d57
+  data.tar.gz: bf5e00de61c14049488a4fe549a9bc198367eca931e9d73c0d47dd0ba9c173f3
 SHA512:
-  metadata.gz: af0c3aeb4a6f88f495555bc7a4f1dbc674f652486cee5392fe60a2ad3a4575d068c92364e6474db2f070e7eabe02a60da48563524e028ffe335bc8c4b194a21a
-  data.tar.gz: 63126e720464f8b66d982aa7558fe50aa1def24ed5f42142e320f0858f424aea4bcd88de6fb880a03b15ba39e77af0a432e9ed1a1dddd4ee2e79935fb2cb9b63
+  metadata.gz: a95d53aac261777b5b52a1a35add35acc0d93d742d4cbb3d2f4deea08ec552ade88b61cbd4447146172953b4ecda464b3ea2539ecb82d58d26c7756cdc5c52b7
+  data.tar.gz: 7dc0ddb8a3622c52b856f1b5a1f45124d300892559800cd62b06115bc14854d0ff84bf33b5a88a50f9f6ae7c060f298f171cb7d082f9bae3aa9696dfdcb36d5a

data/Gemfile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 gemspec

data/README.md

@@ -1,37 +1,35 @@
 # PublicActivity [![Build Status](https://secure.travis-ci.org/chaps-io/public_activity.svg)](http://travis-ci.org/chaps-io/public_activity) [![Code Climate](https://codeclimate.com/github/chaps-io/public_activity.svg)](https://codeclimate.com/github/chaps-io/public_activity) [![Gem Version](https://badge.fury.io/rb/public_activity.svg)](http://badge.fury.io/rb/public_activity)
 
 `public_activity` provides easy activity tracking for your **ActiveRecord**, **Mongoid 3** and **MongoMapper** models
-in Rails 3.0 - 5.0. Simply put: it records what has been changed or created and gives you the ability to present those
-recorded activities to users - in a similar way to how GitHub does it.
+in Rails 5.0+. Simply put: it records what has been changed or created and gives you the ability to present those
+recorded activities to users - similarly to how GitHub does it.
 
-## Sponsors
+## Rails 7
 
-<p align="center">
- <a style="max-width: 478x" href="https://getstream.io/try-the-api/?utm_source=public-activity&utm_medium=banner&utm_campaign=github"><img src="https://i.imgur.com/q4c8wVO.png"/>
-</p>
- 
-## Rails 5
-
-**As of 1.6.0 version, public_activity also supports Rails up to 5.2.**
+**As of version 2.0.0, public_activity also supports Rails up to 7.0.**
 
 ## Table of contents
 
-1. [Example](#example)
-  * [Demo](#online-demo)
-  * [Screencast](#screencast)
-  * **[Common examples](#common-examples)**
-2. [Setup](#setup)
-  1. [Gem installation](#gem-installation)
-  2. [Database setup](#database-setup)
-  3. [Model configuration](#model-configuration)
-  4. [Custom activities](#custom-activities)
-  5. [Displaying activities](#displaying-activities)
-    1. [Activity views](#activity-views)
-    2. [i18n](#i18n)
-3. [Testing](#testing)
-4. [Documentation](#documentation)
-5. **[Help](#help)**
-6. [Upgrading](https://github.com/pokonski/public_activity/wiki/Upgrading-from-pre-0.4.0-versions)
+- [Rails 7](#rails-7)
+- [Table of contents](#table-of-contents)
+- [Example](#example)
+  - [Online demo](#online-demo)
+- [Screencast](#screencast)
+- [Setup](#setup)
+  - [Gem installation](#gem-installation)
+  - [Database setup](#database-setup)
+  - [Model configuration](#model-configuration)
+    - [Custom activities](#custom-activities)
+  - [Displaying activities](#displaying-activities)
+    - [Layouts](#layouts)
+    - [Locals](#locals)
+    - [Activity views](#activity-views)
+    - [I18n](#I18n)
+- [Testing](#testing)
+- [Documentation](#documentation)
+- [Common examples](#common-examples)
+- [Help](#help)
+- [License](#license)
 
 ## Example
 
@@ -197,7 +195,7 @@ For example, if you have an activity with `:key` set to `"activity.user.changed_
 
 If a view file does not exist, then p_a falls back to the old behaviour and tries to translate the activity `:key` using `I18n#translate` method (see the section below).
 
-#### i18n
+#### I18n
 
 Translations are used by the `#text` method, to which you can pass additional options in form of a hash. `#render` method uses translations when view templates have not been provided. You can render pure i18n strings by passing `{display: :i18n}` to `#render_activity` or `#render`.
 
@@ -224,7 +222,7 @@ require 'public_activity/testing'
 PublicActivity.enabled = false
 ```
 
-In your specs you can then blockwise decide wether to turn `public_activity` on
+In your specs you can then blockwise decide whether to turn `public_activity` on
 or off.
 
 ```ruby

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
 require 'rake'
 require 'yard'
 require 'yard/rake/yardoc_task'
 require 'rake/testtask'
 
-task :default => :test
+task default: :test
 
 desc 'Generate documentation for the public_activity plugin.'
 YARD::Rake::YardocTask.new do |doc|
@@ -12,7 +14,6 @@ YARD::Rake::YardocTask.new do |doc|
 end
 
 Rake::TestTask.new do |t|
-	t.libs << "test"
-	t.test_files = FileList['test/test*.rb']
+  t.libs << 'test'
+  t.test_files = FileList['test/test*.rb']
 end
-

data/lib/generators/public_activity/migration/migration_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'generators/public_activity'
 require 'rails/generators/active_record'
 
@@ -7,7 +9,7 @@ module PublicActivity
     class MigrationGenerator < ActiveRecord::Generators::Base
       extend Base
 
-      argument :name, :type => :string, :default => 'create_activities'
+      argument :name, type: :string, default: 'create_activities'
       # Create migration in project's folder
       def generate_files
         migration_template 'migration.rb', "db/migrate/#{name}.rb"

data/lib/generators/public_activity/migration/templates/migration.rb

@@ -1,21 +1,23 @@
+# frozen_string_literal: true
+
 # Migration responsible for creating a table with activities
-class CreateActivities < (ActiveRecord.version.release() < Gem::Version.new('5.2.0') ? ActiveRecord::Migration : ActiveRecord::Migration[5.2])
-  # Create table
+class CreateActivities < ActiveRecord::Migration[5.0]
   def self.up
     create_table :activities do |t|
-      t.belongs_to :trackable, :polymorphic => true
-      t.belongs_to :owner, :polymorphic => true
-      t.string  :key
-      t.text    :parameters
-      t.belongs_to :recipient, :polymorphic => true
+      t.belongs_to :trackable, polymorphic: true
+      t.belongs_to :owner, polymorphic: true
+      t.string :key
+      t.text :parameters
+      t.belongs_to :recipient, polymorphic: true
 
       t.timestamps
     end
 
-    add_index :activities, [:trackable_id, :trackable_type]
-    add_index :activities, [:owner_id, :owner_type]
-    add_index :activities, [:recipient_id, :recipient_type]
+    add_index :activities, %i[trackable_id trackable_type]
+    add_index :activities, %i[owner_id owner_type]
+    add_index :activities, %i[recipient_id recipient_type]
   end
+
   # Drop table
   def self.down
     drop_table :activities

data/lib/generators/public_activity/migration_upgrade/migration_upgrade_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'generators/public_activity'
 require 'rails/generators/active_record'
 
@@ -7,7 +9,8 @@ module PublicActivity
     class MigrationUpgradeGenerator < ActiveRecord::Generators::Base
       extend Base
 
-      argument :name, :type => :string, :default => 'upgrade_activities'
+      argument :name, type: :string, default: 'upgrade_activities'
+
       # Create migration in project's folder
       def generate_files
         migration_template 'upgrade.rb', "db/migrate/#{name}.rb"

data/lib/generators/public_activity/migration_upgrade/templates/upgrade.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 # Migration responsible for creating a table with activities
-class UpgradeActivities < ActiveRecord::Migration
+class UpgradeActivities < ActiveRecord::Migration[5.0]
   # Create table
   def self.change
     change_table :activities do |t|
-      t.belongs_to :recipient, :polymorphic => true
+      t.belongs_to :recipient, polymorphic: true
     end
   end
 end

data/lib/generators/public_activity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators/named_base'
 
 module PublicActivity

data/lib/public_activity/actions/creation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   # Handles creation of Activities upon destruction and update of tracked model.
   module Creation
@@ -14,4 +16,4 @@ module PublicActivity
       create_activity(:create)
     end
   end
-end
+end

data/lib/public_activity/actions/destruction.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   # Handles creation of Activities upon destruction of tracked model.
   module Destruction

data/lib/public_activity/actions/update.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   # Handles creation of Activities upon destruction and update of tracked model.
   module Update

data/lib/public_activity/activity.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module PublicActivity
   # Main model, stores all information about what happened,
   # who caused it, when and anything else.
   class Activity < inherit_orm("Activity")
   end
-end
+end

data/lib/public_activity/common.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   # Happens when creating custom activities without either action or a key.
   class NoKeyProvided < Exception; end
@@ -257,6 +259,20 @@ module PublicActivity
       nil
     end
 
+    # Directly saves activity to database. Works the same as create_activity
+    # but throws validation error for each supported ORM.
+    #
+    # @see #create_activity
+    def create_activity!(*args)
+      return unless self.public_activity_enabled?
+      options = prepare_settings(*args)
+
+      if call_hook_safe(options[:key].split('.').last)
+        reset_activity_instance_options
+        return PublicActivity::Adapter.create_activity!(self, options)
+      end
+    end
+
     # Prepares settings used during creation of Activity record.
     # params passed directly to tracked model have priority over
     # settings specified in tracked() method

data/lib/public_activity/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'singleton'
 
 module PublicActivity

data/lib/public_activity/models/activist.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   # Provides helper methods for selecting activities from a user.
   module Activist
@@ -6,4 +8,4 @@ module PublicActivity
       base.extend PublicActivity::inherit_orm("Activist")
     end
   end
-end
+end

data/lib/public_activity/models/activity.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module PublicActivity
   class Activity < inherit_orm("Activity")
   end
-end
+end

data/lib/public_activity/models/adapter.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module PublicActivity
   # Loads database-specific routines for use by PublicActivity.
   class Adapter < inherit_orm("Adapter")
   end
-end
+end

data/lib/public_activity/models/trackable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   # Provides association for activities bound to this object by *trackable*.
   module Trackable
@@ -6,4 +8,4 @@ module PublicActivity
       base.extend PublicActivity::inherit_orm("Trackable")
     end
   end
-end
+end

data/lib/public_activity/orm/active_record/activist.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   module ORM
     module ActiveRecord

data/lib/public_activity/orm/active_record/activity.rb

@@ -1,4 +1,20 @@
+# frozen_string_literal: true
+
 module PublicActivity
+
+  if not defined? ::PG::ConnectionBad
+    module ::PG
+      class ConnectionBad < Exception; end
+    end
+  end
+  if not defined? Mysql2::Error::ConnectionError
+    module Mysql2
+      module Error
+        class ConnectionError < Exception; end
+      end
+    end
+  end
+  
   module ORM
     module ActiveRecord
       # The ActiveRecord model containing
@@ -9,20 +25,22 @@ module PublicActivity
         self.abstract_class = true
 
         # Define polymorphic association to the parent
-        belongs_to :trackable, :polymorphic => true
+        belongs_to :trackable, polymorphic: true
 
         case ::ActiveRecord::VERSION::MAJOR
-        when 3..4
-          # Define ownership to a resource responsible for this activity
-          belongs_to :owner, :polymorphic => true
-          # Define ownership to a resource targeted by this activity
-          belongs_to :recipient, :polymorphic => true
         when 5
-          with_options(:required => false) do
+          with_options(required: false) do
+            # Define ownership to a resource responsible for this activity
+            belongs_to :owner, polymorphic: true
+            # Define ownership to a resource targeted by this activity
+            belongs_to :recipient, polymorphic: true
+          end
+        when 6..7
+          with_options(optional: true) do
             # Define ownership to a resource responsible for this activity
-            belongs_to :owner, :polymorphic => true
+            belongs_to :owner, polymorphic: true
             # Define ownership to a resource targeted by this activity
-            belongs_to :recipient, :polymorphic => true
+            belongs_to :recipient, polymorphic: true
           end
         end
 
@@ -33,9 +51,9 @@ module PublicActivity
           else
             warn("[WARN] table #{name} doesn't exist. Skipping PublicActivity::Activity#parameters's serialization")
           end
-        rescue ::ActiveRecord::NoDatabaseError => e
+        rescue ::ActiveRecord::NoDatabaseError
           warn("[WARN] database doesn't exist. Skipping PublicActivity::Activity#parameters's serialization")
-        rescue ::PG::ConnectionBad => e
+        rescue ::PG::ConnectionBad
           warn("[WARN] couldn't connect to database. Skipping PublicActivity::Activity#parameters's serialization")
         rescue Mysql2::Error::ConnectionError
           warn("[WARN] couldn't connect to database. Skipping PublicActivity::Activity#parameters's serialization")

data/lib/public_activity/orm/active_record/adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   module ORM
     # Support for ActiveRecord for PublicActivity. Used by default and supported
@@ -10,6 +12,11 @@ module PublicActivity
         def self.create_activity(trackable, options)
           trackable.activities.create options
         end
+
+        # Creates activity on `trackable` with `options`; throws error on validation failure
+        def self.create_activity!(trackable, options)
+          trackable.activities.create! options
+        end
       end
     end
   end

data/lib/public_activity/orm/active_record/trackable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   module ORM
     module ActiveRecord

data/lib/public_activity/orm/active_record.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 require 'active_record'
 require_relative 'active_record/activity.rb'
 require_relative 'active_record/adapter.rb'
 require_relative 'active_record/activist.rb'
-require_relative 'active_record/trackable.rb'
+require_relative 'active_record/trackable.rb'

data/lib/public_activity/orm/mongo_mapper/activist.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   module ORM
     module MongoMapper

data/lib/public_activity/orm/mongo_mapper/activity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongo_mapper'
 require 'active_support/core_ext'
 

data/lib/public_activity/orm/mongo_mapper/adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   module ORM
     module MongoMapper
@@ -6,6 +8,11 @@ module PublicActivity
         def self.create_activity(trackable, options)
           trackable.activities.create options
         end
+
+        # Creates activity on `trackable` with `options`; throws error on validation failure
+        def self.create_activity!(trackable, options)
+          trackable.activities.create! options
+        end
       end
     end
   end

data/lib/public_activity/orm/mongo_mapper/trackable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   module ORM
     module MongoMapper

data/lib/public_activity/orm/mongo_mapper.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 require_relative "mongo_mapper/activity.rb"
 require_relative "mongo_mapper/adapter.rb"
 require_relative "mongo_mapper/activist.rb"
-require_relative "mongo_mapper/trackable.rb"
+require_relative "mongo_mapper/trackable.rb"

data/lib/public_activity/orm/mongoid/activist.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   module ORM
     module Mongoid

data/lib/public_activity/orm/mongoid/activity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'mongoid'
 
 module PublicActivity

data/lib/public_activity/orm/mongoid/adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   module ORM
     module Mongoid
@@ -6,6 +8,11 @@ module PublicActivity
         def self.create_activity(trackable, options)
           trackable.activities.create options
         end
+
+        # Creates activity on `trackable` with `options`; throws error on validation failure
+        def self.create_activity!(trackable, options)
+          trackable.activities.create! options
+        end
       end
     end
   end

data/lib/public_activity/orm/mongoid/trackable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   module ORM
     module Mongoid

data/lib/public_activity/orm/mongoid.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 require_relative "mongoid/activity.rb"
 require_relative "mongoid/adapter.rb"
 require_relative "mongoid/activist.rb"
-require_relative "mongoid/trackable.rb"
+require_relative "mongoid/trackable.rb"

data/lib/public_activity/renderable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   # Provides logic for rendering activities. Handles both i18n strings
   # support and smart partials rendering (different templates per activity key).
@@ -10,7 +12,8 @@ module PublicActivity
       k.unshift('activity') if k.first != 'activity'
       k = k.join('.')
 
-      I18n.t(k, parameters.merge(params) || {})
+      translate_params = parameters.merge(params) || {}
+      I18n.t(k, **translate_params)
     end
 
     # Renders activity from views.
@@ -140,7 +143,7 @@ module PublicActivity
     def prepare_layout(root, layout)
       if layout
         path = layout.to_s
-        unless path.starts_with?(root) || path.starts_with?("/")
+        unless path.start_with?(root) || path.start_with?("/")
           return File.join(root, path)
         end
       end

data/lib/public_activity/roles/deactivatable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   # Enables per-class disabling of PublicActivity functionality.
   module Deactivatable

data/lib/public_activity/roles/tracked.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   # Main module extending classes we want to keep track of.
   module Tracked

data/lib/public_activity/testing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file provides functionality for testing your code with public_activity
 # activated or deactivated.
 # This file should only be required in test/spec code!

data/lib/public_activity/utility/store_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PublicActivity
   class << self
     # Setter for remembering controller instance

data/lib/public_activity/utility/view_helpers.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Provides a shortcut from views to the rendering method.
 module PublicActivity
   # Module extending ActionView::Base and adding `render_activity` helper.

data/lib/public_activity/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module PublicActivity
   # A constant with gem's version
-  VERSION = '1.6.3'
+  VERSION = '2.0.1'
 end

data/lib/public_activity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'action_view'
 # +public_activity+ keeps track of changes made to models

data/test/migrations/001_create_activities.rb

@@ -1 +1 @@
-test/migrations/../../lib/generators/public_activity/migration/templates/migration.rb
+../../lib/generators/public_activity/migration/templates/migration.rb

data/test/migrations/002_create_articles.rb

@@ -1,8 +1,7 @@
-require 'migrations_base.rb'
+# frozen_string_literal: true
 
-class CreateArticles < MigrationsBase
+class CreateArticles < ActiveRecord::Migration[5.0]
   def self.up
-    puts "creating"
     create_table :articles do |t|
       t.string :name
       t.boolean :published

data/test/migrations/003_create_users.rb

@@ -1,6 +1,6 @@
-require 'migrations_base.rb'
+# frozen_string_literal: true
 
-class CreateUsers < MigrationsBase
+class CreateUsers < ActiveRecord::Migration[5.0]
   def self.up
     create_table :users do |t|
       t.string :name

data/test/migrations/004_add_nonstandard_to_activities.rb

@@ -1,6 +1,6 @@
-require 'migrations_base.rb'
+# frozen_string_literal: true
 
-class AddNonstandardToActivities < MigrationsBase
+class AddNonstandardToActivities < ActiveRecord::Migration[5.0]
   def change
     change_table :activities do |t|
       t.string :nonstandard