tagformula 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f6dd975b3faff6b1ecf509af6d3099c4a435043
+  data.tar.gz: a97caeec73a791266dbc8fe103dd0b4684ed2dc5
+SHA512:
+  metadata.gz: c47f0b580bf0961ea0703522b5e1024c6d1ab35ef0e3c36269f2edc808abbf965a55596a5cf8df521b41cb7c86ee88d2d892f43d24e03c6576c030d18a130ae5
+  data.tar.gz: 8c7ccd4638de10725bdd450595cd99bb79f643dc0cf6d15519022282ec0d2266231fb7a4394914dea6e7dce61d5de2d59e39ea97b68b8106f70a09b2c1419674

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 tagformula.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,25 @@
+Copyright (c) 2014 Geoff Youngs
+
+
+
+
+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,60 @@
+# Tagformula::Parser
+
+Match tag formulas with simple boolean operations against lists of strings.  e.g. the formula "foo & ! bar" would match ['foo'], but not ['foo', 'bar'] 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tagformula'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tagformula
+
+## Usage
+
+Tagformula::Parser matches arrays of strings against formulas which require the presence or absence of strings in the array.  Conditions can be nested (in brackets), or negated (with a !) and can be 'and' ('&') or 'or' ('|') conditions.
+
+
+    require 'tagformula/parser'
+
+    formula = Tagformula::Parser.parse("alpha & beta")
+
+    formula.matches?(%w[alpha beta])  # => true
+    formula.matches?(%w[alpha gamma]) # => false
+
+    formula = Tagformula::Parser.parse("alpha & (beta | gamma)")
+
+    formula.matches?(%w[alpha beta])  # => true
+    formula.matches?(%w[alpha gamma]) # => true
+
+    formula = Tagformula::Parser.parse("alpha & !beta")
+
+    formula.matches?(%w[alpha beta])  # => false
+    formula.matches?(%w[alpha gamma]) # => true
+
+Operators:
+
+expr & expr   requires both expressions to be present
+expr | expr   requires either expression to be present
+expr1 & ! expr2 requires the expr1 to be present and expr2 to be absent.
+
+Special words: 
+
+"true" and "yes" will always match as true.   
+
+"false" and "no" will always match as false.
+
+
+## Contributing
+
+1. Fork it ( http://github.com/geoffyoungs/tagformula/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 new Pull Request

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/tagformula.rb

@@ -0,0 +1,5 @@
+require "tagformula/version"
+
+module Tagformula
+  # Your code goes here...
+end

data/lib/tagformula/parser.rb

@@ -0,0 +1,138 @@
+require 'tagformula'
+require 'strscan'
+
+module Tagformula::Parser
+	class Group
+		def initialize()
+			@contents = []
+		end
+		def empty?
+			@contents.empty?
+		end
+		def last_entry
+			@contents.last
+		end
+		def push_condition(what)
+			if [:and,:or].include?(what) && (! @contents.last.is_a?(Symbol))
+				@contents << what
+			end
+		end
+		def push_entry(entry)
+			case entry
+			when Tag, Group
+				@contents << entry
+			end
+		end
+		def required_tags
+			@contents.map do |content|
+				if content.is_a?(Tag) && content.needed
+					content.tagname
+				elsif content.is_a?(Group)
+					content.required_tags
+				else
+					nil
+				end
+			end.flatten.compact
+		end
+		def matches?(taglist)
+			condition, op, i = nil, nil, 0
+			while @contents[i]
+				case @contents[i]
+				when Symbol
+					op = @contents[i]
+				when Group, Tag
+					res = @contents[i].matches?(taglist)
+					raise "Epic fail - res is neither true nor false" unless [true,false].include?(res)
+					case op
+					when :and
+						condition &&= res
+					when :or
+						condition ||= res
+					when nil
+						if i.zero?
+							condition = res
+						else
+							raise "Epic fail - apparently no operator between tags.  How does this even happen?"
+						end
+					end
+				else
+					raise "Epic fail - invalid group entry" # epic fail
+				end
+				i += 1
+			end
+			condition
+		end
+	end
+	class Tag
+		attr_reader :tagname, :needed
+		def initialize(tagname, needed)
+			@tagname, @needed = tagname, needed
+		end
+		def matches?(taglist)
+			case @tagname
+			when 'true', 'false', 'yes', 'no'
+				@needed
+			else
+				taglist.include?(@tagname) ? @needed : ! @needed
+			end	
+		end
+	end
+	module_function
+	def parse(str)
+		groups = [Group.new]
+		scanner = StringScanner.new(str)
+		until scanner.eos?
+		last = groups.last.last_entry
+
+		if scanner.scan(/\(/)
+			raise SyntaxError, "Unexpected tag at #{scanner.pos} - #{scanner.peek(scanner.rest_size)}" unless last.nil? or last.is_a?(Symbol)
+			push_group(groups)
+		elsif scanner.scan(/\)/)
+			raise SyntaxError, "Unexpected group end at #{scanner.pos} - #{scanner.peek(scanner.rest_size)}" if last.nil? or last.is_a?(Symbol)
+			grp = pop_group(groups)
+			raise SyntaxError, "Empty group at offset #{scanner.pos} - #{scanner.peek(scanner.rest_size)}" if grp.empty?
+			raise SyntaxError, "Unmatched braces at offset #{scanner.pos} - #{scanner.peek(scanner.rest_size)}" if groups.empty?
+		elsif scanner.scan(/([-0-9a-zA-Z.]+)/)
+			raise SyntaxError, "Unexpected tag at #{scanner.pos} - #{scanner.peek(scanner.rest_size)}" unless last.nil? or last.is_a?(Symbol)
+			push_tag(groups, scanner[1])
+		elsif scanner.scan(/[!~]\s*([-0-9a-zA-Z.]+)/)
+			raise SyntaxError, "Unexpected tag at #{scanner.pos} - #{scanner.peek(scanner.rest_size)}" unless last.nil? or last.is_a?(Symbol)
+			push_not_tag(groups, scanner[1])
+		elsif scanner.scan(/[,|]/)
+			raise SyntaxError, "Unexpected operator at #{scanner.pos} - #{scanner.peek(scanner.rest_size)}" if last.is_a?(Symbol)
+			push_or(groups)
+		elsif scanner.scan(/[&+]/)
+			raise SyntaxError, "Unexpected operator at #{scanner.pos} - #{scanner.peek(scanner.rest_size)}" if last.is_a?(Symbol)
+			push_and(groups)
+    elsif scanner.scan(/\s+/)
+		else
+			raise SyntaxError, "Error at offset #{scanner.pos} - #{scanner.peek(scanner.rest_size)}"
+		end
+		end
+		raise SyntaxError, "Unmatched braces at offset #{scanner.pos} - #{scanner.peek(scanner.rest_size)}" if groups.size != 1
+		groups[0]
+	end
+	class << self
+	private
+	def push_group(groups)
+		group = Group.new
+		groups.last.push_entry(group)
+		groups.push(group)
+	end
+	def pop_group(groups)
+		groups.pop()
+	end
+	def push_tag groups, tag
+		groups.last.push_entry(Tag.new(tag, true))
+	end
+	def push_not_tag groups, tag
+		groups.last.push_entry(Tag.new(tag, false))
+	end
+	def push_or groups
+		groups.last.push_condition(:or)
+	end
+	def push_and groups
+		groups.last.push_condition(:and)
+	end
+	end
+end

data/lib/tagformula/version.rb

@@ -0,0 +1,3 @@
+module Tagformula
+  VERSION = "0.0.1"
+end

data/spec/formula_spec.rb

@@ -0,0 +1,39 @@
+$: << File.dirname(__FILE__)+'/../lib'
+require 'tagformula/parser'
+
+describe Tagformula::Parser do
+  describe '#parse' do
+
+    it "parses simple formulas" do
+      formula = Tagformula::Parser.parse("alpha & beta")
+      expect(formula.required_tags).to include('alpha', 'beta')
+      expect(formula.required_tags).not_to include('gamma')
+      expect(formula.matches?(['alpha'])).to be_false
+      expect(formula.matches?(['alpha', 'beta'])).to be_true
+    end
+
+    it "parses more negated tag formulas" do
+      formula = Tagformula::Parser.parse("alpha & ! beta")
+      expect(formula.required_tags).to include('alpha')
+      expect(formula.required_tags).not_to include('beta')
+      expect(formula.matches?(['alpha', 'beta'])).to be_false
+      expect(formula.matches?(['alpha'])).to be_true
+    end
+
+    it "fails on invalid formulas" do
+      # Unclosed bracket
+      expect { Tagformula::Parser.parse("(alpha & beta")  }.to raise_error
+      # Missing operator
+      expect { Tagformula::Parser.parse("alpha & beta gamma")  }.to raise_error
+      # Empty group
+      expect { Tagformula::Parser.parse("() & alpha & beta")  }.to raise_error
+    end
+
+    it "parses tags with periods" do
+      formula = Tagformula::Parser.parse("alpha.beta | gamma.delta")
+      expect(formula.required_tags).to include('alpha.beta')
+      expect(formula.matches?(['alpha.beta'])).to be_true
+      expect(formula.matches?(['epsilon'])).to be_false
+    end
+  end
+end

data/tagformula.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tagformula/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tagformula"
+  spec.version       = Tagformula::VERSION
+  spec.authors       = ["Geoff Youngs\n\n\n"]
+  spec.email         = ["git@intersect-uk.co.uk"]
+  spec.summary       = %q{Simple formula parser & matcher}
+  spec.description   = %q{Match tag formulas with simple boolean operations against lists of strings.  e.g. the formula "foo & ! bar" would match ['foo'], but not ['foo', 'bar'] }
+  spec.homepage      = "http://github.com/geoffyoungs/tagformula-parser"
+  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.5"
+  spec.add_development_dependency "rake", '~> 10.1'
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: tagformula
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- |+
+  Geoff Youngs
+
+
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: 'Match tag formulas with simple boolean operations against lists of strings.  e.g.
+  the formula "foo & ! bar" would match [''foo''], but not [''foo'', ''bar''] '
+email:
+- git@intersect-uk.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tagformula.rb
+- lib/tagformula/parser.rb
+- lib/tagformula/version.rb
+- spec/formula_spec.rb
+- tagformula.gemspec
+homepage: http://github.com/geoffyoungs/tagformula-parser
+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.1
+signing_key: 
+specification_version: 4
+summary: Simple formula parser & matcher
+test_files:
+- spec/formula_spec.rb