apipie-rails 0.5.18 → 0.5.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 827ccd7271b49556c90c5bf516ac782ecf7fa38fa380bada85c6ec5c3ac7f5e3
-  data.tar.gz: e989cb29115cc40c0e1033b4800caef2cc9bccac43a6bffd43f0bb974bc68a5f
+  metadata.gz: 444b1aeccaa322d75d64131d2539ae5ecb9ceb3ea984e02c9cfd17a2c80d1190
+  data.tar.gz: ddbcdfaee3494a2f35f343a361c9e07b72541b5a75e5e537c0776f8b6c9669e9
 SHA512:
-  metadata.gz: e1fae727ae94f9083a1b02984f660ff189e30aa5eee2d9792f3d233cce46472bff8a19b077c3863be167f8738016d96c421b50dbfe3c29604397eb7aa5fbb13d
-  data.tar.gz: 71df5da3fd578b00518cc2121d2a32a9c664ac681cb52d266412759c25c5a46ef49a5d40e45006ac28f6d1ce8dd1676e0b44589f6b7869e77b2b3d04f4686195
+  metadata.gz: 18f5f97fc24bab7aa9c554cd3be305e9bf5eb5266466a79c4484fb0c7f6e4b80912d5ddb224a8ed1dd8d8002c376cd7e30a359ab4f0855d60d404352dc74acb0
+  data.tar.gz: 1c66c6990ab997d21e727900a4a36648b76aa08357491007821c4a5f1b46b25f8e48fbb9cdeccfd26f20b1ea268c32c6698f73b040226036b0f5f72fc9447060

data/.gitignore

@@ -12,3 +12,4 @@ Gemfile.local
 .ruby-gemset
 
 .DS_Store
+rel-eng/.ipynb_checkpoints

data/.travis.yml

@@ -15,6 +15,8 @@ gemfile:
   - Gemfile.rails42
   - Gemfile.rails51 # Min ruby 2.2.2
   - Gemfile.rails60 # Min ruby 2.5.0
+  - Gemfile.rails61 # Min ruby 2.5.0
+
 matrix:
   exclude:
     - rvm: 2.5.3
@@ -31,3 +33,9 @@ matrix:
       gemfile: Gemfile.rails60
     - rvm: 2.4.5
       gemfile: Gemfile.rails60
+    - rvm: 2.2.10
+      gemfile: Gemfile.rails61
+    - rvm: 2.3.8
+      gemfile: Gemfile.rails61
+    - rvm: 2.4.5
+      gemfile: Gemfile.rails61

data/CHANGELOG.md

@@ -1,7 +1,15 @@
  Changelog
 ===========
