apipie-dsl 2.2.10 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 990ebec629f1450a927333b32acec610e62378a52dd4d04247de392fa15376ad
-  data.tar.gz: 15a19b903fa3a51096eda59a022ffcfaaaf1bbe82d9253a25b7696a6c04321bc
+  metadata.gz: a8d420cf5c758a736b1f45f9c12e81d7bb1340f64159a7e2b9dfe3929a6a8bfc
+  data.tar.gz: d14c1615c171f70f43715851c898f8e9b5244a7d646ab711a9f57bbc1343f028
 SHA512:
-  metadata.gz: 8b0a2d9ea7df944cb6b1585db1bc18bc98220ffab60e612e832e9eddbd0e19668067da1b950b342b906a36e922c4f539d35ccf4a9d70977593a5931195d16e94
-  data.tar.gz: ab9e8070fed5ce6cb24c5da93ec3c4b297cb792fa704b5e3fcc2f74c40927deaf608e0401de6dc5eef46fc784e9a89300b9317768398a44f78805c2ccb766333
+  metadata.gz: 302bbb70404e1c46c523f2e5c6ad089a1b4d91ac875ef51a93dda65a61f62e41517247a14e666d4df0ae49e4dd1ac12422812d0d00b7d04b64afe390f4bb94af
+  data.tar.gz: f2de5cd7638eb4cc34d494bd3056b4e1f8b298c17e43cd4b6d1040e2a501482c2aa74eddbf840ffbc37c660a48775fcdccb096909cbddea565c1b151aff8eff0

data/app/helpers/apipie_dsl_helper.rb

@@ -49,11 +49,11 @@ module ApipieDslHelper
   def apipie_erb_wrap(content, mode: :loud, open_trim: false, close_trim: false)
     case mode
     when :loud
-      '<%= ' + content + " #{close_trim ? '-' : ''}%>"
+      "<%= #{content} #{close_trim ? '-' : ''}%>"
     when :comment
-      '<%# ' + content + " #{close_trim ? '-' : ''}%>"
+      "<%# #{content} #{close_trim ? '-' : ''}%>"
     else
-      "<%#{open_trim ? '- ' : ' '}" + content + " #{close_trim ? '-' : ''}%>"
+      "<%#{open_trim ? '-' : ''} #{content} #{close_trim ? '-' : ''}%>"
     end
   end
 
@@ -65,6 +65,8 @@ module ApipieDslHelper
       "\"\""
     when Symbol
       ":#{default}"
+    when String
+      "\"#{default}\""
     else
       default
     end
@@ -142,9 +144,10 @@ module ApipieDslHelper
   end
 
   def current_version(classes)
-    if classes.is_a?(Array)
+    case classes
+    when Array
       classes.first[:version]
-    elsif classes.is_a?(Hash)
+    when Hash
       classes.values.first[:version]
     else
       raise ApipieDSL::Error, "Cannot find current version for #{classes}"

data/app/views/apipie_dsl/apipie_dsls/_params.html.erb

@@ -9,7 +9,8 @@
     <td>
       <strong><%= param[:full_name] %> </strong><br>
       <small>
-        <%=  t("apipie_dsl.#{param[:type]}") %>
+        <%=  t("apipie_dsl.#{param[:type]}") %><br>
+        <%= param[:type] == 'keyword' ? 'Optional' : '' %>
       </small>
     </td>
     <td>

data/app/views/apipie_dsl/apipie_dsls/index.html.erb

@@ -14,7 +14,7 @@
 
 <h1 class='page-header'><%= t('apipie_dsl.classes') %></h1>
 
-<% @doc[:classes].each_value do |klass| %>
+<% @doc[:classes].sort_by { |id, c| c[:name] }.each do |id, klass| %>
   <% next unless klass[:show] && in_section?(@section, klass[:id]) %>
   <h2>
     <a href='<%= klass[:doc_url] %><%= @doc[:link_extension] %>'>

data/app/views/apipie_dsl/apipie_dsls/plain.html.erb

@@ -1,4 +1,4 @@
-<% @doc[:classes].sort_by(&:first).each do |key, klass| %>
+<% @doc[:classes].sort_by { |id, c| c[:name] }.each do |key, klass| %>
   <% next unless klass[:show] %>
   <h4><a href='#<%= key %>'><%= klass[:name] %></a></h4>
   <ul>
@@ -14,7 +14,7 @@
   </ul>
 <% end %>
 
-<% @doc[:classes].sort_by(&:first).each do |key, klass| %>
+<% @doc[:classes].sort_by { |id, c| c[:name] }.each do |key, klass| %>
   <% next unless klass[:show] %>
   <hr/>
   <div>

