choo_choo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a77cc4e6f34e32ab2957530979831a258de91728
+  data.tar.gz: d4576efa4bd3c868adc71e55a7d5842727f694bb
+SHA512:
+  metadata.gz: fc879ed83236c253a234d5e566d68819d7289f29d2ce872eff231d3c2f7fe6930bea63e13dbead63133879f9bad600873962dda61eced3065fe43441acf7434b
+  data.tar.gz: d0118dfac26cd761cad87d26b8ec54b950d917a2ec086da6652ba5f7677f6457b8d7237ffb269a48573a071fe90117018b6f1cea8d75dd09077b57860bf31902

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# ChooChoo [![Build Status](https://travis-ci.org/lnucrowding/choo_choo.png?branch=master)](https://travis-ci.org/lnucrowding/choo_choo)
+
+## About
+
+ChooChoo is an application for dynamic activity tracking in Ruby On Rails. By storing information triggered by (tracked) model changes, ChooChoo will then let you reference these changes in a dynamic and highly customizable way.
+
+## Installation
+
+Add this to your `Gemfile`:
+
+    # since it's not a proper gem yet, pull from this repo
+    gem 'choo_choo', github: 'lnucrowding/choo_choo'
+
+Install the required choo_choo migrations:
+
+    rake choo_choo:install:migrations
+
+And then run:
+
+    rake db:migrate
+
+**Optional:**
+
+You can also specify a branch, tag or even a ref:
+
+    gem 'choo_choo', github: 'lnucrowding/choo_choo', branch: 'my_feature'
+
+    gem 'choo_choo', github: 'lnucrowding/choo_choo', tag: 'v0.1.0'
+
+    gem 'choo_choo', github: 'lnucrowding/choo_choo', ref: '6c46204'
+
+## Usage
+
+When listening for model activities through ChooCchoo you will need to set up a parent-children behaviour.
+In the example below, we will be using the dummy app found in spec/dummy to illustrate how ChooChoo works.
+
+
+The first thing to do is to decide for a model that will act as a parent. Using the dummy app, we will go for
+app/models/post.rb as it is a connecting point for comments and users.
+
+```ruby
+# Simply include ChooChoo::ParentNode into post.rb and you're all set
+include ChooChoo::ParentNode
+```
+
+Now that we have a parent, let's give ChooChoo some children. In this example we will only focus on
+Comment model. But you can of course add as many children as you wish.
+
+```ruby
+# First, include the ChooChoo::ChildNode into comment.rb
+include ChooChoo::ChildNode
+```
+
+```ruby
+# And moving on, we need to tell this child where his parent is
+# by simply adding this line into comment.rb
+set_parent :post
+```
+
+So that's all you really need for setting upp ChooChoo - a simple and lightweight activity listener for your models.
+From here you can now get access to your activities. For instance, in your views or controller actions by the following examples.
+
+```ruby
+# Get the whole related ChooChoo instance for a post
+@post.activity
+```
+```ruby
+# Find out what the last action for the activity was
+# This returns a string of 'created', 'updated' or 'deleted'
+# Please do note that if a parent node is deleted you will no longer have access to the activity
+@post.activity.last_action
+```
+```ruby
+# Get the latest changed child for the parent
+# This returns the instance of the object (child) tracked by ChooChoo
+@post.activity.last_updated_node
+```
+
+```ruby
+# You can also just access the reference id if you so wish by
+@post.activity.last_updated_node_id
+```
+
+Of course, you also have access to the timestamp columns created_at and updated_at that are updated accordingly on
+new activities. From here, you are free to customize the ChooChoo so it fits your needs or simply use the given solution
+and make own customizations through views and helpers in your app that utilizes ChooChoo.
+
+### Events
+
+The `activity.last_action` contains a string of the last registered event like
+follows:
+
+- `created` when a parent or child is created
+- `updated` when a parent or child is updated
+- `deleted` when a **child** is deleted
+- `destroyed` when a parent is deleted (this is different because this means
+you lose the references to the models)
+
+## Testing
+
+To run the tests, you first have to make sure it's installed properly, and then
+clone the testing database:
+
+    rake app:db:test:clone
+
+You can then run the tests with:
+
+    bundle exec rspec

