tspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 83c4d9398a6b867d88b048d7e04490339fcfb83f
+  data.tar.gz: '09f87a6d7814aa3314e4a8420556052ed25e0cfd'
+SHA512:
+  metadata.gz: fd0096b8d732ff9c56fa41c1a7abfd02b46eab64063fe9680b9b688e6db9a44f899f16b795008f502f1d79ed370bb3117176a4e30a4883069ea804ab0d03dabc
+  data.tar.gz: e1a10ffc54d218e3025ec18927db331027a0d0cf609bd451235b971e14946dab9cdc32d2384623ef78f07406d95d209a2f7d86702386fd0b18fd3fcc9f991057

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/vendor/bundle
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+# RubyMine
+.idea

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2
+  - 2.3.3
+  - 2.4.0
+before_install: gem install bundler -v 1.14.3

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 k128585@ie.u-ryukyu.ac.jp. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tspec.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 siman-man
+
+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,139 @@
+# TSpec
+
+TSpec add simple type check of method into Ruby.
+
+:construction: **Recommended for use only in hobby programming. Do not use this in production apps.** :construction:
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tspec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tspec
+
+## Usage
+
+tspec can use `#receive` and `#return` method.
+
+
+### receive
+
+`receive` define the type of method arguments.
+
+```ruby
+require 'tspec'
+
+def echo(str)
+  puts str
+end.receive(str: String)
+```
+
+specify multiple type.
+
+```ruby
+require 'tspec'
+
+def echo(val)
+  puts val
+end.receive(val: [String, Float])
+
+echo('hello')
+echo(3.14)
+```
+
+if method arguments is single. it can skip keyword.
+
+```ruby
+require 'tspec'
+
+def join_array(arr)
+  arr.join(' ')
+end.receive([String])
+
+puts join_array(%w(hello world))
+```
+
+if specify Array content type. writing is strange.
+
+```ruby
+require 'tspec'
+
+def receive_string_array(arr)
+  arr.join
+end.receive(arr: [[String]])
+
+puts receive_string_array(['hello', 'world'])
+```
+
+
+### return
+
+`return` define the type of method return value.
+
+```ruby
+require 'tspec'
+
+def message
+  'hello world'
+end.return(String)
+```
+
+multiple return value.
+
+```ruby
+require 'tspec'
+
+def random_val
+  [1.0, '1', :hello].sample
+end.return(Float, String, Symbol)
+
+10.times do
+  v = random_val
+end
+```
+
+specify Array content type.
+
+```ruby
+require 'tspec'
+
+def message_list
+  %w(hello ruby world)
+end.return([String])
+
+p message_list
+```
+
+## Example
+
+combination `receive` and `return` method.
+
+```ruby
+require 'tspec'
+
+def string2symbol(str)
+  str.to_sym
+end.receive(str: String).return(Symbol)
+
+p string2symbol('hello') #=> :hello
+p string2symbol(123)     #=> TSpec::ArgumentTypeError
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/siman-man/tspec. 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 [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

@@ -0,0 +1,11 @@
+require 'tspec'
+
+def say_hello(str)
+  puts str
+end.receive(st: String) #=> undefined `st' variable name
+
+def echo(val)
+  puts val
+end.receive(val: String)
+
+echo(3.14) #=> echo need String parameter

data/examples/receive_success.rb

@@ -0,0 +1,8 @@
+require 'tspec'
+
+def echo(val)
+  puts val
+end.receive(val: [String, Float])
+
+echo('hello')
+echo(3.14)

data/examples/return_failed.rb

@@ -0,0 +1,15 @@
+require 'tspec'
+
+def message
+  'hello'
+end.return(Float)
+
+def string_or_float
+  ['hello', 3.14].sample
+end.return(String, Regexp)
+
+def message_list
+  %w(hello ruby world)
+end.return(String)
+
+p message_list

data/examples/return_success.rb

@@ -0,0 +1,15 @@
+require 'tspec'
+
+def message
+  'hello'
+end.return(String)
+
+def string_or_float
+  ['hello', 3.14].sample
+end.return(String, Float)
+
+def message_list
+  %w(hello ruby world)
+end.return([String])
+
+p message_list

data/lib/tspec.rb

@@ -0,0 +1,107 @@
+module TSpec
+  class ReturnValueTypeError < StandardError
+  end
+
+  class NotFoundArgumentNameError < StandardError
+  end
+
+  class ArgumentTypeError < StandardError
+  end
+end
+
+class Symbol
+  def return(*types)
+    self
+  end
+
+  def receive(*type, **types)
+    self
+  end
+end
+
+module TSpec
+  @method_return_type_table = {}
+  @method_arguments_type_table = {}
+  @before_trace = {}
+  @type_error_flag = false
+
+  def self.value_type_check(value, *types)
+    types.any? do |type|
+      if type.instance_of?(Array)
+        return false unless value.instance_of?(Array)
+
+        value.all? do |v|
+          type.any? do |t|
+            value_type_check(v, t)
+          end
+        end
+      else
+        value.instance_of?(type)
+      end
+    end
+  end
+
+  TracePoint.trace do |tp|
+    case tp.event
+      when :call
+        if %i(return receive).include?(tp.method_id) && %i(method_added singleton_method_added define_method).include?(@before_trace[:method_id])
+          klass = (@before_trace[:method_id] == :singleton_method_added) ? @before_trace[:self].singleton_class : @before_trace[:self]
+          ctx = tp.binding
+          key = "#{klass}::#{ctx.receiver}"
+
+          case tp.method_id
+            when :return
+              @method_return_type_table[key] = ctx.local_variable_get(:types)
+            when :receive
+              @method_arguments_type_table[key] = ctx.local_variable_get(:types)
+
+              if @method_arguments_type_table[key].empty?
+                @method_arguments_type_table[key] = {ctx.local_variable_get(:type).__id__ => ctx.local_variable_get(:type)}
+              end
+          end
+        else
+          key = "#{tp.defined_class}::#{tp.method_id}"
+
+          if types = @method_arguments_type_table[key]
+            arguments = tp.binding.eval("method(:#{tp.method_id}).parameters.map(&:last)")
+
+            types.each do |name, type|
+
+              if name != type.__id__
+                unless arguments.include?(name)
+                  @type_error_flag = true
+                  raise NotFoundArgumentNameError, "undefined arguments `#{name}' for #{key}"
+                end
+
+                value = tp.binding.local_variable_get(name)
+              else
+                value = tp.binding.local_variable_get(arguments.first)
+              end
+
+              unless value_type_check(value, *type)
+                @type_error_flag = true
+                raise ArgumentTypeError, "##{tp.method_id} '#{name}' variable should be #{type.inspect}, but actual '#{value.inspect}' - #{value.class}"
+              end
+            end
+          end
+        end
+      when :return
+        if !@type_error_flag
+          key = "#{tp.defined_class}::#{tp.method_id}"
+
+          if types = @method_return_type_table[key]
+            unless value_type_check(tp.return_value, *types)
+              @type_error_flag = true
+              raise ReturnValueTypeError, "`#{tp.method_id}' expected return #{types.map(&:inspect).join(' or ')}, but actual `#{tp.return_value.inspect}' - #{tp.return_value.class}"
+            end
+          end
+        end
+    end
+
+    @type_error_flag = false
+
+    if tp.defined_class != Symbol || !%i(return receive).include?(tp.method_id)
+      @before_trace = {self: tp.self, method_id: tp.method_id}
+    end
+  end
+end

data/tspec.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "tspec"
+  spec.version       = "0.1.0"
+  spec.authors       = ["siman-man"]
+  spec.email         = ["k128585@ie.u-ryukyu.ac.jp"]
+
+  spec.summary       = %q{Add type check method}
+  spec.description   = %q{Add type check method}
+  spec.homepage      = "https://github.com/siman-man/tspec"
+  spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.2.0'
+
+  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.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: tspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- siman-man
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-15 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Add type check method
+email:
+- k128585@ie.u-ryukyu.ac.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/receive_failed.rb
+- examples/receive_success.rb
+- examples/return_failed.rb
+- examples/return_success.rb
+- lib/tspec.rb
+- tspec.gemspec
+homepage: https://github.com/siman-man/tspec
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Add type check method
+test_files: []