data/app/views/apipie_dsl/apipie_dsls/static.html.erb

@@ -1,4 +1,4 @@
-<% @doc[:classes].sort_by(&:first).each do |key, klass| %>
+<% @doc[:classes].sort_by { |id, c| c[:name] }.each do |key, klass| %>
   <% next unless klass[:show] %>
   <h4><a href='#<%= key %>'><%= klass[:name] %></a></h4>
   <ul>
@@ -18,7 +18,7 @@
 
 <hr>
 
-<% @doc[:classes].sort_by(&:first).each do |key, klass| %>
+<% @doc[:classes].sort_by { |id, c| c[:name] }.each do |key, klass| %>
   <% next unless klass[:show] %>
   <ul class='breadcrumb'  id='<%= key %>'>
     <li><a href='#'><%= @doc[:name] %></a><span class='divider'>/</span></li>

data/lib/apipie_dsl/application.rb

@@ -6,7 +6,7 @@ module ApipieDSL
       require 'apipie_dsl/static_dispatcher'
 
       class Engine < Rails::Engine
-        initializer 'static assets', :before => :build_middleware_stack do |app|
+        initializer 'static assets', before: :build_middleware_stack do |app|
           app.middleware.use ::ApipieDSL::StaticDispatcher, "#{root}/app/public"
         end
       end

data/lib/apipie_dsl/class_description.rb

@@ -23,7 +23,7 @@ module ApipieDSL
       @full_description = ApipieDSL.markup_to_html(dsl_data[:description]) if dsl_data[:description]
       @short_description = dsl_data[:short_description] || @short_description
       @tag_list = dsl_data[:tag_list]
-      if dsl_data[:meta]&.is_a?(Hash)
+      if dsl_data[:meta].is_a?(Hash)
         @metadata&.merge!(dsl_data[:meta])
       elsif dsl_data[:meta]
         @metadata = dsl_data[:meta]
@@ -98,8 +98,8 @@ module ApipieDSL
         full_description: ApipieDSL.translate(@full_description, lang),
         version: version,
         metadata: @metadata,
-        properties: @properties.map { |prop_desc| prop_desc.docs(section, lang) },
-        methods: methods,
+        properties: @properties.map { |prop_desc| prop_desc.docs(section, lang) }.sort_by { |p| p[:name] },
+        methods: methods.sort_by { |m| m[:name] },
         deprecated: @deprecated,
         show: @show
       }

data/lib/apipie_dsl/dsl.rb

@@ -202,9 +202,10 @@ module ApipieDSL
         options[:desc] = desc_or_options
       end
 
-      if retobj_or_options.is_a?(Hash)
+      case retobj_or_options
+      when Hash
         options.merge!(retobj_or_options)
-      elsif retobj_or_options.is_a?(Symbol)
+      when Symbol
         options[:param_group] = retobj_or_options
       else
         options[:object_of] ||= retobj_or_options
@@ -388,7 +389,6 @@ module ApipieDSL
         @extension_data ||= { methods: [] }
       end
 
-      # rubocop:disable Metrics/AbcSize
       def self.define_validators(class_scope, method_desc)
         return if method_desc.nil? || ![true, :implicitly, :explicitly].include?(ApipieDSL.configuration.validate)
         return unless [true, :implicitly].include?(ApipieDSL.configuration.validate)
@@ -415,7 +415,7 @@ module ApipieDSL
       def self.update_method_desc(method_desc, dsl_data)
         method_desc.full_description = dsl_data[:description] || method_desc.full_description
         method_desc.short_description = dsl_data[:short_description] || method_desc.short_description
-        if dsl_data[:meta]&.is_a?(Hash)
+        if dsl_data[:meta].is_a?(Hash)
           method_desc.metadata&.merge!(dsl_data[:meta])
         else
           method_desc.metadata = dsl_data[:meta]
@@ -430,7 +430,6 @@ module ApipieDSL
         end
         ParameterDescription.merge(method_desc.plain_params, params)
       end
-      # rubocop:enable Metrics/AbcSize
     end
   end
 
@@ -456,9 +455,10 @@ module ApipieDSL
     end
 
     def apipie(context = :method, desc_or_options = nil, options = {}, &block)
-      if desc_or_options.is_a?(Hash)
+      case desc_or_options
+      when Hash
         options = options.merge(desc_or_options)
-      elsif desc_or_options.is_a?(String)
+      when String
         options[:desc] = desc_or_options
       end
       options[:name] ||= context.to_s
@@ -509,9 +509,10 @@ module ApipieDSL
     private
 
     def prepare_delegatee(scope, desc_or_options, options, &block)