data/Rakefile

@@ -0,0 +1,21 @@
+#!/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
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/assets/javascripts/choo_choo/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/choo_choo/activity_default.scss.css

@@ -0,0 +1,17 @@
+body {
+  font-family: "Helvetica";
+}
+
+li {
+  padding: 12px 8px 6px 8px;
+  background-color: #eee;
+  margin-left: -40px;
+  list-style: none;
+  border-bottom: 1px solid #ddd;
+  margin-bottom: 20px;
+}
+
+pre {
+  padding: 3px;
+  background-color: #ede8ea;
+}

data/app/assets/stylesheets/choo_choo/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/choo_choo/application_controller.rb

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

data/app/helpers/choo_choo/application_helper.rb

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

data/app/models/choo_choo/activity.rb

@@ -0,0 +1,29 @@
+module ChooChoo
+  # A new activity is created when a ParentNode is created
+  # the event_happened method is called whenever there is a state change for the
+  # tracked models using Activity as a ParentNode or a ChildNode
+  class Activity < ActiveRecord::Base
+
+    attr_accessible :last_action, :parent_node, :last_updated_node
+
+    belongs_to :parent_node, polymorphic: true
+    belongs_to :last_updated_node, polymorphic: true
+
+    after_create :on_create
+
+    # Initial creation of a new activity with a ParentNode set to the model
+    # in the hosting app using choo_choo that will act as a parent
+    def on_create
+      self.event_happened('created', self.parent_node)
+    end
+
+    # Tracks model changes (created, updated, deleted)
+    # Wether it's a parent or child node
+    def event_happened(event_name, model)
+      self.last_action = event_name
+      self.last_updated_node = model
+      self.updated_at = Time.zone.now
+      self.save!
+    end
+  end
+end

data/app/models/choo_choo/child_node.rb

@@ -0,0 +1,38 @@
+module ChooChoo
+  module ChildNode
+    extend ActiveSupport::Concern
+
+    included do
+      cattr_reader :my_parent
+
+      # Callbakcs for when a model tacked by choo_choo
+      # is updated, creeated or destroyed
+      after_create :on_create
+      after_update :on_update
+      before_destroy :on_destroy
+
+      # Defines the parent (the model where ParentNode is included)
+      # for the model to be tracked by choo_choo as a child node
+      def self.set_parent(parent)
+        @@my_parent = parent
+      end
+
+    end
+
+    # The callback actions below are called when there is a new
+    # activity for a child node tracked by choo_choo
+    private
+
+    def on_create
+      self.send(@@my_parent).activity.event_happened('created', self)
+    end
+
+    def on_update
+      self.send(@@my_parent).activity.event_happened('updated', self)
+    end
+
+    def on_destroy
+      self.send(@@my_parent).activity.event_happened('deleted', self)
+    end
+  end
+end

data/app/models/choo_choo/parent_node.rb

@@ -0,0 +1,38 @@
+module ChooChoo
+
+  module ParentNode
+    extend ActiveSupport::Concern
+
+    included do
+
+      # TODO: break out into base_event?
+      after_create :on_create
+      after_update :on_update
+      before_destroy :on_destroy
+
+      has_one :activity, as: :parent_node, class_name: 'ChooChoo::Activity', dependent: :destroy
+    end
+
+
+    # called from subactivites when something has happened
+    def child_event_happened(activity_name, model)
+      # facade
+      self.activity.event_happened(activity_name, model)
+    end
+
+    private
+
+    def on_create
+      ChooChoo::Activity.create(parent_node: self)
+    end
+
+    def on_update
+      self.activity.event_happened('updated', self)
+    end
+
+    def on_destroy
+      self.activity.event_happened('destroyed', nil)
+    end
+  end
+
+end

