manual 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 07a4a65bed75d07a5938ad4b1f83d2b2bcf3328796adfa76ba772763358451f0
4
+ data.tar.gz: 442b7ea8d583e5b28c9a7553ea2942d236a24efe631bc318abe2ba0f9843c30e
5
+ SHA512:
6
+ metadata.gz: d7d72add3ba99796022d787128249e3bf72c75a7f2cd616bf08099b16e845e7e011ba68ff8d55c1abb64b34fea60b011a64b4e9ea933e4ce1f41cd7afcc2ef44
7
+ data.tar.gz: 6840f63b42d7d593e99b98381ce30f2dfe8f9caf302c1f5a4b999bc4a8a5736b33cf5e7bce42a2b5cf2f9f728d255541fa2e14bcf12e6fce7066f69368fded6c
data/.gitignore ADDED
@@ -0,0 +1,11 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/CHANGELOG.md ADDED
File without changes
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in manual.gemspec
4
+ gemspec
5
+
6
+ gem "rake", "~> 12.0"
7
+ gem "rspec", "~> 3.0"
data/Gemfile.lock ADDED
@@ -0,0 +1,34 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ manual (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ diff-lcs (1.3)
10
+ rake (12.3.3)
11
+ rspec (3.9.0)
12
+ rspec-core (~> 3.9.0)
13
+ rspec-expectations (~> 3.9.0)
14
+ rspec-mocks (~> 3.9.0)
15
+ rspec-core (3.9.2)
16
+ rspec-support (~> 3.9.3)
17
+ rspec-expectations (3.9.1)
18
+ diff-lcs (>= 1.2.0, < 2.0)
19
+ rspec-support (~> 3.9.0)
20
+ rspec-mocks (3.9.1)
21
+ diff-lcs (>= 1.2.0, < 2.0)
22
+ rspec-support (~> 3.9.0)
23
+ rspec-support (3.9.3)
24
+
25
+ PLATFORMS
26
+ ruby
27
+
28
+ DEPENDENCIES
29
+ manual!
30
+ rake (~> 12.0)
31
+ rspec (~> 3.0)
32
+
33
+ BUNDLED WITH
34
+ 2.1.4
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2020 Pierre-Arnaud Baciocchini
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,59 @@
1
+ # Manual
2
+
3
+ Automatic controller documentation using rspec
4
+ - No specific DSL
5
+ - No bloated controllers
6
+ - Always in sync with the tests
7
+ - Generates documentation in JSON and HTML for distribution
8
+
9
+ ## Installation
10
+
11
+ Add this line to your application's Gemfile:
12
+
13
+ ```ruby
14
+ gem 'manual'
15
+ ```
16
+
17
+ And then execute:
18
+
19
+ $ bundle install
20
+
21
+ Or install it yourself as:
22
+
23
+ $ gem install manual
24
+
25
+ ## Usage
26
+
27
+ ```ruby
28
+ RSpec.configure do |config|
29
+ Manual::Generator.setup(config)
30
+ end
31
+
32
+ # use `manual: :record` to add the example to the generated manual
33
+ RSpec.describe Api::V1::SessionsController, type: :controller do
34
+ describe "#create" do
35
+ it "responds with a 200 OK", manual: :record do
36
+ user = FactoryBot.create(:user)
37
+
38
+ post :create, params: { email: user.email, password: user.password }
39
+
40
+ expect(response.status).to eq(200)
41
+ end
42
+ end
43
+ end
44
+ ```
45
+
46
+ ## Development
47
+
48
+ After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
49
+
50
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
51
+
52
+ ## Contributing
53
+
54
+ Bug reports and pull requests are welcome on GitHub at https://github.com/prrrnd/manual.
55
+
56
+
57
+ ## License
58
+
59
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
data/Rakefile ADDED
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "manual"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/lib/manual.rb ADDED
@@ -0,0 +1,54 @@
1
+ require "manual/version"
2
+
3
+ module Manual
4
+ class Generator
5
+ class << self
6
+ def setup(config)
7
+ config.before(:all) do
8
+ Manual::Generator.init
9
+ end
10
+
11
+ config.after(:each, manual: :record) do |example|
12
+ Manual::Generator.record(example, self)
13
+ end
14
+
15
+ config.after(:all) do
16
+ Manual::Generator.render
17
+ end
18
+ end
19
+
20
+ def init
21
+ @pages = []
22
+ end
23
+
24
+ def render
25
+ path = Rails.root.join("manual")
26
+ Dir.mkdir(path) unless Dir.exists?(path)
27
+
28
+ File.open(path.join("index.json"), 'w') do |file|
29
+ file.write(@pages.to_json)
30
+ end
31
+ end
32
+
33
+ def record(example, context)
34
+ request = context.request
35
+ response = context.response
36
+
37
+ @pages << {
38
+ scenario: {
39
+ description: example.metadata[:description],
40
+ },
41
+ request: {
42
+ method: request.method,
43
+ path: request.path,
44
+ params: request.params
45
+ },
46
+ response: {
47
+ status: response.status,
48
+ body: JSON.parse(response.body)
49
+ }
50
+ }
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,3 @@
1
+ module Manual
2
+ VERSION = "0.1.0"
3
+ end
data/manual.gemspec ADDED
@@ -0,0 +1,29 @@
1
+ require_relative 'lib/manual/version'
2
+
3
+ Gem::Specification.new do |spec|
4
+ spec.name = "manual"
5
+ spec.version = Manual::VERSION
6
+ spec.authors = ["Pierre-Arnaud Baciocchini"]
7
+ spec.email = ["hello@baciocchini.com"]
8
+
9
+ spec.summary = "Automatic controller documentation using rspec"
10
+ spec.description = "Automatic controller documentation using rspec"
11
+ spec.homepage = "https://github.com/prrrnd/manual"
12
+ spec.license = "MIT"
13
+ spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
14
+
15
+ spec.metadata["allowed_push_host"] = "https://rubygems.org"
16
+
17
+ spec.metadata["homepage_uri"] = spec.homepage
18
+ spec.metadata["source_code_uri"] = spec.homepage
19
+ spec.metadata["changelog_uri"] = "https://github.com/prrrnd/manual/blob/master/CHANGELOG.md"
20
+
21
+ # Specify which files should be added to the gem when it is released.
22
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
23
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
24
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
25
+ end
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+ end
metadata ADDED
@@ -0,0 +1,60 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: manual
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Pierre-Arnaud Baciocchini
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2020-05-05 00:00:00.000000000 Z
12
+ dependencies: []
13
+ description: Automatic controller documentation using rspec
14
+ email:
15
+ - hello@baciocchini.com
16
+ executables: []
17
+ extensions: []
18
+ extra_rdoc_files: []
19
+ files:
20
+ - ".gitignore"
21
+ - ".rspec"
22
+ - CHANGELOG.md
23
+ - Gemfile
24
+ - Gemfile.lock
25
+ - LICENSE.txt
26
+ - README.md
27
+ - Rakefile
28
+ - bin/console
29
+ - bin/setup
30
+ - lib/manual.rb
31
+ - lib/manual/version.rb
32
+ - manual.gemspec
33
+ homepage: https://github.com/prrrnd/manual
34
+ licenses:
35
+ - MIT
36
+ metadata:
37
+ allowed_push_host: https://rubygems.org
38
+ homepage_uri: https://github.com/prrrnd/manual
39
+ source_code_uri: https://github.com/prrrnd/manual
40
+ changelog_uri: https://github.com/prrrnd/manual/blob/master/CHANGELOG.md
41
+ post_install_message:
42
+ rdoc_options: []
43
+ require_paths:
44
+ - lib
45
+ required_ruby_version: !ruby/object:Gem::Requirement
46
+ requirements:
47
+ - - ">="
48
+ - !ruby/object:Gem::Version
49
+ version: 2.3.0
50
+ required_rubygems_version: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - ">="
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ requirements: []
56
+ rubygems_version: 3.0.3
57
+ signing_key:
58
+ specification_version: 4
59
+ summary: Automatic controller documentation using rspec
60
+ test_files: []