mongo_followable 0.3.0 → 0.3.2

data/lib/mongo_followable/version.rb

@@ -1,3 +1,5 @@
-module MongoFollowable
-  VERSION = "0.3.0"
+module Mongo
+  module Followable
+    VERSION = "0.3.2"
+  end
 end

data/mongo_followable.gemspec

@@ -4,7 +4,7 @@ require "mongo_followable/version"
 
 Gem::Specification.new do |s|
   s.name        = "mongo_followable"
-  s.version     = MongoFollowable::VERSION
+  s.version     = Mongo::Followable::VERSION
   s.authors     = ["Jie Fan"]
   s.email       = ["ustc.flyingfox@gmail.com"]
   s.homepage    = "https://github.com/lastomato/mongo_followable"
@@ -13,11 +13,11 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "mongo_followable"
 
-  s.add_development_dependency('rspec', '~> 2.7.0')
-  s.add_development_dependency('mongoid', '~> 2.4.0')
-  s.add_development_dependency('mongo_mapper', '~> 0.10.0')
-  s.add_development_dependency('bson_ext', '~> 1.5.0')
-  s.add_development_dependency('database_cleaner', '~>0.7.0')
+  s.add_development_dependency('rspec', '> 2.7.0')
+  s.add_development_dependency('mongoid', '> 2.4.0')
+  s.add_development_dependency('mongo_mapper', '> 0.10.0')
+  s.add_development_dependency('bson_ext', '> 1.5.0')
+  s.add_development_dependency('database_cleaner', '>0.7.0')
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/mongo/followable_spec.rb

@@ -46,6 +46,10 @@ describe Mongo::Followable do
         u.ever_follow.should =~ [@v, @g]
         @v.ever_followed.should == [u]
 
+        u.ever_follow?(@v).should be_true
+        u.ever_follow?(@g).should be_true
+        @v.ever_followed?(u).should be_true
+
         u.common_followees?(@v).should be_false
         @v.common_followers?(u).should be_false
         u.common_followees_with(@v).should == []
@@ -99,6 +103,12 @@ describe Mongo::Followable do
         u.ever_follow.should =~ [@g, @v]
         @g.ever_followed.should == [u]
 
+        u.clear_follow_history!
+        u.ever_follow.should == []
+
+        @g.clear_history!
+        @g.ever_followed.should == []
+
         u.common_followees?(@v).should be_false
         @v.common_followers?(@g).should be_true
         u.common_followees_with(@v).should == []

data/spec/mongo/performance_spec.rb

@@ -0,0 +1,29 @@
+require "benchmark"
+require "rubygems"
+require "bundler/setup"
+require "mongoid"
+require "../../lib/mongo_followable"
+require "../../spec/mongoid/group"
+require "../../spec/mongoid/user"
+
+Mongoid.configure do |config|
+  name = 'mongo_followable_test'
+  host = 'localhost'
+  config.master = Mongo::Connection.new.db(name)
+  config.autocreate_indexes = true
+end
+
+users = []
+1000.times { users << User.create! }
+group = Group.create!
+
+users.each { |u| u.follow(group) }
+
+Benchmark.bmbm do |x|
+  x.report("before") { group.followers }
+end
+
+RSpec.configure do |c|
+  c.before(:all)  { DatabaseCleaner.strategy = :truncation }
+  c.before(:each) { DatabaseCleaner.clean }
+end

data/spec/mongo_mapper/childuser.rb

@@ -1,5 +1,6 @@
 class ChildUser
   include MongoMapper::Document
-  include Mongo::Followable
-  include Mongo::Follower
+  include Mongo::Followable::Followed
+  include Mongo::Followable::Follower
+  include Mongo::Followable::History
 end

data/spec/mongo_mapper/group.rb

@@ -1,4 +1,5 @@
 class Group
   include MongoMapper::Document
-  include Mongo::Followable
+  include Mongo::Followable::Followed
+  include Mongo::Followable::History
 end

data/spec/mongo_mapper/user.rb

@@ -1,5 +1,6 @@
 class User
   include MongoMapper::Document
