apidoc_to_gfm 0.0.1

data/example/spec/rails_helper.rb

@@ -0,0 +1,43 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require 'spec_helper'
+require File.expand_path("../../config/environment", __FILE__)
+require 'rspec/rails'
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+Dir[Rails.root.join("spec/support/**/*.rb")].each { |f| require f }
+
+# Checks for pending migrations before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+end

data/example/spec/spec_helper.rb

@@ -0,0 +1,74 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

data/lib/apidoc_to_gfm/version.rb

@@ -0,0 +1,3 @@
+module ApidocToGFM
+  VERSION = "0.0.1"
+end

data/lib/apidoc_to_gfm/views/example.rb

@@ -0,0 +1,42 @@
+# -*- encoding : utf-8 -*-
+
+module ApidocToGFM
+  module Views
+    class Example < ::RspecApiDocumentation::Views::MarkdownExample
+      include Helpers
+
+      def initialize(example, configuration)
+        super
+        self.template_name = "rspec_api_documentation/gfm_example"
+        self.template_path = template_path_from_gem  unless template_exists?
+      end
+
+      # Gitlab works only english filenames!
+      def dirname
+        transliterate(super).downcase
+      end
+
+      def filename
+        transliterate(super).downcase
+      end
+
+      def parameters
+        super.map do |parameter|
+          parameter.merge({
+            :required => parameter[:required] ? 'yes' : 'no',
+          })
+        end
+      end
+
+      def extension
+        @extension ||= 'md'.freeze
+      end
+
+      private
+
+      def transliterate(string, replacement = '_')
+        ActiveSupport::Inflector.transliterate string, replacement
+      end
+    end
+  end
+end

data/lib/apidoc_to_gfm/views/helpers.rb

@@ -0,0 +1,14 @@
+module ApidocToGFM
+  module Views
+    module Helpers
+      def template_exists?
+        path = File.join(self.template_path, self.template_name)
+        File.exists? path
+      end
+
+      def template_path_from_gem
+        File.expand_path("../../../../templates", __FILE__)
+      end
+    end
+  end
+end

data/lib/apidoc_to_gfm/views/index.rb

@@ -0,0 +1,17 @@
+module ApidocToGFM
+  module Views
+    class Index < ::RspecApiDocumentation::Views::MarkdownIndex
+      include Helpers
+
+      def initialize(index, configuration)
+        super
+        self.template_name = "rspec_api_documentation/gfm_index"
+        self.template_path = template_path_from_gem  unless template_exists?
+      end
+
+      def examples
+        @index.examples.map { |example| Example.new(example, @configuration) }
+      end
+    end
+  end
+end

data/lib/apidoc_to_gfm/views.rb

@@ -0,0 +1,8 @@
+require "apidoc_to_gfm/views/helpers"
+require "apidoc_to_gfm/views/example"
+require "apidoc_to_gfm/views/index"
+
+module ApidocToGFM
+  module Views
+  end
+end

data/lib/apidoc_to_gfm/writers/writer.rb

@@ -0,0 +1,13 @@
+module ApidocToGFM
+  module Writers
+    class Writer < ::RspecApiDocumentation::Writers::MarkdownWriter
+      def markup_index_class
+        Views::Index
+      end
+
+      def markup_example_class
+        Views::Example
+      end
+    end
+  end
+end

data/lib/apidoc_to_gfm/writers.rb

@@ -0,0 +1,6 @@
+require "apidoc_to_gfm/writers/writer"
+
+module ApidocToGFM
+  module Writers
+  end
+end

data/lib/apidoc_to_gfm.rb

@@ -0,0 +1,10 @@
+require "rspec_api_documentation"
+
+require "apidoc_to_gfm/version"
+require "apidoc_to_gfm/views"
+require "apidoc_to_gfm/writers"
+
+module ApidocToGFM
+end
+
+RspecApiDocumentation::Writers.const_set("gfm_writer".classify, ApidocToGFM::Writers::Writer)

data/templates/rspec_api_documentation/gfm_example.mustache

@@ -0,0 +1,34 @@
+# {{ resource_name }}
+
+## {{ description }}
+
+{{# explanation }}
+
+{{ explanation }}
+{{/ explanation }}
+
+```
+{{ http_method }} {{ route }}
+```
+
+{{# has_parameters? }}
+
+| Attribute | Type | Required | Description |
+| --------- | ---- | -------- | ----------- |
+{{# parameters }}
+| {{ name }} | {{ Type }} | {{ required }} | {{ description }} |
+{{/ parameters }}
+
+{{/ has_parameters? }}
+
+{{# requests }}
+{{# response_status }}
+{{# response_body }}
+
+Example response:
+
+<pre>{{ response_body }}</pre>
+
+{{/ response_body }}
+{{/ response_status }}
+{{/ requests }}

data/templates/rspec_api_documentation/gfm_index.mustache

@@ -0,0 +1,10 @@
+# API
+
+{{# sections }}
+## {{ resource_name }}
+
+{{# examples }}
+* [{{ description }}]({{ dirname }}/{{ filename }})
+{{/ examples }}
+
+{{/ sections }}

metadata

@@ -0,0 +1,180 @@
+--- !ruby/object:Gem::Specification
+name: apidoc_to_gfm
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- German Antsiferov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec_api_documentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: The template supports GitLab Flavored Markdown (GFM)
+email:
+- dxdy@bk.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apidoc_to_gfm.gemspec
+- bin/console
+- bin/setup
+- example/.gitignore
+- example/.rspec
+- example/Gemfile
+- example/Gemfile.lock
+- example/README.rdoc
+- example/Rakefile
+- example/app/assets/images/.keep
+- example/app/assets/javascripts/application.js
+- example/app/assets/stylesheets/application.css
+- example/app/controllers/application_controller.rb
+- example/app/controllers/concerns/.keep
+- example/app/controllers/orders_controller.rb
+- example/app/controllers/uploads_controller.rb
+- example/app/helpers/application_helper.rb
+- example/app/mailers/.keep
+- example/app/models/.keep
+- example/app/models/concerns/.keep
+- example/app/models/order.rb
+- example/app/views/layouts/application.html.erb
+- example/bin/bundle
+- example/bin/rails
+- example/bin/rake
+- example/bin/spring
+- example/config.ru
+- example/config/application.rb
+- example/config/boot.rb
+- example/config/database.yml
+- example/config/environment.rb
+- example/config/environments/development.rb
+- example/config/environments/production.rb
+- example/config/environments/test.rb
+- example/config/initializers/backtrace_silencers.rb
+- example/config/initializers/cookies_serializer.rb
+- example/config/initializers/filter_parameter_logging.rb
+- example/config/initializers/inflections.rb
+- example/config/initializers/mime_types.rb
+- example/config/initializers/session_store.rb
+- example/config/initializers/wrap_parameters.rb
+- example/config/locales/en.yml
+- example/config/routes.rb
+- example/config/secrets.yml
+- example/db/migrate/20140616151047_create_orders.rb
+- example/db/schema.rb
+- example/db/seeds.rb
+- example/lib/assets/.keep
+- example/lib/tasks/.keep
+- example/log/.keep
+- example/public/404.html
+- example/public/422.html
+- example/public/500.html
+- example/public/favicon.ico
+- example/public/robots.txt
+- example/spec/acceptance/orders_spec.rb
+- example/spec/acceptance/uploads_spec.rb
+- example/spec/acceptance_helper.rb
+- example/spec/fixtures/file.png
+- example/spec/rails_helper.rb
+- example/spec/spec_helper.rb
+- example/vendor/assets/javascripts/.keep
+- example/vendor/assets/stylesheets/.keep
+- lib/apidoc_to_gfm.rb
+- lib/apidoc_to_gfm/version.rb
+- lib/apidoc_to_gfm/views.rb
+- lib/apidoc_to_gfm/views/example.rb
+- lib/apidoc_to_gfm/views/helpers.rb
+- lib/apidoc_to_gfm/views/index.rb
+- lib/apidoc_to_gfm/writers.rb
+- lib/apidoc_to_gfm/writers/writer.rb
+- templates/rspec_api_documentation/gfm_example.mustache
+- templates/rspec_api_documentation/gfm_index.mustache
+homepage: https://github.com/mr-dxdy/apidoc_to_gfm.git
+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.6.10
+signing_key: 
+specification_version: 4
+summary: An template for rspec_api_documentation
+test_files: []