beawesomeinstead-explore 0.1.0

data/explore.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name = "explore"
+  s.version = "0.1.0"
+  s.date = "2008-07-11"
+  s.summary = "Simple conditions parser."
+  s.email = "beawesomeinstead@yahoo.com"
+  s.homepage = "http://github.com/beawesomeinstead/explore/wikis"
+  s.description = s.summary
+  s.authors = ["beawesomeinstead"]
+  s.has_rdoc = false
+  s.require_paths = ["libraries"]
+  s.files = ["libraries/explore", "libraries/explore/definition.rb", "libraries/explore/search.rl", "libraries/explore/keyword.rb", "libraries/explore/search.rb", "libraries/explore.rb", "specifications/spec_helper.rb", "specifications/integration", "specifications/integration/explore_spec.rb", "rakefile", "readme", "explore.gemspec"]
+end

data/libraries/explore.rb

@@ -0,0 +1,4 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+%w(explore/definition explore/keyword explore/search).map { |x| require x }

data/libraries/explore/definition.rb

@@ -0,0 +1,28 @@
+module Explore #:nodoc:
+  class Definition #:nodoc:
+    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
+      if k = keywords.detect { |kw| kw.name == key.to_sym }
+        k.handle(values)
+      end
+    end
+  end # class Definition
+end # module Keyword

data/libraries/explore/keyword.rb

@@ -0,0 +1,14 @@
+module Explore #:nodoc:
+  class Keyword #:nodoc:
+    attr_reader :name, :description, :handler
+
+    def initialize(name, description = nil, &handler)
+      @name, @description = name, description
+      @handler = handler
+    end
+
+    def handle(value)
+      handler.call(value)
+    end
+  end # class Keyword
+end # module Keyword

data/libraries/explore/search.rb

