scim-query-filter-parser 0.0.1

data/.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+
+GemSpec ||= Gem::Specification.new do |gem|
+  gem.name = 'scim-query-filter-parser'
+  gem.version = '0.0.1'
+  gem.license = 'MIT'
+  gem.required_ruby_version = '>= 1.9.1'
+
+  gem.authors << 'Ingy döt Net'
+  gem.email = 'ingy@ingy.net'
+  gem.summary = 'SCIM Filter Query Parser'
+  gem.description = <<-'.'
+A parser for SCIM filter queries. Specced here:
+http://www.simplecloud.info/specs/draft-scim-api-01.html#query-resources
+.
+  gem.homepage = 'https://github.com/ingydotnet/scim-query-filter-parser'
+
+  gem.files = `git ls-files`.lines.map{|l|l.chomp}
+
+  gem.add_development_dependency 'rake'
+end

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+- 1.9.3
+script: bundle exec rake test

data/CHANGELOG.yaml

@@ -0,0 +1,3 @@
+- version: 0.0.1
+  date:    Tue Sep 17 16:02:31 PDT 2013
+  changes: First release

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+(The MIT License)
+
+Copyright © 2013 Ingy döt Net
+
+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 NON-INFRINGEMENT. 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.rdoc

@@ -0,0 +1,57 @@
+= Name
+
+scim-query-filter-parser - Parser for SCIM Filter Query Strings
+
+= Synopsis
+
+    require 'scim/query/filter/parser'
+
+    parser = SCIM::Query::Filter::Parser.new
+    rpn_array = parser.parse(filter_query_string)
+    rpn_stack = parser.rpn
+    rpn_tree = parser.tree
+
+    # or (in a single statement):
+    rpn_array = SCIM::Query::Filter::Parser.new.parse(filter_query_string).rpn
+
+= Description
+
+The SCIM spec describes a simple filter query language here:
+http://www.simplecloud.info/specs/draft-scim-api-01.html#query-resources
+
+This gem can parse one of these filter queries and produce a Reverse Polish
+Notation (RPN) stack representation.
+
+For example, parse this filter query string:
+
+    userType eq "Employee" and (emails co "example.com" or emails co "example.org")
+
+Into this RPN stack (array):
+
+    [userType, "Employee", eq, emails, "example.com", co, emails, "example.org", co, or ,and]
+
+Or, optionally into this expression tree:
+
+    [and, [eq, userType, "Employee"], [or, [co, emails, "example.com"], [co, emails, "example.org"]]]
+
+= Methods
+
+`parser = SCIM::Query::Filter::Parser.new()`::
+    Creae a new parser object.
+
+`parser.parse(input)`::
+    Parse a SCIM filter query. Return the parser object (self) if successful.
+
+`array = parser.rpn`::
+    Get the RPN array created by the most recent parse.
+
+`tree = parser.tree`::
+    Get the parse result converted to a tree form.
+
+= Code Status
+
+* {<img src="https://travis-ci.org/ingydotnet/scim-query-filter-parser-rb.png" />}[https://travis-ci.org/ingydotnet/scim-query-filter-parser-rb]
+
+= Copyright
+
+Copyright (c) 2013 Ingy döt Net. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,73 @@
+# Load Gem constants from the gemspec
+GemSpecFile = '.gemspec'
+load GemSpecFile
+GemName = GemSpec.name
+GemVersion = GemSpec.version
+GemDir = "#{GemName}-#{GemVersion}"
+GemFile = "#{GemDir}.gem"
+DevNull = '2>/dev/null'
+
+# Require the Rake libraries
+require 'rake'
+require 'rake/testtask'
+require 'rake/clean'
+if File.exists? 'test/testml.yaml'
+  if File.exists? 'lib/rake/testml.rb'
+    $:.unshift "#{Dir.getwd}/lib"
+  end
+  require 'rake/testml'
+end
+
+task :default => 'help'
+
+CLEAN.include GemDir, GemFile, 'data.tar.gz', 'metadata.gz'
+
+desc 'Run the tests'
+task :test do
+  load '.env' if File.exists? '.env'
+  Rake::TestTask.new do |t|
+    t.verbose = true
+    t.test_files = ENV['DEV_TEST_FILES'] &&
+      FileList[ENV['DEV_TEST_FILES'].split] ||
+      FileList['test/**/*.rb'].sort
+  end
+end
+
+desc 'Build the gem'
+task :build => [:clean, :test] do
+  sh "gem build #{GemSpecFile}"
+end
+
+desc 'Install the gem'
+task :install => [:build] do
+  sh "gem install #{GemFile}"
+end
+
+desc 'Build, unpack and inspect the gem'
+task :distdir => [:build] do
+  sh "tar xf #{GemFile} #{DevNull}"
+  Dir.mkdir GemDir
+  Dir.chdir GemDir
+  sh "tar xzf ../data.tar.gz #{DevNull}"
+  puts "\n>>> Entering sub-shell for #{GemDir}..."
+  system ENV['SHELL']
+end
+
+desc 'Build and push the gem'
+task :release => [:build] do
+  sh "gem push #{GemFile}"
+end
+
+desc 'Print a description of the gem'
+task :desc do
+  puts "Gem: '#{GemName}' (version #{GemVersion})"
+  puts
+  puts GemSpec.description.gsub /^/, '  '
+end
+
+desc 'List the Rakefile tasks'
+task :help do
+  puts 'The following rake tasks are available:'
+  puts
+  puts `rake -T`.gsub /^/, '  '
+end

data/lib/scim/query/filter/parser.rb

@@ -0,0 +1,144 @@
+class SCIM; class Query; class Filter; class Parser; end; end; end; end
+
+class SCIM::Query::Filter::Parser
+  attr_accessor :rpn
+
+  #----------------------------------------------------------------------------
+  # Operator Precedence:
+  Ops = {
+    'pr' => 4,
+    'eq' => 3,
+    'co' => 3,
+    'sw' => 3,
+    'gt' => 3,
+    'ge' => 3,
+    'lt' => 3,
+    'le' => 3,
+    'and' => 2,
+    'or' => 1,
+  }
+  Unary = {
+    'pr' => 1,
+  }
+
+  # Tokenizing regexen:
+  Paren = /[\(\)]/
+  Str = /"(?:\\"|[^"])*"/
+  Op = /#{Ops.keys.join'|'}/
+  Word = /[\w\.]+/
+  Sep = /\s?/
+  NextToken = /^(#{Paren}|#{Str}|#{Op}|#{Word})#{Sep}/
+  IsOperator = /^(?:#{Op})$/
+
+  #----------------------------------------------------------------------------
+  # Parse SCIM filter query into RPN stack:
+  def parse input
+    @input = input.clone            # Save for error msgs
+    @tokens = lex input
+    @rpn = parse_expr
+    assert_eos
+    self
+  end
+
+  def parse_expr
+    ast = []
+    expect_op = false
+    while not eos and peek != ')'
+      expect_op && assert_op || assert_not_op
+      ast.push(start_group ? parse_group : pop)
+      expect_op ^= true unless Unary[ast.last]
+    end
+    to_rpn ast
+  end
+
+  def parse_group
+    pop                 # pop '(' token
+    ast = parse_expr
+    assert_close && pop # pop ')' token
+    ast
+  end
+
+  # Split input into tokens
+  def lex input
+    tokens = []
+    while ! input.empty? do
+      input.sub! NextToken, '' \
+        or fail "Can't lex input here '#{input}'"
+      tokens.push $1
+    end
+    tokens
+  end
+
+  # Turn parsed tokens into an RPN stack
+  # http://en.wikipedia.org/wiki/Shunting_yard_algorithm
+  def to_rpn ast
+    out, ops = [], []
+    out.push ast.shift if not ast.empty?
+    while not ast.empty? do
+      op = ast.shift
+      p = Ops[op] \
+        or fail "Unknown operator '#{op}'"
+      while not ops.empty? do
+        break if p > Ops[ops.first]
+        out.push ops.shift
+      end
+      ops.unshift op
+      out.push ast.shift if not Unary[op]
+    end
+    (out.concat ops).flatten
+  end
+
+  #----------------------------------------------------------------------------
+  # Transform RPN stack into a tree structure
+  def tree
+    @stack = @rpn.clone
+    get_tree
+  end
+
+  def get_tree
+    tree = []
+    if not @stack.empty?
+      op = tree[0] = @stack.pop
+      tree[1] = Ops[@stack.last] ? get_tree : @stack.pop
+      tree.insert 1, Ops[@stack.last] ? get_tree : @stack.pop \
+        if not Unary[op]
+    end
+    tree
+  end
+
+  #----------------------------------------------------------------------------
+  # Token sugar methods
+  def peek; @tokens.first  end
+  def pop;  @tokens.shift  end
+  def eos;  @tokens.empty? end
+  def start_group; peek == '(' end
+  def peek_operator
+    not(eos) and peek.match IsOperator
+  end
+
+
+  # Error handling methods:
+  def parse_error msg
+    fail "#{sprintf(msg, *@tokens, 'EOS')}.\nInput: '#{@input}'\n"
+  end
+
+  def assert_op
+    return true if peek_operator
+    parse_error "Unexpected token '%s'. Expected operator"
+  end
+
+  def assert_not_op
+    return true if ! peek_operator
+    parse_error "Unexpected operator '%s'"
+  end
+
+  def assert_close
+    return true if peek == ')'
+    parse_error "Unexpected token '%s'. Expected ')'"
+  end
+
+  def assert_eos
+    return true if eos
+    parse_error "Unexpected token '%s'. Expected EOS"
+  end
+end

data/test/parse.rb

@@ -0,0 +1,82 @@
+require 'scim/query/filter/parser'
+require 'test/unit'
+require 'yaml'
+require 'json'
+
+class TestParser < Test::Unit::TestCase
+  def test_spec
+    data = $test_parse_data.lines.to_a
+    parser = SCIM::Query::Filter::Parser.new
+    while true do
+      input = data.shift or break
+      input.chomp!
+      rpn_yaml = data.shift or break
+      next if rpn_yaml == "\n"
+      parser.parse(input)
+      got_rpn_json = parser.rpn.to_json
+      want_rpn_json = YAML.load(rpn_yaml).to_json
+      assert_equal want_rpn_json, got_rpn_json,
+        "Test parse to RPN: '#{input.chomp}'"
+      tree_yaml = data.shift or break
+      next if tree_yaml == "\n"
+      got_tree_json = parser.tree.to_json
+      want_tree_json = YAML.load(tree_yaml).to_json
+      assert_equal want_tree_json, got_tree_json,
+        "Test parse to tree: '#{input.chomp}'"
+      blank_line = data.shift or break
+      fail "Got '#{blank_line.chomp}', expected blank line" \
+        unless blank_line == "\n"
+    end
+  end
+end
+
+# See http://www.simplecloud.info/specs/draft-scim-api-01.html#query-resources
+$test_parse_data = <<'...'
+
+[]
+[]
+
+userName eq "bjensen"
+[userName,'"bjensen"',eq]
+[eq, userName,'"bjensen"']
+
+name.familyName co "O'Malley"
+[name.familyName, '"O''Malley"', co]
+[co, name.familyName, '"O''Malley"']
+
+userName sw "J"
+[userName, '"J"', sw]
+[sw, userName, '"J"']
+
+title pr
+[title, pr]
+[pr, title]
+
+meta.lastModified gt "2011-05-13T04:42:34Z"
+[meta.lastModified, '"2011-05-13T04:42:34Z"', gt]
+[gt, meta.lastModified, '"2011-05-13T04:42:34Z"']
+
+meta.lastModified ge "2011-05-13T04:42:34Z"
+[meta.lastModified, '"2011-05-13T04:42:34Z"', ge]
+[ge, meta.lastModified, '"2011-05-13T04:42:34Z"']
+
+meta.lastModified lt "2011-05-13T04:42:34Z"
+[meta.lastModified, '"2011-05-13T04:42:34Z"', lt]
+[lt, meta.lastModified, '"2011-05-13T04:42:34Z"']
+
+meta.lastModified le "2011-05-13T04:42:34Z"
+[meta.lastModified, '"2011-05-13T04:42:34Z"', le]
+[le, meta.lastModified, '"2011-05-13T04:42:34Z"']
+
+title pr and userType eq "Employee"
+[title, pr, userType, '"Employee"', eq, and]
+[and, [pr, title], [eq, userType, '"Employee"']]
+
+title pr or userType eq "Intern"
+[title, pr, userType, '"Intern"', eq, or]
+[or, [pr, title], [eq, userType, '"Intern"']]
+
+userType eq "Employee" and (emails co "example.com" or emails co "example.org")
+[userType, '"Employee"', eq, emails, '"example.com"', co, emails, '"example.org"', co, or ,and]
+[and, [eq, userType, '"Employee"'], [or, [co, emails, '"example.com"'], [co, emails, '"example.org"']]]
+...

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: scim-query-filter-parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ingy döt Net
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! 'A parser for SCIM filter queries. Specced here:
+
+  http://www.simplecloud.info/specs/draft-scim-api-01.html#query-resources
+
+'
+email: ingy@ingy.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gemspec
+- .travis.yml
+- CHANGELOG.yaml
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/scim/query/filter/parser.rb
+- test/parse.rb
+homepage: https://github.com/ingydotnet/scim-query-filter-parser
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: SCIM Filter Query Parser
+test_files: []