mongoid_ext 0.6.1

data/lib/mongoid_ext/voteable.rb

@@ -0,0 +1,104 @@
+module MongoidExt
+  module Voteable
+    extend ActiveSupport::Concern
+
+    included do
+      field :votes_count, :type => Integer, :default => 0
+      field :votes_average, :type => Integer, :default => 0
+      field :votes_up, :type => Integer, :default => 0
+      field :votes_down, :type => Integer, :default => 0
+
+      field :votes, :type => Hash, :default => {}
+    end
+
+    def voted?(voter_id)
+      if self[:votes] && !self[:votes].empty?
+        self[:votes].include?(voter_id)
+      else
+        self.class.exists?(:conditions => {:_id => self.id, :"votes.#{voter_id}".exists => true})
+      end
+    end
+
+    def vote!(value, voter_id, &block)
+      old_vote = self.votes[voter_id]
+      if !old_vote
+        self.votes[voter_id] = value
+        self.save(:validate => false)
+
+        add_vote!(value, voter_id, &block)
+        return :created
+      else
+        if(old_vote != value)
+          self.votes[voter_id] = value
+          self.save
+          self.remove_vote!(old_vote, voter_id, &block)
+          self.add_vote!(value, voter_id, &block)
+
+          return :updated
+        else
+          self.votes.delete(voter_id)
+          self.save(:validate => false)
+          remove_vote!(value, voter_id, &block)
+          return :destroyed
+        end
+      end
+    end
+
+    def add_vote!(value, voter_id, &block)
+      if embedded?
+        updates = {self._position+".votes_count" => 1,
+                   self._position+".votes_average" => value.to_i}
+        if value == 1
+          updates[self._position+".votes_up"] = 1
+        elsif value == -1
+          updates[self._position+".votes_down"] = 1
+        end
+
+        self._parent.increment(updates)
+      else
+        updates = {:votes_count => 1, :votes_average => value.to_i}
+        if value == 1
+          updates[:votes_up] = 1
+        elsif value == -1
+          updates[:votes_down] = 1
+        end
+
+        self.increment(updates)
+      end
+
+      block.call(value, :add) if block
+
+      self.on_add_vote(value, voter_id) if self.respond_to?(:on_add_vote)
+    end
+
+    def remove_vote!(value, voter_id, &block)
+      if embedded?
+        updates = {self._position+".votes_count" => -1,
+                   self._position+".votes_average" => -value.to_i}
+        if value == 1
+          updates[self._position+".votes_up"] = -1
+        elsif value == -1
+          updates[self._position+".votes_down"] = -1
+        end
+
+        self._parent.increment(updates)
+      else
+        updates = {:votes_count => -1, :votes_average => -value}
+        if value == 1
+          updates[:votes_up] = -1
+        elsif value == -1
+          updates[:votes_down] = -1
+        end
+
+        self.increment(updates)
+      end
+
+      block.call(value, :remove) if block
+
+      self.on_remove_vote(value, voter_id) if self.respond_to?(:on_remove_vote)
+    end
+
+    module ClassMethods
+    end
+  end
+end

data/mongoid_ext.gemspec