data/app/views/choo_choo/activities/_all.html.erb

@@ -0,0 +1,13 @@
+<div>
+  <% @activities.each do |activity| %>
+    <div style="background-color: #eee">
+      <h2><%= activity.parent_node.title %></h2>
+      <strong><%= activity.parent_node.body %></strong>
+
+      <h4>Comments:</h4>
+      <ul>
+        <li><%= activity.last_updated_node.body %></li>
+      </ul>
+    </div>
+  <% end %>
+</div>

data/config/initializers/assets_helpers.rb

@@ -0,0 +1,4 @@
+Rails.application.assets.context_class.class_eval do
+  # Allows assets to use the engines url helpers
+  include ChooChoo::Engine.routes.url_helpers
+end

data/config/routes.rb

@@ -0,0 +1,11 @@
+ChooChoo::Engine.routes.draw do
+  
+  # a intresting thing here would be to have altanative routes.
+  # one example is the facebook user profile where you can se another persons activities. 
+  # Then we cannot rely on current_user to know what should be shown. 
+  # Instead we need to send a id param to get another users activities.
+  # For example: get "activities/users/:id/", to: "activities#index"
+  
+  get '/activities/', to: 'activities#index', as: 'activities'
+  root :to => 'activities#index'
+end

data/db/migrate/20140221100053_create_choo_choo_locomotives.rb

@@ -0,0 +1,8 @@
+class CreateChooChooLocomotives < ActiveRecord::Migration
+  def change
+    create_table :choo_choo_locomotives do |t|
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140221100201_create_choo_choo_carriages.rb

@@ -0,0 +1,11 @@
+class CreateChooChooCarriages < ActiveRecord::Migration
+  def change
+    create_table :choo_choo_carriages do |t|
+      t.string :excerpt
+      t.string :activity_type
+      t.integer :recipient_id
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140223212120_add_recipienttype_to_carriage.rb

@@ -0,0 +1,5 @@
+class AddRecipienttypeToCarriage < ActiveRecord::Migration
+  def change
+    add_column :choo_choo_carriages, :recipient_type, :string
+  end
+end

data/db/migrate/20140225222624_add_columns_to_carriage.rb

@@ -0,0 +1,8 @@
+class AddColumnsToCarriage < ActiveRecord::Migration
+  def change
+    rename_column :choo_choo_carriages, :recipient_id, :tracked_resource_id
+    rename_column :choo_choo_carriages, :recipient_type, :tracked_resource_type
+    add_column :choo_choo_carriages, :header, :string
+    add_column :choo_choo_carriages, :creator_id, :integer
+  end
+end

data/db/migrate/20140310144724_create_choo_choo_activities.rb

@@ -0,0 +1,13 @@
+class CreateChooChooActivities < ActiveRecord::Migration
+  def change
+    create_table :choo_choo_activities do |t|
+
+      t.string :last_action
+
+      t.belongs_to :master_event, polymorphic: true
+      t.belongs_to :last_event, polymorphic: true
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20140310170148_remove_locomotives_and_carriages.rb

@@ -0,0 +1,6 @@
+class RemoveLocomotivesAndCarriages < ActiveRecord::Migration
+  def change
+    drop_table :choo_choo_locomotives
+    drop_table :choo_choo_carriages
+  end
+end

data/db/migrate/20140311120314_rename_events_to_nodes.rb

@@ -0,0 +1,9 @@
+class RenameEventsToNodes < ActiveRecord::Migration
+  def change
+    rename_column :choo_choo_activities, :last_event_id, :last_updated_node_id
+    rename_column :choo_choo_activities, :last_event_type, :last_updated_node_type
+
+    rename_column :choo_choo_activities, :master_event_id, :parent_node_id
+    rename_column :choo_choo_activities, :master_event_type, :parent_node_type
+  end
+end