keyword_search_yjchen 1.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 99b430cad0ca06c3aa0cd1b59d6cbbf0029ed61d
+  data.tar.gz: 85094d9cfaaa460182ee1ffef0b37b48e374b5df
+SHA512:
+  metadata.gz: 4cd2225b2b5590ffaeff4148c2a0462c225cbfe1513eb9f1060f4dcf4ea8724f8e0374943e393ba47a02e9bcf38fb16394d765c32e231b0d80ac3af79f50319d
+  data.tar.gz: ddc756a7b1367faa4091959e32fdfedc7dbac81c650e4de3fc4cafb58020256729205e53ca6d35b702d0b7d728e906a75c4ecfc863f15be35a9e158ce89cd8a2

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,9 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+
+bundler_args: --without docs
+
+notifications:
+  email:
+    - brwcodes@gmail.com

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2007-2013 Bruce Williams
+
+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/Manifest

@@ -0,0 +1,8 @@
+History.txt
+lib/keyword_search/definition.rb
+lib/keyword_search.rb
+lib/keyword_search.rl
+Manifest
+Rakefile
+README.rdoc
+test/test_keyword_search.rb

data/README.md

@@ -0,0 +1,112 @@
+Keyword Search
+==============
+
+[![Build Status](https://travis-ci.org/bruce/keyword_search.png)](https://travis-ci.org/bruce/keyword_search)
+
+Description
+-----------
+
+Generic library to parse GMail-style search strings for keyword/value pairs;
+supports definition of valid keywords and handling of quoted values.
+
+Requirements
+------------
+
+None.
+
+Features
+--------
+
+The library features a very simple, easy-to-use API.
+
+ * Define handlers for supported keywords with blocks
+ * Define the default keyword (values not part of a keyword/value pair)
+ * Handle negation
+
+Please see the example provided below.
+
+Synopsis
+--------
+
+Here's an example using ActiveRecord (though the library is generic, and can
+be used for any Ruby project).  The library isn't limited to search terms, as
+shown in this example; how you use it is up to you.
+
+First, let's build up some variables we'll be populating for a SQL query.
+
+```ruby
+clauses = []
+arguments = []
+```
+
+Now let's set an example string to parse.  Presumably you'd get this from
+a form (ie, `params[:terms]`) or some other form of input.
+
+```ruby
+terms = 'account has:attachment since:2006-12-03 -description:crazy'
+```
+
+Now let's do the search, defining the handlers to deal with each keyword.
+
+```ruby
+KeywordSearch.search(terms) do |with|
+
+  # This sets the keyword handler for bare words in the string,
+  # ie "account" in our example search terms
+  with.default_keyword :title
+
+  # Here's what we do when we encounter a "title" keyword
+  with.keyword :title do |values|
+    clauses << "title like ?"
+    arguments << "%#{values.join(' ')}%"
+  end
+
+  # For "has," we check the value provided (and only support "attachment")
+  with.keyword :has do |values|
+    clauses << 'has_attachment = true' if values.include?('attachment')
+  end
+
+  # Here we do some date parsing
+  with.keyword :since do |values|
+    date = Date.parse(values.first) # only support one
+    clauses << 'created_on >= ?'
+    arguments << date.to_s
+  end
+
+  # If a second parameter is defined for a block, you can handle negation.
+  # In this example, we don't want results whose description includes
+  # the word "crazy"
+  with.keyword :description do |values, positive|
+    clauses << "description #{'not' unless positive} like ?"
+    arguments << "%#{values.join(' ')}%"
+  end
+
+end
+```
+
+Immediately after the block is defined, the string is parsed and handlers
+fire.  Due to the magic of closures, we now have populated variables we can
+use to build a real SQL query.
+
+```ruby
+query = clauses.map { |c| "(#{c})" }.join(' AND ')
+conditions = [query, *arguments]
+results = Message.all(:conditions => conditions)
+```
+
+Installation
+------------
+
+```
+gem install keyword_search
+```
+
+License
+-------
+
+See LICENSE.
+
+Legal Notes
+-----------
+
+GMail is copyright Google, Inc.

data/Rakefile

@@ -0,0 +1,16 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+desc "Run tests"
+Rake::TestTask.new do |t|
+  t.pattern = 'test/test_*.rb'
+  t.verbose = true
+  t.warning = false # Ragel is noisy
+end
+
+task default: :test
+
+desc "Build parser with Ragel"
+task :ragel do
+  sh "ragel -R lib/keyword_search.rl -o lib/keyword_search.rb"
+end

data/keyword_search.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'keyword_search/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "keyword_search_yjchen"
+  spec.version       = KeywordSearch::VERSION
+  spec.authors       = ["Bruce Williams", "Eric Lindvall"]
+  spec.email         = ["brwcodes@gmail.com", "eric@sevenscale.com"]
+  spec.summary       = %q{Generic library to parse GMail-style search strings for keyword/value pairs; supports definition of valid keywords and handling of quoted values.}
+  spec.homepage      = %q{http://github.com/bruce/keyword_search}
+  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.rdoc_options  = ["--charset=UTF-8"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/keyword_search/definition.rb

@@ -0,0 +1,57 @@
+module KeywordSearch
+
+  class Definition
+
+    class Keyword
+
+      attr_reader :name, :description, :handler
+      def initialize(name, description=nil, &handler)
+        @name, @description = name, description
+        @handler = handler
+      end
+
+      def handle(value, sign)
+        # If the handler is only expecting one argument,
+        # only give them the positive matches
+        if handler.arity == 1
+          handler.call(value) if sign
+        else
+          handler.call(value, sign)
+        end
+      end
+
+    end
+
+    def initialize
+      @default_keyword = nil
+      yield self if block_given?
+    end
+
+    def keywords
+      @keywords ||= []
+    end
+
+    def keyword(name, description=nil, &block)
+      keywords << Keyword.new(name, description, &block)
+    end
+
+    def default_keyword(name)
+      @default_keyword = name
+    end
+
+    def handle(key, values)
+      key = @default_keyword if key == :default
+      return false unless key
+      true_values, false_values = *values.partition { |v| v[1] }
+
+      # Get just the values
+      true_values.collect! { |v| v[0] }
+      false_values.collect! { |v| v[0] }
+
+      if k = keywords.detect { |kw| kw.name == key.to_sym}
+        k.handle(true_values, true)   unless true_values.empty?
+        k.handle(false_values, false) unless false_values.empty?
+      end
+    end
+  end
+end

data/lib/keyword_search/version.rb

@@ -0,0 +1,3 @@
+module KeywordSearch
+  VERSION = '1.5.0'
+end