doc_type_checker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b0c5eff8a5f546b4d4a0483fb329bc28bf01eff351b41c25afd3cbf710d8febd
+  data.tar.gz: 248fa2619df37cfc9d56ff1fa1e096999ac9b736b4ba200f084533e4bbd05538
+SHA512:
+  metadata.gz: 4411c9653ff3cda9bb5f67c74ab7888d1c9f3b8f6c37df67d81c5a5b3f37aa226e1b20f50eb7db7490fa30ef300c84cd9a3fc6b6576f6a5682915433b3e1651b
+  data.tar.gz: fa1d6e926586ec46a532bb9a81d6a89a2d775acd9d5c9336b4c0a3c63872e50687c5db48f5741fa5535bf306d46a81c4e39a9c1e35a149f86509eb4905274fa5

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  NewCops: enable
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in doc_type_checker.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 shoma07
+
+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,53 @@
+# DocTypeChecker
+
+This is type checker for Ruby at runtime using [YARD](https://github.com/lsegal/yard).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'doc_type_checker'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install doc_type_checker
+
+## Usage
+
+### Configuration
+
+```ruby
+DocTypeChecker.configure do |config|
+  config.enabled = true # or false, default is false
+  config.yard_run_arguments = ['--hide-void-return']
+  # Throw exception if type validation fails.
+  config.strict = true # or false, default is false
+  config.logger = Logger.new(STDOUT) # default is nil
+end
+```
+
+## Features
+
+- Support enumerate types `Array<String>, Hash<Symbol, String>`
+- Support method types `#to_s`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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]/doc_type_checker.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'doc_type_checker'
+
+# 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/doc_type_checker.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative 'lib/doc_type_checker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'doc_type_checker'
+  spec.version       = DocTypeChecker::VERSION
+  spec.authors       = ['shoma07']
+  spec.email         = ['23730734+shoma07@users.noreply.github.com']
+
+  spec.summary       = 'Type Checker for Ruby at runtime using YARD'
+  spec.description   = 'Type Checker for Ruby at runtime using YARD'
+  spec.homepage      = 'https://github.com/shoma07/doc_type_checker'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency 'yard'
+end

data/lib/doc_type_checker.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'tracer'
+require 'yard'
+require 'doc_type_checker/version'
+require 'doc_type_checker/store'
+require 'doc_type_checker/trace_point'
+require 'doc_type_checker/configuration'
+require 'doc_type_checker/tag_type'
+require 'doc_type_checker/definition'
+
+# DocTypeChecker
+module DocTypeChecker
+  # DocTypeChecker::Error
+  class Error < StandardError; end
+  extend Configuration
+end

data/lib/doc_type_checker/configuration.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module DocTypeChecker
+  # DocTypeChecker::Configuration
+  module Configuration
+    def configure
+      @trace_point = DocTypeChecker::TracePoint.new
+      yield self
+    end
+
+    # @param [TrueClass, FalseClass] enabled
+    # @return [TrueClass, FalseClass]
+    def enabled=(enabled)
+      @trace_point.enabled = enabled
+    end
+
+    # @param [TrueClass, FalseClass] strict
+    # @return [TrueClass, FalseClass]
+    def strict=(strict)
+      @trace_point.strict = strict
+    end
+
+    # @param [Array] arguments
+    # @return [TrueClass, FalseClass]
+    def yard_run_arguments=(arguments)
+      YARD::CLI::CommandParser.run(*arguments)
+    end
+  end
+end

data/lib/doc_type_checker/definition.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module DocTypeChecker
+  # DocTypeChecker::Definition
+  class Definition
+    attr_reader :name, :params, :ret
+
+    # @param [YARD::CodeObjects::MethodObject] method_object
+    # @return [DocTypeChecker::Definition]
+    def initialize(method_object)
+      @name = method_object.path
+      init_params(method_object)
+      init_return(method_object)
+    end
+
+    # @param [Hash<Symbol, Class>] arguments
+    # @return [Array<String>]
+    def validate_params(arguments)
+      params.filter_map do |key, value|
+        object = arguments[key]
+        unless value.valid_type(object)
+          "#{name}: #{key} isn't any of #{value.inspect_type}. actual type is #{object.class}"
+        end
+      end
+    end
+
+    # @param [Object] object
+    # @return [String, NilClass]
+    def validate_return(object)
+      return if !ret.types.empty? && ret.valid_type(object)
+
+      "#{name}: return value isn't any of #{ret.inspect_type}. actual type is #{object.class}"
+    end
+
+    private
+
+    # @param [YARD::CodeObjects::MethodObject] method_object
+    # @return [Hash<Symbol, DocTypeChecker::TagType>]
+    # @raise [ArgumentError]
+    def init_params(method_object)
+      @params = method_object.tags.filter_map do |tag|
+        [tag.name.to_sym, TagType.new(tag)] if tag.tag_name == 'param'
+      end.to_h
+      unless @params.empty? || @params.keys == actual_params_definition(method_object)
+        raise ArgumentError, "params doesn't match actual arguments"
+      end
+
+      @params
+    end
+
+    # @param [YARD::CodeObjects::MethodObject] method_object
+    # @return [Array<Symbol>]
+    def actual_params_definition(method_object)
+      method_object.parameters.map { |param| param.first.sub(/:\z/, '').to_sym }
+    end
+
+    # @param [YARD::CodeObjects::MethodObject] method_object
+    # @return [DocTypeChecker::TagType]
+    def init_return(method_object)
+      @ret =
+        TagType.new(
+          YARD::Tags::Tag.new(
+            'return',
+            '',
+            method_object.tags.filter_map { |tag| tag.types if tag.tag_name == 'return' }.flatten
+          )
+        )
+    end
+  end
+end

data/lib/doc_type_checker/store.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DocTypeChecker
+  # DocTypeChecker::Store
+  class Store
+    # @return [DocTypeChecker::Store]
+    def initialize
+      reload!
+    end
+
+    # @param [String] class_name
+    # @param [String] method_name
+    # @return [DocTypeChecker::Definition]
+    def fetch(class_name, method_name)
+      @definitions.fetch(class_name, nil)&.fetch(method_name, nil)
+    end
+
+    # @return [Hash<String, Hash<String, DocTypeChecker::Definition>>]
+    def reload!
+      @definitions = YARD::Registry.load!.all(:class).to_h do |klass|
+        [
+          klass.path,
+          klass.meths.to_h do |meth|
+            [meth.name(true), DocTypeChecker::Definition.new(meth)]
+          end
+        ]
+      end
+    end
+  end
+end

data/lib/doc_type_checker/tag_type.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module DocTypeChecker
+  # DocTypeChecker::TagType
+  class TagType
+    ALLOW_TAG_NAMES = %w[param return].freeze
+    attr_reader :types
+
+    # @param [YARD::Tags::Tag] tag
+    # @return [DocTypeChecker::TagType]
+    def initialize(tag)
+      raise ArgumentError unless ALLOW_TAG_NAMES.include?(tag.tag_name)
+
+      @types = tag.types.to_a.map { |type_comment| const_get(type_comment) }
+    end
+
+    # @param [Object] object
+    # @return [TrueClass, FalseClass]
+    def valid_type(object)
+      types.any? { |type| object.is_a?(type) }
+    end
+
+    # @return [String]
+    def inspect_type
+      types.join(', ')
+    end
+
+    private
+
+    # @todo support definition Array<Integer>
+    # @param [String] type_comment
+    # @return [Class, Module]
+    def const_get(type_comment)
+      type_comment.match(/\A([\w:]+)(<.+>)?\z/) do
+        Object.const_get(Regexp.last_match(1))
+      end || (raise ArgumentError, "#{type_comment} isn't matched class")
+    end
+  end
+end

data/lib/doc_type_checker/trace_point.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module DocTypeChecker
+  # DocTypeChecker::TracePoint
+  class TracePoint
+    attr_writer :logger, :strict
+
+    # @return [DocTypeChecker::TracePoint]
+    def initialize
+      @logger = nil
+      @strict = false
+      @store = DocTypeChecker::Store.new
+      init_trace_point
+    end
+
+    # @param [TrueClass, FalseClass] enabled
+    # @return [TrueClass, FalseClass]
+    def enabled=(enabled)
+      enabled ? @trace_point.enable : @trace_point.disable
+    end
+
+    private
+
+    # @return [TracePoint]
+    def init_trace_point
+      @trace_point = ::TracePoint.new(:call, :return) do |trace_point|
+        case trace_point.event
+        when :call
+          trace_event(trace_point)
+        when :return
+          trace_return(trace_point) if trace_point.method_id != :initialize
+        end
+      end
+    end
+
+    # @param [TracePoint] trace_point
+    # @return [String]
+    def trace_event(trace_point)
+      definition = fetch_definition(trace_point)
+      return if definition.nil?
+
+      errors = definition.validate_params(event_arguments(trace_point))
+      trace_error(errors.join("\n")) unless errors.empty?
+    end
+
+    # @param [TracePoint] trace_point
+    def trace_return(trace_point)
+      definition = fetch_definition(trace_point)
+      return if definition.nil?
+
+      error = definition.validate_return(trace_point.return_value)
+      trace_error(error) unless error.nil?
+    end
+
+    # @param [String] error
+    # @return [String]
+    # @raise [DocTypeChecker::Error]
+    def trace_error(error)
+      info(error)
+      raise Error, error if @strict
+    end
+
+    # @param [TracePoint] trace_point
+    # @return [Hash<Symbol, Class>]
+    def event_arguments(trace_point)
+      binding = trace_point.binding
+      binding.local_variables.to_h { |name| [name, binding.local_variable_get(name)] }
+    end
+
+    # @param [TracePoint] trace_point
+    # @return [DocTypeChecker::Definition]
+    def fetch_definition(trace_point)
+      @store.fetch(
+        trace_point.defined_class.name,
+        "#{'#' unless trace_point.self.is_a?(Class)}#{trace_point.method_id}"
+      )
+    end
+
+    # @param [String] message
+    # @return [String]
+    def info(message)
+      return if @logger.nil?
+
+      @logger.info(message)
+    end
+  end
+end

data/lib/doc_type_checker/version.rb

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

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: doc_type_checker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- shoma07
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: Type Checker for Ruby at runtime using YARD
+email:
+- 23730734+shoma07@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- doc_type_checker.gemspec
+- lib/doc_type_checker.rb
+- lib/doc_type_checker/configuration.rb
+- lib/doc_type_checker/definition.rb
+- lib/doc_type_checker/store.rb
+- lib/doc_type_checker/tag_type.rb
+- lib/doc_type_checker/trace_point.rb
+- lib/doc_type_checker/version.rb
+homepage: https://github.com/shoma07/doc_type_checker
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/shoma07/doc_type_checker
+  source_code_uri: https://github.com/shoma07/doc_type_checker
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Type Checker for Ruby at runtime using YARD
+test_files: []