Contents

module Rapidoc

  ##
  # This module parse controllers comments to yaml format
  #
  module YamlParser

    ##
    # Check if exist a block with resource information 'rapidoc resource block'
    #
    # @param lines [Array] lines that contain comments
    # @param blocks [Hash] lines of blocks, example: { init: 1, end: 4 }
    # @return [Hash] resource info
    #
    def extract_resource_info( lines, blocks )
      blocks ? info = [] : blocks = []

      blocks.each.map do |b|
        if lines[ b[:init] ].include? "=begin resource"
          n_lines = b[:end] - b[:init] - 1
          info.push YAML.load( lines[ b[:init] +1, n_lines ].join.gsub(/\ *#/, '') )
        end
      end

      info.first ? info.first : {}
    end

    ##
    # Check all blocks and load those that are 'rapidoc actions block'
    #
    # @param lines [Array] lines that contain comments
    # @param blocks [Hash] lines of blocks, example: { init: 1, end: 4 }
    # @return [Array] all actions info
    #
    def extract_actions_info( lines, blocks )
      info = []
      blocks = [] unless blocks

      blocks.each do |block|
        if lines[ block[:init] ].include? "=begin action"
          n_lines = block[:end] - block[:init] - 1
          info << YAML.load( lines[ block[:init] + 1, n_lines ].join.gsub(/\ *#/, '') )
        end
      end

      return info
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
rapidoc-0.0.4	lib/rapidoc/yaml_parser.rb