api_tommy 0.1.0

data/lib/api_tommy/github.rb

@@ -0,0 +1,39 @@
+require "grit"
+require "tmpdir"
+
+module ApiTommy
+  class Github
+    def update_wiki(file, content)
+      Dir.mktmpdir("api_tommy") do |dir|
+        clone_wiki(dir)
+        update_file(dir, file, content)
+        push(dir, file)
+      end
+    rescue => e
+      raise Error, "Can't update wiki (#{e.message})"
+    end
+
+    def wiki_url
+      return @wiki_url if defined?(@wiki_url)
+      origin = Grit::Repo.new(Dir.pwd).config["remote.origin.url"]
+      @wiki_url = origin.gsub(".git", ".wiki.git") if origin
+      @wiki_url
+    end
+
+    def clone_wiki(dir)
+      git = Grit::Git.new("/tmp/filling-in")
+      git.clone({}, wiki_url, dir)
+    end
+
+    def update_file(dir, file, content)
+      File.open(File.join(dir, file), "w") { |f| f.write(content) }
+    end
+
+    def push(dir, file)
+      repo = Grit::Repo.new(dir)
+      Dir.chdir(dir) { repo.add(file) }
+      repo.commit_index("Update #{file}")
+      repo.git.push({}, "origin", "master")
+    end
+  end
+end

data/lib/api_tommy/markdown.rb

@@ -0,0 +1,41 @@
+module ApiTommy
+  class Markdown
+    1.upto(6).each do |level|
+      self.class.send(:define_method, "h#{level}") { |text| title(text, level) }
+    end
+
+    def self.title(text, level)
+      "\n#{"#" * level} #{text}\n"
+    end
+
+    def self.p(text)
+      "\n#{text.gsub(/[\n]+/, " ")}\n"
+    end
+
+    def self.code(text, language = nil)
+      result = "\n```"
+      result << language unless language.nil?
+      result << "\n#{text}\n```\n"
+    end
+
+    def self.ul(text)
+      "* #{text}\n"
+    end
+
+    def self.th(*headers)
+      "\n".tap do |result|
+        headers.each { |header| result << "| #{header} " }
+        result << "\n"
+        headers.size.times.each { result << "| --- " }
+        result << "\n"
+      end
+    end
+
+    def self.tr(*values)
+      "".tap do |result|
+        values.each { |value| result << "| #{value} " }
+        result << "\n"
+      end
+    end
+  end
+end

data/lib/api_tommy/version.rb

@@ -0,0 +1,3 @@
+module ApiTommy
+  VERSION = "0.1.0"
+end

data/lib/rdoc/discover.rb

@@ -0,0 +1,3 @@
+# file needed for rdoc generator auto discovering
+require "rdoc/rdoc"
+require "api_tommy"

data/lib/rdoc/generator/api_tommy.rb

@@ -0,0 +1,25 @@
+module RDoc
+  module Generator
+    class ApiTommy < ApiTommy::Generator
+      RDoc.add_generator(self)
+
+      def initialize(store, options)
+        @store = store
+        @options = options
+        @content = ""
+        @h = ::ApiTommy::Markdown
+      end
+
+      def generate
+        log("Parsing and Generating doc...")
+        @store.all_classes.each do |clazz|
+          generate_class_doc(clazz)
+        end
+        log("Done.")
+
+        finalize_content
+        update_wiki
+      end
+    end
+  end
+end

data/test/fixtures/footer.md

@@ -0,0 +1 @@
+# This is the footer

data/test/fixtures/header.md

@@ -0,0 +1 @@
+# This is the header

data/test/fixtures/samples_controller.rb

