apipie-rails-jq 1.4.3.pre.beta.pre.jq.1

data/lib/apipie/extractor/writer.rb

@@ -0,0 +1,454 @@
+require 'set'
+
+module Apipie
+  module Extractor
+    class Writer
+      class << self
+        def compressed
+          Apipie.configuration.compress_examples
+        end
+
+        def update_action_description(controller, action)
+          updater = ActionDescriptionUpdater.new(controller, action)
+          yield updater
+          updater.write!
+        rescue ActionDescriptionUpdater::ControllerNotFound
+          logger.warn("REST_API: Couldn't find controller file for #{controller}")
+        rescue ActionDescriptionUpdater::ActionNotFound
+          logger.warn("REST_API: Couldn't find action #{action} in #{controller}")
+        end
+
+        def write_recorded_examples(examples)
+          FileUtils.mkdir_p(File.dirname(examples_file))
+          content = serialize_examples(examples)
+          content = Zlib::Deflate.deflate(content).force_encoding('utf-8') if compressed
+          File.open(examples_file, 'w') { |f| f << content }
+        end
+
+        def load_recorded_examples
+          return {} unless File.exist?(examples_file)
+          load_json_examples
+        end
+
+        def examples_file
+          pure_path = Rails.root.join(
+            Apipie.configuration.doc_path, 'apipie_examples.json'
+          )
+          zipped_path = pure_path.to_s + '.gz'
+          return zipped_path if compressed
+          pure_path.to_s
+        end
+
+        protected
+
+        def serialize_examples(examples)
+          JSON.pretty_generate(
+            OrderedHash[*examples.sort_by(&:first).flatten(1)]
+          )
+        end
+
+        def deserialize_examples(examples_string)
+          examples = JSON.parse(examples_string)
+          return {} if examples.nil?
+          examples.each_value do |records|
+            records.each do |record|
+              record['verb'] = record['verb'].to_sym if record['verb']
+            end
+          end
+        end
+
+        def load_json_examples
+          raw = IO.read(examples_file)
+          raw = Zlib::Inflate.inflate(raw).force_encoding('utf-8') if compressed
+          deserialize_examples(raw)
+        end
+
+        def logger
+          Extractor.logger
+        end
+      end
+
+      def initialize(collector)
+        @collector = collector
+      end
+
+
+      def write_examples
+        merged_examples = merge_old_new_examples
+        self.class.write_recorded_examples(merged_examples)
+      end
+
+      def write_docs
+        descriptions = @collector.finalize_descriptions
+        descriptions.each_value do |desc|
+          if desc[:api].empty?
+            logger.warn("REST_API: Couldn't find any path for #{desc_to_s(desc)}")
+            next
+          end
+          self.class.update_action_description(desc[:controller], desc[:action]) do |u|
+            u.update_generated_description desc
+          end
+        end
+      end
+
+
+      protected
+
+
+      def desc_to_s(description)
+        "#{description[:controller].name}##{description[:action]}"
+      end
+
+      def ordered_call(call)
+        call = call.stringify_keys
+        ordered_call = OrderedHash.new
+        %w[title verb path versions query request_data response_data code show_in_doc recorded].each do |k|
+          next unless call.key?(k)
+          ordered_call[k] = case call[k]
+                     when ActiveSupport::HashWithIndifferentAccess
+                       convert_file_value(call[k]).to_hash
+                     else
+                       call[k]
+                     end
+      end
+        return ordered_call
+      end
+
+      def convert_file_value hash
+        hash.each do |k, v|
+          case v
+          when Rack::Test::UploadedFile, ActionDispatch::Http::UploadedFile
+            hash[k] = "<FILE CONTENT '#{v.original_filename}'>"
+          when Hash
+            hash[k] = convert_file_value(v)
+          end
+        end
+        hash
+      end
+
+      def load_recorded_examples
+        self.class.load_recorded_examples
+      end
+
+      def merge_old_new_examples
+        new_examples = self.load_new_examples
+        old_examples = self.load_recorded_examples
+        merged_examples = []
+        (new_examples.keys + old_examples.keys).uniq.each do |key|
+          if new_examples.key?(key)
+            if old_examples.key?(key)
+              records = deep_merge_examples(new_examples[key], old_examples[key])
+            else
+              records = new_examples[key]
+            end
+          else
+            records = old_examples[key]
+          end
+          merged_examples << [key, records.map { |r| ordered_call(r) } ]
+        end
+        return merged_examples
+      end
+
+      def deep_merge_examples(new_examples, old_examples)
+        new_examples.map do |new_example|
+          # Use ordered to get compareble output (mainly for the :query)
+          new_example_ordered = ordered_call(new_example.dup)
+
+          # Comparing verb, versions and query
+          if old_example = old_examples.find{ |old_example| old_example["verb"] == new_example_ordered["verb"] && old_example["versions"] == new_example_ordered["versions"] && old_example["query"] == new_example_ordered["query"]}
+
+            # Take the 'show in doc' attribute from the old example if it is present and the configuration requests the value to be persisted.
+            new_example[:show_in_doc] = old_example["show_in_doc"] if Apipie.configuration.persist_show_in_doc && old_example["show_in_doc"].to_i > 0
+
+            # Always take the title from the old example if it exists.
+            new_example[:title] ||= old_example["title"] if old_example["title"].present?
+          end
+          new_example
+        end
+      end
+
+      def load_new_examples
+        @collector.records.reduce({}) do |h, (method, calls)|
+          showed_in_versions = Set.new
+          # we have already shown some example
+          recorded_examples = calls.map do |call|
+            method_descriptions = Apipie.get_method_descriptions(call[:controller], call[:action])
+            call[:versions] = method_descriptions.map(&:version)
+
+            if Apipie.configuration.show_all_examples
+              show_in_doc = 1
+            elsif call[:versions].any? { |v| ! showed_in_versions.include?(v) }
+              call[:versions].each { |v| showed_in_versions << v }
+              show_in_doc = 1
+            else
+              show_in_doc = 0
+            end
+            example = call.merge(:show_in_doc => show_in_doc.to_i, :recorded => true)
+            example
+          end
+          h.update(method => recorded_examples)
+        end
+      end
+
+      def load_old_examples
+        if File.exist?(@examples_file)
+          if defined? SafeYAML
+            return YAML.load_file(@examples_file, :safe=>false)
+          else
+            return YAML.load_file(@examples_file)
+          end
+        end
+        return {}
+      end
+
+      def logger
+        self.class.logger
+      end
+
+      def showable_in_doc?(call)
+        # we don't want to mess documentation with too large examples
+        if hash_nodes_count(call["request_data"]) + hash_nodes_count(call["response_data"]) > 100
+          return false
+        else
+          return 1
+        end
+      end
+
+      def hash_nodes_count(node)
+        case node
+        when Hash
+          1 + (node.values.map { |v| hash_nodes_count(v) }.reduce(:+) || 0)
+        when Array
+          node.map { |v| hash_nodes_count(v) }.reduce(:+) || 1
+        else
+          1
+        end
+      end
+
+    end
+
+    class ActionDescriptionUpdater
+
+      class ControllerNotFound < StandardError; end
+
+      class ActionNotFound < StandardError; end
+
+      def initialize(controller, action)
+        @controller = controller
+        @action = action
+      end
+
+      def generated?
+        old_header.include?(Apipie.configuration.generated_doc_disclaimer)
+      end
+
+      def update_apis(apis)
+        new_header = ""
+        new_header << Apipie.configuration.generated_doc_disclaimer << "\n" if generated?
+        new_header << generate_apis_code(apis)
+        new_header << ensure_line_breaks(old_header.lines).reject do |line|
+          line.include?(Apipie.configuration.generated_doc_disclaimer) ||
+            line =~ /^api/
+        end.join
+        overwrite_header(new_header)
+      end
+
+      def update_generated_description(desc)
+        if generated? || old_header.empty?
+          new_header = generate_code(desc)
+          overwrite_header(new_header)
+        end
+      end
+
+      def update(new_header)
+        overwrite_header(new_header)
+      end
+
+      def old_header
+        return @old_header if defined? @old_header
+        @old_header = lines_above_method[/^\s*?#{Regexp.escape(Apipie.configuration.generated_doc_disclaimer)}.*/m]
+        @old_header ||= lines_above_method[/^\s*?\b(api|params|error|example)\b.*/m]
+        @old_header ||= ""
+        @old_header.sub!(/\A\s*\n/,"")
+        @old_header = align_indented(@old_header)
+      end
+
+      def write!
+        File.open(controller_path, "w") { |f| f << @controller_content }
+        @changed=false
+      end
+
+      protected
+
+      def logger
+        Extractor.logger
+      end
+
+      def action_line
+        return @action_line if defined? @action_line
+        @action_line = ensure_line_breaks(controller_content.lines).find_index { |line| line =~ /def \b#{@action}\b/ }
+        raise ActionNotFound unless @action_line
+        @action_line
+      end
+
+      def controller_path
+        @controller_path ||= Apipie::Extractor.controller_path(@controller.controller_path)
+      end
+
+      def controller_content
+        raise ControllerNotFound.new unless controller_path && File.exist?(controller_path)
+        @controller_content ||= File.read(controller_path)
+      end
+
+      def controller_content=(new_content)
+        return if @controller_name == new_content
+        remove_instance_variable("@action_line")
+        remove_instance_variable("@old_header")
+        @controller_content=new_content
+        @changed = true
+      end
+
+      def generate_code(desc)
+        code = "#{Apipie.configuration.generated_doc_disclaimer}\n"
+        code << generate_apis_code(desc[:api])
+        code << generate_params_code(desc[:params])
+        code << generate_errors_code(desc[:errors])
+        return code
+      end
+
+      def generate_apis_code(apis)
+        code = ""
+        apis.sort_by {|a| a[:path] }.each do |api|
+          desc = api[:desc]
+          name = @controller.controller_name.gsub("_", " ")
+          desc ||= case @action.to_s
+                   when "show", "create", "update", "destroy"
+                     name = name.singularize
+                     "#{@action.capitalize} #{/^[aeiou]/.match?(name) ? 'an' : 'a'} #{name}"
+                   when "index"
+                     "List #{name}"
+                   end
+
+          code << "api :#{api[:method]}, '#{api[:path]}'"
+          code << ", '#{desc}'" if desc
+          code << "\n"
+        end
+        return code
+      end
+
+      def generate_params_code(params, indent = "")
+        code = ""
+        params.sort_by {|n,_| n }.each do |(name, desc)|
+          desc[:type] = (desc[:type] && desc[:type].first) || Object
+          code << "#{indent}param"
+          if /\W/.match?(name)
+            code << " :'#{name}'"
+          else
+            code << " :#{name}"
+          end
+          code << ", #{desc[:type].inspect}"
+          if desc[:allow_nil]
+            code << ", allow_nil: true"
+          end
+          if desc[:required]
+            code << ", required: true"
+          end
+          if desc[:nested]
+            code << " do\n"
+            code << generate_params_code(desc[:nested], indent + "  ")
+            code << "#{indent}end"
+          else
+          end
+          code << "\n"
+        end
+        code
+      end
+
+      def generate_errors_code(errors)
+        code = ""
+        errors.sort_by {|e| e[:code] }.each do |error|
+          code << "error code: #{error[:code]}\n"
+        end
+        code
+      end
+
+      def align_indented(text)
+        shift_left = ensure_line_breaks(text.lines).map { |l| l[/^\s*/].size }.min
+        ensure_line_breaks(text.lines).map { |l| l[shift_left..-1] }.join
+      end
+
+      def overwrite_header(new_header)
+        overwrite_line_from = action_line
+        overwrite_line_to = action_line
+        unless old_header.empty?
+          overwrite_line_from -= ensure_line_breaks(old_header.lines).count
+        end
+        lines = ensure_line_breaks(controller_content.lines).to_a
+        indentation = lines[action_line][/^\s*/]
+        self.controller_content= (lines[0...overwrite_line_from] +
+                              [new_header.gsub(/^/,indentation)] +
+                              lines[overwrite_line_to..-1]).join
+      end
+
+      # returns all the lines before the method that might contain the restpi descriptions
+      # not bulletproof but working for conventional Ruby code
+      def lines_above_method
+        added_lines = []
+        lines_to_add = []
+        block_level = 0
+        ensure_line_breaks(controller_content.lines).first(action_line).reverse_each do |line|
+          if /\s*\bend\b\s*/.match?(line)
+            block_level += 1
+          end
+          if block_level > 0
+            lines_to_add << line
+          else
+            added_lines << line
+          end
+          if /\s*\b(module|class|def)\b /.match?(line)
+            break
+          end
+          next unless /do\s*(\|.*?\|)?\s*$/.match?(line)
+          block_level -= 1
+          if block_level == 0
+            added_lines.concat(lines_to_add)
+            lines_to_add = []
+          end
+        end
+        return added_lines.reverse.join
+      end
+
+      # this method would be totally useless unless some clever guy
+      # decided that it would be great idea to change a behavior of
+      # "".lines method to not include end of lines.
+      #
+      # For more details:
+      #   https://github.com/puppetlabs/puppet/blob/0dc44695/lib/puppet/util/monkey_patches.rb
+      def ensure_line_breaks(lines)
+        if lines.to_a.size > 1 && lines.first !~ /\n\Z/
+          lines.map { |l| !/\n\Z/.match?(l) ? (l << "\n") : l }.to_enum
+        else
+          lines
+        end
+      end
+    end
+
+    # Used to keep apipie_examples.yml params in order
+    class OrderedHash < ActiveSupport::OrderedHash
+
+      def to_yaml_type
+        "!tag:yaml.org,2002:map"
+      end
+
+      def to_yaml(opts = {})
+        YAML.quick_emit(self, opts) do |out|
+          out.map(taguri) do |map|
+            each do |k, v|
+              map.add(k, v)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/apipie/extractor.rb

@@ -0,0 +1,181 @@
+require 'singleton'
+require 'fileutils'
+require 'set'
+require 'yaml'
+require 'apipie/extractor/recorder'
+require 'apipie/extractor/writer'
+require 'apipie/extractor/collector'
+
+class Apipie::Railtie
+  initializer 'apipie.extractor' do |app|
+    ActiveSupport.on_load :action_controller do
+      before_action do |controller|
+        if Apipie.configuration.record
+          Apipie::Extractor.call_recorder.analyse_controller(controller)
+        end
+      end
+    end
+
+    if Apipie.configuration.record
+      app.middleware.use ::Apipie::Extractor::Recorder::Middleware
+
+      ActionController::TestCase.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
+      ActionController::TestCase::Behavior.send(:prepend, Apipie::Extractor::Recorder::FunctionalTestRecording)
+    end
+  end
+end
+
+module Apipie
+
+  module Extractor
+
+    class << self
+
+      def start(record)
+        Apipie.configuration.record = record
+        Apipie.configuration.force_dsl = true
+      end
+
+      def finish
+        record_params, record_examples = false, false
+        case Apipie.configuration.record
+        when "params"   then record_params = true
+        when "examples" then record_examples = true
+        when "all"      then record_params = true, record_examples = true
+        end
+
+        if record_examples
+          puts "Writing examples to a file"
+          write_examples
+        end
+        if record_params
+          puts "Updating auto-generated documentation"
+          write_docs
+        end
+      end
+
+      delegate :logger, to: :Rails
+
+      def call_recorder
+        Thread.current[:apipie_call_recorder] ||= Recorder.new
+      end
+
+      def call_finished
+        @collector ||= Collector.new
+        if record = call_recorder.record
+          @collector.handle_record(record)
+        end
+      end
+
+      def clean_call_recorder
+        Thread.current[:apipie_call_recorder] = nil
+      end
+
+      def write_docs
+        Writer.new(@collector).write_docs if @collector
+      end
+
+      def write_examples
+        Writer.new(@collector).write_examples if @collector
+      end
+
+      def apis_from_routes
+        return @apis_from_routes if @apis_from_routes
+
+        @api_prefix = Apipie.api_base_url.sub(%r{/$},"")
+        populate_api_routes
+        update_api_descriptions
+
+        @apis_from_routes
+      end
+
+      def controller_path(name)
+        Apipie.api_controllers_paths.detect { |p| p.include?("#{name}_controller.rb") }
+      end
+
+      private
+
+      def all_api_routes
+        all_routes = Apipie.configuration.api_routes.routes.map do |r|
+          {
+              :verb => case r.verb
+                         when Regexp then r.verb.source[/\w+/]
+                         else r.verb.to_s
+                       end,
+              :path => case
+                         when r.path.respond_to?(:spec) then r.path.spec.to_s
+                         else r.path.to_s
+                       end,
+              :controller => r.requirements[:controller],
+              :action => r.requirements[:action]
+          }
+        end
+
+        return all_routes.find_all do |r|
+          r[:path].starts_with?(Apipie.api_base_url)
+        end
+      end
+
+      def populate_api_routes
+        @apis_from_routes = Hash.new { |h, k| h[k] = [] }
+
+        all_api_routes.each do |route|
+          controller_path, action = route[:controller], route[:action]
+          next unless controller_path && action
+
+          controller_path = controller_path.split('::').map(&:camelize).join('::')
+          controller = "#{controller_path}Controller"
+
+          path = if /^#{Regexp.escape(@api_prefix)}(.*)$/ =~ route[:path]
+                   $1.sub(/\(\.:format\)$/,'')
+                 else
+                   nil
+                 end
+
+          if route[:verb].present?
+            @apis_from_routes[[controller, action]] << {:method => route[:verb], :path => path}
+          end
+        end
+      end
+
+      def all_apis_from_docs
+        resource_descriptions = Apipie.resource_descriptions.values.map(&:values).flatten
+        method_descriptions = resource_descriptions.map(&:method_descriptions).flatten
+
+        return method_descriptions.reduce({}) do |h, desc|
+          apis = desc.method_apis_to_json.map do |api|
+            { :method => api[:http_method],
+              :path => api[:api_url],
+              :desc => api[:short_description] }
+          end
+          h.update(desc.id => apis)
+        end
+      end
+
+      def update_api_descriptions
+        apis_from_docs = all_apis_from_docs
+        @apis_from_routes.each do |(controller, action), new_apis|
+          method_key = "#{Apipie.get_resource_id(controller.safe_constantize || next)}##{action}"
+          old_apis = apis_from_docs[method_key] || []
+          new_apis.each do |new_api|
+            new_api[:path]&.sub!(/\(\.:format\)$/,"")
+            old_api = old_apis.find do |api|
+              api[:path] == "#{@api_prefix}#{new_api[:path]}"
+            end
+            if old_api
+              new_api[:desc] = old_api[:desc]
+            end
+          end
+        end
+      end
+    end
+  end
+end
+
+if ENV["APIPIE_RECORD"]
+  Apipie::Extractor.start ENV["APIPIE_RECORD"]
+end
+
+at_exit do
+  Apipie::Extractor.finish
+end

data/lib/apipie/generator/config.rb

@@ -0,0 +1,12 @@
+module Apipie
+  module Generator
+    # Configuration interface for generators
+    class Config
+      include Singleton
+
+      def swagger
+        Apipie::Generator::Swagger::Config.instance
+      end
+    end
+  end
+end

data/lib/apipie/generator/generator.rb

@@ -0,0 +1,2 @@
+module Apipie::Generator
+end

data/lib/apipie/generator/swagger/computed_interface_id.rb

@@ -0,0 +1,23 @@
+# The {Apipie::Generator::Swagger::ComputedInterfaceId.id} is a number that is
+# uniquely derived from the list of operations added to the swagger definition (in an order-dependent way).
+# it can be used for regression testing, allowing some differentiation between changes that
+# result from changes to the input and those that result from changes to the generation
+# algorithms.
+#
+# @note At the moment, this only takes operation ids into account, and ignores
+# parameter definitions, so it's only partially useful.
+class Apipie::Generator::Swagger::ComputedInterfaceId
+  include Singleton
+
+  def initialize
+    @computed_interface_id = 0
+  end
+
+  def add!(operation_id)
+    @computed_interface_id = Zlib.crc32("#{@computed_interface_id} #{operation_id}")
+  end
+
+  def id
+    @computed_interface_id
+  end
+end