wfl_simple_activity 0.1.25 → 0.1.26

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'mongoid'
+
+module PublicActivity
+  module ORM
+    module Mongoid
+      # The ActiveRecord model containing
+      # details about recorded activity.
+      class Activity
+        include ::Mongoid::Document
+        include ::Mongoid::Timestamps
+        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,  opts
+        # Define ownership to a resource responsible for this activity
+        belongs_to :owner,      opts
+        # Define ownership to a resource targeted by this activity
+        belongs_to :recipient,  opts
+
+        field :key,         type: String
+        field :parameters,  type: Hash
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PublicActivity
+  module ORM
+    module Mongoid
+      class Adapter
+        # Creates the activity on `trackable` with `options`
+        def self.create_activity(trackable, options)
+          trackable.activities.create options
+        end
+
+        # Creates activity on `trackable` with `options`; throws error on validation failure
+        def self.create_activity!(trackable, options)
+          trackable.activities.create! options
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module PublicActivity
+  module ORM
+    module Mongoid
+      module Trackable
+        def self.extended(base)
+          base.has_many :activities, :class_name => "::PublicActivity::Activity", :as => :trackable
+        end
+      end
+    end
+  end
+end

data/lib/public_activity/renderable.rb

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+module PublicActivity
+  # 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 PublicActivity::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 %>
+    #
+    # == Custom Layout Location
+    # You can customize the layout directory by supplying :layout_root
+    # or by using an absolute path.
+    #
+    # @example Declare custom layout location
+    #
+    #   # Both examples look for a layout in "app/views/custom/_layout.erb"
+    #
+    #    render_activity @activity, :layout_root => "custom"
+    #    render_activity @activity, :layout      => "/custom/layout"
+    #
+    # = 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/public_activity/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/public_activity/articles/comments/_destroy.html.erb
+    #
+    # == Custom Directory
+    # You can override the default `public_directory` template root with the :root parameter
+    #
+    # @example Custom template root
+    #    # look for templates inside of /app/views/custom instead of /app/views/public_directory
+    #    render_activity @activity, :root => "custom"
+    #
+    # == 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_root  = params.delete(:root)         || 'public_activity'
+      partial_path  = nil
+      layout_root   = params.delete(:layout_root)  || 'layouts'
+
+      if params.has_key? :display
+        if params[:display].to_sym == :"i18n"
+          text = self.text(params)
+          return context.render :text => text, :plain => text
+        else
+          partial_path = File.join(partial_root, params[:display].to_s)
+        end
+      end
+
+      context.render(
+        params.merge({
+          :partial => prepare_partial(partial_root, partial_path),
+          :layout  => prepare_layout(layout_root, params.delete(:layout)),
+          :locals  => prepare_locals(params)
+        })
+      )
+    end
+
+    def prepare_partial(root, path)
+      path || self.template_path(self.key, root)
+    end
+
+    def prepare_locals(params)
+      locals = params.delete(:locals) || Hash.new
+
+      controller  = PublicActivity.get_controller
+      prepared_params = prepare_parameters(params)
+      locals.merge(
+        {
+          :a              => self,
+          :activity       => self,
+          :controller     => controller,
+          :current_user   => controller.respond_to?(:current_user) ? controller.current_user : nil,
+          :p              => prepared_params,
+          :params         => prepared_params
+        }
+      )
+    end
+
+    def prepare_layout(root, layout)
+      if layout
+        path = layout.to_s
+        unless path.starts_with?(root) || path.starts_with?("/")
+          return File.join(root, path)
+        end
+      end
+      layout
+    end
+
+    def prepare_parameters(params)
+      @prepared_params ||= self.parameters.with_indifferent_access.merge(params)
+    end
+
+    protected
+
+    # Builds the path to template based on activity key
+    def template_path(key, partial_root)
+      path = key.split(".")
+      path.delete_at(0) if path[0] == "activity"
+      path.unshift partial_root
+      path.join("/")
+    end
+  end
+end

data/lib/public_activity/roles/deactivatable.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module PublicActivity
+  # Enables per-class disabling of PublicActivity functionality.
+  module Deactivatable
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :public_activity_enabled_for_model
+      set_public_activity_class_defaults
+    end
+
+    # Returns true if PublicActivity is enabled
+    # globally and for this class.
+    # @return [Boolean]
+    # @api private
+    # @since 0.5.0
+    # overrides the method from Common
+    def public_activity_enabled?
+      PublicActivity.enabled? && self.class.public_activity_enabled_for_model
+    end
+
+    # Provides global methods to disable or enable PublicActivity on a per-class
+    # basis.
+    module ClassMethods
+      # 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
+
+      # @since 1.0.0
+      # @api private
+      def set_public_activity_class_defaults
+        super
+        self.public_activity_enabled_for_model = true
+      end
+    end
+  end
+end

data/lib/public_activity/roles/tracked.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+module PublicActivity
+  # Main module extending classes we want to keep track of.
+  module Tracked
+    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_params}
+    # [:recipient]
+    #   Set the recipient for this activity. Useful for private notifications, which should only be visible to a certain user. See {Common#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 = {})
+      rest = options.clone
+      self.activity_key           = rest.delete(:key) if rest[:key]
+      self.activity_owner         = rest.delete(:owner) if rest[:owner]
+      self.activity_params        = rest.delete(:params) if rest[:params]
+      self.activity_recipient     = 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 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 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 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,
+      #   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 tracked(opts = {})
+        options = opts.clone
+
+        include_default_actions(options)
+
+        assign_globals       options
+        assign_hooks         options
+        assign_custom_fields options
+
+        nil
+      end
+
+      def include_default_actions(options)
+        defaults = {
+          create:  Creation,
+          destroy: Destruction,
+          update:  Update
+        }
+
+        if options[:skip_defaults] == true
+          return
+        end
+
+        modules = if options[:except]
+          defaults.except(*options[:except])
+        elsif options[:only]
+          defaults.slice(*options[:only])
+        else
+          defaults
+        end
+
+        modules.each do |key, value|
+          include value
+        end
+      end
+
+      def available_options
+        [:skip_defaults, :only, :except, :on, :owner, :recipient, :params].freeze
+      end
+
+      def assign_globals(options)
+        [:owner, :recipient, :params].each do |key|
+          if options[key]
+            self.send("activity_#{key}_global=".to_sym, options.delete(key))
+          end
+        end
+      end
+
+      def assign_hooks(options)
+        if options[:on].is_a?(Hash)
+          self.activity_hooks = options[:on].select {|_, v| v.is_a? Proc}.symbolize_keys
+        end
+      end
+
+      def assign_custom_fields(options)
+        options.except(*available_options).each do |k, v|
+          self.activity_custom_fields_global[k] = v
+        end
+      end
+    end
+  end
+end