lunokhod 0.0.1.pre

data/lib/lunokhod/rule_parsing.rb

@@ -0,0 +1,41 @@
+require 'lunokhod/rule_parser'
+require 'set'
+
+module Lunokhod
+  # Rules are chains of condition tags joined by ANDs and ORs.
+  # Parentheses may be used to modify precedence.
+  #
+  # Examples:
+  #
+  # A
+  # A or B
+  # A and (B or C)
+  # A and (B or (C and D))
+  #
+  # Surveyor actually uses eval (!) to evaluate dependencies.  This means that
+  # Surveyor's dependency language inherits its precedence rules from Ruby.
+  module RuleParsing
+    attr_reader :parsed_rule
+
+    def parse_rule
+      parser = RuleParser.new(rule)
+      parser.parse
+      @parsed_rule = parser.ast
+    end
+
+    def referenced_conditions
+      Set.new.tap do |cs|
+        visit_rule { |n| cs << n.name if n.respond_to?(:name) }
+      end
+    end
+
+    def visit_rule(rule = parsed_rule, &block)
+      yield rule
+
+      if rule.respond_to?(:conj)
+        visit_rule(rule.left, &block)
+        visit_rule(rule.right, &block)
+      end
+    end
+  end
+end

data/lib/lunokhod/verifier.rb

@@ -0,0 +1,155 @@
+require 'lunokhod/ast'
+require 'lunokhod/visitation'
+
+module Lunokhod
+  class Verifier
+    include Ast
+    include Visitation
+
+    attr_reader :atag_count
+    attr_reader :atag_expectations
+    attr_reader :by_qref
+    attr_reader :ctag_count
+    attr_reader :qtag_count
+    attr_reader :qtag_expectations
+    attr_reader :survey
+
+    def initialize(survey)
+      @atag_count = Hash.new(0)
+      @atag_expectations = Hash.new(0)
+      @by_qref = {}
+      @ctag_count = Hash.new(0)
+      @qtag_count = Hash.new(0)
+      @qtag_expectations = Hash.new(0)
+      @survey = survey
+    end
+
+    def run(&block)
+      visit(survey, true) do |n, level, prev, boundary|
+        case n
+        when Condition; inspect_condition(n)
+        when Dependency, Validation; inspect_conditional(n)
+        when Question; inspect_question(n)
+        end
+      end
+
+      run_checks(&block)
+    end
+
+    # When we see a question:
+    #
+    # 1. If the question has a non-empty tag, index the question by its tag.
+    # 2. Register references to it and all of its answers.
+    def inspect_question(q)
+      index_question(q) unless q.tag.empty?
+      ref_question(q)
+      q.answers.each { |a| ref_answer(q, a) }
+    end
+
+    # There are three references in conditions that we have to worry about:
+    #
+    # - the question ref, if one exists
+    # - the answer ref, if one exists
+    # - the condition tag
+    #
+    # Seeing a condition registers a reference to the condition and
+    # expectations for the qref and aref if those refs exist.
+    def inspect_condition(c)
+      pc = c.parsed_condition
+
+      ctag_count[[c.parent, c.tag]] += 1
+
+      pending_question(pc.qtag, c) if pc.qtag
+      pending_answer(pc.qtag, pc.atag, c) if pc.qtag && pc.atag
+    end
+
+    # When we see a dependency or validation, register references to all of its
+    # conditions.
+    def inspect_conditional(c)
+      c.referenced_conditions.each do |tag|
+        key = [c, tag]
+
+        unless ctag_count.has_key?(key)
+          ctag_count[key] = 0
+        end
+      end
+    end
+
+    # Find all unsatisfied expectations.
+    def run_checks
+      bad_refs(qtag_count) do |qt|
+        yield Error.new(survey, Question, :bad_ref, qt, qtag_expectations[qt])
+      end
+
+      bad_refs(atag_count) do |qt, at|
+        yield Error.new(survey, Answer, :bad_ref, at, atag_expectations[[qt, at]])
+      end
+
+      bad_refs(ctag_count) do |c, tag|
+        yield Error.new(survey, Condition, :bad_ref, tag, c)
+      end
+
+      by_qref.select { |k, v| v.length > 1 }.each do |k, vs|
+        yield Error.new(survey, Question, :duplicate_qref, k, vs)
+      end
+    end
+
+    def bad_refs(refs)
+      refs.each { |k, c| yield k if c < 1 }
+    end
+
+    def index_question(q)
+      key = q.tag
+
+      by_qref[key] = [] unless by_qref.has_key?(key)
+      by_qref[key] << q
+    end
+
+    def ref_question(q)
+      qtag_count[q.tag.to_s] += 1
+    end
+
+    def ref_answer(q, a)
+      atag_count[[q.tag.to_s, a.tag.to_s]] += 1
+    end
+
+    def pending_question(qtag, from)
+      qtag_expectations[qtag] = from
+
+      unless qtag_count.has_key?(qtag)
+        qtag_count[qtag] = 0
+      end
+    end
+
+    def pending_answer(qtag, atag, from)
+      key = [qtag, atag]
+      atag_expectations[key] = from
+
+      unless atag_count.has_key?(key)
+        atag_count[key] = 0
+      end
+    end
+
+    class Error < Struct.new(:survey, :node_type, :error_type, :key, :at_fault)
+      def bad_question_tag?
+        bad_tag? && node_type == Ast::Question
+      end
+
+      def bad_answer_tag?
+        bad_tag? && node_type == Ast::Answer
+      end
+
+      def bad_condition?
+        bad_tag? && node_type == Ast::Condition
+      end
+
+      def duplicate_question?
+        error_type == :duplicate_qref
+      end
+
+      def bad_tag?
+        error_type == :bad_ref
+      end
+    end
+  end
+end

