rspec_generate_doc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 151a44bdc19b4f05be2693d500dc376624997f7e
+  data.tar.gz: 5db6ea344c7926fc7dc3f54fb861c9482f3049ea
+SHA512:
+  metadata.gz: ac4326fb9b2e8175785e00f7a72d98cc3232fc9099561ec96a83f34c8ff5edb20ec1684843243a9e1ab87656f38796f08d3af755efdf732310947217264a8edc
+  data.tar.gz: 372ae220dc82d9276655f28abf9133afdf91313b48598c0f03dc9d8eac1a251fb402465f786ef9687ec821fb98fcd71264d35fba7929d73bb4ce4374ede03b1d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at djok69@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+=====================
+
+Copyright (c) 2016 Igor Kutyavin aka Jokius
+
+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,78 @@
+Rspec generate doc
+===
+
+This gem help you to generate simple documentation api from Rspec tests.
+
+Installation
+============
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec_generate_doc'
+```
+
+And then execute:
+
+    $ bundle
+
+Usage
+=====
+
+**Configure**
+``` ruby
+# spec/rails_helper.rb
+...
+require 'rspec_generate_doc'
+..
+RspecGenerateDoc.configure do |config|
+  config.docs_dir = 'path/to/docs/dir' # default: "#{Rails.root}/docs"
+  config.locale = :ru # default: I18n.default_locale
+end
+```
+
+Example use
+
+``` ruby
+# spec/controllers/user_controller_spec.rb
+...
+let(:params) do
+  {
+    id: { description: 'user id', required: true },
+    email: { description: 'user email', required: false }
+  }
+end
+...
+```
+*keys description:*
+id | email - parameter in result
+description - description parameter. Default parent key name
+required - is parameter required? Default false
+
+**result**
+
+After tests completed file *_user_controller.md* will be created in docs folder.  In format to Slate
+
+Copyright
+=========
+
+Copyright (c) 2016 Igor Kutyavin aka Jokius
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rspec_generate_doc"
+
+# 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

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/config/locales/en.yml

@@ -0,0 +1,7 @@
+en:
+  rspec_api_docs:
+    parameter: Parameter
+    required: Required
+    description: Description
+    required_yes: Yes
+    required_no: No

data/config/locales/ru.yml

@@ -0,0 +1,7 @@
+ru:
+  rspec_api_docs:
+    parameter: Параметр
+    required: Обязательный
+    description: Описание
+    required_yes: Да
+    required_no: Нет

data/lib/rspec_generate_doc/configuration.rb

@@ -0,0 +1,21 @@
+require 'fileutils'
+
+module RspecGenerateDoc
+  class Configuration
+    def docs_dir
+      @docs_dir || "#{Rails.root}/docs"
+    end
+
+    def docs_dir=(dir)
+      @docs_dir = dir
+    end
+
+    def locale
+      @locale || I18n.default_locale
+    end
+
+    def locale=(locale)
+      @locale = locale
+    end
+  end
+end

data/lib/rspec_generate_doc/generate.rb

@@ -0,0 +1,77 @@
+require 'fileutils'
+
+module RspecGenerateDoc
+  class Genarate
+    attr_reader :parent, :methods_hash
+
+    def initialize(parent, methods_hash)
+      @parent = parent
+      @methods_hash = methods_hash
+      I18n.locale = RspecGenerateDoc.configuration.locale
+      create_file
+    end
+
+    private
+
+    def dir
+      @dir ||= FileUtils.mkdir_p(RspecGenerateDoc.configuration.docs_dir).join('')
+    end
+
+    def create_file
+      file = File.open("#{dir}/_#{parent_name}.md", 'w+')
+      file.write file_text
+      file.close
+    end
+
+    def parent_name
+      @parent_name ||= parent.downcase.split('::').join('_')
+    end
+
+    def file_text
+      file_text = "# #{parent}\r\n\r\n"
+      methods_hash.each do |key, method|
+        response = method[:response]
+        request = response.request
+        file_text += "##{key.split('#').join(' ')}\r\n\r\n"\
+                  "```http\r\n"\
+                  "#{request.request_method} #{request.original_fullpath.split('?').first} HTTP/1.1\r\n"\
+                  "Host: #{response.request.host}\r\n"\
+                  "User-Agent: ExampleClient/1.0.0\r\n"\
+                  "```\r\n\r\n"\
+                  "```http\r\n"\
+                  "HTTP/1.1 #{response.status} #{response.status_message}\r\n"
+        file_text += "Content-Type: #{response.content_type}\r\n\r\n" if response.content_type.present?
+        if response.body.present?
+          object = begin
+                     JSON.parse(response.body)
+                   rescue
+                     nil
+                   end
+          body = object.nil? ? response.body : JSON.pretty_generate(object)
+          file_text += "#{body}\r\n" if response.body.present?
+        end
+
+        file_text += "```\r\n\r\n"\
+                  "#{I18n.t(:parameter, scope: :rspec_api_docs)} | #{I18n.t(:required, scope: :rspec_api_docs)} | #{I18n.t(:description, scope: :rspec_api_docs)}\r\n"\
+                  "-------- | ------- | -------\r\n"
+        file_text += params_to_text(request, method[:params])
+        file_text += "\r\n\r\n"
+      end
+
+      file_text
+    end
+
+    def params_to_text(request, params)
+      file_text = ''
+      request.params.except(*%i(controller action format)).each do |name, _|
+        hash = params[name.to_sym] || {}
+        hash = {} unless hash.is_a? Hash
+        required = hash[:required] ? I18n.t(:required_yes, scope: :rspec_api_docs) : I18n.t(:required_no, scope: :rspec_api_docs)
+        description = hash[:description] || name
+        file_text += "#{name} | #{required} | #{description}\r\n"
+      end
+
+      file_text
+    end
+  end
+end

data/lib/rspec_generate_doc/library_hooks/doc.rb

@@ -0,0 +1,30 @@
+require 'rspec/rails'
+require 'rspec_generate_doc/generate'
+
+module RspecGenerateDoc
+  module LibraryHooks
+    module Doc
+      ::RSpec.configure do |config|
+        config.before(:context) do
+          @hash = {}
+        end
+
+        config.after(:each) do
+          key = self.class.description
+          parent = self.class.parent
+          loop do
+            break if parent.nil? || parent.description == self.class.top_level_description
+            key = "#{parent.description} #{key}"
+            parent = parent.parent
+          end
+
+          @hash[key] ||= { response: response, params: (try(:params) || @params || {}) }
+        end
+
+        config.after(:context) do
+          RspecGenerateDoc::Genarate.new(self.class.top_level_description, @hash)
+        end
+      end
+    end
+  end
+end

data/lib/rspec_generate_doc/version.rb

@@ -0,0 +1,3 @@
+module RspecGenerateDoc
+  VERSION = '0.1.0'
+end

data/lib/rspec_generate_doc.rb

@@ -0,0 +1,21 @@
+require 'rspec/rails'
+require 'rspec_generate_doc/version'
+require 'rspec_generate_doc/configuration'
+require 'rspec_generate_doc/library_hooks/doc'
+require 'rspec_generate_doc/generate'
+
+module RspecGenerateDoc
+  I18n.load_path.concat Dir[File.expand_path('../../config/locales/*.yml', __FILE__)]
+
+  ::RSpec.configure do |config|
+    config.include RspecGenerateDoc::LibraryHooks::Doc, type: :controller
+  end
+
+  def configure
+    yield configuration
+  end
+
+  def configuration
+    @configuration ||= Configuration.new
+  end
+end

data/rspec_generate_doc.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rspec_generate_doc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rspec_generate_doc'
+  spec.version       = RspecGenerateDoc::VERSION
+  spec.authors       = ["Igor Kutyavin"]
+  spec.email         = ["djok69@gmail.com"]
+
+  spec.summary       = %q{Generate documentation api of rspec tests}
+  spec.homepage      = 'https://github.com/jokius/rspec_api_docs'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = %w(lib)
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_dependency 'rspec-rails'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: rspec_generate_doc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Kutyavin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- djok69@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/locales/en.yml
+- config/locales/ru.yml
+- lib/rspec_generate_doc.rb
+- lib/rspec_generate_doc/configuration.rb
+- lib/rspec_generate_doc/generate.rb
+- lib/rspec_generate_doc/library_hooks/doc.rb
+- lib/rspec_generate_doc/version.rb
+- rspec_generate_doc.gemspec
+homepage: https://github.com/jokius/rspec_api_docs
+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.2
+signing_key: 
+specification_version: 4
+summary: Generate documentation api of rspec tests
+test_files: []