rails_api_documentation 0.2.2 → 0.2.3

data/lib/rails_api_doc/config/validate_ary_object.rb

@@ -3,7 +3,7 @@
 class RailsApiDoc::Config::ValidateAryObject
 
   #
-  # @api_param_data - RailsApiDoc::Controller::Parameter::Repository::Param
+  # @api_param_data - RailsApiDoc::Controller::Request::Param
   # @controller_param - ActionController::Parameter
   #
   # check validation of current type by given data

data/lib/rails_api_doc/config/validate_enum.rb

@@ -4,7 +4,7 @@
 class RailsApiDoc::Config::ValidateEnum
 
   #
-  # @api_param_data - RailsApiDoc::Controller::Parameter::Repository::Param
+  # @api_param_data - RailsApiDoc::Controller::Ruquest::Param
   # @controller_param - ActionController::Parameter
   #
   # check validation of current type by given data

data/lib/rails_api_doc/config/validate_type.rb

@@ -4,7 +4,7 @@
 class RailsApiDoc::Config::ValidateType
 
   #
-  # @api_param_data - RailsApiDoc::Controller::Parameter::Repository::Param
+  # @api_param_data - RailsApiDoc::Controller::Request::Param
   # @controller_param - ActionController::Parameter
   #
   # check validation of current type by given data

data/lib/rails_api_doc/config/validator.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 # author: Vadim Shaveiko <@vshaveyko>
-require_relative 'validate_ary_object'
-require_relative 'validate_enum'
-require_relative 'validate_type'
-
 class RailsApiDoc::Config::Validator
 
   class << self

data/lib/rails_api_doc/config.rb

@@ -14,5 +14,3 @@ class RailsApiDoc::Config
   end
 
 end
-
-require_relative 'config/validator'

data/lib/rails_api_doc/controller/request/dsl.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+# author: Vadim Shaveiko <@vshaveyko>
+module RailsApiDoc
+  module Controller
+    module Request
+      module DSL
+
+        VALID_KEYS = [:type, :required, :enum, :model, :desc, :value].freeze #:nodoc:
+
+        # Use parameter in controller to define REQUEST parameter.
+        # Adds it to repository: RailsApiDoc::Controller::Request::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)
+
+          RailsApiDoc::Controller::Request::Param.valid_type?(options[:type])
+        end
+
+        # default repo can be reassigned to deal with nested parameters
+        # see nested_parameter
+        def repo
+          @repo || RailsApiDoc::Controller::Request::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 RailsApiDoc::Controller::Request::Param.valid_nested?(parameter_data[:type], block_given?)
+            parameter_data = nested_parameter(parameter_data, &block)
+          elsif RailsApiDoc::Controller::Request::Param.valid_enum?(parameter_data[:type], parameter_data[:enum])
+            parameter_data[:enum].map!(:to_s)
+          end
+
+          repo[name] = RailsApiDoc::Controller::Request::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
+    end
+  end
+end

data/lib/rails_api_doc/controller/request/headers.rb

@@ -0,0 +1,56 @@
+# :nodoc:
+module RailsApiDoc
+  module Controller
+    module Request
+      module Headers
+
+        def headers
+          REQUEST_HEADERS
+        end
+
+        REQUEST_HEADERS = {
+          'Parameter' => {
+            value: -> (row_name, row_values) {
+              title = row_name.to_s
+              title += '*' if row_values.required?
+              title
+            },
+            fill_type: :input,
+            param: :name
+          },
+          'Type' => {
+            value: -> (row_name, row_values) {
+              if row_values.nested?
+                (row_values.model || row_values.type).to_s + "(Nested)"
+              else
+                row_values.type
+              end
+            },
+            fill_type: :select,
+            param: :type,
+            values: RailsApiDoc::Controller::Request::Param::ACCEPTED_TYPES
+          },
+          'Special' => {
+            value: -> (row_name, row_values) {
+              case
+              when row_values.enum?
+                row_values[:enum]
+              when row_values.model?
+                row_values[:model]
+              end
+            },
+            fill_type: :input,
+            param: :special
+          },
+          'Desc' => {
+            value: -> (row_name, row_values) {
+              'TODO: description' # if row_values[:desc]
+            },
+            fill_type: :input,
+            param: :desc
+          }
+        }
+      end
+    end
+  end
+end

