minitest_apidoc 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c9526c1cad962bec6b662954fb434d38523b759
+  data.tar.gz: 591f9e60c2d776fed70620a7b9e7cdcdd1b62065
+SHA512:
+  metadata.gz: 514371eaf5ccf57c4e48507b45bc7bda70e575a3fb571f6fbb9b1cfadfd717fa8288053332144000d2e89f47131e5686ab0226c5c48633aa79b07fccf0834024
+  data.tar.gz: 395ebc533f727bb1dabc55b34680692fbd74feb073cfa7201ed1111805edaff729592b40496495af132b3ec3ccbd6b4dc05b3996b5518b4d41323792f8a66498

data/lib/minitest/api_doc_plugin.rb

@@ -0,0 +1,54 @@
+require_relative 'markdown'
+require_relative 'holder/test'
+require_relative 'document'
+require_relative 'test_case_extension'
+module Minitest
+  ActionController::TestCase.include TestCase::Extension
+
+  def self.plugin_api_doc_init(options)
+    Minitest.reporter << ApiDocReporter.new
+  end
+
+  def self.plugin_api_doc_options(opts, options)
+  end
+
+  class ApiDocReporter < AbstractReporter
+    attr_accessor :test_holders
+    def initialize
+      @test_holders = []
+    end
+
+    def record result
+      return unless  valid_for_doc? result
+      klass = result.class
+      holder =
+        find_holder(klass) ||
+        new_holder(klass, klass.test_class_desc)
+      holder.perform(result)
+    end
+
+    def report
+      Document.new(test_holders).print
+    end
+
+    private
+
+    def valid_for_doc? result
+      result.class < ActionController::TestCase &&
+        result.test_desc.present? &&
+        result.class.test_class_desc.present?
+    end
+
+    def find_holder klass
+      test_holders.find do |holder|
+        holder.klass == klass
+      end
+    end
+
+    def new_holder klass, klass_desc
+      Holder::Test.new(klass, klass_desc).tap do |h|
+        test_holders << h
+      end
+    end
+  end
+end

data/lib/minitest/document.rb

@@ -0,0 +1,29 @@
+class Document
+  attr_accessor :holders, :md
+  def initialize holders
+    self.holders = holders
+  end
+  def print
+    # TODO italic markdown
+    File.open("api_documentation.md", "wt") do |f|
+      @md = Markdown.new
+      holders.each do |holder|
+       f.puts md.header(holder.klass_desc)
+       holder.units.each do |unit|
+         f.puts md.sub_header unit.name
+         f.puts md.default(unit.test_desc)
+         f.puts md.sub_sub_header unit.path_title
+         f.puts md.italic unit.path
+         f.puts md.sub_sub_header unit.method_title
+         f.puts md.italic unit.method
+         f.puts md.sub_sub_header unit.params_title
+         f.puts md.code unit.params
+         f.puts md.sub_sub_header unit.body_title
+         f.puts md.code(unit.body)
+         f.puts md.sub_sub_header unit.status_title
+         f.puts md.italic unit.status
+       end
+      end
+    end
+  end
+end

data/lib/minitest/holder/test.rb

@@ -0,0 +1,79 @@
+module Holder
+  class Test
+    attr_accessor :klass, :klass_desc, :units
+    def initialize klass, klass_desc
+      Markdown
+      @klass = klass
+      @klass_desc = klass_desc
+      @units = []
+    end
+
+    def perform result
+      units << Unit.new(result).tap(&:perform )
+    end
+  end
+  class Unit
+    attr_accessor :test_desc, :result, :path, :method, :params,
+                  :body, :status, :header, :name
+    def initialize result
+      @result = result
+    end
+
+    def perform
+      self.name = humanize_name
+      @test_desc = result.test_desc
+      hold_request
+      hold_response
+    end
+
+    def params
+     @params.presence || {}
+    end
+
+    def body
+      @body.presence || {}
+    end
+
+    def path_title
+     'path' 
+    end
+
+    def method_title
+      'method'
+    end
+
+    def params_title
+      'parameter'
+    end
+
+    def status_title
+      'status'
+    end
+
+    def body_title
+      'body'
+    end
+
+    private
+
+    def hold_request
+      request = result.request
+      self.path = request.path
+      self.method = request.method
+      self.params = request.env["action_dispatch.request.request_parameters"].presence ||
+                    request.env["action_dispatch.request.query_parameters"].presence
+    end
+
+    def hold_response
+      response = result.response
+      self.body = response.body
+      self.status = response.status
+      self.header = response.header['Content-Type']
+    end
+
+    def humanize_name
+      result.name.sub('test_', '').humanize
+    end
+  end
+end
+

data/lib/minitest/markdown.rb

@@ -0,0 +1,32 @@
+class Markdown
+  def header text
+    '# ' + text
+  end
+
+  def sub_header text
+    '## ' + text
+  end
+
+  def sub_sub_header text
+    '### ' + text
+  end
+  
+  def default text
+    text
+  end
+
+  def next_line
+    ''
+  end
+
+  def code text
+    text = text.is_a?(Hash) ? text : eval(text.gsub('null', 'nil'))
+    "```json \n " +
+    JSON.pretty_generate(text) + "\n" +
+    "```"
+  end
+
+  def italic text
+    "*#{text}*"
+  end
+end

data/lib/minitest/test_case_extension.rb

@@ -0,0 +1,33 @@
+module TestCase
+  module Extension
+    def self.included base
+      def base.inherited subclass
+        super subclass
+        subclass.extend ClassMethods
+        subclass.include InstanceMethods
+      end
+    end
+
+    module ClassMethods
+      def desc description
+         @test_class_desc = description
+      end
+
+      def test_class_desc
+        @test_class_desc
+      end
+
+    end
+
+    module InstanceMethods
+      extend ActiveSupport::Concern
+      included do
+        attr_reader :test_desc
+      end
+
+      def desc description
+        @test_desc = description
+      end
+    end
+  end
+end

data/lib/minitest_apidoc.rb

@@ -0,0 +1,13 @@
+require_relative 'minitest/test_case_extension'
+require_relative 'minitest/api_doc_plugin'
+class MinitestApidoc
+  VERSION = '0.0.0'.freeze
+
+  def self.version
+    VERSION
+  end
+
+  def self.hello
+    'hello world'
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: minitest_apidoc
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Alexander Ibrahim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-12 00:00:00.000000000 Z
+dependencies: []
+description: simple api documentation of minitest
+email: alxibra@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/minitest/api_doc_plugin.rb
+- lib/minitest/document.rb
+- lib/minitest/holder/test.rb
+- lib/minitest/markdown.rb
+- lib/minitest/test_case_extension.rb
+- lib/minitest_apidoc.rb
+homepage: http://rubygems.org/gems/hola
+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.2
+signing_key: 
+specification_version: 4
+summary: simple api documentation of minitest
+test_files: []