primer 0.1.0

data/spec/primer/watcher/active_record_spec.rb

@@ -0,0 +1,189 @@
+require 'spec_helper'
+
+describe Primer::Watcher::ActiveRecordMacros do
+  before do
+    @person   = Person.create(:name => "Abe")
+    @impostor = Person.create(:name => "Aaron")
+    @post     = @person.blog_posts.create(:title => "web scale")
+    @id       = @person.id
+    
+    @artist   = Artist.create(:name => "Wolf Parade")
+    @concert  = Concert.create(:date => 6.months.ago, :venue => "Borderline")
+    @festival = Concert.create(:date => 3.months.ago, :venue => "End of the Road")
+    @calendar = Calendar.create(:artists => [@artist])
+    
+    @artist.concerts << @festival
+    
+    Primer::Worker::ActiveRecordAgent.bind_to_bus
+    Primer::Watcher.enable!
+  end
+  
+  after do
+    @person.delete
+  end
+  
+  def should_publish(topic, *message)
+    @publish ||= Primer.bus.method(:publish)
+    Primer.bus.should_receive(:publish).with(topic, message) do |*args|
+      @publish.call(*args)
+    end
+  end
+  
+  describe "#primer_identifier" do
+    it "returns a tuple that tells us enough to find the object" do
+      @person.primer_identifier.should == ["ActiveRecord", "Person", @person.id]
+    end
+  end
+  
+  it "is mixed in automatically when using Primer with ActiveRecord" do
+    Person.should be_kind_of(Primer::Watcher::ActiveRecordMacros)
+  end
+  
+  it "watches ActiveRecord attributes" do
+    @person.name.should == "Abe"
+    Primer::Watcher.call_log.should == [[@person, :name, [], nil, "Abe"]]
+  end
+  
+  it "watches calls to has_many associations" do
+    @person.blog_posts.count.should == 1
+    Primer::Watcher.call_log.should include([@person, :blog_posts, [], nil, [@post]])
+  end
+  
+  it "watches calls to belongs_to associations" do
+    @post.person.should == @person
+    Primer::Watcher.call_log.should include([@post, :person, [], nil, @person])
+  end
+  
+  it "logs calls made inside other methods" do
+    @person.all_attributes.should == [@id, "Abe"]
+    Primer::Watcher.call_log.should == [
+      [@person, :id,   [], nil, @id  ],
+      [@person, :name, [], nil, "Abe"]
+    ]
+  end
+  
+  it "publishes a message when an attribute changes" do
+    should_publish(:active_record, :update, "Person", anything, anything)
+    should_publish(:changes, "ActiveRecord", "Person", @person.id, "name")
+    @person.update_attribute(:name, "Aaron")
+  end
+  
+  it "publishes messages when an object is deleted" do
+    should_publish(:active_record, :destroy, "Person", anything)
+    should_publish(:changes, "ActiveRecord", "Person", @person.id, "id")
+    should_publish(:changes, "ActiveRecord", "Person", @person.id, "name")
+    should_publish(:changes, "ActiveRecord", "Person", @person.id, "age")
+    should_publish(:changes, "ActiveRecord", "BlogPost", @post.id, "person")
+    @person.destroy
+  end
+  
+  it "publishes a message about a belongs_to association when the foreign key changes" do
+    should_publish(:active_record, :create, "BlogPost", anything)
+    should_publish(:changes, "ActiveRecord", "Person", @person.id, "blog_posts")
+    BlogPost.create(:person => @person, :title => "How to make a time machine")
+  end
+  
+  it "publishes a message about a belongs_to association when the object changes" do
+    should_publish(:active_record, :update, "BlogPost", anything, anything)
+    should_publish(:changes, "ActiveRecord", "BlogPost", @post.id, "person_id")
+    should_publish(:changes, "ActiveRecord", "BlogPost", @post.id, "person")
+    should_publish(:changes, "ActiveRecord", "Person", @impostor.id, "blog_posts")
+    should_publish(:changes, "ActiveRecord", "Person", @person.id, "blog_posts")
+    @post.update_attribute(:person, @impostor)
+  end
+  
+  it "publishes a message when a has_many collection gains a member" do
+    should_publish(:active_record, :create, "BlogPost", anything)
+    should_publish(:changes, "ActiveRecord", "Person", @person.id, "blog_posts")
+    BlogPost.create(:person => @person, :title => "How to make a time machine")
+  end
+  
+  it "publishes a message when a has_many collection loses a member" do
+    should_publish(:active_record, :destroy, "BlogPost", anything)
+    should_publish(:changes, "ActiveRecord", "BlogPost", @post.id, "id")
+    should_publish(:changes, "ActiveRecord", "BlogPost", @post.id, "person_id")
+    should_publish(:changes, "ActiveRecord", "BlogPost", @post.id, "title")
+    should_publish(:changes, "ActiveRecord", "BlogPost", @post.id, "person")
+    should_publish(:changes, "ActiveRecord", "Person", @person.id, "blog_posts")
+    @post.destroy
+  end
+  
+  it "publishes a message when an object is pushed to a has_many :through has_many" do
+    should_publish(:active_record, :create, "Performance", anything)
+    should_publish(:changes, "ActiveRecord", "Concert", @concert.id, "performances")
+    should_publish(:changes, "ActiveRecord", "Artist", @artist.id, "performances")
+    should_publish(:changes, "ActiveRecord", "Artist", @artist.id, "concerts")
+    @artist.concerts << @concert
+  end
+  
+  it "publishes a message when a join object is pushed to a has_many :through has_many" do
+    should_publish(:active_record, :create, "Performance", anything)
+    should_publish(:changes, "ActiveRecord", "Concert", @concert.id, "performances")
+    should_publish(:changes, "ActiveRecord", "Artist", @artist.id, "performances")
+    should_publish(:changes, "ActiveRecord", "Artist", @artist.id, "concerts")
+    @artist.performances << Performance.new(:concert => @concert)
+  end
+  
+  it "publishes a message when a join object is created for has_many :through has_many" do
+    should_publish(:active_record, :create, "Performance", anything)
+    should_publish(:changes, "ActiveRecord", "Concert", @concert.id, "performances")
+    should_publish(:changes, "ActiveRecord", "Artist", @artist.id, "performances")
+    should_publish(:changes, "ActiveRecord", "Artist", @artist.id, "concerts")
+    Performance.create(:concert => @concert, :artist => @artist)
+  end
+  
+  it "publishes messages when a join object is deleted from a has_many :through has_many collection" do
+    @performance = @festival.performances.first
+    should_publish(:active_record, :destroy, "Performance", anything)
+    should_publish(:changes, "ActiveRecord", "Performance", @performance.id, "artist_id")
+    should_publish(:changes, "ActiveRecord", "Performance", @performance.id, "artist")
+    should_publish(:changes, "ActiveRecord", "Performance", @performance.id, "concert_id")
+    should_publish(:changes, "ActiveRecord", "Performance", @performance.id, "concert")
+    should_publish(:changes, "ActiveRecord", "Performance", @performance.id, "id")
+    should_publish(:changes, "ActiveRecord", "Artist", @artist.id, "performances")
+    should_publish(:changes, "ActiveRecord", "Artist", @artist.id, "concerts")
+    should_publish(:changes, "ActiveRecord", "Concert", @festival.id, "performances")
+    @artist.performances.first.destroy
+  end
+  
+  it "publishes messages when a member is deleted from a has_many :through has_many collection" do
+    @performance = @festival.performances.first
+    should_publish(:active_record, :destroy, "Performance", anything)
+    should_publish(:changes, "ActiveRecord", "Performance", @performance.id, "artist_id")
+    should_publish(:changes, "ActiveRecord", "Performance", @performance.id, "artist")
+    should_publish(:changes, "ActiveRecord", "Artist", @artist.id, "performances")
+    should_publish(:changes, "ActiveRecord", "Artist", @artist.id, "concerts")
+    should_publish(:changes, "ActiveRecord", "Performance", @performance.id, "concert_id")
+    should_publish(:changes, "ActiveRecord", "Performance", @performance.id, "concert")
+    should_publish(:changes, "ActiveRecord", "Concert", @festival.id, "performances")
+    should_publish(:changes, "ActiveRecord", "Performance", @performance.id, "id")
+    should_publish(:active_record, :destroy, "Concert", anything)
+    should_publish(:changes, "ActiveRecord", "Concert", @festival.id, "id")
+    should_publish(:changes, "ActiveRecord", "Concert", @festival.id, "calendar_id")
+    should_publish(:changes, "ActiveRecord", "Concert", @festival.id, "calendar")
+    should_publish(:changes, "ActiveRecord", "Concert", @festival.id, "date")
+    should_publish(:changes, "ActiveRecord", "Concert", @festival.id, "venue")
+    @artist.concerts.first.destroy
+  end
+  
+  it "publishes messages when a join object is pushed to a has_many :through belongs_to" do
+    should_publish(:active_record, :update, "Concert", anything, anything)
+    should_publish(:changes, "ActiveRecord", "Concert", @concert.id, "calendar_id")
+    should_publish(:changes, "ActiveRecord", "Concert", @concert.id, "calendar")
+    should_publish(:changes, "ActiveRecord", "Calendar", @calendar.id, "gigs")
+    should_publish(:changes, "ActiveRecord", "Artist", @artist.id, "upcoming_gigs")
+    @calendar.gigs << @concert
+  end
+  
+  it "publishes messages when a join object is removed from a has_many :through belongs_to" do
+    @calendar.gigs << @festival
+    should_publish(:active_record, :update, "Concert", anything, anything)
+    should_publish(:changes, "ActiveRecord", "Concert", @festival.id, "calendar_id")
+    should_publish(:changes, "ActiveRecord", "Concert", @festival.id, "calendar")
+    should_publish(:changes, "ActiveRecord", "Calendar", @calendar.id, "gigs")
+    should_publish(:changes, "ActiveRecord", "Artist", @artist.id, "upcoming_gigs")
+    @festival.calendar = nil
+    @festival.save
+  end
+end
+

data/spec/primer/watcher_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Primer::Watcher do
+  let(:watchable) { Watchable.new("Aaron") }
+  
+  describe "#primer_identifier" do
+    it "returns a tuple that tells us enough to find the object" do
+      watchable.primer_identifier.should == ["Object", "Watchable", watchable.object_id]
+    end
+  end
+  
+  describe "with watching disabled" do
+    before { Primer::Watcher.disable! }
+    
+    it "lets methods run as usual" do
+      watchable.name.should == "Aaron"
+    end
+    
+    it "does not log method calls" do
+      watchable.name
+      Primer::Watcher.call_log.should be_empty
+    end
+  end
+  
+  describe "with watching enabled" do
+    before { Primer::Watcher.enable! }
+    
+    it "lets methods return their usual return values" do
+      watchable.name.should == "Aaron"
+    end
+    
+    it "logs the monitored method calls" do
+      watchable.name
+      Primer::Watcher.call_log.should == [[watchable, :name, [], nil, "Aaron"]]
+    end
+    
+    it "logs arguments given to methods" do
+      watchable.is_called?("Aaron")
+      watchable.is_called?("Abe")
+      Primer::Watcher.call_log.should == [
+        [watchable, :is_called?, ["Aaron"], nil, true ],
+        [watchable, :is_called?, ["Abe"],   nil, false]
+      ]
+    end
+    
+    it "logs blocks passed to methods" do
+      block = lambda {}
+      watchable.name(&block)
+      Primer::Watcher.call_log.should == [[watchable, :name, [], block, "Aaron"]]
+    end
+    
+    it "does not log after you disable the watcher" do
+      Primer::Watcher.disable!
+      watchable.name.should == "Aaron"
+      watchable.is_called?("Aaron").should be_true
+      watchable.is_called?("Abe").should be_false
+      Primer::Watcher.call_log.should be_empty
+    end
+  end
+  
+  describe ".watching" do
+    it "returns the value of the block" do
+      Primer::Watcher.watching { watchable.name }.should == "Aaron"
+    end
+    
+    it "logs calls during the block to a list you supply" do
+      calls = []
+      Primer::Watcher.watching(calls) { watchable.name }
+      calls.should == [[watchable, :name, [], nil, "Aaron"]]
+    end
+    
+    it "does not log calls outside of the block" do
+      Primer::Watcher.watching { watchable.name }
+      watchable.name
+      Primer::Watcher.call_log.should == [[watchable, :name, [], nil, "Aaron"]]
+    end
+    
+    it "allows nested blocks to just capture specific scopes" do
+      block = lambda {}
+      
+      all_calls, inner_calls = [], []
+      Primer::Watcher.watching(all_calls) do
+        watchable.name
+        Primer::Watcher.watching(inner_calls) do
+          watchable.is_called?("Abe")
+        end
+        watchable.is_called?("Aaron", &block)
+      end
+      
+      all_calls.should == [
+        [watchable, :name,       [],        nil,   "Aaron"],
+        [watchable, :is_called?, ["Abe"],   nil,   false  ],
+        [watchable, :is_called?, ["Aaron"], block, true   ]
+      ]
+      inner_calls.should == [
+        [watchable, :is_called?, ["Abe"],   nil,   false  ]
+      ]
+    end
+  end
+end
+