-      if desc_or_options.is_a?(Hash)
+      case desc_or_options
+      when Hash
         options = options.merge(desc_or_options)
-      elsif desc_or_options.is_a?(String)
+      when String
         options[:desc] = desc_or_options
       end
 
@@ -530,9 +531,10 @@ module ApipieDSL
     include ApipieDSL::Delegatable
 
     def apipie(context = :method, desc_or_options = nil, options = {}, &block)
-      if desc_or_options.is_a?(Hash)
+      case desc_or_options
+      when Hash
         options = options.merge(desc_or_options)
-      elsif desc_or_options.is_a?(String)
+      when String
         options[:desc] = desc_or_options
       end
       options[:name] ||= context.to_s

data/lib/apipie_dsl/errors.rb

@@ -2,10 +2,12 @@
 
 module ApipieDSL
   class Error < StandardError; end
+
   class ParamError < Error
     attr_accessor :param
 
     def initialize(param)
+      super
       @param = param
     end
   end
@@ -46,6 +48,7 @@ module ApipieDSL
     attr_accessor :value
 
     def initialize(value)
+      super
       @value = value
     end
 
@@ -70,6 +73,7 @@ module ApipieDSL
     attr_reader :value
 
     def initialize(value)
+      super
       @value = value
     end
 

data/lib/apipie_dsl/parameter_description.rb

@@ -33,7 +33,6 @@ module ApipieDSL
       end
     end
 
-    # rubocop:disable Metrics/ParameterLists
     def initialize(method_description, name, validator, desc_or_options = nil, options = {}, &block)
       if desc_or_options.is_a?(Hash)
         options = options.merge(desc_or_options)
@@ -64,7 +63,6 @@ module ApipieDSL
       end
       raise StandardError, "Validator for #{validator} not found." unless @validator
     end
-    # rubocop:enable Metrics/ParameterLists
 
     def validator
       return @validator unless @validator.is_a?(ApipieDSL::Validator::Lazy)

data/lib/apipie_dsl/return_description.rb

@@ -12,8 +12,6 @@ module ApipieDSL
         @param_group = { scope: @scope }
         @options = options
         @return_type = (@options.keys & %i[array_of one_of object_of param_group]).first
-
-        return unless @options[@return_type].is_a?(::Class)
       end
 
       # this routine overrides Param#default_param_group_scope

data/lib/apipie_dsl/routing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ApipieDSL
   module Routing
     module MapperExtensions

data/lib/apipie_dsl/tasks/apipie_dsl/cache.rake

@@ -8,6 +8,9 @@ namespace :apipie_dsl do
     task :cache, [:include_json] => :environment do |_task, args|
       args.with_defaults(include_json: false)
       include_json = %w[1 true].include?(args[:include_json])
+      cache_part = ENV['cache_part']
+      generate_index = (cache_part == 'classes' ? false : true)
+      generate_classes = (cache_part == 'index' ? false : true)
       time_start = Time.now
       puts "#{time_start} | Started"
       ApipieDSL::TasksUtils.with_loaded_documentation do
@@ -24,12 +27,16 @@ namespace :apipie_dsl do
               ApipieDSL.url_prefix = "../../#{subdir}"
               doc = ApipieDSL.docs(version, nil, nil, lang, section)
               doc[:docs][:link_extension] = "#{ApipieDSL::TasksUtils.lang_ext(lang)}.html"
-              ApipieDSL::TasksUtils.generate_index_page(file_base_version, doc, include_json, true, lang, section)
-              ApipieDSL.url_prefix = "../../../#{subdir}"
-              section_out = "#{file_base_version}/#{section}"
-              ApipieDSL::TasksUtils.generate_class_pages(version, section_out, doc, include_json, lang, section)
-              ApipieDSL.url_prefix = "../../../../#{subdir}"
-              ApipieDSL::TasksUtils.generate_method_pages(version, section_out, doc, include_json, lang, section)
+              if generate_index
+                ApipieDSL::TasksUtils.generate_index_page(file_base_version, doc, include_json, true, lang, section)
+              end
+              if generate_classes
+                ApipieDSL.url_prefix = "../../../#{subdir}"
+                section_out = "#{file_base_version}/#{section}"
+                ApipieDSL::TasksUtils.generate_class_pages(version, section_out, doc, include_json, lang, section)
+                ApipieDSL.url_prefix = "../../../../#{subdir}"
+                ApipieDSL::TasksUtils.generate_method_pages(version, section_out, doc, include_json, lang, section)
+              end
             end
             ApipieDSL.url_prefix = "../../#{subdir}"
             doc = ApipieDSL.docs(version, nil, nil, lang)