@@ -0,0 +1,47 @@
+# This API deals with user operations.
+#
+# id - the id
+# username - the username
+# api_key - the api key
+# email - the email
+# first_name - the first name
+# last_name - the last name
+# role - the role
+# role_promotion - the role from a promotion point of view
+# activated - true or false indicating if the user is enabled
+# shop_ids - an array of all shop ids
+#
+# Examples
+#
+# {
+#     "id": "67bc91bf-d28d-5a24-ac73-296dfdbcdc6a",
+#     "username": "sysadmin",
+#     "api_key": null,
+#     "email": "sys@admin.net",
+#     "first_name": "sys",
+#     "last_name": "admin",
+#     "role": "sysadmin",
+#     "role_promotion": "admin",
+#     "activated": true,
+#     "shop_ids": [
+#         "7bf37141-20ed-537c-8aed-d1b1f1a23adc"
+#     ]
+# }
+#
+class SamplesController < ApplicationController
+  # Get all users. Must be an authenticated sysadmin.
+  # Only returns JSON responses. Pagination options are available.
+  #
+  # api_key - The api key
+  #
+  # Examples
+  #   GET /api/v2/users
+  #
+  # Returns an array of all users (field '''users''' in the JSON repsonse).
+  # Raises 401 if the current user is not authenticated.
+  # Raises 403 if the current user is not sysadmin.
+  # Raises 500 if an error occurs.
+  def index
+    puts "foobar"
+  end
+end

data/test/lib/api_tommy/github_test.rb

@@ -0,0 +1,49 @@
+require "test_helper"
+require "tmpdir"
+
+module ApiTommy
+  class GithubTest < ActiveSupport::TestCase
+    def setup
+      @g = Github.new
+    end
+
+    test "can extract wiki url" do
+      Grit::Repo.any_instance.expects(:config).returns(
+        "remote.origin.url" => "foobar.git"
+      )
+      assert_equal "foobar.wiki.git", @g.wiki_url
+    end
+
+    test "can clone a github wiki" do
+      Grit::Repo.any_instance.stubs(:config).returns(
+        "remote.origin.url" => "https://github.com/rails-api/rails-api.git"
+      )
+      Dir.mktmpdir("api_tommy") do |dir|
+        Grit::Git.any_instance.expects(:clone).with(
+          {},
+          "https://github.com/rails-api/rails-api.wiki.git",
+          dir
+        )
+        @g.clone_wiki(dir)
+      end
+    end
+
+    test "can update a file" do
+      filename = "foobar.txt"
+      Dir.mktmpdir("api_tommy") do |dir|
+        Dir.chdir(dir) { File.open(filename, "w") { |f| f.write("foo") } }
+        @g.update_file(dir, filename, "bar")
+        Dir.chdir(dir) { assert_equal "bar", File.read(filename) }
+      end
+    end
+
+    test "can push file" do
+      filename = "foobar.txt"
+      Dir.mktmpdir(["api_tommy", ".git"]) do |dir|
+        @g.update_file(dir, filename, "foo")
+        Grit::Git.any_instance.stubs(:push).with({}, "origin", "master")
+        @g.push(dir, filename)
+      end
+    end
+  end
+end

data/test/lib/api_tommy/markdown_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+
+module ApiTommy
+  class MarkdownTest < ActiveSupport::TestCase
+    def setup
+      @h = ApiTommy::Markdown
+    end
+
+    1.upto(6).each do |level|
+      test "can generate an h#{level} title" do
+        assert_equal "\n#{"#" * level} foobar\n", @h.send("h#{level}", "foobar")
+      end
+    end
+
+    test "can generate a paragraph" do
+      assert_equal "\nfoobar!\n", @h.p("foobar!")
+    end
+
+    test "can generate an unordered list item" do
+      assert_equal "* foobar\n", @h.ul("foobar")
+    end
+
+    test "can generate table headers" do
+      expected = "\n| foo | bar | foobar \n| --- | --- | --- \n"
+      assert_equal expected, @h.th("foo", "bar", "foobar")
+    end
+
+    test "can generate table values" do
+      assert_equal "| foo | bar | foobar \n", @h.tr("foo", "bar", "foobar")
+    end
+  end
+end

data/test/lib/rdoc/generator/api_tommy_test.rb