+## [v0.5.19](https://github.com/Apipie/apipie-rails/tree/v0.5.19) (2021-07-25)
+[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.5.18...v0.5.19)
+* Add rel-eng notebook (Oleh Fedorenko)
+* Correct the word parâmentros for brazilian portuguese [#687](https://github.com/Apipie/apipie-rails/pull/687) (Diego Noronha)
+* Fix depreciated file.exists. [#721](https://github.com/Apipie/apipie-rails/pull/721) (Diane Delallée)
+* Fix typo in changelog [#703](https://github.com/Apipie/apipie-rails/pull/703) (Pavel Rodionov)
+* Add rails 6.1 support in doc generation [#702](https://github.com/Apipie/apipie-rails/pull/702) (andrew-newell)
 
-[v0.5.17](https://github.com/Apipie/apipie-rails/tree/v0.5.18) (2020-05-20)
+
+[v0.5.18](https://github.com/Apipie/apipie-rails/tree/v0.5.18) (2020-05-20)
 --------
 
 [Full Changelog](https://github.com/Apipie/apipie-rails/compare/v0.5.17...v0.5.18)

data/Gemfile

@@ -1 +1 @@
-./Gemfile.rails50
+./Gemfile.rails61

data/Gemfile.rails61

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem 'rails', '~> 6.1.1'
+gem 'mime-types', '~> 2.99.3'
+gem 'rails-controller-testing'
+gem 'rspec-rails', '~> 4.0.2'
+
+gem 'test_engine', path: 'spec/dummy/components/test_engine', group: :test

data/config/locales/pt-BR.yml

@@ -16,7 +16,7 @@
     optional: opcional
     nil_allowed: nulo permitido
     param_name: Nome parâmetro
-    params: Parâmentros
+    params: Parâmetros
     examples: Exemplos
     metadata: Metadado
     errors: Erros

data/lib/apipie/version.rb

@@ -1,3 +1,3 @@
 module Apipie
-  VERSION = '0.5.18'
+  VERSION = "0.5.19"
 end

data/lib/tasks/apipie.rake

@@ -172,7 +172,12 @@ namespace :apipie do
     layouts_paths = [File.expand_path("../../../app/views/layouts", __FILE__)]
     layouts_paths.unshift("#{Rails.root}/app/views/layouts") if File.directory?("#{Rails.root}/app/views/layouts/apipie")
 
-    @apipie_renderer = ActionView::Base.new(base_paths + layouts_paths)
+    if ActionView::Base.respond_to?(:with_empty_template_cache) && ActionView::Base.respond_to?(:with_view_paths)
+      @apipie_renderer = ActionView::Base.with_empty_template_cache.with_view_paths(base_paths + layouts_paths)
+    else
+      @apipie_renderer = ActionView::Base.new(base_paths + layouts_paths)
+    end
+
     @apipie_renderer.singleton_class.send(:include, ApipieHelper)
     return @apipie_renderer
   end
@@ -210,14 +215,14 @@ namespace :apipie do
   end
 
   def generate_json_page(file_base, doc, lang = nil)
-    FileUtils.mkdir_p(file_base) unless File.exists?(file_base)
+    FileUtils.mkdir_p(file_base) unless File.exist?(file_base)
 
     filename = "schema_apipie#{lang_ext(lang)}.json"
     File.open("#{file_base}/#{filename}", 'w') { |file| file.write(JSON.pretty_generate(doc)) }
   end
 
   def generate_swagger_json_page(file_base, doc, sfx="", lang = nil)
-    FileUtils.mkdir_p(file_base) unless File.exists?(file_base)
+    FileUtils.mkdir_p(file_base) unless File.exist?(file_base)
 
     path = Pathname.new("#{file_base}/schema_swagger#{sfx}#{lang_ext(lang)}.json")
     File.open(path, 'w') { |file| file.write(JSON.pretty_generate(doc)) }
@@ -226,21 +231,21 @@ namespace :apipie do
   end
 
   def generate_one_page(file_base, doc, lang = nil)
-    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base))
+    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exist?(File.dirname(file_base))
 
     render_page("#{file_base}-onepage#{lang_ext(lang)}.html", "static", {:doc => doc[:docs],
       :language => lang, :languages => Apipie.configuration.languages})
   end
 
   def generate_plain_page(file_base, doc, lang = nil)
-    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base))
+    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exist?(File.dirname(file_base))
 
     render_page("#{file_base}-plain#{lang_ext(lang)}.html", "plain", {:doc => doc[:docs],
       :language => lang, :languages => Apipie.configuration.languages}, nil)
   end
 
   def generate_index_page(file_base, doc, include_json = false, show_versions = false, lang = nil)
-    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exists?(File.dirname(file_base))
+    FileUtils.mkdir_p(File.dirname(file_base)) unless File.exist?(File.dirname(file_base))
     versions = show_versions && Apipie.available_versions
     render_page("#{file_base}#{lang_ext(lang)}.html", "index", {:doc => doc[:docs],
       :versions => versions, :language => lang, :languages => Apipie.configuration.languages})
@@ -251,7 +256,7 @@ namespace :apipie do
   def generate_resource_pages(version, file_base, doc, include_json = false, lang = nil)
     doc[:docs][:resources].each do |resource_name, _|
       resource_file_base = File.join(file_base, resource_name.to_s)
-      FileUtils.mkdir_p(File.dirname(resource_file_base)) unless File.exists?(File.dirname(resource_file_base))
+      FileUtils.mkdir_p(File.dirname(resource_file_base)) unless File.exist?(File.dirname(resource_file_base))
 
       doc = Apipie.to_json(version, resource_name, nil, lang)
       doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
@@ -265,7 +270,7 @@ namespace :apipie do
     doc[:docs][:resources].each do |resource_name, resource_params|
       resource_params[:methods].each do |method|
         method_file_base = File.join(file_base, resource_name.to_s, method[:name].to_s)
-        FileUtils.mkdir_p(File.dirname(method_file_base)) unless File.exists?(File.dirname(method_file_base))
+        FileUtils.mkdir_p(File.dirname(method_file_base)) unless File.exist?(File.dirname(method_file_base))
 
         doc = Apipie.to_json(version, resource_name, method[:name], lang)
         doc[:docs][:link_extension] = (lang ? ".#{lang}.html" : ".html")
@@ -329,7 +334,7 @@ MESSAGE
   desc "Convert your examples from the old yaml into the new json format"
   task :convert_examples => :environment do
     yaml_examples_file = File.join(Rails.root, Apipie.configuration.doc_path, "apipie_examples.yml")
-    if File.exists?(yaml_examples_file)
+    if File.exist?(yaml_examples_file)
       #if SafeYAML gem is enabled, it will load examples as an array of Hash, instead of hash
       if defined? SafeYAML
         examples = YAML.load_file(yaml_examples_file, :safe=>false)

data/rel-eng/gem_release.ipynb

@@ -0,0 +1,366 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Release of apipie-rails gem\n",
+    "\n",
+    "### Requirements\n",
+    "- push access to https://github.com/Apipie/apipie-rails\n",
+    "- push access to rubygems.org for apipie-rails\n",
+    "- sudo yum install python-slugify asciidoc\n",
+    "- ensure neither the `git push` or `gem push` don't require interractive auth. If you can't use api key or ssh key to auth skip these steps and run them form the shell manually \n",
+    "\n",
+    "### Release process\n",
+    "- Follow the steps with `<Shift>+<Enter>` or `<Ctrl>+<Enter>,<Down>`\n",
+    "- If anything fails, fix it and re-run the step if applicable\n",
+    "\n",
+    "### Release settings"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%cd .."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Update the following notebook settings"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "NEW_VERSION = '0.5.19'\n",
+    "LAST_VERSION = '0.5.18'\n",
+    "GIT_REMOTE_UPSTREAM = 'origin'\n",
+    "WORK_BRANCH = 'master'\n"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Ensure the repo is up to date"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git checkout {WORK_BRANCH}"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git fetch {GIT_REMOTE_UPSTREAM}"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git rebase {GIT_REMOTE_UPSTREAM}/{WORK_BRANCH}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Run tests localy"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! bundle update"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": true
+   },
+   "outputs": [],
+   "source": [
+    "! bundle exec rake"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Update release related stuff"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! sed -i 's/VERSION = .*/VERSION = \"{NEW_VERSION}\"/' lib/apipie/version.rb"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Parse git changelog\n",
+    "from IPython.display import Markdown as md\n",
+    "from subprocess import check_output\n",
+    "from shlex import split\n",
+    "import re\n",
+    "\n",
+    "def format_log_entry(entry):\n",
+    "    author = re.search(r'author:(.*)', entry).group(1)\n",
+    "    entry = re.sub(r'author:(.*)', '', entry)\n",
+    "    entry = re.sub(r'([fF]ixes|[rR]efs)[^-]*-\\s*(.*)', r'\\2', entry)\n",
+    "    entry = '* ' + entry.capitalize()\n",
+    "    entry = re.sub(r'\\(#([0-9]+)\\)', r'[#\\1](https://github.com/Apipie/apipie-rails/pull/\\1)', entry)\n",
+    "    entry = entry + f'({author})'\n",
+    "    return entry\n",
+    "\n",
+    "def skip(entry):\n",
+    "    if re.match(r'Merge pull', entry) or \\\n",
+    "      re.match(r'^i18n', entry) or \\\n",
+    "      re.match(r'^Bump to version', entry):\n",
+    "        return True\n",
+    "    else:\n",
+    "        return False \n",
+    "git_log_cmd = 'git log --pretty=format:\"%%s author:%%an\" v%s..HEAD' % LAST_VERSION\n",
+    "log = check_output(split(git_log_cmd)).decode('utf8').split('\\n')\n",
+    "change_log = [format_log_entry(e) for e in log if not skip(e)]\n",
+    "md('\\n'.join(change_log))\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# Write release notes\n",
+    "from datetime import datetime\n",
+    "import fileinput\n",
+    "import sys\n",
+    "\n",
+    "fh = fileinput.input('CHANGELOG.md', inplace=True)  \n",
+    "for line in fh:  \n",
+    "    print(line.rstrip())\n",
+    "    if re.match(r'========', line):\n",
+    "        print('## [v%s](https://github.com/Apipie/apipie-rails/tree/v%s) (%s)' % (NEW_VERSION, NEW_VERSION, datetime.today().strftime('%Y-%m-%d')))\n",
+    "        print('[Full Changelog](https://github.com/Apipie/apipie-rails/compare/v%s...v%s)' % (LAST_VERSION, NEW_VERSION))\n",
+    "        for entry in change_log:\n",
+    "            print(entry)\n",
+    "        print('')\n",
+    "fh.close()  "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Manual step: Update deps in the gemspec if neccessary"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Check what is going to be commited"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": false
+   },
+   "outputs": [],
+   "source": [
+    "! git add -u\n",
+    "! git status"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": true
+   },
+   "outputs": [],
+   "source": [
+    "! git diff --cached"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Commit changes"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "scrolled": true
+   },
+   "outputs": [],
+   "source": [
+    "! git commit -m \"Bump to {NEW_VERSION}\""
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Tag new version"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git tag v{NEW_VERSION}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Build the gem"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! rake build"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! gem push pkg/apipie-rails-{NEW_VERSION}.gem"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### PUSH the changes upstream If everything is correct"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git push {GIT_REMOTE_UPSTREAM} {WORK_BRANCH}"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "! git push --tags {GIT_REMOTE_UPSTREAM} {WORK_BRANCH}"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Now the new release is in upstream repo"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### Some manual steps follow to improve the UX\n",
+    "\n",
+    "#### New relase on GitHub\n",
+    "\n",
+    "Copy the following changelog lines to the description in form on link below\n",
+    "The release title is the new version."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "print('\\n')\n",
+    "print('\\n'.join(change_log))\n",
+    "print('\\n\\nhttps://github.com/Apipie/apipie-rails/releases/new?tag=%s' % NEW_VERSION)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Congratulations\n",
+    "\n",
+    "Release is public now."
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.6.8"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: apipie-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.18
+  version: 0.5.19
 platform: ruby
 authors:
 - Pavel Pokorny
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2021-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -156,6 +156,7 @@ files:
 - Gemfile.rails50
 - Gemfile.rails51
 - Gemfile.rails60
+- Gemfile.rails61
 - MIT-LICENSE
 - NOTICE
 - PROPOSAL_FOR_RESPONSE_DESCRIPTIONS.md
@@ -239,6 +240,7 @@ files:
 - lib/generators/apipie/install/templates/initializer.rb.erb
 - lib/generators/apipie/views_generator.rb
 - lib/tasks/apipie.rake
+- rel-eng/gem_release.ipynb
 - rel-eng/packages/.readme
 - rel-eng/packages/rubygem-apipie-rails
 - rel-eng/tito.props