qdocs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dc6b3ccc77bc958c324f4cdc463febbcd6337e7c6b39a51e55f215c187167d80
+  data.tar.gz: 503a6012c888d1626a834f1ab95d2fbc194ca9193943ea1595d4e9c732bfd038
+SHA512:
+  metadata.gz: 3066dea2b451986c417f12ed8e437c0d6131068a546d30969a305be55cc63ec0044f3ec09add1d650356e321810546a49a84c23ecc9a0219fb408d27deddf9b2
+  data.tar.gz: 679cd7f630fd15b4026646cfb60bbb1692fc8ddcbceb8febecf3585a75e86c705fd08c4399fa3556bcdb379829240dc0254f949e242501988c4760530c8d52e6

data/.gitignore

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

data/.rspec

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    qdocs (0.1.0)
+      method_source (~> 1)
+      rack (> 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    rack (2.2.3)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  qdocs!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Joseph Johansen
+
+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 @@
+# Qdocs
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/qdocs`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'qdocs'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install qdocs
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 the created tag, 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]/qdocs.
+
+## 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 "qdocs"
+
+# 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/exe/qdocs

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'qdocs'
+require 'json'
+
+input = ARGV[0]
+
+output = nil
+
+case input
+when "--version", "-v", "-version"
+  puts Qdocs::VERSION
+when "-s", "--server"
+  require "qdocs/server"
+when "help", "--help", "-h", "", nil
+  puts <<~STR
+    Usage:
+      qdocs 'String#split' # => info about String's "split" instance method
+      qdocs 'String.try_convert' # => info about String's "try_convert" singleton method
+      qdocs puts # => info about Object/Kernel method
+      qdocs String # => info about String class
+      qdocs String/tr/ # => grep for methods matching /tr/ within String
+  STR
+else
+  begin
+    output = Qdocs.lookup(input)
+  rescue => e
+    abort e.message
+  end
+end
+
+puts JSON.pretty_generate(output) if output

data/lib/qdocs.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+require 'method_source'
+require_relative "qdocs/version"
+
+module Qdocs
+  class UnknownClassError < StandardError; end
+
+  class UnknownMethodTypeError < StandardError; end
+
+  class UnknownMethodError < StandardError; end
+
+  class UnknownPatternError < StandardError; end
+
+  module Helpers
+    def source_location_to_str(source_location)
+      if source_location && source_location.length == 2
+        "#{source_location[0]}:#{source_location[1]}"
+      end
+    end
+
+    def own_methods(methods)
+      methods - Object.methods
+    end
+
+    def params_to_hash(params)
+      hsh = {}
+      params.each_with_index do |prm, i|
+        hsh[prm[1] || "unnamed_arg_#{i}"] = prm[0]
+      end
+      hsh
+    end
+
+    def find_constant(const)
+      case const
+      when Symbol, String
+        Object.const_get const
+      else
+        const
+      end
+    rescue NameError
+      raise UnknownClassError, "Unknown constant #{const}"
+    end
+  end
+
+  class Const
+    include Helpers
+
+    def show(const)
+      const = const.to_s
+      constant = find_constant const
+
+      const_sl = Object.const_source_location const
+
+      {
+        source_location: source_location_to_str(const_sl),
+        instance_methods: own_methods(constant.instance_methods).sort,
+        singleton_methods: own_methods(constant.methods).sort,
+      }
+    end
+  end
+
+  class Method
+    include Helpers
+
+    def index(const, pattern)
+      constant = find_constant const
+      {
+        constant: constant,
+        singleton_methods: own_methods(constant.methods.grep(pattern)).sort,
+        instance_methods: own_methods(constant.instance_methods.grep(pattern)).sort,
+      }
+    end
+
+    def show(const, meth, type)
+      constant = begin
+                   find_constant(const)
+                 rescue UnknownClassError
+                   abort "Unknown class #{const.inspect}"
+                 end
+      method = case meth
+               when Symbol, String
+                 method_method = case type
+                                 when :instance
+                                   :instance_method
+                                 when :singleton, :class
+                                   :method
+                                 else
+                                   raise UnknownMethodTypeError, "Unknown method type #{type}"
+                                 end
+
+                 begin
+                   constant.send method_method, meth
+                 rescue NameError
+                   raise UnknownMethodError, "No method #{meth.inspect} for #{constant.inspect}. Did you mean #{constant.inspect}/#{meth}/ ?"
+                 end
+               when Method
+                 meth
+               else
+                 raise InvalidArgumentError, "#{meth.inspect} must be of type Symbol, String, or Method"
+               end
+
+      parameters = params_to_hash(method.parameters)
+      src = method.source rescue nil
+      source = if src
+                 lines = src.lines
+                 first_line = lines.first
+                 indent_amount = first_line.length - first_line.sub(/^\s*/, '').length
+                 lines.map { |l| l[indent_amount..-1] }.join
+               end
+
+      {
+        defined_at: source_location_to_str(method.source_location),
+        source: source,
+        arity: method.arity,
+        parameters: parameters,
+        comment: (method.comment.strip rescue nil),
+        name: method.name,
+        belongs_to: method.owner,
+        super_method: method.super_method,
+      }
+    end
+  end
+
+  METHOD_REGEXP = /(?:[a-zA-Z_]+|\[\])[?!=]?/.freeze
+  CONST_REGEXP = /[[:upper:]]\w*(?:::[[:upper:]]\w*)*/.freeze
+
+  def self.lookup(input)
+    case input
+    when /\A([[:lower:]](?:#{METHOD_REGEXP})?)\z/
+      Qdocs::Method.new.show(Object, $1, :instance)
+    when /\A(#{CONST_REGEXP})\.(#{METHOD_REGEXP})\z/
+      Qdocs::Method.new.show($1, $2, :singleton)
+    when /\A(#{CONST_REGEXP})#(#{METHOD_REGEXP})\z/
+      Qdocs::Method.new.show($1, $2, :instance)
+    when /\A(#{CONST_REGEXP})\z/
+      Qdocs::Const.new.show($1)
+    when %r{\A(#{CONST_REGEXP})/([^/]+)/\z}
+      Qdocs::Method.new.index($1, Regexp.new($2))
+    else
+      raise UnknownPatternError, "Unrecognised pattern #{input}"
+    end
+  end
+end

data/lib/qdocs/server.rb

@@ -0,0 +1,23 @@
+require "rack"
+
+module Qdocs
+  class Server
+    def call(env)
+      req = Rack::Request.new(env)
+      params = req.params
+      case env["REQUEST_PATH"]
+      when "/"
+        body = JSON.pretty_generate(Qdocs.lookup(params["input"]))
+        [200, { "Content-Type" => "application/json; charset=utf-8" }, [body]]
+      else
+        [404, { "Content-Type" => "text/html; charset=utf-8" }, ["Not Found"]]
+      end
+    rescue => e
+      [500, { "Content-Type" => "text/html; charset=utf-8" }, ["Error: #{e.message}"]]
+    end
+  end
+end
+
+handler = Rack::Handler::WEBrick
+
+handler.run Qdocs::Server.new

data/lib/qdocs/version.rb

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

data/qdocs.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require_relative "lib/qdocs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "qdocs"
+  spec.version       = Qdocs::VERSION
+  spec.authors       = ["Joseph Johansen"]
+  spec.email         = ["joe@stotles.com"]
+
+  spec.summary       = "A rudimentary ruby language intelligence server"
+  spec.description   = "A server providing runtime information about constants and methods"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["source_code_uri"] = "https://github.com/johansenja/qdocs"
+
+  # 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{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "method_source", "~> 1"
+  spec.add_dependency "rack", "> 1"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: qdocs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Johansen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: A server providing runtime information about constants and methods
+email:
+- joe@stotles.com
+executables:
+- qdocs
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/qdocs
+- lib/qdocs.rb
+- lib/qdocs/server.rb
+- lib/qdocs/version.rb
+- qdocs.gemspec
+homepage:
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  source_code_uri: https://github.com/johansenja/qdocs
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.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: A rudimentary ruby language intelligence server
+test_files: []