public_activity 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 111fe89197635000ddcdf89d3d534f9cb00c3443
-  data.tar.gz: ab11f3c49c42d58ba8af32a325874c83f5c634db
+SHA256:
+  metadata.gz: 7898488841ef521c0116e25424aa74919e5dddb714fab5462e3c9699fa42d410
+  data.tar.gz: e0ab8d01799d0ed377831bd7cb89a98015385d3594a316d2d9abf73f15653f47
 SHA512:
-  metadata.gz: 41d3b14a7bd58a3c321b52f6fb423b5f612e4f5a8c2881a03dbed893bd352ad0a596ad9e4f64d6cb49289d08fa8c780554dde54dc79b20962dd8e59ef10cad58
-  data.tar.gz: df0ba2f1a81173d47c9b750696e7e8eab2af04b0eb8483ceefb1c6c86ebd5e79f811672bba60c4caac8b436f60b2500d1346613c5a7c53c35a31467a17186750
+  metadata.gz: 7a6e3034bbeaa15528b77df4d514314acfbe21d527022800e2893f40b586a02ce4a73ef1c006ffcf19f9e3b7c8b7a99f3fcc4d124cdc753a52e109b9dbf1b9ca
+  data.tar.gz: 7cf64d2a8b18de233e963c3eab76658d0dd68f34080c64d43c33fd70dc2a4ec461402c4e9b79cd3560e38f2707ac8eb59046f3488a955977c24d1e23604ae639

data/README.md

@@ -1,13 +1,12 @@
-# PublicActivity [![Build Status](https://secure.travis-ci.org/pokonski/public_activity.png)](http://travis-ci.org/pokonski/public_activity) [![Dependency Status](https://gemnasium.com/pokonski/public_activity.png)](https://gemnasium.com/pokonski/public_activity) [![Code Climate](https://codeclimate.com/github/pokonski/public_activity.png)](https://codeclimate.com/github/pokonski/public_activity) [![Gem Version](https://badge.fury.io/rb/public_activity.png)](http://badge.fury.io/rb/public_activity)
+# PublicActivity [![Build Status](https://secure.travis-ci.org/chaps-io/public_activity.png)](http://travis-ci.org/pokonski/public_activity) [![Dependency Status](https://gemnasium.com/chaps-io/public_activity.png)](https://gemnasium.com/chaps-io/public_activity) [![Code Climate](https://codeclimate.com/github/chaps-io/public_activity.png)](https://codeclimate.com/github/chaps-io/public_activity) [![Gem Version](https://badge.fury.io/rb/public_activity.png)](http://badge.fury.io/rb/public_activity)
 
 `public_activity` provides easy activity tracking for your **ActiveRecord**, **Mongoid 3** and **MongoMapper** models
-in Rails 3. Simply put: it records what has been changed or created and gives you the ability to present those
+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.
 
-## Rails 4
-
-**As of 1.4.0 version, public_activity now supports both Rails 3.X and 4.0.**
+## Rails 5
 
+**As of 1.6.0 version, public_activity also supports Rails up to 5.0.**
 
 ## Table of contents
 
@@ -177,7 +176,7 @@ The activity will be wrapped with the `app/views/layouts/_activity.erb` layout,
 Sometimes, it's desirable to pass additional local variables to partials. It can be done this way:
 
 ```erb
-<%= render_activity(@activity, locals: {friends: current_user.friends} %>
+<%= render_activity(@activity, locals: {friends: current_user.friends}) %>
 ```
 
 *Note*: Before 1.4.0, one could pass variables directly to the options hash for `#render_activity` and access it from activity parameters. This functionality is retained in 1.4.0 and later, but the `:locals` method is **preferred**, since it prevents bugs from shadowing variables from activity parameters in the database.
@@ -210,11 +209,10 @@ This structure is valid for activities with keys `"activity.article.create"` or
 
 ## Testing
 
