wiser_trails 1.1.3

data/lib/wiser_trails/config.rb

@@ -0,0 +1,63 @@
+require 'singleton'
+
+module WiserTrails
+  # Class used to initialize configuration object.
+  class Config
+    include ::Singleton
+    attr_accessor :enabled
+
+    @@orm = :active_record
+
+    def initialize
+      # Indicates whether WiserTrails is enabled globally
+      @enabled  = true
+    end
+
+    # Evaluates given block to provide DSL configuration.
+    # @example Initializer for Rails
+    #   WiserTrails::Config.set do
+    #     orm :mongo_mapper
+    #     enabled false
+    #   end
+    def self.set &block
+      b = Block.new
+      b.instance_eval &block
+      orm = b.instance_variable_get(:@orm)
+      @@orm = orm unless orm.nil?
+      enabled = b.instance_variable_get(:@en)
+      instance
+      instance.instance_variable_set(:@enabled, enabled) unless enabled.nil?
+    end
+
+    # Set the ORM for use by WiserTrails.
+    def self.orm(orm = nil)
+      @@orm = (orm ? orm.to_sym : false) || @@orm
+    end
+
+    # alias for {#orm}
+    # @see #orm
+    def self.orm=(orm = nil)
+      orm(orm)
+    end
+
+    # instance version of {Config#orm}
+    # @see Config#orm
+    def orm(orm=nil)
+      self.class.orm(orm)
+    end
+
+    # Provides simple DSL for the config block.
+    class Block
+      # @see Config#orm
+      def orm(orm = nil)
+        @orm = (orm ? orm.to_sym : false) || @orm
+      end
+
+      # Decides whether to enable WiserTrails.
+      # @param en [Boolean] Enabled?
+      def enabled(en = nil)
+        @en = (en.nil? ? @en : en)
+      end
+    end
+  end
+end

data/lib/wiser_trails/models/activist.rb

@@ -0,0 +1,9 @@
+module WiserTrails
+  # Provides helper methods for selecting activities from a user.
+  module Activist
+    # Delegates to configured ORM.
+    def self.included(base)
+      base.extend WiserTrails::inherit_orm("Activist")
+    end
+  end
+end

data/lib/wiser_trails/models/activity.rb

@@ -0,0 +1,4 @@
+module WiserTrails
+  class Activity < inherit_orm("Activity")
+  end
+end

data/lib/wiser_trails/models/adapter.rb

@@ -0,0 +1,5 @@
+module WiserTrails
+  # Loads database-specific routines for use by WiserTrails.
+  class Adapter < inherit_orm("Adapter")
+  end
+end

data/lib/wiser_trails/models/trackable.rb

@@ -0,0 +1,9 @@
+module WiserTrails
+  # Provides association for activities bound to this object by *trackable*.
+  module Trackable
+    # Delegates to ORM.
+    def self.included(base)
+      base.extend WiserTrails::inherit_orm("Trackable")
+    end
+  end
+end

data/lib/wiser_trails/orm/active_record.rb

@@ -0,0 +1,5 @@
+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'

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

@@ -0,0 +1,48 @@
+module WiserTrails
+  module ORM
+    module ActiveRecord
+      # Module extending classes that serve as owners
+      module Activist
+        extend ActiveSupport::Concern
+
+        # Loads the {ClassMethods#activist} method for declaring the class
+        # as an activist.
+        def self.extended(base)
+          base.extend(ClassMethods)
+        end
+
+
+        # 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
+          #     include WiserTrails::Model
+          #     activist
+          #   end
+          #
+          # In controller:
+          #   User.first.activities
+          #
+          def activist
+            # Association of activities as their owner.
+            # @!method activities_as_owner
+            # @return [Array<Activity>] Activities which self is the owner of.
+            has_many :activities_as_owner, :class_name => "::WiserTrails::Activity", :as => :owner
+
+            # Association of activities as their recipient.
+            # @!method activities_as_recipient
+            # @return [Array<Activity>] Activities which self is the recipient of.
+            has_many :activities_as_account, :class_name => "::WiserTrails::Activity", :as => :account
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module WiserTrails
+  module ORM
+    module ActiveRecord
+      # The ActiveRecord model containing
+      # details about recorded activity.
+      class Activity < ::ActiveRecord::Base
+        self.table_name = "wiser_trails"
+        include Renderable
+
+        # Define polymorphic association to the parent
+        belongs_to :trackable, :polymorphic => true
+        # 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 :account, :polymorphic => true
+        # Serialize parameters Hash
+        serialize :new_value, Hash
+
+        if ::ActiveRecord::VERSION::MAJOR < 4
+          attr_accessible :key, :owner, :new_value, :account, :trackable
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+module WiserTrails
+  module ORM
+    # Support for ActiveRecord for WiserTrails. Used by default and supported
+    # officialy.
+    module ActiveRecord
+      # Provides ActiveRecord specific, database-related routines for use by
+      # WiserTrails.
+      class Adapter
+        # Creates the activity on `trackable` with `options`
+        def self.create_activity(trackable, options)
+          trackable.activities.create options
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+module WiserTrails
+  module ORM
+    module ActiveRecord
+      # Implements {WiserTrails::Trackable} for ActiveRecord
+      # @see WiserTrails::Trackable
+      module Trackable
+        # Creates an association for activities where self is the *trackable*
+        # object.
+        def self.extended(base)
+          base.has_many :activities, :class_name => "::WiserTrails::Activity", :as => :trackable
+        end
+      end
+    end
+  end
+end

