rails_api_documentation 0.2.3 → 0.3.0

data/lib/rails_api_doc/controller/headers.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+# author: Vadim Shaveiko <@vshaveyko>
+# :nodoc:
+module RailsApiDoc
+  module Controller
+    module Headers
+
+      DESC_HEADER = {
+        'Desc' => {
+          value: lambda do |_row_name, row_values|
+            row_values[:desc] || row_values.param&.desc || 'TODO: add description'
+          end,
+          fill_type: :input,
+          param: :desc
+        }
+      }.freeze
+
+      TYPE_HEADER = {
+        'Type' => {
+          value: lambda do |_row_name, row_values|
+            row_values.display_type
+          end,
+          fill_type: :select,
+          param: :type,
+          values: RailsApiDoc::ACCEPTED_TYPES
+        }
+      }.freeze
+
+      SPECIAL_HEADER = {
+        'Special' => {
+          value: lambda do |_row_name, row_values|
+            row_values.display_special
+          end,
+          fill_type: :input,
+          param: :special
+        }
+      }.freeze
+
+      NAME_HEADER = {
+        'Parameter' => {
+          value: lambda do |row_name, row_values|
+            row_values.display_name
+          end,
+          fill_type: :input,
+          param: :name
+        }
+      }.freeze
+
+      VALUE_HEADER = {
+        'Value' => {
+          value: lambda do |_row_name, row_values|
+            row_values.display_value
+          end
+        }
+      }.freeze
+
+    end
+  end
+end

data/lib/rails_api_doc/controller/param.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+# author: Vadim Shaveiko <@vshaveyko>
+module RailsApiDoc
+  module Controller
+    class Param
+
+      COMMON_VALID_KEYS = [:type, :model, :desc, :id, :nested, :action_type].freeze #:nodoc:
+      VALID_REQUEST_KEYS = [:required, :enum, :value].freeze
+      VALID_RESPONSE_KEYS = [:attr].freeze
+      VALID_KEYS = (COMMON_VALID_KEYS + VALID_REQUEST_KEYS + VALID_RESPONSE_KEYS).freeze
+
+      HELPER_KEYS = [:new, :is_new, :param, :name, :store].freeze
+      attr_accessor *HELPER_KEYS
+
+      #
+      # define methods responding to each type with '?'
+      # ex: ary_object? array? string?
+      #
+      RailsApiDoc::ACCEPTED_TYPES.each do |type|
+        define_method "#{type}?" do
+          @store[:type] == type.to_sym
+        end
+      end
+
+      #
+      # redirect all keys accssors to store
+      # .type= is @store[:type]=
+      # .type  is @store[:type]
+      #
+      def self.define_accessors(*accessors)
+        accessors.each do |acc|
+          define_method acc do
+            @store[acc]
+          end
+
+          define_method "#{acc}?" do
+            @store[acc].present?
+          end
+
+          define_method "#{acc}=" do |val|
+            @store[acc] = val
+          end
+        end
+      end
+
+      #
+      # define methods for each store key
+      # type, name, etc
+      #
+      define_accessors *COMMON_VALID_KEYS
+
+      #
+      # try sending other methods to @store
+      # if possible
+      #
+      delegate :[], :[]=, :each_value, to: :@store
+
+      #
+      # these are actions applied to the params by gem user from frontend
+      #
+      def destroyed?
+        param&.action_type == 'destroy'
+      end
+
+      def created?
+        param&.action_type == 'create'
+      end
+
+      def updated?
+        param&.action_type == 'update'
+      end
+
+      def add_updated_field(field)
+        @new.push(field) unless field.in?(@new)
+      end
+
+      #
+      # redefine to get desired behaviour
+      #
+      def display_type
+        t = if nested?
+              (model || type).to_s + '(Nested)'
+            else
+              type.to_s
+            end
+
+        t += "(#{param.type})" if param && param.type != type
+
+        t
+      end
+
+      #
+      # redefined in descendants
+      #
+      def display_special
+      end
+
+      #
+      # redefined in descendants
+      #
+      def display_name
+        @name
+      end
+
+      #
+      # redefined in descendants
+      #
+      def display_value
+      end
+
+    end
+  end
+end

data/lib/rails_api_doc/controller/repo.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# author: Vadim Shaveiko <@vshaveyko>
+# :nodoc:
+module RailsApiDoc::Controller::Repo
+
+  attr_accessor :repo
+
+  def self.extended(base)
+    base.instance_eval do
+      @repo = Hash.new do |hsh, key|
+        hsh[key] = Hash.new do |hsh, key|
+          hsh[key] = RailsApiDoc::Controller::Request::Param.new(key, {})
+        end
+      end
+    end
+  end
+
+  def method_missing(name, *args, &block)
+    return @repo.send(name, *args, &block) if respond_to_missing?(name)
+    super
+  end
+
+  def respond_to_missing?(method, *)
+    @repo.respond_to?(method)
+  end
+
+  def []=(key, value)
+    unless key < ActionController::Base
+      raise ArgumentError, 'Repository keys are controllers only'
+    end
+
+    super
+  end
+
+end

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