-For RSpec you can first disable `public_activity` and add the `test_helper` in
-the `spec_helper.rb` with
+For RSpec you can first disable `public_activity` and add the `test_helper` in `rails_helper.rb` with:
 
 ```ruby
-#spec_helper.rb
+#rails_helper.rb
 require 'public_activity/testing'
 
 PublicActivity.enabled = false

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

@@ -1,5 +1,7 @@
+require 'migrations_base.rb'
+
 # Migration responsible for creating a table with activities
-class CreateActivities < ActiveRecord::Migration
+class CreateActivities < MigrationsBase
   # Create table
   def self.up
     create_table :activities do |t|

data/lib/public_activity.rb

@@ -27,7 +27,7 @@ module PublicActivity
   # @param value [Boolean]
   # @since 0.5.0
   def self.enabled=(value)
-    PublicActivity.config.enabled = value
+    config.enabled(value)
   end
 
   # Returns `true` if PublicActivity is on, `false` otherwise.
@@ -35,7 +35,7 @@ module PublicActivity
   # @return [Boolean]
   # @since 0.5.0
   def self.enabled?
-    !!PublicActivity.config.enabled
+    config.enabled
   end
 
   # Returns PublicActivity's configuration object.

data/lib/public_activity/actions/update.rb

@@ -11,7 +11,8 @@ module PublicActivity
 
     # Creates activity upon modification of the tracked model
     def activity_on_update
-      create_activity(:update)
+      # Either use #changed? method for Rails < 5.1 or #saved_changes? for recent versions
+      create_activity(:update) if respond_to?(:saved_changes?) ? saved_changes? : changed?
     end
   end
 end

data/lib/public_activity/config.rb

@@ -4,15 +4,6 @@ module PublicActivity
   # Class used to initialize configuration object.
   class Config
     include ::Singleton
-    attr_accessor :enabled, :table_name
-
-    @@orm = :active_record
-
-    def initialize
-      # Indicates whether PublicActivity is enabled globally
-      @enabled    = true
-      @table_name = "activities"
-    end
 
     # Evaluates given block to provide DSL configuration.
     # @example Initializer for Rails
@@ -23,15 +14,11 @@ module PublicActivity
     #   end
     def self.set &block
       b = Block.new
-      b.instance_eval &block
-      @@orm = b.orm unless b.orm.nil?
+      b.instance_eval(&block)
       instance
-      instance.instance_variable_set(:@enabled,    b.enabled)     unless  b.enabled.nil?
-    end
-
-    # Set the ORM for use by PublicActivity.
-    def self.orm(orm = nil)
-      @@orm = (orm ? orm.to_sym : false) || @@orm
+      orm(b.orm) unless b.orm.nil?
+      enabled(b.enabled) unless b.enabled.nil?
+      table_name(b.table_name) unless b.table_name.nil?
     end
 
     # alias for {#orm}
@@ -40,15 +27,58 @@ module PublicActivity
       orm(orm)
     end
 
+    # alias for {#enabled}
+    # @see #enabled
+    def self.enabled=(en = nil)
+      enabled(en)
+    end
+
     # instance version of {Config#orm}
     # @see Config#orm
     def orm(orm=nil)
       self.class.orm(orm)
     end
 
+    # instance version of {Config#table_name}
+    # @see Config#orm
+    def table_name(name = nil)
+      self.class.table_name(name)
+    end
+
+    # instance version of {Config#enabled}
+    # @see Config#orm
+    def enabled(en = nil)
+      self.class.enabled(en)
+    end
+
+    # Set the ORM for use by PublicActivity.
+    def self.orm(orm = nil)
+      if orm.nil?
+        Thread.current[:public_activity_orm] || :active_record
+      else
+        Thread.current[:public_activity_orm] = orm.to_sym
+      end
+    end
+
+    def self.table_name(name = nil)
+      if name.nil?
+        Thread.current[:public_activity_table_name] || "activities"
+      else
+        Thread.current[:public_activity_table_name] = name
+      end
+    end
+
+    def self.enabled(en = nil)
+      if en.nil?
+        value = Thread.current[:public_activity_enabled]
+        value.nil? ? true : value
+      else
+        Thread.current[:public_activity_enabled] = en
+      end
+    end
+
     # Provides simple DSL for the config block.
     class Block
-      attr_reader :orm, :enabled, :table_name
       # @see Config#orm
       def orm(orm = nil)
         @orm = (orm ? orm.to_sym : false) || @orm
@@ -63,7 +93,7 @@ module PublicActivity
       # Sets the table_name
       # for the model
       def table_name(name = nil)
-        PublicActivity.config.table_name = name
+        @table_name = (name.nil? ? @table_name : name)
       end
     end
   end

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

@@ -6,17 +6,30 @@ module PublicActivity
       class Activity < ::ActiveRecord::Base
         include Renderable
         self.table_name = PublicActivity.config.table_name
+        self.abstract_class = true
 
         # Define polymorphic association to the parent
         belongs_to :trackable, :polymorphic => true
-        with_options(::ActiveRecord::VERSION::MAJOR >= 5 ? { :required => false } : { }) do
+
+        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
+            # 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
+
         # Serialize parameters Hash
-        serialize :parameters, Hash
+        if table_exists? && ![:json, :jsonb, :hstore].include?(columns_hash['parameters'].type)
+          serialize :parameters, Hash
+        end
 
         if ::ActiveRecord::VERSION::MAJOR < 4 || defined?(ProtectedAttributes)
           attr_accessible :key, :owner, :parameters, :recipient, :trackable

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

@@ -8,15 +8,21 @@ module PublicActivity
       class Activity
         include ::Mongoid::Document
         include ::Mongoid::Timestamps
-        include ::Mongoid::Attributes::Dynamic if (::Mongoid::VERSION =~ /^4/) == 0
+        include ::Mongoid::Attributes::Dynamic if ::Mongoid::VERSION.split('.')[0].to_i >= 4
         include Renderable
 
+        if ::Mongoid::VERSION.split('.')[0].to_i >= 7
+          opts = { polymorphic: true, optional: false }
+        else
+          opts = { polymorphic: true }
+        end
+
         # Define polymorphic association to the parent
-        belongs_to :trackable,  polymorphic: true
+        belongs_to :trackable,  opts
         # Define ownership to a resource responsible for this activity
-        belongs_to :owner,      polymorphic: true
+        belongs_to :owner,      opts
         # Define ownership to a resource targeted by this activity
-        belongs_to :recipient,  polymorphic: true
+        belongs_to :recipient,  opts
 
         field :key,         type: String
         field :parameters,  type: Hash

data/lib/public_activity/renderable.rb

@@ -100,7 +100,8 @@ module PublicActivity
 
       if params.has_key? :display
         if params[:display].to_sym == :"i18n"
-          return context.render :text => self.text(params)
+          text = self.text(params)
+          return context.render :text => text, :plain => text
         else
           partial_path = File.join(partial_root, params[:display].to_s)
         end

data/lib/public_activity/testing.rb

@@ -12,11 +12,11 @@ module PublicActivity
   #     # your test code here
   #   end
   def self.with_tracking
-    current = PublicActivity.enabled?
-    PublicActivity.enabled = true
+    current = PublicActivity.config.enabled
+    PublicActivity.config.enabled(true)
     yield
   ensure
-    PublicActivity.enabled = current
+    PublicActivity.config.enabled(current)
   end
 
   # Execute the code block with PublicActiviy deactive
@@ -27,9 +27,9 @@ module PublicActivity
   #   end
   def self.without_tracking
     current = PublicActivity.enabled?
-    PublicActivity.enabled = false
+    PublicActivity.config.enabled(false)
     yield
   ensure
-    PublicActivity.enabled = current
+    PublicActivity.config.enabled(current)
   end
 end

data/lib/public_activity/utility/view_helpers.rb

@@ -21,6 +21,8 @@ module PublicActivity
       content_for(name, content, &block)
     end
   end
+end
 
-  ActionView::Base.class_eval { include ViewHelpers }
+ActiveSupport.on_load(:action_view) do
+  include PublicActivity::ViewHelpers
 end

data/lib/public_activity/version.rb

@@ -1,4 +1,4 @@
 module PublicActivity
   # A constant with gem's version
-  VERSION = '1.5.0'
+  VERSION = '1.6.0'
 end

data/test/migrations/001_create_activities.rb

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

data/test/migrations/002_create_articles.rb

@@ -1,4 +1,6 @@
-class CreateArticles < ActiveRecord::Migration
+require 'migrations_base.rb'
+
+class CreateArticles < MigrationsBase
   def self.up
     puts "creating"
     create_table :articles do |t|
@@ -8,4 +10,4 @@ class CreateArticles < ActiveRecord::Migration
       t.timestamps
     end
   end
-end
+end

data/test/migrations/003_create_users.rb

@@ -1,8 +1,10 @@
-class CreateUsers < ActiveRecord::Migration
+require 'migrations_base.rb'
+
+class CreateUsers < MigrationsBase
   def self.up
     create_table :users do |t|
       t.string :name
       t.timestamps
     end
   end
-end
+end

data/test/migrations/004_add_nonstandard_to_activities.rb

@@ -1,4 +1,6 @@
-class AddNonstandardToActivities < ActiveRecord::Migration
+require 'migrations_base.rb'
+
+class AddNonstandardToActivities < MigrationsBase
   def change
     change_table :activities do |t|
       t.string :nonstandard

data/test/migrations_base.rb

@@ -0,0 +1,5 @@
+MigrationsBase = if ActiveRecord.version.release() < Gem::Version.new('5.2.0')
+  ActiveRecord::Migration
+else
+  ActiveRecord::Migration[5.2]
+end

data/test/mongoid.yml

@@ -1,6 +1,6 @@
 test:
-  sessions:
+  clients:
     default:
       hosts:
         - 127.0.0.1:27017
-      database: public_activity_test
+      database: public_activity_test

data/test/test_activist.rb

@@ -53,4 +53,4 @@ describe PublicActivity::Activist do
 
     owner.activities_as_owner.length.must_equal 1
   end
-end
+end

data/test/test_common.rb

@@ -48,6 +48,16 @@ describe PublicActivity::Common do
     subject.create_activity("some.key").wont_be_nil
   end
 
+  it 'update action should not create activity on save unless model changed' do
+    subject.save
+    before_count = subject.activities.count
+    subject.save
+    subject.save
+    after_count = subject.activities.count
+    before_count.must_equal after_count
+  end
+
+
   it 'allows passing owner through #create_activity' do
     article = article().new
     article.save
@@ -94,6 +104,13 @@ describe PublicActivity::Common do
     activity.owner.must_equal @owner
   end
 
+  it 'reports PublicActivity::Activity as the base class' do
+    if ENV["PA_ORM"] == "active_record" # Only relevant for ActiveRecord
+      subject.save
+      subject.activities.last.class.base_class.must_equal PublicActivity::Activity
+    end
+  end
+
   describe '#prepare_key' do
     describe 'for class#activity_key method' do
       before do
@@ -156,9 +173,9 @@ describe PublicActivity::Common do
       controller = mock('controller')
       controller.expects(:current_user).returns(:cu)
       PublicActivity.set_controller(controller)
-      p = proc {|controller, model|
-        assert_equal :cu, controller.current_user
-        assert_equal 5, model.accessor
+      p = proc {|c, m|
+        assert_equal :cu, c.current_user
+        assert_equal 5, m.accessor
       }
       PublicActivity.resolve_value(context, p)
       PublicActivity.resolve_value(context, :accessor)

data/test/test_controller_integration.rb

@@ -2,7 +2,7 @@ require 'test_helper'
 
 class StoringController < ActionView::TestCase::TestController
   include PublicActivity::StoreController
-  include ActionController::Testing::ClassMethods
+  include ActionController::Testing
 end
 
 describe PublicActivity::StoreController do
@@ -27,9 +27,9 @@ describe PublicActivity::StoreController do
     PublicActivity.set_controller(1)
     PublicActivity.get_controller.must_equal 1
 
-    a = Thread.new {
+    Thread.new {
       PublicActivity.set_controller(2)
-      PublicActivity.get_controller.must_equal 2
+      assert_equal 2, PublicActivity.get_controller
       PublicActivity.set_controller(nil)
     }
 

data/test/test_helper.rb

@@ -14,6 +14,7 @@ require 'public_activity'
 require 'public_activity/testing'
 require 'pry'
 require 'minitest/autorun'
+require 'mocha/minitest'
 
 PublicActivity::Config.orm = (ENV['PA_ORM'] || :active_record)
 
@@ -24,7 +25,15 @@ when :active_record
   require 'stringio'        # silence the output
   $stdout = StringIO.new    # from migrator
   ActiveRecord::Base.establish_connection(:adapter => 'sqlite3', :database => ':memory:')
-  ActiveRecord::Migrator.migrate(File.expand_path('../migrations', __FILE__))
+
+  migrations_path = File.expand_path('../migrations', __FILE__)
+
+  if ActiveRecord.version.release() < Gem::Version.new('5.2.0')
+    ActiveRecord::Migrator.migrate(migrations_path)
+  else
+    ActiveRecord::MigrationContext.new(migrations_path).migrate
+  end
+
   $stdout = STDOUT
 
   def article(options = {})
@@ -70,7 +79,11 @@ when :mongoid
     include Mongoid::Timestamps
     include PublicActivity::Model
 
-    belongs_to :user
+    if ::Mongoid::VERSION.split('.')[0].to_i >= 7
+      belongs_to :user, optional: true
+    else
+      belongs_to :user
+    end
 
     field :name, type: String
     field :published, type: Boolean

data/test/test_testing.rb

@@ -2,6 +2,10 @@ require 'test_helper'
 describe PublicActivity do
 
   describe "self.with_tracking" do
+    after do
+      PublicActivity.enabled = true
+    end
+    
     it "enables tracking inside the block" do
       PublicActivity.enabled = false
 
@@ -28,4 +32,4 @@ describe PublicActivity do
       end
     end
   end
-end
+end

data/test/test_tracking.rb

@@ -33,7 +33,11 @@ describe PublicActivity::Tracked do
           include Mongoid::Timestamps
           include PublicActivity::Model
 
-          belongs_to :user
+          if ::Mongoid::VERSION.split('.')[0].to_i >= 7
+            belongs_to :user, optional: true
+          else
+            belongs_to :user
+          end
 
           field :name, type: String
           field :published, type: Boolean
@@ -70,7 +74,7 @@ describe PublicActivity::Tracked do
     art = ActivistAndTrackedArticle.new
     art.save
     art.activities.last.trackable_id.must_equal art.id
-    art.activities.last.owner_id.must_equal nil
+    assert_nil art.activities.last.owner_id
   end
 
   describe 'custom fields' do
@@ -154,6 +158,7 @@ describe PublicActivity::Tracked do
       PublicActivity::Activity.count.must_equal activity_count_before
 
       klass.public_activity_on
+      @article.name = 'Changed Article'
       @article.save
       PublicActivity::Activity.count.must_be :>, activity_count_before
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: public_activity
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Piotrek Okoński
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-19 00:00:00.000000000 Z
+date: 2018-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +109,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.8
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -143,14 +157,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -221,6 +235,7 @@ files:
 - test/migrations/002_create_articles.rb
 - test/migrations/003_create_users.rb
 - test/migrations/004_add_nonstandard_to_activities.rb
+- test/migrations_base.rb
 - test/mongo_mapper.yml
 - test/mongoid.yml
 - test/test_activist.rb
@@ -237,7 +252,8 @@ files:
 - test/views/layouts/_activity.erb
 - test/views/public_activity/_test.erb
 homepage: https://github.com/pokonski/public_activity
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -255,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Easy activity tracking for ActiveRecord models
@@ -264,6 +280,7 @@ test_files:
 - test/migrations/002_create_articles.rb
 - test/migrations/003_create_users.rb
 - test/migrations/004_add_nonstandard_to_activities.rb
+- test/migrations_base.rb
 - test/mongo_mapper.yml
 - test/mongoid.yml
 - test/test_activist.rb

data/test/migrations/001_create_activities.rb

@@ -1,23 +0,0 @@
-# Migration responsible for creating a table with activities
-class CreateActivities < ActiveRecord::Migration
-  # Create table
-  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.timestamps
-    end
-
-    add_index :activities, [:trackable_id, :trackable_type]
-    add_index :activities, [:owner_id, :owner_type]
-    add_index :activities, [:recipient_id, :recipient_type]
-  end
-  # Drop table
-  def self.down
-    drop_table :activities
-  end
-end