narrator 0.0.1.alpha → 0.0.1.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa1bb48cf586a6f4f347ed23bad29ef890b6a970
+  data.tar.gz: 61fc99168cf94e4bf24b68652747e4df0822d6da
+SHA512:
+  metadata.gz: fa6d4ce60133cca0a0c8596fb5bc9dfc314ddb46f278c52d2c470bac44a5d0457a4f87b29a210093bbf4191f46c64897e2f4463ffccd2920146d455a9396a3e5
+  data.tar.gz: a264d17ae149cb7713ffed1b36f1884b62103ff442431f4539bebaaada182964ba6acc4b753ca3691440c5082d4298a65c45a1466395691dc0038854eb4ae58e

data/.travis.yml

@@ -1,8 +1,7 @@
 language: ruby
 rvm:
-  - "1.8.7"
-  - "1.9.2"
-  - "1.9.3"
+  - 1.8.7
+  - 1.9.3
   #- jruby-18mode # JRuby in 1.8 mode
   #- jruby-19mode # JRuby in 1.9 mode
   #- rbx-18mode

data/README.rdoc

@@ -1,3 +1,4 @@
+= This gem is currently unstable as it is being developed.
 = Narrator {<img src="https://secure.travis-ci.org/jweakley/narrator.png?branch=master" />}[http://travis-ci.org/jweakley/narrator]
 
 Narrator is an activity library for Ruby on Rails that allow you to track what is happening on models and later use to build an activity or news stream. Tracking is done at the controller level with a simple narrate_resource command (which was inspired by the simplicity of Ryan Bates' CanCan gem).
@@ -8,9 +9,73 @@ In <b> Rails 3 </b> add this line to your application's Gemfile and run the +bun
 
     gem "narrator"
 
+Once you have the Narrator gem installed you will need to run the generator:
+
+    rails generate narrator:install
+
+This generator will add the migrations needed for the activity tracking. Currently this only works for ActiveRecord.
+
+After the migration has been added you will need to migrate your database to run the new migration.
+
+    rake db:migrate
+
 == Getting Started
 
-* Coming Soon
+Narrator expects a +current_user+ method to exist in the controller. First, set up some authentication (such as Authlogic[https://github.com/binarylogic/authlogic] or Devise[https://github.com/plataformatec/devise]).
+
+=== 1. Mark a Model as Narratable
+
+Any model that we would like to have tracked by narrator needs to have <tt>narratable_model</tt> added to it.
+
+  class Article
+    narratable_model
+    ...
+  end
+
+See {Narrated Model}[https://github.com/jweakley/narrator/wiki/Narrated-Model] for more details and features.
+
+=== 1. Mark a Model as Narratable
+
+Any model that we would like to create activites (normally just User) needs to have <tt>narratable_actor</tt> added to it.
+
+  class User
+    narratable_actor
+    ...
+  end
+
+See {Narrated Actor}[https://github.com/jweakley/narrator/wiki/Narrated-ACtor] for more details and features.
+
+
+=== 3. Narrate the Model's activities from the controller
+
+The <tt>narrate</tt> method in the controller will narrate something important.
+
+  def create
+    ...
+    @article = Article.new(params[:article])
+    ...
+    narrate @article if @article.save
+    ....
+  end
+
+In this example, if the article is successfully saved, an activity gets logged for the article.
+
+See {Tracked Activities}[https://github.com/jweakley/narrator/wiki/Tracked-Activities] for more details and features with tracked activities.
+
+== Future Features
+
+Automagical Narration
+
+  class ArticlesController < ApplicationController
+    narrate_resource
+
+    def create
+      ...
+      respond_with @article
+      # @article is automaticly tracked if it is valid
+    end
+  end
+
 
 == Wiki Docs
 

data/Rakefile

@@ -1,5 +1,6 @@
 require "bundler/gem_tasks"
+require 'rake'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-task default: :spec
+task :default => :spec

data/lib/generators/narrator/install_generator.rb

@@ -0,0 +1,41 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Narrator
+  class InstallGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+    desc 'Generates migration for Activity model'
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.source_root
+      File.join(
+        File.dirname(__FILE__),
+        'templates',
+        (orm.to_s unless orm.class.eql?(String))
+      )
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        migration_number = Time.now.utc.strftime('%Y%m%d%H%M%S').to_i
+        migration_number += 1
+        migration_number.to_s
+      else
+        sprintf '%.3d' , (current_migration_number(dirname) + 1)
+      end
+    end
+
+    def create_migration_file
+      if self.class.orm_has_migration?
+        migration_template 'migration.rb', 'db/migrate/narrator_migration'
+      end
+    end
+  end
+end

data/lib/generators/narrator/templates/active_record/migration.rb

@@ -0,0 +1,31 @@
+class NarratorMigration < ActiveRecord::Migration
+  def change
+    if table_exists?(:activities)
+      say 'Activities table already exists! Narrator was unable to install.'
+      raise 'Narrator was unable to resolve clashing table names.'
+    else
+      suppress_messages do
+        create_table :activities do |t|
+          t.belongs_to :owner
+          t.string :owner_type
+          t.belongs_to :actor
+          t.string :actor_type
+          t.text :context
+          t.belongs_to :subject
+          t.string :subject_type
+          t.belongs_to :target
+          t.string :target_type
+          t.string :verb
+          t.boolean :has_seen, default: false
+
+          t.timestamps
+        end
+        add_index :activities, [:owner_id, :owner_type]
+        add_index :activities, [:actor_id, :actor_type]
+        add_index :activities, [:subject_id, :subject_type]
+        add_index :activities, [:target_id, :target_type]
+      end
+      say 'Created tables for Narrator'
+    end
+  end
+end

data/lib/narrator/activity.rb

@@ -1,4 +1,28 @@
 module Narrator
-  module Activity
+  class Activity < ::ActiveRecord::Base
+    ###
+    # Attribute accessible
+    ###
+      attr_accessible :owner, :subject, :actor, :target, :verb, :context, :has_seen
+
+    ###
+    # Associations
+    ###
+      belongs_to :owner, polymorphic: true
+      belongs_to :actor, polymorphic: true
+      belongs_to :subject, polymorphic: true
+      belongs_to :target, polymorphic: true
+
+    ###
+    # Validate
+    ###
+      validates :subject, presence: true
+      validates :verb, presence: true
+
+    ###
+    # Scopes
+    ###
+      scope :unseen, where(has_seen: false)
+      scope :seen, where(has_seen: true)
   end
 end

data/lib/narrator/controller_additions.rb

@@ -3,23 +3,37 @@ module Narrator
     module ClassMethods
 
       def narrate_resource(*args)
-        narrator_resource_class.add_before_filter(self, :narrate_resource, *args)
-      end
-
-      def narrate(subject, target = nil, verb = params[:action], actor_id = current_user.user_profile_id)
-        if user_signed_in?
-          subject.class.delay.track_user_activity(subject.id, actor_id, target.class.to_s, (target.blank? ? nil : target.id), verb.to_s)
-        end
+        narrator_resource_class.add_after_filter(self, :narrate_resource, *args)
       end
 
       def narrator_resource_class
+        if ancestors.map(&:to_s).include? 'InheritedResources::Actions'
+          InheritedResource
+        else
           ControllerResource
+        end
       end
+    end
 
-      def self.included(base)
-        base.extend ClassMethods
-      end
+    def self.included(base)
+      base.extend ClassMethods
+      base.helper_method :narrate
+    end
 
+    def narrate(subject, actor = current_user,  target = nil, verb = params[:action], context = nil)
+      if subject.class.respond_to? :track_user_activity
+        # Add some config way of determining to use delayed jobs.
+        subject.class.track_user_activity(
+          (subject.blank? ? nil : subject.id),
+          subject.class.to_s,
+          (actor.blank? ? nil : actor.id),
+          actor.class.to_s,
+          (target.blank? ? nil : target.id),
+          target.class.to_s,
+          verb,
+          context
+        )
+      end
     end
   end
 end

data/lib/narrator/controller_resource.rb

@@ -1,6 +1,15 @@
 module Narrator
   class ControllerResource
 
+    def self.add_after_filter(controller_class, method, *args)
+      options = args.extract_options!
+      resource_name = args.first
+      after_filter_method = options.delete(:prepend) ? :prepend_after_filter : :after_filter
+      controller_class.send(after_filter_method, options.slice(:only, :except, :if, :unless)) do |controller|
+        controller.class.narrator_resource_class.new(controller, resource_name, options.except(:only, :except, :if, :unless)).send(method)
+      end
+    end
+
     def initialize(controller, *args)
       @controller = controller
       @params = controller.params
@@ -9,8 +18,7 @@ module Narrator
     end
 
     def narrate_resource
-      # TODO Add skipper for this method
-      @controller.narrate(subject, nil, params[:action], current_user)
+      @controller.narrate(resource_instance) if resource_instance.valid?
     end
 
     protected
@@ -19,12 +27,20 @@ module Narrator
       @controller.send(:current_user)
     end
 
-    def resource_class
-      case @options[:class]
-      when String then @options[:class].constantize
-      else @options[:class]
-      end
+    def resource_instance
+      @controller.instance_variable_get("@#{instance_name}")
     end
 
+    def name
+      @name || name_from_controller
+    end
+
+    def name_from_controller
+      @params[:controller].sub('Controller', '').underscore.split('/').last.singularize
+    end
+
+    def instance_name
+      @options[:instance_name] || name
+    end
   end
 end

data/lib/narrator/model_additions.rb

@@ -0,0 +1,34 @@
+module Narrator
+  module ModelAdditions
+    include ::ActiveSupport::Inflector
+    def narratable_model
+      ###
+      # Includes
+      ###
+      include Narrator::ModelResources
+
+      ###
+      # Associations
+      ###
+      has_many :activities, as: :subject, class_name: 'Narrator::Activity', dependent: :destroy
+
+      ###
+      # Instance Methods
+      ###
+
+      # TODO Add documentation once format is determined.
+      def track_user_activity(subject_id, subject_class, actor_id, actor_class, target_id, target_class, verb, context)
+        actor = actor_id.blank? ? nil : actor_class.constantize.find_by_id(actor_id)
+        subject = subject_id.blank? ? nil : subject_class.constantize.find_by_id(subject_id)
+        target = target_id.blank? ? nil : target_class.constantize.find_by_id(target_id)
+        Narrator::Activity.create!(owner: nil, subject: subject, actor: actor, target: target, verb: verb, context: context)
+      end
+    end
+    def narratable_actor
+      ###
+      # Associations
+      ###
+      has_many :activities, as: :actor, class_name: 'Narrator::Activity', dependent: :destroy
+    end
+  end
+end

data/lib/narrator/model_resources.rb

@@ -0,0 +1,9 @@
+module Narrator
+  module ModelResources
+
+    # TODO Remove this test method.
+    def haldo
+      puts 'Haldo!'
+    end
+  end
+end

data/lib/narrator/narrator_railtie.rb

@@ -0,0 +1,9 @@
+module Narrator
+  class NarratorRailtie < Rails::Railtie
+    initializer 'narrator.model_additions' do
+      ActiveSupport.on_load :active_record do
+        extend ModelAdditions
+      end
+    end
+  end
+end

data/lib/narrator/version.rb

@@ -1,3 +1,3 @@
 module Narrator
-  VERSION = "0.0.1.alpha"
+  VERSION = '0.0.1.beta'
 end

data/lib/narrator.rb

@@ -1,9 +1,7 @@
-require 'narrator/ability'
-require 'narrator/controller_resource'
+require 'narrator/version'
+require 'narrator/activity'
+require 'narrator/model_additions'
+require 'narrator/model_resources'
 require 'narrator/controller_additions'
-
-require "narrator/version"
-
-module Narrator
-  # Your code goes here...
-end
+require 'narrator/controller_resource'
+require 'narrator/narrator_railtie.rb' if defined?(Rails)

data/narrator.gemspec

@@ -17,5 +17,8 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.add_dependency('rails', '~>3.0')
+
   gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
 end

data/spec/narrator/narrator_spec.rb

@@ -1,5 +1,8 @@
 require 'spec_helper'
 
 describe Narrator do
-  pending "Add moar tests!"
+  it 'should pass' do
+    true.should eq true
+  end
+  pending 'Add MOAR TESTS!'
 end

data/spec/spec_helper.rb

@@ -1 +1 @@
-require "narrator"
+require 'narrator'

metadata

@@ -1,30 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: narrator
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
-  prerelease: 6
+  version: 0.0.1.beta
 platform: ruby
 authors:
 - Joe Weakley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-08 00:00:00.000000000 Z
+date: 2013-10-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: Straightforward and flexable activity tracking for rails that is designed
@@ -43,40 +68,41 @@ files:
 - LICENSE.txt
 - README.rdoc
 - Rakefile
-- lib/generators/narrator/activity/USAGE
-- lib/generators/narrator/activity/activity_generator.rb
-- lib/generators/narrator/activity/templates/activity.rb
+- lib/generators/narrator/install_generator.rb
+- lib/generators/narrator/templates/active_record/migration.rb
 - lib/narrator.rb
 - lib/narrator/activity.rb
 - lib/narrator/controller_additions.rb
 - lib/narrator/controller_resource.rb
+- lib/narrator/model_additions.rb
+- lib/narrator/model_resources.rb
+- lib/narrator/narrator_railtie.rb
 - lib/narrator/version.rb
 - narrator.gemspec
 - spec/narrator/narrator_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/jweakley/narrator
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>'
+  - - '>'
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Straightforward and flexable activity tracking for rails.
 test_files:
 - spec/narrator/narrator_spec.rb

data/lib/generators/narrator/activity/USAGE

@@ -1,4 +0,0 @@
-Description:
-  The narrator:activity generator creates an Activity class in the models
-  directory. You can move this file anywhere you want as long as it
-  is in the load path.

data/lib/generators/narrator/activity/activity_generator.rb

@@ -1,11 +0,0 @@
-module Narrator
-  module Generators
-    class ActivityGenerator < Rails::Generators::Base
-      source_root File.expand_path('../templates', __FILE__)
-
-      def generate_ability
-        copy_file "activity.rb", "app/models/activity.rb"
-      end
-    end
-  end
-end

data/lib/generators/narrator/activity/templates/activity.rb

@@ -1,30 +0,0 @@
-class Activity
-    include Narrator::Activity
-    ###
-    # Attribute accessible
-    ###
-      attr_accessible :owner, :subject, :actor, :target, :target_id, :target_type, :verb, :context, :has_seen
-
-    ###
-    # Associations
-    ###
-      belongs_to :owner, class_name: 'UserProfile'
-      belongs_to :actor, class_name: 'UserProfile'
-      belongs_to :subject, polymorphic: true
-      belongs_to :target, polymorphic: true
-
-    ###
-    # Validate
-    ###
-      validates :owner, presence: true
-      validates :subject, presence: true
-      validates :verb, presence: true
-
-    ###
-    # Scopes
-    ###
-      scope :unseen, where{has_seen.eq false}
-      scope :seen, where{has_seen.eq true}
-      scope :recent, order('created_at DESC')
-
-end