public_activity 1.6.4 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed14383fee5beb59cc2e6963aec4b151edac0d910dba6ae076f158dce0791ba8
-  data.tar.gz: 2cb71a7c50553cddeb0500c882bf7709a780b3ca8cb60318da8d7e4b6be00e77
+  metadata.gz: f12beefe37e1f8d3c8fbaada9d0318de0838dd8514c1b32c93d47b97d7af6d57
+  data.tar.gz: bf5e00de61c14049488a4fe549a9bc198367eca931e9d73c0d47dd0ba9c173f3
 SHA512:
-  metadata.gz: 57aed9400b411ae43657dea3944be5aa062139356e4c5a686c97f84439369619ea6471e1685946d71c63a8765014250467646f2da37699e4f8b7723ec09e8b64
-  data.tar.gz: '098d249436ad7f6d16e1f7d3dfff28a8da55ee567e480a1030db9bdf0d3a68fe4d8ffcc011ad96fc332d5b98d001186b483ba41f3681cacb74a072a6a8e22ccb'
+  metadata.gz: a95d53aac261777b5b52a1a35add35acc0d93d742d4cbb3d2f4deea08ec552ade88b61cbd4447146172953b4ecda464b3ea2539ecb82d58d26c7756cdc5c52b7
+  data.tar.gz: 7dc0ddb8a3622c52b856f1b5a1f45124d300892559800cd62b06115bc14854d0ff84bf33b5a88a50f9f6ae7c060f298f171cb7d082f9bae3aa9696dfdcb36d5a

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.
 
+## Rails 7
 
-
-
-
-
- 
-## 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,12 +1,12 @@
 # frozen_string_literal: true
 
-require "bundler/gem_tasks"
+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|
@@ -14,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

@@ -9,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,23 +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

@@ -9,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,11 +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/public_activity/orm/active_record/activity.rb

@@ -25,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..6
-          with_options(:required => false) do
+        when 5
+          with_options(required: false) 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
+        when 6..7
+          with_options(optional: true) 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
         end
 
@@ -49,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/renderable.rb

@@ -12,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.
@@ -142,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/version.rb

@@ -2,5 +2,5 @@
 
 module PublicActivity
   # A constant with gem's version
-  VERSION = '1.6.4'
+  VERSION = '2.0.1'
 end

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

data/test/test_activist.rb

@@ -5,54 +5,55 @@ require 'test_helper'
 describe PublicActivity::Activist do
   it 'adds owner association' do
     klass = article
-    klass.must_respond_to :activist
+    assert_respond_to klass, :activist
     klass.activist
-    klass.new.must_respond_to :activities
-    case ENV["PA_ORM"]
-      when "active_record"
-        klass.reflect_on_association(:activities_as_owner).options[:as].must_equal :owner
-      when "mongoid"
-        klass.reflect_on_association(:activities_as_owner).options[:inverse_of].must_equal :owner
-      when "mongo_mapper"
-        klass.associations[:activities_as_owner].options[:as].must_equal :owner
+    assert_respond_to klass.new, :activities
+
+    case ENV['PA_ORM']
+    when 'active_record'
+      assert_equal klass.reflect_on_association(:activities_as_owner).options[:as], :owner
+    when 'mongoid'
+      assert_equal klass.reflect_on_association(:activities_as_owner).options[:inverse_of], :owner
+    when 'mongo_mapper'
+      assert_equal klass.associations[:activities_as_owner].options[:as], :owner
     end
 
-    if ENV["PA_ORM"] == "mongo_mapper"
-      klass.associations[:activities_as_owner].options[:class_name].must_equal "::PublicActivity::Activity"
+    if ENV['PA_ORM'] == 'mongo_mapper'
+      assert_equal klass.associations[:activities_as_owner].options[:class_name], '::PublicActivity::Activity'
     else
-      klass.reflect_on_association(:activities_as_owner).options[:class_name].must_equal "::PublicActivity::Activity"
+      assert_equal klass.reflect_on_association(:activities_as_owner).options[:class_name], '::PublicActivity::Activity'
     end
   end
 
   it 'returns activities from association' do
     case PublicActivity::Config.orm
-      when :active_record
-        class ActivistUser < ActiveRecord::Base
-          include PublicActivity::Model
-          self.table_name = 'users'
-          activist
-        end
-      when :mongoid
-        class ActivistUser
-          include Mongoid::Document
-          include PublicActivity::Model
-          activist
-
-          field :name, type: String
-        end
-      when :mongo_mapper
-        class ActivistUser
-          include MongoMapper::Document
-          include PublicActivity::Model
-          activist
-
-          key :name, String
-        end
+    when :active_record
+      class ActivistUser < ActiveRecord::Base
+        include PublicActivity::Model
+        self.table_name = 'users'
+        activist
+      end
+    when :mongoid
+      class ActivistUser
+        include Mongoid::Document
+        include PublicActivity::Model
+        activist
+
+        field :name, type: String
+      end
+    when :mongo_mapper
+      class ActivistUser
+        include MongoMapper::Document
+        include PublicActivity::Model
+        activist
+
+        key :name, String
+      end
     end
