initial

Author: schneems

.gitignore

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

.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.13.6

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 [email protected]. 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/

Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in docs_doctor.gemspec
+gemspec

LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 schneems
+
+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.

README.md

@@ -0,0 +1,68 @@
+Playing around here, nothing set in stone.
+
+## Writing a Doc Parser
+
+CodeTriage supports sending people documented and undocumented methods. It has native support for Ruby, because thats what [@schneems](https://www.twitter.com/schneems) writes in. However there is an API for getting your favorite "language" supported.
+
+## Architecture
+
+We must be able to parse docs for your language, most likely this means we need to run your language in production.
+
+### Running your Language in Production
+
+Your lang needs to be able to run on Heroku. Each doc parser will run in it's own app that will install Ruby and whatever code you need to parse documentation.
+
+To get started look at the [Ruby doc app]().
+
+
+### Doc Communication
+
+Once you've parsed that documentation we need to get it back into the CodeTriage database. We use redis and `sidekiq` as a transport medium. Each redis entry represents a single documentation entry. Your language does not need to be able to enqueue into redis, instead you can write to a file on disk and our utilities can enqueue into redis for you.
+
+
+## Executing Doc Parsers
+
+### Executable interface
+
+You need to provide a script that will be called once for each library that needs to be documented. Our tools will clone the project and execute your `bin/document` command that you need to provide:
+
+```
+$ bin/document --repo_path="<location/to/project/folder>" --output_file="<location/to/output/file.docs>"
+```
+
+The option `repo_path` will be the location of the folder where the project has been downloaded. The second option `output_file` is the location of the file that CodeTriage expects your docs to be written to. Other arguments or options may be added at a later time.
+
+## Output File format
+
+We expect a newline seperated file with each line being a json blob that represents a single documentation entry.
+
+```
+$ cat <location/to/output/file.docs>
+{ name: "foo" }
+{ name: "foo" }
+```
+
+Note: that the whole file is not valid json, but each individual line should be json. This is done to make streaming results back to the parent app easier (so we only have to parse individual lines, not the whole thing).
+
+## JSON doc entry
+
+Here is expected interface for json in the file.
+
+```ruby
+{
+  name: "pipetree",                  # String: Name of method
+  full_name: "DSL::Import#pipetree", # String: The full name of the method, i.e. how would you call it from a root context
+  line: 199,                         # Numeric: The line number where the docs (or thing to be documented) is located
+  path: "lib/foo/import.rb",         # String: The full path to the file of the thing that is being documented
+  comment: "I ama comment",          # String: Contents of the documentation, can be null or the key ommitted when docs not present
+  language:   "Ruby",                # String: The language of the parser, Must match Repo::CLASS_FOR_DOC_LANGUAGE list
+  skip_write: false,                 # Boolean: When true, we will not email to someone who want's to "write docs"
+  skip_read:  false,                 # Boolean: When true, we will not email to someone who want's to "read docs"
+}
+```
+
+We will add
+
+- commit_sha
+- github_full_name
+

Rakefile

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

bin/console

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

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

docs_doctor.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'docs_doctor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "docs_doctor"
+  spec.version       = DocsDoctor::VERSION
+  spec.authors       = ["schneems"]
+  spec.email         = ["[email protected]"]
+
+  spec.summary       = %q{: Write a short summary, because Rubygems requires one.}
+  spec.description   = %q{: Write a longer description or delete this line.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  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_dependency             "git_hub_bub", "~> 0.0"
+  spec.add_dependency             "sequel",      "~> 4.0"
+  spec.add_dependency             "sidekiq",     "~> 4.2"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

ext/docs_doctor

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+
+require 'docs_doctor'
+
+argv = ARGV.dup
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: $ docs_doctor enqueue:all --language=Ruby --script_path=<path/to/parsing/script>"
+
+  opts.on("-l", "--language", "Computer language of target project") do |lang|
+    options[:language] = lang
+  end
+  opts.on("-p", "--script_path", "Location of the script that needs to be run to generate documentation") do |path|
+    options[:script_path] = path
+  end
+end.parse!
+
+
+cli = DocsDoctor::CLI.new(argv, **options)
+
+case command = argv.first
+when "enqueue:all"
+  cli.enqueue
+else
+  "No command found for #{command}"
+end

lib/docs_doctor.rb

@@ -0,0 +1,20 @@
+require 'json'
+require 'tmpfile'
+
+require "docs_doctor/version"
+
+module DocsDoctor
+  class ScriptExecutionError < StandardError
+    def initialize(msg, out: , err: )
+      msg << "STDOUT: #{out.inspect}"
+      msg << "STDERR: #{err.inspect}"
+      super msg
+    end
+  end
+end
+
+
+require 'docs_doctor/project_name_cache'
+require 'docs_doctor/projects_from_database'
+require 'docs_doctor/github_fetcher'
+require 'docs_doctor/cli'