minidbc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e59101c087693aadb6c7fbcf3bd9f9d817a30b7a
+  data.tar.gz: 736919d3ea3376968990d995635f82ed6714bdd5
+SHA512:
+  metadata.gz: 4fe68f105bb88ee61a928647b9e2cb6e86182b0200d0e7ded0fd52c15328073294dbb3e77715b265499e071a1b7033b4638e8e872ec6a77e6c2732d28f9b4c16
+  data.tar.gz: b287ff187068ecaffe2b4ac34cfd1168de1f0c6d3a8eb945ffbd8f9acde8d5d6c9e22dd81302be1c3cba58740c43b31b84548a8928d1e3bdfcd89853dcca445b

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.*.swp
+.byebug_history

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in minidbc.gemspec
+gemspec

data/README.md

@@ -0,0 +1,34 @@
+# Minidbc
+
+Minimalist version of Dbc for ruby. Only implement pre, post and invariant. Not consider a lot of case involve meta programming. Use it carefully and take your own risk.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minidbc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install minidbc
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. 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]/minidbc.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,176 @@
+require "minidbc/version"
+
+module Minidbc
+  class DesignContractViolationException < Exception
+  end
+
+  def self.included(clz)
+    clz.extend ClassMethods
+    clz.minidbc_init
+  end
+
+  def minidbc_check_condition( condition_list, *args )
+    condition_list.each do |cond| 
+      if !instance_exec(*args, &cond.blk) 
+        ( file, lineno ) = cond.location.split(":")
+        puts "Contract Violation at #{cond.location}"
+        if File.exist? file
+          puts File.open(file).readlines[lineno.to_i - 1]
+        end
+        raise DesignContractViolationException.new( "Contact failed at #{cond.location}" )
+      end
+    end
+  end
+
+  Cond = Struct.new( :blk, :location )
+
+  def minidbc_call_wrap( method_name, new_method_name, check_pre, check_post, pre_check_invariants, post_check_invariants, *arg )
+    minidbc_check_condition(minidbc_pre(method_name), *arg) if check_pre
+    minidbc_check_condition(minidbc_invariants) if pre_check_invariants
+    #TODO need to handle exception
+    ret = send( new_method_name, *arg )
+    minidbc_check_condition(minidbc_invariants) if post_check_invariants
+    minidbc_check_condition(minidbc_post(method_name), ret, *arg) if check_post
+    ret
+  end
+
+  def minidbc_pre(method_name)
+    self.class.preconds(method_name) || []
+  end
+
+  def minidbc_post(method_name)
+    self.class.postconds(method_name) || []
+  end
+
+  def minidbc_invariants
+    # byebug
+    self.class.invariants
+  end
+
+  module SubclassMethods
+    def preconds(method_name)
+      preconds = @minidbc_pres[method_name]
+      super_preconds = superclass.preconds(method_name)
+      if preconds
+        if !super_preconds.empty?
+          puts "Warnning: You have override precondition for #{method_name}. You can only lose them"
+        else
+          preconds
+        end
+      else
+        super_preconds
+      end
+    end
+
+    def postconds(method_name)
+      ( @minidbc_posts[method_name] || [] ).concat( superclass.postconds(method_name) )
+    end
+
+    def invariants
+      @invariants.concat( superclass.invariants )
+    end
+  end
+
+  module ClassMethods
+    def preconds(method_name)
+      @minidbc_pres[method_name] 
+    end
+
+    def postconds(method_name)
+      @minidbc_posts[method_name]
+    end
+
+    def invariants
+      @invariants
+    end
+
+    def method_added(method_name)
+      # byebug if method_name == :initialize
+
+      if /\w+_without_dbc/ =~ method_name.to_s
+        return
+      elsif  /(pre_|post_|check_minidbc_invariant)\w+/ =~ method_name.to_s
+        return
+      else
+
+        new_method_name = :"#{method_name}_#{self.to_s.gsub(/::/,"_")}_without_dbc"
+
+        if instance_methods(false).include?(new_method_name)
+          return
+        end
+
+        if method_name == :initialize && @hook_initialize
+          return
+        end
+
+
+        @minidbc_pres[method_name] = @pres
+        @minidbc_posts[method_name] = @posts
+
+        @pres = []
+        @posts = []
+
+        #TODO need to support client code call alias_method
+        alias_method new_method_name, method_name
+
+        if method_name == :initialize
+          @hook_initialize = true
+          create_method_call_wrap( method_name, new_method_name, true, true, false, true )
+        elsif private_methods.include? method_name
+          create_method_call_wrap( method_name, new_method_name, true, true, false, false )
+        else
+          create_method_call_wrap( method_name, new_method_name, true, true, true, true )
+        end
+      end
+    end
+
+    def create_method_call_wrap( method_name, new_method_name, check_pre, check_post, pre_check_invariants, post_check_invariants )
+      define_method method_name do |*arg|
+        # puts self.class
+        # puts method_name
+        # puts new_method_name
+        # byebug
+        minidbc_call_wrap( method_name, new_method_name, check_pre, check_post, pre_check_invariants, post_check_invariants, *arg )
+      end
+    end
+
+    def minidbc_init
+      @pres = []
+      @posts = []
+      @minidbc_pres = {}
+      @minidbc_posts = {}
+      @invariants = []
+      @hook_initialize = false
+
+      #TODO need to check invariants on initialize
+      # class << self
+      # alias_method :minidbc_new, :new
+      # def new(*arg)
+      # ret = __new__(*arg)
+      # ret.minidbc_check_condition(
+      # end
+      # end
+    end
+
+
+    def inherited(subclass)
+      subclass.minidbc_init
+      if subclass.superclass == self
+        puts subclass
+        subclass.extend(SubclassMethods)
+      end
+    end
+
+    def invariant(&blk)
+      @invariants << Cond.new( blk, caller[0] )
+    end
+
+    def pre(&blk)
+      @pres << Cond.new( blk, caller[0] )
+    end
+
+    def post(&blk)
+      @posts << Cond.new( blk, caller[0] )
+    end
+  end
+end

data/lib/minidbc/version.rb

@@ -0,0 +1,3 @@
+module Minidbc
+  VERSION = "0.1.0"
+end

data/minidbc.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "minidbc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "minidbc"
+  spec.version       = Minidbc::VERSION
+  spec.authors       = ["Yang Chen"]
+  spec.email         = ["yangchen@thinkmore.info"]
+
+  spec.summary       = %q{A minimal implementation of dbc for ruby}
+  spec.description   = %q{This is a simple dbc library for ruby. It emploies alias_method to redefine method, hence it will introduce a lot of method name in your class. And it should be slow. If you care this, don't use it}
+  spec.homepage      = "https://github.com/wao/minidbc"
+
+  # 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"] = "TODO: Set to 'http://mygemserver.com'"
+  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.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "shoulda-context"
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: minidbc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yang Chen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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: shoulda-context
+  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'
+description: This is a simple dbc library for ruby. It emploies alias_method to redefine
+  method, hence it will introduce a lot of method name in your class. And it should
+  be slow. If you care this, don't use it
+email:
+- yangchen@thinkmore.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/minidbc.rb
+- lib/minidbc/version.rb
+- minidbc.gemspec
+homepage: https://github.com/wao/minidbc
+licenses: []
+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.6.8
+signing_key: 
+specification_version: 4
+summary: A minimal implementation of dbc for ruby
+test_files: []