crystal-ext 0.0.1

data/lib/rails_ext/spec/rails_ext/haml_builder_spec.rb

@@ -0,0 +1,136 @@
+require 'spec'
+
+require 'ruby_ext'
+require 'active_support'
+require "#{File.dirname __FILE__}/../../lib/abstract_interface/haml_builder"
+
+require 'facets/openobject'
+
+
+# 
+# Don't use should ==, it doesn't works with OpenObject
+# 
+describe "HamlBuilder use cases" do  
+  class TemplateStub
+    def self.capture &block
+      block.call
+      self.output
+    end
+    
+    class << self
+      attr_accessor :output
+    end
+  end
+  
+  def build *args, &block
+    opt = args.extract_options!
+    args.size.should! :be_in, 0..1
+    opt[:content] = args.first if args.size == 1
+    
+    r = AbstractInterface::HamlBuilder.get_input(TemplateStub, opt, &block)
+    convert_to_hashes r
+  end
+  
+  def convert_to_hashes value
+    if value.is_a? OpenObject
+      r = {}
+      value.each do |k, v|
+        r[k] = convert_to_hashes v
+      end
+      r
+    else
+      value
+    end
+  end
+  
+  it "hash" do
+    (build do |o|
+      o.a :b
+    end).should == {:a => :b}
+  
+    build(:a => :b).should == {:a => :b}
+  end
+  
+  it "array" do
+    (build do |a|
+      a.add 1
+      a.add 2
+    end).should == {:content => [1, 2]}
+    
+    (build do |o|
+      o.a :b
+      o.ar do |a|
+        a.add 1
+        a.add 2
+      end      
+    end).should == {:a => :b, :ar => [1, 2]}
+  end
+  
+  it "capture" do
+    build("value").should == {:content => "value"}
+    
+    (build do
+      TemplateStub.output = "value"
+    end).should == {:content => "value"}
+    
+    (build do |o|
+      o.content do
+        TemplateStub.output = "value"
+      end
+    end).should == {:content => "value"}
+    
+    (build do |o|
+      o.value do
+        TemplateStub.output = "value"
+      end
+    end).should == {:value => "value"}
+  end
+  
+  it "invalid usage" do
+    lambda{
+      build "value" do
+        TemplateStub.output = "value"
+      end
+    }.should raise_error(/Invalid usage!/)
+  end
+  
+  it "merge" do
+    (build :a => :b do
+      TemplateStub.output = "value"
+    end).should == {:a => :b, :content => "value"}
+    
+    (build :a => :b do |o|
+      o.c :d
+    end).should == {:a => :b, :c => :d}
+  end
+  
+  it "nested" do
+    (build :a => :b do |o|
+      o.a do |o|
+        o.b :c
+      end
+    end).should == {
+      :a => {:b => :c}
+    }
+  end
+  
+  it "complex" do
+    (build :a => :b do |o|      
+      o.hs do |h|
+        h.c :d
+      end
+      o.ar do |a|
+        a.add 1        
+        a.add 2
+      end
+      o.html do
+        TemplateStub.output = "value"
+      end
+    end).should == {
+      :a => :b,
+      :hs => {:c => :d},
+      :ar => [1, 2],
+      :html => 'value'
+    }
+  end
+end

data/lib/rails_ext/spec/rails_ext/safe_hash_spec.rb

