rspec_extensions_collection 0.0.3

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in rspec_extensions_collection.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    rspec_extensions_collection (0.0.3)
+      rspec
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activesupport (3.0.3)
+    bson (1.1.5)
+    bson_ext (1.1.5)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    i18n (0.5.0)
+    mongo (1.1.5)
+      bson (>= 1.1.5)
+    mongoid (2.0.0.beta.20)
+      activemodel (~> 3.0)
+      mongo (~> 1.1)
+      tzinfo (~> 0.3.22)
+      will_paginate (~> 3.0.pre)
+    mongoid-rspec (1.2.1)
+      bson_ext (>= 1.0.4)
+      mongoid (>= 2.0.0.beta.15)
+      rspec (>= 2.0.0.beta.19)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    tzinfo (0.3.23)
+    will_paginate (3.0.pre2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.0)
+  mongoid-rspec
+  rspec
+  rspec_extensions_collection!

data/README.rdoc

@@ -0,0 +1,55 @@
+= RSpec extensions collection
+
+  This is a collection of various RSpec extensions I would like to use for multiple projects. 
+  The primary purpose is for me to use them anywhere so it's not necessarily made for generic use.  
+
+== Install
+
+  Put the following in Gemfile:
+    gem "rspec_extensions_collection"
+  Then execute:
+    bundle install
+  
+== Set up
+
+  1. Helpers
+
+     Include a helper you want to use in Spec.
+     Or include a helper in spec_helper.rb. e.g.
+       config.include RSpecExtensionsCollection::Matchers::MongoidModelHelpers
+  
+  2. Matchers
+
+     Put the following in spec_helper.rb:
+       config.include RSpecExtensionsCollection::Matchers
+
+== Usage
+
+  1. Helpers
+
+  2. Matchers
+
+   2-1. SearchMatcher
+
+     search_by(*args)
+
+       args: List of field name symbols. 
+             Last argument can be Hash of options. 
+               :locale - Specifies the locale on which the filtering the search result is based on. "en" or "fr".
+
+     The method to test: search(keyword)
+
+     Example: BlogPost.should search_by(:title, :content, :locale => I18n.locale.to_s)
+
+   2-2. SearchEmbeddedMatcher - For Mongoid embedded documents.
+
+     search_embedded_by(association_name, *args)
+
+       association_name: Name of the embedded document specified in the parent document.
+       args:             List of field name symbols. 
+                         Last argument can be Hash of options. 
+                           :locale - Specifies the locale on which the filtering the search result is based on. "en" or "fr".
+
+     The method to test: search_embedded_by(keyword)
+
+     Example: BlogPost.should search_embedded_by(:comments, :content, :locale => I18n.locale.to_s)

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/rspec_extensions_collection.rb

@@ -0,0 +1,3 @@
+require 'rspec_extensions_collection/helpers/mongoid_model_helpers'
+require 'rspec_extensions_collection/matchers/search_matcher'
+require 'rspec_extensions_collection/matchers/search_embedded_matcher'

data/lib/rspec_extensions_collection/helpers/mongoid_model_helpers.rb

@@ -0,0 +1,13 @@
+module RSpecExtensionsCollection
+  module Matchers
+    module MongoidModelHelpers
+  
+      # Mongoid executes query only when it's needed. Until then, it just creates Criteria object. 
+      # For the purpose of test, this method gets the result models array from Criteria object as usually done in for loop in view.
+      def execute_query_to_models(result_array_mongoid_criteria)
+        result_array_mongoid_criteria.map { |model| model }
+      end
+  
+    end
+  end
+end

data/lib/rspec_extensions_collection/matchers/search_embedded_matcher.rb