data/lib/rails_api_doc/controller/request/param.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+# author: Vadim Shaveiko <@vshaveyko>
+module RailsApiDoc
+  module Controller
+    module Request
+      class 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 nested?
+          self.class.accepted_nested_type?(@store[:type])
+        end
+
+        def required?
+          @store[:required]
+        end
+
+        def method_missing(name, *args)
+          #
+          # define methods responding to each type with '?'
+          # ex: ary_object? array? string?
+          #
+          if name[-1] == '?'
+            type_name = name[0...-1]
+
+            return @store[:type] == type_name.to_sym
+          end
+
+          if @store.key?(name)
+            return @store[name]
+          end
+
+          if respond_to_missing?(name)
+            return @store.public_send(name, *args)
+          end
+
+          super
+        end
+
+        def respond_to_missing?(name, *)
+          @store.respond_to?(name) || @store.key?(name)
+        end
+
+      end
+    end
+  end
+end

data/lib/rails_api_doc/controller/{parameter → request}/repository.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 # author: Vadim Shaveiko <@vshaveyko>
 # :nodoc:
-class RailsApiDoc::Controller::Parameter::Repository
+class RailsApiDoc::Controller::Request::Repository
+
+  extend RailsApiDoc::Controller::Request::Headers
 
   @repo = Hash.new { |hsh, key| hsh[key] = Hash.new { |hsh, key| hsh[key] = Param.new(key) } }
 