@@ -0,0 +1,71 @@
+require 'spec'
+
+require 'active_support'
+require "#{File.dirname __FILE__}/../../lib/rails_ext/micelaneous/safe_hash"
+
+describe "SafeHash and SafeNil" do
+  it "should allow check for value presence" do
+    h = SafeHash.new :a => :b
+    h.a?.should be_true
+    h.b?.should be_false
+    
+    h.should include(:a)
+    h.should_not include(:b)
+  end
+  
+  it "should allow owerride values" do
+    h = SafeHash.new :a => :b
+    h[:b] = :c
+    h.b!.should == :c
+  end
+  
+  it "general behaviour" do
+    h = SafeHash.new :key => :value
+    
+    h.key.should == :value
+    h.key(:missing).should == :value
+    
+    h[:key].should == :value
+    h[:key, :missing].should == :value
+    
+    h['key'].should == :value
+    h['key', :missing].should == :value
+        
+    h.a.b.c[:d].e('missing').should == 'missing'
+    h.a.b.c[:d][:e, 'missing'].should == 'missing'
+  end
+  
+  it "should build hierarchies of SafeHash" do
+    h = SafeHash.new :a => {:a => :b}
+    
+    h.a.a.should == :b
+    h.a.missing.b.c('missing').should == 'missing'
+  end
+  
+  it "should require setting if ! used" do
+    h = SafeHash.new :a => :v, :b => {:c => :v}
+    
+    h.a!.should == :v
+    h.b.c!.should == :v
+    h.b!.c!.should == :v
+    
+    lambda{h.j!}.should raise_error(/No key j/) 
+    lambda{h.j.b.c!}.should raise_error(/No key c/)
+  end
+  
+  it "should be able to update itself" do
+    h = SafeHash.new 
+    h.b?.should be_false
+    h[:a] = :a
+    h.a!.should == :a
+  end
+  
+  it "should implement include?" do
+    h = SafeHash.new :a => :b
+    h.include?(:a).should be_true
+    h.include?('a').should be_true
+    h.include?(:b).should be_false
+
+    h.b.include?(:a).should be_false
+  end
+end

data/lib/rails_ext/spec/spec.opts

@@ -0,0 +1,3 @@
+--color
+--reverse
+--backtrace

data/lib/sunspot/mongo_mapper/adapters.rb

@@ -0,0 +1,79 @@
+module Sunspot #:nodoc:
+  module MongoMapper #:nodoc:
+    # 
+    # This module provides Sunspot Adapter implementations for MongoMapper
+    # models.
+    #
+    module Adapters
+      class MongoMapperInstanceAdapter < Sunspot::Adapters::InstanceAdapter
+        # 
+        # Return the primary key for the adapted instance
+        #
+        # ==== Returns
+        # 
+        # Integer:: Database ID of model
+        #
+        def id
+          @instance.id
+        end
+      end
+
+      class MongoMapperDataAccessor < Sunspot::Adapters::DataAccessor
+        # options for the find
+        attr_accessor :include, :select
+
+        #
+        # Set the fields to select from the database. This will be passed
+        # to MongoMapper.
+        #
+        # ==== Parameters
+        #
+        # value<Mixed>:: String of comma-separated columns or array of columns
+        #
+        def select=(value)
+          value = value.join(', ') if value.respond_to?(:join)
+          @select = value
+        end
+        
+        # 
+        # Get one MongoMapper instance out of the database by ID
+        #
+        # ==== Parameters
+        #
+        # id<String>:: Database ID of model to retreive
+        #
+        # ==== Returns
+        #
+        # MongoMapper::Base:: MongoMapper model
+        # 
+        def load(id)
+          @clazz.first(options_for_find.merge(:id => id))
+        end
+
+        # 
+        # Get a collection of MongoMapper instances out of the database by ID
+        #
+        # ==== Parameters
+        #
+        # ids<Array>:: Database IDs of models to retrieve
+        #
+        # ==== Returns
+        #
+        # Array:: Collection of MongoMapper models
+        #
+        def load_all(ids)
+          @clazz.all(options_for_find.merge(:id => ids))
+        end
+        
+        private
+        
+        def options_for_find
+          returning({}) do |options|
+            options[:include] = @include unless @include.blank?
+            options[:select]  =  @select unless  @select.blank?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/mongo_mapper/searchable.rb