@@ -61,12 +68,16 @@ namespace :apipie_dsl do
               ApipieDSL.url_prefix = "../../#{subdir}"
               doc = ApipieDSL.docs(version, nil, nil, lang, section)
               doc[:docs][:link_extension] = "#{ApipieDSL::TasksUtils.lang_ext(lang)}.html"
-              ApipieDSL::TasksUtils.generate_index_page(file_base_version, doc, include_json, true, lang, section)
-              ApipieDSL.url_prefix = "../../../#{subdir}"
-              section_out = "#{file_base_version}/#{section}"
-              ApipieDSL::TasksUtils.generate_class_pages(version, section_out, doc, include_json, lang, section)
-              ApipieDSL.url_prefix = "../../../../#{subdir}"
-              ApipieDSL::TasksUtils.generate_method_pages(version, section_out, doc, include_json, lang, section)
+              if generate_index
+                ApipieDSL::TasksUtils.generate_index_page(file_base_version, doc, include_json, true, lang, section)
+              end
+              if generate_classes
+                ApipieDSL.url_prefix = "../../../#{subdir}"
+                section_out = "#{file_base_version}/#{section}"
+                ApipieDSL::TasksUtils.generate_class_pages(version, section_out, doc, include_json, lang, section)
+                ApipieDSL.url_prefix = "../../../../#{subdir}"
+                ApipieDSL::TasksUtils.generate_method_pages(version, section_out, doc, include_json, lang, section)
+              end
             end
             ApipieDSL.url_prefix = "../../#{subdir}"
             doc = ApipieDSL.docs(version, nil, nil, lang)

data/lib/apipie_dsl/tasks_utils.rb

@@ -21,11 +21,12 @@ module ApipieDSL
         base_paths.unshift("#{Rails.root}/app/views/apipie_dsl/apipie_dsls") if File.directory?("#{Rails.root}/app/views/apipie_dsl/apipie_dsls")
       end
       layouts_paths = [File.expand_path('../../app/views/layouts', __dir__)]
-      if ApipieDSL.configuration.rails?
-        layouts_paths.unshift("#{Rails.root}/app/views/layouts") if File.directory?("#{Rails.root}/app/views/layouts/apipie_dsl")
+      if ApipieDSL.configuration.rails? && File.directory?("#{Rails.root}/app/views/layouts/apipie_dsl")
+        layouts_paths.unshift("#{Rails.root}/app/views/layouts")
       end
       paths = ActionView::PathSet.new(base_paths + layouts_paths)
-      @renderer = ActionView::Base.new(paths, {})
+      lookup_context = ActionView::LookupContext.new(paths)
+      @renderer = ActionView::Base.with_empty_template_cache.new(lookup_context, {}, nil)
       @renderer.singleton_class.send(:include, ::ApipieDslHelper)
       @renderer
     end

data/lib/apipie_dsl/utils.rb

@@ -60,18 +60,7 @@ module ApipieDSL
     end
   end
 end
-if RUBY_VERSION < '2.5.0'
-  class Hash
-    def transform_keys
-      result = {}
-      each do |key, value|
-        new_key = yield key
-        result[new_key] = value
-      end
-      result
-    end
-  end
-end
+
 if defined? Rails
   class Module
     # https://github.com/rails/rails/pull/35035

data/lib/apipie_dsl/validator.rb

@@ -17,6 +17,7 @@ module ApipieDSL
         BaseValidator.find(@param_description, @argument.constantize, @options, @block)
       end
     end
+
     # To create a new validator, inherit from ApipieDSL::Validator::BaseValidator
     # and implement class method 'build' and instance method 'validate'
     class BaseValidator
@@ -49,6 +50,7 @@ module ApipieDSL
       end
 
       def self.inherited(subclass)
+        super(subclass)
         @validators ||= []
         @validators.unshift(subclass)
       end
@@ -325,9 +327,7 @@ module ApipieDSL
         return false unless value.is_a?(Hash)
 
         @hash_params&.each do |name, param|
-          if ApipieDSL.configuration.validate_value?
-            param.validate(value[name]) if value.key?(name)
-          end
+          param.validate(value[name]) if ApipieDSL.configuration.validate_value? && value.key?(name)
         end
         true
       end

data/lib/apipie_dsl/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ApipieDSL
-  VERSION = '2.2.10'
+  VERSION = '2.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipie-dsl
 version: !ruby/object:Gem::Version
-  version: 2.2.10
+  version: 2.5.0
 platform: ruby
 authors:
 - Oleh Fedorenko
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
+date: 2022-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -198,7 +198,7 @@ homepage: https://github.com/ofedoren/apipie-dsl
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -206,7 +206,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -214,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Ruby DSL documentation tool
 test_files: