microplane 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7101c87881bf06553225c39f82c7985c3ea1f88c
+  data.tar.gz: 9f051d4b24ca374eb422942e5935dff89d63001a
+SHA512:
+  metadata.gz: 8bd07ef18b9cb9d8d3b63777fe624f74a05a726daf7867b288eee149accb110bce2f2e4610e1b5525eec760a43127d79f53ec0b369f13aae23a8125d5815001b
+  data.tar.gz: 3424432cad9995b98990881b5502ec1b1fe1a6cbc588a8f057a36573091e303736177ddc308e3cb675760836a028b49119e6131109248f952227e59a8a997212

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+/spec/examples.txt

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at carlthuringer@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in microplane.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,13 @@
+Copyright 2017 Carl Thuringer
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,43 @@
+# Microplane
+
+A microlanguage for general-purpose embedded programming inside your application.
+
+Microplane was designed so that untrusted users could be given a limited environment
+in which to define their own programs and execute code inside your application
+without the risks of evaluating full ruby code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'microplane'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install microplane
+
+## Usage
+
+I don't know how this will be used yet.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/microplane. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).
+

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'microplane'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/microplane.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# Base module
+module Microplane
+  # Your code goes here...
+end
+
+require 'microplane/version'
+require 'microplane/vm'
+require 'microplane/lib/std'
+require 'microplane/errors'

data/lib/microplane/errors.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class StackUnderflow < StandardError
+end
+
+class EmptyWord < StandardError; end
+class NestedDefinition < StandardError; end

data/lib/microplane/lib.rb

@@ -0,0 +1,6 @@
+module Microplane
+  # Namespace for function libraries
+  module Lib; end
+end
+
+require_relative './lib/std'

data/lib/microplane/lib/std.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Microplane
+  module Lib
+    # Standard library of functions.
+    class Std
+      # DICTIONARY = .freeze
+
+      def self.load_words(base)
+        base.instance_eval do
+          @dictionary.merge!(
+            '+' => -> { push(pop + pop) },
+            '-' => -> { push(pop - pop) },
+            '*' => -> { push(pop * pop) },
+            '/' => -> { push(pop / pop) },
+            '%' => -> { push(pop % pop) },
+            '<' => -> { push(pop < pop) },
+            '<=' => -> { push(pop <= pop) },
+            '=' => -> { push(pop == pop) },
+            '>=' => -> { push(pop >= pop) },
+            '>' => -> { push(pop > pop) },
+            'true' => -> { push true },
+            'false' => -> { push false },
+            '|' => -> { push(pop || pop) },
+            'not' => -> { push(!pop) },
+            'neg' => -> { push(-pop) },
+            'pop' => -> { pop },
+            'if' => -> { @skip = true },
+            'fi' => -> { @skip = false },
+            'dup' => lambda do
+              popped = pop
+              push(popped)
+              push(popped)
+            end,
+            'over' => lambda do
+              first = pop
+              second = pop
+              push(first)
+              push(second)
+            end
+          )
+        end
+      end
+    end
+  end
+end

data/lib/microplane/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Microplane
+  VERSION = '0.1.0'.freeze
+end

data/lib/microplane/vm.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Microplane
+  # Implements the basic Microplane VM
+  class VM
+    def self.run(code)
+      new.evaluate(code).pop
+    end
+
+    attr_reader :stack
+
+    def initialize
+      @stack = []
+      @skip = false
+      @dictionary = {}
+      @libraries = []
+      add_library Lib::Std
+    end
+
+    def add_library(lib)
+      lib.load_words(self)
+    end
+
+    def evaluate(code)
+      tokens = code.split
+      return define_new_word(tokens) if tokens.first == ':'
+      tokens.each do |w|
+        next if @skip == true && w != 'fi'
+        parse(w)
+      end
+      self
+    end
+
+    def pop
+      stack.pop
+    end
+
+    private
+
+    def define_new_word(tokens)
+      word = tokens[1]
+      @dictionary[word] = tokens[2..-2].join(' ')
+    end
+
+    def push(obj)
+      stack << obj
+    end
+
+    def parse(w)
+      return push(w.to_i) if number?(w)
+      word = @dictionary[w]
+      raise "Unknown Word #{w}" unless word
+      return word.call if word.is_a?(Proc)
+      evaluate(word)
+    end
+
+    def number?(w)
+      w.getbyte(0) >= 48 && w.getbyte(0) <= 57
+    end
+  end
+end

data/microplane.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'microplane/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'microplane'
+  spec.version       = Microplane::VERSION
+  spec.authors       = ['Carl Thuringer']
+  spec.email         = ['carlthuringer@gmail.com']
+
+  spec.summary       = 'A stack-oriented, extensible microlanguage'
+  spec.description   = 'A general-purpose microlanguage for configurable objects.'
+  spec.homepage      = 'https://www.github.com/carlthuringer'
+  spec.license       = 'Apache 2.0'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.6.0'
+  spec.add_development_dependency 'ruby-prof', '~> 0.16.2'
+  spec.add_development_dependency 'benchmark-ips', '~> 2.7.2'
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: microplane
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Carl Thuringer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: ruby-prof
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.7.2
+description: A general-purpose microlanguage for configurable objects.
+email:
+- carlthuringer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/microplane.rb
+- lib/microplane/errors.rb
+- lib/microplane/lib.rb
+- lib/microplane/lib/std.rb
+- lib/microplane/version.rb
+- lib/microplane/vm.rb
+- microplane.gemspec
+homepage: https://www.github.com/carlthuringer
+licenses:
+- Apache 2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A stack-oriented, extensible microlanguage
+test_files: []