data/lib/rails_api_doc/controller/{response_factory.rb → response/factory.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # author: Vadim Shaveiko <@vshaveyko>
 # :nodoc:
-class RailsApiDoc::Controller::Response
+class RailsApiDoc::Controller::Response::Factory
 
   class << self
 
@@ -11,7 +11,7 @@ class RailsApiDoc::Controller::Response
     end
 
     def controllers
-      RailsApiDoc::Controller::Parameter::Repository.registered_controllers
+      RailsApiDoc::Controller::Request::Repository.registered_controllers
     end
 
   end

data/lib/rails_api_doc/controller/response/headers.rb

@@ -0,0 +1,30 @@
+# :nodoc:
+module RailsApiDoc::Controller::Response::Headers
+
+  RESPONSE_HEADERS = {
+    'Parameter' => {
+      value: -> (row_name, row_values) { row_name },
+      fill_type: :input,
+      param: :name
+    },
+    'Value' => {
+      value: -> (row_name, row_values) {
+        title = row_values.attr.to_s
+        title += '(NESTED)' if row_values.nested?
+        title
+      }
+    },
+    'Desc' => {
+      value: -> (row_name, row_values) {
+        'TODO: description' # if row_values[:desc]
+      },
+      fill_type: :input,
+      param: :desc
+    }
+  }
+
+  def headers
+    RESPONSE_HEADERS
+  end
+
+end

data/lib/rails_api_doc/controller/response/param.rb

@@ -0,0 +1,14 @@
+# :nodoc:
+module RailsApiDoc
+  module Controller
+    module Response
+      class Param < Struct.new(:name, :attr, :nested, :model, :desc)
+
+        def nested?
+          !nested.nil?
+        end
+
+      end
+    end
+  end
+end

data/lib/rails_api_doc/controller/response/rabl.rb

@@ -2,11 +2,13 @@
 # author: Vadim Shaveiko <@vshaveyko>
 # :nodoc:
 # :nodoc:
-class RailsApiDoc::Controller::Response
+module RailsApiDoc::Controller::Response
 
   # :nodoc:
   class Rabl
 
+    include RailsApiDoc::Controller::Response::Headers
+
     class << self
 
       attr_accessor :renderer

data/lib/rails_api_doc/controller/response/rabl_compiler.rb

@@ -1,16 +1,7 @@
 # frozen_string_literal: true
 # author: Vadim Shaveiko <@vshaveyko>
 # :nodoc:
-# :nodoc:
-class RailsApiDoc::Controller::Response
-
-  class Node < Struct.new(:name, :attr, :nested)
-
-    def nested?
-      !nested.nil?
-    end
-
-  end
+module RailsApiDoc::Controller::Response
 
   # template struct
   class CompiledAttributes
@@ -36,7 +27,7 @@ class RailsApiDoc::Controller::Response
         n[:name] = "#{n[:name]}(#{n[:attr]})"
       end
 
-      @nodes[n[:name]] = Node.new(n[:name], n[:attr], n[:nested])
+      @nodes[n[:name]] = RailsApiDoc::Controller::Response::Param.new(n[:name], n[:attr], n[:nested])
     end
 
     def extends(template)
@@ -50,9 +41,9 @@ class RailsApiDoc::Controller::Response
 
     def initialize(file_path, view_path: 'app/views')
       paths = Dir["#{view_path}/#{file_path}{.json,}.rabl"]
-      file_path = paths.find { |path| File.exist?(path) }
+      @file_path = paths.find { |path| File.exist?(path) }
 
-      @source = _preserve_ivars File.read(file_path)
+      @source = _preserve_ivars File.read(@file_path)
     rescue
     end
 

data/lib/rails_api_doc/controller/strong_params/dsl.rb

@@ -0,0 +1,17 @@
+# :nodoc:
+module RailsApiDoc
+  module Controller
+    module ResourceParams
+      module DSL
+
+        include RailsApiDoc::Controller::ResourceParams::PermittedParams # implements params_to_permit
+
+        def resource_params
+          # accepted_params for permit
+          params.permit(params_to_permit)
+        end
+
+      end
+    end
+  end
+end

data/lib/rails_api_doc/controller/strong_params/permitted_params.rb

@@ -0,0 +1,88 @@
+# author: Vadim Shaveiko <@vshaveyko>
+# frozen_string_literal: true
+module RailsApiDoc
+  module Controller
+    module ResourceParams
+      module PermittedParams
+
+        private
+
+        def params_to_permit
+          _next_nesting_level(params, param_data: _permitted_params)
+        end
+
+        def _permitted_params
+          ::RailsApiDoc::Controller::Request::Repository[self.class]
+        end
+
+        #
+        # iterate recursively
+        # level_accepted_params initted as [{}] bcs params permit accepts
+        # aray with hash as a last arguments for describing nesting levels
+        #
+        def _next_nesting_level(controller_param, param_data:, current_accepted_params: nil, param_name: nil)
+          level_accepted_params = [{}]
+
+          if param_name && current_accepted_params # no param name and current_accepted_params on first iteration
+            current_accepted_params.last[param_name] = level_accepted_params
+          end
+
+          loop_params(controller_param, param_data, level_accepted_params)
+
+          level_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
+        # @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) # raise if required and no value
+
+            # no value present && not required => skip
+            next unless controller_param
+
+            # value present but not valid for this type => skip
+            next unless RailsApiDoc::Config::Validator.valid_param?(controller_param, api_param_data)
+
+            if api_param_data.ary_object? # controller_param value should be array of objects
+              controller_param.each do |single_controller_param|
+                _next_nesting_level(single_controller_param,
+                                    param_data: api_param_data.nested,
+                                    current_accepted_params: accepted_params,
+                                    param_name: param_name)
+
+              end
+            elsif api_param_data.nested? # value should be nested object
+              _next_nesting_level(controller_param,
+                                  param_data: api_param_data.nested,
+                                  current_accepted_params: accepted_params,
+                                  param_name: param_name)
+
+            else # all other options
+              accepted_params.unshift(param_name)
+            end
+          end
+        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
+    end
+  end
+end

data/lib/rails_api_doc/engine.rb

@@ -4,18 +4,6 @@ require 'jquery-rails' # needed for require in javascript
 
 require_relative 'railtie'
 
-require_relative 'exception/param_required'
-
-require_relative 'controller'
-require_relative 'controller/strong_params'
-require_relative 'controller/attribute_parser'
-
-require_relative 'controller/parameter'
-require_relative 'controller/parameter/repository'
-require_relative 'controller/parameter/repository/param'
-
-require_relative 'controller/response_factory'
-
 # add rabl support
 begin
   require 'rabl'

data/lib/rails_api_doc/{controller → model}/attribute_parser.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 # author: Vadim Shaveiko <@vshaveyko>
 # :nodoc:
-class RailsApiDoc::Controller::AttributeParser
+class RailsApiDoc::Model::AttributeParser
 
   # TODO : Change to I18n. Added on: 08.10.16. Added by: <@vshaveyko>
   WRONG_NAME_ERROR_STRING = 'Name should consist only of letters\ciphers\underscores'

data/lib/rails_api_doc/railtie.rb

@@ -2,8 +2,11 @@ module RailsApiDoc
   class Railtie < Rails::Railtie
     initializer 'api_doc.controller_additions' do
       ActiveSupport.on_load :action_controller do
-        include RailsApiDoc::Controller::StrongParams
-        extend RailsApiDoc::Controller::Parameter
+
+        include RailsApiDoc::Controller::ResourceParams::DSL
+
+        extend RailsApiDoc::Controller::Request::DSL
+
       end
     end
   end

data/lib/rails_api_doc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 # author: Vadim Shaveiko <@vshaveyko>
 module RailsApiDoc
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/lib/rails_api_doc.rb

@@ -1,9 +1,56 @@
 # author: Vadim Shaveiko <@vshaveyko>
 # frozen_string_literal: true
-require 'rails_api_doc/config'
 
 module RailsApiDoc
 
+  module Controller
+    module Response
+      _dir = 'rails_api_doc/controller/response/'
+
+      autoload :Factory, _dir + 'factory'
+      autoload :Headers, _dir + 'headers'
+      autoload :Param, _dir + 'param'
+    end
+
+    module Request
+      _dir = 'rails_api_doc/controller/request/'
+
+      autoload :DSL, _dir + 'dsl'
+      autoload :Param, _dir + 'param'
+      autoload :Headers, _dir + 'headers'
+      autoload :Repository, _dir + 'repository'
+    end
+
+    module ResourceParams
+      _dir = 'rails_api_doc/controller/strong_params/'
+
+      autoload :DSL, _dir + 'dsl'
+      autoload :PermittedParams, _dir + 'permitted_params'
+    end
+  end
+
+  module Model
+    _dir = 'rails_api_doc/model/'
+
+    autoload :AttributeParser, _dir + 'attribute_parser'
+  end
+
+  require 'rails_api_doc/config'
+  class Config
+    _dir = 'rails_api_doc/config/'
+
+    autoload :Validator, _dir + 'validator'
+    autoload :ValidateEnum, _dir + 'validate_enum'
+    autoload :ValidateType, _dir + 'validate_type'
+    autoload :ValidateAryObject, _dir + 'validate_ary_object'
+  end
+
+  module Exception
+    _dir = 'rails_api_doc/exception/'
+
+    autoload :ParamRequired, _dir + 'param_required'
+  end
+
   class << self
 
     def configure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_documentation
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - vs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-26 00:00:00.000000000 Z
+date: 2016-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -139,42 +139,44 @@ files:
 - app/assets/javascripts/rails_api_doc/application.js
 - app/assets/javascripts/table.js.coffee
 - app/assets/stylesheets/rails_api_doc/application.css
+- app/assets/stylesheets/rails_api_doc/default.sass
 - app/assets/stylesheets/rails_api_doc/side_menu.sass
 - app/assets/stylesheets/rails_api_doc/table.sass
 - app/controllers/rails_api_doc/api_docs_controller.rb
 - app/controllers/rails_api_doc/application_controller.rb
 - app/helpers/rails_api_doc/application_helper.rb
+- app/models/rails_api_doc/api_datum.rb
 - app/models/rails_api_doc/application_record.rb
 - app/views/layouts/rails_api_doc/application.slim
-- app/views/rails_api_doc/api_docs/_edit_field.slim
 - app/views/rails_api_doc/api_docs/_request_api_table.slim
 - app/views/rails_api_doc/api_docs/_response_api_table.slim
-- app/views/rails_api_doc/api_docs/_side_menu.slim
-- app/views/rails_api_doc/api_docs/_title.slim
-- app/views/rails_api_doc/api_docs/edit.js.erb
-- app/views/rails_api_doc/api_docs/example.html.erb
 - app/views/rails_api_doc/api_docs/index.slim
-- app/views/rails_api_doc/api_docs/new.js.erb
-- app/views/shared/_response_table.slim
+- app/views/shared/_param_inputs.slim
+- app/views/shared/_side_menu.slim
 - app/views/shared/_table.slim
 - config/routes.rb
+- lib/generators/rails_api_doc/install_generator.rb
+- lib/generators/rails_api_doc/templates/api_datum_migration.rb
 - lib/rails_api_doc.rb
 - lib/rails_api_doc/config.rb
 - lib/rails_api_doc/config/validate_ary_object.rb
 - lib/rails_api_doc/config/validate_enum.rb
 - lib/rails_api_doc/config/validate_type.rb
 - lib/rails_api_doc/config/validator.rb
-- lib/rails_api_doc/controller.rb
-- lib/rails_api_doc/controller/attribute_parser.rb
-- lib/rails_api_doc/controller/parameter.rb
-- lib/rails_api_doc/controller/parameter/repository.rb
-- lib/rails_api_doc/controller/parameter/repository/param.rb
+- lib/rails_api_doc/controller/request/dsl.rb
+- lib/rails_api_doc/controller/request/headers.rb
+- lib/rails_api_doc/controller/request/param.rb
+- lib/rails_api_doc/controller/request/repository.rb
+- lib/rails_api_doc/controller/response/factory.rb
+- lib/rails_api_doc/controller/response/headers.rb
+- lib/rails_api_doc/controller/response/param.rb
 - lib/rails_api_doc/controller/response/rabl.rb
 - lib/rails_api_doc/controller/response/rabl_compiler.rb
-- lib/rails_api_doc/controller/response_factory.rb
-- lib/rails_api_doc/controller/strong_params.rb
+- lib/rails_api_doc/controller/strong_params/dsl.rb
+- lib/rails_api_doc/controller/strong_params/permitted_params.rb
 - lib/rails_api_doc/engine.rb
 - lib/rails_api_doc/exception/param_required.rb
+- lib/rails_api_doc/model/attribute_parser.rb
 - lib/rails_api_doc/railtie.rb
 - lib/rails_api_doc/version.rb
 homepage: https://github.com/vshaveyko/rails_api_doc