-  include Mongo::Followable
-  include Mongo::Follower
+  include Mongo::Followable::Followed
+  include Mongo::Followable::Follower
+  include Mongo::Followable::History
 end

data/spec/mongoid/childuser.rb

@@ -1,5 +1,6 @@
 class ChildUser
   include Mongoid::Document
-  include Mongo::Followable
-  include Mongo::Follower
+  include Mongo::Followable::Followed
+  include Mongo::Followable::Follower
+  include Mongo::Followable::History
 end

data/spec/mongoid/group.rb

@@ -1,4 +1,5 @@
 class Group
   include Mongoid::Document
-  include Mongo::Followable
+  include Mongo::Followable::Followed
+  include Mongo::Followable::History
 end

data/spec/mongoid/user.rb

@@ -1,5 +1,6 @@
 class User
   include Mongoid::Document
-  include Mongo::Followable
-  include Mongo::Follower
+  include Mongo::Followable::Followed
+  include Mongo::Followable::Follower
+  include Mongo::Followable::History
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongo_followable
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,14 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-31 00:00:00.000000000 Z
+date: 2012-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: 2.7.0
   type: :development
@@ -24,7 +24,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: 2.7.0
 - !ruby/object:Gem::Dependency
@@ -32,7 +32,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: 2.4.0
   type: :development
@@ -40,7 +40,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: 2.4.0
 - !ruby/object:Gem::Dependency
@@ -48,7 +48,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: 0.10.0
   type: :development
@@ -56,7 +56,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: 0.10.0
 - !ruby/object:Gem::Dependency
@@ -64,7 +64,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: 1.5.0
   type: :development
@@ -72,7 +72,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: 1.5.0
 - !ruby/object:Gem::Dependency
@@ -80,7 +80,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: 0.7.0
   type: :development
@@ -88,7 +88,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>'
       - !ruby/object:Gem::Version
         version: 0.7.0
 description: ! ' Mongo Followable adds following feature to mongoid/mongo_mapper '
@@ -99,11 +99,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .idea/encodings.xml
-- .idea/misc.xml
-- .idea/modules.xml
-- .idea/mongo_followable.iml
-- .idea/vcs.xml
 - .rakeTasks
 - Gemfile
 - LICENSE.txt
@@ -112,12 +107,15 @@ files:
 - app/models/follow.rb
 - lib/mongo_followable.rb
 - lib/mongo_followable/core_ext/string.rb
-- lib/mongo_followable/followable.rb
+- lib/mongo_followable/features/authorization.rb
+- lib/mongo_followable/features/confirmation.rb
+- lib/mongo_followable/features/history.rb
+- lib/mongo_followable/followed.rb
 - lib/mongo_followable/follower.rb
-- lib/mongo_followable/railtie.rb
 - lib/mongo_followable/version.rb
 - mongo_followable.gemspec
 - spec/mongo/followable_spec.rb
+- spec/mongo/performance_spec.rb
 - spec/mongo_mapper/childuser.rb
 - spec/mongo_mapper/group.rb
 - spec/mongo_mapper/user.rb
@@ -145,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: mongo_followable
-rubygems_version: 1.8.22
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: adds following feature to mongoid/mongo_mapper

data/.idea/encodings.xml

@@ -1,5 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="Encoding" useUTFGuessing="true" native2AsciiForPropertiesFiles="false" />
-</project>
-

data/.idea/misc.xml

@@ -1,5 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectRootManager" version="2" project-jdk-name="RVM: ruby-1.9.3-p125" project-jdk-type="RUBY_SDK" />
-</project>
-

data/.idea/modules.xml

@@ -1,9 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="ProjectModuleManager">
-    <modules>
-      <module fileurl="file://$PROJECT_DIR$/.idea/mongo_followable.iml" filepath="$PROJECT_DIR$/.idea/mongo_followable.iml" />
-    </modules>
-  </component>
-</project>
-

data/.idea/mongo_followable.iml

