locomotive_search_ext_plugin 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MzIwODQyYTI2MDI0MjdkNzBhMTM2YzFkMzMzNDYyOTUyYjcxNWQyMg==
+  data.tar.gz: !binary |-
+    MjI4NGZkMTVhZTM4NmQzZjlhNTlkMTQwYjAwZDI2Y2VjOTQ0NjBkNA==
+SHA512:
+  metadata.gz: !binary |-
+    ZmMwYmQ5Y2RkYTg5ZjNhNWI4ZWJmMzYyMzIwZjIyNjkwOWM5ZTg2M2E4ZjU2
+    ZWFkOGU3ZDc2ZGM0M2RmYWEwNjhkNjI0YzllNzc3NzhmMGUzNzlkNmM2NmFm
+    MTlhNGJiZTljZTljYTMwYWRlNjEzZDlkNDViNTNhYzNmMzM5YjY=
+  data.tar.gz: !binary |-
+    NGZhMWRiNDExMGVlZTJjODQyYzYxMmI1YTNlODY1MDdkZjk3YTM1YzMzYzBj
+    OTY1MzU2YzkwNThkZGE2MDExZDI0ZDBlMTA5MzQ3ZDMzMjViZWM0MTlhNzkw
+    OTFiM2YwYzk5NjlmYjZkNDg0NzEwY2Y4MDc2MTFlMWE5MTJjZTY=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Charlie Greene
+
+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.textile

@@ -0,0 +1,73 @@
+h1. Search Plugin
+
+This is a plugin for LocomotiveCMS. It was created to allow LocomotiveCMS designers to add some functionallity to the LocomotiveCMS search gem.
+
+It provides a few liwuid tags that can be used to improve the search functionality.
+
+h2. Installation
+
+To use this plugin you must be using a version of LocomotiveCMS that has the plugins feature designed by "Colibri Software":https://www.colibri-software.com. You can do this by making the following changes to the Gemfile in you app:
+
+* Remove or comment out the following line:
+@gem 'locomotive_cms', '~> 2.X.X', require: 'locomotive/engine'@
+* Add the following line:
+@gem 'locomotive_cms', require: 'locomotive/engine', git: 'https://github.com/colibri-software/locomotive_engine.git', branch: 'plugins'@
+
+Then add the following lines in your Gemfile to include the plugin:
+<pre><code>group :locomotive_plugins do
+  gem 'locomotive_search_ext_plugin'
+end</code></pre>
+
+This plugin also requires the LocomotiveCMS Search gem. To add it add the following to your gemfile:
+@gem 'locomotivecms-search', require: 'locomotive/search/mongoid'@
+
+h2. Usage
+
+h3. Configuring Plugin
+
+This plugin requires no configuration.
+
+h3. Liquid Drops
+
+This plugin has no Liquid Drops
+
+h3. Liquid Tags
+
+This plugin provides several tags that will improve the search functionallity.
+
+The following is a list of tags and their options(and defaults):
+
+* search_assign
+** Used to turn a search result into a page or content_entry
+** Usage:
+@{% search_assign <search_result> to <variabel to assign to>: <variable for content_type name> %}@
+** Example:
+<pre><code>{% for result in site.search %}
+  {% search_assign result to object: flag %}
+  {% if object %}
+    {% link_to object%}
+    {{ object_description }}
+    {% if flag %}
+      <p>{{flag}}</p>
+    {% else %}
+      <p>Page</p>
+    {% endif %}
+  {% endif %}
+{% endfor %}</code></pre>
+* search_custom_type
+** Used to do a search on a specific model using specific fields
+** Usage:
+@{% search_custom_type <content_type> on <comma seperated fields> to <variable to store results>%}@
+** Example:
+<pre><code><form id="members" action="/members">
+  <input type="text" name="category_id" />
+</form>
+{% search_custom_type members on fields category_id to results  %}
+{% for member in members %}
+  {{member.name}}
+{% endfor %}</code></pre>
+
+
+h3. Liquid Filters
+
+This plugin has no Liquid Filters

data/Rakefile

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

data/lib/activesearch/proxy_score.rb

