wfl_simple_activity 0.1.25 → 0.1.26

data/lib/public_activity/config.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'singleton'
+
+module PublicActivity
+  # Class used to initialize configuration object.
+  class Config
+    include ::Singleton
+
+    # Evaluates given block to provide DSL configuration.
+    # @example Initializer for Rails
+    #   PublicActivity::Config.set do
+    #     orm :mongo_mapper
+    #     enabled false
+    #     table_name "activities"
+    #   end
+    def self.set &block
+      b = Block.new
+      b.instance_eval(&block)
+      instance
+      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}
+    # @see #orm
+    def self.orm=(orm = nil)
+      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
+      # @see Config#orm
+      def orm(orm = nil)
+        @orm = (orm ? orm.to_sym : false) || @orm
+      end
+
+      # Decides whether to enable PublicActivity.
+      # @param en [Boolean] Enabled?
+      def enabled(en = nil)
+        @enabled = (en.nil? ? @enabled : en)
+      end
+
+      # Sets the table_name
+      # for the model
+      def table_name(name = nil)
+        @table_name = (name.nil? ? @table_name : name)
+      end
+    end
+  end
+end

data/lib/public_activity/models/activist.rb

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

data/lib/public_activity/models/activity.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module PublicActivity
+  class Activity < inherit_orm("Activity")
+  end
+end

data/lib/public_activity/models/adapter.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PublicActivity
+  # Loads database-specific routines for use by PublicActivity.
+  class Adapter < inherit_orm("Adapter")
+  end
+end

data/lib/public_activity/models/trackable.rb

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

data/lib/public_activity/orm/active_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+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/public_activity/orm/active_record/activist.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module PublicActivity
+  module ORM
+    module ActiveRecord
+      # Module extending classes that serve as owners
+      module Activist
+        # 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 PublicActivity::Model
+        #     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
+end

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module PublicActivity
+
+  if not defined? ::PG::ConnectionBad
+    module ::PG
+      class ConnectionBad < Exception; end
+    end
+  end
+  if not defined? Mysql2::Error::ConnectionError
+    module Mysql2
+      module Error
+        class ConnectionError < Exception; end
+      end
+    end
+  end
+  
+  module ORM
+    module ActiveRecord
+      # The ActiveRecord model containing
+      # details about recorded activity.
+      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, optional: true
+
+        case ::ActiveRecord::VERSION::MAJOR
+        when 3..4
+          # Define ownership to a resource responsible for this activity
+          belongs_to :owner, :polymorphic => true, optional: true
+          # Define ownership to a resource targeted by this activity
+          belongs_to :recipient, :polymorphic => true, optional: true
+        when 5..6
+          with_options(:required => false) do
+            # Define ownership to a resource responsible for this activity
+            belongs_to :owner, :polymorphic => true, optional: true
+            # Define ownership to a resource targeted by this activity
+            belongs_to :recipient, :polymorphic => true, optional: true
+          end
+        end
+
+        # Serialize parameters Hash
+        begin
+          if table_exists?
+            serialize :parameters, Hash unless [:json, :jsonb, :hstore].include?(columns_hash['parameters'].type)
+          else
+            warn("[WARN] table #{name} doesn't exist. Skipping PublicActivity::Activity#parameters's serialization")
+          end
+        rescue ::ActiveRecord::NoDatabaseError => e
+          warn("[WARN] database doesn't exist. Skipping PublicActivity::Activity#parameters's serialization")
+        rescue ::PG::ConnectionBad => e
+          warn("[WARN] couldn't connect to database. Skipping PublicActivity::Activity#parameters's serialization")
+        rescue Mysql2::Error::ConnectionError
+          warn("[WARN] couldn't connect to database. Skipping PublicActivity::Activity#parameters's serialization")
+        end
+
+        if ::ActiveRecord::VERSION::MAJOR < 4 || defined?(ProtectedAttributes)
+          attr_accessible :key, :owner, :parameters, :recipient, :trackable
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module PublicActivity
+  module ORM
+    # Support for ActiveRecord for PublicActivity. Used by default and supported
+    # officialy.
+    module ActiveRecord
+      # Provides ActiveRecord specific, database-related routines for use by
+      # PublicActivity.
+      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/active_record/trackable.rb

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

data/lib/public_activity/orm/mongo_mapper.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "mongo_mapper/activity.rb"
+require_relative "mongo_mapper/adapter.rb"
+require_relative "mongo_mapper/activist.rb"
+require_relative "mongo_mapper/trackable.rb"

data/lib/public_activity/orm/mongo_mapper/activist.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module PublicActivity
+  module ORM
+    module MongoMapper
+      # Module extending classes that serve as owners
+      module Activist
+        # Adds MongoMapper 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
+        #     include MongoMapper::Document
+        #     include PublicActivity::Model
+        #     activist
+        #   end
+        #
+        # In controller:
+        #   User.first.activities
+        #
+        def activist
+          many :activities_as_owner,
+            :class_name => "::PublicActivity::Activity",
+            :as => :owner
+          many :activities_as_recipient,
+            :class_name => "::PublicActivity::Activity",
+            :as => :recipient
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'mongo_mapper'
+require 'active_support/core_ext'
+
+module PublicActivity
+  module ORM
+    module MongoMapper
+      # The MongoMapper document containing
+      # details about recorded activity.
+      class Activity
+        include ::MongoMapper::Document
+        include Renderable
+
+        class SymbolHash < Hash
+          def self.from_mongo(value)
+            value.symbolize_keys unless value.nil?
+          end
+        end
+
+        # 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 :recipient,  polymorphic: true
+
+        key :key,         String
+        key :parameters,  SymbolHash
+
+        timestamps!
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PublicActivity
+  module ORM
+    module MongoMapper
+      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/mongo_mapper/trackable.rb

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

data/lib/public_activity/orm/mongoid.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative "mongoid/activity.rb"
+require_relative "mongoid/adapter.rb"
+require_relative "mongoid/activist.rb"
+require_relative "mongoid/trackable.rb"

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module PublicActivity
+  module ORM
+    module Mongoid
+      # Module extending classes that serve as owners
+      module Activist
+        # 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 PublicActivity::Model
+        #     activist
+        #   end
+        #
+        # In controller:
+        #   User.first.activities
+        #
+        def activist
+          has_many :activities_as_owner,
+            :class_name => "::PublicActivity::Activity",
+            :inverse_of => :owner
+
+          has_many :activities_as_recipient,
+            :class_name => "::PublicActivity::Activity",
+            :inverse_of => :recipient
+        end
+      end
+    end
+  end
+end