lunr 1.0.1 → 2.0.0

data/Isolate

@@ -1,8 +1,13 @@
-gem "configlet", "~> 1.3"
-gem "rsolr",     "~> 0.12"
+options :system => false
+
+gem "sunspot", "~> 1.1.0"
 
 env :development do
-  gem "fakeweb",       "~> 1.3"
-  gem "minitest",      "~> 1.7"
-  gem "will_paginate", "~> 3.0.pre2"
+  gem "ZenTest",    "4.4.0"
+  gem "fakeweb",    "1.3.0"
+  gem "hoe",        "2.6.2"
+  gem "hoe-doofus", "1.0.0"
+  gem "hoe-git",    "1.3.0"
+  gem "minitest",   "1.7.1"
+  gem "mocha",      "0.9.8"
 end

data/Manifest.txt

@@ -5,5 +5,10 @@ Manifest.txt
 README.rdoc
 Rakefile
 lib/lunr.rb
-lib/lunr/error.rb
+lib/lunr/errors.rb
+lib/lunr/model.rb
+lib/lunr/search.rb
+lib/lunr/sunspot.rb
 test/test_lunr.rb
+test/test_lunr_model.rb
+test/test_lunr_search.rb

data/README.rdoc

@@ -4,7 +4,7 @@
 
 == Description
 
-A simple read-only interface to Solr, built on RSolr.
+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
@@ -14,30 +14,38 @@ 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.
 
-As seen in Sunspot and similar tools, if
-<code>WillPaginate::Collection</code> is available it'll be wrapped
-around the results of any search.
-
 == Examples
 
   require "lunr"
 
-  # set ENV["LUNR_URL"], or...
-  Lunr[:url] = "http://localhost:8983/solr"
+  class My::SimpleTrack
+    include Lunr::Model
 
-  # simplest possible, returns a hash
-  Lunr.search "foo"
+    searches "Track" do
+      property :album,  :text
+      property :artist, :text
+      property :title,  :text
 
-  # returns the result of the block for each entry
-  Lunr.search "foo" do |raw|
-    MyReadOnlyModelClass.new raw
-  end
+      time    :accepted_at
+      boolean :hot
+      string  :state
+    end
+
+    scope do |q|
+      q.order_by :hot, :desc
+      q.order_by :accepted_at, :desc
 
-  # pagination is part of solr, select a page with :p
-  Lunr.search "foo", :p => params[:page]
+      q.with :state, "accepted"
+    end
 
-  # default per page is 25, but you can set ENV["LUNR_PP"] or...
-  Lunr.search "foo", :p => params[:page], :pp => 500
+    scope :hot do
+      with :hot, true
+    end
+
+    scope :state do |q, state|
+      q.with :state, state
+    end
+  end
 
 == Installation
 

data/Rakefile

@@ -1,3 +1,8 @@
+unless Gem.available? "isolate"
+  abort "Please `gem install isolate` and run rake again."
+end
+
+require "isolate/now"
 require "hoe"
 
 Hoe.plugins.delete :rubyforge

data/lib/lunr.rb

@@ -1,57 +1,11 @@
-require "configlet"
-require "rsolr"
-
-require "lunr/error"
+require "lunr/sunspot"
+require "lunr/model"
+require "lunr/search"
 
 module Lunr
-  extend Configlet
-  
-  # Duh.
-  VERSION = "1.0.1"
-
-  config :lunr do
-    default :pp  => "25"
-    default :url => "http://localhost:8983/solr"
-  end
-
-  def self.search query, options = {}, &block
-    page = [1, Integer(options[:p] || 0)].max
-    per  = Integer options[:pp] || self[:pp]
-
-    params = {
-      :q    => query,
-      :rows => per,
-      :start => per * (page - 1),
-    }
-
-    begin
-      raw = solr.select params
-    rescue Errno::ECONNREFUSED => e
-      raise Lunr::Error, "Can't connect to #{self[:url]}: #{e}"
-    end
-
-    header   = raw["responseHeader"]
-    response = raw["response"]
 
-    unless status = header["status"]
-      raise Lunr::Error, "Bad (and cryptic) response status: #{status}"
-    end
-
-    docs  = response.delete "docs"
-    total = response.delete "numFound"
-
-    docs = block_given? ? docs.map(&block) : docs
-
-    if defined? WillPaginate::Collection
-      old = docs
-      docs = WillPaginate::Collection.new page, per, total
-      docs.replace old
-    end
-
-    docs
-  end
+  # Duh.
+  VERSION = "2.0.0"
 
-  def self.solr
-    @solr ||= RSolr.connect :url => self[:url]
-  end
 end
+

data/lib/lunr/errors.rb

