public_activity 0.5.4 → 1.0.0

data/lib/public_activity/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: public_activity
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,56 +10,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-25 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -76,103 +60,23 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.5.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.6.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.6.4
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0.9'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.12.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 0.12.1
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :development
+        version: '3.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 3.0.0
-description: Smooth activity tracking for your ActiveRecord models. Provides Activity
+        version: '3.0'
+description: Easy activity tracking for your ActiveRecord models. Provides Activity
   model with details about actions performed by your users, like adding comments,
   responding etc.
 email: piotrek@okonski.org
@@ -188,17 +92,27 @@ files:
 - lib/generators/public_activity/migration_upgrade/migration_upgrade_generator.rb
 - lib/generators/public_activity/migration_upgrade/templates/upgrade.rb
 - lib/public_activity.rb
-- lib/public_activity/activist.rb
-- lib/public_activity/activity.rb
+- lib/public_activity/actions/creation.rb
+- lib/public_activity/actions/destruction.rb
+- lib/public_activity/actions/update.rb
 - lib/public_activity/common.rb
 - lib/public_activity/config.rb
-- lib/public_activity/creation.rb
-- lib/public_activity/destruction.rb
-- lib/public_activity/store_controller.rb
-- lib/public_activity/tracked.rb
-- lib/public_activity/update.rb
+- lib/public_activity/orm/active_record.rb
+- lib/public_activity/orm/active_record/activist.rb
+- lib/public_activity/orm/active_record/activity.rb
+- lib/public_activity/orm/active_record/adapter.rb
+- lib/public_activity/orm/active_record/trackable.rb
+- lib/public_activity/orm/mongoid.rb
+- lib/public_activity/orm/mongoid/activist.rb
+- lib/public_activity/orm/mongoid/activity.rb
+- lib/public_activity/orm/mongoid/adapter.rb
+- lib/public_activity/orm/mongoid/trackable.rb
+- lib/public_activity/renderable.rb
+- lib/public_activity/roles/deactivatable.rb
+- lib/public_activity/roles/tracked.rb
+- lib/public_activity/utility/store_controller.rb
+- lib/public_activity/utility/view_helpers.rb
 - lib/public_activity/version.rb
-- lib/public_activity/view_helpers.rb
 - Gemfile
 - Rakefile
 - README.md
@@ -206,38 +120,10 @@ files:
 - UPGRADING
 homepage: https://github.com/pokonski/public_activity
 licenses: []
-post_install_message: ! '################################################
-
-  #          RUBY 1.8.7 IS NOW DEPRECATED        #
-
-  ################################################
-
-
-  The 0.5 version of public_activity will be the
-
-  last to support versions older than 1.9.2. Please
-
-  update your Ruby if you wish to continue using
-
-  this gem.
-
-
-  --------------------------------------------------
-
-  |  NOTE FOR UPGRADING FROM PRE-0.4.0 VERSION     |
-
-  --------------------------------------------------
-
-
-  public_activity 0.4.0 brings major changes compared to 0.3.X versions,
-
-  please read https://github.com/pokonski/public_activity#upgrading
-
-  to learn about all the changes you need to apply to properly
-
-  upgrade your applications.
-
-'
+post_install_message: ! "##################################################\n#  NOTE
+  FOR UPGRADING FROM PRE-0.4.0 VERSION     #\n##################################################\n\npublic_activity
+  0.4.0 brings major changes compared to 0.3.X versions,\nplease read https://github.com/pokonski/public_activity#upgrading
+  \nto learn about all the changes you need to apply to properly\nupgrade your applications.\n"
 rdoc_options: []
 require_paths:
 - lib
@@ -246,7 +132,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -258,6 +144,6 @@ rubyforge_project:
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: Smooth activity tracking for ActiveRecord models
+summary: Easy activity tracking for ActiveRecord models
 test_files: []
 has_rdoc: 

data/lib/public_activity/activist.rb