@@ -0,0 +1,39 @@
+require "activesearch/proxy"
+
+module ActiveSearch
+  class Proxy
+    include Enumerable
+
+    def initialize(text, conditions, options = {}, &implementation)
+      @text           = text
+      @conditions     = conditions
+      @options        = options
+      @implementation = implementation
+    end
+
+    def each(&block)
+      @implementation.call(@text, @conditions).each do |result|
+        block.call(Result.new(result, @text, @options), generate_score(result))
+      end
+    end
+
+    protected
+
+    def generate_score(result)
+      score = 0
+      result.each do |k,v|
+        score += 1 if text_words.include?(k)
+        if v.class == String
+          v.split.each do |word|
+            score += 1 if text_words.include?(word)
+          end
+        end
+      end
+      score
+    end
+
+    def text_words
+      @text_words ||= @text.scan(/\w+|\n/)
+    end
+  end
+end

data/lib/locomotive/search_ext/plugin.rb

@@ -0,0 +1,23 @@
+require "locomotive/search_ext/plugin/version"
+require "locomotive/search_ext/plugin/assign"
+require "locomotive/search_ext/plugin/custom_type"
+require "activesearch/proxy_score"
+
+module Locomotive
+  module SearchExt
+    class Plugin
+      include Locomotive::Plugin
+
+      def self.default_plugin_id
+        'search_ext'
+      end
+
+      def self.liquid_tags
+        {
+          :assign => Assign,
+          :custom_type => CustomType
+        }
+      end
+    end
+  end
+end

data/lib/locomotive/search_ext/plugin/assign.rb