@@ -0,0 +1,19 @@
+module Lunr
+  class Error < StandardError
+  end
+
+  class AlreadyExecuted < Error
+    attr_reader :search
+
+    def initalize search
+      @search = search
+      super "Can't add more criteria, this search has already been executed!"
+    end
+  end
+
+  class BadModel < Error
+    def initialize klass
+      super "#{klass.name} doesn't include Lunr::Model!"
+    end
+  end
+end

data/lib/lunr/model.rb

@@ -0,0 +1,47 @@
+require "lunr/search"
+require "lunr/sunspot"
+
+module Lunr
+  module Model
+    def self.included klass
+      klass.extend Klass
+    end
+
+    attr_reader :id
+
+    module Klass
+      def properties
+        @properties ||= []
+      end
+
+      def scopes
+        @scopes ||= {}
+      end
+
+      def scope sym = :all, &block
+        scopes[sym] = block
+
+        unless sym == :all
+          class_eval <<-END, __FILE__, __LINE__ + 1
+            def self.#{sym}; search.#{sym} end
+          END
+        end
+      end
+
+      def search &block
+        Lunr::Search.new self, &block
+      end
+
+      alias_method :all, :search
+
+      def searches classname, &block
+        Sunspot::TypeField.alias self, classname
+        Sunspot.setup self, &block
+
+        properties.uniq.each do |prop|
+          attr_reader prop
+        end
+      end
+    end
+  end
+end

data/lib/lunr/search.rb

@@ -0,0 +1,116 @@
+require "lunr/errors"
+require "lunr/model"
+require "lunr/sunspot"
+
+module Lunr
+  class Search
+    include Enumerable
+
+    def each &block
+      execute && @results.each(&block)
+    end
+
+    def total
+      execute && @search.total
+    end
+
+    alias_method :size, :total
+
+    def empty?
+      0 == total
+    end
+
+    # Acting like WillPaginate::Collection
+
+    def current_page
+      execute && @search.query.page
+    end
+
+    def per_page
+      execute && @search.query.per_page
+    end
+
+    def total_entries
+      total
+    end
+
+    def total_pages
+      total_entries / per_page +
+        (total_entries % per_page > 0 ? 1 : 0)
+    end
+
+    attr_reader :klass
+
+    def initialize klass, &block
+      raise Lunr::BadModel.new(klass) unless klass < Lunr::Model
+
+      @executed = false
+      @klass    = klass
+      @search   = Sunspot.new_search klass, &block
+
+      if all = @klass.scopes[:all]
+        scope &all
+      end
+    end
+
+    def scope &block
+      executable!
+      @search.build &block
+    end
+
+    def executable!
+      raise Lunr::AlreadyExecuted.new(self) if executed?
+    end
+
+    def executed?
+      @executed
+    end
+
+    # :nodoc:
+
+    def params
+      @search.query.to_params
+    end
+
+    def method_missing sym, *args
+      super unless scope = klass.scopes[sym]
+
+      executable!
+
+      dsl = @search.send :dsl
+
+      if args.empty?
+        dsl.instance_eval &scope
+      else
+        scope.call dsl, args
+      end
+
+      self
+    end
+
+    def respond_to sym, include_private = false
+      klass.scopes.key?(sym) || super
+    end
+
+    private
+
+    def execute
+      unless @executed
+        @executed = true
+        @search.execute
+
+        @results = @search.hits.map do |hit|
+          klass.new.tap do |model|
+            model.instance_variable_set :"@id", hit.primary_key
+
+            klass.properties.each do |prop|
+              model.instance_variable_set :"@#{prop}", hit.stored(prop)
+            end
+          end
+        end
+      end
+
+      true
+    end
+  end
+end

data/lib/lunr/sunspot.rb

@@ -0,0 +1,59 @@
+require "sunspot"
+
+module Sunspot
+  module DSL
+    class Fields
+      def property name, type, options = {}
+        @setup.clazz.properties << name
+        send type, name, options.merge(:stored => true)
+      end
+    end
+  end
+
+  class Field
+    def stored?
+      @stored
+    end
+  end
+
+  module Search
+    class Hit
+      alias_method :original_initialize, :initialize
+
+      def initialize *args
+        original_initialize *args
+
+        if clazz = Sunspot::TypeField.aliases_inverted[@class_name]
+          @class_name = clazz.name
+        end
+      end
+    end
+  end
+
+  class Setup
+    def lunr_properties
+      @lunr_properties ||= []
+    end
+  end
+
+  class TypeField
+    class << self
+      def alias(dest_class, source_class_name)
+        @@inverted = nil # invalidate cache
+        aliases[dest_class] = source_class_name
+      end
+
+      def aliases
+        @@aliases ||= {}
+      end
+
+      def aliases_inverted
+        @@inverted ||= aliases.invert
+      end
+    end
+
+    def to_indexed clazz
+      self.class.aliases[clazz] || clazz.name
+    end
+  end
+end

data/test/test_lunr.rb

