mongo_watchable 0.1.0 → 0.1.1

data/README.markdown

@@ -0,0 +1,56 @@
+MongoWatchable
+==============
+
+A simple many-to-many assocation between watchers and watchables for mongodb.
+
+Requirements
+------------
+
+- MongoDB
+- MongoMapper
+
+Installation
+------------
+
+    sudo gem install mongo_watchable
+
+Simple Example
+--------------
+
+    class User
+      include MongoMapper::Document
+      include MongoWatchable::Watcher
+    end
+    
+    class Widget
+      include MongoMapper::Document
+      include MongoWatchable::Watchable
+    end
+    
+To watch it:
+
+    user.watch(widget)
+
+Check if user is watching a widget:
+
+    user.watching?(widget)
+
+Return count of all widgets a user is watching:
+
+    user.widget_watchings.count
+
+Return all widgets a user is watching:
+
+    user.widget_watchings
+
+Return all users watching widget:
+
+    widget.user_watchers
+
+Return count of all users watching widget:
+
+    widget.user_watchers.count
+
+Unwatch a widget
+
+    user.unwatch(widget)

data/Rakefile

@@ -1,3 +1,10 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
 begin
   GEM = "mongo_watchable"
   AUTHOR = "Jonathan Bell"
@@ -26,9 +33,27 @@ begin
     # Development dependencies. Not installed by default.
     # Install with: sudo gem install formtastic --development
     #s.add_development_dependency 'rspec-rails', '>= 1.2.6'
+    s.add_development_dependency 'shoulda', '>= 2.10.0'
   end
   
   Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "[mongo_watchable:] Jeweler - or one of its dependencies - is not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end
+
+desc 'Test the mongo_watchable plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the mongo_watchable plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Mongo Watchable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/lib/mongo_watchable/proxy.rb

@@ -1,63 +1,67 @@
 module MongoWatchable
   class Proxy
-      attr_reader :array_key
-      attr_reader :model
-      attr_reader :target_class
-      
-      def initialize(model, array_key, target_class)
-        @model, @array_key, @target_class = model, array_key, target_class
-      end
-      
-      def to_a
-        fetch_all.to_a
-      end
-      
-      def count
-        array.size
-      end
-      
-      def all(opts = {})
-        fetch_all
-      end
-      
-      def each(&block)
-        fetch_all.each {|entry| yield entry}
-      end
-      
-      def find(id)
-        return nil unless array.include?(id)
-        target_class.find(id)
-      end
-      
-      def first(opts = {})
-        return @first ||= target_class.find(array.first) if opts.empty?
-        target_class.first(opts.merge(:_id.in => array))
-      end
-      
-      def last(opts = {})
-        return @last ||= target_class.find(array.last) if opts.empty?
-        target_class.last(opts.merge(:_id.in => array))
-      end
-      
-      alias :size :count
-      
-      def << (entry)
-        array << entry.id
-        @fetch ? @fetch << entry : fetch_all
-      end
-      
-      def delete(entry)
-        array.delete entry.id
-        @fetch ? @fetch.delete(entry) : fetch_all
-      end
-      
-      def inspect
-        all.inspect
-      end
-      
-    private
-      def fetch_all
-        @fetch ||= target_class.find(array)
+    attr_reader :array_key
+    attr_reader :model
+    attr_reader :target_class
+    
+    def initialize(model, array_key, target_class)
+      @model, @array_key, @target_class = model, array_key, target_class
+    end
+    
+    def to_a
+      fetch_all.to_a
+    end
+    
+    def count
+      array.size
+    end
+    
+    def all(opts = {})
+      fetch_all
+    end
+    
+    def each(&block)
+      fetch_all.each {|entry| yield entry}
+    end
+    
+    def find(id)
+      return nil unless array.include?(id)
+      target_class.find(id)
+    end
+    
+    def first(opts = {})
+      return @first ||= target_class.find(array.first) if opts.empty?
+      target_class.first(opts.merge(:_id.in => array))
+    end
+    
+    def last(opts = {})
+      return @last ||= target_class.find(array.last) if opts.empty?
+      target_class.last(opts.merge(:_id.in => array))
+    end
+    
+    def empty?
+      array.empty?
+    end
+    
+    alias :size :count
+    
+    def << (entry)
+      array << entry.id
+      @fetch ? @fetch << entry : fetch_all
+    end
+    
+    def delete(entry)
+      array.delete entry.id
+      @fetch ? @fetch.delete(entry) : fetch_all
+    end
+    
+    def inspect
+      all.inspect
+    end
+    
+  private
+    def fetch_all
+      @fetch ||= target_class.find(array)
     end
     
     def array

