mongo_watchable 0.0.0.pre1

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 Jonathan Bell
+ 
+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/Rakefile

@@ -0,0 +1,34 @@
+begin
+  GEM = "mongo_watchable"
+  AUTHOR = "Jonathan Bell"
+  EMAIL = "jonbell@spamcop.net"
+  SUMMARY = "A ruby gem for adding watching to mongo documents."
+  HOMEPAGE = "http://github.com/jonbell/mongo_watchable"
+  
+  gem 'jeweler', '>= 1.0.0'
+  require 'jeweler'
+  
+  Jeweler::Tasks.new do |s|
+    s.name = GEM
+    s.summary = SUMMARY
+    s.email = EMAIL
+    s.homepage = HOMEPAGE
+    s.description = SUMMARY
+    s.author = AUTHOR
+    
+    s.require_path = 'lib'
+    s.files = %w(MIT-LICENSE README.textile Rakefile) + Dir.glob("{rails,lib,generators,spec}/**/*")
+    
+    # Runtime dependencies: When installing Formtastic these will be checked if they are installed.
+    # Will be offered to install these if they are not already installed.
+    s.add_dependency 'mongo_mapper', '>= 0.7.0'
+    
+    # Development dependencies. Not installed by default.
+    # Install with: sudo gem install formtastic --development
+    #s.add_development_dependency 'rspec-rails', '>= 1.2.6'
+  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

data/lib/mongo_watchable/proxy.rb

@@ -0,0 +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)
+    end
+    
+    def array
+      model.send(array_key)
+    end
+  end
+end

data/lib/mongo_watchable/watchable.rb

@@ -0,0 +1,34 @@
+module MongoWatchable
+  module Watchable
+    def self.included(watchable)
+      watchable.class_eval do
+        MongoWatchable.watchers.each do |watcher|
+          key :"#{watcher.name.underscore}_watcher_ids", Array
+          
+          define_method :"#{watcher.name.underscore}_watchers" do
+            MongoWatchable::Proxy.new(self, :"#{watcher.name.underscore}_watcher_ids", watcher)
+          end
+        end
+      end
+      
+      MongoWatchable.watchers.each do |watcher|
+        watcher.class_eval do
+          key :"#{watchable.name.underscore}_watching_ids", Array
+          
+          define_method :"#{watchable.name.underscore}_watchings" do
+            MongoWatchable::Proxy.new(self, :"#{watchable.name.underscore}_watching_ids", watchable)
+          end
+        end
+      end
+      MongoWatchable.watchables << watchable
+    end
+  
+    def watchers_proxy_for(watcher)
+      klass = watcher.class
+      while klass.superclass && klass.superclass.include?(MongoWatchable::Watcher)
+        klass = klass.superclass
+      end
+      send("#{klass.name.underscore}_watchers")
+    end
+  end
+end

data/lib/mongo_watchable/watcher.rb

