teacher 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f045b662218cb1306c73ab4d6358a440638c9e0
+  data.tar.gz: 35ed5ad00b3fb5c687ef173f8367296f9130bd33
+SHA512:
+  metadata.gz: 932037dbbe7f05e2418cbb9ddc02501bfe71a938f74640a25f15b849bd22735832d09ec8837383b02c50ef8a3153fd678d4881631d9c0bb84e46e8c58b90c3c4
+  data.tar.gz: 8705924a2baec42b99aa039789486360ee7c4415b2a6c8de800d2605ea0589ebe88b07abba5b0f9571778cf25efc976a7ee97ccbd48527cc055c9f894e6efb45

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    teacher (0.0.1)
+      treetop (= 1.5.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    polyglot (0.3.4)
+    rake (10.3.1)
+    treetop (1.5.3)
+      polyglot (~> 0.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.5)
+  rake
+  teacher!

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Marcos Felipe Pimenta Rodrigues
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 mrodrigues
+
+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,62 @@
+# Grade Calculator
+Flexible language for defining grades calculations.
+
+## How to use
+Consider the following input:
+```
+# Assign values to variables
+e1=8
+e2=6
+e3=4
+t=6
+re=6
+
+# Publish these variables
+pub(e1)
+pub(e2)
+pub(e3)
+pub(t)
+pub(re)
+
+# Returns the smaller expression *in a symbolic way*
+smaller=min(e1,e2,e3)
+
+# Substitute the *variable* on the left by the right one
+# *ONLY* expressions that return identifiers should be 
+# used on the left side
+sub(smaller,re)
+
+# Calculate the final grade
+fg=(3*(2*e1+2*e2+3*e3)/7+t)/4
+pub(fg)
+```
+
+Interpreting the language:
+```
+require 'teacher'
+
+teacher = Teacher::Base.new
+
+teacher.run(File.read("example.teacher"))
+scope = teacher.scope
+
+scope.published_variables["e1"] # => 8.0
+scope.symbols["e1"] # => 8.0
+
+scope.published_variables["e2"] # => 6.0
+scope.symbols["e2"] # => 6.0
+
+scope.published_variables["e3"] # => 4.0
+scope.symbols["e3"] # => 4.0
+
+scope.published_variables["t"] # => 6.0
+scope.symbols["t"] # => 6.0
+
+scope.published_variables["re"] # => 6.0
+scope.symbols["re"] # => 6.0
+
+scope.symbols["smaller"] # => identificador "e3"
+
+scope.published_variables["fg"] # => 6.428571428571429
+scope.symbols["fg"] # => 6.428571428571429
+```

data/Rakefile

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

data/example.teacher

@@ -0,0 +1,18 @@
+e1=8
+e2=6
+e3=4
+t=6
+re=6
+
+pub(e1)
+pub(e2)
+pub(e3)
+pub(t)
+pub(re)
+
+smaller=min(e1,e2,e3)
+
+sub(smaller,re)
+
+fg=(3*(2*e1+2*e2+3*e3)/7+t)/4
+pub(fg)

data/grammar/teacher.treetop

@@ -0,0 +1,93 @@
+# Based on http://floris.briolas.nl/floris/2008/07/simple-calculator-with-antlr/comment-page-1/
+
+grammar Teacher
+  rule program
+    statement* <Program>
+  end
+
+  rule statement
+    (expression newline / assignment newline) <Statement> / newline
+  end
+
+  rule expression
+    function_call / additive
+  end
+
+  rule newline
+    "\r"? "\n" { def eval(scope); end }
+  end
+
+  rule assignment
+    identifier "=" expression <Assignment>
+  end
+
+  rule additive
+    operand_1:multitive operator:additive_operator operand_2:additive <BinaryOperation>
+    /
+    multitive
+  end
+
+  rule additive_operator
+    '+' {
+      def apply(a, b)
+        a + b
+      end
+    }
+    /
+    '-' {
+      def apply(a, b)
+        a - b
+      end
+    }
+  end
+
+  rule multitive
+    operand_1:atom operator:multitive_operator operand_2:multitive <BinaryOperation>
+    /
+    atom
+  end
+
+  rule multitive_operator
+    '*' {
+      def apply(a, b)
+        a * b
+      end
+    }
+    /
+    '/' {
+      def apply(a, b)
+        a / b
+      end
+    }
+  end
+
+  rule function_call
+    name:identifier "(" abc:list? ")" <FunctionCall>
+  end
+
+  rule list
+    (expression "," list+ <List>)
+    /
+    expression
+  end
+
+  rule group
+    "(" additive ")" <Group>
+  end
+
+  rule number
+    [0-9]+ <Number>
+  end
+
+  rule identifier
+    [a-zA-Z]+ [a-zA-Z_0-9]* <Identifier>
+  end
+
+  rule space
+    [ \t]* <Space>
+  end
+
+  rule atom
+    number / identifier / group
+  end
+end

data/lib/teacher.rb

@@ -0,0 +1,31 @@
+require 'teacher/version'
+
+require 'treetop'
+
+require 'teacher/scope'
+require 'teacher/function'
+require 'teacher/nodes'
+
+Treetop.load("grammar/teacher")
+
+module Teacher
+
+  class Base
+
+    attr_accessor :scope
+
+    def initialize
+      @parser = TeacherParser.new
+    end
+
+    def run(string)
+      @scope = TopLevel.new
+      @tree = parse(string)
+      @tree.eval(scope)
+    end
+
+    def parse(string)
+      @parser.parse(string)
+    end
+  end
+end

data/lib/teacher/function.rb

@@ -0,0 +1,26 @@
+module Teacher
+
+  class Function
+    def initialize(scope, &block)
+      @scope = scope
+      @body = block
+    end
+
+    def call(scope, args)
+      args.reject! { |a| a.text_value.blank? }
+      if args.to_a.any?
+        tmp = [args.first]
+        if args.length > 1
+          last = args.last.elements.first
+          if last.is_a?(List)
+            tmp += last.eval(self)
+          else
+            tmp << last
+          end
+        end
+        args = tmp
+      end
+      @body.call(*args)
+    end
+  end
+end

data/lib/teacher/nodes.rb

@@ -0,0 +1,70 @@
+module Teacher
+  class Program < Treetop::Runtime::SyntaxNode
+    def eval(scope)
+      elements.map { |e, i| e.eval(scope) }.last
+    end
+  end
+
+  module Number
+    def eval(scope); text_value.to_f; end
+  end
+
+  class Identifier < Treetop::Runtime::SyntaxNode
+    def eval(scope); scope[text_value]; end
+  end
+
+  module Statement
+    def eval(scope)
+      elements.first.eval(scope)
+    end
+  end
+
+  class Space < Treetop::Runtime::SyntaxNode
+    def eval(scope);  end
+  end
+
+  class BinaryOperation < Treetop::Runtime::SyntaxNode
+    def eval(scope)
+      operand_1 = elements.first
+      operand_2 = elements.last
+      loop do
+        operand_1 = operand_1.eval(scope)
+        break unless operand_1.is_a? Identifier
+      end
+      loop do
+        operand_2 = operand_2.eval(scope)
+        break unless operand_2.is_a? Identifier
+      end
+      operator.apply(operand_1, operand_2)
+    end
+  end
+
+  class List < Treetop::Runtime::SyntaxNode
+    def eval(scope)
+      last = elements.last.elements.first
+      last = last.eval(scope) if last.is_a?(List)
+      [elements.first, *last]
+    end
+  end
+
+  class FunctionCall < Treetop::Runtime::SyntaxNode
+    def eval(scope)
+      func = scope[name.text_value]
+      args = elements[2]
+      args = args.is_a?(List) ? args.elements : [args]
+      func.call(scope, args)
+    end
+  end
+
+  class Group < Treetop::Runtime::SyntaxNode
+    def eval(scope)
+      elements[1].eval(scope)
+    end
+  end
+
+  class Assignment < Treetop::Runtime::SyntaxNode
+    def eval(scope)
+      scope[elements.first.text_value] = elements.last.eval(scope)
+    end
+  end
+end

data/lib/teacher/scope.rb

@@ -0,0 +1,42 @@
+module Teacher
+  class Scope
+
+    attr_reader :published_variables, :symbols
+
+    def initialize(parent = nil)
+      @parent = parent || {}
+      @symbols = {}
+      @published_variables = {}
+    end
+
+    def [](name)
+      @symbols[name] || @parent[name]
+    end
+
+    def []=(name, value)
+      @symbols[name] = value
+    end
+  end
+
+  class TopLevel < Scope
+    def initialize(*args)
+      super
+
+      self["min"] = Function.new(self) do |*arguments|
+        arguments.min_by { |a| a.eval(self) }
+      end
+
+      self["sub"] = self["substitute"] = Function.new(self) do |target, origin|
+        loop do
+          target = target.eval(self)
+          break if target.is_a?(Identifier)
+        end
+        @symbols[target.text_value] = origin.eval(self)
+      end
+
+      self["pub"] = self["publish"] = Function.new(self) do |identifier|
+        @published_variables[identifier.text_value] = identifier.eval(self)
+      end
+    end
+  end
+end

data/lib/teacher/version.rb

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

data/teacher.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'teacher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "teacher"
+  spec.version       = Teacher::VERSION
+  spec.authors       = ["mrodrigues"]
+  spec.email         = ["mrodrigues.uff@gmail.com"]
+  spec.summary       = %q{Flexible language for defining grades calculations.}
+  spec.homepage      = "https://github.com/mrodrigues/teacher"
+  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"
+  spec.add_runtime_dependency "treetop", "1.5.3"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: teacher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- mrodrigues
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-01 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: '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: 1.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+description: 
+email:
+- mrodrigues.uff@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- example.teacher
+- grammar/teacher.treetop
+- lib/teacher.rb
+- lib/teacher/function.rb
+- lib/teacher/nodes.rb
+- lib/teacher/scope.rb
+- lib/teacher/version.rb
+- teacher.gemspec
+homepage: https://github.com/mrodrigues/teacher
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Flexible language for defining grades calculations.
+test_files: []