@@ -0,0 +1,409 @@
+module Sunspot #:nodoc:
+  module MongoMapper #:nodoc:
+    # 
+    # This module adds Sunspot functionality to MongoMapper models. As well as
+    # providing class and instance methods, it optionally adds lifecycle hooks
+    # to automatically add and remove models from the Solr index as they are
+    # created and destroyed.
+    #
+    module Searchable
+      class <<self
+        def included(base) #:nodoc:
+          base.module_eval do
+            extend(ActsAsMethods)
+          end
+        end
+      end
+
+      module ActsAsMethods
+        # 
+        # Makes a class searchable if it is not already, or adds search
+        # configuration if it is. Note that the options passed in are only used
+        # the first time this method is called for a particular class; so,
+        # search should be defined before activating any mixins that extend
+        # search configuration.
+        #
+        # The block passed into this method is evaluated by the
+        # <code>Sunspot.setup</code> method. See the Sunspot documentation for
+        # complete information on the functionality provided by that method.
+        #
+        # ==== Options (+options+)
+        # 
+        # :auto_index<Boolean>::
+        #   Automatically index models in Solr when they are saved.
+        #   Default: true
+        # :auto_remove<Boolean>::
+        #   Automatically remove models from the Solr index when they are
+        #   destroyed. <b>Setting this option to +false+ is not recommended
+        #   </b>(see the README).
+        # :ignore_attribute_changes_of<Array>::
+        #   Define attributes, that should not trigger a reindex of that
+        #   object. Usual suspects are updated_at or counters.
+        # :include<Mixed>::
+        #   Define default MongoMapper includes, set this to allow MongoMapper
+        #   to load required associations when indexing. See MongoMapper's 
+        #   documentation on eager-loading for examples on how to set this
+        #   Default: [] 
+        #
+        # ==== Example
+        #
+        #   class Post < MongoMapper::Base
+        #     searchable do
+        #       text :title, :body
+        #       string :sort_title do
+        #         title.downcase.sub(/^(an?|the)/, '')
+        #       end
+        #       integer :blog_id
+        #       time :updated_at
+        #     end
+        #   end
+        #
+        def searchable(options = {}, &block)
+          Sunspot.setup(self, &block)
+
+          if searchable?
+            sunspot_options[:include].concat(Util::Array(options[:include]))
+          else
+            extend ClassMethods
+            include InstanceMethods
+
+            class_inheritable_hash :sunspot_options
+            
+            unless options[:auto_index] == false
+              before_save :maybe_mark_for_auto_indexing
+              after_save :maybe_auto_index
+            end
+
+            unless options[:auto_remove] == false
+              after_destroy do |searchable|
+                searchable.remove_from_index
+              end
+            end
+            options[:include] = Util::Array(options[:include])
+            
+            self.sunspot_options = options
+          end
+        end
+
+        # 
+        # This method is defined on all MongoMapper::Base subclasses. It
+        # is false for classes on which #searchable has not been called, and
+        # true for classes on which #searchable has been called.
+        #
+        # ==== Returns
+        #
+        # +false+
+        #
+        def searchable?
+          false
+        end
+      end
+
+      module ClassMethods
+        def self.extended(base) #:nodoc:
+          class <<base
+            alias_method :search, :solr_search unless method_defined? :search
+            alias_method :search_ids, :solr_search_ids unless method_defined? :search_ids
+            alias_method :remove_all_from_index, :solr_remove_all_from_index unless method_defined? :remove_all_from_index
+            alias_method :remove_all_from_index!, :solr_remove_all_from_index! unless method_defined? :remove_all_from_index!
+            alias_method :reindex, :solr_reindex unless method_defined? :reindex
+            alias_method :index, :solr_index unless method_defined? :index
+            alias_method :index_orphans, :solr_index_orphans unless method_defined? :index_orphans
+            alias_method :clean_index_orphans, :solr_clean_index_orphans unless method_defined? :clean_index_orphans
+          end
+        end
+        # 
+        # Search for instances of this class in Solr. The block is delegated to
+        # the Sunspot.search method - see the Sunspot documentation for the full
+        # API.
+        #
+        # ==== Example
+        #
+        #   Post.search(:include => [:blog]) do
+        #     keywords 'best pizza'
+        #     with :blog_id, 1
+        #     order :updated_at, :desc
+        #     facet :category_ids
+        #   end
+        #
+        # ==== Options
+        #
+        # :include:: Specify associations to eager load
+        # :select:: Specify columns to select from database when loading results
+        #
+        # ==== Returns
+        #
+        # Sunspot::Search:: Object containing results, totals, facets, etc.
+        #
+        def solr_search(options = {}, &block)
+          solr_execute_search(options) do
+            Sunspot.new_search(self, &block)
+          end
+        end
+
+        # 
+        # Get IDs of matching results without loading the result objects from
+        # the database. This method may be useful if search is used as an
+        # intermediate step in a larger find operation. The block is the same
+        # as the block provided to the #search method.
+        #
+        # ==== Returns
+        #
+        # Array:: Array of IDs, in the order returned by the search
+        #
+        def solr_search_ids(&block)
+          solr_execute_search_ids do
+            solr_search(&block)
+          end
+        end
+
+        # 
+        # Remove instances of this class from the Solr index.
+        #
+        def solr_remove_all_from_index
+          Sunspot.remove_all(self)
+        end
+
+        # 
+        # Remove all instances of this class from the Solr index and immediately
+        # commit.
+        #
+        #
+        def solr_remove_all_from_index!
+          Sunspot.remove_all!(self)
+        end
+
+        # 
+        # Completely rebuild the index for this class. First removes all
+        # instances from the index, then loads records and indexes them.
+        #
+        # See #index for information on options, etc.
+        #
+        def solr_reindex(options = {})
+          solr_remove_all_from_index
+          solr_index(options)
+        end
+
+        #
+        # Add/update all existing records in the Solr index. The
+        # +batch_size+ argument specifies how many records to load out of the
+        # database at a time. The default batch size is 500; if nil is passed,
+        # records will not be indexed in batches. By default, a commit is issued
+        # after each batch; passing +false+ for +batch_commit+ will disable
+        # this, and only issue a commit at the end of the process. If associated
+        # objects need to indexed also, you can specify +include+ in format 
+        # accepted by MongoMapper to improve your sql select performance
+        #
+        # ==== Options (passed as a hash)
+        #
+        # batch_size<Integer>:: Batch size with which to load records. Passing
+        #                       'nil' will skip batches.  Default is 500.
+        # batch_commit<Boolean>:: Flag signalling if a commit should be done after
+        #                         after each batch is indexed, default is 'true'
+        # include<Mixed>:: include option to be passed to the MongoMapper find,
+        #                  used for including associated objects that need to be
+        #                  indexed with the parent object, accepts all formats
+        #                  MongoMapper::Base.find does
+        # first_id:: The lowest possible ID for this class. Defaults to 0, which
+        #            is fine for integer IDs; string primary keys will need to
+        #            specify something reasonable here.
+        #
+        # ==== Examples
+        #   
+        #   # index in batches of 500, commit after each
+        #   Post.index 
+        #
+        #   # index all rows at once, then commit
+        #   Post.index(:batch_size => nil) 
+        #
+        #   # index in batches of 500, commit when all batches complete
+        #   Post.index(:batch_commit => false) 
+        #
+        #   # include the associated +author+ object when loading to index
+        #   Post.index(:include => :author) 
+        #
+        def solr_index(opts={})
+          options = { :batch_size => 500, :batch_commit => true, :include => self.sunspot_options[:include], :first_id => 0}.merge(opts)
+          unless options[:batch_size]
+            Sunspot.index!(all(:include => options[:include]))
+          else
+            batch_size = options[:batch_size]            
+            record_count = count
+            page = 1
+            while (page - 1) * batch_size < record_count
+              solr_benchmark options[:batch_size], page do
+                records = paginate(:page => page, :per_page => batch_size, :order => "id")
+                Sunspot.index(records)
+              end
+              Sunspot.commit if options[:batch_commit]
+              page += 1
+            end            
+            Sunspot.commit unless options[:batch_commit]
+          end
+        end
+
+        # 
+        # Return the IDs of records of this class that are indexed in Solr but
+        # do not exist in the database. Under normal circumstances, this should
+        # never happen, but this method is provided in case something goes
+        # wrong. Usually you will want to rectify the situation by calling
+        # #clean_index_orphans or #reindex
+        # 
+        # ==== Returns
+        #
+        # Array:: Collection of IDs that exist in Solr but not in the database
+        def solr_index_orphans
+          count = self.count
+          indexed_ids = solr_search_ids { paginate(:page => 1, :per_page => count) }.to_set
+          all(:select => 'id').each do |object|
+            indexed_ids.delete(object.id)
+          end
+          indexed_ids.to_a
+        end
+
+        # 
+        # Find IDs of records of this class that are indexed in Solr but do not
+        # exist in the database, and remove them from Solr. Under normal
+        # circumstances, this should not be necessary; this method is provided
+        # in case something goes wrong.
+        #
+        def solr_clean_index_orphans
+          solr_index_orphans.each do |id|
+            new do |fake_instance|
+              fake_instance.id = id
+            end.solr_remove_from_index
+          end
+        end
+
+        # 
+        # Classes that have been defined as searchable return +true+ for this
+        # method.
+        #
+        # ==== Returns
+        #
+        # +true+
+        #
+        def searchable?
+          true
+        end
+        
+        def solr_execute_search(options = {})
+          options.assert_valid_keys(:include, :select)
+          search = yield
+          unless options.empty?
+            search.build do |query|
+              if options[:include]
+                query.data_accessor_for(self).include = options[:include]
+              end
+              if options[:select]
+                query.data_accessor_for(self).select = options[:select]
+              end
+            end
+          end
+          search.execute
+        end
+
+        def solr_execute_search_ids(options = {})
+          search = yield
+          search.raw_results.map { |raw_result| raw_result.primary_key.to_i }
+        end
+        
+        protected
+        
+        # 
+        # Does some logging for benchmarking indexing performance
+        #
+        def solr_benchmark(batch_size, counter,  &block)
+          start = Time.now
+          logger.info("[#{Time.now}] Start Indexing")
+          yield
+          elapsed = Time.now-start
+          logger.info("[#{Time.now}] Completed Indexing. Rows indexed #{counter * batch_size}. Rows/sec: #{batch_size/elapsed.to_f} (Elapsed: #{elapsed} sec.)")
+        end
+
+      end
+
+      module InstanceMethods
+        def self.included(base) #:nodoc:
+          base.module_eval do
+            alias_method :index, :solr_index unless method_defined? :index
+            alias_method :index!, :solr_index! unless method_defined? :index!
+            alias_method :remove_from_index, :solr_remove_from_index unless method_defined? :remove_from_index
+            alias_method :remove_from_index!, :solr_remove_from_index! unless method_defined? :remove_from_index!
+            alias_method :more_like_this, :solr_more_like_this unless method_defined? :more_like_this
+            alias_method :more_like_this_ids, :solr_more_like_this_ids unless method_defined? :more_like_this_ids
+          end
+        end
+        # 
+        # Index the model in Solr. If the model is already indexed, it will be
+        # updated. Using the defaults, you will usually not need to call this
+        # method, as models are indexed automatically when they are created or
+        # updated. If you have disabled automatic indexing (see
+        # ClassMethods#searchable), this method allows you to manage indexing
+        # manually.
+        #
+        def solr_index
+          Sunspot.index(self)
+        end
+
+        # 
+        # Index the model in Solr and immediately commit. See #index
+        #
+        def solr_index!
+          Sunspot.index!(self)
+        end
+        
+        # 
+        # Remove the model from the Solr index. Using the defaults, this should
+        # not be necessary, as models will automatically be removed from the
+        # index when they are destroyed. If you disable automatic removal
+        # (which is not recommended!), you can use this method to manage removal
+        # manually.
+        #
+        def solr_remove_from_index
+          Sunspot.remove(self)
+        end
+
+        # 
+        # Remove the model from the Solr index and commit immediately. See
+        # #remove_from_index
+        #
+        def solr_remove_from_index!
+          Sunspot.remove!(self)
+        end
+
+        def solr_more_like_this(*args, &block)
+          options = args.extract_options!
+          self.class.solr_execute_search(options) do
+            Sunspot.new_more_like_this(self, *args, &block)
+          end
+        end
+
+        def solr_more_like_this_ids(&block)
+          self.class.solr_execute_search_ids do
+            solr_more_like_this(&block)
+          end
+        end
+
+        private
+
+        def maybe_mark_for_auto_indexing
+          @marked_for_auto_indexing =
+            if !new_record? && ignore_attributes = self.class.sunspot_options[:ignore_attribute_changes_of]
+              @marked_for_auto_indexing = !(changed.map { |attr| attr.to_sym } - ignore_attributes).blank?
+            else
+              true
+            end
+          true
+        end
+
+        def maybe_auto_index
+          if @marked_for_auto_indexing
+            solr_index
+            remove_instance_variable(:@marked_for_auto_indexing)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sunspot/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'sunspot/rails/spec_helper'
+
+Spec::Runner.configure do |config|
+  config.before(:each) do
+    ::Sunspot.session = ::Sunspot::Rails::StubSessionProxy.new(::Sunspot.session)
+  end
+
+  config.after(:each) do
+    ::Sunspot.session = ::Sunspot.session.original_session
+  end
+end