rails_api_documentation 0.2.2 → 0.2.3

data/app/views/rails_api_doc/api_docs/_edit_field.slim

@@ -1,9 +0,0 @@
-.row
-  = form_tag(api_doc_path, method: 'post', remote: true, class: 'form-horizontal') do
-    - ([:name] + headers).each do |field_name|
-      div.field(class="col-md-#{col_num - 1}")
-        / Add parameter name second argument
-        = text_field_tag field_name, nil, placeholder: field_name, class: 'form-control'
-
-    div.actions(class="col-md-#{col_num - 1}")
-      = button_tag 'Add table parameter', class: 'btn btn-primary'

data/app/views/rails_api_doc/api_docs/_side_menu.slim

@@ -1,9 +0,0 @@
-nav.bs-docs-sidebar.hidden-print.hidden-sm.hidden-xs
- ul.side-menu.nav.bs-docs-sidenav
-   - locals[:models].each do |model|
-    li
-      a[href=('#' + model.to_s)] = model.to_s
-      span = '('
-      a[href=('#' + model.to_s + '.request')] req,
-      a[href=('#' + model.to_s + '.response')] resp
-      span = ')'

data/app/views/rails_api_doc/api_docs/_title.slim

@@ -1,4 +0,0 @@
-.bs-docs-section
-  h1#grid.page-header
-    a.anchorjs-link[href="#grid" aria-label="Anchor link for: grid" data-anchorjs-icon="" style="font-family: anchorjs-icons; font-style: normal; font-variant: normal; font-weight: normal; line-height: inherit; position: absolute; margin-left: -1em; padding-right: 0.5em;"]
-    | Api documentation

data/app/views/rails_api_doc/api_docs/example.html.erb

@@ -1,32 +0,0 @@
-<table class="table table-condensed">
-  <thead class="thead-default">
-    <tr>
-      <th>#</th>
-      <th>First Name</th>
-      <th>Last Name</th>
-      <th>Username</th>
-    </tr>
-  </thead>
-  <tbody>
-    <tr class="success">
-      <th scope="row">1</th>
-      <td>Mark</td>
-      <td>Otto</td>
-      <td>@mdo</td>
-    </tr>
-    <tr class="active">
-      <th scope="row">2</th>
-      <td>Jacob</td>
-      <td>Thornton</td>
-      <td>@fat</td>
-    </tr>
-    <tr>
-      <th scope="row" class="warning">3</th>
-      <td>Larry</td>
-      <td>the Bird</td>
-      <td>@twitter</td>
-    </tr>
-  </tbody>
-</table>
-
-

data/app/views/shared/_response_table.slim

@@ -1,30 +0,0 @@
-- nesting = locals[:nesting] || []
-
-div.flex-table
-
-  = form_tag(api_doc_url(nesting: nesting), method: :put, remote: true, class: 'flex-line row') do
-    / Угловой елемент
-    div.flex-item
-      // TODO: use icon with + to indicate adding
-      span.add-ico = '( + )'
-      = text_field_tag 'name', nil, placeholder: 'Enter param name'
-      span Parameter
-
-    div.flex-item Value
-
-    = submit_tag 'Save', class: 'flex-item mod-submit'
-
-  - locals[:rows].each do |row_name, node|
-    = form_tag(api_doc_url(nesting: nesting), method: :put, remote: true, class: 'flex-line row') do
-      div.flex-item
-        span.edit-ico = '(edit)'
-        = text_field_tag 'name', row_name, placeholder: 'Enter param name'
-        span #{row_name}
-      - if node.nested?
-        div.flex-item.next-is-nested #{node.attr}(Nested)
-      - else
-        div.flex-item #{node.attr}
-      = submit_tag 'Save', class: 'flex-item mod-submit'
-
-    - if node.nested?
-      = render 'shared/response_table', locals: { rows: node.nested, nesting: nesting + [row_name] }

data/lib/rails_api_doc/controller/parameter/repository/param.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-# author: Vadim Shaveiko <@vshaveyko>
-class RailsApiDoc::Controller::Parameter::Repository::Param
-
-  NESTED_TYPES = [:ary_object, :object, :model, Object].freeze
-
-  STRAIGHT_TYPES = [:bool, :string, :integer, :array, :datetime, :enum, String, Object, Integer, Array, DateTime].freeze
-
-  ACCEPTED_TYPES = (NESTED_TYPES + STRAIGHT_TYPES).freeze
-
-  # @type - type to check
-  def self.accepted_nested_type?(type)
-    type.in?(NESTED_TYPES)
-  end
-
-  def self.valid_type?(type)
-    return if type.nil? || type.in?(ACCEPTED_TYPES)
-    raise ArgumentError, "Wrong type: #{type}. " \
-                         "Correct types are: #{ACCEPTED_TYPES}."
-  end
-
-  def self.valid_enum?(type, enum)
-    return false unless type == :enum
-    return if enum.is_a?(Array)
-    raise ArgumentError, 'Enum must be an array.'
-  end
-
-  def self.valid_nested?(type, block_given)
-    return false unless accepted_nested_type?(type)
-    return true if block_given
-    raise ArgumentError, 'Empty object passed.'
-  end
-
-  def initialize(name, store)
-    @name = name
-    @store = store
-  end
-
-  def enum?
-    @store[:type] == :enum && @store[:enum].present?
-  end
-
-  def ary_object?
-    @store[:type] == :ary_object
-  end
-
-  def nested?
-    self.class.accepted_nested_type?(@store[:type])
-  end
-
-  def nesting
-    @store[:nested]
-  end
-
-  def required?
-    @store[:required]
-  end
-
-  def method_missing(name, *args)
-    return @store.public_send(name, *args) if respond_to_missing?(name)
-    super
-  end
-
-  def respond_to_missing?(name, *)
-    @store.respond_to?(name)
-  end
-
-end