@@ -0,0 +1,51 @@
+module Locomotive
+  module SearchExt
+    class Assign < ::Liquid::Tag
+      include ActionView::Helpers::SanitizeHelper
+      Syntax = /(#{::Liquid::VariableSignature}+)\s*to\s*(#{::Liquid::VariableSignature}+):\s*(#{::Liquid::VariableSignature}+)/
+
+        def initialize(tag_name, markup, tokens, context)
+          if markup =~ Syntax
+            @results = $1
+            @target = $2
+            @description = "#{@target}_description"
+            @flag = $3
+            @options = {}
+            markup.scan(::Liquid::TagAttributes) { |key, value| @options[key.to_sym] = value.gsub(/"|'/, '') }
+          else
+            raise ::Liquid::SyntaxError.new("Syntax Error in 'search_assign' - Valid syntax: search_assign results to variable: pagetag")
+          end
+
+          super
+        end
+
+      def render(context)
+        @site = context.registers[:site]
+        @result = context[@results][0]
+        result_data = false
+
+        if @result['content_type_slug']
+          # its a model entry
+          model = @site.content_types.where(slug: @result['content_type_slug']).first
+          model_item = model.entries.find(@result['original_id']).to_liquid
+          result_data = model_item if model_item
+          context[@flag.to_s] = model.name
+          context[@description.to_s] = @result
+        else
+          # it is a page
+          page = @site.pages.find(@result['original_id']).to_liquid
+          result_data = page if page
+          context[@flag.to_s] = false
+
+          res =  @result['highlighted']['searchable_content']
+
+          context[@description] = strip_tags(res)
+        end
+        context[@target.to_s] = result_data
+        Rails.logger.error(result_data)
+        ""
+      end
+    end
+  end
+end
+

data/lib/locomotive/search_ext/plugin/custom_type.rb

@@ -0,0 +1,100 @@
+#require 'ruby-prof'
+
+module Locomotive
+  module SearchExt
+    class CustomType < ::Liquid::Tag
+
+      Syntax = /(#{::Liquid::QuotedFragment})\s*on fields\s*(#{::Liquid::QuotedFragment})\s*to\s*(#{::Liquid::QuotedFragment})/
+
+        def initialize(tag_name, markup, tokens, context)
+          if markup =~ Syntax
+            @content_type_slug = $1
+            @fields = $2.split(',')
+            @target = $3
+          else
+            raise ::Liquid::SyntaxError.new("Syntax Error in 'search_custom_type - Valid syntax: search_custom_type 'content_type_slug' on fields 'field_a, field_b' to results")
+          end
+
+          #@site = context.registers[:site]
+          #content_type = @site.content_type.where(slug: @content_type_slug).first
+          #raise ::Liquid::SyntaxError.new("Syntax Error in 'search_custom_type': #{@content_type_slug} is not a content type ") unless content_type
+          #real_fields = content_type.entries_custom_fields.collect(&:label)
+          #@fields.each do  |field|
+          #  unless real_fields.include?(field)
+          #    raise ::Liquid::SyntaxError.new("Syntax Error in 'search_custom_type':#{field} is not a field on #{@content_type_slug}")
+          #  end
+          #end
+          super
+        end
+
+      def render(context)
+        @site = context.registers[:site]
+        content_type = @site.content_types.where(slug: @content_type_slug).first
+        raise ::Liquid::Error.new("Error in 'search_custom_type': #{@content_type_slug} is not a content type ") unless content_type
+        @fields.each do |field|
+          unless content_type.entries.first.respond_to?(field)
+            raise ::Liquid::Error.new("Error in 'search_custom_type':#{field} is not a field on #{@content_type_slug}")
+          end
+        end
+
+        #profile = RubyProf.profile do
+        search = nil
+        search_terms = context.registers[:controller].params[:search]
+        if search_terms and !search_terms.empty?
+          Rails.logger.warn "Params: #{search_terms}, { \"site_id\" => #{@site.id}, \"content_type_slug\" => #{@content_type_slug} }"
+          search = ::ActiveSearch.search(
+            search_terms,
+            {
+            "site_id" => @site.id,
+            "content_type_slug" => @content_type_slug,
+          }
+          )
+        end
+
+        @fields.select! do |field|
+          param = context.registers[:controller].params[field]
+          param && !param.empty?
+        end
+
+        if search
+          slugs = {}
+          search.each do |result,score|
+            Rails.logger.warn "search: #{result}"
+            slugs[result['_slug']] = score
+          end
+        end
+
+        Rails.logger.warn "Seach Slugs: #{slugs}"
+        final_results = []
+        content_type.ordered_entries(context["with_scope"]).each do |entry|
+          if !search or slugs.has_key?(entry._slug)
+            if match_fields(context, entry)
+              idx = 0
+              idx = slugs[entry._slug] if search
+              final_results[idx] ||= []
+              final_results[idx] << entry.to_liquid
+            end
+          end
+        end
+
+        context[@target.to_s] = final_results.reverse.flatten.compact
+        #end
+        # Print a graph profile to text
+        #printer = RubyProf::MultiPrinter.new(profile)
+        #printer.print(:path => '/home/greeneca/colibri/tmp/profile')
+
+        ""
+      end
+
+      private
+
+      def match_fields(context, model_item)
+        @fields.each do |field|
+          return false unless model_item[field].to_s == context.registers[:controller].params[field]
+        end
+        true
+      end
+    end
+  end
+end
+

data/lib/locomotive/search_ext/plugin/version.rb

@@ -0,0 +1,5 @@
+module Locomotive
+  module SearchExt
+    VERSION = "1.0.0"
+  end
+end

data/lib/locomotive_search_ext_plugin.rb

@@ -0,0 +1 @@
+require 'locomotive/search_ext/plugin'

data/locomotive_search_ext_plugin.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'locomotive/search_ext/plugin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "locomotive_search_ext_plugin"
+  spec.version       = Locomotive::SearchExt::VERSION
+  spec.authors       = ["Charlie Greene"]
+  spec.email         = ["greeneca@gmail.com"]
+  spec.description   = %q{Provides search display tag.}
+  spec.summary       = %q{Provides a simple search display tag.}
+  spec.homepage      = "http://colibri-software.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency "locomotive_plugins", '~> 1.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: locomotive_search_ext_plugin
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Charlie Greene
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: locomotive_plugins
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Provides search display tag.
+email:
+- greeneca@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.textile
+- Rakefile
+- lib/activesearch/proxy_score.rb
+- lib/locomotive/search_ext/plugin.rb
+- lib/locomotive/search_ext/plugin/assign.rb
+- lib/locomotive/search_ext/plugin/custom_type.rb
+- lib/locomotive/search_ext/plugin/version.rb
+- lib/locomotive_search_ext_plugin.rb
+- locomotive_search_ext_plugin.gemspec
+homepage: http://colibri-software.com
+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: Provides a simple search display tag.
+test_files: []