data/lib/lunokhod/version.rb

@@ -0,0 +1,3 @@
+module Lunokhod
+  VERSION = '0.0.1.pre'
+end

data/lib/lunokhod/visitation.rb

@@ -0,0 +1,12 @@
+module Lunokhod
+  module Visitation
+    def visit(root, only_enter = false, level = 0, prev = nil, &block)
+      yield root, level, prev, :enter
+      root.children.each { |c| visit(c, only_enter, level + 1, root, &block) }
+
+      unless only_enter
+        yield root, level, prev, :exit
+      end
+    end
+  end
+end

data/lunokhod.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lunokhod/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lunokhod"
+  spec.version       = Lunokhod::VERSION
+  spec.authors       = ["David Yip"]
+  spec.email         = ["yipdw@northwestern.edu"]
+  spec.description   = %q{Parsing and compilation tools for Surveyor surveys}
+  spec.summary       = %q{Parsing and compilation tools for Surveyor surveys}
+  spec.homepage      = "https://github.com/NUBIC/lunokhod"
+  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_dependency 'case'
+  spec.add_dependency 'uuidtools'
+
+  spec.add_development_dependency "bundler", "~> 1.2"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'kpeg'
+  spec.add_development_dependency 'rspec'
+end

data/spec/lunokhod/error_report_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+module Lunokhod
+  describe ErrorReport do
+    let(:ep) { ErrorReport.new(surveys) }
+    let(:surveys) { p = Parser.new(data); p.parse; p.surveys }
+
+    describe '#run' do
+      let(:data) do
+        %q{survey "foo" do
+            section "bar" do
+              q_1 "a question"
+              a_1 "an answer"
+              dependency :rule => "A or B"
+              condition_A :q_oops, '==', :a_1
+              q_1 "duplicate"
+              a_1 "yep"
+            end
+          end
+
+          survey "bar" do
+            section "baz" do
+              q_1 "a question"
+              a_1 "an answer"
+              dependency :rule => "A"
+              condition_A :q_1, '==', :a_oops
+            end
+          end}
+      end
+
+      before do
+        ep.run
+      end
+
+      def errors_for(sname)
+        ep.errors.select { |e| e.survey.name == sname }
+      end
+
+      describe 'for each survey' do
+        it 'finds unknown question references' do
+          errors_for('foo').select(&:bad_question_tag?).length.should == 1
+          errors_for('bar').select(&:bad_question_tag?).length.should == 0
+        end
+
+        it 'finds unknown answer references' do
+          errors_for('foo').select(&:bad_answer_tag?).length.should == 1
+          errors_for('bar').select(&:bad_answer_tag?).length.should == 1
+        end
+
+        it 'finds unknown condition references' do
+          errors_for('foo').select(&:bad_condition?).length.should == 1
+          errors_for('bar').select(&:bad_condition?).length.should == 0
+        end
+
+        it 'finds duplicate question references' do
+          errors_for('foo').select(&:duplicate_question?).length.should == 1
+          errors_for('bar').select(&:duplicate_question?).length.should == 0
+        end
+      end
+    end
+  end
+end