data/lib/rails_api_doc/controller/parameter.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-# author: Vadim Shaveiko <@vshaveyko>
-module RailsApiDoc::Controller::Parameter
-
-  VALID_KEYS = [:type, :required, :enum, :model].freeze #:nodoc:
-
-  # Use parameter in controller to defined REQUEST parameter.
-  # Adds it to repository: RailsApiDoc::Controller::Parameter::Repository
-  def parameter(name, options = {}, &block)
-    raise ArgumentError, 'Parameter already defined.' if repo.key?(name)
-
-    validate_options(options, block_given?)
-
-    define_parameter(name, options, &block)
-  end
-
-  private
-
-  def validate_options(options, block_given)
-    options.assert_valid_keys(VALID_KEYS)
-
-    Repository::Param.valid_type?(options[:type])
-  end
-
-  # default repo can be reassigned to deal with nested parameters
-  # see nested_parameter
-  def repo
-    @repo || Repository[self]
-  end
-
-  # adjust parameter values depending on parameter type
-  # 1. if nested - add nested values to parameter_data on :nested key
-  # 2. if enum - transform all values to_s
-  #    bcs all incoming controller parameters will be strings and there can be errors
-  def define_parameter(name, parameter_data, &block)
-    if Repository::Param.valid_nested?(parameter_data[:type], block_given?)
-      parameter_data = nested_parameter(parameter_data, &block)
-    elsif Repository::Param.valid_enum?(parameter_data[:type], parameter_data[:enum])
-      parameter_data[:enum].map!(:to_s)
-    end
-
-    repo[name] = Repository::Param.new(name, parameter_data)
-  end
-
-  def nested_parameter(parameter_data)
-    _backup_repo = @repo
-    @repo = {}
-    yield
-    parameter_data.merge(nested: @repo)
-  ensure
-    @repo = _backup_repo
-  end
-
-end

data/lib/rails_api_doc/controller/strong_params.rb

@@ -1,71 +0,0 @@
-# author: Vadim Shaveiko <@vshaveyko>
-# frozen_string_literal: true
-module RailsApiDoc::Controller::StrongParams
-
-  ParamIsRequired = Class.new(StandardError)
-
-  def resource_params
-    # accepted_params for permit
-    params.permit(params_to_permit)
-  end
-
-  private
-
-  def params_to_permit
-    accepted_params = [{}]
-
-    loop_params(params, permitted_params, accepted_params)
-
-    accepted_params
-  end
-
-  # loop through current level of params and add to permit level if all requirements are met
-  #
-  # requirements are: 1) if required is set - param must be present and not empty => or error is raised
-  #                   2) if enum is set - param must equal predefined value => see Config::ValidateEnum
-  #                   3) if ary_object => see Config::ValidateAryObject
-  #                   3) if config.check_params_type is set - param must be of required type
-  #
-  # @accepted_params = [{}] - array with last member hash for nesting
-  # @level_params - current nesting level params
-  # @level_permitted_params - data for params permission
-  def loop_params(params, level_permitted_params, accepted_params)
-    level_permitted_params.each do |param_name, api_param_data|
-      controller_param = params[param_name]
-
-      check_required(param_name, controller_param, api_param_data)
-      #
-      # no value present && not required => go next
-      next unless controller_param
-
-      next unless RailsApiDoc::Config::Validator.valid_param?(controller_param, api_param_data)
-
-      # if settings is array
-      if api_param_data.ary_object?
-        controller_param.each do |single_controller_param|
-          _next_nesting_level(single_controller_param, param_data: api_param_data, current_accepted_params: accepted_params, param_name: param_name)
-        end
-      elsif api_param_data.nested?
-        _next_nesting_level(controller_param, param_data: api_param_data, current_accepted_params: accepted_params, param_name: param_name)
-      else
-        accepted_params.unshift(param_name)
-      end
-    end
-  end
-
-  def _next_nesting_level(controller_param, param_data:, current_accepted_params:, param_name:)
-    level_accepted_params = current_accepted_params.last[param_name] = [{}]
-
-    loop_params(controller_param, param_data.nesting, level_accepted_params)
-  end
-
-  def permitted_params
-    ::RailsApiDoc::Controller::Parameter::Repository[self.class]
-  end
-
-  def check_required(param_name, param_data, param_config)
-    return unless param_config.required? && param_data.blank?
-    raise RailsApiDoc::Exception::ParamRequired, param_name
-  end
-
-end

data/lib/rails_api_doc/controller.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-# author: Vadim Shaveiko <@vshaveyko>
-module RailsApiDoc
-  module Controller
-  end
-end