query_syntax 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3080165576250038bec4e48ed2cf0da017b81fc3
+  data.tar.gz: 7bcff375364147ea3669ed5b66273ade248cd0a8
+SHA512:
+  metadata.gz: 530277fd07a24d1e15b9b532fb92b8eaac72a36d5329b698064dbe78015f71f0d989bef1402a4b08e1dea7196bd9f6945e7a3bf41581b606b2e0326f162549d4
+  data.tar.gz: 41e176ca044ab28dd65d5d17cb38ff5eb4ab867f23bd9970b48e52d846684c95b72f5cf67a2ec2c5918c80e7ddceec52d9a6d1005becad8d273c2131e4fb0a62

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jonathan Serafini
+
+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.md

@@ -0,0 +1,110 @@
+# QuerySyntax
+
+Provides chainable objects to build Chef search queries as well as a method to share, re-use and extend queries.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'query_syntax'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install query_syntax
+
+## Usage
+
+QuerySyntax::Query provides bang and non-bang methods for and, or, not, where which determine whether we are modifying the current object or whether we are returning a new object. In most cases though, QuerySyntax will return the QuerySyntax object so that we can chain at will.
+
+The following methods are most likely to be used : 
+
+`.where!(hash)` 
+An AND-ed hash of criteria to search for within a single (scope). If multiple values are provided for a single key from subsequent where! or where calls, then the value is converted to an array of values which are OR-ed.
+
+Also notice that, as long as we chain where!, we are contribution criteria to the same scope.
+
+```
+Query.where!(a:1).to_s
+> a:1
+
+Query.where!(a:1, b:1).to_s
+> (a:1 AND b:1)
+
+Query.where!(a:1, b:1).where!(a:2,b:2).to_s
+> ((a:1 OR a:2) AND (b:1 OR b:2))
+```
+
+`.and!(hash)`
+Very similar to where!, we add additional criteria which we AND to the query. Unlike where!, however, and! generates a new (scope).
+
+If and! is specified without a hash, we decide that the entire left most portion of the statement is to be made it's own composite scope.
+
+```
+Query.where!(a:1, b:1).where!(a:2,b:2).to_s
+> ((a:1 OR a:2) AND (b:1 OR b:2))
+
+Query.where!(a:0,b:1).where!(a:2,b:2).and!(a:2,b:2).to_s
+> ((a:0 OR a:2) AND (b:1 OR b:2)) AND (a:2 AND b:2)
+```
+
+`.or!(hash) and .not!(hash)` function exactly like .and, however with a different operator than AND.
+
+`.push(object)` may be used to begin with a baseline and build on top of it.
+
+# Examples
+```
+# Create a baseline query
+Chef::Search.add_query("base")
+Chef::Search.base.
+  where!(chef_environment:"production").to_s
+> chef_environment:production
+
+# Create peers query
+Chef::Search.add_query("peers")
+Chef::Search.peers.push(Chef::Search.base).
+  where!(roles:"load_balancer").to_s
+> chef_environment:production AND roles:load_balancer
+
+# Update the baseline
+Chef::Search.base.
+  not!(tags:"maintenance").to_s
+> chef_environment:production NOT tags:maintenance
+
+Chef::Search.peers.to_s
+> (chef_environment:production NOT tags:maintenance) AND roles:load_balancer
+
+# Return an updated peers query for single use, notice there's no ! symbol
+Chef::Search.peers.where(roles:"shard1").to_s
+> (chef_environment:production NOT tags:maintenance) AND roles:load_balancer AND roles:shard1
+
+Chef::Search.base.to_s
+# Unchanged
+> chef_environment:production NOT tags:maintenance
+
+Chef::Search.peers.to_s
+# Unchanged
+> (chef_environment:production NOT tags:maintenance) AND roles:load_balancer
+
+# Perform a search
+Chef::Search.peers.search.map { |item| item.node_name }
+> [node,node,node]
+
+# Perform a partial search
+# notice we automatically ensure values are Arrays when they are strings
+Chef::Search.peers.partial(
+  keys:{chef_environment:"chef_environment",hostname:["hostname"]
+)
+> [{chef_environment:"production", hostname:"host1"}]
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/query_syntax/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/lib/chef/search.rb

@@ -0,0 +1,19 @@
+
+class Chef
+  class Search
+    def self.add_query(name, index = :node)
+      self.class.instance_eval do
+        define_method "#{name}" do
+          instance_variable_get("@#{name}")
+        end
+
+        define_method "#{name}=" do |value|
+          instance_variable_set("@#{name}",value)
+        end
+      end
+
+      instance_variable_set("@#{name}", QuerySyntax::Query.new(index))
+    end
+  end
+end
+

data/lib/query_syntax.rb

@@ -0,0 +1,5 @@
+
+require "query_syntax/version"
+require "query_syntax/query"
+require "chef/search"
+

data/lib/query_syntax/query.rb

@@ -0,0 +1,102 @@
+
+require 'query_syntax/scope'
+
+module QuerySyntax
+  class Query < NestedScope
+    def initialize(index)
+      super "AND"
+      @index = index
+      @ignore_failure = true
+    end
+
+    attr_accessor :ignore_failure
+
+    #
+    # Spawn! returns a clone to continue processing without mucking self
+    #
+    def spawn(operator="AND")
+      scope = clone
+      scope.scopes = scopes.clone
+      scope.scope!(operator)
+      scope
+    end
+
+    #
+    # Spawn a new scopes
+    #
+
+    def where(args={})
+      scope = spawn("AND")
+      scope.where!(args) if args
+    end
+
+    def not(args={})
+      scope = spawn("NOT")
+      scope.not!(args)
+    end
+
+    def and(args={})
+      scope = spawn("AND")
+      scope.and!(args)
+    end
+
+    def or(args={})
+      scope = spawn("OR")
+      scope.or!(args)
+    end
+
+    #
+    # Search related methods
+    #
+    def encode
+      URI.escape(to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+
+    def search(&block)
+      begin
+        if Kernel.block_given?
+          Chef::Search::Query.new.search(index, encode, &block)
+        else 
+          results = Array.new
+          search { |result| results << result }
+          results
+        end
+      rescue Net::HTTPServerException => e
+        error = Chef::JSONCompat.from_json(e.response.body)["error"].first
+        Chef::Log.error("Search failed with : #{error}")
+
+        if @ignore_failure
+        then Array.new
+        else raise Net::HTTPServerException
+        end
+      end
+    end
+
+    def partial(keys, &block)
+      keys = Hash[keys.map { |k,v| [k,Array(v)] }]
+
+      begin
+        if Kernel.block_given?
+          Chef::PartialSearc.new.search(index, encode, keys:keys, &block)
+        else
+          results = Array.new
+          partial(keys) { |result| results << result }
+          results
+        end
+      rescue Net::HTTPServerException => e
+        error = Chef::JSONCompat.from_json(e.response.body)["error"].first
+        Chef::Log.error("Search failed with : #{error}")
+
+        if @ignore_failure
+        then Array.new
+        else raise Net::HTTPServerException
+        end
+      end
+    end
+
+    def each(&block)
+      search(&block)
+    end
+  end
+end
+

data/lib/query_syntax/scope.rb

@@ -0,0 +1,18 @@
+
+module QuerySyntax
+  #
+  # Scopes are conditions seperated by operators (NOT | AND | OR)
+  #
+
+  class Scope
+    def initialize(operator="AND")
+      @operator = operator
+    end
+
+    attr_accessor :operator
+  end
+end
+
+require 'query_syntax/scope/criteria'
+require 'query_syntax/scope/nested'
+

data/lib/query_syntax/scope/criteria.rb

@@ -0,0 +1,47 @@
+
+require 'forwardable'
+require 'query_syntax/scope'
+
+module QuerySyntax
+  #
+  # Criteria Scopes are scopes containing key:value conditions
+  # ex.: where!(a:0, b:1).where!(a:2) becomes (a=0 OR a=2) AND b=1
+  #
+
+  class CriteriaScope < Scope
+    extend Forwardable
+
+    def initialize(operator, conditions={})
+      super operator
+      @conditions = conditions
+      where!(conditions)
+    end
+
+    attr_accessor :conditions
+
+    def_delegators(:@conditions, 
+      *(Hash.instance_methods - Object.instance_methods))
+
+    def where!(args={})
+      args.each do |k,v|
+        next if v.nil?
+        @conditions[k] = [] unless conditions.key?(k)
+        @conditions[k].concat(Array(v)).uniq!
+      end
+      self
+    end
+
+    #
+    # Collapse all conditions to a string
+    #
+    def to_s
+      value = @conditions.map do |key,values|
+        query = values.map { |value| "#{key}:#{value}" }.join(" OR ")
+        values.count > 1 ? "(#{query})" : query
+      end.join(" AND ")
+
+      conditions.count > 1 ? "(#{value})" : value
+    end
+  end
+end
+

data/lib/query_syntax/scope/nested.rb

@@ -0,0 +1,122 @@
+
+require 'forwardable'
+require 'query_syntax/scope'
+require 'query_syntax/scope/criteria'
+
+module QuerySyntax
+  #
+  # Nested Scopes are scopes used for nesting other related scopes within ()
+  #
+
+  class NestedScope < Scope
+    extend Forwardable
+    
+    def initialize(operator, *scopes)
+      super operator
+      @scopes = scopes
+    end
+
+    attr_accessor :scopes
+    
+    #
+    # Return a new CriteriaScope which is added to previous scopes
+    #
+    def scope!(operator)
+      scope = CriteriaScope.new(operator)
+      scopes << scope
+      self
+    end
+
+    def nest!(operator)
+      @scopes = [NestedScope.new(operator, *scopes)]
+      self
+    end
+
+    def not!(args={})
+      if args.empty? then nest!("NOT")
+      else scope!("NOT").where!(args)
+      end
+      self
+    end
+
+    def and!(args={})
+      if args.empty? then nest!("AND")
+      else scope!("AND").where!(args)
+      end
+      self
+    end
+
+    def or!(args={})
+      if args.empty? then nest!("OR")
+      else scope!("OR").where!(args)
+      end
+      self
+    end
+
+    #
+    # Return the last scope so that we can continue adding to it
+    #
+    def scope
+      scope!(operator)  if @scopes.empty?
+      scope!("AND")     if @scopes.last.is_a?(NestedScope)
+      @scopes.last
+    end
+
+    #
+    # Return the last scope's criteria
+    #
+    def conditions
+      scope.conditions
+    end
+
+    #
+    # Add criteria to the last scope
+    #
+    def where!(args={})
+      scope.where!(args)
+      self
+    end
+
+    #
+    # Convenience
+    #
+
+    def empty?
+      compact.empty?
+    end
+
+    def compact
+      scopes.reject { |scope| scope.empty? }
+    end
+
+    def compact!
+      scopes = compact
+      self
+    end
+
+    def push(other)
+      @scopes << other
+      scope!(operator)
+      self
+    end
+
+    #
+    # Collapse all scopes to a string
+    #
+    def to_s
+      values = compact.map do |scope|
+        value = scope.to_s
+        value = if scope.is_a?(NestedScope)
+                  scope.compact.count > 1 ? "(#{value})" : value
+                else value
+                end
+        [scope.operator, value]
+      end
+
+      values = values.flatten.compact
+      values.shift
+      values.join(" ")
+    end
+  end
+end
+

data/lib/query_syntax/version.rb

@@ -0,0 +1,5 @@
+
+module QuerySyntax
+  VERSION = "1.0.1"
+end
+

data/query_syntax.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'query_syntax/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "query_syntax"
+  spec.version       = QuerySyntax::VERSION
+  spec.authors       = ["Jonathan Serafini"]
+  spec.email         = ["jonathan@lightspeedretail.com"]
+  spec.summary       = "Provide chainable objects to build Chef search queries"
+  spec.description   = "Provides a mechanism to craft Chef queries through object chains such as .and.or.where(key:value)"
+  spec.homepage      = "https://github.com/JonathanSerafini/gem-query_syntax"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: query_syntax
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Jonathan Serafini
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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 a mechanism to craft Chef queries through object chains such
+  as .and.or.where(key:value)
+email:
+- jonathan@lightspeedretail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/chef/search.rb
+- lib/query_syntax.rb
+- lib/query_syntax/query.rb
+- lib/query_syntax/scope.rb
+- lib/query_syntax/scope/criteria.rb
+- lib/query_syntax/scope/nested.rb
+- lib/query_syntax/version.rb
+- query_syntax.gemspec
+homepage: https://github.com/JonathanSerafini/gem-query_syntax
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Provide chainable objects to build Chef search queries
+test_files: []