@@ -0,0 +1,281 @@
+module Explore
+
+  class ParseError < ::SyntaxError; end  
+      
+  class << self
+  
+    # line 54 "lib/keyword_search.rl"
+
+    
+    def search(input_string, definition=nil, &block)
+      definition ||= Definition.new(&block)
+      results = parse(input_string)
+      results.each do |key, terms|
+        definition.handle(key, terms)
+      end
+      results
+    end
+    
+    #######
+    private
+    #######
+    
+    def parse(input) #:nodoc:
+      data = input + ' '
+      
+# line 30 "lib/keyword_search.rb"
+class << self
+	attr_accessor :_parser_actions
+	private :_parser_actions, :_parser_actions=
+end
+self._parser_actions = [
+	0, 1, 3, 1, 5, 1, 6, 2, 
+	0, 2, 2, 1, 0, 3, 0, 2, 
+	4, 3, 1, 0, 4
+]
+
+class << self
+	attr_accessor :_parser_key_offsets
+	private :_parser_key_offsets, :_parser_key_offsets=
+end
+self._parser_key_offsets = [
+	0, 0, 6, 10, 15, 19, 20, 21, 
+	22, 23
+]
+
+class << self
+	attr_accessor :_parser_trans_keys
+	private :_parser_trans_keys, :_parser_trans_keys=
+end
+self._parser_trans_keys = [
+	0, 32, 34, 39, 40, 58, 32, 34, 
+	41, 58, 32, 34, 39, 40, 58, 32, 
+	34, 41, 58, 34, 32, 39, 41, 32, 
+	34, 41, 58, 0
+]
+
+class << self
+	attr_accessor :_parser_single_lengths
+	private :_parser_single_lengths, :_parser_single_lengths=
+end
+self._parser_single_lengths = [
+	0, 6, 4, 5, 4, 1, 1, 1, 
+	1, 4
+]
+
+class << self
+	attr_accessor :_parser_range_lengths
+	private :_parser_range_lengths, :_parser_range_lengths=
+end
+self._parser_range_lengths = [
+	0, 0, 0, 0, 0, 0, 0, 0, 
+	0, 0
+]
+
+class << self
+	attr_accessor :_parser_index_offsets
+	private :_parser_index_offsets, :_parser_index_offsets=
+end
+self._parser_index_offsets = [
+	0, 0, 7, 12, 18, 23, 25, 27, 
+	29, 31
+]
+
+class << self
+	attr_accessor :_parser_trans_targs_wi
+	private :_parser_trans_targs_wi, :_parser_trans_targs_wi=
+end
+self._parser_trans_targs_wi = [
+	9, 0, 5, 7, 8, 0, 2, 1, 
+	0, 0, 3, 2, 0, 5, 7, 8, 
+	0, 4, 1, 0, 0, 0, 4, 6, 
+	5, 1, 0, 6, 7, 6, 8, 1, 
+	0, 0, 3, 2, 0
+]
+
+class << self
+	attr_accessor :_parser_trans_actions_wi
+	private :_parser_trans_actions_wi, :_parser_trans_actions_wi=
+end
+self._parser_trans_actions_wi = [
+	7, 5, 13, 13, 13, 5, 7, 1, 
+	0, 0, 0, 0, 0, 17, 17, 17, 
+	0, 10, 1, 0, 0, 0, 0, 3, 
+	0, 1, 0, 3, 0, 3, 0, 1, 
+	0, 0, 0, 0, 0
+]
+
+class << self
+	attr_accessor :parser_start
+end
+self.parser_start = 1;
+class << self
+	attr_accessor :parser_first_final
+end
+self.parser_first_final = 9;
+class << self
+	attr_accessor :parser_error
+end
+self.parser_error = 0;
+
+class << self
+	attr_accessor :parser_en_main
+end
+self.parser_en_main = 1;
+
+# line 72 "lib/keyword_search.rl"
+    	p = 0
+    	pe = data.length
+    	key = nil
+    	tokstart = nil
+    	results = {}
+    	quotes = 0
+      
+# line 138 "lib/keyword_search.rb"
+begin
+	cs = parser_start
+end
+# line 79 "lib/keyword_search.rl"
+      
+# line 144 "lib/keyword_search.rb"
+begin
+	_klen, _trans, _keys, _acts, _nacts = nil
+	if p != pe
+	if cs != 0
+	while true
+	_break_resume = false
+	begin
+	_break_again = false
+	_keys = _parser_key_offsets[cs]
+	_trans = _parser_index_offsets[cs]
+	_klen = _parser_single_lengths[cs]
+	_break_match = false
+	
+	begin
+	  if _klen > 0
+	     _lower = _keys
+	     _upper = _keys + _klen - 1
+
+	     loop do
+	        break if _upper < _lower
+	        _mid = _lower + ( (_upper - _lower) >> 1 )
+
+	        if data[p] < _parser_trans_keys[_mid]
+	           _upper = _mid - 1
+	        elsif data[p] > _parser_trans_keys[_mid]
+	           _lower = _mid + 1
+	        else
+	           _trans += (_mid - _keys)
+	           _break_match = true
+	           break
+	        end
+	     end # loop
+	     break if _break_match
+	     _keys += _klen
+	     _trans += _klen
+	  end
+	  _klen = _parser_range_lengths[cs]
+	  if _klen > 0
+	     _lower = _keys
+	     _upper = _keys + (_klen << 1) - 2
+	     loop do
+	        break if _upper < _lower
+	        _mid = _lower + (((_upper-_lower) >> 1) & ~1)
+	        if data[p] < _parser_trans_keys[_mid]
+	          _upper = _mid - 2
+	        elsif data[p] > _parser_trans_keys[_mid+1]
+	          _lower = _mid + 2
+	        else
+	          _trans += ((_mid - _keys) >> 1)
+	          _break_match = true
+	          break
+	        end
+	     end # loop
+	     break if _break_match
+	     _trans += _klen
+	  end
+	end while false
+	cs = _parser_trans_targs_wi[_trans]
+	break if _parser_trans_actions_wi[_trans] == 0
+	_acts = _parser_trans_actions_wi[_trans]
+	_nacts = _parser_actions[_acts]
+	_acts += 1
+	while _nacts > 0
+		_nacts -= 1
+		_acts += 1
+		case _parser_actions[_acts - 1]
+when 0:
+# line 13 "lib/keyword_search.rl"
+		begin
+
+        tokstart = p;
+      		end
+# line 13 "lib/keyword_search.rl"
+when 1:
+# line 17 "lib/keyword_search.rl"
+		begin
+
+        key = data[tokstart...p-1]
+        results[key] ||= []
+      		end
+# line 17 "lib/keyword_search.rl"
+when 2:
+# line 22 "lib/keyword_search.rl"
+		begin
+
+        key = nil
+      		end
+# line 22 "lib/keyword_search.rl"
+when 3:
+# line 26 "lib/keyword_search.rl"
+		begin
+
+        value = data[tokstart..p-1]
+        if ["("].include?(value[0,1])
+          value = parse(value[1..-2])[:default]
+        elsif ["'", '"'].include?(value[0,1])
+          value = value[1..-2]
+        end
+        (results[key || :default] ||= []) << value
+      		end
+# line 26 "lib/keyword_search.rl"
+when 4:
+# line 36 "lib/keyword_search.rl"
+		begin
+ quotes += 1 		end
+# line 36 "lib/keyword_search.rl"
+when 5:
+# line 38 "lib/keyword_search.rl"
+		begin
+ quotes -= 1 		end
+# line 38 "lib/keyword_search.rl"
+when 6:
+# line 52 "lib/keyword_search.rl"
+		begin
+ raise ParseError, "At offset #{p}, near: '#{data[p,10]}'" 		end
+# line 52 "lib/keyword_search.rl"
+# line 261 "lib/keyword_search.rb"
+		end # action switch
+	end
+	end while false
+	break if _break_resume
+	break if cs == 0
+	p += 1
+	break if p == pe
+	end
+	end
+	end
+	end
+# line 80 "lib/keyword_search.rl"
+    	
+# line 275 "lib/keyword_search.rb"
+# line 81 "lib/keyword_search.rl"
+    	unless quotes.zero?
+    	  raise ParseError, "Unclosed quotes"
+    	end
+    	results
+    end
+    
+  end
+  
+end