@@ -0,0 +1,95 @@
+module MongoWatchable
+  module Watcher
+    def self.included(watcher)
+      watcher.class_eval do
+        MongoWatchable.watchables do |watchable|
+          key :"#{watchable.name.underscore}_watching_ids", Array
+          
+          define_method :"#{watchable.name.underscore}_watchings" do
+            MongoWatchable::Proxy.new(self, :"#{watchable.name.underscore}_watching_ids", watchable)
+          end
+        end
+      end
+      
+      MongoWatchable.watchables.each do |watchable|
+        watchable.class_eval do
+          key :"#{watcher.name.underscore}_watcher_ids", Array
+          
+          define_method :"#{watcher.name.underscore}_watchers" do
+            MongoWatchable::Proxy.new(self, :"#{watcher.name.underscore}_watcher_ids", watcher)
+          end
+        end
+      end
+      
+      MongoWatchable.watchers << watcher
+    end
+    
+    def watch(watchable)
+      unless watching?(watchable)
+        watchings_proxy_for(watchable) << watchable
+        watchable.watchers_proxy_for(self) << self
+        save if watchable.save
+      end
+    end
+    
+    def watch!(watchable)
+      raise "#{self.class.name} is already watching #{watchable.class.name}" if watching?(watchable)
+      watchings_proxy_for(watchable) << watchable
+      watchable.watchers_proxy_for(self) << self
+      watchable.save!
+      self.save!
+    end
+    
+    def watching?(watchable)
+      watching_ids_for(watchable).include?(watchable.id)
+    end
+    
+    def unwatch(watchable)
+      if watching?(watchable)
+        watchings_proxy_for(watchable).delete watchable
+        watchable.watchers_proxy_for(self).delete self
+        save if watchable.save
+      end
+    end
+    
+    def unwatch!(watchable)
+      raise "#{self.class.name} is not watching #{watchable.class.name}" unless watching?(watchable)
+      watchings_proxy_for(watchable).delete watchable
+      watchable.watchers_proxy_for(self).delete self
+      watchable.save!
+      self.save!
+    end
+    
+    def watching_ids_for(watchable)
+      klass = watchable.class
+      while klass.superclass && klass.superclass.include?(MongoWatchable::Watchable)
+        klass = klass.superclass
+      end
+      send("#{klass.name.underscore}_watching_ids")
+    end
+    
+    def watchings_proxy_for(watchable)
+      klass = watchable.class
+      while klass.superclass && klass.superclass.include?(MongoWatchable::Watchable)
+        klass = klass.superclass
+      end
+      send("#{klass.name.underscore}_watchings")
+    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)
+        klass = klass.superclass
+      end
+      klass
+    end
+  end
+end

data/lib/mongo_watchable.rb

@@ -0,0 +1,13 @@
+require 'mongo_watchable/proxy'
+require 'mongo_watchable/watcher'
+require 'mongo_watchable/watchable'
+
+module MongoWatchable
+  def self.watchables
+    @watchables ||= []
+  end
+  
+  def self.watchers
+    @watchers ||= []
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'active_support'
+
+require 'active_support/test_case'
+require 'test/unit'
+
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+env_rb = File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+if File.exists? env_rb
+  require env_rb
+else
+  require 'mongo_mapper'
+  $LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
+  require 'mongo_watchable'
+  config = {'test' => {'database' => 'mongo_watchable-test'}}
+  MongoMapper.setup(config, 'test')
+end
+
+class ActiveSupport::TestCase
+  # Drop all columns after each test case.
+  def teardown
+    MongoMapper.database.collections.each do |coll|
+      coll.drop  
+    end
+  end
+ 
+  # Make sure that each test case has a teardown
+  # method to clear the db after each test.
+  def inherited(base)
+    base.define_method teardown do 
+      super
+    end
+  end
+end
+
+# kinda weird, but we have to do this so we can ignore the app's User class and use our own for testing
+Object.send(:remove_const, :User) if Object.const_defined?(:User)
+
+class User
+  include MongoMapper::Document
+  include MongoWatchable::Watcher
+  key :name, String
+end
+
+class Widget
+  include MongoMapper::Document  
+  include MongoWatchable::Watchable
+  key :name, String
+end
+

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: mongo_watchable
+version: !ruby/object:Gem::Version 
+  prerelease: true
+  segments: 
+  - 0
+  - 0
+  - 0
+  - pre1
+  version: 0.0.0.pre1
+platform: ruby
+authors: 
+- Jonathan Bell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-22 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo_mapper
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        - 0
+        version: 0.7.0
+  type: :runtime
+  version_requirements: *id001
+description: A ruby gem for adding watching to mongo documents.
+email: jonbell@spamcop.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- MIT-LICENSE
+- Rakefile
+- lib/mongo_watchable.rb
+- lib/mongo_watchable/proxy.rb
+- lib/mongo_watchable/watchable.rb
+- lib/mongo_watchable/watcher.rb
+has_rdoc: true
+homepage: http://github.com/jonbell/mongo_watchable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A ruby gem for adding watching to mongo documents.
+test_files: 
+- test/test_helper.rb