lunr 2.0.2 → 2.0.3

data/CHANGELOG.rdoc

@@ -1,3 +1,10 @@
+=== 2.0.3 / 2010-09-07
+
+* Cleanups, squash warnings.
+* Improve the README a bit.
+* Improve search and scope examples.
+* Remove unnecessary monkeypatch.
+
 === 2.0.2 / 2010-09-02
 
 * Fix Rakefile typo.

data/README.rdoc

@@ -6,13 +6,11 @@
 
 A simple read-only interface to Solr, built on Sunspot.
 
-Lunr makes it easy to query and create objects from a Solr index
-without requiring all the knowledge, code, and data that was used to
-build the index in the first place.
-
-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.
+Lunr makes it easy to query and create objects from a Sunspot-managed
+Solr index without requiring all the knowledge, code, and data used to
+build the index in the first place. 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.
 
 == A Lunr Model
 
@@ -31,11 +29,11 @@ might be what you're looking for.
       string  :state
     end
 
-    scope do |q|
-      q.order_by :hot, :desc
-      q.order_by :accepted_at, :desc
+    scope do
+      order_by :hot, :desc
+      order_by :accepted_at, :desc
 
-      q.with :state, "accepted"
+      with :state, "accepted"
     end
 
     scope :hot do
@@ -83,11 +81,11 @@ Sunspot's DSL that involves indexing.
 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
+    scope do
+      order_by :hot, :desc
+      order_by :accepted_at, :desc
 
-      q.with :state, "accepted"
+      with :state, "accepted"
     end
 
 === Named Scopes
@@ -111,9 +109,14 @@ first param must be the Sunspot query object.
 
 == Searching
 
+Use Sunspot's excellent search DSL for ad hock searches.
+
     My::SimpleTrack.search
     My::SimpleTrack.all # same thing
 
+    My::SimpleTrack.search { with :title, "Hello" }
+    My::SimpleTrack.first  { with :title, "First!" }
+
 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
@@ -134,8 +137,8 @@ method is called on the search object. For convenience,
 
 == Development
 
-Version number notwithstanding, Lunr is under pretty heavy
-development. It's missing a lot of tests, and will be in flux a
+Lunr is under pretty heavy development. It was extracted from a Real
+Application, and barely has any tests of its own. It will be in flux a
 bit. Contributions and suggestions are very welcome.
 
 Install the <code>isolate</code> gem and run <code>rake</code>. All

data/lib/lunr.rb

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

data/lib/lunr/model.rb

@@ -2,7 +2,7 @@ require "lunr/model/klass"
 
 module Lunr
   module Model
-    attr_reader :id
+    attr_accessor :id
 
     def to_h
       @to_h ||= {}.tap do |h|

data/lib/lunr/model/klass.rb

@@ -8,6 +8,26 @@ module Lunr
     end
 
     module Klass
+      def create hit
+        new.tap do |instance|
+          instance.id = hit.primary_key
+
+          properties.each do |name, type|
+            value = hit.stored name
+
+            # For text fields, which always appear to be multiple.
+
+            if Array === value && value.length == 1 && type == :text
+              value = value.first
+            end
+
+            instance.send "#{name}=", value
+          end
+
+          instance.freeze
+        end
+      end
+
       def first &block
         search(&block).first
       end
@@ -20,12 +40,12 @@ module Lunr
         @scopes ||= {}
       end
 
-      def scope sym = :all, &block
-        scopes[sym] = block
+      def scope name = :all, &block
+        scopes[name] = block
 
-        unless sym == :all
+        unless name == :all
           class_eval <<-END, __FILE__, __LINE__ + 1
-            def self.#{sym}; search.#{sym} end
+            def self.#{name}; search.#{name} end
           END
         end
       end
@@ -36,12 +56,12 @@ module Lunr
 
       alias_method :all, :search
 
-      def searches classname, &block
-        Sunspot::TypeField.alias self, classname
+      def searches classname = nil, &block
+        Sunspot::TypeField.alias self, classname if classname
         Sunspot.setup self, &block
 
         properties.each do |name, type|
-          attr_reader name
+          attr_accessor name
         end
       end
     end

data/lib/lunr/search.rb

@@ -17,8 +17,8 @@ module Lunr
 
       all = @klass.scopes[:all]
 
-      scope &all   if all
-      scope &block if block_given?
+      scope(&all)   if all
+      scope(&block) if block_given?
     end
 
     def each &block
@@ -37,15 +37,15 @@ module Lunr
       @executed
     end
 
-    def method_missing sym, *args
-      return super unless scope = klass.scopes[sym]
+    def method_missing name, *args
+      return super unless scope = klass.scopes[name]
 
       executable!
 
       dsl = @search.send :dsl
 
       if args.empty?
-        dsl.instance_eval &scope
+        dsl.instance_eval(&scope)
       else
         scope.call dsl, args
       end
@@ -58,8 +58,8 @@ module Lunr
     end
 
     def pages
-      total / per +
-        (total_entries % per_page > 0 ? 1 : 0)
+      @pages ||= total / per +
+        ((total_entries % per_page) > 0 ? 1 : 0)
     end
 
     def params
@@ -70,13 +70,15 @@ module Lunr
       @per ||= execute && @search.query.per_page
     end
 
-    def respond_to sym, include_private = false
-      klass.scopes.key?(sym) || super
+    def respond_to name, include_private = false
+      klass.scopes.key?(name) || super
     end
 
     def scope &block
       executable!
-      @search.build &block
+      @search.build(&block)
+
+      self
     end
 
     def total
@@ -95,27 +97,12 @@ module Lunr
     private
 
     def execute
-      unless @executed
+      unless executed?
         @executed = true
         @search.execute
 
         @results = @search.hits.map do |hit|
-          # FIX: this belongs in the model.
-          klass.new.tap do |model|
-            model.instance_variable_set :"@id", hit.primary_key
-
-            klass.properties.each do |name, type|
-              value = hit.stored name
-
-              # For text fields, which always appear to be multiple.
-
-              if Array === value && value.length == 1 && type == :text
-                value = value.first
-              end
-
-              model.instance_variable_set :"@#{name}", value
-            end
-          end
+          klass.create hit
         end
       end
 

data/lib/lunr/sunspot.rb

@@ -10,18 +10,12 @@ module Sunspot
     end
   end
 
-  class Field
-    def stored?
-      @stored
-    end
-  end
-
   module Search
     class Hit
       alias_method :original_initialize, :initialize
 
       def initialize *args
-        original_initialize *args
+        original_initialize(*args)
 
         if clazz = Sunspot::TypeField.aliases_inverted[@class_name]
           @class_name = clazz.name
@@ -46,6 +40,8 @@ module Sunspot
       end
     end
 
+    alias_method :old_to_indexed, :to_indexed
+
     def to_indexed clazz
       self.class.aliases[clazz] || clazz.name
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lunr
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: false
   segments: 
   - 2
   - 0
-  - 2
-  version: 2.0.2
+  - 3
+  version: 2.0.3
 platform: ruby
 authors: 
 - John Barnette
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-02 00:00:00 -07:00
+date: 2010-09-07 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -165,13 +165,11 @@ dependencies:
 description: |-
   A simple read-only interface to Solr, built on Sunspot.
   
-  Lunr makes it easy to query and create objects from a Solr index
-  without requiring all the knowledge, code, and data that was used to
-  build the index in the first place.
-  
-  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.
+  Lunr makes it easy to query and create objects from a Sunspot-managed
+  Solr index without requiring all the knowledge, code, and data used to
+  build the index in the first place. 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.
 email: 
 - code@jbarnette.com
 executables: []