data/lib/wiser_trails/renderable.rb

@@ -0,0 +1,118 @@
+module WiserTrails
+  # Provides logic for rendering activities. Handles both i18n strings
+  # support and smart partials rendering (different templates per activity key).
+  module Renderable
+    # Virtual attribute returning text description of the activity
+    # using the activity's key to translate using i18n.
+    def text(params = {})
+      # TODO: some helper for key transformation for two supported formats
+      k = key.split('.')
+      k.unshift('activity') if k.first != 'activity'
+      k = k.join('.')
+
+      I18n.t(k, parameters.merge(params) || {})
+    end
+
+    # Renders activity from views.
+    #
+    # @param [ActionView::Base] context
+    # @return [nil] nil
+    #
+    # Renders activity to the given ActionView context with included
+    # AV::Helpers::RenderingHelper (most commonly just ActionView::Base)
+    #
+    # The *preferred* *way* of rendering activities is
+    # to provide a template specifying how the rendering should be happening.
+    # However, one may choose using _I18n_ based approach when developing
+    # an application that supports plenty of languages.
+    #
+    # If partial view exists that matches the *key* attribute
+    # renders that partial with local variables set to contain both
+    # Activity and activity_parameters (hash with indifferent access)
+    #
+    # Otherwise, it outputs the I18n translation to the context
+    # @example Render a list of all activities from a view (erb)
+    #   <ul>
+    #     <% for activity in WiserTrails::Activity.all %>
+    #      <li><%= render_activity(activity) %></li>
+    #     <% end %>
+    #   </ul>
+    #
+    # = Layouts
+    # You can supply a layout that will be used for activity partials
+    # with :layout param.
+    # Keep in mind that layouts for partials are also partials.
+    # @example Supply a layout
+    #   # in views:
+    #   #   All examples look for a layout in app/views/layouts/_activity.erb
+    #    render_activity @activity, :layout => "activity"
+    #    render_activity @activity, :layout => "layouts/activity"
+    #    render_activity @activity, :layout => :activity
+    #
+    #   # app/views/layouts/_activity.erb
+    #   <p><%= a.created_at %></p>
+    #   <%= yield %>
+    #
+    # = Creating a template
+    # To use templates for formatting how the activity should render,
+    # create a template based on activity key, for example:
+    #
+    # Given a key _activity.article.create_, create directory tree
+    # _app/views/wiser_trails/article/_ and create the _create_ partial there
+    #
+    # Note that if a key consists of more than three parts splitted by commas, your
+    # directory structure will have to be deeper, for example:
+    #   activity.article.comments.destroy => app/views/wiser_trails/articles/comments/_destroy.html.erb
+    #
+    # == Variables in templates
+    # From within a template there are two variables at your disposal:
+    # * activity (aliased as *a* for a shortcut)
+    # * params   (aliased as *p*) [converted into a HashWithIndifferentAccess]
+    #
+    # @example Template for key: _activity.article.create_ (erb)
+    #   <p>
+    #     Article <strong><%= p[:name] %></strong>
+    #     was written by <em><%= p["author"] %></em>
+    #     <%= distance_of_time_in_words_to_now(a.created_at) %>
+    #   </p>
+    def render(context, params = {})
+      partial_path = nil
+      if params.has_key? :display
+        # if i18n has been requested, let it render and bail
+        return context.render :text => self.text(params) if params[:display].to_sym == :"i18n"
+        partial_path = 'wiser_trails/'+params[:display].to_s
+      end
+
+      controller = WiserTrails.get_controller
+      if layout = params.delete(:layout)
+        layout = layout.to_s
+        layout = layout[0,8] == "layouts/" ? layout : "layouts/#{layout}"
+      end
+
+      locals = params.delete(:locals) || Hash.new
+
+      params_indifferent = self.parameters.with_indifferent_access
+      params_indifferent.merge!(params)
+
+      context.render params.merge(:partial => (partial_path || self.template_path(self.key)),
+        :layout => layout,
+        :locals => locals.merge(:a => self, :activity => self,
+           :controller => controller,
+           :current_user => controller.respond_to?(:current_user) ?
+                controller.current_user : nil ,
+           :p => params_indifferent, :params => params_indifferent))
+    end
+
+    protected
+    # Builds the path to template based on activity key
+    # TODO: verify that attribute `key` is splitted by commas
+    #       and that the word before first comma is equal to
+    #       "activity"
+    def template_path(key)
+      path = key.split(".")
+      path.delete_at(0) if path[0] == "activity"
+      path.unshift "wiser_trails"
+      path.join("/")
+    end
+  end
+end

data/lib/wiser_trails/roles/deactivatable.rb

@@ -0,0 +1,42 @@
+module WiserTrails
+  # Enables per-class disabling of WiserTrails functionality.
+  module Deactivatable
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :wiser_trails_enabled_for_model
+      set_wiser_trails_class_defaults
+    end
+
+    # Returns true if WiserTrails is enabled
+    # globally and for this class.
+    # @return [Boolean]
+    # @api private
+    # @since 0.5.0
+    # overrides the method from Common
+    def wiser_trails_enabled?
+      WiserTrails.enabled? && self.class.wiser_trails_enabled_for_model
+    end
+
+    # Provides global methods to disable or enable WiserTrails on a per-class
+    # basis.
+    module ClassMethods
+      # Switches wiser_trails off for this class
+      def wiser_trails_off
+        self.wiser_trails_enabled_for_model = false
+      end
+
+      # Switches wiser_trails on for this class
+      def wiser_trails_on
+        self.wiser_trails_enabled_for_model = true
+      end
+
+      # @since 1.0.0
+      # @api private
+      def set_wiser_trails_class_defaults
+        super
+        self.wiser_trails_enabled_for_model = true
+      end
+    end
+  end
+end

data/lib/wiser_trails/roles/trail_it.rb

@@ -0,0 +1,180 @@
+module WiserTrails
+  # Main module extending classes we want to keep track of.
+  module TrailIt
+    extend ActiveSupport::Concern
+    # 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 {Common#activity_key}
+    # [:owner]
+    #   See {Common#activity_owner}
+    # [:params]
+    #   See {Common#activity_new_value}
+    # [:recipient]
+    #   Set the recipient for this activity. Useful for private notifications, which should only be visible to a certain user. See {Common#activity_account}.
+    # @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 = {})
+      rest = options.clone
+      self.activity_key = rest.delete(:key) if rest[:key]
+      self.activity_owner = rest.delete(:owner) if rest[:owner]
+      self.activity_new_value = rest.delete(:params) if rest[:params]
+      self.activity_account = rest.delete(:recipient) if rest[:recipient]
+      self.activity_custom_fields = rest if rest.count > 0
+      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 => proc {|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 => proc {|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 {Renderable#text} method.
+      #   == Example:
+      #    class Article < ActiveRecord::Base
+      #      include WiserTrails::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 {WiserTrails::Common#create_activity}
+      #   for a guide on how to manually record activities.
+      # [:only]
+      #   Accepts a symbol or an array of symbols, of which any combination of the three is accepted:
+      #   * _:create_
+      #   * _:update_
+      #   * _:destroy_
+      #   Selecting one or more of these will make WiserTrails 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,
+      #   see _:except_ option for a shorter version
+      # [:except]
+      #   Accepts a symbol or an 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,
+      #   but not on the _create_ action.
+      # [: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 opts [Hash] options
+      # @return [nil] options
+      def trail_it(opts = {})
+        options = opts.clone
+
+        all_options = [:create, :update, :destroy]
+
+        if !options.has_key?(:skip_defaults) && !options[:only] && !options[:except]
+          include Creation
+          include Destruction
+          include Update
+        end
+        options.delete(:skip_defaults)
+
+        if options[:except]
+          options[:only] = all_options - Array(options.delete(:except))
+        end
+
+        if options[:only]
+          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
+          options.delete(:only)
+        end
+
+        if options[:owner]
+          self.activity_owner_global = options.delete(:owner)
+        end
+        if options[:account]
+          self.activity_account_global = options.delete(:account)
+        end
+        if options.has_key?(:on) and options[:on].is_a? Hash
+          self.activity_hooks = options.delete(:on).select {|_, v| v.is_a? Proc}.symbolize_keys
+        end
+
+        options.each do |k, v|
+          self.activity_custom_fields_global[k] = v
+        end
+
+        nil
+      end
+    end
+  end
+end