lurker 0.6.8 → 1.0.0

data/lib/lurker/endpoint.rb

@@ -19,7 +19,7 @@ module Lurker
     RESPONSE_CODES = 'responseCodes'.freeze
     REQUEST_PARAMETERS = 'requestParameters'.freeze
     RESPONSE_PARAMETERS = 'responseParameters'.freeze
-    DESCRPTIONS = {
+    DESCRIPTIONS = {
       'index' => 'listing',
       'show' => '',
       'edit' => 'editing',
@@ -44,7 +44,7 @@ module Lurker
       finalize_schema!
 
       Lurker::Json::Orderer.reorder(schema) unless persisted?
-      Lurker::Json::Writter.write(schema, endpoint_path)
+      Lurker::Json::Writer.write(schema, endpoint_path)
 
       @persisted = true
     end
@@ -131,6 +131,10 @@ module Lurker
       @schema[RESPONSE_CODES]
     end
 
+    def documentation
+      @schema.documentation
+    end
+
     protected
 
     def persisted?
@@ -167,7 +171,7 @@ module Lurker
     def finalize_schema!
       path_params = schema[EXTENSIONS][PATH_PARAMS] || {}
       subject = path_params[CONTROLLER].to_s.split(/\//).last.to_s
-      description = DESCRPTIONS[path_params[ACTION]]
+      description = DESCRIPTIONS[path_params[ACTION]]
 
       schema[DESCRIPTION] = "#{subject.singularize} #{description}".strip if schema[DESCRIPTION].blank?
       schema[PREFIX] = "#{subject} management" if schema[PREFIX].blank?
@@ -188,15 +192,15 @@ module Lurker
     def word_wrap(text)
       # strip .json# | .json.yml# | .json.yml.erb#
       text = text.reverse
-      text.gsub!(/(\n|^)#bre\./, "\nbre.")
-      text.gsub!(/(\n|^)#lmy\./, "\nlmy.")
-      text.gsub!(/(\n|^)#nosj\./, "\nnosj.")
+      text.gsub!(/(\n|^)#bre\./, "\nbre.")   # erb
+      text.gsub!(/(\n|^)#lmy\./, "\nlmy.")   # yml
+      text.gsub!(/(\n|^)#nosj\./, "\nnosj.") # json
       text.strip!
       text = text.reverse
 
       text.gsub!(/\s+in schema/m, "\n  in schema")
       if defined?(Rails)
-        text.gsub!(/file:\/\/#{Rails.root}\//m, "")
+        text.gsub!(Regexp.new("#{Rails.root}\/"), "")
       end
       text
     end

data/lib/lurker/form_builder.rb

@@ -11,55 +11,46 @@ module Lurker
 
     private
 
-    def add_to_buffer(params, parent_labels = [])
-      params.each do |label, value|
-        if parent_labels.present?
-          label = "[#{label}]"
-        end
-
-        new_parent_labels = parent_labels.clone << label
+    def add_to_buffer(params, parent_accessors = [])
+      params.each do |name, value|
 
+        accessors = parent_accessors.clone << name
         if value.is_a?(Hash)
-          add_legend_to_buffer(parent_labels, label)
-
-          add_to_buffer(value, new_parent_labels)
+          add_to_buffer(value, accessors)
         elsif value.is_a?(Array)
-          value.each do |v|
+          value.each_with_index do |v, i|
             if v.is_a?(Hash)
-              add_legend_to_buffer(parent_labels, label)
-
-              add_to_buffer(v, parent_labels.clone << "#{label}[]")
+              add_to_buffer(v, accessors << i)
             else
-              add_element_to_buffer(parent_labels, "#{label}[]", v)
+              add_element_to_buffer(accessors, v)
             end
           end
         else
-          add_element_to_buffer(parent_labels, label, value)
+          add_element_to_buffer(accessors, value)
         end
       end
     end
 
-    def add_element_to_buffer(parent_labels, label, value)
+    def add_element_to_buffer(accessors, value)
       @_buffer += render(
         :partial => 'param_form_element',
-        :locals  => {
-          :label      => "#{print_labels(parent_labels)}#{label}",
-          :label_text => "#{print_labels(parent_labels)}#{label}",
-          :value      => value
+        :locals => {
+          :accessor => "#{accessors.compact.join('.')}",
+          :label => "#{print_labels(accessors)}",
+          :label_text => "#{print_labels(accessors)}",
+          :value => value
         }
       )
     end
 
-    def add_legend_to_buffer(parent_labels, label)
-      return
-      @_buffer += render(
-        :partial => 'param_form_legend',
-        :locals  => { :label => print_labels(parent_labels.clone << label) }
-      )
-    end
-
-    def print_labels(parent_labels)
-      "#{parent_labels * ''}"
+    def print_labels(accessors)
+      accessors.inject do |acc, label|
+        if label.is_a? Numeric
+          "#{acc}[]"
+        else
+          "#{acc}[#{label}]"
+        end
+      end
     end
   end
 end

data/lib/lurker/json/concerns/validatable.rb

@@ -9,7 +9,11 @@ module Lurker
 
         def to_validation_schema
           set_additional_properties_false_on(to_hash).tap do |schema|
-            schema[Json::ID] = "file://#{uri}"
+            if uri.class == URI::Generic
+              schema[Json::ID] = uri.path
+            else
+              schema[Json::ID] = uri.to_s
+            end
           end
         end
 

data/lib/lurker/json/parser.rb

@@ -16,7 +16,7 @@ module Lurker
         @parent_schema = options[:parent_schema]
         @parent_property = options[:parent_property]
         @polymorph_if_empty = options.fetch(:polymorph_if_empty, false)
-        @uri = options[:uri] || @parent_schema.try(:uri)
+        @uri = options[:uri] || @parent_schema&.uri
         @strategy = nil
       end
 

data/lib/lurker/json/schema.rb

@@ -21,6 +21,16 @@ module Lurker
         parse_schema(schema)
       end
 
+      def documentation_uri(extension = 'md')
+        @uri.to_s.sub(%r{^file:(//)?}, '').sub(/(\.json)?(\.yml)?(\.erb)?$/, ".#{extension}")
+      end
+
+      def documentation
+        open(documentation_uri).read
+      rescue
+        @schema['description']
+      end
+
       def root?
         root_schema.blank?
       end
@@ -40,8 +50,7 @@ module Lurker
       end
 
       def replace!(property, property_schema)
-        @schema[property] = Lurker::Json::Parser.plain(subschema_options)
-          .parse_property(property, property_schema)
+        @schema[property] = @parser.plain.parse_property(property, property_schema)
       end
 
       def reorder!
@@ -54,19 +63,23 @@ module Lurker
       end
 
       def to_json(options = {})
-        hashify(@schema, options).to_json
+        to_hash(options).to_json
       end
 
       def to_yaml(options = {})
         YAML.dump(to_hash(options))
       end
 
+      def respond_to_missing?(method, include_private=false)
+        @schema.respond_to?(method, include_private)
+      end
+
       def method_missing(method, *args, &block)
         if @schema.is_a?(Lurker::Json::Schema) || @schema.respond_to?(method)
-          return @schema.send(method, *args, &block)
+          @schema.send(method, *args, &block)
+        else
+          super
         end
-
-        super
       end
 
       private

data/lib/lurker/json/{writter.rb → writer.rb}

@@ -1,6 +1,6 @@
 module Lurker
   module Json
-    class Writter
+    class Writer
       class << self
         def write(schema, path)
           new(path).write(schema)
@@ -16,7 +16,7 @@ module Lurker
         write_to_file(schema)
 
         extract_references(schema).each do |reference|
-          Lurker::Json::Writter.write(reference, reference.original_uri.path)
+          Lurker::Json::Writer.write(reference, reference.original_uri.path)
         end
       end
 

data/lib/lurker/presenters/base_presenter.rb

@@ -9,16 +9,6 @@ class Lurker::BasePresenter
     @options = options
   end
 
-  def render_erb(erb_name, binding = get_binding)
-    template_path = path_for_template(erb_name)
-    template = ERB.new(File.read(template_path), nil, '-')
-    template.result(binding)
-  end
-
-  def get_binding
-    binding
-  end
-
   def html_directory
     options[:url_base_path] || options[:html_directory] || ""
   end
@@ -27,8 +17,12 @@ class Lurker::BasePresenter
     options[:url_base_path] || '/'
   end
 
-  def css_path
-    File.join(html_directory, "styles.css")
+  def assets
+    options[:assets] || {}
+  end
+
+  def asset_path(asset)
+    "#{html_directory}/#{assets[asset] || asset}"
   end
 
   def index_path(subdirectory = "")
@@ -51,27 +45,9 @@ class Lurker::BasePresenter
     EOS
   end
 
-  def render(*args)
-    rendering_controller.render_to_string(*args)
-  end
-
-  protected
-
-  def path_for_template(filename)
-    template_dir  = options[:template_directory]
-    template_path = File.join(template_dir, filename) if template_dir
-    if template_path.nil? || !File.exist?(template_path)
-      template_path = File.join(File.dirname(__FILE__), "../templates", filename)
-    end
-    template_path
-  end
-
-  def rendering_controller
-    return @rendering_controller if @rendering_controller
-    @rendering_controller = Lurker::RenderingController.new
-    instance_variables.each do |var|
-      @rendering_controller.instance_variable_set(var, instance_variable_get(var))
-    end
-    @rendering_controller
+  def markup(content)
+    return unless content
+    Lurker.safe_require 'kramdown'
+    defined?(Kramdown) ? Kramdown::Document.new(content).to_html : content
   end
 end

data/lib/lurker/presenters/endpoint_presenter.rb

@@ -2,6 +2,9 @@
 class Lurker::EndpointPresenter < Lurker::BasePresenter
   attr_accessor :service_presenter, :endpoint, :endpoint_presenter
 
+  extend Forwardable
+  def_delegators :endpoint, :url_params
+
   def initialize(endpoint, options = {})
     super(options)
     @endpoint = endpoint
@@ -10,11 +13,15 @@ class Lurker::EndpointPresenter < Lurker::BasePresenter
   end
 
   def to_html(options={})
-    @service_presenter = service_presenter
-    @endpoint_presenter = self
-    @url_params = endpoint.url_params
-    @post_params = example_request.json
-    render('show', options)
+    controller = Lurker::RenderingController.new
+    controller.service_presenter = service_presenter
+    controller.endpoint_presenter = self
+    controller.instance_variable_set :@title, "#{service_presenter.title} | #{title}"
+    controller.render_to_string 'show', options
+  end
+
+  def documentation
+    markup @endpoint.documentation
   end
 
   def relative_path(extension = ".html")
@@ -33,6 +40,10 @@ class Lurker::EndpointPresenter < Lurker::BasePresenter
     endpoint.prefix || endpoint.path.split("/").first
   end
 
+  def post_params
+    example_request.json
+  end
+
   def zws_ify(str)
     # zero-width-space, makes long lines friendlier for breaking
     # str.gsub(/\//, '&#8203;/') if str
@@ -209,15 +220,15 @@ class Lurker::EndpointPresenter < Lurker::BasePresenter
   end
 
   def example_from_array(array, parent=nil)
-    if array["items"].is_a? Array
+    if array["items"].respond_to?(:each) && !array["items"].respond_to?(:each_pair)
       example = []
       array["items"].each do |item|
         example << example_from_schema(item, parent)
       end
       example
-    elsif (array["items"] || {})["type"].is_a? Array
+    elsif (types = (array["items"] || {})["type"]).respond_to?(:each)
       example = []
-      array["items"]["type"].each do |item|
+      types.each do |item|
         example << example_from_schema(item, parent)
       end
       example

data/lib/lurker/presenters/schema_presenter.rb

@@ -116,18 +116,19 @@ class Lurker::SchemaPresenter < Lurker::BasePresenter
 
   def items_html
     return unless items = @schema["items"]
+    return if items.size == 0
 
     html = ""
     html << '<li>Items'
 
     sub_options = options.merge(:nested => options[:nested] + 1, :parent => self)
 
-    if items.is_a? Array
-      item.compact.each do |item|
-        html << self.class.new(item, sub_options).to_html
-      end
-    else
+    if items.respond_to?(:each_pair)
       html << self.class.new(items, sub_options).to_html
+    else
+      items.each do |item|
+        html << self.class.new(item, sub_options).to_html if item
+      end
     end
 
     html << '</li>'

data/lib/lurker/presenters/service_presenter.rb

@@ -1,3 +1,6 @@
+require 'active_support/inflector'
+require 'active_support/hash_with_indifferent_access'
+
 # An BasePresenter for Lurker::Service
 class Lurker::ServicePresenter < Lurker::BasePresenter
   attr_reader :service
@@ -11,14 +14,24 @@ class Lurker::ServicePresenter < Lurker::BasePresenter
     @filtering_block = block
   end
 
-  # TODO move to controller
-  def to_html(&block)
-    @service_presenter = self
-    render('index')
+  def to_html(options={}, &block)
+    controller = Lurker::RenderingController.new
+    controller.service_presenter = self
+    controller.render_to_string 'index', options
+  end
+
+  def to_print(options = {})
+    controller = Lurker::RenderingController.new
+    controller.service_presenter = self
+    controller.render_to_string 'all', { layout: 'print' }.merge(options)
+  end
+
+  def documentation
+    markup @service.documentation
   end
 
   def title
-    "Lurker | #{name}"
+    "#{name}"
   end
 
   def domains
@@ -31,19 +44,40 @@ class Lurker::ServicePresenter < Lurker::BasePresenter
     '/'
   end
 
+  def request_media_types
+    return service.request_media_types if service.request_media_types.present?
+    ['application/x-www-form-urlencoded']
+  end
+
+  def default_request_media_type
+    request_media_types[0]
+  end
+
   def name_as_link(options = {})
     path = index_path
     '<a href="%s">%s %s</a>' % [path, options[:prefix], service.name]
   end
 
   def slug_name
-    service.name.downcase.gsub(/[ \/]/, '_')
+    @slug_name ||= service.name.downcase.gsub(/[ \/]/, '_')
+  end
+
+  def url_name
+    @url_name ||= name.gsub(/[^a-z0-9\-_]+/i, '_')
   end
 
   def url(extension = ".html")
     '%s-%s%s' % [@endpoint.path, @endpoint.verb, extension]
   end
 
+  def footer
+    @footer ||= options[:footer].present? ? "Revision&nbsp;#{options[:footer]}".html_safe : ''
+  end
+
+  def lurker
+    @lurker ||= options[:lurker] || ''
+  end
+
   def endpoints
     unless @endpoints
       @endpoints = []
@@ -91,6 +125,6 @@ class Lurker::ServicePresenter < Lurker::BasePresenter
   private
 
   def service_domains
-    service.domains.to_hash
+    service.domains.try(:to_hash) || {}
   end
 end