documentation-sunspot 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0efe466327b05099e723a9794f655a01a14b3d3d
+  data.tar.gz: 788d09ebda400d7184e9e338bef90d059bfda439
+SHA512:
+  metadata.gz: 4ce153b7c84a87f0721a4ae61a916481478f5953960aa0ad331268095236b547a4b662c1e9d81e64185d01e562a6d610608b65d682a11ffac2d1ca89bcac1ad9
+  data.tar.gz: d7698209b929186934f11415ca7bd6aadb6b1d276755d929f876702e9b9da04695e7301fb74843a9d9d0f3a94b98c2c39cf52a9b6937a94decdbc0d247c21e26

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in documentation-sunspot.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 jamesprior
+
+MIT License
+
+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,28 @@
+# Documentation Sunspot
+
+This is a module for Documentation which replaces the searcher searcher with one powered by Sunspot and Apache's Solr.  See http://sunspot.github.com/ for more information about Sunspot.
+
+## Installation
+
+Add the gem to your Gemfile and run `bundle`.
+
+```ruby
+gem 'documentation-sunspot'
+```
+
+Once installed, you should add an initializer to your Rails application to add configuration.
+
+```ruby
+Documentation.config.searcher = Documentation::Searchers::Sunspot.new
+```
+
+## Setup
+
+Once installed, you'll probably want to index all your documents.
+
+```ruby
+# Remove any existing index
+Documentation.config.searcher.reset
+# Index all pages
+Documentation::Page.all.each(&:index)
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/documentation-sunspot.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'documentation/sunspot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "documentation-sunspot"
+  spec.version       = Documentation::Sunspot::VERSION
+  spec.authors       = ["jamesprior"]
+  spec.email         = ["james.m.prior@gmail.com"]
+  spec.summary       = %q{A search replacement for the documentation engine}
+  spec.description   = %q{Documentation is a Rails engine which provides a complete system for managing a set of hierarchical documentation.  This gem allows document searching and fragment highlighting with the Sunspot gem and Apache's Solr search index.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/documentation/searchers/sunspot.rb

@@ -0,0 +1,59 @@
+module Documentation
+  module Searchers
+    class Sunspot < Documentation::Searchers::Abstract
+    
+      def setup
+        ::Sunspot.setup(Documentation::Page) do
+          text :title, :boost => 2.0
+          text :content, :stored => true
+          string :title, :stored => true
+          string :permalink
+          string :full_permalink
+          time :created_at
+          time :updated_at
+        end
+      end
+      
+      def index(page)
+        ::Sunspot.index(page)
+      end
+      
+      def delete(page)
+        ::Sunspot.remove(page)
+      end
+      
+      def reset
+        ::Sunspot.remove_all(Documentation::Page)
+      end
+      
+      def search(query, options = {})
+        # Default options
+        options[:page]      ||= 1
+        options[:per_page]  ||= 15
+        
+        result = ::Sunspot.search(Documentation::Page) do |search|
+          search.keywords query, :highlight => true
+          search.paginate :page => options[:page], :per_page => options[:per_page]
+        end
+        
+        search_result                 = Documentation::SearchResult.new
+        search_result.page            = options[:page].to_i
+        search_result.per_page        = options[:per_page].to_i
+        search_result.total_results   = result.total
+        search_result.query           = query
+        search_result.time            = result.query_time
+        search_result.raw_results     = result.hits.inject(Hash.new) do |hash, hit|
+          hash[hit.primary_key.to_i] = {
+            :score => hit.score,
+            :highlights => hit.highlights(:content).collect{|x| x.format{|word| "{{{#{word}}}}"}}
+          }
+          hash
+        end
+        
+        # Return it
+        search_result
+      end
+      
+    end
+  end
+end

data/lib/documentation/sunspot.rb

@@ -0,0 +1,2 @@
+require 'documentation/sunspot/version'
+require 'documentation/searchers/sunspot'

data/lib/documentation/sunspot/version.rb

@@ -0,0 +1,5 @@
+module Documentation
+  module Sunspot
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: documentation-sunspot
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- jamesprior
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Documentation is a Rails engine which provides a complete system for
+  managing a set of hierarchical documentation.  This gem allows document searching
+  and fragment highlighting with the Sunspot gem and Apache's Solr search index.
+email:
+- james.m.prior@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- documentation-sunspot.gemspec
+- lib/documentation/searchers/sunspot.rb
+- lib/documentation/sunspot.rb
+- lib/documentation/sunspot/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A search replacement for the documentation engine
+test_files: []
+has_rdoc: