simple_logic 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6509f93fc93262c3a09463d3f0174a5608c1016
+  data.tar.gz: 5e5cd5ded451b4a9d5bb0416ab9925747fd1a3cb
+SHA512:
+  metadata.gz: 3d71ad530e7da3f544fdc4643f2ef0d95ec319431976bebbf00ddd0883b411c4b06d0fa21fdf77cea5cc346a94c22cff7b26f731a280919b373b0056af3e1728
+  data.tar.gz: 7c5739d0001d4c00c604621d7579bd13bca266723545efb3a2b04bd4268ec252c5a0d9e0b732d4786ce656d49c8e643651f7190165e00fe1b51b4e7f6758cd5c

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/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - jruby
+  - 2.0.0
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - pete@schwamb.net
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Pete Schwamb
+
+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,34 @@
+# SimpleLogic
+
+A ruby gem that parses and evaluates simple boolean statements specified as a string.  Useful for evaluating user supplied input in your application without using ruby's eval().
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_logic'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_logic
+
+## Usage
+
+```ruby
+context = { hungry: true, fridge_empty: true, restaurant_nearby: true}
+in_luck = SimpleLogic.eval("hungry && !fridge_empty || restaurant_nearby", context)
+# => true
+```
+
+
+## Contributing
+
+1. Fork it
+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,10 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/lib/simple_logic/errors.rb

@@ -0,0 +1,16 @@
+module SimpleLogic
+  class ParseError < StandardError
+    attr_reader :offset
+    def initialize(offset)
+      @offset = offset
+    end
+  end
+
+  class UndefinedVariableError < StandardError
+    attr_reader :offset
+    def initialize(offset)
+      @offset = offset
+    end
+  end
+
+end

data/lib/simple_logic/parser.rb

@@ -0,0 +1,23 @@
+require 'treetop'
+
+module SimpleLogic
+
+  class Parser
+    base_path = File.expand_path(File.dirname(__FILE__))
+    Treetop.load(File.join(base_path, 'simple_logic'))
+    @@parser = SimpleLogicParser.new
+
+    def self.parse(data)
+      # Pass the data over to the parser instance
+      tree = @@parser.parse(data)
+
+      # If the AST is nil then there was an error during parsing
+      # we need to report a simple error message to help the user
+      if(tree.nil?)
+       raise ParseError.new(@@parser.index), "Parse error at offset: #{@@parser.index}"
+      end
+
+      return tree
+    end
+  end
+end

data/lib/simple_logic/precedence_table.rb

@@ -0,0 +1,50 @@
+module SimpleLogic
+  module PrecedenceTable
+    class Operator
+      attr_accessor :precedence, :associativity, :symbol
+      def initialize(precedence, associativity, symbol)
+        @precedence = precedence
+        @associativity = associativity
+        @symbol = symbol
+      end
+
+      def left_associative?
+        @associativity == :left
+      end
+
+      def apply(l, r)
+        if @symbol == "&&"
+          l && r
+        elsif @symbol == "||"
+          l || r
+        else
+          raise "Invalid operator: #{@symbol}"
+        end
+      end
+
+    end
+
+    def self.lookup(operator)
+      @operators[operator]
+    end
+
+    def self.op(associativity, *operators)
+      @precedence ||= 0
+      @operators ||= {}
+      operators.each do |operator|
+        @operators[operator] = Operator.new(@precedence, associativity, operator)
+      end
+      @precedence += 1
+    end
+
+    # operator precedence, low to high
+    op :left, '||'
+    op :left, '&&'
+    op :none, '==', '!='
+    op :left, '<', '<=', '>', '>='
+    op :left, '+', '-'
+    op :left, '*', '/'
+    op :right, '^'
+  end
+end
+

data/lib/simple_logic/simple_logic.treetop

@@ -0,0 +1,30 @@
+grammar SimpleLogic
+  rule expression
+    infix_operation / primary
+  end
+
+  rule infix_operation
+    lhs:infix_operation_chain rhs:primary <InfixOperation>
+  end
+
+  rule infix_operation_chain
+    (primary space operator space)+ <InfixOperationChain>
+  end
+
+  rule space
+    " "*
+  end
+
+  rule operator
+    "&&" / "||"
+  end
+
+  rule primary
+    variable / "!" primary <NegationOperator> / '(' expression ')'
+  end
+
+  rule variable
+    name:[\w]+ <Variable>
+  end
+  
+end

data/lib/simple_logic/syntax_nodes.rb

@@ -0,0 +1,77 @@
+module SimpleLogic
+  class Expression < Treetop::Runtime::SyntaxNode    
+  end
+
+  class InfixOperation < Treetop::Runtime::SyntaxNode    
+    def eval(context)
+      rpn(shunting_yard(values_and_operators(context)))
+    end
+
+    def list
+      lhs.list + [rhs]
+    end
+
+    def values_and_operators(context)
+      list.map do |node|
+        if node.instance_of?(Treetop::Runtime::SyntaxNode)
+          PrecedenceTable.lookup(node.text_value)
+        else
+          node.eval(context)
+        end
+      end
+    end
+
+    def shunting_yard(input)
+      [].tap do |rpn|
+        operator_stack = []
+        input.each do |object|
+          if object.instance_of?(PrecedenceTable::Operator)
+            op1 = object
+            rpn << operator_stack.pop while (op2 = operator_stack.last) && (op1.left_associative? ? op1.precedence <= op2.precedence : op1.precedence < op2.precedence)
+            operator_stack << op1
+          else
+            rpn << object
+          end
+        end
+        rpn << operator_stack.pop until operator_stack.empty?
+      end
+    end
+
+    def rpn(input)
+      results = []
+      input.each do |object|
+        if object.instance_of?(PrecedenceTable::Operator)
+          r, l = results.pop, results.pop
+          results << object.apply(l, r)
+        else
+          results << object
+        end
+      end
+      results.first
+    end  
+  end
+
+  class InfixOperationChain < Treetop::Runtime::SyntaxNode    
+    def list
+      elements.map {|e| [e.primary, e.operator] }.flatten
+    end
+  end
+
+  class Variable < Treetop::Runtime::SyntaxNode
+    def eval(context)
+      key = text_value.to_sym
+      if context.include?(key)
+        context[key]
+      else
+        raise UndefinedVariableError, "Undefined variable: \"#{text_value}\""
+      end
+    end
+  end
+
+  class NegationOperator < Treetop::Runtime::SyntaxNode
+    def eval(context)
+      ! elements[1].eval(context)
+    end
+  end
+end
+

data/lib/simple_logic/version.rb

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

data/lib/simple_logic.rb

@@ -0,0 +1,14 @@
+require "simple_logic/errors"
+require "simple_logic/parser"
+require "simple_logic/precedence_table"
+require "simple_logic/version"
+require "simple_logic/syntax_nodes"
+require 'treetop'
+
+module SimpleLogic
+
+  def self.eval(data, context)
+    Parser.parse(data).eval(context)
+  end
+
+end

data/simple_logic.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_logic/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "simple_logic"
+  spec.version       = SimpleLogic::VERSION
+  spec.authors       = ["Pete Schwamb"]
+  spec.email         = ["pete@schwamb.net"]
+  spec.description   = %q{Boolean logic parsing and evaluation engine}
+  spec.summary       = %q{A ruby gem that parses and evaluates simple boolean statements specified as a string.}
+  spec.homepage      = ""
+  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.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-nc"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+
+  spec.add_dependency("treetop")
+end

data/spec/simple_logic_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe SimpleLogic do
+  it "should evaluate single variable" do
+    context = { hungry: true }
+    expression = "hungry" 
+    in_luck = SimpleLogic.eval(expression, context)
+    expect(in_luck).to eq true
+  end
+
+  it "should evaluate negated variable" do
+    context = { hungry: true }
+    expression = "!hungry" 
+    in_luck = SimpleLogic.eval(expression, context)
+    expect(in_luck).to eq false
+  end
+
+  it "should evaluate logical and" do
+    context = { hungry: true, fridge_empty: false}
+    expression = "hungry && fridge_empty" 
+    in_luck = SimpleLogic.eval(expression, context)
+    expect(in_luck).to eq false
+  end
+
+  it "should evaluate logical or" do
+    context = { hungry: true, fridge_empty: false}
+    expression = "hungry || fridge_empty" 
+    in_luck = SimpleLogic.eval(expression, context)
+    expect(in_luck).to eq true
+  end
+
+  it "should evaluate chained logic statements" do
+    context = { hungry: true, fridge_empty: true, restaurant_nearby: true}
+    expression = "hungry && !fridge_empty || restaurant_nearby" 
+    in_luck = SimpleLogic.eval(expression, context)
+    expect(in_luck).to eq true
+  end
+
+  it "should raise an exception on a syntax error" do
+    expect { SimpleLogic.eval("> hungry", {}) }.to raise_error {|e|
+      expect(e.offset).to eq 0
+    }
+  end
+
+  it "should raise an exception on a syntax error and indicate location of parse error" do
+    expect { 
+      SimpleLogic.eval("testing > hungry", {testing: true}) 
+    }.to raise_error(SimpleLogic::ParseError) {|e|
+      expect(e.offset).to eq 7
+    }
+  end
+
+  it "should raise an exception on undefined variable" do
+    expect { 
+      SimpleLogic.eval("testing && hungry", {testing: true}) 
+    }.to raise_error(SimpleLogic::UndefinedVariableError)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'simple_logic'

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: simple_logic
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pete Schwamb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-nc
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Boolean logic parsing and evaluation engine
+email:
+- pete@schwamb.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/simple_logic.rb
+- lib/simple_logic/errors.rb
+- lib/simple_logic/parser.rb
+- lib/simple_logic/precedence_table.rb
+- lib/simple_logic/simple_logic.treetop
+- lib/simple_logic/syntax_nodes.rb
+- lib/simple_logic/version.rb
+- simple_logic.gemspec
+- spec/simple_logic_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: A ruby gem that parses and evaluates simple boolean statements specified
+  as a string.
+test_files:
+- spec/simple_logic_spec.rb
+- spec/spec_helper.rb