capataz 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c29c01bcf811102a7b55b2cb078411516f6e5ae
+  data.tar.gz: 366911255ca5df4e56264b9d5855bf81a470fd38
+SHA512:
+  metadata.gz: b24a102e5f3cca7f062b3f963a58fefbb0df89ff9c3140f3410b8b6f3475e21671a3326b1087642169e8289abc7916a3cf9e1d4114e1528d921dad6a9e207992
+  data.tar.gz: 287a8b838427b32b8cd829865609b37c2a2e988762ce4e69856bbe78f6c87832cc4c038c408198303a8a7ca08afb5239541de172888475ed64b202b9ba6393f6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'parser'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Maikel Arcia
+
+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,89 @@
+# Capataz
+
+Provides Ruby code execution control by defining rules for syntax and runtime behavior.   
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capataz'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capataz
+
+## Usage
+
+Take for example the following Ruby code:
+
+```ruby
+class A
+  attr_reader :value, :secret_value
+  def initialize
+    @value = rand(10)
+    @secret_value = rand(value)
+  end
+end
+
+class B < A; end
+```
+
+So you can configure your code syntax and runtime rules
+```ruby
+Capataz.config do
+
+  deny_declarations_of :module, :class
+
+  deny_invoke_of :constantize
+
+  allowed_constants A
+
+  deny_for A, :secret_value
+end
+```
+
+And then you can control your Ruby code execution by evaluating it with `Capataz` 
+
+```ruby
+Capataz.eval <<-RUBY
+class C
+end
+RUBY #ERROR: can not define classes
+
+Capataz.eval <<-RUBY
+B.new
+RUBY #ERROR: Illegal access to constant B 
+
+Capataz.eval <<-RUBY
+'B'.constantize.new
+RUBY #ERROR: invoking method constantize is not allowed
+
+Capataz.eval <<-RUBY
+A.new.value
+RUBY # 5 (a random value)
+
+Capataz.eval <<-RUBY
+A.new.secret_value
+RUBY #ERROR: undefined method secret_value for #<A:0x000000022e7960>
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/macarci/capataz/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 a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'capataz'
+
+# 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

data/bin/setup

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

data/capataz.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capataz/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capataz'
+  spec.version       = Capataz::VERSION
+  spec.authors       = ['Maikel Arcia']
+  spec.email         = ['macarci@gmail.com']
+
+  spec.summary       = %q{Provides Ruby code execution control by defining rules for syntax and runtime behavior.}
+  spec.homepage      = 'https://github.com/macarci/capataz'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.8'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_runtime_dependency 'parser'
+end

data/lib/capataz.rb

@@ -0,0 +1,207 @@
+require 'capataz/version'
+require 'parser/current'
+require 'capataz/core_ext'
+require 'capataz/proxy'
+require 'capataz/rewriter'
+
+module Capataz
+
+  class << self
+
+    def eval(string, *binding_filename_lineno)
+      string = rewrite(string)
+      super
+    end
+
+    def disable(*args)
+      @disable = args.first.to_s.to_i.to_b
+    end
+
+    def disable?
+      @disable
+    end
+
+    def deny_declarations_of(*symbols)
+      symbol_array_store(:denied_declarations, symbols)
+    end
+
+    def deny_invoke_of(*methods)
+      symbol_array_store(:denied_methods, methods)
+    end
+
+    def allowed_constants(*constants)
+      set = @config[:allowed_constants]
+      constants = [constants] unless constants.is_a?(Enumerable)
+      constants << Capataz unless constants.include?(Capataz)
+      constants.each { |constant| set << constant }
+    end
+
+    def allow_on(objs, *methods)
+      store_options(:instances, :allow, objs, methods)
+    end
+
+    def deny_on(objs, *methods)
+      store_options(:instances, :deny, objs, methods)
+    end
+
+    def allow_for(types, *options)
+      store_options(:modules, :allow, types, options) { |type| type.is_a?(Module) }
+    end
+
+    def deny_for(types, *options)
+      store_options(:modules, :deny, types, options) { |type| type.is_a?(Module) }
+    end
+
+    def config(&block)
+      @config ||=
+        {
+          denied_declarations: Set.new,
+          allowed_constants: Set.new,
+          denied_methods: Set.new,
+          instances: {},
+          modules: {}
+        }
+      class_eval(&block) if block
+      @config
+    end
+
+    def instance_response_to?(instance, *args)
+      fail ArgumentError if args.length == 0
+      method = args[0].is_a?(Symbol) ? args[0] : args[0].to_s.to_sym
+      return false if @config[:denied_methods].include?(method)
+      if (options = @config[:instances][instance])
+        return false unless allowed_method?(options, instance, method)
+      else
+        @config[:modules].each do |type, opts|
+          if instance.is_a?(type)
+            return false unless allowed_method?(opts, instance, method)
+          end
+        end
+      end
+      instance.respond_to?(*args)
+    end
+
+    def allows_invocation_of(method)
+      method = method.to_s.to_sym unless method.is_a?(Symbol)
+      return false if @config[:denied_methods].include?(method)
+      true
+    end
+
+    def allowed_constant?(const)
+      (set = @config[:allowed_constants]) && set.include?(const)
+    end
+
+    def can_declare?(symbol)
+      (set = @config[:denied_declarations]).empty? || !set.include?(symbol)
+    end
+
+    def validate(code)
+      errors = []
+      begin
+        buffer = Parser::Source::Buffer.new('code')
+        buffer.source = code
+        Capataz::Rewriter.new(errors: errors).rewrite(buffer, Parser::CurrentRuby.new.parse(buffer))
+      rescue => ex
+        errors << ex.message
+      end
+      errors
+    end
+
+    def rewrite(code, options = {})
+      return code if Capataz.disable?
+      options ||= {}
+      options[:halt_on_error] = true if options[:halt_on_error].nil?
+      if (locals = options[:locals])
+        locals = [locals] unless locals.is_a?(Enumerable)
+        locals.each { |local| code = "#{local} ||= nil\r\n" + code }
+      end
+      buffer = Parser::Source::Buffer.new('code')
+      buffer.source = code
+      begin
+        Capataz::Rewriter.new(options).rewrite(buffer, Parser::CurrentRuby.new.parse(buffer))
+      rescue Exception => ex
+        if (logs = options[:logs]).is_a?(Hash) &&
+          (errors = (logs[:errors] ||= [])).is_a?(Array)
+          errors << "syntax error: #{ex.message}"
+        else
+          raise ex
+        end
+      end
+    end
+
+    def handle(obj, options = {})
+      if obj.capataz_proxy? || [NilClass, Fixnum, Symbol, String, TrueClass, FalseClass].any? { |type| obj.is_a?(type) }
+        obj
+      elsif obj.is_a?(Hash)
+        Capataz::HashProxy.new(obj)
+      else
+        Capataz::Proxy.new(obj, options)
+      end
+    end
+
+    private
+
+    def allow_method_overrides
+      true #TODO Setup on config
+    end
+
+    def allowed_method?(options, instance, method)
+      if (allow = options[:allow])
+        if allow.is_a?(Proc)
+          return false unless allow.call(instance, method)
+        else
+          return false unless allow.include?(method)
+        end
+      end
+      if (deny = options[:deny])
+        if deny.is_a?(Proc)
+          return false if deny.call(instance, method)
+        else
+          return false if deny.include?(method)
+        end
+      end
+      true
+    end
+
+    def symbol_array_store(key, symbols)
+      set = @config[key]
+      symbols = [symbols] unless symbols.is_a?(Enumerable)
+      symbols.each { |symbol| set << (symbol.is_a?(Symbol) ? symbol : symbol.to_s.to_sym) }
+    end
+
+    def instances_store(key, objs, methods)
+      methods = [methods] unless methods.is_a?(Enumerable)
+      methods = methods.to_a.collect { |method| method.is_a?(Symbol) ? method : method.to_s.to_sym }
+      objs = [objs] unless objs.is_a?(Enumerable)
+      instances = @config[:instances]
+      objs.each do |obj|
+        (instances[obj] ||= {}).merge!(key => methods)
+      end
+    end
+
+    def store_options(entry_key, access_key, objs, options)
+      if options.is_a?(Enumerable)
+        options = options.flatten if options.is_a?(Array)
+      else
+        options = [options]
+      end
+      options =
+        if options.length == 1 && options[0].is_a?(Proc)
+          options[0]
+        else
+          options.collect { |option| option.is_a?(Symbol) ? option : option.to_s.to_sym }
+        end
+      objs = [objs] unless objs.is_a?(Enumerable)
+      entry = @config[entry_key]
+      objs.each do |obj|
+        if block_given?
+          fail "Illegal object #{obj}" unless yield(obj)
+        end
+        (entry[obj] ||= {}).merge!(access_key => options)
+      end
+    end
+
+  end
+
+  Capataz.config
+end

data/lib/capataz/core_ext.rb

@@ -0,0 +1,24 @@
+class BasicObject
+  def capataz_proxy?
+    false
+  end
+
+  def capataz_slave
+    self
+  end
+end
+
+module Parser
+  module Source
+    class Range
+
+      def eql?(obj)
+        self == obj
+      end
+
+      def hash
+        begin_pos + 83 * end_pos
+      end
+    end
+  end
+end

data/lib/capataz/proxy.rb

@@ -0,0 +1,76 @@
+
+module Capataz
+
+  class Proxy
+
+    instance_methods.each do |m|
+      if m !~ /^(__|instance_eval|object_id)/
+        class_eval("
+        def #{m}(*args, &block)
+          method_missing(:#{m}, *args, &block)
+        end")
+      end
+    end
+
+    def initialize(obj, options = {})
+      @obj = obj
+      if (@options = options || {})[:constant] && !Capataz.allowed_constant?(obj)
+        fail "Illegal access to constant #{obj}"
+      end
+    end
+
+    def method(sym)
+      if Capataz.instance_response_to?(@obj, symbol)
+        @obj.method(sym)
+      else
+        nil
+      end
+    end
+
+    def method_missing(symbol, *args, &block)
+      if Capataz.instance_response_to?(@obj, symbol)
+        @obj.send(symbol, *args, &block)
+      else
+        fail NoMethodError, "undefined method #{symbol} for #{@obj}"
+      end
+    end
+
+    def is_a?(type)
+      if type.capataz_proxy?
+        @obj.is_a?(type.capataz_slave)
+      else
+        @obj.is_a?(type)
+      end
+    end
+
+    def capataz_proxy?
+      true
+    end
+
+    def capataz_slave
+      @obj
+    end
+
+    def class
+      @obj.class
+    end
+
+    def respond_to?(*args)
+      Capataz.instance_response_to?(@obj, *args)
+    end
+  end
+
+  class HashProxy < Proxy
+
+    def []=(key, value)
+      key = key.capataz_slave if key.capataz_proxy?
+      @obj[key] = value
+    end
+
+    def [](key)
+      key = key.capataz_slave if key.capataz_proxy?
+      value = @obj[key]
+      value.capataz_proxy? ? value.capataz_slave : value
+    end
+  end
+end

data/lib/capataz/rewriter.rb

@@ -0,0 +1,165 @@
+require 'capataz/source_rewriter'
+
+module Capataz
+
+  class Rewriter < Parser::Rewriter
+
+    attr_reader :logs
+
+    def initialize(options = {})
+      @options = options || {}
+      @logs = options[:logs] || {}
+      @self_linker = options[:self_linker]
+      @self_send_prefixer = options[:self_send_prefixer]
+      @capatized_nodes = Set.new
+    end
+
+    def rewrite(source_buffer, ast)
+      @logs.clear
+      @capatized_nodes.clear
+      @source_rewriter = Capataz::SourceRewriter.new(source_buffer)
+
+      process(ast)
+
+      @source_rewriter.preprocess
+      @source_rewriter.process
+    end
+
+    def on_array(node)
+      super
+      node.children.each { |child| decapatize(child) }
+    end
+
+    def on_send(node)
+      super
+      unless Capataz.allows_invocation_of(method_name = node.children[1])
+        report_error("invoking method #{method_name} is not allowed")
+      end
+      if (left = node.children[0])
+        capatize(left)
+      elsif node.type == :send
+        unless @self_linker.link?(method_name)
+          report_error("error linking #{method_name}")
+        end if @self_linker
+        (@logs[:self_sends] ||= Set.new) << method_name
+        prefix = @self_send_prefixer ? @self_send_prefixer.prefix(method_name, @self_linker) : ''
+        insert_before(node.location.expression, "::Capataz.handle(self).#{prefix}")
+      end
+      i = 2
+      while i < node.children.length
+        decapatize(node.children[i])
+        i += 1
+      end
+    end
+
+    def on_return(node)
+      report_error('can not use return') unless Capataz.can_declare?(:return)
+      super
+      capatize(node.children[2])
+    end
+
+    def on_casgn(node)
+      report_error('can not define (or override) constants') unless Capataz.can_declare?(:constant)
+      super
+      capatize(node.children[2])
+    end
+
+    def on_lvasgn(node)
+      super
+      capatize(node.children[1])
+    end
+
+    def on_class(node)
+      report_error('can not define classes') unless Capataz.can_declare?(:class)
+      super
+    end
+
+    def on_module(node)
+      report_error('can not define modules') unless Capataz.can_declare?(:module)
+      super
+    end
+
+    def on_def(node)
+      report_error('can not define methods') unless Capataz.can_declare?(:def)
+      super
+      insert_before(node.location.expression, ";::Capataz.denied_override_of(self, :#{node.children[0]});") unless Capataz.allow_method_overrides
+    end
+
+    def on_self(_)
+      report_error('can not access to self') unless Capataz.can_declare?(:self)
+    end
+
+    def on_yield(node)
+      report_error('can not make yield calls') unless Capataz.can_declare?(:yield)
+      super
+    end
+
+    def on_ivasgn(_)
+      report_error('can not access instance variables') unless Capataz.can_declare?(:ivar)
+      super
+    end
+
+    def on_ivar(_)
+      report_error('can not access instance variables') unless Capataz.can_declare?(:ivar)
+      super
+    end
+
+    def on_cvasgn(_)
+      report_error('can not access class variables') unless Capataz.can_declare?(:cvar)
+      super
+    end
+
+    def on_cvar(_)
+      report_error('can not access class variables') unless Capataz.can_declare?(:cvar)
+      super
+    end
+
+    def on_gvar(_)
+      report_error('can not access global variables') unless Capataz.can_declare?(:gvar)
+      super
+    end
+
+    def on_gvasgn(_)
+      report_error('can not access global variables') unless Capataz.can_declare?(:gvar)
+      super
+    end
+
+    private
+
+    def report_error(message)
+      if @options[:halt_on_error]
+        fail message
+      else
+        (logs[:errors] ||= []) << message
+      end
+    end
+
+    def capatize(node, options = {})
+      if node && !@capatized_nodes.include?(node)
+        @capatized_nodes << node
+        options[:constant] = true if node.type == :const
+        @source_rewriter.insert_before_multi(node.location.expression, '::Capataz.handle(')
+        if !options.empty?
+          @source_rewriter.insert_after_multi(node.location.expression, ", #{options.to_a.collect { |item| "#{item[0]}: #{item[1]}" }.join(',')})")
+        else
+          @source_rewriter.insert_after_multi(node.location.expression, ')')
+        end
+      end
+    end
+
+    def decapatize(node)
+      unless node.type == :hash
+        @source_rewriter.insert_before_multi(node.location.expression, '(')
+        @source_rewriter.insert_after_multi(node.location.expression, ').capataz_slave')
+      end
+    end
+
+    def const_from(node)
+      if node
+        const_from(node.children[0]) + '::' + node.children[1].to_s
+      else
+        ''
+      end
+    end
+  end
+end

data/lib/capataz/source_rewriter.rb

@@ -0,0 +1,18 @@
+
+module Capataz
+
+  class SourceRewriter < Parser::Source::Rewriter
+
+    def preprocess
+      hash = {}
+      @queue.each do |action|
+        if a = hash[action.range]
+          hash[action.range] = Parser::Source::Rewriter::Action.new(a.range, action.replacement + a.replacement)
+        else
+          hash[action.range] = action
+        end
+      end
+      @queue = hash.values.to_a
+    end
+  end
+end

data/lib/capataz/version.rb

@@ -0,0 +1,3 @@
+module Capataz
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: capataz
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Maikel Arcia
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: parser
+  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: 
+email:
+- macarci@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capataz.gemspec
+- lib/capataz.rb
+- lib/capataz/core_ext.rb
+- lib/capataz/proxy.rb
+- lib/capataz/rewriter.rb
+- lib/capataz/source_rewriter.rb
+- lib/capataz/version.rb
+homepage: https://github.com/macarci/capataz
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Provides Ruby code execution control by defining rules for syntax and runtime
+  behavior.
+test_files: []