mongoid_misc 0.0.1

data/lib/mongoid_misc.rb

@@ -0,0 +1,38 @@
+require 'mongoid_misc/gems'
+
+require 'mongo_ext'
+require 'mongoid'
+require 'will_paginate'
+
+%w(
+  hacks
+  support
+  
+  attribute_cache
+  attribute_convertors
+  belongs_to_with_counter_cache
+  simple_finders
+  micelaneous
+).each{|file| require "mongoid_misc/#{file}"}
+
+# 
+# Default plugins
+# 
+[
+  Mongoid::AttributeCache,
+  Mongoid::AttributeConvertors, 
+  Mongoid::BelongsToWithCounterCache, 
+  Mongoid::SimpleFinders, 
+  Mongoid::Micelaneous
+].each{|plugin| Mongoid::Document.send :include, plugin}
+  
+
+# 
+# Locales
+# 
+# Mongoid.add_language "*" - can't use this there's some bug, haven't time to investigate it
+Mongoid.add_language "en"
+Mongoid.add_language "ru"
+
+dir = File.expand_path "#{__FILE__}/../.."
+I18n.load_path += Dir["#{dir}/config/locales/**/*.{rb,yml}"]

data/readme.md

@@ -0,0 +1,85 @@
+## Mongo Migrations
+
+Migrations are framework-agnostic, You can use it with Mongoid, MongoMapper, or with just with bare Mongo driver.
+
+    require 'mongo_migration'
+    require 'mongo_migration/adapters/mongoid'
+    
+    # use existing adapter or define Your own, it has only 2 methods 
+    # and about 10 lines of code (use Mongoid as a sample)
+    adapter = Mongo::Migration::Mongoid.new
+    
+    # initialize migration
+    Mongo.migration = Mongo::Migration.new adapter
+    
+    # configure migration by defining migration steps 
+    # You can place all of them in one file or as different
+    # files in one directory
+    Mongo.migration.define 1 do |m|
+      m.up do |db|
+        # update Your models
+        # User.create name: 'Bob'
+        
+        # or use db directly
+        db.collection('users').insert({name: 'Bob'})
+      end
+      m.down{|db| db.collection('users').remove({name: 'Bob'})}
+    end
+        
+    Mongo.migration.define 2 do |m|
+      m.up{|db| db.collection('users').insert({name: 'John'})}
+      m.down{|db| db.collection('users').remove({name: 'John'})}
+    end
+    
+    # specify what version (it can be any version) do You need
+    # and apply migration
+    # You can call it directly or via Rake task
+    Mongo.migration.update 2    
+    adapter.database(:default).collection('users').find.count.should == 2
+    
+    # rollback to any version changes
+    Mongo.migration.update 0
+    adapter.database(:default).collection('users').find.count.should == 0
+    
+To see this code running go to spec.  
+
+# Mongoid
+
+## Attribute Converters
+
+Handy shortcut to assign tags (Array) as a string with delimiters (there are also other converters for Lists, Hashes, Yaml):
+
+    class Post    
+      include Mongoid::Document
+      
+      field :tags, type: Array, default: [], as_string: :line
+    end
+    
+    @post.tags_as_string = "personal, article"
+    @post.tags                                  # => ['personal', 'article']
+    @post.tags_as_string                        # => "personal, article"
+
+## :counter_cache option
+
+    class Comment
+      belongs_to :post, counter_cache: true
+    end
+    
+    Post.comments_count
+    
+## Handy upserts
+
+    @post.upsert! :$inc => {comments_count: 1}
+    
+# Installation
+
+    gem install 'mongoid_misc'
+    
+    require 'mongoid_misc'
+        
+    # support for CarrierWave is optional
+    # require 'carrierwave_ext'
+
+# License
+
+Copyright (c) Alexey Petrushin [http://4ire.net](http://4ire.net), released under the MIT license.

data/spec/carrierwave_ext/mount_uploader_spec.rb

@@ -0,0 +1,158 @@
+require 'carrierwave_ext/spec_helper'
+
+describe "Mongoid & CarrierWave" do   
+  with_tmp_spec_dir
+  before :each do
+    connection = Mongo::Connection.new
+    connection.db('test').collection('test').drop
+    
+    Mongoid.configure do |config|
+      config.master = connection.db('test')
+    end
+  end
+  
+  before :all do
+    class PlaneImageUploader < CarrierWave::Uploader::Base
+      require 'carrierwave/processing/mini_magick'
+  
+      include CarrierWave::MiniMagick      
+    
+      storage :file
+    
+      version :icon do
+        process convert: :png
+        process resize_to_fit: [50, 50]
+      end
+    
+      def store_dir
+        PlaneImageUploader.store_dir
+      end
+    
+      def root
+        PlaneImageUploader.store_dir
+      end
+      
+      class << self
+        attr_accessor :store_dir
+      end
+    end        
+  end
+  after(:all){remove_constants :PlaneImageUploader}
+  
+  before do
+    PlaneImageUploader.store_dir = "#{spec_dir}/data"
+    @file = File.new "#{spec_dir}/plane.jpg"
+  end
+  after do 
+    @file.close
+    @file2.close if @file2
+  end
+  
+  it "should works without model" do
+    # writing
+    uploader = PlaneImageUploader.new
+    uploader.store!(@file)
+    uploader.identifier.should == 'plane.jpg'
+    uploader.url.should == '/plane.jpg'
+    uploader.icon.url.should == '/plane.icon.jpg'
+    File.should exist("#{spec_dir}/data/plane.icon.jpg")
+    
+    # reading
+    uploader = PlaneImageUploader.new
+    uploader.retrieve_from_store! 'plane.jpg'
+    uploader.url.should == '/plane.jpg'
+    uploader.icon.url.should == '/plane.icon.jpg'
+    
+    # destroying
+    uploader = PlaneImageUploader.new
+    uploader.retrieve_from_store! 'plane.jpg'
+    uploader.remove!
+    File.should_not exist("#{spec_dir}/data/plane.icon.jpg")
+  end
+  
+  describe "Document" do
+    before :all do
+      class Plane
+        include Mongoid::Document
+  
+        mount_uploader :image, PlaneImageUploader
+      end        
+    end
+    after(:all){remove_constants :Plane}
+  
+    it "basic" do
+      Plane.create! image: @file
+      Plane.first.image.current_path.should =~ /\/plane.jpg/
+      File.should exist("#{spec_dir}/data/plane.jpg")
+    end
+    
+    it "path format" do
+      Plane.create! image: @file
+      
+      plane = Plane.first
+      plane.image.url.should == '/plane.jpg'
+      plane.image.icon.url.should =~ /\/plane\.icon\.jpg/
+      plane.image.name.should == 'plane.jpg'
+    
+      plane.image.icon.current_path.should =~ /\/plane\.icon\.jpg/
+      File.should exist("#{spec_dir}/data/plane.icon.jpg")
+    end
+  end
+  
+  describe "EmbeddedDocument" do
+    before :all do
+      class PlaneImage
+        include Mongoid::Document
+        embedded_in :plane, class_name: 'Plane2'
+        mount_uploader :image, PlaneImageUploader
+      end
+      
+      class Plane2
+        include Mongoid::Document
+        
+        embeds_many :images, class_name: 'PlaneImage'                
+        mount_embedded_uploader :images, :image
+      end        
+    end
+    after(:all){remove_constants :Plane2, :PlaneImage}
+  
+    it "basic" do
+      Plane2.create! images: [PlaneImage.new(image: @file)]
+      Plane2.first.images.first.image.current_path.should =~ /\/plane.jpg/
+      File.should exist("#{spec_dir}/data/plane.jpg")
+    end
+    
+    it "CRUD" do
+      # create
+      Plane2.create! images: [PlaneImage.new(image: @file)]      
+      File.should exist("#{spec_dir}/data/plane.jpg")
+      
+      # update
+      plane = Plane2.first
+      @file2 = File.new "#{spec_dir}/plane2.jpg"      
+      plane.images << PlaneImage.new(image: @file2)
+      plane.save!
+      File.should exist("#{spec_dir}/data/plane2.jpg")
+      
+      # destroy embedded
+      plane.images.last.destroy
+      File.should exist("#{spec_dir}/data/plane.jpg")
+      File.should_not exist("#{spec_dir}/data/plane2.jpg")
+
+      # destroy parent
+      plane.destroy
+      File.should_not exist("#{spec_dir}/data/plane.jpg")
+    end
+  
+    it "path format" do
+      Plane2.create! images: [PlaneImage.new(image: @file)]
+      
+      plane_image = Plane2.first.images.first
+      plane_image.image.url.should == '/plane.jpg'
+      plane_image.image.icon.url.should =~ /\/plane\.icon\.jpg/
+    
+      plane_image.image.icon.current_path.should =~ /\/plane\.icon\.jpg/
+      File.should exist("#{spec_dir}/data/plane.icon.jpg")
+    end
+  end
+end

data/spec/carrierwave_ext/spec_helper.rb

@@ -0,0 +1,7 @@
+require "mongoid_misc"
+
+require "carrierwave_ext"
+
+require 'rspec_ext'
+require 'mongoid_misc/spec'
+require 'carrierwave_ext/spec'

data/spec/carrierwave_ext/uploader_spec//321/204/320/260/320/270/314/206/320/273 /321/201 /320/277/321/200/320/276/320/261/320/265/320/273/320/260/320/274/320/270.txt"

@@ -0,0 +1 @@
+1

data/spec/carrierwave_ext/uploader_spec.rb

@@ -0,0 +1,61 @@
+require 'carrierwave_ext/spec_helper'
+require 'carrierwave/processing/mini_magick'
+
+describe "Uploading" do  
+  with_tmp_spec_dir
+  with_mongoid
+  with_files  
+
+  before :all do
+    class ImageUploader < CarrierWave::Uploader::Base
+      include CarrierWave::MiniMagick
+
+      # def sanitize_regexp
+      #   /[^[:word:]\.\-\+\s_]/i
+      # end
+
+      def file_path
+        model.id
+      end
+
+      def store_dir
+        "#{root}#{file_path}"
+      end
+
+      def extension_white_list
+        [/.*/]
+      end
+    end
+
+    class Post
+      include Mongoid::Document
+
+      field :name, type: String, default: ""
+      validates_uniqueness_of :name
+  
+      mount_uploader :image, ImageUploader
+    end                
+  end  
+  after(:all){remove_constants :Post, :ImageUploader}  
+
+  it "should upload images" do    
+    post = nil
+    File.open "#{spec_dir}/ship.jpg" do |f|
+      post = Post.new image: f
+      post.save!
+    end
+    post.image.url.should =~ /\/ship\.jpg/
+    post.image_filename.should =~ /ship\.jpg/
+    post.image.path.should =~ /\/ship\.jpg/
+  end
+
+  it "should preserve spaces and unicode characters in filename" do
+    File.open "#{spec_dir}/файл с пробелами.txt" do |f|
+      post = Post.new image: f
+
+      post.image.url.should =~ /\/файл с пробелами\.txt/
+      post.image.filename =~ /файл с пробелами\.txt/
+      post.image.path =~ /\/файл с пробелами\.txt/
+    end
+  end
+end

data/spec/mongo_ext/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'mongo_ext'
+
+require 'rspec_ext'
+require 'mongo_ext/spec'

data/spec/mongo_ext/upsert_spec.rb

@@ -0,0 +1,20 @@
+require 'mongo_ext/spec_helper'
+
+describe "Micelaneous" do
+  before do
+    db = clear_mongo_database
+    @collection = db.collection 'test'
+  end
+  
+  it "upsert should update" do
+    id = @collection.save count: 2
+    @collection.upsert!({_id: id}, :$inc => {count: 1})
+    @collection.find(_id: id).first['count'].should == 3
+  end
+
+  it "upsert should set" do
+    id = @collection.save({})
+    @collection.upsert!({_id: id}, :$inc => {count: 1})
+    @collection.find(_id: id).first['count'].should == 1
+  end
+end

data/spec/mongo_migration/basic_spec.rb

@@ -0,0 +1,110 @@
+require 'mongo_migration/spec_helper'
+
+describe "Migration" do
+  before :all do
+    class TestAdapter
+      def initialize
+        @logger = Logger.new(nil)
+        
+        connection = Mongo::Connection.new
+        @databases = {
+          default: connection.db('test'),
+          global:  connection.db('global_test')
+        }
+      end
+      
+      attr_reader :logger
+      def database name; @databases[name] end
+    end
+    Mongo::Migration::Mongoid = TestAdapter
+  end
+  after(:all){remove_constants :TestAdapter, :MyAdapter}
+  
+  before do    
+    clear_mongo_database    
+    
+    @adapter = TestAdapter.new
+    @migration = Mongo::Migration.new @adapter
+  end
+  
+  it "basic sample" do    
+    # use existing adapter or define Your own, it has only 2 methods 
+    # and about 10 lines of code (use Mongoid as a sample)
+    adapter = Mongo::Migration::Mongoid.new
+    
+    # initialize migration
+    Mongo.migration = Mongo::Migration.new adapter
+    
+    # configure migration by defining migration steps 
+    # You can place all of them in one file or as different
+    # files in one directory
+    Mongo.migration.define 1 do |m|
+      m.up do |db|
+        # update Your models
+        # User.create name: 'Bob'
+        
+        # or use db directly
+        db.collection('users').insert({name: 'Bob'})
+      end
+      m.down{|db| db.collection('users').remove({name: 'Bob'})}
+    end
+        
+    Mongo.migration.define 2 do |m|
+      m.up{|db| db.collection('users').insert({name: 'John'})}
+      m.down{|db| db.collection('users').remove({name: 'John'})}
+    end
+    
+    # specify what version (it can be any version) do You need
+    # and apply migration
+    # You can call it directly or via Rake task
+    Mongo.migration.update 2    
+    adapter.database(:default).collection('users').find.count.should == 2
+    
+    # rollback to any version changes
+    Mongo.migration.update 0
+    adapter.database(:default).collection('users').find.count.should == 0
+  end
+  
+  it "Shouldn't update if versions are the same" do
+    @migration.update(0).should be_false
+  end
+  
+  it "migration should provide access to database" do 
+    @migration.define 1 do |m|
+      m.up do |db|
+        db.collection('users').insert({name: 'Bob'})
+      end
+    end  
+    @migration.update(1).should be_true
+    @adapter.database(:default).collection('users').find.count.should == 1
+  end    
+  
+  it "increase_db_version" do
+    check = mock
+    @migration.define 1 do |m|
+      m.up{check.up}
+    end
+  
+    check.should_receive :up
+    @migration.update(1).should be_true    
+    @migration.metadata(@adapter.database(:default))['version'].should == 1
+  end
+  
+  it "decrease_db_version" do
+    check = mock
+    @migration.define 1 do |m|
+      m.up{check.up}
+      m.down{check.down}
+    end
+    check.should_receive :up
+    @migration.update(1).should be_true
+
+    check.should_receive :down
+    @migration.update(0).should be_true
+    @migration.metadata(@adapter.database(:default))['version'].should == 0
+  end
+  
+  describe "multiple databases" do
+    before{clear_mongo_database 'global_test'}        
+  end
+end

data/spec/mongo_migration/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'logger'
+require 'mongo_migration'
+
+require 'rspec_ext'
+require 'mongo_ext/spec'

data/spec/mongoid_misc/attribute_convertors_spec.rb

@@ -0,0 +1,70 @@
+require 'mongoid_misc/spec_helper'
+
+describe "Attribute Convertors" do
+  with_mongoid
+  
+  after(:all){remove_constants :TheSample}    
+    
+  before do
+    @convertors = Mongoid::AttributeConvertors::CONVERTORS
+    # @convertors.merge(test_convertor: {
+    #   from_string: -> s {"from_string: #{s}"},
+    #   to_string:   -> v {"to_string: #{v}"}
+    # })
+  end
+  
+  it ":line convertor" do      
+    v = ['a', 'b']
+    str_v = 'a, b'
+    @convertors[:line][:from_string].call(str_v).should == v
+    @convertors[:line][:to_string].call(v).should == str_v
+  end
+  
+  it ":yaml convertor" do
+    v = {'a' => 'b'}
+    str_v = v.to_yaml.strip
+    
+    @convertors[:yaml][:from_string].call(str_v).should == v
+    @convertors[:yaml][:to_string].call(v).should == str_v
+  end
+  
+  it ":json convertor" do
+    v = {'a' => 'b'}
+    str_v = v.to_json.strip
+    @convertors[:json][:from_string].call(str_v).should == v
+    @convertors[:json][:to_string].call(v).should == str_v
+  end
+  
+  it ":field should generate helper methods if :as_string option provided" do
+    class ::TheSample
+      include Mongoid::Document
+      
+      field :tags,           type: Array, default: [], as_string: :line
+      field :protected_tags, type: Array, default: [], as_string: :line, protected: true
+    end
+  
+    o = TheSample.new
+    
+    # get
+    o.tags_as_string.should == ''
+    o.tags = %w(Java Ruby)
+    o.clear_cache
+    o.tags_as_string.should == 'Java, Ruby'
+    
+    # set
+    o.tags_as_string = ''
+    o.tags.should == []
+    o.tags_as_string = 'Java, Ruby'
+    o.tags.should == %w(Java Ruby)
+    
+    # mass assignment
+    o.tags = []
+    o.update_attributes tags_as_string: 'Java, Ruby'
+    o.tags.should == %w(Java Ruby)
+    
+    # # protection
+    o.protected_tags = []
+    o.update_attributes protected_tags_as_string: 'Java, Ruby'
+    o.protected_tags.should == []
+  end
+end

data/spec/mongoid_misc/belongs_to_with_counter_cache_spec.rb

@@ -0,0 +1,41 @@
+require 'mongoid_misc/spec_helper'
+
+describe "BelongsToWithCounterCache" do
+  with_mongoid
+  
+  before :all do
+    class ::Post
+      include Mongoid::Document      
+      
+      field :comments_count, type: Integer, default: 0
+      has_many :comments
+    end
+    
+    class ::Comment
+      include Mongoid::Document
+      
+      field :post_id
+      belongs_to :post, counter_cache: true
+    end
+  end  
+  after(:all){remove_constants :Post, :Comment}
+  
+  it "should increase count of comments" do
+    post = Post.create!
+    comment = post.comments.create!
+    
+    post.reload
+    post.comments_count.should == 1
+  end
+  
+  it "should decrease count of comments" do
+    post = Post.create!
+    comment = post.comments.create!
+    post.reload
+    post.comments_count.should == 1
+    
+    comment.destroy    
+    post.reload
+    post.comments_count.should == 0
+  end  
+end