@@ -8,18 +8,4 @@ class TestLunr < MiniTest::Unit::TestCase
   def setup
     FakeWeb.clean_registry
   end
-
-  def test_self_search
-    stub "foo"
-    Lunr.search "foo"
-  end
-
-  def stub query, fixture = "simple"
-    FakeWeb.register_uri :get, url(query),
-      :body => File.read("test/fixtures/#{fixture}")
-  end
-
-  def url query
-    "#{Lunr[:url]}/select?wt=ruby&start=0&q=#{query}&rows=25"
-  end
 end

data/test/test_lunr_model.rb

@@ -0,0 +1,4 @@
+require "minitest/autorun"
+
+class TestLunrModel < MiniTest::Unit::TestCase
+end

data/test/test_lunr_search.rb

@@ -0,0 +1,42 @@
+require "minitest/autorun"
+require "mocha"
+require "lunr/search"
+
+class TestLunrSearch < MiniTest::Unit::TestCase
+  include Lunr::Model
+
+  def setup
+    @search = Lunr::Search.new self.class
+  end
+
+  def test_initialize
+    s = Lunr::Search.new self.class do
+      with :foo, "bar"
+    end
+
+    assert_equal TestLunrSearch, s.klass
+    assert_equal "type:TestLunrSearch", s.params[:fq].first
+    assert s.params[:fq].include?("foo_s:bar")
+  end
+
+  def test_scope
+    @search.scope { with :foo, "blergh" }
+    @search.scope { with :bar, "corge"  }
+
+    assert @search.params[:fq].include?("foo_s:blergh")
+    assert @search.params[:fq].include?("bar_s:corge")
+  end
+
+  def test_scope_bad
+    @search.stubs(:executed?).returns true
+
+    assert_raises Lunr::AlreadyExecuted do
+      @search.scope { with :foo, "hello" }
+    end
+  end
+end
+
+Sunspot.setup TestLunrSearch do
+  string :bar
+  string :foo
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lunr
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 15
   prerelease: false
   segments: 
-  - 1
+  - 2
   - 0
-  - 1
-  version: 1.0.1
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - John Barnette
@@ -15,38 +15,40 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-25 00:00:00 -07:00
+date: 2010-09-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: configlet
+  name: sunspot
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 19
         segments: 
         - 1
-        - 3
-        version: "1.3"
+        - 1
+        - 0
+        version: 1.1.0
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rsolr
+  name: ZenTest
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 47
         segments: 
+        - 4
+        - 4
         - 0
-        - 12
-        version: "0.12"
-  type: :runtime
+        version: 4.4.0
+  type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: fakeweb
@@ -54,64 +56,114 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 27
         segments: 
         - 1
         - 3
-        version: "1.3"
+        - 0
+        version: 1.3.0
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: minitest
+  name: hoe
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 19
         segments: 
-        - 1
-        - 7
-        version: "1.7"
+        - 2
+        - 6
+        - 2
+        version: 2.6.2
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: will_paginate
+  name: hoe-doofus
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: -1876988247
+        hash: 23
         segments: 
-        - 3
+        - 1
+        - 0
         - 0
-        - pre2
-        version: 3.0.pre2
+        version: 1.0.0
   type: :development
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: hoe
+  name: hoe-git
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 9
+        segments: 
+        - 1
+        - 7
+        - 1
+        version: 1.7.1
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 21
+        hash: 19
         segments: 
         - 2
         - 6
-        - 1
-        version: 2.6.1
+        - 2
+        version: 2.6.2
   type: :development
-  version_requirements: *id006
+  version_requirements: *id009
 description: |-
-  A simple read-only interface to Solr, built on RSolr.
+  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
@@ -120,10 +172,6 @@ description: |-
   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.
-  
-  As seen in Sunspot and similar tools, if
-  <code>WillPaginate::Collection</code> is available it'll be wrapped
-  around the results of any search.
 email: 
 - code@jbarnette.com
 executables: []
@@ -142,8 +190,13 @@ files:
 - README.rdoc
 - Rakefile
 - lib/lunr.rb
-- lib/lunr/error.rb
+- lib/lunr/errors.rb
+- lib/lunr/model.rb
+- lib/lunr/search.rb
+- lib/lunr/sunspot.rb
 - test/test_lunr.rb
+- test/test_lunr_model.rb
+- test/test_lunr_search.rb
 has_rdoc: true
 homepage: http://github.com/jbarnette/lunr
 licenses: []
@@ -178,6 +231,8 @@ rubyforge_project: lunr
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A simple read-only interface to Solr, built on RSolr
+summary: A simple read-only interface to Solr, built on Sunspot
 test_files: 
 - test/test_lunr.rb
+- test/test_lunr_model.rb
+- test/test_lunr_search.rb

data/lib/lunr/error.rb

@@ -1,4 +0,0 @@
-module Lunr
-  class Error < StandardError
-  end
-end