data/lib/mongo_watchable/watcher.rb

@@ -77,13 +77,6 @@ module MongoWatchable
     end
   
   private
-  
-    def watch(watchable)
-      klass = watchable
-      while klass.superclass && klass.superclass.include?(MongoWatchable::Watchable)
-        klass = klass.superclass
-      end
-    end
     def root_watching_class(instance)
       klass = instance
       while klass.superclass && klass.superclass.include?(MongoWatchable::Watchable)

data/test/mongo_watchable_test.rb

@@ -0,0 +1,229 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class MongoWatchableTest < ActiveSupport::TestCase
+  
+  context "user unwatches non-watching widget with unwatch" do
+    setup do
+      @user = User.create!(:name => 'foo')
+      @widget = Widget.create!(:name => 'bar')
+        
+      @return = @user.unwatch(@widget)
+    end
+    
+    should "return with false" do
+      assert !@return
+    end
+  end
+  
+  context "user unwatches non-watching widget with unwatch!" do
+    setup do
+      @user = User.create!(:name => 'foo')
+      @widget = Widget.create!(:name => 'bar')
+    end
+    
+    should "throw standard error" do
+      assert_raises RuntimeError do
+        @user.unwatch!(@widget)
+      end
+    end
+  end
+  
+  context "user watching widget with watch" do
+    setup do
+      @user = User.create!(:name => 'foo')
+      @widget = Widget.create!(:name => 'bar')
+      
+      @return = @user.watch(@widget)
+      @user.reload
+      @widget.reload
+    end
+    
+    should "should only have 1 widget in widget_watchings array" do
+      assert_equal 1, @user.widget_watchings.size
+    end
+    
+    should "should have widget in widget watchings array" do
+      assert_equal @widget, @user.widget_watchings.first
+    end
+    
+    should "have only one watcher in widgets user_watchers array" do
+      assert_equal 1, @widget.user_watchers.size
+    end
+    
+    should "be the watcher in widgets user_watchers array" do
+      assert_equal @user, @widget.user_watchers.first
+    end
+    
+    should "return true for watching?" do
+      assert @user.watching?(@widget)
+    end
+    
+    should "return with true" do
+      assert @return
+    end
+    
+    context "and then watches widget again" do
+      setup do
+        @return = @user.watch(@widget)
+      end
+    
+      should "return with false" do
+        assert !@return
+      end
+    end
+    
+    context "and another widget" do
+      setup do
+        @widget2 = Widget.create!(:name => 'baz')
+        @return = @user.watch(@widget2)
+        @user.reload
+        @widget2.reload
+      end
+    
+      should "return with true" do
+        assert @return
+      end
+    
+      should "should only have 2 widgets in widget_watchings array" do
+        assert_equal 2, @user.widget_watchings.size
+      end
+      
+      should "should have widget in widget watchings array" do
+        assert_equal @widget, @user.widget_watchings.first
+      end
+      
+      should "should have widget2 in widget watchings array" do
+        assert_equal @widget2, @user.widget_watchings.last
+      end
+    
+      should "have only one watcher in widget's user_watchers array" do
+        assert_equal 1, @widget.user_watchers.size
+      end
+      
+      should "be the watcher in widget's user_watchers array" do
+        assert_equal @user, @widget.user_watchers.first
+      end
+    
+      should "have only one watcher in widget2's user_watchers array" do
+        assert_equal 1, @widget2.user_watchers.size
+      end
+      
+      should "be the watcher in widget2's user_watchers array" do
+        assert_equal @user, @widget2.user_watchers.first
+      end
+    end
+    
+    context "and then unwatched with unwatch" do
+      setup do
+        @return = @user.unwatch(@widget)
+        @user.reload
+        @widget.reload
+      end
+      
+      should "have no widgets in widget_watchings array" do
+        assert @user.widget_watchings.empty?
+      end
+      
+      should "have no user_watchers in widget" do
+        assert @widget.user_watchers.empty?
+      end
+    
+      should "return with true" do
+        assert @return
+      end
+    end
+  end
+  
+  context "user watching widget with watch!" do
+    setup do
+      @user = User.create!(:name => 'foo')
+      @widget = Widget.create!(:name => 'bar')
+      
+      @user.watch!(@widget)
+      @user.reload
+      @widget.reload
+    end
+    
+    should "should only have 1 widget in widget_watchings array" do
+      assert_equal 1, @user.widget_watchings.size
+    end
+    
+    should "should have widget in widget watchings array" do
+      assert_equal @widget, @user.widget_watchings.first
+    end
+    
+    should "have only one watcher in widgets user_watchers array" do
+      assert_equal 1, @widget.user_watchers.size
+    end
+    
+    should "be the watcher in widgets user_watchers array" do
+      assert_equal @user, @widget.user_watchers.first
+    end
+    
+    should "return true for watching?" do
+      assert @user.watching?(@widget)
+    end
+    
+    context "and another widget" do
+      setup do
+        @widget2 = Widget.create!(:name => 'baz')
+        @user.watch!(@widget2)
+        @user.reload
+        @widget2.reload
+      end
+    
+      should "should only have 2 widgets in widget_watchings array" do
+        assert_equal 2, @user.widget_watchings.size
+      end
+      
+      should "should have widget in widget watchings array" do
+        assert_equal @widget, @user.widget_watchings.first
+      end
+      
+      should "should have widget2 in widget watchings array" do
+        assert_equal @widget2, @user.widget_watchings.last
+      end
+    
+      should "have only one watcher in widget's user_watchers array" do
+        assert_equal 1, @widget.user_watchers.size
+      end
+      
+      should "be the watcher in widget's user_watchers array" do
+        assert_equal @user, @widget.user_watchers.first
+      end
+    
+      should "have only one watcher in widget2's user_watchers array" do
+        assert_equal 1, @widget2.user_watchers.size
+      end
+      
+      should "be the watcher in widget2's user_watchers array" do
+        assert_equal @user, @widget2.user_watchers.first
+      end
+    end
+    
+    context "and then watches widget again" do
+      should "raise RuntimeError" do
+        assert_raises RuntimeError do
+          @user.watch!(@widget)
+        end
+      end
+    end
+    
+    context "and then unwatched with unwatch!" do
+      setup do
+        @user.unwatch!(@widget)
+        @user.reload
+        @widget.reload
+      end
+      
+      should "have no widgets in widget_watchings array" do
+        assert @user.widget_watchings.empty?
+      end
+      
+      should "have no user_watchers in widget" do
+        assert @widget.user_watchers.empty?
+      end
+    end
+  end
+  
+end

data/test/test_helper.rb

@@ -3,6 +3,7 @@ require 'active_support'
 
 require 'active_support/test_case'
 require 'test/unit'
+require 'shoulda'
 
 ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
 env_rb = File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Jonathan Bell
@@ -31,14 +31,28 @@ dependencies:
         version: 0.7.0
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 10
+        - 0
+        version: 2.10.0
+  type: :development
+  version_requirements: *id002
 description: A ruby gem for adding watching to mongo documents.
 email: jonbell@spamcop.net
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.markdown
 files: 
 - MIT-LICENSE
 - Rakefile
@@ -46,6 +60,7 @@ files:
 - lib/mongo_watchable/proxy.rb
 - lib/mongo_watchable/watchable.rb
 - lib/mongo_watchable/watcher.rb
+- README.markdown
 has_rdoc: true
 homepage: http://github.com/jonbell/mongo_watchable
 licenses: []
@@ -77,4 +92,5 @@ signing_key:
 specification_version: 3
 summary: A ruby gem for adding watching to mongo documents.
 test_files: 
+- test/mongo_watchable_test.rb
 - test/test_helper.rb