contracts-non_intrusive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eed70c8cc2c5e2b424c61370619c71f27986ac19
+  data.tar.gz: 07b145093a7e96ac7196258a5da0dbfcccb7f171
+SHA512:
+  metadata.gz: c5d265aac9459dbec9b8f8646cc7a4c6e140cd055a629dae6c21f7806c89807229fc71b64fd330a854f143a85662497863aa395183bbe0eb2a47838fd3bc5e81
+  data.tar.gz: 41ac3fe78d8c5dabb3e8495daa0bf6eb95bce748e03c49843e351358ba0d44a968d1854ec87d824edcc4d405f652b9a67b1238a65a988778a3f3bf91a2b1c84b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in contracts-non_intrusive.gemspec
+gemspec
+
+gem "contracts"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Oleksii Fedorov
+
+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,70 @@
+# Contracts::NonIntrusive
+
+Less intrusive version of Contracts DSL. Allows to use static/dynamic code
+analysis tools.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'contracts-non_intrusive'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install contracts-non_intrusive
+
+## Usage
+
+First, you should have some version of `contracts.ruby` installed.
+
+```ruby
+require "contracts/non_intrusive"
+C = Contracts
+
+class Example
+  include Contracts::NonIntrusive
+
+  Contract(C::Num, C::Num => C::Num)[:add => :add__raw]
+  def add__raw(a, b)
+    a + b
+  end
+end
+```
+
+### Singleton methods
+
+This gem does not support (Yet?) singleton methods, workaround is to use
+singleton class:
+
+```ruby
+class Example
+  class << self
+    include Contracts::NonIntrusive
+
+    Contract(C::Num, C::Num => C::Num)[:add => :add__raw]
+    def add__raw(a, b)
+      a + b
+    end
+  end
+end
+```
+
+## 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/waterlink/contracts-non_intrusive/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 "contracts/non_intrusive"
+
+# 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/contracts-non_intrusive.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'contracts/non_intrusive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "contracts-non_intrusive"
+  spec.version       = Contracts::NonIntrusive::VERSION
+  spec.authors       = ["Oleksii Fedorov"]
+  spec.email         = ["waterlink000@gmail.com"]
+
+  spec.summary       = %q{Non intrusive wrapper gem for contracts.ruby.}
+  spec.description   = %q{This gem allows you to use static/dynamic analyzer tools together with contracts.ruby. It is achieved by allowing you to do the method mangling yourself.}
+  spec.homepage      = "https://github.com/waterlink/contracts-non_intrusive"
+  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"
+end

data/examples/add.rb

@@ -0,0 +1,25 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "contracts/non_intrusive"
+C = Contracts
+
+class Example
+  include Contracts::NonIntrusive
+
+  Contract(C::Num, C::Num => C::Num)[:add => :add__raw]
+  def add__raw(a, b)
+    a + b
+  end
+end
+
+puts Example.new.add(3, 2)
+# => 5
+
+puts Example.new.add(2, "foo")
+# : Contract violation for argument 2 of 2: (ParamContractError)
+#       Expected: Num,
+#       Actual: "foo"
+#       Value guarded in: Example::add
+#       With Contract: Num, Num => Num
+#       At: examples/add.rb:11

data/examples/singleton_add.rb

@@ -0,0 +1,27 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "contracts/non_intrusive"
+C = Contracts
+
+class Example
+  class << self
+    include Contracts::NonIntrusive
+
+    Contract(C::Num, C::Num => C::Num)[:add => :add__raw]
+    def add__raw(a, b)
+      a + b
+    end
+  end
+end
+
+puts Example.add(3, 2)
+# => 5
+
+puts Example.add(2, "foo")
+#: Contract violation for argument 2 of 2: (ParamContractError)
+#        Expected: Num,
+#        Actual: "foo"
+#        Value guarded in: Example::add
+#        With Contract: Num, Num => Num
+#        At: examples/singleton_add.rb:12

data/lib/contracts/non_intrusive.rb

@@ -0,0 +1,42 @@
+require "contracts/non_intrusive/version"
+require "contracts"
+
+module Contracts
+  class SimpleMethodReference < MethodReference
+    attr_reader :raw_name
+    def initialize(name, raw_name)
+      @name = name
+      @raw_name = raw_name
+    end
+
+    def set_method_once(value)
+      @method ||= value
+    end
+
+    def send_to(this, *args, &blk)
+      this.send(raw_name, *args, &blk)
+    end
+  end
+
+  module NonIntrusive
+    def self.included(base)
+      base.send(:extend, self)
+    end
+
+    def Contract(*contracts)
+      lambda do |method_map|
+        name = method_map.first.first
+        raw_name = method_map.first.last
+        simple_method = SimpleMethodReference.new(name, raw_name)
+        contract = nil
+
+        define_method(name) do |*args, &blk|
+          simple_method.set_method_once(method(raw_name))
+          klass = self.class == Class ? self : self.class
+          contract ||= Contract.new(klass, simple_method, *contracts)
+          contract.call_with(self, *args, &blk)
+        end
+      end
+    end
+  end
+end

data/lib/contracts/non_intrusive/version.rb

@@ -0,0 +1,5 @@
+module Contracts
+  module NonIntrusive
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: contracts-non_intrusive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oleksii Fedorov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-06 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'
+description: This gem allows you to use static/dynamic analyzer tools together with
+  contracts.ruby. It is achieved by allowing you to do the method mangling yourself.
+email:
+- waterlink000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- contracts-non_intrusive.gemspec
+- examples/add.rb
+- examples/singleton_add.rb
+- lib/contracts/non_intrusive.rb
+- lib/contracts/non_intrusive/version.rb
+homepage: https://github.com/waterlink/contracts-non_intrusive
+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: Non intrusive wrapper gem for contracts.ruby.
+test_files: []