@@ -0,0 +1,62 @@
+require 'rspec_extensions_collection/matchers/search_matcher'
+
+module RSpecExtensionsCollection
+  module Matchers
+
+    # Asserts the search is made with the given fields for embedded Mongoid document
+    # with the option specifying if the result if filtered by locale.
+    # The method to test: search_embedded(keyword)
+    #
+    # Options:
+    #
+    # association_name: Name of the embedded document specified in the parent document.
+    # args:             List of field name symbols. 
+    #                   Last argument can be +Hash+ of options. 
+    #                     :locale - Specifies the locale on which the filtering the search result is based on. "en" or "fr".
+    #
+    # Example:
+    #
+    # <tt>BlogPost.should search_embedded_by(:comments, :title, :content, :locale => I18n.locale.to_s)</tt>
+    def search_embedded_by(association_name, *args)
+      SearchEmbeddedMatcher.new(association_name, *args)
+    end
+
+    class SearchEmbeddedMatcher < SearchMatcher
+
+      def initialize(association_name, *args)
+        @association_name = association_name
+        super(*args)
+      end
+
+      private
+        # Executes the method in concern such as search:
+        def execute
+          @model_class.search_embedded(KEYWORD)
+        end
+
+        def create_model(field_with_keyword, locale = nil)
+          # TODO: Replace with factory:
+          parent_model = @model_class.create(:title => "Title", :content => "Content")
+          
+          embedded_model = parent_model.send(@association_name).build
+          @fields.each do |field| 
+            field_writer_symbol = "#{field}=".to_sym
+            if field == field_with_keyword
+              embedded_model.send(field_writer_symbol, FIELD_CONTENT_WITH_KEYWORD)
+            else
+              embedded_model.send(field_writer_symbol, FIELD_CONTENT_WITHOUT_KEYWORD)
+            end
+          end
+          embedded_model.locale = locale if locale
+          
+          embedded_model.save
+          
+          parent_model.update_attributes(:locale => locale) if locale
+
+          parent_model
+        end
+
+    end
+
+  end
+end

data/lib/rspec_extensions_collection/matchers/search_matcher.rb

@@ -0,0 +1,104 @@
+module RSpecExtensionsCollection
+  module Matchers
+
+    # Asserts the search is made with the given fields with the option specifying if the result if filtered by locale.
+    # The method to test: search(keyword)
+    #
+    # Options:
+    #
+    # args: List of field name symbols. 
+    #       Last argument can be +Hash+ of options. 
+    #         :locale - Specifies the locale on which the filtering the search result is based on. "en" or "fr".
+    #
+    # Example:
+    #
+    # <tt>BlogPost.should search_by(:title, :content, :locale => I18n.locale.to_s)</tt>
+    def search_by(*args)
+      SearchMatcher.new(*args)
+    end
+
+    class SearchMatcher
+      include MongoidModelHelpers
+
+      KEYWORD = "temp"
+      FIELD_CONTENT_WITH_KEYWORD = "This contains the keyword #{KEYWORD} and something else."
+      FIELD_CONTENT_WITHOUT_KEYWORD = "Used for some data."
+      LOCALES = ["en", "fr"]
+
+      def initialize(*args)
+        if args.try(:last).instance_of?(Hash)
+          @locale = args.pop[:locale]
+        end    
+        @fields = args
+      end
+
+      def matches?(model_class)
+        @model_class = model_class
+        @model_class.delete_all
+        create_models
+        @search_result = execute
+        execute_query_to_models(@search_result.asc(:_id)) == @matching_models
+      end
+
+      def failure_message_for_should
+        "expected #{@model_class} to find #{@matching_models} but got #{execute_query_to_models(@search_result)}"
+      end
+
+      private
+        # Executes the method in concern such as search:
+        def execute
+          @model_class.search(KEYWORD)
+        end
+      
+        def create_models
+          @all_models = []
+          @matching_models = []
+
+          (0..@fields.size-1).each do |index|
+            if @locale
+              model_with_matching_locale = create_model(@fields[index], @locale)
+              @matching_models << model_with_matching_locale
+              @all_models << model_with_matching_locale
+          
+              model_with_other_locale = create_model(@fields[index], other_locale)
+              @all_models << model_with_other_locale
+            else
+              model = create_model(@fields[index])
+              @matching_models << model
+              @all_models << model
+            end
+          end
+      
+          if @locale
+            LOCALES.each { |locale| @all_models << create_model(nil, locale) }
+          else
+            @all_models << create_model(nil)
+          end
+        end
+
+        def create_model(field_with_keyword, locale = nil)
+          model = @model_class.new do |model_object|
+            @fields.each do |field| 
+              field_writer_symbol = "#{field}=".to_sym
+              if field == field_with_keyword
+                model_object.send(field_writer_symbol, FIELD_CONTENT_WITH_KEYWORD)
+              else
+                model_object.send(field_writer_symbol, FIELD_CONTENT_WITHOUT_KEYWORD)
+              end
+            end
+            model_object.locale = locale if locale
+          end
+          model.save!
+          model
+        end
+    
+        def other_locale
+          locales_copy = Array.new(LOCALES)
+          locales_copy.delete(@locale)
+          locales_copy.first
+        end
+
+    end
+
+  end
+end