@@ -0,0 +1,129 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{mongoid_ext}
+  s.version = "0.6.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["David A. Cuadrado"]
+  s.date = %q{2011-06-25}
+  s.default_executable = %q{mongoid_console}
+  s.description = %q{mongoid plugins}
+  s.email = %q{krawek@gmail.com}
+  s.executables = ["mongoid_console"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/mongoid_console",
+    "lib/mongoid_ext.rb",
+    "lib/mongoid_ext/criteria_ext.rb",
+    "lib/mongoid_ext/document_ext.rb",
+    "lib/mongoid_ext/file.rb",
+    "lib/mongoid_ext/file_list.rb",
+    "lib/mongoid_ext/file_server.rb",
+    "lib/mongoid_ext/filter.rb",
+    "lib/mongoid_ext/filter/parser.rb",
+    "lib/mongoid_ext/filter/result_set.rb",
+    "lib/mongoid_ext/js/filter.js",
+    "lib/mongoid_ext/js/find_tags.js",
+    "lib/mongoid_ext/js/tag_cloud.js",
+    "lib/mongoid_ext/modifiers.rb",
+    "lib/mongoid_ext/mongo_mapper.rb",
+    "lib/mongoid_ext/paranoia.rb",
+    "lib/mongoid_ext/patches.rb",
+    "lib/mongoid_ext/random.rb",
+    "lib/mongoid_ext/slugizer.rb",
+    "lib/mongoid_ext/storage.rb",
+    "lib/mongoid_ext/tags.rb",
+    "lib/mongoid_ext/types/embedded_hash.rb",
+    "lib/mongoid_ext/types/open_struct.rb",
+    "lib/mongoid_ext/types/timestamp.rb",
+    "lib/mongoid_ext/types/translation.rb",
+    "lib/mongoid_ext/update.rb",
+    "lib/mongoid_ext/versioning.rb",
+    "lib/mongoid_ext/voteable.rb",
+    "mongoid_ext.gemspec",
+    "test/helper.rb",
+    "test/models.rb",
+    "test/support/custom_matchers.rb",
+    "test/test_filter.rb",
+    "test/test_modifiers.rb",
+    "test/test_paranoia.rb",
+    "test/test_random.rb",
+    "test/test_slugizer.rb",
+    "test/test_storage.rb",
+    "test/test_tags.rb",
+    "test/test_update.rb",
+    "test/test_versioning.rb",
+    "test/test_voteable.rb",
+    "test/types/test_open_struct.rb",
+    "test/types/test_set.rb",
+    "test/types/test_timestamp.rb"
+  ]
+  s.homepage = %q{http://github.com/dcu/mongoid_ext}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{mongoid plugins}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongoid>, ["~> 2"])
+      s.add_runtime_dependency(%q<uuidtools>, [">= 2.1.1"])
+      s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_runtime_dependency(%q<tzinfo>, [">= 0"])
+      s.add_runtime_dependency(%q<differ>, [">= 0.1.2"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<shoulda>, ["~> 2.11.3"])
+      s.add_development_dependency(%q<jnunemaker-matchy>, ["~> 0.4"])
+      s.add_development_dependency(%q<shoulda>, ["~> 2.11.3"])
+      s.add_development_dependency(%q<mocha>, ["~> 0.9.4"])
+      s.add_development_dependency(%q<timecop>, [">= 0"])
+    else
+      s.add_dependency(%q<mongoid>, ["~> 2"])
+      s.add_dependency(%q<uuidtools>, [">= 2.1.1"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<tzinfo>, [">= 0"])
+      s.add_dependency(%q<differ>, [">= 0.1.2"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<shoulda>, ["~> 2.11.3"])
+      s.add_dependency(%q<jnunemaker-matchy>, ["~> 0.4"])
+      s.add_dependency(%q<shoulda>, ["~> 2.11.3"])
+      s.add_dependency(%q<mocha>, ["~> 0.9.4"])
+      s.add_dependency(%q<timecop>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mongoid>, ["~> 2"])
+    s.add_dependency(%q<uuidtools>, [">= 2.1.1"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<tzinfo>, [">= 0"])
+    s.add_dependency(%q<differ>, [">= 0.1.2"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<shoulda>, ["~> 2.11.3"])
+    s.add_dependency(%q<jnunemaker-matchy>, ["~> 0.4"])
+    s.add_dependency(%q<shoulda>, ["~> 2.11.3"])
+    s.add_dependency(%q<mocha>, ["~> 0.9.4"])
+    s.add_dependency(%q<timecop>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+
+gem 'jnunemaker-matchy'
+
+require 'matchy'
+require 'shoulda'
+require 'timecop'
+require 'mocha'
+require 'pp'
+
+require 'support/custom_matchers'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'mongoid_ext'
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db("test")
+end
+
+require 'models'
+
+class Test::Unit::TestCase
+  include CustomMatchers
+end
+
+MongoidExt.init
+
+$VERBOSE=nil

data/test/models.rb

@@ -0,0 +1,80 @@
+
+class Event # for safe_update, and Timestamp
+  include Mongoid::Document
+
+  field :start_date, :type => Timestamp
+  field :end_date, :type => Timestamp
+
+  field :password, :type => String
+end
+
+class Recipe # for Set
+  include Mongoid::Document
+  include MongoidExt::Filter
+
+  language Proc.new { |d| d.language }
+  filterable_keys :language
+
+  field :ingredients, :type => Set
+  field :description, :type => String
+  field :language, :type => String, :default => 'en'
+end
+
+class Avatar # for Storage and File
+  include Mongoid::Document
+  include MongoidExt::Storage
+
+  file_key :data
+
+  file_list :alternatives
+  file_key :first_alternative, :in => :alternatives
+end
+
+class UserConfig #for OpenStruct
+  include Mongoid::Document
+  field :entries, :type => OpenStruct
+end
+
+class User
+  include Mongoid::Document
+  include MongoidExt::Paranoia
+  include MongoidExt::Voteable
+
+  field :login
+  field :email
+end
+
+class BlogPost # for Slug and Filter
+  include Mongoid::Document
+  include MongoidExt::Filter
+  include MongoidExt::Slugizer
+  include MongoidExt::Tags
+  include MongoidExt::Versioning
+
+  filterable_keys :title, :body, :tags, :date
+  slug_key :title, :max_length => 18, :min_length => 3, :callback_type => :before_validation, :add_prefix => true
+  language :find_language
+
+  field :title, :type => String
+  field :body, :type => String
+  field :tags, :type => Array
+  field :date, :type => Time
+
+  referenced_in :updated_by, :class_name => "User"
+
+  versionable_keys :title, :body, :tags, :owner_field => "updated_by_id", :max_versions => 2
+
+  def find_language
+    'en'
+  end
+end
+
+class Entry
+  include Mongoid::Document
+  include MongoidExt::Random
+
+  field :v, :type => Integer
+  field :a, :type => Array
+end
+Entry.delete_all
+100.times {|v| Entry.create(:v => v)}

data/test/support/custom_matchers.rb

@@ -0,0 +1,55 @@
+module CustomMatchers
+  custom_matcher :be_nil do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected #{receiver} to be nil but it wasn't"
+    matcher.negative_failure_message = "Expected #{receiver} not to be nil but it was"
+    receiver.nil?
+  end
+  
+  custom_matcher :be_blank do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected #{receiver} to be blank but it wasn't"
+    matcher.negative_failure_message = "Expected #{receiver} not to be blank but it was"
+    receiver.blank?
+  end
+  
+  custom_matcher :be_true do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected #{receiver} to be true but it wasn't"
+    matcher.negative_failure_message = "Expected #{receiver} not to be true but it was"
+    receiver.eql?(true)
+  end
+  
+  custom_matcher :be_false do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected #{receiver} to be false but it wasn't"
+    matcher.negative_failure_message = "Expected #{receiver} not to be false but it was"
+    receiver.eql?(false)
+  end
+
+  custom_matcher :be_valid do |receiver, matcher, args|
+    matcher.positive_failure_message = "Expected to be valid but it was invalid #{receiver.errors.inspect}"
+    matcher.negative_failure_message = "Expected to be invalid but it was valid #{receiver.errors.inspect}"
+    receiver.valid?
+  end
+
+  custom_matcher :have_error_on do |receiver, matcher, args|
+    receiver.valid?
+    attribute = args[0]
+    expected_message = args[1]
+    
+    if expected_message.nil?
+      matcher.positive_failure_message = "#{receiver} had no errors on #{attribute}"
+      matcher.negative_failure_message = "#{receiver} had errors on #{attribute} #{receiver.errors.inspect}"
+      !receiver.errors.on(attribute).blank?
+    else
+      actual = receiver.errors.on(attribute)
+      matcher.positive_failure_message = %Q(Expected error on #{attribute} to be "#{expected_message}" but was "#{actual}")
+      matcher.negative_failure_message = %Q(Expected error on #{attribute} not to be "#{expected_message}" but was "#{actual}")
+      actual == expected_message
+    end
+  end
+  
+  custom_matcher :have_index do |receiver, matcher, args|
+    index_name = args[0]
+    matcher.positive_failure_message = "#{receiver} does not have index named #{index_name}, but should"
+    matcher.negative_failure_message = "#{receiver} does have index named #{index_name}, but should not"
+    !receiver.collection.index_information.detect { |index| index[0] == index_name }.nil?
+  end
+end

data/test/test_filter.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+require 'helper'
+
+class TestFilter < Test::Unit::TestCase
+  context "filtering data" do
+    setup do
+      BlogPost.delete_all
+      @blogpost = BlogPost.create!(:title => "%How dOEs tHIs Work?!",
+                                   :body => "HeRe is tHe Body of the bLog pOsT",
+                                   :tags => ["my", "list", "of", "tags"])
+      @entradablog = BlogPost.create!(:title => "sobre las piña",
+                                      :body => "la piña no es un árbol",
+                                      :tags => ["frutas"])
+    end
+
+    should "be case insensitive" do
+      BlogPost.filter("body").should == [@blogpost]
+    end
+
+    should "be able to find by title" do
+      BlogPost.filter("this").should == [@blogpost]
+    end
+
+    should "be able to find by body" do
+      BlogPost.filter("blog").should == [@blogpost]
+    end
+
+    should "be able to find by tags" do
+      BlogPost.filter("list").should == [@blogpost]
+    end
+
+    should "be able to find by title or body" do
+      BlogPost.filter("work blog").should == [@blogpost]
+    end
+
+    should "ignore inexistant words" do
+      BlogPost.filter("work lalala").should == [@blogpost]
+    end
+
+    should "normalize the text" do
+      BlogPost.filter("pina").should == [@entradablog]
+      BlogPost.filter("arbol").should == [@entradablog]
+    end
+
+    should "allow to paginate results" do
+      results = BlogPost.filter("tag", :per_page => 1, :page => 1)
+      results.should == [@blogpost]
+      results.total_pages.should == 1
+    end
+  end
+end