@@ -5,8 +5,6 @@ module RailsApiDoc
     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)
@@ -20,7 +18,7 @@ module RailsApiDoc
         private
 
         def validate_options(options, block_given)
-          options.assert_valid_keys(VALID_KEYS)
+          options.assert_valid_keys(RailsApiDoc::Controller::Param::VALID_KEYS)
 
           RailsApiDoc::Controller::Request::Param.valid_type?(options[:type])
         end

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

@@ -0,0 +1,29 @@
+# :nodoc:
+class RailsApiDoc::Controller::Request::Factory
+
+  class << self
+
+    def repo
+      attributes = RailsApiDoc::Controller::Request::Repository.new
+
+      attributes = merge_attributes_from_model attributes
+
+      attributes
+    end
+
+    def registered_controllers
+      RailsApiDoc::Controller::Request::Repository.repo.keys
+    end
+
+    private
+
+    #
+    # do not mutate attributes
+    #
+    def merge_attributes_from_model(attributes)
+      RailsApiDoc::Model::AttributeMerger.new(attributes).call(api_type: 'request')
+    end
+
+  end
+
+end

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

@@ -1,55 +1,24 @@
+# frozen_string_literal: true
+# author: Vadim Shaveiko <@vshaveyko>
 # :nodoc:
 module RailsApiDoc
   module Controller
     module Request
       module Headers
 
+        include RailsApiDoc::Controller::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
-          }
-        }
+        REQUEST_HEADERS = [
+          NAME_HEADER,
+          TYPE_HEADER,
+          SPECIAL_HEADER,
+          DESC_HEADER
+        ].reduce(&:merge).freeze
+
       end
     end
   end

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

@@ -3,25 +3,25 @@
 module RailsApiDoc
   module Controller
     module Request
-      class Param
+      class Param < RailsApiDoc::Controller::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
+        #
+        # define methods for each store key
+        # type, name, etc
+        #
+        define_accessors *VALID_REQUEST_KEYS
 
         #
         # @type - type to check
         #
         def self.accepted_nested_type?(type)
-          type.in?(NESTED_TYPES)
+          type.in?(RailsApiDoc::NESTED_TYPES)
         end
 
         def self.valid_type?(type)
-          return if type.nil? || type.in?(ACCEPTED_TYPES)
+          return if type.nil? || type.in?(RailsApiDoc::ACCEPTED_TYPES)
           raise ArgumentError, "Wrong type: #{type}. " \
-          "Correct types are: #{ACCEPTED_TYPES}."
+                               "Correct types are: #{RailsApiDoc::ACCEPTED_TYPES}."
         end
 
         def self.valid_enum?(type, enum)
@@ -36,43 +36,36 @@ module RailsApiDoc
           raise ArgumentError, 'Empty object passed.'
         end
 
-        def initialize(name, store)
+        def initialize(name, store, is_new: false)
           @name = name
           @store = store
+
+          @new = []
+          @is_new = is_new
         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]
+        def display_special
+          spec = if enum?
+                  enum
+                elsif nested?
+                  model
+                end
 
-            return @store[:type] == type_name.to_sym
-          end
+          spec = spec.to_s + "(#{param.special})" if param&.special
 
-          if @store.key?(name)
-            return @store[name]
-          end
+          spec
+        end
 
-          if respond_to_missing?(name)
-            return @store.public_send(name, *args)
-          end
+        def display_name
+          title = @name.to_s
 
-          super
-        end
+          title += '*' if required?
 
-        def respond_to_missing?(name, *)
-          @store.respond_to?(name) || @store.key?(name)
+          title
         end
 
       end

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

@@ -3,33 +3,12 @@
 # :nodoc:
 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) } }
-
-  class << self
-
-    def method_missing(name, *args, &block)
-      return @repo.send(name, *args, &block) if respond_to_missing?(name)
-      super
-    end
-
-    def registered_controllers
-      @repo.keys
-    end
-
-    def respond_to_missing?(method, *)
-      @repo.respond_to?(method)
-    end
-
-    def []=(key, value)
-      unless key < ActionController::Base
-        raise ArgumentError, 'Repository keys are controllers only'
-      end
-
-      super
-    end
+  include RailsApiDoc::Controller::Request::Headers
+  extend RailsApiDoc::Controller::Repo
+  include RailsApiDoc::Controller::Repo
 
+  def initialize
+    @repo = self.class.repo.clone.transform_values { |v| v.deep_dup }
   end
 
 end