data/spec/schema.rb

@@ -0,0 +1,31 @@
+ActiveRecord::Schema.define do |version|
+  create_table :artists, :force => true do |t|
+    t.belongs_to :calendar
+    t.string :name
+  end
+  
+  create_table :calendars, :force => true do |t|
+  end
+  
+  create_table :concerts, :force => true do |t|
+    t.belongs_to :calendar
+    t.date :date
+    t.string :venue
+  end
+  
+  create_table :performances, :force => true do |t|
+    t.belongs_to :artist
+    t.belongs_to :concert
+  end
+  
+  create_table :blog_posts, :force => true do |t|
+    t.belongs_to :person
+    t.string :title
+  end
+  
+  create_table :people, :force => true do |t|
+    t.string  :name
+    t.integer :age
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,60 @@
+dir = File.expand_path(File.dirname(__FILE__))
+$:.unshift(dir)
+
+require dir + '/../lib/primer'
+require 'tilt'
+require 'erb'
+require 'action_controller'
+
+require 'fileutils'
+require 'active_record'
+FileUtils.mkdir_p(dir + '/db')
+ActiveRecord::Base.establish_connection(
+  :adapter  => 'sqlite3',
+  :database => dir + '/db/test.sqlite3')
+
+require 'schema'
+
+require 'models/watchable'
+require 'models/artist'
+require 'models/calendar'
+require 'models/concert'
+require 'models/performance'
+require 'models/blog_post'
+require 'models/person'
+
+module Helper
+  def self.next_id
+    @next_id ||= 0
+    @next_id += 1
+    @next_id
+  end
+end
+
+RSpec.configure do |config|
+  config.before do
+    Primer::Watcher.disable!
+    Primer.bus = Primer::Bus::Memory.new
+    Primer.cache = nil
+    Primer.real_time = false
+  end
+  
+  config.after do
+    if Primer.cache
+      Primer.cache.clear
+      Primer.cache.routes = nil
+    end
+    Primer::Watcher.reset!
+    Primer.bus.unsubscribe_all
+    
+    [ BlogPost,
+      Person,
+      Artist,
+      Calendar,
+      Concert,
+      Performance
+      
+    ].each { |m| m.delete_all }
+  end
+end
+

