activity_hub 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 463e1aba9dc9f50fddf18b2686b57ddb1a3d85ae7580b2c3ee87fb2162b3f2fd
+  data.tar.gz: 8544f01f08091445b991813eb03f240ca68817f9b13ea8a9ef3288b3edeebf63
+SHA512:
+  metadata.gz: e2aec02d6f9a434d7b95573e1ff0598b6a539843002a09c5e5cb0f1c7b014efb8572f7ea8e400f2b06ecd2748917326b2a4682d1aef85d581f4c812687829fc0
+  data.tar.gz: 720a2da75369d503bc079a91aad9f8068d17612dd9ae54957fc771fcdddd1c2984708370fdf61a81ab8b17bbcf0bdb0bf2c1481e7870a1de98a87062778bd420

data/Gemfile

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

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011-2013 Piotrek Okoński
+
+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,260 @@
+# 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.
+
+## Rails 6
+
+**As of 1.6.4 version, public_activity also supports Rails up to 6.0.**
+
+## Table of contents
+
+- [PublicActivity ![Build Status](http://travis-ci.org/chaps-io/public_activity) ![Code Climate](https://codeclimate.com/github/chaps-io/public_activity) ![Gem Version](http://badge.fury.io/rb/public_activity)](#publicactivity-build-statushttptravis-ciorgchaps-iopublicactivity-code-climatehttpscodeclimatecomgithubchaps-iopublicactivity-gem-versionhttpbadgefuryiorbpublicactivity)
+  - [Rails 6](#rails-6)
+  - [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
+
+Here is a simple example showing what this gem is about:
+
+![Example usage](http://i.imgur.com/q0TVx.png)
+
+### Online demo
+
+You can see an actual application using this gem here: http://public-activity-example.herokuapp.com/feed
+
+The source code of the demo is hosted here: https://github.com/pokonski/activity_blog
+
+## Screencast
+
+Ryan Bates made a [great screencast](http://railscasts.com/episodes/406-public-activity) describing how to integrate Public Activity in your Rails Application.
+
+## Setup
+
+### Gem installation
+
+You can install `public_activity` as you would any other gem:
+
+    gem install public_activity
+
+or in your Gemfile:
+
+```ruby
+gem 'public_activity'
+```
+
+### Database setup
+
+By default _public_activity_ uses Active Record. If you want to use Mongoid or MongoMapper as your backend, create
+an initializer file in your Rails application with the corresponding code inside:
+
+For _Mongoid:_
+
+```ruby
+# config/initializers/public_activity.rb
+PublicActivity::Config.set do
+  orm :mongoid
+end
+```
+
+For _MongoMapper:_
+
+```ruby
+# config/initializers/public_activity.rb
+PublicActivity::Config.set do
+  orm :mongo_mapper
+end
+```
+
+**(ActiveRecord only)** Create migration for activities and migrate the database (in your Rails project):
+
+    rails g public_activity:migration
+    rake db:migrate
+
+### Model configuration
+
+Include `PublicActivity::Model` and add `tracked` to the model you want to keep track of:
+
+For _ActiveRecord:_
+
+```ruby
+class Article < ActiveRecord::Base
+  include PublicActivity::Model
+  tracked
+end
+```
+
+For _Mongoid:_
+
+```ruby
+class Article
+  include Mongoid::Document
+  include PublicActivity::Model
+  tracked
+end
+```
+
+For _MongoMapper:_
+
+```ruby
+class Article
+  include MongoMapper::Document
+  include PublicActivity::Model
+  tracked
+end
+```
+
+And now, by default create/update/destroy activities are recorded in activities table.
+This is all you need to start recording activities for basic CRUD actions.
+
+_Optional_: If you don't need `#tracked` but still want the comfort of `#create_activity`,
+you can include only the lightweight `Common` module instead of `Model`.
+
+#### Custom activities
+
+You can trigger custom activities by setting all your required parameters and triggering `create_activity`
+on the tracked model, like this:
+
+```ruby
+@article.create_activity key: 'article.commented_on', owner: current_user
+```
+
+See this entry http://rubydoc.info/gems/public_activity/PublicActivity/Common:create_activity for more details.
+
+### Displaying activities
+
+To display them you simply query the `PublicActivity::Activity` model:
+
+```ruby
+# notifications_controller.rb
+def index
+  @activities = PublicActivity::Activity.all
+end
+```
+
+And in your views:
+
+```erb
+<%= render_activities(@activities) %>
+```
+
+*Note*: `render_activity` is a helper for use in view templates. `render_activity(activity)` can be written as `activity.render(self)` and it will have the same meaning.
+
+*Note*: `render_activities` is an alias for `render_activity` and does the same.
+
+#### Layouts
+
+You can also pass options to both `activity#render` and `#render_activity` methods, which are passed deeper
+to the internally used `render_partial` method.
+A useful example would be to render activities wrapped in layout, which shares common elements of an activity,
+like a timestamp, owner's avatar etc:
+
+```erb
+<%= render_activities(@activities, layout: :activity) %>
+```
+
+The activity will be wrapped with the `app/views/layouts/_activity.erb` layout, in the above example.
+
+**Important**: please note that layouts for activities are also partials. Hence the `_` prefix.
+
+#### Locals
+
+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}) %>
+```
+
+*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.
+
+#### Activity views
+
+`public_activity` looks for views in `app/views/public_activity`.
+
+For example, if you have an activity with `:key` set to `"activity.user.changed_avatar"`, the gem will look for a partial in `app/views/public_activity/user/_changed_avatar.(erb|haml|slim|something_else)`.
+
+*Hint*: the `"activity."` prefix in `:key` is completely optional and kept for backwards compatibility, you can skip it in new projects.
+
+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
+
+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`.
+
+Translations should be put in your locale `.yml` files. To render pure strings from I18n Example structure:
+
+```yaml
+activity:
+  article:
+    create: 'Article has been created'
+    update: 'Someone has edited the article'
+    destroy: 'Some user removed an article!'
+```
+
+This structure is valid for activities with keys `"activity.article.create"` or `"article.create"`. As mentioned before, `"activity."` part of the key is optional.
+
+## Testing
+
+For RSpec you can first disable `public_activity` and add the `test_helper` in `rails_helper.rb` with:
+
+```ruby
+#rails_helper.rb
+require 'public_activity/testing'
+
+PublicActivity.enabled = false
+```
+
+In your specs you can then blockwise decide wether to turn `public_activity` on
+or off.
+
+```ruby
+# file_spec.rb
+PublicActivity.with_tracking do
+  # your test code goes here
+end
+
+PublicActivity.without_tracking do
+  # your test code goes here
+end
+```
+
+## Documentation
+
+For more documentation go [here](http://rubydoc.info/gems/public_activity/index)
+
+## Common examples
+
+* [[How to] Set the Activity's owner to current_user by default](https://github.com/pokonski/public_activity/wiki/%5BHow-to%5D-Set-the-Activity's-owner-to-current_user-by-default)
+* [[How to] Disable tracking for a class or globally](https://github.com/pokonski/public_activity/wiki/%5BHow-to%5D-Disable-tracking-for-a-class-or-globally)
+* [[How to] Create custom activities](https://github.com/pokonski/public_activity/wiki/%5BHow-to%5D-Create-custom-activities)
+* [[How to] Use custom fields on Activity](https://github.com/pokonski/public_activity/wiki/%5BHow-to%5D-Use-custom-fields-on-Activity)
+
+## Help
+
+If you need help with using public_activity please visit our discussion group and ask a question there:
+
+https://groups.google.com/forum/?fromgroups#!forum/public-activity
+
+Please do not ask general questions in the Github Issues.
+
+## License
+Copyright (c) 2011-2013 Piotrek Okoński, released under the MIT license

data/Rakefile

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

data/lib/generators/public_activity.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rails/generators/named_base'
+
+module PublicActivity
+  # A generator module with Activity table schema.
+  module Generators
+    # A base module
+    module Base
+      # Get path for migration template
+      def source_root
+        @_public_activity_source_root ||= File.expand_path(File.join('../public_activity', generator_name, 'templates'), __FILE__)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'generators/public_activity'
+require 'rails/generators/active_record'
+
+module PublicActivity
+  module Generators
+    # Migration generator that creates migration file from template
+    class MigrationGenerator < ActiveRecord::Generators::Base
+      extend Base
+
+      argument :name, :type => :string, :default => 'create_activities'
+      # Create migration in project's folder
+      def generate_files
+        migration_template 'migration.rb', "db/migrate/#{name}.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'generators/public_activity'
+require 'rails/generators/active_record'
+
+module PublicActivity
+  module Generators
+    # Migration generator that creates migration file from template
+    class MigrationUpgradeGenerator < ActiveRecord::Generators::Base
+      extend Base
+
+      argument :name, :type => :string, :default => 'upgrade_activities'
+      # Create migration in project's folder
+      def generate_files
+        migration_template 'upgrade.rb', "db/migrate/#{name}.rb"
+      end
+    end
+  end
+end

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

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

data/lib/public_activity.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'action_view'
+# +public_activity+ keeps track of changes made to models
+# and allows you to display them to the users.
+#
+# Check {PublicActivity::Tracked::ClassMethods#tracked} for more details about customizing and specifying
+# ownership to users.
+module PublicActivity
+  extend ActiveSupport::Concern
+  extend ActiveSupport::Autoload
+
+  autoload :Activity,     'public_activity/models/activity'
+  autoload :Activist,     'public_activity/models/activist'
+  autoload :Adapter,      'public_activity/models/adapter'
+  autoload :Trackable,    'public_activity/models/trackable'
+  autoload :Common
+  autoload :Config
+  autoload :Creation,     'public_activity/actions/creation.rb'
+  autoload :Deactivatable,'public_activity/roles/deactivatable.rb'
+  autoload :Destruction,  'public_activity/actions/destruction.rb'
+  autoload :Renderable
+  autoload :Tracked,      'public_activity/roles/tracked.rb'
+  autoload :Update,       'public_activity/actions/update.rb'
+  autoload :VERSION
+
+  # Switches PublicActivity on or off.
+  # @param value [Boolean]
+  # @since 0.5.0
+  def self.enabled=(value)
+    config.enabled(value)
+  end
+
+  # Returns `true` if PublicActivity is on, `false` otherwise.
+  # Enabled by default.
+  # @return [Boolean]
+  # @since 0.5.0
+  def self.enabled?
+    config.enabled
+  end
+
+  # Returns PublicActivity's configuration object.
+  # @since 0.5.0
+  def self.config
+    @@config ||= PublicActivity::Config.instance
+  end
+
+  # Method used to choose which ORM to load
+  # when PublicActivity::Activity class is being autoloaded
+  def self.inherit_orm(model="Activity")
+    orm = PublicActivity.config.orm
+    require "public_activity/orm/#{orm.to_s}"
+    "PublicActivity::ORM::#{orm.to_s.classify}::#{model}".constantize
+  end
+
+  # Module to be included in ActiveRecord models. Adds required functionality.
+  module Model
+    extend ActiveSupport::Concern
+    included do
+      include Common
+      include Deactivatable
+      include Tracked
+      include Activist  # optional associations by recipient|owner
+    end
+  end
+end
+
+require 'public_activity/utility/store_controller'
+require 'public_activity/utility/view_helpers'