rmla 1.0

data/.document

@@ -0,0 +1,6 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt
+TODO.md

data/.rspec

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

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+
+gem 'slingshot-rb', 			'0.0.8'
+gem 'mongoid', 						'>= 2.1.8'
+
+group :development do
+  gem "bson_ext", 				"~> 1.3.1"
+  gem "bundler", 					"1.2.0.pre"
+  gem "jeweler", 					"~> 1.6.4"
+  gem "rcov", 						">= 0"
+	gem 'rspec', 						'~> 2.3.0'
+  gem 'yard', 						'~> 0.6.0'
+  gem 'mongoid-rspec', 		'~> 1.4.4'
+  gem 'database_cleaner', '0.6.4'
+  gem 'bluecloth', 				'~> 2.1.0'
+
+  #optional but handy
+  gem 'irbtools', :require => 'irbtools/configure'
+  
+  gem "ruby-debug", :platform => :ruby_18
+  gem "ruby-debug19", :platform => :ruby_19
+end

data/Gemfile.lock

@@ -0,0 +1,139 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.10)
+      activesupport (= 3.0.10)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activesupport (3.0.10)
+    alias (0.2.2)
+    archive-tar-minitar (0.5.2)
+    awesome_print (0.4.0)
+    bluecloth (2.1.0)
+    boson (0.3.4)
+      alias (>= 0.2.2)
+      hirb (>= 0.5.0)
+    bson (1.3.1)
+    bson_ext (1.3.1)
+    builder (2.1.2)
+    clipboard (0.9.9)
+    coderay (1.0.5)
+    columnize (0.3.6)
+    database_cleaner (0.6.4)
+    diff-lcs (1.1.2)
+    every_day_irb (1.1.1)
+    fancy_irb (0.7.2)
+      paint (>= 0.8.1)
+      unicode-display_width (>= 0.1.1)
+    g (1.5.0)
+      ruby_gntp
+    git (1.2.5)
+    hirb (0.5.0)
+    i18n (0.5.0)
+    interactive_editor (0.0.10)
+      spoon (>= 0.0.1)
+    irbtools (1.1.1)
+      awesome_print (~> 0.4.0)
+      boson (>= 0.3.4)
+      clipboard (>= 0.9.9)
+      coderay (~> 1.0.0)
+      every_day_irb (>= 1.1.1)
+      fancy_irb (>= 0.7.2)
+      g (>= 1.4.0)
+      hirb (~> 0.5.0)
+      interactive_editor (>= 0.0.10)
+      looksee (~> 1.0.3)
+      method_locator (>= 0.0.4)
+      method_source (>= 0.6.7)
+      methodfinder (>= 1.2.3)
+      ori (~> 0.1.0)
+      paint (>= 0.8.3)
+      rvm_loader (>= 1.0.0)
+      sketches (>= 0.1.1)
+      wirb (>= 0.4.1)
+      zucker (>= 11)
+    jeweler (1.6.4)
+      bundler (1.2.0.pre)
+      git (>= 1.2.5)
+      rake
+    linecache (0.46)
+      rbx-require-relative (> 0.0.4)
+    linecache19 (0.5.12)
+      ruby_core_source (>= 0.1.4)
+    looksee (1.0.3)
+    method_locator (0.0.4)
+    method_source (0.7.0)
+    methodfinder (1.2.5)
+    mime-types (1.16)
+    mongo (1.3.1)
+      bson (>= 1.3.1)
+    mongoid (2.1.8)
+      activemodel (~> 3.0)
+      mongo (~> 1.3)
+      tzinfo (~> 0.3.22)
+    mongoid-rspec (1.4.4)
+      mongoid (~> 2.0)
+      rspec (~> 2)
+    ori (0.1.0)
+    paint (0.8.3)
+    rake (0.9.2)
+    rbx-require-relative (0.0.5)
+    rcov (0.9.9)
+    rest-client (1.6.3)
+      mime-types (>= 1.16)
+    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)
+    ruby-debug (0.10.4)
+      columnize (>= 0.1)
+      ruby-debug-base (~> 0.10.4.0)
+    ruby-debug-base (0.10.4)
+      linecache (>= 0.3)
+    ruby-debug-base19 (0.11.25)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.5)
+      archive-tar-minitar (>= 0.5.2)
+    ruby_gntp (0.3.4)
+    rvm_loader (1.0.0)
+    sketches (0.1.1)
+    slingshot-rb (0.0.8)
+      bundler (1.2.0.pre)
+      rest-client (~> 1.6.0)
+      yajl-ruby (> 0.7.9)
+    spoon (0.0.1)
+    tzinfo (0.3.29)
+    unicode-display_width (0.1.1)
+    wirb (0.4.1)
+    yajl-ruby (0.8.2)
+    yard (0.6.7)
+    zucker (11)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bluecloth (~> 2.1.0)
+  bson_ext (~> 1.3.1)
+  bundler (1.2.0.pre)
+  database_cleaner (= 0.6.4)
+  irbtools
+  jeweler (~> 1.6.4)
+  mongoid (>= 2.1.8)
+  mongoid-rspec (~> 1.4.4)
+  rcov
+  rspec (~> 2.3.0)
+  ruby-debug
+  ruby-debug19
+  slingshot-rb (= 0.0.8)
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Omar Mekky
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,255 @@
+Mebla
+====
+
+Mebla is an [elasticsearch](http://www.elasticsearch.org) wrapper for [Mongoid](http://mongoid.org) based on 
+[Slingshot](https://github.com/karmi/slingshot).
+
+Name
+---------
+
+Mebla is derived from the word "Nebla", which means slingshot in arabic.
+
+Also since its a wrapper for mongoid ODM, the letter "N" is replaced with "M".
+
+Installation
+---------------
+
+### Install elasticsearch
+
+Mebla requires a running [elasticsearch](http://www.elasticsearch.org) installation.
+
+To install elasticsearch follow the uptodate instructions [here](http://www.elasticsearch.org/guide/reference/setup/) or
+simply copy and paste in your terminal window:
+
+    $ curl -k -L -o elasticsearch-0.15.0.tar.gz http://github.com/downloads/elasticsearch/elasticsearch/elasticsearch-0.15.0.tar.gz
+    $ tar -zxvf elasticsearch-0.15.0.tar.gz
+    $ ./elasticsearch-0.15.0/bin/elasticsearch -f
+
+### Install Mebla
+
+Once elasticsearch is installed, add Mebla to your gem file:
+
+    gem "mebla"
+    
+then run bundle in your application root to update your gems' bundle:
+
+    $ bundle install
+    
+next generate the configuration file:
+
+    $ rails generate mebla:install
+    
+finally index your data:
+
+    $ rake mebla:index_data
+    
+Usage
+---------
+
+### Defining indexed fields
+
+To enable searching models, you first have to define which fields mebla should index:
+
+    class Post
+      include Mongoid::Document
+      include Mongoid::Mebla
+      field :title
+      field :author
+      field :body
+      field :publish_date, :type => Date
+      field :tags, :type => Array
+      
+      embeds_many :comments
+      search_in :author, :body, :publish_date, :tags, :title => { :boost => 2.0, :analyzer => 'snowball' }
+    end
+    
+In the example above, mebla will index the author field, body field, publish_date field and finally indexes
+the title field with some custom [mappings](http://www.elasticsearch.org/guide/reference/mapping).
+
+#### Embedded documents
+
+You can also index embedded documents as follows:
+
+    class Comment
+      include Mongoid::Document
+      include Mongoid::Mebla
+      field :comment
+      field :author
+      
+      embedded_in :blog_post
+      search_in :comment, :author, :embedded_in => :blog_post
+    end
+    
+This will index all comments and make it available for searching directly through the Comment model.
+
+#### Indexing methods
+
+You can also index method results:
+
+    class Post
+      include Mongoid::Document
+      include Mongoid::Mebla
+      field :title
+      field :author
+      field :body
+      field :publish_date, :type => Date
+      field :tags, :type => Array
+      
+      embeds_many :comments
+      search_in :author, :body, :publish_date, :tags, :permalink, :title => { :boost => 2.0, :analyzer => 'snowball' }
+      
+      def permalink
+        self.title.gsub(/\s/, "-").downcase
+      end
+    end
+    
+This will index the result of the method permalink.
+
+#### Indexing fields of relations
+
+You can also index fields of relations:
+
+    class Post
+      include Mongoid::Document
+      include Mongoid::Mebla
+      field :title
+      field :author
+      field :body
+      field :publish_date, :type => Date
+      field :tags, :type => Array
+      
+      embeds_many :comments
+      search_in :author, :body, :publish_date, :tags, :title => { :boost => 2.0, :analyzer => 'snowball' },
+        :search_relations => {:comments => :author}
+    end
+    
+This will index authors of all comments embedded with this Post.
+
+### Searching the index
+
+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).
+
+#### Index searching
+
+Using the same models we defined above, we can search for all posts and comments with the author "cousine":
+
+    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 "author: cousine", [:post, :comment]
+
+#### Model searching
+
+Instead of searching all models like index searching, we can search one model only:
+
+    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 
+"cousine", tagged "ruby" or "rails", and sorting the results with their publish_date fields.
+
+One more feature we are using is "Faceted Search", from Slingshot's homepage:
+
+> _Faceted Search_
+>
+> _ElasticSearch makes it trivial to retrieve complex aggregated data from the index/database, so called 
+[facets](http://www.lucidimagination.com/Community/Hear-from-the-Experts/Articles/Faceted-Search-Solr)._
+
+In the example above we are retrieving two facets, "tags" and "authors"; "tags" are global
+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.
+
+#### Retrieving results
+
+To retrieve the results of the model search we performed above we would simply:
+
+    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
+    end
+    
+To retrieve the facets:
+
+    # Get the count of posts for each tag accross the index
+    hits.facets['tags']['terms'].each do |facet|
+      puts "#{facet['term']} : #{facet['count']}"
+    end
+    
+    # Get the count of posts matching the query for each author
+    hits.facets['authors']['terms'].each do |facet|
+      puts "#{facet['term']} : #{facet['count']}"
+    end
+    
+### Indexing data
+
+#### Synchronizing data
+
+By default Mebla synchronizes all changes done to your models with your index, if however
+you would like to bypass this behavior:
+
+    Post.without_indexing do
+      Post.create :title => "This won't be indexed"
+    end
+    
+#### Indexing existing data
+
+You can index existing data by using the "index" rake task:
+
+    $ rake mebla:index
+    
+This will create the index and index all the data in the database
+
+#### Reindexing
+
+Just like indexing, you can reindex your data using the "reindex" rake task:
+
+    $ rake mebla:reindex
+    
+This will rebuild the index and index all your data again, note that unlike other full-text
+search engines, you don't need to reindex your data frequently (if ever) however you 
+might want to refresh the index so changes are reflected on the index.
+
+#### Refreshing the index
+
+Refreshing the index makes changes done to the index available for searching or modification.
+
+Mebla automatically refreshes the index whenever a change is done, but just incase you
+need to refresh the index:
+
+    $ rake mebla:refresh
+    
+### Rake tasks
+
+Mebla provides a number of rake tasks to perform various tasks on the index, you can
+list all tasks using this command:
+
+    $ rake -T mebla
+
+Contributing to Mebla
+----------------------------
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+-------------
+
+Copyright (c) 2011 Omar Mekky. See LICENSE.txt for
+further details.
+