manual 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 07a4a65bed75d07a5938ad4b1f83d2b2bcf3328796adfa76ba772763358451f0
+  data.tar.gz: 442b7ea8d583e5b28c9a7553ea2942d236a24efe631bc318abe2ba0f9843c30e
+SHA512:
+  metadata.gz: d7d72add3ba99796022d787128249e3bf72c75a7f2cd616bf08099b16e845e7e011ba68ff8d55c1abb64b34fea60b011a64b4e9ea933e4ce1f41cd7afcc2ef44
+  data.tar.gz: 6840f63b42d7d593e99b98381ce30f2dfe8f9caf302c1f5a4b999bc4a8a5736b33cf5e7bce42a2b5cf2f9f728d255541fa2e14bcf12e6fce7066f69368fded6c

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in manual.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    manual (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  manual!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Pierre-Arnaud Baciocchini
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,59 @@
+# Manual
+
+Automatic controller documentation using rspec
+- No specific DSL
+- No bloated controllers
+- Always in sync with the tests
+- Generates documentation in JSON and HTML for distribution
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'manual'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install manual
+
+## Usage
+
+```ruby
+RSpec.configure do |config|
+  Manual::Generator.setup(config)
+end
+
+# use `manual: :record` to add the example to the generated manual
+RSpec.describe Api::V1::SessionsController, type: :controller do
+  describe "#create" do
+    it "responds with a 200 OK", manual: :record do
+      user = FactoryBot.create(:user)
+
+      post :create, params: { email: user.email, password: user.password }
+
+      expect(response.status).to eq(200)
+    end
+  end
+end
+```
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/prrrnd/manual.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "manual"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/manual.rb

@@ -0,0 +1,54 @@
+require "manual/version"
+
+module Manual
+  class Generator
+    class << self
+      def setup(config)
+        config.before(:all) do
+          Manual::Generator.init
+        end
+
+        config.after(:each, manual: :record) do |example|
+          Manual::Generator.record(example, self)
+        end
+
+        config.after(:all) do
+          Manual::Generator.render
+        end
+      end
+
+      def init
+        @pages = []
+      end
+
+      def render
+        path = Rails.root.join("manual")
+        Dir.mkdir(path) unless Dir.exists?(path)
+
+        File.open(path.join("index.json"), 'w') do |file|
+          file.write(@pages.to_json)
+        end
+      end
+
+      def record(example, context)
+        request = context.request
+        response = context.response
+
+        @pages << {
+          scenario: {
+            description: example.metadata[:description],
+          },
+          request: {
+            method: request.method,
+            path: request.path,
+            params: request.params
+          },
+          response: {
+            status: response.status,
+            body: JSON.parse(response.body)
+          }
+        }
+      end
+    end
+  end
+end

data/lib/manual/version.rb

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

data/manual.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/manual/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "manual"
+  spec.version       = Manual::VERSION
+  spec.authors       = ["Pierre-Arnaud Baciocchini"]
+  spec.email         = ["hello@baciocchini.com"]
+
+  spec.summary       = "Automatic controller documentation using rspec"
+  spec.description   = "Automatic controller documentation using rspec"
+  spec.homepage      = "https://github.com/prrrnd/manual"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/prrrnd/manual/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: manual
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pierre-Arnaud Baciocchini
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-05 00:00:00.000000000 Z
+dependencies: []
+description: Automatic controller documentation using rspec
+email:
+- hello@baciocchini.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/manual.rb
+- lib/manual/version.rb
+- manual.gemspec
+homepage: https://github.com/prrrnd/manual
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/prrrnd/manual
+  source_code_uri: https://github.com/prrrnd/manual
+  changelog_uri: https://github.com/prrrnd/manual/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Automatic controller documentation using rspec
+test_files: []