apipie-dsl 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8be129129902b76525b6f6f49af8ceb5966f658cb12734725a15d7a85e44612
-  data.tar.gz: 538ddde32dfe9058739a350a0f641ed64fbc40d8ae529a0ce48e08ce8aa6bbb5
+  metadata.gz: 95dfead8f64abaa0afb0acb4c8af97c43a484d0486596a08049420baff6ba9a4
+  data.tar.gz: 5f454030f583bd23a2728693c6950c6c145223289448f1f6ae681c021cc0897f
 SHA512:
-  metadata.gz: 7c645ba1b449e181d24b1e4710a493056f0332b6408ee6adf51fb2e496d42c37dee53895f03f89425e2a9d10dd5151a163e9c5d1e04a1b8adea6d75dd17860ef
-  data.tar.gz: 3b1ae75bc8dc25968e5fc0524a66339212598abe751b9254b21715ab705b42dd9e9b29c6e06c54accb2ec1901a149eb58d1dff60bb8b0b507ba4ae7bad14eb2b
+  metadata.gz: e0d8dccd8fdaa5bbd2c8cc1ef4a89cdda096fa000ace242518f5196a420cf7cc7e62f4790d3f9e6c1b7335bdc2dd65c5b6dbe5133fceb7b6477376d3bf95d640
+  data.tar.gz: c5a0a6ba9167b2bf13e117ca608d997689ab97eb76e422a69423dab1c8152c7e203594dde8d9d6216e661c4116a5d6f5f113ed95913b41b8d41cb6418f8f3232

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/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
@@ -414,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]
@@ -454,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
@@ -507,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
 
@@ -528,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

@@ -34,40 +34,40 @@ module ApipieDSL
     end
 
     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)
-  elsif desc_or_options.is_a?(String)
-    options[:desc] = desc_or_options
-  elsif !desc_or_options.nil?
-    raise ArgumentError, 'Parameter description: expected description or options as 3rd parameter'
-  end
+      if desc_or_options.is_a?(Hash)
+        options = options.merge(desc_or_options)
+      elsif desc_or_options.is_a?(String)
+        options[:desc] = desc_or_options
+      elsif !desc_or_options.nil?
+        raise ArgumentError, 'Parameter description: expected description or options as 3rd parameter'
+      end
 
-  @options = options.transform_keys(&:to_sym)
+      @options = options.transform_keys(&:to_sym)
 
-  @method_description = method_description
-  @name = name
-  @desc = @options[:desc]
-  @type = @options[:type] || :required
-  @schema = @options[:schema]
-  @default_value = @options[:default]
-  @parent = @options[:parent]
-  @metadata = @options[:meta]
-  @show = @options.key?(:show) ? @options[:show] : true
+      @method_description = method_description
+      @name = name
+      @desc = @options[:desc]
+      @type = @options[:type] || :required
+      @schema = @options[:schema]
+      @default_value = @options[:default]
+      @parent = @options[:parent]
+      @metadata = @options[:meta]
+      @show = @options.key?(:show) ? @options[:show] : true
 
-  return unless validator
+      return unless validator
 
-  @validator = if validator.is_a?(String)
-    ApipieDSL::Validator::Lazy.new(self, validator, @options, block)
-  else
-    ApipieDSL::Validator::BaseValidator.find(self, validator, @options, block)
-  end
-  raise StandardError, "Validator for #{validator} not found." unless @validator
+      @validator = if validator.is_a?(String)
+        ApipieDSL::Validator::Lazy.new(self, validator, @options, block)
+      else
+        ApipieDSL::Validator::BaseValidator.find(self, validator, @options, block)
+      end
+      raise StandardError, "Validator for #{validator} not found." unless @validator
     end
 
     def validator
-  return @validator unless @validator.is_a?(ApipieDSL::Validator::Lazy)
+      return @validator unless @validator.is_a?(ApipieDSL::Validator::Lazy)
 
-  @validator = @validator.build
+      @validator = @validator.build
     end
 
     def validate(value)

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/tasks_utils.rb

@@ -21,8 +21,8 @@ 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, {})

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.3.0'
+  VERSION = '2.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apipie-dsl
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Oleh Fedorenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2021-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -206,14 +206,14 @@ 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:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Ruby DSL documentation tool