@@ -1,17 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="RUBY_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$" />
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" scope="PROVIDED" name="builder (v3.0.0, RVM: ruby-1.9.3-p125) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.1.3, RVM: ruby-1.9.3-p125) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.1.3, RVM: ruby-1.9.3-p125) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="i18n (v0.6.0, RVM: ruby-1.9.3-p125) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="mongo (v1.5.2, RVM: ruby-1.9.3-p125) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="mongoid (v2.4.7, RVM: ruby-1.9.3-p125) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="multi_json (v1.0.4, RVM: ruby-1.9.3-p125) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rspec (v2.7.0, RVM: ruby-1.9.3-p125) [gem]" level="application" />
-  </component>
-</module>
-

data/.idea/vcs.xml

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<project version="4">
-  <component name="VcsDirectoryMappings">
-    <mapping directory="$PROJECT_DIR$" vcs="Git" />
-  </component>
-</project>
-

data/lib/mongo_followable/followable.rb

@@ -1,247 +0,0 @@
-module Mongo
-  module Followable
-    extend ActiveSupport::Concern
-
-    included do |base|
-      if defined?(Mongoid)
-        if CONFIG[:authorization]
-          base.field :cannot_followed, :type => Array, :default => []
-        end
-
-        if CONFIG[:history]
-          base.field :followed_history, :type => Array, :default => []
-        end
-
-        base.has_many :followers, :class_name => "Follow", :as => :followable, :dependent => :destroy
-      elsif defined?(MongoMapper)
-        if CONFIG[:authorization]
-          base.key :cannot_followed, :type => Array, :default => []
-        end
-
-        if CONFIG[:history]
-          base.key :followed_history, :type => Array, :default => []
-        end
-
-        base.many :followers, :class_name => "Follow", :as => :followable, :dependent => :destroy
-      end
-    end
-
-    module ClassMethods
-
-      # get certain model's followees of this type
-      #
-      # Example:
-      #   >> @jim = User.new
-      #   >> @ruby = Group.new
-      #   >> @jim.save
-      #   >> @ruby.save
-      #
-      #   >> @jim.follow(@ruby)
-      #   >> User.followees_of(@jim)
-      #   => [@ruby]
-      #
-      #   Arguments:
-      #     model: instance of some followable model
-
-      def followees_of(model)
-        model.followees_by_type(self.name)
-      end
-
-      # 4 methods in this function
-      #
-      # Example:
-      #   >> Group.with_max_followers
-      #   => [@ruby]
-      #   >> Group.with_max_followers_by_type('user')
-      #   => [@ruby]
-
-      ["max", "min"].each do |s|
-        define_method(:"with_#{s}_followers") do
-          follow_array = self.all.to_a.sort! { |a, b| a.followers_count <=> b.followers_count }
-          num = follow_array[-1].followers_count
-          follow_array.select { |c| c.followers_count == num }
-        end
-
-        define_method(:"with_#{s}_followers_by_type") do |*args|
-          follow_array = self.all.to_a.sort! { |a, b| a.followers_count_by_type(args[0]) <=> b.followers_count_by_type(args[0]) }
-          num = follow_array[-1].followers_count_by_type(args[0])
-          follow_array.select { |c| c.followers_count_by_type(args[0]) == num }
-        end
-      end
-
-      #def method_missing(name, *args)
-      #  if name.to_s =~ /^with_(max|min)_followers$/i
-      #    follow_array = self.all.to_a.sort! { |a, b| a.followers_count <=> b.followers_count }
-      #    if $1 == "max"
-      #      max = follow_array[-1].followers_count
-      #      follow_array.select { |c| c.followers_count == max }
-      #    elsif $1 == "min"
-      #      min = follow_array[0].followers_count
-      #      follow_array.select { |c| c.followers_count == min }
-      #    end
-      #  elsif name.to_s =~ /^with_(max|min)_followers_by_type$/i
-      #    follow_array = self.all.to_a.sort! { |a, b| a.followers_count_by_type(args[0]) <=> b.followers_count_by_type(args[0]) }
-      #    if $1 == "max"
-      #      max = follow_array[-1].followers_count_by_type(args[0])
-      #      follow_array.select { |c| c.followers_count_by_type(args[0]) == max }
-      #    elsif $1 == "min"
-      #      min = follow_array[0].followers_count
-      #      follow_array.select { |c| c.followers_count_by_type(args[0]) == min }
-      #    end
-      #  else
-      #    super
-      #  end
-      #end
-
-    end
-
-    # set which mongoid cannot follow self
-    #
-    # Example:
-    #   >> @ruby.set_authorization('user')
-    #   => true
-
-    if CONFIG[:authorization]
-      define_method(:set_authorization) do |*models|
-        models.each do |model|
-
-          self.cannot_followed << model.safe_capitalize
-        end
-        self.save
-      end
-
-      define_method(:unset_authorization) do |*models|
-        models.each do |model|
-          self.cannot_followed -= [model.safe_capitalize]
-        end
-        self.save
-      end
-    end
-
-    # see if this model is followee of some model
-    #
-    # Example:
-    #   >> @ruby.followee_of?(@jim)
-    #   => true
-
-    def followee_of?(model)
-      0 < self.followers.by_model(model).limit(1).count * model.followees.by_model(self).limit(1).count
-    end
-
-    # return true if self is followed by some models
-    #
-    # Example:
-    #   >> @ruby.followed?
-    #   => true
-
-    def followed?
-      0 < self.followers.length
-    end
-
-    # get all the followers of this model, same with classmethod followers_of
-    #
-    # Example:
-    #   >> @ruby.all_followers
-    #   => [@jim]
-
-    def all_followers
-      rebuild_instances(self.followers)
-    end
-
-    def unfollowed(*models, &block)
-      if block_given?
-        models.delete_if { |model| !yield(model) }
-      end
-
-      models.each do |model|
-        term = CONFIG[:authorization] ? (self.cannot_followed.include?(model.class.name) or model.cannot_follow.include?(self.class.name)) : false
-
-        unless model == self or !self.followee_of?(model) or !model.follower_of?(self) or term
-          model.followees.by_model(self).first.destroy
-          self.followers.by_model(model).first.destroy
-        end
-      end
-    end
-
-    # unfollow all
-
-    def unfollowed_all
-      unfollowed(*self.all_followers)
-    end
-
-    # get all the followers of this model in certain type
-    #
-    # Example:
-    #   >> @ruby.followers_by_type("user")
-    #   => [@jim]
-
-    def followers_by_type(type)
-      rebuild_instances(self.followers.by_type(type))
-    end
-
-    # get the number of followers
-    #
-    # Example:
-    #   >> @ruby.followers_count
-    #   => 1
-
-    def followers_count
-      self.followers.count
-    end
-
-    # get the number of followers in certain type
-    #
-    # Example:
-    #   >> @ruby.followers_count_by_type("user")
-    #   => 1
-
-    def followers_count_by_type(type)
-      self.followers.by_type(type).count
-    end
-
-    # see model's followed history
-    #
-    # Example:
-    #   >> @ruby.ever_followed
-    #   => [@jim]
-
-    if CONFIG[:history]
-      define_method(:ever_followed) do
-        follow = []
-        self.followed_history.each do |h|
-          follow << h.split('_')[0].constantize.find(h.split('_')[1])
-        end
-        follow
-      end
-    end
-
-    # return if there is any common followers
-    #
-    # Example:
-    #   >> @ruby.common_followees?(@python)
-    #   => true
-
-    def common_followers?(model)
-      0 < (rebuild_instances(self.followers) & rebuild_instances(model.followers)).length
-    end
-
-    # get common followers with some model
-    #
-    # Example:
-    #   >> @ruby.common_followers_with(@python)
-    #   => [@jim]
-
-    def common_followers_with(model)
-      rebuild_instances(self.followers) & rebuild_instances(model.followers)
-    end
-
-    private
-      def rebuild_instances(follows)
-        follow_list = []
-        follows.each do |follow|
-          follow_list << follow.f_type.constantize.find(follow.f_id)
-        end
-        follow_list
-      end
-  end
-end