nesta-plugin-search 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+vendor/bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in nesta-search.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,16 @@
+PATH
+  remote: .
+  specs:
+    nesta-plugin-search (0.1.2)
+      ferret (>= 0.11.6)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ferret (0.11.8.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  nesta-plugin-search!

data/README.md

@@ -0,0 +1,80 @@
+README
+======
+
+nesta-plugin-search is a plugin for the Nesta CMS use
+[Ferret](https://github.com/dbalmain/ferret) to index and search your site.
+
+Installation
+------------
+
+To install it as a gem add nesta-search to the `Gemfile` in your Nesta
+project, and then re-run `bundle`:
+
+    $ echo "gem 'nesta-plugin-search'" >> Gemfile
+    $ bundle
+
+Text Search Usage
+-----------------
+
+Create a `/search` page -- `content/pages/search.haml` -- here's an example:
+
+    %h1 Search Results
+    - if (results = search_results( search_index, params[:q] )) && !results.empty?
+      %section.articles= article_summaries(results)
+    - else
+      %h3 No articles found!
+
+Add a searchbox to your layout, something like:
+
+    %form{:action => "/search"}
+        %input{:type => "text", :name => "q", :value => "#{params[:q]||''}"}
+
+
+Text Search Configuration
+-------------------------
+
+Set `search_index_timeout` to the number of seconds you want your default indexes to
+be stored for. By default, this is `false`, which never expires the index. It should
+be noted that reindexing is slow.
+
+Set `search_ignore_list` to the abspath of the pages you want to be excluded from the
+search index. "/search" is forcefully excluded always and "/" is the default.
+
+Example:
+
+    search_index_timeout: 3600
+    search_ignore_list:
+    - /
+    - /foo
+    - /foo/bar
+
+> IMPORTANT NOTE: If you're not using "/search" as your search page, please add it to
+> this list or bad things may happen.
+
+Advanced Usage Notes
+--------------------
+
+Provided Index Helpers:
+
+- `search_index` -- an index of all pages and articles.
+- `article_index` -- an index of articles only.
+
+Creating your own index:
+
+    - my_index = Nesta::Plugin::Search::Index.new( :my_find_method ).index
+    %h1 Search Results
+    - if (results = search_results( my_index, params[:q] )) && !results.empty?
+      %section.articles= article_summaries(results)
+    - else
+      %h3 No articles found!
+
+If you want to pregenerate your cache to disk and load it that way, it would be something
+like this:
+
+    - existing_index = Ferret::Index::Index.new(:path => "/path/to/existing/index")
+    %h1 Search Results
+    - if (results = search_results( existing_index, params[:q] )) && !results.empty?
+      %section.articles= article_summaries(results)
+    - else
+      %h3 No articles found!
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/nesta-plugin-search.rb

@@ -0,0 +1,3 @@
+require "nesta-plugin-search/version"
+
+Nesta::Plugin.register(__FILE__)

data/lib/nesta-plugin-search/init.rb

@@ -0,0 +1,83 @@
+module Nesta
+  class App
+    helpers do
+      def search_index
+        $search_index ||= Nesta::Plugin::Search::Index.new(:find_all, Nesta::Config.search_index_timeout).index
+      end
+
+      def article_index
+        $article_index ||= Nesta::Plugin::Search::Index.new(:find_articles, Nesta::Config.search_index_timeout).index
+      end
+
+      def search_results index, term
+        Nesta::Plugin::Search.results( index, term ) || []
+      end
+    end
+  end
+
+  class Config
+    @settings += %w[ search_index_timeout search_ignore_list ]
+
+    def self.search_index_timeout
+      from_yaml("search_index_timeout")||false
+    end
+
+    def self.search_ignore_list
+      (from_yaml("search_ignore_list")||["/"]) + %w[ /search ]
+    end
+  end
+
+  module Plugin
+    module Search
+
+      def self.results index, term
+        results = []
+        index.search_each(term) do |key, score|
+          results.push Nesta::Page.find_by_path(index[key][:href])# rescue nil
+        end
+        results
+      end
+
+      class Index
+        attr_accessor :index_method
+
+        # Currently imethod is expected to be:
+        # - :find_all
+        # - :find_articles
+        #
+        # Initializing with a timeout = false will
+        # cause index to not expire without a server
+        # restart.
+        def initialize(imethod, timeout=false) # 12 hours default
+          @index_method = imethod.to_sym
+          if timeout
+            @timeout = timeout
+            @expire_at = Time.now+timeout
+          end
+        end
+
+        def index
+          # index and return if index doesn't exist or is empty
+          return @index = reindex unless @index && @index.size > 0
+
+          # return existing index if current index isn't expired or expired_at isn't set
+          return @index if @expire_at && @expire_at > Time.now
+
+          # if all else fails, index and return
+          return @index = reindex
+        end
+
+        def reindex
+          @index = Ferret::Index::Index.new
+
+          Nesta::Page.send(@index_method).each do |item|
+            unless Nesta::Config.search_ignore_list.include?(item.abspath)
+              @index << {:heading => item.heading, :href => item.abspath, :summary => item.summary, :body => item.body}
+            end
+          end
+          @index
+        end
+      end
+    end
+  end
+end

data/lib/nesta-plugin-search/version.rb

@@ -0,0 +1,7 @@
+module Nesta
+  module Plugin
+    module Search
+      VERSION = "0.0.2"
+    end
+  end
+end

data/nesta-plugin-search.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "nesta-plugin-search/version"
+
+Gem::Specification.new do |s|
+  s.name        = "nesta-plugin-search"
+  s.version     = Nesta::Plugin::Search::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Joshua Mervine"]
+  s.email       = ["joshua@mervine.net"]
+  s.homepage    = "http://github.com/jmervine/search-plugin-nesta"
+  s.summary     = %q{Search plugin for Nesta CMS}
+  s.description = %q{Uses Ferret to search your Nesta site. Based on https://github.com/gma/nesta-search.}
+
+  s.add_dependency 'ferret', '=0.11.8.5'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: nesta-plugin-search
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Joshua Mervine
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ferret
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.11.8.5
+description: Uses Ferret to search your Nesta site. Based on https://github.com/gma/nesta-search.
+email:
+- joshua@mervine.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/nesta-plugin-search.rb
+- lib/nesta-plugin-search/init.rb
+- lib/nesta-plugin-search/version.rb
+- nesta-plugin-search.gemspec
+homepage: http://github.com/jmervine/search-plugin-nesta
+licenses: []
+post_install_message: 
+rdoc_options: []
+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: Search plugin for Nesta CMS
+test_files: []
+has_rdoc: