auto_type_doc 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 78f3bb6835356121a3179d8fa8220e2718ec85c5
+  data.tar.gz: f80b263c640383b2d1b2f5c2948abc601aaf31ae
+SHA512:
+  metadata.gz: 99e9358fee430832c00a4f0fe4d5774685487fce3fab55f439e9f8f584389acf4185caf80267add1fc4f184083ddeebcaee4dd08725ab378b7a46c24674bb5dd
+  data.tar.gz: d6e3f62879028b552c96640fe30dba19c8dc1dff23ef255d1e926f6af03a1bc12be10787e9c7a394d443f1929704ac5070d2e84528cb41babbf1bd667c13b496

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,132 @@
+# https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+
+AllCops:
+  Include:
+    - Rakefile
+  TargetRubyVersion: 2.5
+
+LineLength:
+  Max: 80
+  Exclude:
+    - test/**/**
+
+Layout/ExtraSpacing:
+  Enabled: false
+
+Layout/SpaceInsideStringInterpolation:
+  Enabled: false
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Layout/EmptyLineBetweenDefs:
+  NumberOfEmptyLines: [1, 2]
+
+Layout/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Layout/AlignParameters:
+  EnforcedStyle: with_first_parameter
+
+Layout/DotPosition:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/SingleLineBlockParams:
+  Enabled: false
+
+Style/TrivialAccessors:
+  AllowPredicates: true
+
+Style/Semicolon:
+  AllowAsExpressionSeparator: true
+
+Style/PerlBackrefs:
+  Enabled: false
+
+Style/SingleLineMethods:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/CommandLiteral:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/FormatString:
+  Enabled: false
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/SymbolProc:
+  AutoCorrect: false
+
+Style/EmptyMethod:
+  Enabled: false
+
+Style/MultilineTernaryOperator:
+  Enabled: false
+
+Style/DoubleNegation:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ParameterLists:
+  CountKeywordArgs: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Naming/PredicateName:
+  Enabled: false
+
+Naming/MethodName:
+  Enabled: false
+
+Performance/RedundantBlockCall:
+  Enabled: false
+
+Lint/UnusedMethodArgument:
+  Enabled: true
+  AutoCorrect: false

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.4.3

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.1
+script:
+  - bundle exec rake test

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 auto_type_doc.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    auto_type_doc (0.1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    coderay (1.1.2)
+    method_source (0.9.0)
+    minitest (5.11.3)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    pry-doc (0.13.4)
+      pry (~> 0.11)
+      yard (~> 0.9.11)
+    rake (10.5.0)
+    yard (0.9.12)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  auto_type_doc!
+  bundler (~> 1.16)
+  minitest (~> 5.0)
+  pry
+  pry-byebug
+  pry-doc
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Rathesan Iyadurai
+
+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,39 @@
+# AutoTypeDoc
+
+![Build status](https://travis-ci.org/rathrio/auto_type_doc.svg?branch=master)
+
+Generates type documentation (e.g. YARD tags) by collecting runtime information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'auto_type_doc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install auto_type_doc
+
+## 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/rathrio/auto_type_doc.
+
+## 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,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/auto_type_doc.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "auto_type_doc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "auto_type_doc"
+  spec.version       = AutoTypeDoc::VERSION
+  spec.authors       = ["Rathesan Iyadurai"]
+  spec.email         = ["rad.iyadurai@gmail.com"]
+
+  spec.summary       = %q{Automatic type documentation powered by Ruby's runtime information}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/rathrio/auto_type_doc"
+  spec.license       = "MIT"
+
+  # 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.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pry-doc"
+  spec.add_development_dependency "pry-byebug"
+end

data/bin/console

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

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+EXECUTABLE_FILE = File.realpath(__FILE__)
+$LOAD_PATH.unshift File.expand_path('../lib', EXECUTABLE_FILE)
+require 'auto_type_doc'
+
+AutoTypeDoc.enable
+class Dog
+end
+
+class Fish
+end
+
+module M
+  def bite(animal)
+  end
+end
+
+module CM
+  def eat(food)
+  end
+
+  def self.info(*args)
+    "CHELLO THERE"
+  end
+end
+
+class Cat
+  class << self
+    def chabis=(some_value)
+      some_value = some_value.to_a
+      @chabis = some_value
+    end
+  end
+
+  def self.foobar(num)
+    num + 4
+  end
+
+  include M
+  extend CM
+end
+
+Cat.chabis = Set.new
+Cat.new.bite(Dog.new)
+Cat.foobar 2
+Cat.foobar 8.9
+Cat.foobar 123.34
+
+Cat.eat(Fish.new)
+
+CM.info(1, 2)
+
+AutoTypeDoc.disable
+AutoTypeDoc.dump_json

data/lib/auto_type_doc.rb

@@ -0,0 +1,126 @@
+require "auto_type_doc/version"
+require "auto_type_doc/argument"
+require "auto_type_doc/method_info"
+
+require 'irb'
+require 'pry'
+require 'json'
+require 'set'
+require 'fileutils'
+
+module AutoTypeDoc
+  module_function
+
+  METHOD_BLACK_LIST = %r{
+    AutoTypeDoc
+  }x
+
+  LOCATION_BLACK_LIST = %r{
+    rubies/
+    |/gems/
+    |/spec/
+    |/test/
+  }x
+
+  Tracker = TracePoint.new(:call, :return) do |t|
+    begin
+      method = t.self.method(t.method_id)
+    rescue
+      next
+    end
+
+    source_location = method.source_location
+    next if source_location.nil?
+
+    source_path = source_location[0]
+    next if source_path =~ LOCATION_BLACK_LIST
+    next if method.to_s =~ METHOD_BLACK_LIST
+    next if method_name_with_owner(method).start_with?("#<")
+
+    case t.event
+    when :call
+      next if method.parameters.empty?
+      on_call(t, method: method)
+    when :return
+      on_return(t, method: method)
+    end
+  end
+
+  # @param method [Method]
+  # @return [String]
+  def method_name_with_owner(method)
+    method.to_s[/^#<Method:\s(.+)>$/, 1].sub(/^.+\((.+)\)/, '\1')
+  end
+
+  def on_call(t, method:)
+    method_info = method_info(method)
+
+    method.parameters.each_with_index do |(kind, name), index|
+      begin
+        obj = t.binding.local_variable_get(name)
+      rescue
+        next
+      end
+
+      method_info.add_argument(
+        name: name,
+        type: type(obj),
+        kind: kind,
+        position: index
+      )
+    end
+  end
+
+  # @return [String]
+  def type(obj)
+    if obj.is_a?(Array) && obj.any?
+      return "#{obj.class}<#{type(obj.first)}>"
+    end
+
+    if obj.equal?(true) || obj.equal?(false)
+      return "Boolean"
+    end
+
+    obj.class
+  end
+
+  def on_return(t, method:)
+    method_info = method_info(method)
+    obj = t.return_value
+    method_info.add_return_type(type(obj))
+  end
+
+  def method_info(method)
+    key = method_name_with_owner(method)
+
+    AutoTypeDoc.all_method_info[key] ||= MethodInfo.new(
+      source_location: method.source_location
+    )
+
+    AutoTypeDoc.all_method_info[key]
+  end
+
+  def all_method_info
+    @all_method_info ||= {}
+  end
+
+  def enable
+    Tracker.enable
+  end
+
+  def disable
+    Tracker.disable
+  end
+
+  def doc_dir
+    './type_doc'
+  end
+
+  def dump_json
+    FileUtils.mkdir_p(doc_dir)
+
+    File.open("#{doc_dir}/types.json", 'w') do |f|
+      f.write(JSON.pretty_generate(all_method_info))
+    end
+  end
+end

data/lib/auto_type_doc/argument.rb

@@ -0,0 +1,38 @@
+module AutoTypeDoc
+  class Argument
+    attr_reader :name, :types, :kind, :position
+
+    def initialize(name:, kind:, position:)
+      @name = name.to_s
+      @kind = kind.to_s
+      @types = Hash.new(0)
+      @position = position
+    end
+
+    def add_type(type)
+      type = type.to_s
+      types[type] += 1
+    end
+
+    def ==(other)
+      name == other.name
+    end
+
+    def eql?(other)
+      self == other
+    end
+
+    def hash
+      name.hash
+    end
+
+    def to_h
+      {
+        name: name,
+        types: types,
+        kind: kind,
+        position: position
+      }
+    end
+  end
+end

data/lib/auto_type_doc/method_info.rb

@@ -0,0 +1,71 @@
+module AutoTypeDoc
+  class MethodInfo
+    attr_accessor :arguments
+    attr_accessor :return_types
+    attr_accessor :source_location
+
+    def initialize(source_location:)
+      @source_location = source_location
+      @arguments = Set.new
+      @return_types = Hash.new(0)
+    end
+
+    def source_file
+      source_location[0]
+    end
+
+    def source_line
+      source_location[1]
+    end
+
+    def argument(name)
+      arguments.find { |a| a.name == name.to_s }
+    end
+
+    def add_argument(name:, type:, kind:, position:)
+      if (a = argument(name))
+        a.add_type(type)
+      else
+        a = Argument.new(name: name, kind: kind, position: position)
+        a.add_type(type)
+        arguments << a
+      end
+    end
+
+    def add_return_type(type)
+      return_types[type.to_s] += 1
+    end
+
+    # @return [String]
+    def most_frequent_arg_type(arg_name)
+      most_frequent_type(argument(arg_name).types)
+    end
+
+    # @return [String]
+    def most_frequent_return_type
+      most_frequent_type(return_types)
+    end
+
+    def to_h
+      h = {}
+      h[:arguments] = arguments.map(&:to_h) if arguments.any?
+      h.merge(
+        return_types: return_types,
+        source_location: {
+          path: source_file,
+          line: source_line
+        }
+      )
+    end
+
+    def to_json(*args)
+      to_h.to_json(*args)
+    end
+
+    private
+
+    def most_frequent_type(type_hash)
+      type_hash.max_by { |_, count| count }[0]
+    end
+  end
+end

data/lib/auto_type_doc/version.rb

@@ -0,0 +1,3 @@
+module AutoTypeDoc
+  VERSION = "0.1.1"
+end

data/type_doc/types.json

@@ -0,0 +1,99 @@
+{
+  "Cat.chabis=": {
+    "arguments": [
+      {
+        "name": "some_value",
+        "types": {
+          "Set": 1
+        },
+        "kind": "req",
+        "position": 0
+      }
+    ],
+    "return_types": {
+      "Array": 1
+    },
+    "source_location": {
+      "file": "foo_test.rb",
+      "line": 30
+    }
+  },
+  "M#bite": {
+    "arguments": [
+      {
+        "name": "animal",
+        "types": {
+          "Dog": 1
+        },
+        "kind": "req",
+        "position": 0
+      }
+    ],
+    "return_types": {
+      "NilClass": 1
+    },
+    "source_location": {
+      "file": "foo_test.rb",
+      "line": 15
+    }
+  },
+  "Cat.foobar": {
+    "arguments": [
+      {
+        "name": "num",
+        "types": {
+          "Integer": 1,
+          "Float": 2
+        },
+        "kind": "req",
+        "position": 0
+      }
+    ],
+    "return_types": {
+      "Integer": 1,
+      "Float": 2
+    },
+    "source_location": {
+      "file": "foo_test.rb",
+      "line": 36
+    }
+  },
+  "CM#eat": {
+    "arguments": [
+      {
+        "name": "food",
+        "types": {
+          "Fish": 1
+        },
+        "kind": "req",
+        "position": 0
+      }
+    ],
+    "return_types": {
+      "NilClass": 1
+    },
+    "source_location": {
+      "file": "foo_test.rb",
+      "line": 20
+    }
+  },
+  "CM.info": {
+    "arguments": [
+      {
+        "name": "args",
+        "types": {
+          "Array<Integer>": 1
+        },
+        "kind": "rest",
+        "position": 0
+      }
+    ],
+    "return_types": {
+      "String": 1
+    },
+    "source_location": {
+      "file": "foo_test.rb",
+      "line": 23
+    }
+  }
+}

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: auto_type_doc
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Rathesan Iyadurai
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: pry
+  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: pry-doc
+  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: pry-byebug
+  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: ''
+email:
+- rad.iyadurai@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- auto_type_doc.gemspec
+- bin/console
+- bin/setup
+- foo_test.rb
+- lib/auto_type_doc.rb
+- lib/auto_type_doc/argument.rb
+- lib/auto_type_doc/method_info.rb
+- lib/auto_type_doc/version.rb
+- type_doc/types.json
+homepage: https://github.com/rathrio/auto_type_doc
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Automatic type documentation powered by Ruby's runtime information
+test_files: []