data/spec/lunokhod/parser_spec.rb

@@ -0,0 +1,87 @@
+require 'spec_helper'
+
+module Lunokhod
+  describe Parser do
+    let(:parser) { Parser.new(data, 'fake') }
+    let(:ast) { parser.surveys.first }
+
+    describe 'for repeaters' do
+      let(:data) do
+        %q{
+          survey "fake" do
+            section "one" do
+              q_a "Eh?"
+              a_y "Yes"
+
+              repeater "I'm going to ask you a bunch of questions" do
+                dependency :rule => "A"
+                condition_A :q_a, "==", :a_y
+
+                q "Who is your daddy, and what does he do?"
+                a :string
+              end
+            end
+          end
+        }
+      end
+
+      before do
+        parser.parse
+      end
+
+      let(:repeater) { ast.sections[0].questions[1] }
+
+      it 'associates repeater dependencies with the repeater' do
+        repeater.dependencies.length.should == 1
+      end
+    end
+
+    describe 'for answers' do
+      let(:data) do
+        %q{
+          survey "fake" do
+            section "one" do
+              q_a "A question"
+              a "An answer", :string
+              a "An answer with options", :help_text => "Yep"
+              a "An answer with everything", :string, :help_text => "Yep"
+              a :string
+              a :other, :string
+            end
+          end
+        }
+      end
+
+      before do
+        parser.parse
+      end
+
+      let(:answers) { ast.sections[0].questions[0].answers }
+
+      it 'parses answer response class' do
+        answers[0].type.should == :string
+        answers[0].options.should be_empty
+      end
+
+      it 'parses options on answers' do
+        answers[1].options.should == { :help_text => 'Yep' }
+      end
+
+      it 'parses answers with options and response class' do
+        answers[2].type.should == :string
+        answers[2].options.should == { :help_text => 'Yep' }
+      end
+
+      it 'parses answers with a response class but no text' do
+        answers[3].type.should == :string
+        answers[3].options.should be_empty
+      end
+
+      it 'parses the "other" answer type with a response class' do
+        answers[4].should be_other
+        answers[4].type.should == :string
+        answers[4].options.should be_empty
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'lunokhod'
+
+RSpec.configure do |c|
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: lunokhod
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+  prerelease: 6
+platform: ruby
+authors:
+- David Yip
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: case
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: kpeg
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Parsing and compilation tools for Surveyor surveys
+email:
+- yipdw@northwestern.edu
+executables:
+- lunokhod-driver
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .gitmodules
+- .travis.yml
+- CHANGELOG
+- Gemfile
+- LICENSE
+- README
+- Rakefile
+- TODO
+- bin/lunokhod-driver
+- kitchen_sink_survey.rb
+- lib/lunokhod.rb
+- lib/lunokhod/ast.rb
+- lib/lunokhod/backends/debug.rb
+- lib/lunokhod/backends/webpage.rb
+- lib/lunokhod/backends/webpage/evaluator.js
+- lib/lunokhod/backends/webpage/jquery.min.js
+- lib/lunokhod/backends/webpage/page.html.erb
+- lib/lunokhod/compiler.rb
+- lib/lunokhod/condition_parsing.rb
+- lib/lunokhod/error_report.rb
+- lib/lunokhod/parser.rb
+- lib/lunokhod/rule_parser.kpeg
+- lib/lunokhod/rule_parser.rb
+- lib/lunokhod/rule_parsing.rb
+- lib/lunokhod/verifier.rb
+- lib/lunokhod/version.rb
+- lib/lunokhod/visitation.rb
+- lunokhod.gemspec
+- spec/lunokhod/error_report_spec.rb
+- spec/lunokhod/parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/NUBIC/lunokhod
+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: '0'
+      segments:
+      - 0
+      hash: -1254807072621896079
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Parsing and compilation tools for Surveyor surveys
+test_files:
+- spec/lunokhod/error_report_spec.rb
+- spec/lunokhod/parser_spec.rb
+- spec/spec_helper.rb