activity_engine 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 67279cf55dbed635e902fdd9e1360922f774bc84
+  data.tar.gz: 0849e330812d6b4e364dd4db17572833d472bcb3
+SHA512:
+  metadata.gz: ad39086e8d7790407eafd2e7e26e2109fa6cd194a5b71aedc0e2fdeb189a798ea91b1b961be0582eca973b300ffa2667a90fb5a8b84aa8ea121646dccfecebc5
+  data.tar.gz: 6108ebb34fa9abafc41cb1d86d6e3e210574bfac5b2623ab98ed5515cf550383f8733f13bd15ad2035a0eea7d4a5ba2dcf682070f62348187948ddc3d38cb2bd

data/.gitignore

@@ -0,0 +1,10 @@
+.bundle/
+log/*.log
+pkg/
+spec/dummy/db/*.sqlite3
+spec/dummy/log/*.log
+spec/dummy/tmp/
+spec/dummy/.sass-cache
+Gemfile.lock
+tmp/*
+coverage/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,23 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in activity_engine.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# jquery-rails is used by the dummy application
+gem "jquery-rails"
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use debugger
+# gem 'debugger'
+
+group :test do
+  gem 'simplecov', require: false
+  gem "guard"
+  gem "guard-rspec"
+end

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.+)\.rb$})     { |m| "spec/app/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch('spec/support/*')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,17 @@
+##########################################################################
+# activity_engine
+#
+# Copyright © 2013 University of Notre Dame
+# Additional copyright may be held by others, as reflected in the commit history.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

data/README.md

@@ -0,0 +1,39 @@
+# ActivityEngine
+
+A mountable Rails engine for both recording activity and displaying activity on
+a persisted object.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activity_engine'
+
+And then execute:
+
+    $ bundle
+
+Then run:
+
+    $ rails g activity_engine:install
+
+## Register a Method
+
+To record activity, register a class and method via a Rails generator.
+
+    $ rails g activity_engine:register <ClassName> <MethodName> <Subject>
+
+Or by hand in a config/initializers/activity_engine_config.rb
+
+    ActivityEngine.register('<ClassName>', '<MethodName>') do |activity,context|
+      activity.subject = context.<subject>
+      activity.user = context.current_user
+      activity.activity_type = "an arbitrary type"
+      activity.message = "A particulare message?"
+    end
+
+Then, whenever the ClassName#MethodName is invoke an activity will be recorded.
+
+## TODO
+
+* Provide a means for retrieving an object's activities

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks

data/TODO.md

@@ -0,0 +1,24 @@
+# Development Phases
+
+## Phase 1
+
+We need basic activity reporting and collecting. At this point, we would add the registration to each of the appropriate methods.
+An initial assumption is that activity logs will be stored in a different persistence engine than the objects in which there is activity.
+That is to say Fedora Commons for the persisted objects, and an ActiveRecord database for the persisted objects.
+
+### High Level Tasks
+
+* Allow for the creation of an Activity against a persisted object
+* Allow for collecting my activity
+* Allow for collecting a persisted objects activity
+
+### Commands
+
+    $ rails generate model JournalEntry \
+    journaled_object_type:string journaled_object_id:string \
+    requested_by_user_id:string journal_type:string \
+    message:text
+
+## Phase 2
+
+Allow for the registration of all activity observers on an application basis.

data/activity_engine.gemspec

@@ -0,0 +1,31 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "activity_engine/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "activity_engine"
+  s.version     = ActivityEngine::VERSION
+  s.authors     = [
+    "Jeremy Friesen"
+  ]
+  s.email       = [
+    "jeremy.n.friesen@gmail.com"
+  ]
+
+  s.homepage    = "http://github.com/ndlib/activity_engine"
+  s.summary     = "ActivityEngine - a mountable Rails engine for activity streams"
+  s.description = "ActivityEngine - a mountable Rails engine for activity streams"
+  s.license = "APACHE2"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rails", "~> 3.2.13"
+
+  s.add_development_dependency "sqlite3"
+  s.add_development_dependency 'rspec-rails'
+end

data/app/assets/javascripts/activity_engine/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/activity_engine/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/controllers/activity_engine/application_controller.rb

@@ -0,0 +1,4 @@
+module ActivityEngine
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/activity_engine/application_helper.rb

@@ -0,0 +1,4 @@
+module ActivityEngine
+  module ApplicationHelper
+  end
+end

data/app/models/activity_engine/activity.rb

@@ -0,0 +1,28 @@
+require 'activity_engine/exceptions'
+module ActivityEngine
+  class Activity < ActiveRecord::Base
+    def self.call(data)
+      create! do |activity|
+        activity.subject = data.subject
+        activity.user = data.current_user
+        activity.message = data.message
+        activity.activity_type = data.activity_type
+      end
+    end
+
+    belongs_to :user
+
+    def subject
+      subject_type.constantize.find(subject_id)
+    end
+
+    def subject=(object)
+      if object.persisted?
+        write_attribute(:subject_type, object.class.to_s)
+        write_attribute(:subject_id, object.to_param)
+      else
+        raise UnpersistedSubjectError.new(object)
+      end
+    end
+  end
+end

data/app/views/layouts/activity_engine/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>ActivityEngine</title>
+  <%= stylesheet_link_tag    "activity_engine/application", :media => "all" %>
+  <%= javascript_include_tag "activity_engine/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+ActivityEngine::Engine.routes.draw do
+end

data/db/migrate/20130722162331_create_activity_engine_activities.rb

@@ -0,0 +1,13 @@
+class CreateActivityEngineActivities < ActiveRecord::Migration
+  def change
+    create_table :activity_engine_activities do |t|
+      t.integer :user_id
+      t.string :subject_type, index: true, null: false
+      t.string :subject_id, index: true, null: false
+      t.string :activity_type, index: true, null: false
+      t.text :message
+      t.timestamps
+    end
+    add_index :activity_engine_activities, :user_id
+  end
+end

data/lib/activity_engine/activity_builder.rb

@@ -0,0 +1,45 @@
+require 'activity_engine/activity_data_structure'
+require 'activity_engine/exceptions'
+module ActivityEngine
+  class ActivityBuilder
+
+    attr_accessor :configuration_proc, :activity_receiver
+    private :activity_receiver=, :configuration_proc=
+
+    def initialize(activity_receiver, configuration_proc)
+      unless activity_receiver.respond_to?(:call)
+        raise RuntimeError, "Excpected :activity_receiver #{activity_receiver.inspect} to be callable"
+      end
+      unless configuration_proc.respond_to?(:call)
+        raise RuntimeError, "Excpected :configuration_proc #{configuration_proc.inspect} to be callable"
+      end
+      self.activity_receiver = activity_receiver
+      self.configuration_proc = configuration_proc
+    end
+
+    def call(context)
+      configuration_proc.call(self, context)
+      activity_receiver.call(self.to_activity_data_structure)
+    end
+
+    def to_activity_data_structure
+      ActivityDataStructure.new.tap {|ads|
+        ads.subject = subject
+        ads.current_user = current_user
+        ads.message = message
+        ads.activity_type = activity_type
+      }
+    end
+
+    def subject=(persisted_object)
+      if persisted_object.persisted?
+        @subject = persisted_object
+      else
+        raise UnpersistedSubjectError.new(persisted_object)
+      end
+    end
+
+    attr_reader :subject
+    attr_accessor :current_user, :message, :activity_type
+  end
+end

data/lib/activity_engine/activity_data_structure.rb

@@ -0,0 +1,10 @@
+module ActivityEngine
+  if !defined?(ActivityDataStructure)
+    ActivityDataStructure = Struct.new(
+      :subject,
+      :current_user,
+      :message,
+      :activity_type
+    )
+  end
+end

data/lib/activity_engine/context_builder.rb

@@ -0,0 +1,40 @@
+require 'activity_engine/exceptions'
+module ActivityEngine
+  class ContextBuilder
+
+    def initialize(class_name, method_name)
+      self.class_name = class_name
+      self.method_name = method_name
+      extract_context_class!
+      extract_method!
+    end
+
+    def wrap!(wrapper)
+      # Why the i prefix? We need the local variables to be availabe
+      # within the context of the module_exec.
+      context_class.module_exec(method_name, context_method, wrapper) { |imethod_name, icontext_method, wrapper_proc|
+        define_method(imethod_name) { |*args, &block|
+          returning_value = icontext_method.bind(self).call(*args, &block)
+          wrapper_proc.call(self)
+          returning_value
+        }
+      }
+    end
+
+    attr_accessor :class_name, :method_name, :context_class, :context_method
+    private :class_name, :method_name
+    private
+    def extract_context_class!
+      if class_name.respond_to?(:constantize)
+        @context_class = class_name.constantize
+      else
+        @context_class = class_name
+      end
+    end
+
+    def extract_method!
+      @context_method = context_class.instance_method(method_name)
+    end
+
+  end
+end

data/lib/activity_engine/engine.rb

@@ -0,0 +1,17 @@
+module ActivityEngine
+  class Engine < ::Rails::Engine
+    isolate_namespace ActivityEngine
+
+    config.generators do |g|
+      g.test_framework :rspec, :fixture => false
+    end
+
+    extend ActiveSupport::Autoload
+    eager_autoload do
+      autoload :ContextBuilder
+      autoload :ActivityBuilder
+      autoload :ActivityDataStructure
+      autoload :Activity
+    end
+  end
+end

data/lib/activity_engine/exceptions.rb

@@ -0,0 +1,7 @@
+module ActivityEngine
+  class UnpersistedSubjectError < RuntimeError #:nodoc:
+    def initialize(subject)
+      super("#{subject.inspect} is not persisted")
+    end
+  end
+end

data/lib/activity_engine/version.rb

@@ -0,0 +1,3 @@
+module ActivityEngine
+  VERSION = "0.0.2"
+end

data/lib/activity_engine.rb

@@ -0,0 +1,14 @@
+require "activity_engine/engine"
+require 'activity_engine/context_builder'
+require 'activity_engine/activity_builder'
+
+module ActivityEngine
+  module_function
+
+  def register(class_name, method_name, activity_receiver = ActivityEngine::Activity, &config_block)
+    context_builder = ContextBuilder.new(class_name, method_name)
+    activity_builder = ActivityBuilder.new(activity_receiver, config_block)
+    context_builder.wrap!(activity_builder)
+  end
+
+end

data/lib/generators/activity_engine/install_generator.rb

@@ -0,0 +1,19 @@
+module ActivityEngine
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates a ActivityEngine initializer."
+
+      def copy_initializer
+        template "activity_engine_config.rb", "config/initializers/activity_engine_config.rb"
+      end
+
+      def run_migrations
+        rake('activity_engine:install:migrations')
+        rake('db:migrate')
+      end
+
+    end
+  end
+end

data/lib/generators/activity_engine/register_generator.rb

@@ -0,0 +1,28 @@
+module ActivityEngine
+  module Generators
+    class RegisterGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates a ActivityEngine initializer."
+      argument :class_name, type: :string
+      argument :method_name, type: :string
+      argument :subject_method, type: :string
+
+      def copy_initializer
+        generate('activity_engine:install')
+        text = [
+          "ActivityEngine.register('#{class_name}', '#{method_name}') do |activity, context|",
+          "  activity.subject = context.#{subject_method}",
+          "  activity.user = context.current_user",
+          "  activity.activity_type = '#{class_name}##{method_name}'",
+          "#  activity.message = 'Specify a custom message if applicable'",
+          "end",
+          "",
+          ""
+        ].join("\n")
+
+        inject_into_file('config/initializers/activity_engine_config.rb', text, before: /\A.*ActivityEngine.register/)
+      end
+    end
+  end
+end

data/lib/generators/activity_engine/templates/activity_engine_config.rb

@@ -0,0 +1,6 @@
+# ActivityEngine.register('PagesController', 'show') do |activity,context|
+#   activity.subject = context.page
+#   activity.user = context.current_user
+#   activity.activity_type = 'pages#show'
+#   activity.message = "A particulare message?"
+# end

data/lib/tasks/activity_engine_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :activity_engine do
+#   # Task goes here
+# end

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/activity_engine/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'