-    owner = ActivistUser.create(:name => "Peter Pan")
+    owner = ActivistUser.create(name: 'Peter Pan')
     a = article(owner: owner).new
     a.save
 
-    owner.activities_as_owner.length.must_equal 1
+    assert_equal owner.activities_as_owner.length, 1
   end
 end

data/test/test_activity.rb

@@ -4,86 +4,85 @@ require 'test_helper'
 
 describe 'PublicActivity::Activity Rendering' do
   describe '#text' do
-    subject { PublicActivity::Activity.new(:key => 'activity.test', :parameters => {:one => 1}) }
+    subject { PublicActivity::Activity.new(key: 'activity.test', parameters: { one: 1 }) }
 
     specify '#text uses translations' do
       subject.save
-      I18n.config.backend.store_translations(:en,
-        {:activity => {:test => '%{one} %{two}'}}
-      )
-      subject.text(:two => 2).must_equal('1 2')
-      subject.parameters.must_equal({:one => 1})
+      I18n.config.backend.store_translations(:en, activity: { test: '%{one} %{two}' })
+      assert_equal subject.text(two: 2), '1 2'
+      assert_equal subject.parameters, one: 1
     end
   end
 
   describe '#render' do
     subject do
-      s = PublicActivity::Activity.new(:key => 'activity.test', :parameters => {:one => 1})
-      s.save && s
+      s = PublicActivity::Activity.new(key: 'activity.test', parameters: { one: 1 })
+      s.save
+      s
     end
 
     let(:template_output) { "<strong>1, 2</strong>\n<em>activity.test, #{subject.id}</em>\n" }
-    before { @controller.view_paths << File.expand_path('../views', __FILE__) }
+    before { @controller.view_paths << File.expand_path('views', __dir__) }
 
     it 'uses view partials when available' do
       PublicActivity.set_controller(Struct.new(:current_user).new('fake'))
-      subject.render(self, :two => 2)
-      rendered.must_equal template_output + "fake\n"
+      subject.render(self, two: 2)
+      assert_equal rendered, "#{template_output}fake\n"
     end
 
     it 'uses requested partial'
 
     it 'uses view partials without controller' do
       PublicActivity.set_controller(nil)
-      subject.render(self, :two => 2)
-      rendered.must_equal template_output + "\n"
+      subject.render(self, two: 2)
+      assert_equal rendered, "#{template_output}\n"
     end
 
     it 'provides local variables' do
       PublicActivity.set_controller(nil)
-      subject.render(self, locals: {two: 2})
-      rendered.chomp.must_equal "2"
+      subject.render(self, locals: { two: 2 })
+      assert_equal rendered.chomp, '2'
     end
 
     it 'uses translations only when requested' do
-      I18n.config.backend.store_translations(:en,
-        {:activity => {:test => '%{one} %{two}'}}
-      )
+      I18n.config.backend.store_translations(:en, activity: { test: '%{one} %{two}' })
       @controller.view_paths.paths.clear
       subject.render(self, two: 2, display: :i18n)
-      rendered.must_equal '1 2'
+      assert_equal rendered, '1 2'
     end
 
-    it "pass all params to view context" do
+    it 'pass all params to view context' do
       view_context = mock('ViewContext')
       PublicActivity.set_controller(nil)
-      view_context.expects(:render).with() {|params| params[:formats] == ['json']}
-      subject.render(view_context, :formats => ['json'])
+      view_context.expects(:render).with { |params| params[:formats] == ['json'] }
+      subject.render(view_context, formats: ['json'])
     end
 
-    it "uses specified layout" do
+    it 'uses specified layout' do
       PublicActivity.set_controller(nil)
-      subject.render(self, :layout => "activity")
-      rendered.must_include "Here be the layouts"
+      subject.render(self, layout: 'activity')
+      assert_includes rendered, 'Here be the layouts'
 
-      subject.render(self, :layout => "layouts/activity")
-      rendered.must_include "Here be the layouts"
+      subject.render(self, layout: 'layouts/activity')
+      assert_includes rendered, 'Here be the layouts'
 
-      subject.render(self, :layout => :activity)
-      rendered.must_include "Here be the layouts"
+      subject.render(self, layout: :activity)
+      assert_includes rendered, 'Here be the layouts'
     end
 
-    it "accepts a custom layout root" do
-      subject.render(self, :layout => :layout, :layout_root => "custom")
-      rendered.must_include "Here be the custom layouts"
+    it 'accepts a custom layout root' do
+      subject.render(self, layout: :layout, layout_root: 'custom')
+      assert_includes rendered, 'Here be the custom layouts'
     end
-    it "accepts an absolute layout path" do
-      subject.render(self, :layout => '/custom/layout')
-      rendered.must_include "Here be the custom layouts"
+
+    it 'accepts an absolute layout path' do
+      subject.render(self, layout: '/custom/layout')
+      assert_includes rendered, 'Here be the custom layouts'
     end
-    it "accepts a template root" do
-      subject.render(self, :root => "custom")
-      rendered.must_include "Custom Template Root"
+
+    it 'accepts a template root' do
+      subject.render(self, root: 'custom')
+      assert_includes rendered, 'Custom Template Root'
     end
   end
 end