@@ -0,0 +1,95 @@
+require "test_helper"
+require "ostruct"
+require "optparse"
+
+module RDoc
+  module Generator
+    class ApiTommyTest < ActiveSupport::TestCase
+      test "rdoc should have registered the generator" do
+        assert_equal ApiTommy, RDoc::GENERATORS["apitommy"]
+      end
+
+      test "should set corret setup options" do
+        options = OpenStruct.new(
+          :dry_run => false,
+          :option_parser => OptionParser.new
+        )
+        ApiTommy.setup_options options
+        assert options.dry_run
+      end
+
+      test "accepts a filename option" do
+        options = Options.new
+        options.option_parser = OptionParser.new
+        ApiTommy.setup_options options
+        options.option_parser.parse(%w(--filename foobar.md))
+        assert_equal "foobar.md", options.filename
+      end
+
+      test "accepts a filename option with space" do
+        options = Options.new
+        options.option_parser = OptionParser.new
+        ApiTommy.setup_options options
+        options.option_parser.parse(["--filename", "foo bar.md"])
+        assert_equal "foo-bar.md", options.filename
+      end
+
+      test "accepts a filename option without md extension" do
+        options = Options.new
+        options.option_parser = OptionParser.new
+        ApiTommy.setup_options options
+        options.option_parser.parse(["--filename", "foobar"])
+        assert_equal "foobar.md", options.filename
+      end
+
+      test "accepts a header option" do
+        options = Options.new
+        options.option_parser = OptionParser.new
+        ApiTommy.setup_options options
+        options.option_parser.parse(["--header", "foobar.md"])
+        assert_equal "foobar.md", options.header
+      end
+
+      test "accepts a footer option" do
+        options = Options.new
+        options.option_parser = OptionParser.new
+        ApiTommy.setup_options options
+        options.option_parser.parse(["--footer", "foobar.md"])
+        assert_equal "foobar.md", options.footer
+      end
+
+      test "should correctly generate" do
+        rdoc = RDoc.new
+        options = rdoc.load_options
+        options.parse(%w(--format apitommy test/fixtures/samples_controller.rb))
+        ApiTommy.setup_options(options)
+        options.verbosity = 0
+        ::ApiTommy::Github.any_instance.stubs(:update_wiki)
+        rdoc.document(options)
+        assert rdoc.generator.content.include?("This API deals with user operations.")
+        assert rdoc.generator.content.include?("Get all users.")
+      end
+
+      test "should correctly generate with header and footer" do
+        rdoc = RDoc.new
+        options = rdoc.load_options
+        options.parse(%w(
+          --format apitommy
+          --header test/fixtures/header.md
+          --footer test/fixtures/footer.md
+          test/fixtures/samples_controller.rb
+        ))
+        ApiTommy.setup_options(options)
+        options.verbosity = 0
+        ::ApiTommy::Github.any_instance.stubs(:update_wiki)
+        rdoc.document(options)
+        assert rdoc.generator.content.include?("This is the header")
+        assert rdoc.generator.content.include?("This is the footer")
+      end
+    end
+
+    class ApiTommy
+      attr_accessor :options, :content
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require "simplecov"
+SimpleCov.start
+
+require "active_support"
+require "minitest/autorun"
+require "mocha/setup"
+require "pry"
+
+require "minitest/reporters"
+Minitest::Reporters.use!(Minitest::Reporters::DefaultReporter.new)
+
+ActiveSupport::TestCase.test_order = :random
+
+require "api_tommy"
+
+system('mkdir', '-p', 'doc')

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: api_tommy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- David Fernandez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: tomparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: grit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+description: This generator takes one or several classes with comments formatted in
+  TomDoc and spits out a single Markdown file
+email:
+- david.fernandez@gatemedia.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_tommy.gemspec
+- lib/api_tommy.rb
+- lib/api_tommy/error.rb
+- lib/api_tommy/generator.rb
+- lib/api_tommy/github.rb
+- lib/api_tommy/markdown.rb
+- lib/api_tommy/version.rb
+- lib/rdoc/discover.rb
+- lib/rdoc/generator/api_tommy.rb
+- test/fixtures/footer.md
+- test/fixtures/header.md
+- test/fixtures/samples_controller.rb
+- test/lib/api_tommy/github_test.rb
+- test/lib/api_tommy/markdown_test.rb
+- test/lib/rdoc/generator/api_tommy_test.rb
+- test/test_helper.rb
+homepage: https://github.com/gatemedia/api-tommy
+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.4.5
+signing_key: 
+specification_version: 4
+summary: An API documentation generator based on RDoc and TomDoc
+test_files:
+- test/fixtures/footer.md
+- test/fixtures/header.md
+- test/fixtures/samples_controller.rb
+- test/lib/api_tommy/github_test.rb
+- test/lib/api_tommy/markdown_test.rb
+- test/lib/rdoc/generator/api_tommy_test.rb
+- test/test_helper.rb