appmap_swagger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fab77dbb3fd27bda9de4005dec030569a6c6c2e357e3aa395d0db0b756e2a17a
+  data.tar.gz: b21378cc57387b4a692eef8d6559656a94328d34c4b7e4f81faf2f1de7671e31
+SHA512:
+  metadata.gz: ccea92116d5bcceecdad969785e62b2e229abf288a810a52e144382a156a68a8357be1099fcf58c9f399d2fac557cf19731da716db4734b512e78f5e159e5671
+  data.tar.gz: bfaf3e21575f94349442bfad0c9906941328303e9749df18ba35fed2a82babd4959118f0dea9259ceb8d75944271f0c8694364201d8e0a72b69b8e0ad455694f

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    appmap_swagger (0.1.0)
+      activesupport
+      rake
+      rdoc
+      reverse_markdown
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    concurrent-ruby (1.1.8)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    mini_portile2 (2.5.0)
+    minitest (5.14.4)
+    nokogiri (1.11.2)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    racc (1.5.2)
+    rake (12.3.3)
+    rdoc (6.3.0)
+    reverse_markdown (2.0.0)
+      nokogiri
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appmap_swagger!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Kevin Gilpin
+
+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,97 @@
+# `appmap_swagger`
+
+This gem provides a Rake task called `appmap:swagger` that generates [Swagger 3](https://swagger.io/specification/) (aka OpenAPI) YAML from [AppMap](https://github.com/applandinc/appmap-ruby) data.
+
+It depends on an NPM package called [@appland/appmap-swagger](https://www.npmjs.com/package/@appland/appmap-swagger), which does most of the heavy lifting of converting AppMaps to Swagger. This gem adds the Rake task and some niceties such as Rails integration.
+
+# How it works
+
+The Rake task `appmap:swagger`:
+
+1. Requires Node.js, and it requires the `@appland/appmap-swagger` package to be installed from NPM.
+2. Runs the Node.js program `appmap-swagger` to generate Swagger YAML.
+3. Merges the generated Swagger with a template file.
+4. Applies some sensible defaults for Ruby, and Ruby on Rails.
+5. Outputs two files to the specified directory (default: `swagger`):
+     1. `openapi.yaml` Full Swagger, including documentation and examples.
+     2. `openapi_stable.yaml` Swagger without documentation and examples, so that it's more stable across versions.
+
+`openapi_stable.yaml` is ideal for use in code reviews, to see if (and how) web services have been changed.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development do
+  gem 'appmap_swagger'
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+# Usage
+
+## Defining the `appmap:swagger` Rake task
+
+You need to define the `appmap:swagger` Rake task. In Rails, this is done by creating a file like `lib/tasks/appmap.rake`.
+
+In the file, check if `AppMap` is loaded, and then configure the Rake task. You'll probably want to provide
+a project name and version. (The default project name is determined from your Rails Application class name and might be fine, actually).
+
+```ruby
+  if defined?(AppMap::Swagger)
+    AppMap::Swagger::RakeTask.new.tap do |task|
+      task.project_name = 'My Server API'
+      # You may not have a VERSION file. Do what works best for you.
+      task.project_version = "v#{File.read(File.join(Rails.root, 'VERSION')).strip}"
+    end
+  end
+```
+
+## Incorporating the Swagger API and UI
+
+Two other gems work great with `appmap:swagger`: `rswag-api` and `rswag-ui` from [rswag](https://github.com/rswag/rswag).
+
+Install in your Gemfile:
+
+```ruby
+# By default, let's not run this in production until we've thought about the implications.
+group :test, :development do
+  gem 'rswag-api'
+  gem 'rswag-ui'
+end
+```
+
+Then run the install commands:
+
+```sh-session
+$ rails g rswag:api:install
+$ rails g rswag:ui:install
+```
+
+Update `routes.rb`:
+
+```ruby
+  if defined?(Rswag)
+    mount Rswag::Ui::Engine => '/api-docs'
+    mount Rswag::Api::Engine => '/api-docs'
+  end
+```
+
+## Development
+
+After checking out the repo, run `bundle` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake gem: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/applandinc/appmap_swagger-ruby.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/appmap_swagger.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'appmap/swagger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'appmap_swagger'
+  spec.version       = AppMap::Swagger::VERSION
+  spec.authors       = ['Kevin Gilpin']
+  spec.email         = ['kgilpin@gmail.com']
+
+  spec.summary       = %q{Provides a Rake task to generate Swagger from AppMap data}
+  spec.homepage      = 'https://github.com/applandinc/appmap_swagger-ruby'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # 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']
+
+  spec.add_dependency 'rake'
+  spec.add_dependency 'rdoc'
+  spec.add_dependency 'reverse_markdown'
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'minitest'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "appmap_swagger"
+
+# 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/appmap/swagger/markdown_descriptions.rb

@@ -0,0 +1,45 @@
+require 'active_support'
+require 'active_support/core_ext'
+require 'rdoc'
+require 'reverse_markdown'
+
+module AppMap
+  module Swagger
+    # Transform description fields into Markdown.
+    class MarkdownDescriptions
+      def initialize(swagger_yaml)
+        @swagger_yaml = swagger_yaml
+      end
+
+      def converter
+        method(:rdoc_to_markdown)
+      end
+
+      def perform
+        to_markdown = lambda do |obj|
+          return obj.each(&to_markdown) if obj.is_a?(Array)
+          return unless obj.is_a?(Hash)
+
+          description = obj['description']
+          obj['description'] = converter.(description) if description
+
+          obj.reject { |k,v| k == 'properties' }.each_value(&to_markdown)
+
+          obj
+        end
+
+        to_markdown.(@swagger_yaml.deep_dup)
+      end
+
+      protected
+
+      def rdoc_to_markdown(comment)
+        # Strip tags
+        comment = comment.split("\n").reject { |line| line =~ /^\s*@/ }.join("\n")
+        converter = ::RDoc::Markup::ToHtml.new(::RDoc::Options.new)
+        html = converter.convert(comment).strip
+        ::ReverseMarkdown.convert(html).strip
+      end
+    end
+  end
+end

data/lib/appmap/swagger/rake_task.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rake/tasklib'
+require 'appmap/swagger/stable'
+require 'appmap/swagger/markdown_descriptions'
+
+module AppMap
+  module Swagger
+    class RakeTask < ::Rake::TaskLib
+      DEFAULT_APPMAP_DIR = 'tmp/appmap'
+      DEFAULT_OUTPUT_DIR = 'swagger'
+      DEFAULT_SWAGGERGEN = './node_modules/@appland/appmap-swagger/cli.js'
+
+      attr_accessor :name, :verbose, :swaggergen, :appmap_dir, :output_dir, :project_name, :project_version
+
+      def initialize(*args, &task_block)
+        @name            = args.shift || :swagger
+        @verbose         = true
+        @swaggergen      = DEFAULT_SWAGGERGEN
+        @appmap_dir      = DEFAULT_APPMAP_DIR
+        @output_dir      = DEFAULT_OUTPUT_DIR
+
+        # https://www.rubydoc.info/docs/rails/Module#module_parent_name-instance_method
+        module_parent_name = ->(cls) { cls.name =~ /::[^:]+\Z/ ? $`.freeze : nil }
+        
+        @project_name    = \
+          if defined?(Rails)
+            [ module_parent_name.(Rails.application.class).humanize.titleize, 'API' ].join(' ')
+          else
+            'MyProject API'
+          end
+        @project_version = 'v1.0'
+
+
+        define(args, &task_block)
+      end
+
+      def run_task(verbose)
+        FileUtils.mkdir_p output_dir
+
+        do_fail = lambda do |msg|
+          warn msg if verbose
+          exit $?.exitstatus || 1
+        end
+
+        return do_fail.(%Q('node' not found; please install NodeJS)) unless system('node --version 2>&1 > /dev/null')
+        return do_fail.(%Q('#{swaggergen}' not found; please install appmap-swagger from NPM)) unless File.exists?(swaggergen)
+
+        warn swagger_command.join(' ') if verbose
+
+        swagger_raw = `#{swagger_command.join(' ')}`.strip
+        return do_fail.(%Q(Swagger generation failed: #{swagger_raw})) if $?.exitstatus != 0
+
+        gen_swagger = YAML.load(swagger_raw)
+        gen_swagger_full = AppMap::Swagger::MarkdownDescriptions.new(gen_swagger).perform
+        gen_swagger_stable = AppMap::Swagger::Stable.new(gen_swagger).perform
+
+        swagger = swagger_template.merge(gen_swagger_full)
+        File.write File.join(output_dir, 'openapi.yaml'), YAML.dump(swagger)
+
+        swagger = swagger_template.merge(gen_swagger_stable)
+        File.write File.join(output_dir, 'openapi_stable.yaml'), YAML.dump(swagger)
+      end
+
+      def swagger_template
+        YAML.load <<~TEMPLATE
+        openapi: 3.0.1
+        info:
+          title: #{project_name}
+          version: #{project_version}
+        paths:
+        components:
+        servers:
+        - url: http://{defaultHost}
+          variables:
+            defaultHost:
+              default: localhost:3000
+        TEMPLATE
+      end    
+
+      def swagger_command
+        [ 'node', swaggergen, 'generate', '--directory', appmap_dir ]
+      end
+
+      private
+
+      # This bit of black magic - https://github.com/rspec/rspec-core/blob/main/lib/rspec/core/rake_task.rb#L110
+      def define(args, &task_block)
+        desc "Generate Swagger from AppMaps" unless ::Rake.application.last_description
+
+        task(name, *args) do |_, task_args|
+          RakeFileUtils.__send__(:verbose, verbose) do
+            task_block.call(*[self, task_args].slice(0, task_block.arity)) if task_block
+            run_task verbose
+          end
+        end
+      end
+    end
+  end
+end

data/lib/appmap/swagger/stable.rb

@@ -0,0 +1,40 @@
+require 'active_support'
+require 'active_support/core_ext'
+
+module AppMap
+  module Swagger
+    # Transform raw Swagger into a "stable" variant. For example, remove descriptions
+    # and parameter examples, whose variance does not substantially affect the API.
+    class Stable
+      def initialize(swagger_yaml)
+        @swagger_yaml = swagger_yaml
+      end
+
+      def perform
+        clean_only = nil
+        clean = lambda do |obj, properties = %w[description example]|
+          return obj.each(&clean_only.(properties)) if obj.is_a?(Array)
+          return unless obj.is_a?(Hash)
+
+          properties.each { |property| obj.delete property }
+
+          obj.each do |key, value|
+            # Don't clean 'description' from within 'properties'
+            props = key == 'properties' ? %w[example] : properties
+            clean_only.(props).(value)
+          end
+
+          obj
+        end
+
+        clean_only = lambda do |properties|
+          lambda do |example|
+            clean.(example, properties)
+          end
+        end
+
+        clean.(@swagger_yaml.deep_dup)
+      end
+    end
+  end
+end

data/lib/appmap/swagger/version.rb

@@ -0,0 +1,5 @@
+module AppMap
+  module Swagger
+    VERSION = "0.1.0"
+  end
+end

data/lib/appmap_swagger.rb

@@ -0,0 +1,2 @@
+require 'appmap/swagger/version'
+require 'appmap/swagger/rake_task'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: appmap_swagger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kevin Gilpin
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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'
+- !ruby/object:Gem::Dependency
+  name: reverse_markdown
+  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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- kgilpin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- appmap_swagger.gemspec
+- bin/console
+- bin/setup
+- lib/appmap/swagger/markdown_descriptions.rb
+- lib/appmap/swagger/rake_task.rb
+- lib/appmap/swagger/stable.rb
+- lib/appmap/swagger/version.rb
+- lib/appmap_swagger.rb
+homepage: https://github.com/applandinc/appmap_swagger-ruby
+licenses:
+- MIT
+metadata: {}
+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: Provides a Rake task to generate Swagger from AppMap data
+test_files: []