crapidocs 0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/lib/crapidocs.rb +55 -0
- metadata +44 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: b995140375b7d77b964c283f94f807214ff86e39
|
4
|
+
data.tar.gz: ff4721f9536bb7060a2b995ce38a408af25faaa3
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 86e217248f99650808772dda6d324313d50f1e03f47919a25480f88c668b5e68b4c6f132354a0c362505bf060522c7608956025e935164900a831116e0ce2f72
|
7
|
+
data.tar.gz: 3835c184c6e0e75dbd35eb828e924b8307d9c04ae60ace13e485aa94c9964d9b067f54eda76a0ee37afca7a15b20d1857e5545a14f128e23de4d10afe52e0864
|
data/lib/crapidocs.rb
ADDED
@@ -0,0 +1,55 @@
|
|
1
|
+
require 'rack/test'
|
2
|
+
require 'active_support/all'
|
3
|
+
|
4
|
+
require_relative 'crapidocs/formatter'
|
5
|
+
require_relative 'crapidocs/session'
|
6
|
+
|
7
|
+
module Rack
|
8
|
+
class MockSession
|
9
|
+
method = instance_method(:request)
|
10
|
+
define_method(:request) do |*args, &block|
|
11
|
+
result = method.bind(self).call(*args, &block)
|
12
|
+
CrapiDocs.session.track(args, result)
|
13
|
+
result
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
module CrapiDocs
|
19
|
+
VERSION = [0, 1]
|
20
|
+
TEMPLATE_DIR = File.expand_path('../..', __FILE__) + '/templates'
|
21
|
+
|
22
|
+
class << self
|
23
|
+
attr_reader :session
|
24
|
+
|
25
|
+
def version
|
26
|
+
VERSION.join('.')
|
27
|
+
end
|
28
|
+
|
29
|
+
def start(pattern, target = './doc/api.md')
|
30
|
+
@session = Session.new(pattern)
|
31
|
+
@target = target
|
32
|
+
end
|
33
|
+
|
34
|
+
def purge
|
35
|
+
@session = nil
|
36
|
+
end
|
37
|
+
|
38
|
+
def on?
|
39
|
+
@session.present?
|
40
|
+
end
|
41
|
+
|
42
|
+
def done
|
43
|
+
formatter = Formatter.new(@session)
|
44
|
+
write_file(formatter.to_md)
|
45
|
+
end
|
46
|
+
|
47
|
+
private
|
48
|
+
|
49
|
+
def write_file(data)
|
50
|
+
File.open(@target, 'w').write(data)
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
at_exit { CrapiDocs.done if CrapiDocs.on? }
|
metadata
ADDED
@@ -0,0 +1,44 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: crapidocs
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: '0.1'
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Mike Holly
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-12-15 00:00:00.000000000 Z
|
12
|
+
dependencies: []
|
13
|
+
description: Generate decent API documentation from RSpec API tests.
|
14
|
+
email: mikejholly@gmail.com
|
15
|
+
executables: []
|
16
|
+
extensions: []
|
17
|
+
extra_rdoc_files: []
|
18
|
+
files:
|
19
|
+
- lib/crapidocs.rb
|
20
|
+
homepage: https://rubygems.org/gems/crapidocs
|
21
|
+
licenses:
|
22
|
+
- MIT
|
23
|
+
metadata: {}
|
24
|
+
post_install_message:
|
25
|
+
rdoc_options: []
|
26
|
+
require_paths:
|
27
|
+
- lib
|
28
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
29
|
+
requirements:
|
30
|
+
- - ">="
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: '0'
|
33
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
34
|
+
requirements:
|
35
|
+
- - ">="
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '0'
|
38
|
+
requirements: []
|
39
|
+
rubyforge_project:
|
40
|
+
rubygems_version: 2.2.2
|
41
|
+
signing_key:
|
42
|
+
specification_version: 4
|
43
|
+
summary: Crazy Rspec API Docs
|
44
|
+
test_files: []
|