rspec-doc 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a57e71c3a1595c2d603e7d846e5f6e1e06e4595f
+  data.tar.gz: 36c009ccd18465d73e1ffa3036f6db8a732abb10
+SHA512:
+  metadata.gz: 01476cee7c922208940fdbcea7ee7532a9f7ba8734d3ba0f49d08d22dd8a658d0a6aefec1a36f03c22f5d4db117788c73d9d9c90998902c009ba2ec404c124a2
+  data.tar.gz: 360baa78dbd0963c4aff3db91abcd31f37169eeb2e5a417dc481e3f57aa4d79933770e4d78bf7cd7c6b145faaea02a61563b77c5286669a4ce09bd43b4b06d33

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/bin/rspecdoc

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+require 'rspec-doc'
+
+USAGE = 'usage: rspecdoc build_models' 
+
+if not File.exist?('database_config.yml')
+  puts 'need database_config.yml'
+  exit
+end
+
+if ARGV.size < 1 || ARGV[1] != 'build_models'
+  puts USAGE
+  exit 
+end
+
+RSpecDoc::ModelBuilder.build_models
+

data/lib/rspec-doc.rb

@@ -0,0 +1,8 @@
+class RSpecDoc
+end
+
+require 'rspec-doc/model_builder'
+require 'rspec-doc/markdown_formatter'
+require 'rspec-doc/markdown_util'
+require 'rspec-doc/rest_client'
+require 'rspec-doc/active_record'

data/lib/rspec-doc/active_record.rb

