lurker 0.5.3 → 0.5.4

data/features/support/env.rb

@@ -1,6 +1,9 @@
 require 'simplecov'
 SimpleCov.start do
-  add_filter 'lurker_app'
+  filters.clear # This will remove the :root_filter that comes via simplecov's defaults
+  add_filter do |src|
+    !(src.filename =~ /^#{SimpleCov.root}\/lib\/lurker/)
+  end
 end
 
 require 'fileutils'
@@ -38,10 +41,13 @@ Before do
     system "bin/spring stop"
     FileUtils.rm_rf File.expand_path('../../../tmp/lurker_app/lurker', __FILE__)
     FileUtils.rm_rf File.expand_path('../../../tmp/lurker_app/html', __FILE__)
+    FileUtils.rm_rf File.expand_path('../../../tmp/lurker_app/spec/request', __FILE__)
+    FileUtils.rm_rf File.expand_path('../../../tmp/lurker_app/spec/controllers', __FILE__)
   end
 end
 
 After do |scenario|
+  ActiveRecord::Base.connection.reconnect!
   DatabaseCleaner.clean
 end
 

data/gemfiles/Gemfile32.ci

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lurker.gemspec
+gemspec path: '../'
+
+gem 'rails', '~> 3.2.17'

data/{Gemfile.ci → gemfiles/Gemfile40.ci}

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in lurker.gemspec
-gemspec
+gemspec path: '../'
+
+gem 'rails', '~> 4.0.4'

data/gemfiles/Gemfile41.ci

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lurker.gemspec
+gemspec path: '../'
+
+gem 'rails', '~> 4.1.0'

data/lib/lurker.rb

@@ -38,7 +38,6 @@ require 'lurker/schema'
 require 'lurker/ref_object'
 require 'lurker/erb_schema_context'
 require 'lurker/service'
-require 'lurker/meta_service'
 require 'lurker/jaml_descriptor'
 require 'lurker/validator'
 require 'lurker/validation_error'
@@ -49,7 +48,6 @@ require 'lurker/form_builder'
 require 'lurker/presenters/json_presenter'
 require 'lurker/presenters/base_presenter'
 require 'lurker/presenters/service_presenter'
-require 'lurker/presenters/meta_service_presenter'
 require 'lurker/presenters/endpoint_presenter'
 require 'lurker/presenters/schema_presenter'
 require 'lurker/presenters/response_code_presenter'

data/lib/lurker/cli.rb

@@ -1,7 +1,6 @@
 require 'thor'
 require 'digest/sha1'
 require 'lurker/service'
-require 'lurker/meta_service'
 
 module Lurker
   # A Thor::Error to be thrown when an lurker directory is not found
@@ -24,13 +23,13 @@ module Lurker
       File.expand_path("../templates/public", __FILE__)
     end
 
-    desc "convert [LURKER_PATH]", "Convert lurker to HTML or Markdowns"
+    desc "convert [LURKER_PATH]", "Convert lurker to HTML"
     method_option :rails, :type => :boolean, :desc => "Includes Rails environment"
     method_option :exclude, :aliases => "-e", :desc => "Select endpoints by given regexp, if NOT matching prefix"
     method_option :select, :aliases => "-s", :desc => "Select endpoints by given regexp, matching prefix"
     method_option :output, :aliases => "-o", :desc => "Output path"
     method_option :url_base_path, :aliases => "-u", :desc => "URL base path"
-    method_option :format, :aliases => "-f", :desc => "Format in html or markdown, defaults to html", :default => "html"
+    method_option :format, :aliases => "-f", :desc => "Format in html or pdf, defaults to html", :default => "html"
     method_option :templates, :aliases => "-t", :desc => "Template overrides path"
     method_option :content, :aliases => "-c", :desc => "Content to be rendered into html-docs main page"
     def convert(lurker_path=Lurker::DEFAULT_SERVICE_PATH)
@@ -49,14 +48,18 @@ module Lurker
         require "#{Dir.pwd}/config/environment"
       end
 
-      if options[:format] == 'markdown'
-        convert_to_markdown
+      if options[:format] == 'pdf'
+        convert_to_pdf
       else
         convert_to_html
       end
     end
 
     no_tasks do
+      def convert_to_pdf
+        # TODO
+      end
+
       def convert_to_html
         in_root do
           # js, css, fonts
@@ -71,12 +74,10 @@ module Lurker
               FileUtils.cp_r fname, destination.to_s
             end
           end
-
-          create_file("index.html", meta_presenter.to_html) if has_meta_service?
         end
 
         service_presenters.each do |service_presenter|
-          inside_service_presenter(service_presenter) do
+          in_root do
             create_file("index.html", service_presenter.to_html, force: true)
 
             service_presenter.endpoints.each do |endpoint_prefix_group|
@@ -88,32 +89,6 @@ module Lurker
         end
       end
 
-      def convert_to_markdown
-        in_root do
-          create_file("index.md", meta_presenter.to_markdown) if has_meta_service?
-        end
-
-        service_presenters.each do |service_presenter|
-          inside_service_presenter(service_presenter) do
-            create_file("index.md", service_presenter.to_markdown)
-
-            service_presenter.endpoints.each do |endpoint_prefix_group|
-              endpoint_prefix_group.each do |endpoint|
-                create_file(endpoint.url('.md'), endpoint.to_markdown)
-              end
-            end
-          end
-        end
-      end
-
-      def inside_service_presenter(service, &block)
-        if has_meta_service?
-          inside(service.slug_name, {:verbose => true}, &block)
-        else
-          in_root(&block)
-        end
-      end
-
       def output_path
         @output_path ||=
           if options[:output]
@@ -140,10 +115,6 @@ module Lurker
         !destination.exist? || destination.directory?
       end
 
-      def has_meta_service?
-        !meta_service.empty?
-      end
-
       def service_presenters
         @service_presenters ||= services.map do |service|
           Lurker::ServicePresenter.new(service, html_options, &filtering_block)
@@ -194,23 +165,7 @@ module Lurker
     end
 
     def services
-      @services ||=
-        if has_meta_service?
-          meta_service.services
-        else
-          [Lurker::Service.new(origin_path)]
-        end
-    end
-
-    def meta_presenter
-      @meta_presenter ||= Lurker::MetaServicePresenter.new(
-        meta_service,
-        html_options
-      )
-    end
-
-    def meta_service
-      @meta_service ||= Lurker::MetaService.new(origin_path)
+      @services ||= [Lurker::Service.new(origin_path)]
     end
 
     def origin

data/lib/lurker/controller_spec_watcher.rb

@@ -8,10 +8,7 @@ module Lurker
 
     included do
       # _describe = self # RSpec::ExampleGroups::... # class
-      actions = [:get, :post, :put, :delete]
-      if defined?(ActionDispatch::Request::HTTP_METHODS) && ActionDispatch::Request::HTTP_METHODS.include?('PATCH')
-        actions << :patch
-      end
+      actions = [:get, :post, :put, :delete, :patch]
       actions.each do |verb|
         send(:define_method, "#{verb}_with_lurker") do |*params|
           @__action, @__request_params = params
@@ -19,7 +16,7 @@ module Lurker
 
           send("#{verb}_without_lurker", @__action, @__request_params)
 
-          @__query_params = Hash[@__request_params.except(*path_params.keys).map do |k,v|
+          @__query_params = Hash[@__request_params.reject { |k,_| path_params.keys.include? k } .map do |k,v|
             [k.to_s, v.to_s]
           end]
           endpoint_path = explicit_path(@__example)
@@ -47,7 +44,16 @@ module Lurker
           verify(verb, endpoint_path)
         end
 
-        send :alias_method_chain, verb, :lurker
+        begin
+          send :alias_method_chain, verb, :lurker
+        rescue NameError
+          if verb == :patch
+            alias_method :patch_without_lurker, :put_without_lurker
+            alias_method :patch, :patch_with_lurker
+          else
+            raise
+          end
+        end
       end
 
       around do |example|

data/lib/lurker/endpoint.rb

@@ -95,7 +95,7 @@ class Lurker::Endpoint
   end
 
   def url_params
-    (schema.extensions['path_params'] || {}).except('action', 'controller')
+    (schema.extensions['path_params'] || {}).reject { |k, _| ['action', 'controller', 'format'].include? k }
   end
 
   def query_params

data/lib/lurker/presenters/base_presenter.rb

@@ -1,12 +1,7 @@
 require 'erb'
-require 'kramdown'
 require 'json'
 require 'forwardable'
 
-# BasePresenters assist in generating Html for lurker classes.
-# BasePresenters is an abstract class with a lot of helper methods
-# for URLs and common text styling tasks (like #render_markdown
-# and #render_json)
 class Lurker::BasePresenter
 
   attr_reader :options
@@ -21,14 +16,6 @@ class Lurker::BasePresenter
     template.result(binding)
   end
 
-  def render_markdown(markdown_str)
-    if markdown_str
-      Kramdown::Document.new(markdown_str, :entity_output => :numeric).to_html
-    else
-      nil
-    end
-  end
-
   def get_binding
     binding
   end

data/lib/lurker/presenters/endpoint_presenter.rb

@@ -20,10 +20,6 @@ class Lurker::EndpointPresenter < Lurker::BasePresenter
     render('show')
   end
 
-  def to_markdown
-    render_erb('endpoint.md.erb')
-  end
-
   def relative_path(extension = ".html")
     '%s%s-%s%s' % [ options[:prefix], endpoint.path, endpoint.verb, extension ]
   end
@@ -79,7 +75,7 @@ class Lurker::EndpointPresenter < Lurker::BasePresenter
     return if endpoint.request_parameters.empty?
     Lurker::JsonPresenter.new(
       example_from_schema(endpoint.request_parameters, endpoint.schema)
-        .except(*endpoint.url_params.keys)
+        .reject { |k,_| endpoint.url_params.keys.include? k }
     )
   end
 
@@ -110,7 +106,12 @@ class Lurker::EndpointPresenter < Lurker::BasePresenter
 
   # for live form WITH :placeholders
   def named_path
-    base_path.sub(/\/?$/, '/') + endpoint.path.gsub(/__/, ':')
+    return @named_path if @named_path
+    @named_path = base_path.sub(/\/?$/, '/') + endpoint.path.gsub(/__/, ':')
+    if (suffix = endpoint.schema.extensions.try(:[], 'suffix')).present?
+      @named_path = @named_path.gsub(/-#{suffix}/, '')
+    end
+    @named_path
   end
 
   def verb

data/lib/lurker/presenters/json_presenter.rb

@@ -19,13 +19,4 @@ class Lurker::JsonPresenter
       '<pre><code>%s</code></pre>' % JSON.pretty_generate(json)
     end
   end
-
-  def to_markdown
-    if json.kind_of?(Hash) ||
-       json.kind_of?(Array)
-      JSON.pretty_generate(json)
-    else
-      json
-    end
-  end
 end

data/lib/lurker/presenters/response_code_presenter.rb

@@ -18,10 +18,6 @@ class Lurker::ResponseCodePresenter < Lurker::BasePresenter
     EOS
   end
 
-  def to_markdown
-    "__#{status}__: #{description_raw}"
-  end
-
   def successful?
     response_code["successful"]
   end
@@ -31,11 +27,6 @@ class Lurker::ResponseCodePresenter < Lurker::BasePresenter
   end
 
   def description
-    render_markdown(description_raw)
-  end
-
-  def description_raw
     response_code["description"]
   end
-
 end

data/lib/lurker/presenters/schema_presenter.rb

@@ -34,7 +34,7 @@ class Lurker::SchemaPresenter < Lurker::BasePresenter
     html << '<span class="deprecated">Deprecated</span>' if deprecated?
 
     html << '<div class="schema">'
-    html << render_markdown(@schema["description"])
+    html << @schema["description"]
 
     html << '<ul>'
     begin
@@ -59,38 +59,6 @@ class Lurker::SchemaPresenter < Lurker::BasePresenter
     html.string
   end
 
-  def to_markdown(prefix = "")
-    md = StringIO.new
-    md << 'Deprecated' if deprecated?
-    md << "\n#{@schema["description"]}"
-    md << "\n#{prefix}* __Required__: #{required?}" if nested?
-    md << "\n#{prefix}* __Type__: #{type}" if type
-    md << "\n#{prefix}* __Format__: #{format}" if format
-    md << "\n#{prefix}* __Example__: <tt>#{example.to_markdown}</tt>" if example
-    md << "\n#{@schema['enum']}"
-    (@schema.keys - Lurker::SchemaPresenter::FORMATTED_KEYS).each do |key|
-      md << "\n#{prefix}* %{key} %{@schema[key]}"
-    end
-    if items = @schema["items"]
-      md << "\n#{prefix}* Items"
-      if items.kind_of? Array
-        item.compact.each do |item|
-          md << Lurker::SchemaPresenter.new(item, options.merge(:nested => true)).to_markdown(prefix + "\t")
-        end
-      else
-        md << Lurker::SchemaPresenter.new(@schema["items"], options.merge(:nested => true)).to_markdown(prefix + "\t")
-      end
-    end
-    if properties = @schema["properties"]
-      properties.each do |key, property|
-        next if property.nil?
-        md << "\n#{prefix}* __#{key}__:"
-        md << Lurker::SchemaPresenter.new(property, options.merge(:nested => true)).to_markdown(prefix + "\t")
-      end
-    end
-    md.string
-  end
-
   def type
     t = @schema["type"]
     if t.kind_of? Array

data/lib/lurker/presenters/service_presenter.rb

@@ -3,7 +3,7 @@ class Lurker::ServicePresenter < Lurker::BasePresenter
   attr_reader :service
 
   extend Forwardable
-  def_delegators :service, :name, :service_dir, :meta_service
+  def_delegators :service, :description, :discussion, :name, :service_dir
 
 
   def initialize(service, options = {}, &block)
@@ -18,10 +18,6 @@ class Lurker::ServicePresenter < Lurker::BasePresenter
     render('index')
   end
 
-  def to_markdown
-    render_erb('service.md.erb')
-  end
-
   def title
     "Lurker | #{name}"
   end
@@ -37,7 +33,7 @@ class Lurker::ServicePresenter < Lurker::BasePresenter
   end
 
   def name_as_link(options = {})
-    path = service.meta_service ? index_path(slug_name) : index_path
+    path = index_path
     '<a href="%s">%s %s</a>' % [ path, options[:prefix], service.name ]
   end
 
@@ -92,22 +88,4 @@ class Lurker::ServicePresenter < Lurker::BasePresenter
       hash
     end
   end
-
-  def description(options = {:render => true})
-    options[:render] ? render_markdown(service.description) : service.description
-  end
-
-  def discussion(options = {:render => true})
-    options[:render] ? render_markdown(service.discussion) : service.discussion
-  end
-
-  def relative_meta_service_path(file_name = nil)
-    service_path = service_dir.gsub(meta_service.meta_service_dir, "")
-    service_path = service_path.count("/").times.map { "../" }.join
-    if file_name
-      service_path = File.join(service_path, file_name)
-    end
-    service_path
-  end
-
 end

data/lib/lurker/request_spec_watcher.rb

@@ -8,11 +8,7 @@ module Lurker
 
     included do
       # _describe = self # RSpec::ExampleGroups::... # class
-      actions = [:get, :post, :put, :delete]
-      if defined?(ActionDispatch::Request::HTTP_METHODS) && ActionDispatch::Request::HTTP_METHODS.include?('PATCH')
-        actions << :patch
-      end
-
+      actions = [:get, :post, :put, :delete, :patch]
       actions.each do |verb|
         send(:define_method, "#{verb}_with_lurker") do |*params|
           @__action, @__request_params, @__env = params
@@ -58,7 +54,16 @@ module Lurker
           verify(verb, endpoint_path)
         end
 
-        send :alias_method_chain, verb, :lurker
+        begin
+          send :alias_method_chain, verb, :lurker
+        rescue NameError
+          if verb == :patch
+            alias_method :patch_without_lurker, :put_without_lurker
+            alias_method :patch, :patch_with_lurker
+          else
+            raise
+          end
+        end
       end
 
       around do |example|