mebla 1.0.0.rc2 → 1.0.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mebla (1.0.0.rc1)
+    mebla (1.0.0.rc2)
       bson (= 1.2.0)
       bson_ext (= 1.2.0)
       mebla

data/README.md

@@ -87,50 +87,26 @@ This will index all comments and make it available for searching directly throug
 Mebla supports two types of search, index search and model search; in index search Mebla searches
 the index and returns all matching documents regardless of their types, in model search however
 Mebla searches the index and returns matching documents of the model(s) type(s).
-documents
-
-Mebla performs search using [Slingshot's searching DSL](http://karmi.github.com/slingshot/), I encourage
-you to check the tutorial to have a broader view of slingshot's capabilities.
 
 #### Index searching
 
 Using the same models we defined above, we can search for all posts and comments with the author "cousine":
 
-    Mebla.search do
-      query do
-        string "author: cousine"
-      end
-    end
+    Mebla.search "author: cousine"
 
 This will return all documents with an author set to "cousine" regardless of their type, if we however want to
 search only Posts and Comments, we would explicitly tell Mebla:
 
-    Mebla.search [:post, :comment] do 
-      query { string "author: cousine" }
-    end
-    
-As shown above, you can also use the shorthand notation of ruby blocks.
+    Mebla.search "author: cousine", [:post, :comment]
 
 #### Model searching
 
 Instead of searching all models like index searching, we can search one model only:
 
-    Post.search do
-      query { string "title: Testing Search" }
-      
-      filter :term, :author => "cousine"
-      filter :terms, :tags => ["ruby", "rails"]
-      
-      sort { publish_date "desc" }
-      
-      facet 'tags' do
-        terms :tags, :global => true
-      end
-      
-      facet 'authors' do
-        terms :author
-      end
-    end
+    Post.search("title: Testing Search").desc(:publish_date).only(
+      :author => ["cousine"], 
+      :tags => ["ruby", "rails"]
+    ).facet('tags', :tags, :global => true).facet('authors', :author)
     
 In the above example we are taking full advantage of slingshot's searching capabilities, 
 we are getting all posts with the title "Testing Search", filtering the results with author 
@@ -147,28 +123,14 @@ In the example above we are retrieving two facets, "tags" and "authors"; "tags"
 which means that we want to get the counts of posts for each tag over the whole index, "authors"
 however will only get the count of posts matching the search query for each author.
 
-You can find more about searching [here](http://karmi.github.com/slingshot/)
-
 #### Retrieving results
 
 To retrieve the results of the model search we performed above we would simply:
 
-    hits = Post.search do
-      query { string "title: Testing Search" }
-      
-      filter :term, :author => "cousine"
-      filter :terms, :tags => ["ruby", "rails"]
-      
-      sort { publish_date "desc" }
-      
-      facet 'tags' do
-        terms :tags, :global => true
-      end
-      
-      facet 'authors' do
-        terms :author
-      end
-    end
+    hits = Post.search("title: Testing Search").desc(:publish_date).only(
+      :author => ["cousine"], 
+      :tags => ["ruby", "rails"]
+    ).facet('tags', :tags, :global => true).facet('authors', :author)
     
     hits.each do |hit|
       puts hit.title

data/VERSION

@@ -1 +1 @@
-1.0.0.rc2
+1.0.0

data/lib/generators/mebla/install/install_generator.rb

@@ -1,6 +1,6 @@
-# @private
+# A wrapper for slingshot  elastic-search adapter for Mongoid
 module Mebla  
-  # @private
+  # Generates the required files for Mebla to function
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path('../templates', __FILE__)
     
@@ -10,37 +10,26 @@ module Mebla
     end
     
     private
+    # Returns the rails application name
+    # @return [String]
     def app_name
       @app_name ||= defined_app_const_base? ? defined_app_name : File.basename(destination_root)
     end
 
+    # @private
+    # Returns the rails application name underscored
+    # @return [String]
     def defined_app_name
       defined_app_const_base.underscore
     end
 
+    # @private
+    # Returns the application CONSTANT    
     def defined_app_const_base
       Rails.respond_to?(:application) && defined?(Rails::Application) &&
         Rails.application.is_a?(Rails::Application) && Rails.application.class.name.sub(/::Application$/, "")
-      end
-
-    alias :defined_app_const_base? :defined_app_const_base
-
-    def app_const_base
-      @app_const_base ||= defined_app_const_base || app_name.gsub(/\W/, '_').squeeze('_').camelize
     end
 
-    def app_const
-      @app_const ||= "#{app_const_base}::Application"
-    end
-
-    def valid_app_const?
-      if app_const =~ /^\d/
-        raise Error, "Invalid application name #{app_name}. Please give a name which does not start with numbers."
-      elsif RESERVED_NAMES.include?(app_name)
-        raise Error, "Invalid application name #{app_name}. Please give a name which does not match one of the reserved rails words."
-      elsif Object.const_defined?(app_const_base)
-        raise Error, "Invalid application name #{app_name}, constant #{app_const_base} is already in use. Please choose another application name."
-      end
-    end
+    alias :defined_app_const_base? :defined_app_const_base    
   end
 end

data/lib/mebla/configuration.rb

@@ -1,7 +1,7 @@
 require 'erb'
 require 'singleton'
 
-# @private
+# A wrapper for slingshot  elastic-search adapter for Mongoid
 module Mebla
   # Parses the configuration file and holds important configuration attributes  
   class Configuration
@@ -11,6 +11,7 @@ module Mebla
     attr_accessor :index, :host, :port, :logger
     
     # @private
+    # Initializes a new configuration object
     def initialize
       @log_dir = "#{Dir.pwd}/tmp/log"
       parse_config      
@@ -21,10 +22,10 @@ module Mebla
       @port ||= 9200
       
       make_tmp_dir
-      @logger = Logger.new(
+      @logger = ActiveSupport::BufferedLogger.new(
         open("#{@log_dir}/mebla.log", "a")
       )
-      @logger.level = Logger::DEBUG
+      @logger.level = ActiveSupport::BufferedLogger::Severity::DEBUG
       
       setup_logger        
       
@@ -35,10 +36,7 @@ module Mebla
     # Sets up the default settings of the logger
     # @return [nil]
     def setup_logger
-      @logger.datetime_format = "%Y-%m-%d %H:%M:%S"
-      @logger.formatter = proc { |severity, datetime, progname, msg|
-        "#{datetime}: #{msg}\n"
-      }
+      @logger.auto_flushing = true      
     end
     
     # Returns the proper url for elasticsearch

data/lib/mebla/context.rb

@@ -1,4 +1,4 @@
-# @private
+# A wrapper for slingshot  elastic-search adapter for Mongoid
 module Mebla
   # Handles indexing and reindexing
   class Context    
@@ -6,6 +6,7 @@ module Mebla
     attr_reader  :mappings
     
     # @private
+    # Creates a new context object
     def initialize            
       @indexed_models = []
       @mappings = {}
@@ -30,9 +31,9 @@ module Mebla
     # @return [nil]
     def rebuild_index
       # Only rebuild if the index exists
-      raise ::Mebla::Errors::MeblaIndexException.new("#{@slingshot_index_name} does not exist !! use #create_index to create the index first.") unless index_exists?
+      raise Mebla::Errors::MeblaIndexException.new("#{@slingshot_index_name} does not exist !! use #create_index to create the index first.") unless index_exists?
 
-      ::Mebla.log("Rebuilding index")      
+      Mebla.log("Rebuilding index")      
       
       # Delete the index
       if drop_index
@@ -46,9 +47,9 @@ module Mebla
     # @return [Boolean] true if operation is successful
     def create_index
       # Only create the index if it doesn't exist
-      raise ::Mebla::Errors::MeblaIndexException.new("#{@slingshot_index_name} already exists !! use #rebuild_index to rebuild the index.") if index_exists?
+      raise Mebla::Errors::MeblaIndexException.new("#{@slingshot_index_name} already exists !! use #rebuild_index to rebuild the index.") if index_exists?
       
-      ::Mebla.log("Creating index")
+      Mebla.log("Creating index")
       
       # Create the index
       build_index
@@ -60,12 +61,12 @@ module Mebla
       # Only drop the index if it exists
       return true unless index_exists?
       
-      ::Mebla.log("Dropping index: #{self.slingshot_index_name}", :debug)
+      Mebla.log("Dropping index: #{self.slingshot_index_name}", :debug)
       
       # Drop the index
       result = @slingshot_index.delete
       
-      ::Mebla.log("Dropped #{self.slingshot_index_name}: #{result.to_s}", :debug)
+      Mebla.log("Dropped #{self.slingshot_index_name}: #{result.to_s}", :debug)
       
       # Check that the index doesn't exist
       !index_exists?
@@ -86,13 +87,13 @@ module Mebla
     # @param *models a list of symbols each representing a model name to be indexed
     # @return [nil]
     def index_data(*models)
-      if models.empty?
+      if models.nil? || models.empty?
         only_index = @indexed_models
       else
         only_index = models.collect{|m| m.to_s}
       end
       
-      ::Mebla.log("Indexing #{only_index.join(", ")}", :debug)
+      Mebla.log("Indexing #{only_index.join(", ")}", :debug)
       
       # Build up a bulk query to save processing and time
       bulk_query = ""
@@ -103,7 +104,7 @@ module Mebla
       if create_index
         # Start collecting documents
         only_index.each do |model|
-          ::Mebla.log("Indexing: #{model}")
+          Mebla.log("Indexing: #{model}")
           # Get the class
           to_index = model.camelize.constantize
           
@@ -141,13 +142,10 @@ module Mebla
           end
         end
       else
-        raise ::Mebla::Errors::MeblaIndexException.new("Could not create #{@slingshot_index_name}!!!")
-      end
-      
-      # Add a new line to the query
-      bulk_query << '\n'
+        raise Mebla::Errors::MeblaIndexException.new("Could not create #{@slingshot_index_name}!!!")
+      end      
       
-      ::Mebla.log("Bulk indexing:\n#{bulk_query}", :debug)
+      Mebla.log("Bulk indexing:\n#{bulk_query}", :debug)      
       
       # Send the query
       response = Slingshot::Configuration.client.post "#{Mebla::Configuration.instance.url}/_bulk", bulk_query
@@ -155,54 +153,58 @@ module Mebla
       # Only refresh the index if no error ocurred
       unless response =~ /error/                              
         # Log results
-        ::Mebla.log("Indexed #{only_index.count} model(s) to #{self.slingshot_index_name}: #{response}")
-        ::Mebla.log("Indexing Report:")
+        Mebla.log("Indexed #{only_index.count} model(s) to #{self.slingshot_index_name}: #{response}")
+        Mebla.log("Indexing Report:")
         indexed_count.each do |model_name, count|
-          ::Mebla.log("Indexed #{model_name}: #{count} document(s)")
+          Mebla.log("Indexed #{model_name}: #{count} document(s)")
         end
         
         # Refresh the index
         refresh_index
       else
-        raise ::Mebla::Errors::MeblaIndexException.new("Indexing #{only_index.join(", ")} failed with the following response:\n #{response}")
+        raise Mebla::Errors::MeblaIndexException.new("Indexing #{only_index.join(", ")} failed with the following response:\n #{response}")
       end
     rescue RestClient::Exception => error
-      raise ::Mebla::Errors::MeblaIndexException.new("Indexing #{only_index.join(", ")} failed with the following error: #{error.message}")
+      raise Mebla::Errors::MeblaIndexException.new("Indexing #{only_index.join(", ")} failed with the following error: #{error.message}")
     end
     
     # Rebuilds the index and indexes the data for all models or a list of models given
     # @param *models a list of symbols each representing a model name to rebuild it's index
     # @return [nil]
     def reindex_data(*models)   
-      ::Mebla.log("Rendexing: #{self.slingshot_index_name}")
+      Mebla.log("Rendexing: #{self.slingshot_index_name}")
       
       unless drop_index
-        raise ::Mebla::Errors::MeblaIndexException.new("Could not drop #{@slingshot_index_name}!!!")
+        raise Mebla::Errors::MeblaIndexException.new("Could not drop #{@slingshot_index_name}!!!")
       end        
       
       # Create the index and index the data
-      index_data(models)      
+      if models && !models.empty?
+        index_data(models)
+      else
+        index_data
+      end
     end
         
     # Refreshes the index
     # @return [nil]
     def refresh_index
-      ::Mebla.log("Refreshing: #{self.slingshot_index_name}", :debug)
+      Mebla.log("Refreshing: #{self.slingshot_index_name}", :debug)
       
       result = @slingshot_index.refresh
       
-      ::Mebla.log("Refreshed #{self.slingshot_index_name}: #{result}")
+      Mebla.log("Refreshed #{self.slingshot_index_name}: #{result}")
     end
     
     private          
     # Builds the index according to the mappings set
     # @return [Boolean] true if the index was created successfully, false otherwise
     def build_index 
-      ::Mebla.log("Building index", :debug)
+      Mebla.log("Building #{self.slingshot_index_name}", :debug)
       # Create the index
       result = @slingshot_index.create :mappings => @mappings 
       
-      ::Mebla.log("Created index: #{result.to_s}")
+      Mebla.log("Created #{self.slingshot_index_name}: #{result.to_s}")
       
       # Check if the index exists
       index_exists?

data/lib/mebla/errors/mebla_configuration_exception.rb

@@ -1,6 +1,6 @@
-# @private
+# A wrapper for slingshot  elastic-search adapter for Mongoid
 module Mebla
-  # @private
+  # Represents the parent module for all errors in Mebla
   module Errors
     # Thrown when configuration fails
     # @note this is a fatal exception

data/lib/mebla/errors/mebla_error.rb

@@ -1,6 +1,6 @@
-# @private
+# A wrapper for slingshot  elastic-search adapter for Mongoid
 module Mebla
-  # @private
+  # Represents the parent module for all errors in Mebla
   module Errors
     # Default parent Mebla error for all custom non-fatal errors.
     class MeblaError < ::StandardError      

data/lib/mebla/errors/mebla_fatal.rb

@@ -1,6 +1,6 @@
-# @private
+# A wrapper for slingshot  elastic-search adapter for Mongoid
 module Mebla
-  # @private
+  # Represents the parent module for all errors in Mebla
   module Errors
     # Default parent Mebla error for all custom fatal errors.
     class MeblaFatal < ::StandardError

data/lib/mebla/errors/mebla_index_exception.rb

@@ -1,6 +1,6 @@
-# @private
+# A wrapper for slingshot  elastic-search adapter for Mongoid
 module Mebla
-  # @private
+  # Represents the parent module for all errors in Mebla
   module Errors
     # Thrown when an index operation fails
     # @note this is a fatal exception

data/lib/mebla/errors/mebla_synchronization_exception.rb

@@ -1,6 +1,6 @@
-# @private
+# A wrapper for slingshot  elastic-search adapter for Mongoid
 module Mebla
-  # @private
+  # Represents the parent module for all errors in Mebla
   module Errors
     # Thrown when a synchronization operation fails
     class MeblaSynchronizationException < MeblaError      

data/lib/mebla/errors.rb

@@ -0,0 +1,11 @@
+# A wrapper for slingshot  elastic-search adapter for Mongoid
+module Mebla
+  # Represents the parent module for all errors in Mebla
+  module Errors
+    autoload :MeblaError, 'mebla/errors/mebla_error'
+    autoload :MeblaFatal, 'mebla/errors/mebla_fatal'
+    autoload :MeblaConfigurationException, 'mebla/errors/mebla_configuration_exception'
+    autoload :MeblaIndexException, 'mebla/errors/mebla_index_exception'
+    autoload :MeblaSynchronizationException, 'mebla/errors/mebla_synchronization_exceptions'
+  end
+end

data/lib/mebla/log_subscriber.rb

@@ -1,6 +1,6 @@
 require 'active_support/log_subscriber'
 
-# @private
+# A wrapper for slingshot  elastic-search adapter for Mongoid
 module Mebla
   # Handles logging
   class LogSubscriber < ActiveSupport::LogSubscriber
@@ -11,27 +11,27 @@ module Mebla
 
     # Error message
     def mebla_error(event)
-      error_red event.payload[:message]
+      error_red event.payload[:message]      
     end
     
     # Info message    
     def mebla_info(event)
-      info_blue event.payload[:message]
+      info_blue event.payload[:message]      
     end
     
     # Fatal message
     def mebla_fatal(event)
-      fatal_magenta event.payload[:message]
+      fatal_magenta event.payload[:message]      
     end
 
     # Warning message
     def mebla_warn(event)
-      warn_yellow event.payload[:message]
+      warn_yellow event.payload[:message]      
     end
     
-    # Unkown message
-    def mebla_unkown(event)
-      unkown event.payload[:message]
+    # Unknown message
+    def mebla_unknown(event)
+      unknown event.payload[:message]      
     end
     
     # --
@@ -42,7 +42,7 @@ module Mebla
     
     # Print a debug message to the log file
     def debug_green(msg)
-      debug color(msg, LogSubscriber::Green)
+      debug color(msg, LogSubscriber::GREEN)
     end
     
     # Print an error message to the log file
@@ -52,7 +52,7 @@ module Mebla
     
     # Print an info message to the log file
     def info_blue(msg)
-      ingo color(msg, LogSubscriber::BLUE)
+      info color(msg, LogSubscriber::BLUE)
     end
     
     # Print a fatal message to the log file
@@ -67,11 +67,8 @@ module Mebla
     
     # Returns the main logger for Mebla
     # @return [Logger]
-    def logger
+    def self.logger
       Mebla::Configuration.instance.logger
     end
   end    
-end
-
-# Register the logger
-Mebla::LogSubscriber.attach_to :mebla
+end

data/lib/mebla/mongoid/mebla.rb

@@ -42,6 +42,7 @@ module Mongoid
       self.whiny_indexing = false
     end
     
+    # Defines class methods for Mongoid::Mebla
     module ClassMethods
       # Defines which fields should be indexed and searched
       # @param [*opts] fields
@@ -123,20 +124,15 @@ module Mongoid
         ::Mebla.context.add_indexed_model(self, self.slingshot_type_name.to_sym => prepare_mappings)
       end
             
-      # Searches the model using Slingshot search DSL
-      # @return [ResultSet]
+      # Searches the model using Slingshot search DSL      
+      # @param [String] query a string representing the search query  
+      # @return [Mebla::Search]
       #
-      # Search for posts with the title 'Testing Search'::
+      # Search for all posts with a field 'title' of value 'Testing Search'::
       #
-      #  Post.search do
-      #   query do
-      #    string "title: Testing Search"
-      #   end
-      #  end
-      #
-      # @note For more information about Slingshot search DSL, check http://karmi.github.com/slingshot
-      def search(&block)
-        ::Mebla.search(self.slingshot_type_name, &block)
+      #  Post.search "title: Testing Search" 
+      def search(query = "")
+        ::Mebla.search(query, self.slingshot_type_name)
       end
       
       # Retrieves the type name of the model 
@@ -244,6 +240,7 @@ module Mongoid
       return false
     end
     
+    # Raises synchronization exception in either #add_to_index or #remove_from_index
     def raise_synchronization_exception(error)
       exception_message = "#{self.class.slingshot_type_name} synchronization failed with the following error: #{error.message}"
       if self.class.whiny_indexing

data/lib/mebla/railtie.rb

@@ -1,34 +1,35 @@
 require 'mebla'
 require 'rails'
 
-# @private
+# A wrapper for slingshot  elastic-search adapter for Mongoid
 module Mebla
   # @private
+  # Railtie for Mebla
   class Railtie < Rails::Railtie
     # Configuration
      initializer "mebla.set_configs" do |app|
       Mebla.configure do |config|
         # Open logfile
-        config.logger = Logger.new(
-          open("#{Dir.pwd}/logs/#{Rails.env}.mebla.log", "a")
+        config.logger = ActiveSupport::BufferedLogger.new(
+          open("#{Dir.pwd}/log/#{Rails.env}.mebla.log", "a")
         )
         # Setup the log level
         config.logger.level = case app.config.log_level
           when :info
-            Logger::INFO
+            ActiveSupport::BufferedLogger::Severity::INFO
           when :warn
-            Logger::WARN          
+            ActiveSupport::BufferedLogger::Severity::WARN          
           when :error
-            Logger::ERROR
+            ActiveSupport::BufferedLogger::Severity::ERROR
           when :fatal
-            Logger::FATAL
+            ActiveSupport::BufferedLogger::Severity::FATAL
           else
-            Logger::DEBUG
+            ActiveSupport::BufferedLogger::Severity::DEBUG
           end
           
         config.setup_logger
       end
-    end
+    end    
     
     # Rake tasks
     rake_tasks do

data/lib/mebla/result_set.rb

@@ -1,4 +1,4 @@
-# @private
+# A wrapper for slingshot  elastic-search adapter for Mongoid
 module Mebla
   # Represents a set of search results  
   class ResultSet
@@ -14,8 +14,8 @@ module Mebla
     def initialize(response)
       # Keep the query time
       @time = response['took'] 
-      # Keep the facets
-      @facets = response['facets']      
+      # Keep the facets      
+      @facets = response['facets']
       # Keep the query total to check against the count 
       @total = response['hits']['total']