sunspot_cell 0.1.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Zheileman
+
+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.rdoc

@@ -0,0 +1,59 @@
+= Sunspot Cell (gem)
+
+== Note by Zheileman
+
+* This gem exists because the only gem I could find for the original project (https://github.com/springbok/sunspot_cell) was the one packaged by Kevin Motschiedler (https://github.com/motske/sunspot_cell) and it lacks the support to deal with S3 included in this other fork: https://github.com/chebyte/sunspot_cell
+
+
+This gem adds Cell support (for indexing rich documents like pdf, docs, html, etc...) to Sunspot (developed against Sunspot 1.3.0).
+Support Paperclip and S3 Storage
+
+The code is based on the patch included here:
+http://outoftime.lighthouseapp.com/projects/20339/tickets/98-solr-cell
+
+== Requirements
+
+* Sunspot gem installed (>= 1.3.0)
+
+* Solr Cell libraries (+dist/apache-solr-cell-1.4.X.jar+ and +contrib/extraction/lib/*.jar+ from the standard Solr distribution) placed in the +/solr/lib+ directory as created by the Sunspot gem, in development environment. Your production setup might vary.
+
+* Adjustments to the Solr +schema.xml+:
+
+	<fieldType name="ignored" stored="false" indexed="false" multiValued="true" class="solr.StrField" />
+
+and
+
+	<dynamicField name="*_attachment" stored="true" type="text" multiValued="true" indexed="true"/>
+	<dynamicField name="ignored_*" type="ignored"/>
+
+=== Install Plugin
+
+Add sunspot gem and sunspot_cell to Gemfile:
+
+ gem 'sunspot_rails', '~> 1.3.0'
+ gem 'sunspot_cell', :git => 'git://github.com/zheileman/sunspot_cell.git'
+
+== Usage
+
+  class Doc
+    searchable do
+       text :title
+       attachment :file
+     end
+  end
+
+== Paperclip & S3 Storage
+
+  require 'open-uri'
+
+  class Doc
+    searchable do
+       text :title
+       attachment :attached_file
+     end
+
+  private
+    def attached_file
+      URI.parse(remote_full_url)
+    end
+  end

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'rake'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+begin
+  require 'rspec'
+  require 'rspec/core/rake_task'
+  desc 'Run the unit tests'
+  RSpec::Core::RakeTask.new(:test)
+rescue LoadError
+  task :test do
+    STDERR.puts "You must have rspec 2.0 installed to run the tests"
+  end
+end
+
+desc 'Generate documentation.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.options << '--title' << 'Sunspot Cell support' << '--line-numbers' << '--inline-source' << '--main' << 'README.rdoc'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/init.rb

@@ -0,0 +1 @@
+require 'sunspot_cell'

data/lib/sunspot/rich_document.rb

@@ -0,0 +1,49 @@
+module Sunspot
+
+  class RichDocument < RSolr::Xml::Document
+    include Enumerable
+
+    def contains_attachment?
+      @fields.each do |field|
+        if field.name.to_s.include?("_attachment") && field.value.present?
+          return true
+        end
+      end
+      return false
+    end
+
+    def add(connection)
+      params = {
+        :wt => :ruby
+      }
+
+      data = nil
+
+      @fields.each do |f|
+        if f.name.to_s.include?("_attachment") and f.value.present?
+          params['fmap.content'] = f.name
+          if f.value.is_a?(Hash)
+            params['stream.url']         = f.value[:file]
+            params['stream.contentType'] = f.value[:type]
+          else
+            data = open(f.value).read rescue ""
+          end
+        else
+          param_name = "literal.#{f.name.to_s}"
+          params[param_name] = [] unless params.has_key?(param_name)
+          params[param_name] << f.value
+        end
+        if f.attrs[:boost]
+          params["boost.#{f.name.to_s}"] = f.attrs[:boost]
+        end
+      end
+
+      connection.send_and_receive('update/extract', 
+        { :method => :post, 
+          :params => params, 
+          :data => data, 
+          :headers => {"Content-Type" => ""}
+        })
+    end
+  end
+end

data/lib/sunspot_cell.rb

@@ -0,0 +1,17 @@
+require 'sunspot/rich_document'
+require 'sunspot_cell/dsl/fields'
+Sunspot::DSL::Fields.send(:include, SunspotCell::DSL::Fields)
+require 'sunspot_cell/dsl/standard_query'
+Sunspot::DSL::StandardQuery.send(:include, SunspotCell::DSL::StandardQuery)
+require 'sunspot_cell/composite_setup'
+Sunspot::CompositeSetup.send(:include, SunspotCell::CompositeSetup)
+require 'sunspot_cell/type'
+Sunspot::Type.send(:include, SunspotCell::Type)
+require 'sunspot_cell/attribute_field'
+Sunspot::AttributeField.send(:include, SunspotCell::AttributeField)
+require 'sunspot_cell/setup'
+Sunspot::Setup.send(:include, SunspotCell::Setup)
+require 'sunspot_cell/field_factory'
+Sunspot::FieldFactory.send(:include, SunspotCell::FieldFactory)
+require 'sunspot_cell/indexer'
+Sunspot::Indexer.send(:include, SunspotCell::Indexer)

data/lib/sunspot_cell/attribute_field.rb

@@ -0,0 +1,12 @@
+module SunspotCell
+  module AttributeField
+
+
+    def self.included(base)
+      base.class_eval do
+        attr_reader :default_boost
+      end
+    end
+
+  end
+end

data/lib/sunspot_cell/composite_setup.rb

@@ -0,0 +1,43 @@
+module SunspotCell
+  module CompositeSetup
+
+    def self.included(base)
+      base.class_eval do
+        include InstanceMethods
+      end
+    end
+
+    module InstanceMethods
+
+      # Collection of all attachment fields configured for any of the enclosed types.
+      #
+      # === Returns
+      #
+      # Array:: Text fields configured for the enclosed types
+      #
+      def all_attachment_fields
+        @attachment_fields ||= attachment_fields_hash.values.map { |set| set.to_a }.flatten
+      end
+
+      private
+
+      # Return a hash of field names to atachment field objects, containing all fields
+      # that are configured for any of the types enclosed.
+      #
+      # ==== Returns
+      #
+      # Hash:: Hash of field names to text field objects.
+      #
+      def attachment_fields_hash
+        @attachment_fields_hash ||=
+          setups.inject({}) do |hash, setup|
+            setup.all_attachment_fields.each do |text_field|
+              (hash[text_field.name] ||= Set.new) << text_field
+            end
+            hash
+          end
+      end
+
+    end
+  end
+end

data/lib/sunspot_cell/dsl/fields.rb

@@ -0,0 +1,26 @@
+module SunspotCell
+  module DSL
+    module Fields
+
+      def self.included(base)
+        base.class_eval do
+          include InstanceMethods
+        end
+      end
+
+      module InstanceMethods
+
+        # Added an attachment field, the attachment filename is passed to Solr for
+        # indexing by tiqa
+
+        def attachment(*names)
+          options = names.pop if names.last.is_a?(Hash)
+          names.each do |name|
+            @setup.add_attachment_field_factory(name, options || {})
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/sunspot_cell/dsl/standard_query.rb

@@ -0,0 +1,74 @@
+module SunspotCell
+  module DSL
+    module StandardQuery
+
+      def self.included(base)
+        base.class_eval do
+          include InstanceMethods
+        end
+      end
+
+      module InstanceMethods
+
+        def fulltext(keywords, options = {}, &block)
+          if keywords && !(keywords.to_s =~ /^\s*$/)
+            fulltext_query = @query.add_fulltext(keywords)
+            if field_names = options.delete(:fields)
+              Util.Array(field_names).each do |field_name|
+                @setup.text_fields(field_name).each do |field|
+                  fulltext_query.add_fulltext_field(field, field.default_boost)
+                end
+              end
+            end
+            if minimum_match = options.delete(:minimum_match)
+              fulltext_query.minimum_match = minimum_match.to_i
+            end
+            if tie = options.delete(:tie)
+              fulltext_query.tie = tie.to_f
+            end
+            if query_phrase_slop = options.delete(:query_phrase_slop)
+              fulltext_query.query_phrase_slop = query_phrase_slop.to_i
+            end
+            if highlight_field_names = options.delete(:highlight)
+              if highlight_field_names == true
+                fulltext_query.add_highlight
+              else
+                highlight_fields = []
+                Util.Array(highlight_field_names).each do |field_name|
+                  highlight_fields.concat(@setup.text_fields(field_name))
+                end
+                fulltext_query.add_highlight(highlight_fields)
+              end
+            end
+            if block && fulltext_query
+              fulltext_dsl = Fulltext.new(fulltext_query, @setup)
+              Util.instance_eval_or_call(
+                fulltext_dsl,
+                &block
+              )
+            end
+            if !field_names && (!fulltext_dsl || !fulltext_dsl.fields_added?)
+              @setup.all_text_fields.each do |field|
+                unless fulltext_query.has_fulltext_field?(field)
+                  unless fulltext_dsl && fulltext_dsl.exclude_fields.include?(field.name)
+                    fulltext_query.add_fulltext_field(field, field.default_boost)
+                  end
+                end
+              end
+            end
+          end
+          if !field_names && (!fulltext_dsl || !fulltext_dsl.fields_added?)
+            unless @setup.all_attachment_fields.empty?
+              @setup.all_attachment_fields.each do |attachment_text_field|
+                unless fulltext_dsl && fulltext_dsl.exclude_fields.include?(attachment_text_field.name)
+                  fulltext_query.add_fulltext_field(attachment_text_field, attachment_text_field.default_boost)
+                end
+              end
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/sunspot_cell/field_factory.rb

@@ -0,0 +1,18 @@
+module SunspotCell
+  module FieldFactory
+
+    class Attachment
+      def initialize(name = nil, &block)
+        if block
+          @data_extractor = DataExtractor::BlockExtractor.new(&block)
+        else
+          @data_extractor = DataExtractor::AttributeExtractor.new(name)
+        end
+      end
+
+      def populate_document(document, model)
+      end
+    end
+    
+  end
+end

data/lib/sunspot_cell/indexer.rb

@@ -0,0 +1,45 @@
+module SunspotCell
+  module Indexer
+
+    def self.included(base)
+      base.class_eval do
+
+        def add_documents(documents)
+          documents_arr = Sunspot::Util.Array(documents)
+          docs_attach = []
+          docs_no_attach = []
+          documents_arr.each do |document|
+            if document.contains_attachment?
+              docs_attach << document
+            else
+              docs_no_attach << document
+            end
+          end
+
+          begin
+            if !docs_no_attach.empty?
+              @connection.add(docs_no_attach)
+            end
+            if !docs_attach.empty?
+              Sunspot::Util.Array(docs_attach).each do |document|
+                document.add(@connection)
+              end
+            end
+          rescue Exception => e
+            @batch = nil
+            raise e
+          end
+        end
+
+
+        def document_for(model)
+          Sunspot::RichDocument.new(
+            :id => Sunspot::Adapters::InstanceAdapter.adapt(model).index_id,
+            :type => Sunspot::Util.superclasses_for(model.class).map { |clazz| clazz.name }
+          )
+        end
+
+      end
+    end
+  end
+end

data/lib/sunspot_cell/setup.rb

@@ -0,0 +1,76 @@
+module SunspotCell
+  module Setup
+
+    def self.included(base)
+      base.class_eval do
+        alias :sunspot_initialize :initialize unless method_defined?(:sunspot_initialize)
+        def initialize(clazz)
+          @attachment_field_factories, @attachment_field_factories_cache = *Array.new(8) { Hash.new }
+          sunspot_initialize(clazz)
+        end
+
+        alias :sunspot_all_field_factories :all_field_factories unless method_defined?(:sunspot_all_field_factories)
+        def all_field_factories
+          all_field_factories = sunspot_all_field_factories
+          all_field_factories.concat(attachment_field_factories)
+          all_field_factories
+        end
+        
+        # Add field_factories for fulltext search on attachments
+        #
+        # ==== Parameters
+        #
+        def add_attachment_field_factory(name, options = {}, &block)
+          stored = options[:stored]
+          field_factory = Sunspot::FieldFactory::Static.new(name, Sunspot::Type::AttachmentType.instance, options, &block)
+          @attachment_field_factories[name] = field_factory
+          @attachment_field_factories_cache[field_factory.name] = field_factory
+          if stored
+            @attachment_field_factories_cache[field_factory.name] << field_factory
+          end
+        end
+
+        def text_fields(field_name)
+          text_field =
+            if field_factory = @text_field_factories_cache[field_name.to_sym]
+              field_factory.build
+            else
+              if field_factory = @attachment_field_factories_cache[field_name.to_sym]
+                field_factory.build
+              else
+                raise(
+                  UnrecognizedFieldError,
+                  "No text field configured for #{@class_name} with name '#{field_name}'"
+                )
+              end
+            end
+          [text_field]
+        end
+
+        #
+        # Return all text fields
+        #
+        def all_text_fields
+          text_fields = text_field_factories.map { |text_field_factory| text_field_factory.build }
+          text_fields.concat(all_attachment_fields)
+        end
+
+        def all_attachment_fields
+          attachment_field_factories.map { |field_factory| field_factory.build }
+        end
+
+        # Get the text field_factories associated with this setup as well as all inherited
+        # attachment field_factories
+        #
+        # ==== Returns
+        #
+        # Array:: Collection of all text field_factories associated with this setup
+        #
+        def attachment_field_factories
+          collection_from_inheritable_hash(:attachment_field_factories)
+        end
+      end
+    end
+
+  end
+end

data/lib/sunspot_cell/type.rb

@@ -0,0 +1,19 @@
+module SunspotCell
+  module Type
+
+    class AttachmentType < Sunspot::Type::AbstractType
+      def indexed_name(name)
+        "#{name}_attachment"
+      end
+
+      def to_indexed(value)
+        value if value
+      end
+
+      def cast(text)
+        text
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: sunspot_cell
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- liZhang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sunspot
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: This gem adds Cell support (for indexing rich documents) to Sunspot
+email: zhangyicaocao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.rdoc
+files:
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/sunspot/rich_document.rb
+- lib/sunspot_cell.rb
+- lib/sunspot_cell/attribute_field.rb
+- lib/sunspot_cell/composite_setup.rb
+- lib/sunspot_cell/dsl/fields.rb
+- lib/sunspot_cell/dsl/standard_query.rb
+- lib/sunspot_cell/field_factory.rb
+- lib/sunspot_cell/indexer.rb
+- lib/sunspot_cell/setup.rb
+- lib/sunspot_cell/type.rb
+homepage: https://github.com/uudui/sunspot_cell
+licenses:
+- MIT
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+- --main
+- README.rdoc
+- LICENSE
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: This gem adds Cell support (for indexing rich documents) to Sunspot
+test_files: []