@@ -0,0 +1,71 @@
+require 'active_record'
+require_relative 'markdown_util'
+
+module RSpecDoc::ActiveRecord  
+  def self.describe(example, model, &block)
+    model_name = model.to_s
+    id = ''
+    if model.is_a?(ActiveRecord::Base)
+      model_name = "#{model.class.table_name}"
+      id = "[id=#{model.id}]"
+    end
+
+    db_assertion_md = make_db_assertion_md(block.source)
+    return unless db_assertion_md
+
+    example.metadata[:md_doc] ||= {}
+    example.metadata[:md_doc][:database_assertion] ||= []
+    example.metadata[:md_doc][:database_assertion].concat(
+      ["**#{model_name}**#{id}", db_assertion_md]
+    )
+
+    block.call
+  end
+
+private
+  EQUAL_MATCHERS = ['eq', 'eql', 'equal', 'be']
+
+  def self.is_symbol(is)
+    return is ? '==' : '!='
+  end
+
+  def self.is_string(is)
+    return is ? '' : 'does not'
+  end
+
+  def self.matcher_name(is, matcher)
+    return self.is_symbol(is) if EQUAL_MATCHERS.include? matcher   
+
+    "#{self.is_string(is)} #{matcher}"
+  end
+
+  def self.make_db_assertion_md(expectation_source)
+    expectation_source = expectation_source.lstrip
+    # get the target obj name 
+    /^DocDB\.describe[\(\s+]example,\s+(?<model>.*)[\)\s+]do/ =~ expectation_source
+    return nil unless model
+    
+    model.chomp!(')')    
+    items = []
+    # select the target obj item 
+    expectation_source.gsub!(model, 'model')
+    expectation_source.gsub!('be_', 'be ')
+    expectation_items = expectation_source.lines do |line| 
+      key, matcher, value = nil
+      /expect\(model\.(?<key>.*)\)\.(?<is>to|not_to)[\s+\(](?<matcher>.*)[\s+\(](?<value>.*)[\,\)\s+\n]/ =~ "#{line.strip}\n"
+      next unless key && is && matcher && value
+      
+      value = value.strip.chomp(')' * (value.count(')') - value.count('('))) # remove tailing extra ')'
+      begin
+        value = eval(value).inspect
+      rescue => exception
+        value = "`#{value}`"
+      end
+
+      items << [key.strip, "#{matcher_name(is == 'to', matcher.strip)}", value]
+    end
+
+    # build markdown table 
+    MarkdownUtil.table(['Column', 'Assertion', 'Value'], items)
+  end 
+end

data/lib/rspec-doc/markdown_formatter.rb

@@ -0,0 +1,165 @@
+require 'rspec'
+
+class RSpecDoc::MarkdownFormatter
+  RSpec::Core::Formatters.register self, :example_group_started, :example_group_finished, :example_finished,
+                      :example_passed, :example_pending, :example_failed, :message, :dump_failures,
+                      :dump_summary, :dump_summary, :dump_pending, :seed
+
+  # All formatters inheriting from this formatter will receive these
+  # notifications.
+  attr_accessor :example_group
+  attr_reader :output
+
+  # @api public
+  # @param output [IO] the formatter output
+  # @see RSpec::Core::Formatters::Protocol#initialize
+  def initialize(output)
+    @output = output || StringIO.new
+    @example_group = nil
+    @group_level = 0    
+  end
+
+  # @api public
+  #
+  # @param notification [StartNotification]
+  # @see RSpec::Core::Formatters::Protocol#start
+  def start(notification)
+    start_sync_output
+    @example_count = notification.count
+  end
+
+  # @api public
+  #
+  # @param _notification [NullNotification] (Ignored)
+  # @see RSpec::Core::Formatters::Protocol#close
+  def close(_notification)
+    return if output.closed?
+
+    output.puts
+
+    output.flush
+  end
+
+  # @api public
+  #
+  # Used by the reporter to send messages to the output stream.
+  #
+  # @param notification [MessageNotification] containing message
+  def message(notification)
+    output.puts "#{space_indentation}#{notification.message}"
+  end
+
+  # @api public
+  #
+  # Dumps detailed information about each example failure.
+  #
+  # @param notification [NullNotification]
+  def dump_failures(notification)
+    return if notification.failure_notifications.empty?
+    output.puts notification.fully_formatted_failed_examples
+  end
+
+  # @api public
+  #
+  # This method is invoked after the dumping of examples and failures.
+  # Each parameter is assigned to a corresponding attribute.
+  #
+  # @param summary [SummaryNotification] containing duration,
+  #   example_count, failure_count and pending_count
+  def dump_summary(summary)
+    output.puts summary.fully_formatted
+  end
+
+  # @private
+  def dump_pending(notification)
+    return if notification.pending_examples.empty?
+    output.puts notification.fully_formatted_pending_examples
+  end
+
+  # @private
+  def seed(notification)
+    return unless notification.seed_used?
+    output.puts notification.fully_formatted
+  end
+
+  def example_group_started(notification)
+    output.puts if @group_level == 0
+    output.puts "#{current_indentation}#{notification.group.description.strip}"
+    @group_level += 1
+  end
+
+  def example_group_finished(_notification)
+    @group_level -= 1 if @group_level > 0    
+  end
+
+  def example_finished(notification)
+  end
+
+  def output_doc(example)
+    return unless example.metadata[:md_doc].is_a? Hash
+    output.puts
+    example.metadata[:md_doc].each do |key, items|
+      output.puts "  #{space_indentation}#### #{key.to_s.split('_').map(&:capitalize).join(' ')}"
+      items.each do |item| 
+        output.puts
+        item.each_line { |line| output.puts "  #{space_indentation}#{line}" }
+      end
+    end
+    example.metadata[:md_doc] = {}
+  end
+
+  def example_passed(passed)
+    output.puts passed_output(passed.example)
+    output_doc(passed.example)
+  end
+
+  def example_pending(pending)
+    output.puts pending_output(pending.example,
+                              pending.example.execution_result.pending_message)
+    output_doc(pending.example)
+  end
+
+  def example_failed(failure)
+    output.puts failure_output(failure.example)
+    output_doc(failure.example)
+  end
+
+private
+
+  def start_sync_output
+    @old_sync, output.sync = output.sync, true if output_supports_sync
+  end
+
+  def output_supports_sync
+    output.respond_to?(:sync=)
+  end
+
+  def passed_output(example)
+    "#{current_indentation}#{example.description.strip}"
+  end
+
+  def pending_output(example, message)
+    "#{current_indentation}#{example.description.strip} \n(PENDING: #{message})"
+  end
+
+  def failure_output(example)
+    "#{current_indentation}#{example.description.strip} \n(FAILED - #{next_failure_index})"
+  end
+
+  def next_failure_index
+    @next_failure_index ||= 0
+    @next_failure_index += 1
+  end
+
+  def current_indentation
+    return "\n## " if @group_level == 0
+    return "\n### " if @group_level == 1
+
+    space_indentation << '- '
+  end
+
+  def space_indentation
+    return '' if @group_level < 1
+    '  ' * (@group_level - 1)
+  end
+end

data/lib/rspec-doc/markdown_util.rb

@@ -0,0 +1,50 @@
+require 'json'
+
+module RSpecDoc::MarkdownUtil
+  def self.table(header, body)
+    return '' unless header.is_a?(Enumerable) and body.is_a?(Enumerable)
+
+    header_line = "| #{header.join(' | ')} |"
+    direction_line = "| #{':--- |' * header.size}"
+    [header_line, direction_line]
+      .concat(body.map { |item| "| #{item.join(' | ')} |" })
+      .join("\n")
+  end
+
+  def self.kv_table(kv, params = {})
+    return '' unless kv
+
+    kv = JSON.parse(kv) if kv.is_a? String
+    items = []
+    kv.each do |key, value|
+      next unless value
+
+      value = value.map { |k, v| "#{k}: #{v}" }.join("\n") if value.is_a? Hash
+      value = value.join("\n") if value.is_a? Enumerable
+      key = params[:key_formatter].call(key) if params[:key_formatter].is_a? Proc
+      items << [key, value]
+    end
+
+    return '' if items.size == 0 
+
+    self.table(['Key', 'Value'], items)
+  end
+
+  def self.http_headers_table(kv)
+    formatter = -> (k) { k.to_s.split('_').map(&:capitalize).join('-') }
+    self.kv_table(kv, {key_formatter: formatter})
+  end
+
+  def self.code_block(type, body)
+    [
+      "```#{type.to_s}",
+      body,
+      '```'
+    ].join("\n")
+  end
+
+  def self.json_block(h)
+    h = JSON.parse(h) if h.is_a? String
+    self.code_block(:json, JSON.pretty_generate(h))
+  end
+end

data/lib/rspec-doc/model_builder.rb

@@ -0,0 +1,49 @@
+require 'fileutils'
+require 'yaml'
+require 'erb'
+
+require 'rare_map'
+require 'active_record' 
+
+module RareMap
+  # RareMap::SchemaParser parses schema.rb into Table.
+  module SchemaParser
+    # Parses schema.rb into an Array of Table.
+    #
+    # @return [Array] an Array of Table
+    def parse_schema(schema)
+      tables = []
+      
+      schema.split(/\n/).each do |line|
+        case line.strip!
+        when /^create_table/
+          name = line.match(/create_table\s+['"]([^'"]+)['"]/)[1]
+          id = line.match(/(:id\s*=>|id:)\s*false/) ? false : true
+          pk = line.match(/(:primary_key\s*=>|primary_key:)\s*['"](.+)['"]/)
+          primary_key = pk[2] if pk
+          tables << RareMap::Table.new(name, :id => id, :primary_key => primary_key)
+        when /^t\.index/
+          unique_column_math = line.match(/t\.index\s+.*\[\s*['"]([^'"]+)['"]\s*\].*(:unique\s*=>|unique:)\s*true/)
+          next if !unique_column_math || unique_column_math.size < 2
+          unique_column = unique_column_math[1] 
+          column = tables.last.columns.find { |col| col.name == unique_column }
+          column.unique = true
+        when /^t\./
+          name = line.match(/t\.\w+\s+['"]([^'"]+)['"]/)[1]
+          type = line.match(/t\.(\w+)\s+/)[1]
+          tables.last.columns << RareMap::Column.new(name, type)
+        end
+      end
+      
+      tables
+    end
+  end
+end
+
+module RSpecDoc::ModelBuilder
+  def self.build_models
+    config = ERB.new(File.read('database_config.yml')).result
+    File.open('rare_map.yml', 'w') { |file| file.write(config) }
+    RareMap.mapping
+  end
+end

data/lib/rspec-doc/rest_client.rb

@@ -0,0 +1,62 @@
+require 'active_record'
+require 'rest-client'
+require_relative 'markdown_util'
+
+module RSpecDoc::RestClient
+  def self.get(example, url, headers={}) 
+    example.metadata[:md_doc] ||= {}
+    resp = RestClient.get(url, headers)    
+    example.metadata[:md_doc][:api_request] = self.make_api_request_md({
+      method: :get,
+      url: url,
+      headers: headers,
+      response: resp 
+    })
+    resp
+  end
+
+  def self.post(example, url, payload, headers={})
+    example.metadata[:md_doc] ||= {}
+    resp = RestClient.post(url, payload, headers)    
+    example.metadata[:md_doc][:api_request] = self.make_api_request_md({
+      method: :post,
+      url: url,
+      payload: payload,
+      headers: headers, 
+      response: resp 
+    })
+    resp
+  end
+
+private
+  def self.make_api_request_md(params = {})
+    lines = []
+    lines << "#{params[:method].to_s.upcase} #{params[:url]}"
+
+    if params[:headers][:params]
+      lines << "**Query String Parameters**" 
+      lines << MarkdownUtil.kv_table(params[:headers][:params])
+    end
+
+    params[:headers].delete(:params)
+    if params[:headers].size > 0
+      lines << "**Request Headers**" 
+      lines << MarkdownUtil.http_headers_table(params[:headers])
+    end
+
+    if params[:payload]
+      lines << "**Request Body**" 
+      lines << MarkdownUtil.json_block(params[:payload])
+    end
+
+    lines << "**Response Headers**"
+    lines << MarkdownUtil.http_headers_table(params[:response].headers)
+
+    if params[:response].headers[:content_type].to_s.include? 'json'
+      lines << "**Response Body**"
+      lines << MarkdownUtil.json_block(params[:response].body)
+    end
+    
+    lines
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: rspec-doc
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Focinfi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.4
+- !ruby/object:Gem::Dependency
+  name: rare_map
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.2
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+description: Make markdown for rspec
+email: focinfi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- bin/rspecdoc
+- lib/rspec-doc.rb
+- lib/rspec-doc/active_record.rb
+- lib/rspec-doc/markdown_formatter.rb
+- lib/rspec-doc/markdown_util.rb
+- lib/rspec-doc/model_builder.rb
+- lib/rspec-doc/rest_client.rb
+homepage: https://github.com/Focinfi/rspec-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.5.1
+signing_key: 
+specification_version: 4
+summary: rspec-doc
+test_files: []