data/libraries/explore/search.rl

@@ -0,0 +1,80 @@
+module Explore
+  class ParseError < ::SyntaxError; end  
+
+  class << self
+    %%{
+      machine parser;
+
+      action start {
+        tokstart = p;
+      }
+
+      action key {
+        key = data[tokstart...p-1]
+        results[key] ||= []
+      }
+
+      action default {
+        key = nil
+      }
+
+      action value {
+        value = data[tokstart..p-1]
+        if ["("].include?(value[0,1])
+          value = parse(value[1..-2])[:default]
+        elsif ["'", '"'].include?(value[0,1])
+          value = value[1..-2]
+        end
+        (results[key || :default] ||= []) << value
+      }
+
+      action quote { quotes += 1 }
+
+      action unquote { quotes -= 1 }
+
+      bareword = [^ '"(:] [^ "):]*; # allow apostrophes
+      grouped = '(' @ quote any* :>> ')' @ unquote;
+      dquoted = '"' @ quote any* :>> '"' @ unquote;
+      squoted = '\'' @ quote any* :>> '\'' @ unquote;
+
+      value = ( grouped | dquoted | squoted | bareword );
+
+      pair = (bareword > start ':') % key value > start % value ;
+
+      definition = ( pair | value > start > default % value) ' ';        
+      main := definition** 0
+              @!{ raise ParseError, "At offset #{p}, near: '#{data[p,10]}'" };        
+    }%%
+
+    def search(input_string, definition=nil, &block)
+      definition ||= Definition.new(&block)
+      results = parse(input_string)
+      results.each do |key, terms|
+        definition.handle(key, terms)
+      end
+      results
+    end
+
+    #######
+    private
+    #######
+
+    def parse(input) #:nodoc:
+      data = input + ' '
+      %% write data;
+    	p = 0
+    	pe = data.length
+    	key = nil
+    	tokstart = nil
+    	results = {}
+    	quotes = 0
+      %% write init;
+      %% write exec;
+    	%% write eof;
+    	unless quotes.zero?
+    	  raise ParseError, "Unclosed quotes"
+    	end
+    	results
+    end
+  end
+end

data/rakefile

@@ -0,0 +1,6 @@
+%w(rubygems rake/gempackagetask spec/rake/spectask).each { |x| require x }
+
+Spec::Rake::SpecTask.new("specs") do |t|
+  t.spec_opts << '--format' << 'specdoc' << '--colour'
+  t.spec_files = Dir.glob("specifications/**/*_spec.rb")
+end

data/specifications/integration/explore_spec.rb

@@ -0,0 +1,204 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "spec_helper"))
+
+describe Explore do
+  NAME_AND_AGE = %<bruce williams age:26>
+  NAME_QUOTED_AND_AGE = %<"bruce williams" age:26>
+  NAME_AND_QUOTED_AGE = %<bruce williams age:"26">  
+  DEFAULT_AGE_WITH_QUOTED_AGE = %<26 name:"bruce williams">
+  DEFAULT_AGE_WITH_SINGLE_QUOTED_AGE = %<26 name:'bruce williams'>
+  NAME_WITH_NESTED_SINGLE_QUOTES = %<"d'arcy d'uberville" age:28>
+  NAME_AND_GROUPED_AGE = %<coda hale age:(27)>
+  NAME_AND_GROUPED_QUOTED_AGE = %<coda hale age:("27")>
+  NAME_AND_GROUPED_QUOTED_AGES = %<coda hale age:("27" 34 '48')>
+  GROUPED_NAMES_AND_AGE = %<(coda bruce 'hale' "williams") age:20>
+
+  before(:each) do
+    @result = nil
+  end
+
+  it "should parse grouped default keywords properly" do
+    Explore.search(NAME_AND_AGE) do |with|
+      with.default_keyword :name
+      with.keyword :name do |values|
+        @result = values.join(' ')
+      end
+    end
+    @result.should == "bruce williams"
+  end
+
+  it "should parse grouped default keywords properly" do
+    Explore.search(GROUPED_NAMES_AND_AGE) do |with|
+      with.default_keyword :name
+      with.keyword :name do |values|
+        @result = values.first
+      end
+    end
+    @result.should == ['coda', 'bruce', 'hale', 'williams']
+  end
+
+  it "should parse unquoted keyword term properly" do
+    Explore.search(NAME_AND_AGE) do |with|
+      with.keyword :age do |values|
+        @result = Integer(values.first)
+      end
+    end
+    @result.should == 26
+  end
+
+  it "should parse unquoted grouped keyword term properly" do
+    Explore.search(NAME_AND_GROUPED_AGE) do |with|
+      with.keyword :age do |values|
+        @result = Integer(values.first.first)
+      end
+    end
+    @result.should == 27
+  end
+
+  it "should parse quoted grouped keyword term properly" do
+    Explore.search(NAME_AND_GROUPED_QUOTED_AGE) do |with|
+      with.keyword :age do |values|
+        @result = Integer(values.first.first)
+      end
+    end
+    @result.should == 27
+  end
+
+  it "should parse mixed grouped keyword terms properly" do
+    Explore.search(NAME_AND_GROUPED_QUOTED_AGES) do |with|
+      with.keyword :age do |values|
+        @result = values.first.map { |v| v.to_i }
+      end
+    end
+    @result.should == [27, 34, 48]
+  end
+
+  it "should parse quoted default keyword term properly" do
+    Explore.search(NAME_QUOTED_AND_AGE) do |with|
+      with.default_keyword :name
+      with.keyword :name do |values|
+        @result = values.join(' ')
+      end
+    end
+    @result.should == "bruce williams"
+  end
+
+  it "should parse quoted keyword term properly" do
+    Explore.search(NAME_AND_QUOTED_AGE) do |with|
+      with.keyword :age do |values|
+        @result = Integer(values.first)
+      end
+    end
+    @result.should == 26
+  end
+
+  it "should parse quoted keyword term with whitespace properly" do
+    Explore.search(DEFAULT_AGE_WITH_QUOTED_AGE) do |with|
+      with.default_keyword :age
+      with.keyword :name do |values|
+        @result = values.first
+      end
+    end
+    @result.should == "bruce williams"
+  end
+
+  it "should parse single quoted keyword term with whitespace" do
+    Explore.search(DEFAULT_AGE_WITH_SINGLE_QUOTED_AGE) do |with|
+      with.default_keyword :age
+      with.keyword :name do |values|
+        @result = values.first
+      end
+    end
+    @result.should == "bruce williams"
+  end
+
+  it "should parse nested single quote is accumulated" do
+    Explore.search(NAME_WITH_NESTED_SINGLE_QUOTES) do |with|
+      with.default_keyword :name
+      with.keyword :name do |values|
+        @result = values.first
+      end
+    end
+    @result.should == %<d'arcy d'uberville>
+  end
+
+  it "should parse nested single quote is accumulated" do
+    Explore.search(%<'he was called "jake"'>) do |with|
+      with.default_keyword :text
+      with.keyword :text do |values|
+        @result = values.first
+      end
+    end
+    @result.should == %<he was called "jake">
+  end
+
+  it "should parse bare single quote in unquoted literal is accumulated" do
+    Explore.search(%<bruce's age:27>) do |with|
+      with.default_keyword :text
+      with.keyword :text do |values|
+        @result = values.first
+      end
+    end
+    @result.should == %<bruce's>
+  end
+
+  it "should parse single quoted literal is accumulated" do
+    Explore.search(%<foo 'bruce williams' age:27>) do |with|
+      with.default_keyword :text
+      with.keyword :text do |values|
+        @result = values.last
+      end
+    end
+    @result.should == %<bruce williams>
+  end
+
+  it "should parse period in literal is accumulated" do
+    Explore.search(%<okay... age:27>) do |with|
+      with.default_keyword :text
+      with.keyword :text do |values|
+        @result = values.first
+      end
+    end
+    @result.should == %<okay...>
+  end
+
+  it "should parse data with apostrophes in unquoted literal" do
+    Explore.search(%<d'correct>) do |with|
+      with.default_keyword :text
+      with.keyword :text do |values|
+        @result = values.first
+      end
+    end
+    @result.should == "d'correct"
+  end
+
+  it "should parse data with apostrophes in unquoted literal values" do
+    Explore.search(%<text:d'correct>) do |with|
+      with.default_keyword :text
+      with.keyword :text do |values|
+        @result = values.first
+      end
+    end
+    @result.should == "d'correct"
+  end
+
+  it "should parse case-sensitive keywords" do
+    Explore.search(%<Text:justtesting>) do |with|
+      with.keyword :text do |values|
+        @result = :small
+      end
+      with.keyword :Text do |values|
+        @result = :big
+      end
+    end
+    @result.should == :big
+  end
+
+  it "should parse case-sensitive values" do
+    Explore.search(%<text:Big>) do |with|
+      with.keyword :text do |values|
+        @result = values.first
+      end
+    end
+    @result.should == "Big"
+  end
+end

data/specifications/spec_helper.rb

@@ -0,0 +1,2 @@
+%w(rubygems spec).each { |x| require x }
+require File.join(File.dirname(__FILE__), "..", "libraries", "explore")

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: beawesomeinstead-explore
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- beawesomeinstead
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-11 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Simple conditions parser.
+email: beawesomeinstead@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- libraries/explore
+- libraries/explore/definition.rb
+- libraries/explore/search.rl
+- libraries/explore/keyword.rb
+- libraries/explore/search.rb
+- libraries/explore.rb
+- specifications/spec_helper.rb
+- specifications/integration
+- specifications/integration/explore_spec.rb
+- rakefile
+- readme
+- explore.gemspec
+has_rdoc: false
+homepage: http://github.com/beawesomeinstead/explore/wikis
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- libraries
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simple conditions parser.
+test_files: []
+