satchel 0.0.1.placeholder → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bc1b5af14aff7fae2306be204e01ed2ecf9c24ff
-  data.tar.gz: 0bb526524e4a81c9ca0ea4615dc937184980ad67
+  metadata.gz: f65129ed73d372a2b29b8c7bdabdf65f21616502
+  data.tar.gz: baa20abc0389eb97ef188b676c70073049931fed
 SHA512:
-  metadata.gz: 02071fa3b9f2db7aed0f36ae5780b47f6101a1f820bc94e7f39dbe562881ba14cbcda646dfb70a7f52eca1f4f75f0cf9504a6b01676cc87ef40b43945c0e350d
-  data.tar.gz: 4efeb0266b9f6d170c036377a938efeba768e7136726da321b287409bc8e8d4cc6b6c9e0117d68bd3f2935a41b897e60551222f0a024ad8738b73455a542828e
+  metadata.gz: 2a947c6b478508e3d46f076b64b32e3cdce44c8830760f15e7347fccdb52855746047cbe0c30bddf9bc1c7e3c0d725881d6adde0e4f489a6a8441c1634a4e08d
+  data.tar.gz: 9d937162e3a863a63752c7ab7d286048e7ff4f4061d2cba53cec58bb34f5f22f31bd3208abf44e7a24596069900bf62bfeacbf0667b0a3a9e725f002129f4491

data/.gitignore

@@ -6,3 +6,4 @@ spec/dummy/log/*.log
 spec/dummy/tmp/
 spec/dummy/.sass-cache
 Gemfile.lock
+tmp/*

data/Gemfile

@@ -15,3 +15,9 @@ gem "jquery-rails"
 
 # 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/Rakefile

@@ -4,35 +4,8 @@ begin
 rescue LoadError
   puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
 end
-begin
-  require 'rdoc/task'
-rescue LoadError
-  require 'rdoc/rdoc'
-  require 'rake/rdoctask'
-  RDoc::Task = Rake::RDocTask
-end
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Satchel'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-
 
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task :default => :test

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/app/assets/javascripts/satchel/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/satchel/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/satchel/application_controller.rb

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

data/app/helpers/satchel/application_helper.rb

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

data/app/models/satchel/activity.rb

@@ -0,0 +1,28 @@
+require 'satchel/exceptions'
+module Satchel
+  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/satchel/application.html.erb

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

data/config/routes.rb

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

data/db/migrate/20130722162331_create_satchel_activities.rb

@@ -0,0 +1,13 @@
+class CreateSatchelActivities < ActiveRecord::Migration
+  def change
+    create_table :satchel_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 :satchel_activities, :user_id
+  end
+end

data/lib/satchel/activity_builder.rb

@@ -0,0 +1,45 @@
+require 'satchel/activity_data_structure'
+require 'satchel/exceptions'
+module Satchel
+  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/satchel/activity_data_structure.rb

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

data/lib/satchel/context_builder.rb

@@ -0,0 +1,40 @@
+require 'satchel/exceptions'
+module Satchel
+  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/satchel/engine.rb

@@ -0,0 +1,17 @@
+module Satchel
+  class Engine < ::Rails::Engine
+    isolate_namespace Satchel
+
+    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/satchel/exceptions.rb

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

data/lib/satchel/version.rb

@@ -1,3 +1,3 @@
 module Satchel
-  VERSION = "0.0.1.placeholder"
+  VERSION = "0.0.1"
 end

data/lib/satchel.rb

@@ -1,2 +1,14 @@
+require "satchel/engine"
+require 'satchel/context_builder'
+require 'satchel/activity_builder'
+
 module Satchel
+  module_function
+
+  def register(class_name, method_name, activity_receiver = Satchel::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/satchel.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/ndlib/satchel"
   s.summary     = "Satchel - a mountable Rails engine for activity streams"
   s.description = "Satchel - 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")
@@ -26,4 +27,5 @@ Gem::Specification.new do |s|
   s.add_dependency "rails", "~> 3.2.13"
 
   s.add_development_dependency "sqlite3"
+  s.add_development_dependency 'rspec-rails'
 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/satchel/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |   |   |-- images
+  |   |   |-- javascripts
+  |   |   `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   |-- assets
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   `-- cache
+  |       `-- assets
+  `-- vendor
+      |-- assets
+      |   |-- javascripts
+      |   `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/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 .