data/lib/rspec_extensions_collection/version.rb

@@ -0,0 +1,3 @@
+module RspecExtensionsCollection
+  VERSION = "0.0.3"
+end

data/rspec_extensions_collection.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/rspec_extensions_collection/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "rspec_extensions_collection"
+  s.version     = RspecExtensionsCollection::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Tadatoshi Takahashi"]
+  s.email       = ["tadatoshi.3.takahashi@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/rspec_extensions_collection"
+  s.summary     = "Collection of various RSpec extensions"
+  s.description = "Collection of RSpec extensions incluing helper methods, matchers, and macros that the author would like to use for multiple projects."
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "rspec_extensions_collection"
+  
+  s.add_dependency "rspec"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "mongoid-rspec"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/spec/models/blog_post.rb

@@ -0,0 +1,38 @@
+class BlogPost
+  include Mongoid::Document
+  
+  field :title
+  field :content
+  field :locale
+
+  index :title
+  index :locale
+  
+  before_validation :assign_current_locale
+
+  validates :title, :presence => true
+  validates :locale, :presence => true  
+
+  embeds_many :comments, :class_name => "Blogs::Comment"
+
+  scope :ordered, desc(:_id)  
+  scope :in_current_locale, lambda { where(:locale => I18n.locale.to_s) }
+
+  class << self
+
+    def search(keyword)
+      in_current_locale.where("this.title.match(/#{keyword}/i) || this.content.match(/#{keyword}/i)")
+    end
+    
+    def search_embedded(keyword)
+      in_current_locale.where("comments.content" => Regexp.new(keyword))
+    end
+  
+  end
+
+  private
+    def assign_current_locale
+      self.locale ||= I18n.locale.to_s
+    end
+  
+end

data/spec/models/blogs/comment.rb

@@ -0,0 +1,28 @@
+module Blogs
+
+  class Comment
+    include Mongoid::Document
+
+    field :content
+    field :locale
+
+    index :locale
+  
+    before_validation :assign_current_locale  
+
+    validates :content, :presence => true
+    validates :locale, :presence => true  
+  
+    embedded_in :blog_post, :inverse_of => :comments
+  
+    scope :ordered, asc(:_id)
+    scope :in_current_locale, lambda { where(:locale => I18n.locale.to_s) }  
+  
+    private
+      def assign_current_locale
+        self.locale ||= I18n.locale.to_s
+      end  
+  
+  end
+
+end

data/spec/rspec_extensions_collection/helpers/mongoid_model_helpers_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe "MongoidModelHelpers" do
+  include RSpecExtensionsCollection::Matchers::MongoidModelHelpers
+
+  describe BlogPost do
+    
+    before(:each) do
+      BlogPost.delete_all
+    end
+    
+    after(:each) do
+      BlogPost.delete_all
+    end    
+    
+    context "Scope" do
+
+      it "should have the current locale and be ordered by id" do     
+
+        blog_post_1 = BlogPost.create(:locale => "fr", :title => "First blog entry", :content => "This is the first entry")
+        blog_post_2 = BlogPost.create(:locale => "fr", :title => "Second blog entry", :content => "This is the second entry")
+        blog_post_3 = BlogPost.create(:locale => "en", :title => "Third blog entry", :content => "This is the third entry")
+        blog_post_4 = BlogPost.create(:locale => "fr", :title => "Fourth blog entry", :content => "This is the fourth entry")
+        blog_post_5 = BlogPost.create(:locale => "en", :title => "Fifth blog entry", :content => "This is the fifth entry")
+
+        I18n.locale = "en"
+        execute_query_to_models(BlogPost.in_current_locale.ordered).should == [blog_post_5, blog_post_3]
+        I18n.locale = "fr"
+        execute_query_to_models(BlogPost.in_current_locale.ordered).should == [blog_post_4, blog_post_2, blog_post_1]      
+
+      end
+
+    end
+    
+  end
+  
+end

data/spec/rspec_extensions_collection/matchers/search_embedded_matcher_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe "SearchEmbeddedMatcher" do
+
+  describe BlogPost do
+    
+    before(:each) do
+      BlogPost.delete_all
+      I18n.locale = "en"
+    end
+    
+    after(:each) do
+      BlogPost.delete_all
+      I18n.locale = "en"
+    end    
+    
+    context "Search" do
+
+      it "should find blog_post with a keyword contained in specified embedded document using custom matcher" do
+        
+        BlogPost.should search_embedded_by(:comments, :content, :locale => I18n.locale.to_s)
+        
+      end
+
+    end
+    
+  end
+  
+end

data/spec/rspec_extensions_collection/matchers/search_matcher_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe "SearchMatcher" do
+
+  describe BlogPost do
+    
+    before(:each) do
+      BlogPost.delete_all
+      I18n.locale = "en"
+    end
+    
+    after(:each) do
+      BlogPost.delete_all
+      I18n.locale = "en"
+    end    
+    
+    context "Search" do
+
+      it "should find blog_post with a keyword using custom matcher" do
+        
+        BlogPost.should search_by(:title, :content, :locale => I18n.locale.to_s)
+        
+      end
+
+    end
+    
+  end
+  
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+--format progress

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '/../lib/rspec_extensions_collection'))
+
+require 'rspec'
+require 'rspec/core'
+require 'rspec/expectations'
+require 'mongoid'
+Dir[File.expand_path(File.join(File.dirname(__FILE__), '/../lib/', 'rspec_extensions_collection/**/*.rb'))].each {|f| require f}
+Dir[File.join(File.dirname(__FILE__), "models/**/*.rb")].each {|f| require f}
+
+Mongoid.configure do |config|
+  name = "rspec_extensions_collection_test"
+  host = "localhost"
+  config.master = Mongo::Connection.new.db(name)
+end
+
+RSpec.configure do |config|
+  # config.include RSpec::Matchers
+  # config.include Mongoid::Matchers
+  config.mock_with :rspec
+  
+  config.include RSpecExtensionsCollection::Matchers
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: rspec_extensions_collection
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Tadatoshi Takahashi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-28 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: mongoid-rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Collection of RSpec extensions incluing helper methods, matchers, and macros that the author would like to use for multiple projects.
+email: 
+- tadatoshi.3.takahashi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/rspec_extensions_collection.rb
+- lib/rspec_extensions_collection/helpers/mongoid_model_helpers.rb
+- lib/rspec_extensions_collection/matchers/search_embedded_matcher.rb
+- lib/rspec_extensions_collection/matchers/search_matcher.rb
+- lib/rspec_extensions_collection/version.rb
+- rspec_extensions_collection.gemspec
+- spec/models/blog_post.rb
+- spec/models/blogs/comment.rb
+- spec/rspec_extensions_collection/helpers/mongoid_model_helpers_spec.rb
+- spec/rspec_extensions_collection/matchers/search_embedded_matcher_spec.rb
+- spec/rspec_extensions_collection/matchers/search_matcher_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/rspec_extensions_collection
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: rspec_extensions_collection
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Collection of various RSpec extensions
+test_files: []
+