@@ -1,37 +0,0 @@
-module PublicActivity
-  # Module extending classes that serve as owners
-  module Activist
-    extend ActiveSupport::Concern
-
-    # Association of activities as their owner.
-    # @!method activities
-    # @return [Array<Activity>] Activities which self is the owner of.
-
-    # Association of activities as their recipient.
-    # @!method private_activities
-    # @return [Array<Activity>] Activities which self is the recipient of.
-
-    # Module extending classes that serve as owners
-    module ClassMethods
-      # Adds ActiveRecord associations to model to simplify fetching
-      # so you can list activities performed by the owner.
-      # It is completely optional. Any model can be an owner to an activity
-      # even without being an explicit activist.
-      #
-      # == Usage:
-      # In model:
-      #
-      #   class User < ActiveRecord::Base
-      #     activist
-      #   end
-      #
-      # In controller:
-      #   User.first.activities
-      #
-      def activist
-        has_many :activities_as_owner, :class_name => "PublicActivity::Activity", :as => :owner
-        has_many :activities_as_recipient, :class_name => "PublicActivity::Activity", :as => :recipient
-      end
-    end
-  end
-end

data/lib/public_activity/tracked.rb

@@ -1,337 +0,0 @@
-module PublicActivity
-  # Main module extending classes we want to keep track of.
-  module Tracked
-    extend ActiveSupport::Concern
-
-    included do
-      class_attribute :activity_owner_global, :activity_recipient_global,
-                      :activity_params_global, :activity_hooks, :public_activity_enabled_for_model
-      self.activity_owner_global             = nil
-      self.activity_recipient_global         = nil
-      self.activity_params_global            = {}
-      self.activity_hooks                    = {}
-      self.public_activity_enabled_for_model = true
-    end
-
-    # @!group Global options
-
-    # @!attribute activity_owner_global
-    #   Global version of activity owner
-    #   @see #activity_owner
-    #   @return [Model]
-
-    # @!attribute activity_recipient_global
-    #   Global version of activity recipient
-    #   @see #activity_recipient
-    #   @return [Model]
-
-    # @!attribute activity_params_global
-    #   Global version of activity parameters
-    #   @see #activity_params
-    #   @return [Hash<Symbol, Object>]
-
-    # @!attribute activity_hooks
-    #   @return [Hash<Symbol, Proc>]
-    #   Hooks/functions that will be used to decide *if* the activity should get
-    #   created.
-    #
-    #   The supported keys are:
-    #   * :create
-    #   * :update
-    #   * :destroy
-
-    # @!endgroup
-
-    # @!group Instance options
-
-    # Set or get parameters that will be passed to {Activity} when saving
-    #
-    # == Usage:
-    #
-    #   @article.activity_params = {:article_title => @article.title}
-    #   @article.save
-    #
-    # This way you can pass strings that should remain constant, even when model attributes
-    # change after creating this {Activity}.
-    # @return [Hash<Symbol, Object>]
-    attr_accessor :activity_params
-    @activity_params = {}
-    # Set or get owner object responsible for the {Activity}.
-    #
-    # == Usage:
-    #
-    #   # where current_user is an object of logged in user
-    #   @article.activity_owner = current_user
-    #   # OR: take @article.author association
-    #   @article.activity_owner = :author
-    #   # OR: provide a Proc with custom code
-    #   @article.activity_owner = proc {|controller, model| model.author }
-    #   @article.save
-    #   @article.activities.last.owner #=> Returns owner object
-    # @return [Model] Polymorphic model
-    # @see #activity_owner_global
-    attr_accessor :activity_owner
-    @activity_owner = nil
-
-    # Set or get recipient for activity.
-    #
-    # Association is polymorphic, thus allowing assignment of
-    # all types of models. This can be used for example in the case of sending
-    # private notifications for only a single user.
-    # @return (see #activity_owner)
-    attr_accessor :activity_recipient
-    @activity_recipient = nil
-    # Set or get custom i18n key passed to {Activity}, later used in {Activity#text}
-    #
-    # == Usage:
-    #
-    #   @article = Article.new
-    #   @article.activity_key = "my.custom.article.key"
-    #   @article.save
-    #   @article.activities.last.key #=> "my.custom.article.key"
-    #
-    # @return [String]
-    attr_accessor :activity_key
-    @activity_key = nil
-
-    # @!visibility private
-    @@activity_hooks = {}
-
-    # @!endgroup
-
-    # A shortcut method for setting custom key, owner and parameters of {Activity}
-    # in one line. Accepts a hash with 3 keys:
-    # :key, :owner, :params. You can specify all of them or just the ones you want to overwrite.
-    #
-    # == Options
-    #
-    # [:key]
-    #   See {#activity_key}
-    # [:owner]
-    #   See {#activity_owner}
-    # [:params]
-    #   See {#activity_params}
-    # [:recipient]
-    #   Set the recipient for this activity. Useful for private notifications, which should only be visible to a certain user. See {#activity_recipient}.
-    # @example
-    #
-    #   @article = Article.new
-    #   @article.title = "New article"
-    #   @article.activity :key => "my.custom.article.key", :owner => @article.author, :params => {:title => @article.title}
-    #   @article.save
-    #   @article.activities.last.key #=> "my.custom.article.key"
-    #   @article.activities.last.parameters #=> {:title => "New article"}
-    #
-    # @param options [Hash] instance options to set on the tracked model
-    # @return [nil]
-    def activity(options = {})
-      self.activity_key = options[:key] if options[:key]
-      self.activity_owner = options[:owner] if options[:owner]
-      self.activity_params = options[:params] if options[:params]
-      self.activity_recipient = options[:recipient] if options[:recipient]
-      nil
-    end
-
-    # Module with basic +tracked+ method that enables tracking models.
-    module ClassMethods
-      # Adds required callbacks for creating and updating
-      # tracked models and adds +activities+ relation for listing
-      # associated activities.
-      #
-      # == Parameters:
-      # [:owner]
-      #   Specify the owner of the {Activity} (person responsible for the action).
-      #   It can be a Proc, Symbol or an ActiveRecord object:
-      #   == Examples:
-      #
-      #    tracked :owner => :author
-      #    tracked :owner => {|o| o.author}
-      #
-      #   Keep in mind that owner relation is polymorphic, so you can't just
-      #   provide id number of the owner object.
-      # [:recipient]
-      #   Specify the recipient of the {Activity}
-      #   It can be a Proc, Symbol, or an ActiveRecord object
-      #   == Examples:
-      #
-      #    tracked :recipient => :author
-      #    tracked :recipient => {|o| o.author}
-      #
-      #   Keep in mind that recipient relation is polymorphic, so you can't just
-      #   provide id number of the owner object.
-      # [:params]
-      #   Accepts a Hash with custom parameters you want to pass to i18n.translate
-      #   method. It is later used in {Activity#text} method.
-      #   == Example:
-      #    class Article < ActiveRecord::Base
-      #      include PublicActivity::Model
-      #      tracked :params => {
-      #          :title => :title,
-      #          :author_name => "Michael",
-      #          :category_name => proc {|controller, model_instance| model_instance.category.name},
-      #          :summary => proc {|controller, model_instance| truncate(model.text, :length => 30)}
-      #      }
-      #    end
-      #
-      #   Values in the :params hash can either be an *exact* *value*, a *Proc/Lambda* executed before saving the activity or a *Symbol*
-      #   which is a an attribute or a method name executed on the tracked model's instance.
-      #
-      #   Everything specified here has a lower priority than parameters
-      #   specified directly in {#activity} method.
-      #   So treat it as a place where you provide 'default' values or where you
-      #   specify what data should be gathered for every activity.
-      #   For more dynamic settings refer to {Activity} model documentation.
-      # [:skip_defaults]
-      #   Disables recording of activities on create/update/destroy leaving that to programmer's choice. Check {PublicActivity::Common#create_activity}
-      #   for a guide on how to manually record activities.
-      # [:only]
-      #   Accepts array of symbols, of which correct is any combination of the three:
-      #   * _:create_
-      #   * _:update_
-      #   * _:destroy_
-      #   Selecting one or more of these will make PublicActivity create activities
-      #   automatically for the tracked model on selected actions.
-      #
-      #   Resulting activities will have have keys assigned to, respectively:
-      #   * _article.create_
-      #   * _article.update_
-      #   * _article.destroy_
-      #   Since only three options are valid in this array,
-      #   see _:except_ option for a shorter version
-      # [:except]
-      #   Accepts array of symbols with values like in _:only_, above.
-      #   Values provided will be subtracted from all default actions:
-      #   (create, update, destroy).
-      #
-      #   So, passing _create_ would track and automatically create
-      #   activities on _update_ and _destroy_ actions.
-      # [:on]
-      #   Accepts a Hash with key being the *action* on which to execute *value* (proc)
-      #   Currently supported only for CRUD actions which are enabled in _:only_
-      #   or _:except_ options on this method.
-      #
-      #   Key-value pairs in this option define callbacks that can decide
-      #   whether to create an activity or not. Procs have two attributes for
-      #   use: _model_ and _controller_. If the proc returns true, the activity
-      #   will be created, if not, then activity will not be saved.
-      #
-      #   == Example:
-      #     # app/models/article.rb
-      #     tracked :on => {:update => proc {|model, controller| model.published? }}
-      #
-      #   In the example above, given a model Article with boolean column _published_.
-      #   The activities with key _article.update_ will only be created
-      #   if the published status is set to true on that article.
-      # @param options [Hash] options
-      # @return [nil] options
-      def tracked(options = {})
-        include Common
-
-        all_options = [:create, :update, :destroy]
-
-        if !options.has_key?(:skip_defaults) && !options[:only] && !options[:except]
-          include Creation
-          include Destruction
-          include Update
-        end
-
-        if options[:except].is_a? Array
-          options[:only] = all_options - options[:except]
-        end
-
-        if options[:only].is_a? Array
-          options[:only].each do |opt|
-            if opt.eql?(:create)
-              include Creation
-            elsif opt.eql?(:destroy)
-              include Destruction
-            elsif opt.eql?(:update)
-              include Update
-            end
-          end
-        end
-
-        if options[:owner]
-          self.activity_owner_global = options[:owner]
-        end
-        if options[:recipient]
-          self.activity_recipient_global = options[:recipient]
-        end
-        if options[:params]
-          self.activity_params_global = options[:params]
-        end
-        if options.has_key?(:on) and options[:on].is_a? Hash
-          self.activity_hooks = options[:on].delete_if {|_, v| !v.is_a? Proc}.symbolize_keys if RUBY_VERSION == "1.8.7"
-          self.activity_hooks = options[:on].select {|_, v| v.is_a? Proc}.symbolize_keys if RUBY_VERSION != "1.8.7"
-        end
-        has_many :activities, :class_name => "PublicActivity::Activity", :as => :trackable
-
-        nil
-      end
-
-      # Extracts a hook from the _:on_ option provided in
-      # {Tracked::ClassMethods#tracked}. Returns nil when no hook exists for
-      # given action
-      # {Tracked#get_hook}
-      #
-      # @see Tracked#get_hook
-      # @param key [String, Symbol] action to retrieve a hook for
-      # @return [Proc, nil] callable hook or nil
-      # @since 0.4.0
-      # @api private
-      def get_hook(key)
-        key = key.to_sym
-        if self.activity_hooks.has_key?(key) and self.activity_hooks[key].is_a? Proc
-          self.activity_hooks[key]
-        else
-          nil
-        end
-      end
-
-      # Switches public_activity off for this class
-      def public_activity_off
-        self.public_activity_enabled_for_model = false
-      end
-
-      # Switches public_activity on for this class
-      def public_activity_on
-        self.public_activity_enabled_for_model = true
-      end
-    end
-
-    # Returns true if PublicActivity is enabled
-    # globally and for this class.
-    # @return [Boolean]
-    # @api private
-    # @since 0.5.0
-    def public_activity_enabled?
-      PublicActivity.enabled? && self.class.public_activity_enabled_for_model
-    end
-
-    # Shortcut for {Tracked::ClassMethods#get_hook}
-    # @param (see Tracked::ClassMethods#get_hook)
-    # @return (see Tracked::ClassMethods#get_hook)
-    # @since (see Tracked::ClassMethods#get_hook)
-    # @api (see Tracked::ClassMethods#get_hook)
-    def get_hook(key)
-      self.class.get_hook(key)
-    end
-
-    # Calls hook safely.
-    # If a hook for given action exists, calls it with model (self) and
-    # controller (if available, see {StoreController})
-    # @param key (see #get_hook)
-    # @return [Boolean] if hook exists, it's decision, if there's no hook, true
-    # @since 0.4.0
-    # @api private
-    def call_hook_safe(key)
-      hook = self.get_hook(key)
-      if hook
-        # provides hook with model and controller
-        hook.call(self, PublicActivity.get_controller)
-      else
-        true
-      end
-    end
-  end
-end