data/spec/templates/page.erb

@@ -0,0 +1,3 @@
+Welcome, <%= primer '/user' %>
+<% primer '/cache/key' do %>Hello, <%= name %><% end %>
+Thanks

metadata

@@ -0,0 +1,235 @@
+--- !ruby/object:Gem::Specification 
+name: primer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- James Coglan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-25 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: redis
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 1
+        version: 2.1.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: amqp
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 7
+        version: 0.6.7
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: faye
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        version: "0.5"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: tilt
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+description: 
+email: jcoglan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- example/README.rdoc
+files: 
+- README.rdoc
+- spec/spec_helper.rb
+- spec/primer/bus_spec.rb
+- spec/primer/watcher_spec.rb
+- spec/primer/helpers/erb_spec.rb
+- spec/primer/watcher/active_record_spec.rb
+- spec/primer/cache_spec.rb
+- spec/templates/page.erb
+- spec/schema.rb
+- spec/models/calendar.rb
+- spec/models/blog_post.rb
+- spec/models/watchable.rb
+- spec/models/performance.rb
+- spec/models/artist.rb
+- spec/models/person.rb
+- spec/models/concert.rb
+- lib/javascript/primer.js
+- lib/primer/enabler.rb
+- lib/primer/cache/memory.rb
+- lib/primer/cache/redis.rb
+- lib/primer/real_time.rb
+- lib/primer/watcher.rb
+- lib/primer/route_set.rb
+- lib/primer/worker/active_record_agent.rb
+- lib/primer/bus/memory.rb
+- lib/primer/bus/amqp.rb
+- lib/primer/worker.rb
+- lib/primer/bus.rb
+- lib/primer/watcher/active_record_macros.rb
+- lib/primer/watcher/macros.rb
+- lib/primer/cache.rb
+- lib/primer/helpers.rb
+- lib/primer.rb
+- example/application.rb
+- example/config.ru
+- example/README.rdoc
+- example/script/setup_database.rb
+- example/public/style.css
+- example/worker.rb
+- example/environment.rb
+- example/views/show.erb
+- example/views/layout.erb
+- example/views/index.erb
+- example/models/blog_post.rb
+- example/models/connection.rb
+has_rdoc: true
+homepage: http://github.com/jcoglan/primer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --title
+- Primer
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Intelligent caching, no observers necessary
+test_files: []
+