lunr 2.0.1 → 2.0.2

data/CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+=== 2.0.2 / 2010-09-02
+
+* Fix Rakefile typo.
+* Add ModelClass.first search helper.
+* Require Ruby >= 1.8.7.
+* Tighten Sunspot dep to = 1.1.0.
+* Improve the README a bit.
+
 === 2.0.1 / 2010-09-02
 
 * Clean up model and search.

data/Isolate

@@ -1,6 +1,6 @@
 options :system => false
 
-gem "sunspot", "~> 1.1.0"
+gem "sunspot", "1.1.0"
 
 env :development do
   gem "ZenTest",    "4.4.0"

data/README.rdoc

@@ -14,7 +14,7 @@ If you have complex indexes with a stored fields and need to search /
 access those fields without access to the original data store, Lunr
 might be what you're looking for.
 
-== Examples
+== A Lunr Model
 
   require "lunr"
 
@@ -47,10 +47,100 @@ might be what you're looking for.
     end
   end
 
+=== Including the Module
+
+All model class must <code>include Lunr::Model</code>.
+
+=== Define the Search Index
+
+Time to tell Solr what this class searches, and which fields are
+properties. The DSL in here is exactly the same as Sunspot's, with the
+addition of a <code>property</code> method. Calling
+<code>property</code> tells Lunr that you expect access to this field,
+generates an <code>attr_reader</code> and passes it along to Sunspot's
+DSL as <code>:stored => true</code>.
+
+    searches "Track" do
+      property :album,  :text
+      property :artist, :text
+      property :title,  :text
+
+      time    :accepted_at
+      boolean :hot
+      string  :state
+    end
+
+The <code>searches</code> method also takes an optional type name,
+which can be used to map Lunr model types to differing search
+results. In this case, <code>My::SimpleTrack</code> will search
+documents with an original type of <code>Track</code>.
+
+List every criteria you might want to search by, but omit any of
+Sunspot's DSL that involves indexing.
+
+=== Default Scope
+
+Call <code>scope</code> with no name to set default filtering,
+ordering, and pagination properties.
+
+    scope do |q|
+      q.order_by :hot, :desc
+      q.order_by :accepted_at, :desc
+
+      q.with :state, "accepted"
+    end
+
+=== Named Scopes
+
+You can define any number of named scopes to make searching
+simpler. They're made availble as static methods on the model class,
+and they're chainable when searching. See the "Searching" section
+below.
+
+    scope :hot do
+      with :hot, true
+    end
+
+Scope blocks without parameters are <code>instance_eval</code>ed in
+the Sunspot query DSL's context. If your scope takes parameters, the
+first param must be the Sunspot query object.
+
+    scope :state do |q, state|
+      q.with :state, state
+    end
+
+== Searching
+
+    My::SimpleTrack.search
+    My::SimpleTrack.all # same thing
+
+All searches return a <code>Lunr::Search</code> object, and searches
+can be narrowed using the Sunspot query DSL or named scopes. Searches
+aren't run until an <code>Enumerable</code>, arraylike, or pagination
+method is called on the search object. For convenience,
+<code>Lunr::Search</code> quacks like
+<code>WillPaginate::Collection</code>.
+
+   search = My::SimpleTrack.hot.scope { |q| q.fulltext "hello" }
+   p :page => search.page, :total => search.total
+
+   search.each do |track|
+     puts "#{track.title} by #{track.artist} on #{track.album}."
+   end
+
 == Installation
 
     $ gem install lunr
 
+== Development
+
+Version number notwithstanding, Lunr is under pretty heavy
+development. It's missing a lot of tests, and will be in flux a
+bit. Contributions and suggestions are very welcome.
+
+Install the <code>isolate</code> gem and run <code>rake</code>. All
+dev dependencies will be installed automatically.
+
 == License
 
 Copyright 2010 John Barnette (code@jbarnette.com)

data/Rakefile

@@ -11,6 +11,8 @@ Hoe.plugin :doofus, :git, :isolate
 Hoe.spec "lunr" do
   developer "John Barnette", "code@jbarnette.com"
 
+  require_ruby_version ">= 1.8.7"
+
   self.extra_rdoc_files = Dir["*.rdoc"]
   self.history_file     = "CHANGELOG.rdoc"
   self.readme_file      = "README.rdoc"

data/lib/lunr.rb

@@ -6,7 +6,7 @@ module Lunr
 
   # Duh.
 
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 
 end
 

data/lib/lunr/model/klass.rb

@@ -8,6 +8,10 @@ module Lunr
     end
 
     module Klass
+      def first &block
+        search(&block).first
+      end
+
       def properties
         @properties ||= {}
       end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lunr
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 11
   prerelease: false
   segments: 
   - 2
   - 0
-  - 1
-  version: 2.0.1
+  - 2
+  version: 2.0.2
 platform: ruby
 authors: 
 - John Barnette
@@ -24,7 +24,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
         hash: 19
         segments: 
@@ -213,10 +213,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 57
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: