avocado-docs 2.0.6 → 3.0.0

data/lib/avocado/config.rb

@@ -2,7 +2,7 @@ module Avocado
   class Config
     class << self
 
-      attr_accessor :url, :headers, :document_if, :yaml_path, :ignored_params
+      attr_accessor :url, :headers, :document_if, :json_path, :ignored_params
 
       def configure(&block)
         yield self
@@ -16,8 +16,8 @@ module Avocado
         @document_if || -> { true }
       end
 
-      def yaml_path
-        @yaml_path || Rails.application.root
+      def json_path
+        @json_path || Rails.application.root
       end
 
       def ignored_params
@@ -25,7 +25,10 @@ module Avocado
       end
 
       def reset!
-        @headers = @document_if = @yaml_path = @ignored_params = nil
+        @headers = nil
+        @document_if = nil
+        @json_path = nil
+        @ignored_params = nil
       end
 
     end

data/lib/avocado/controller.rb

@@ -6,17 +6,21 @@ module Avocado
     extend ActiveSupport::Concern
 
     included do
-      after_action -> do
-        Avocado::Cache.clean
-        Avocado::Cache.store(request, response) if documentable?
-      end
+      around_action :store_request_and_response_in_avocado
     end
 
     def documentable?
-      response.body.blank? || !!JSON.parse(response.body)
+      (response.status == 204 && response.body.blank?) || !!JSON.parse(response.body)
     rescue
       false
     end
 
+    def store_request_and_response_in_avocado
+      yield
+    ensure
+      Avocado::RequestStore.instance.reset!
+      Avocado::RequestStore.instance.store(request, response) if documentable?
+    end
+
   end
 end

data/lib/avocado/middleware/defaults.rb

@@ -4,6 +4,7 @@ require 'avocado/middleware/request_serialization'
 require 'avocado/middleware/response_serialization'
 require 'avocado/middleware/resource_serialization'
 require 'avocado/middleware/example_serialization'
+require 'avocado/middleware/ignore_xhr_requests'
 
 Avocado::Middleware.configure do |chain|
   chain << Avocado::Middleware::DocumentMetadata
@@ -12,4 +13,5 @@ Avocado::Middleware.configure do |chain|
   chain << Avocado::Middleware::ResponseSerialization
   chain << Avocado::Middleware::ResourceSerialization
   chain << Avocado::Middleware::ExampleSerialization
+  chain << Avocado::Middleware::IgnoreXhrRequests
 end

data/lib/avocado/middleware/document_metadata.rb

@@ -2,11 +2,11 @@ module Avocado
   class Middleware::DocumentMetadata
 
     # return false if the :document metadata is given and is explicitly false
-    def call(example, *)
-      if example.metadata[:document] == false
-        yield false
-      else
+    def call(package)
+      if package.document?
         yield
+      else
+        yield false
       end
     end
 

data/lib/avocado/middleware/example_serialization.rb

@@ -1,8 +1,8 @@
 module Avocado
   class Middleware::ExampleSerialization
 
-    def call(example, *)
-      Avocado::Cache.json[:description] = example.description
+    def call(package)
+      Avocado::RequestStore.instance.json[:description] = package.description
       yield
     end
 

data/lib/avocado/middleware/ignore_xhr_requests.rb

@@ -0,0 +1,10 @@
+module Avocado
+  class Middleware::IgnoreXhrRequests
+
+    # return false and bail if the request is AJAX
+    def call(package)
+      yield !package.request.xhr?
+    end
+
+  end
+end

data/lib/avocado/middleware/request_serialization.rb

@@ -1,9 +1,9 @@
 module Avocado
   class Middleware::RequestSerialization
 
-    def call(example, request, response)
-      @request = request
-      Avocado::Cache.json.merge! request: serialize(@request)
+    def call(package)
+      @request = package.request
+      Avocado::RequestStore.instance.json.merge! request: serialize(@request)
       yield
     end
 
@@ -34,10 +34,11 @@ module Avocado
 
       def deep_replace_file_uploads_with_text(hash)
         hash.each do |k, v|
-          if Hash === v
+          case v
+          when Hash
             deep_replace_file_uploads_with_text(v)
-          else
-            hash[k] = '<Multipart File Upload>' if v.respond_to? :path
+          when Rack::Test::UploadedFile
+            hash[k] = '<Multipart File Upload>'
           end
         end
       end

data/lib/avocado/middleware/resource_serialization.rb

@@ -1,21 +1,19 @@
 module Avocado
   class Middleware::ResourceSerialization
 
-    def call(example, request, response)
-      name = infer_name_from_route(request.path, request.method) || ""
-      Avocado::Cache.json.merge! resource: { name: name }
+    def call(package)
+      request = package.request
+      name = infer_resource_name_from_request(request)
+      Avocado::RequestStore.instance.json.merge! resource: { name: name }
       yield
     end
 
     private
 
-      def infer_name_from_route(path, method)
-        controller = Rails.application.routes.recognize_path(path, method: method)[:controller]
+      def infer_resource_name_from_request(request)
+        controller = request.params[:controller]
         name = controller.partition('/').reject(&:blank?).last
         name.titleize.split('/').last
-      rescue ActionController::RoutingError
-        puts "Path #{path} not found in controller routes; Defaulting name to path."
-        path
       end
 
   end

data/lib/avocado/middleware/response_serialization.rb

@@ -1,8 +1,9 @@
 module Avocado
   class Middleware::ResponseSerialization
 
-    def call(example, request, response)
-      Avocado::Cache.json.merge! response: serialize(response)
+    def call(package)
+      response = package.response
+      Avocado::RequestStore.instance.json.merge! response: serialize(response)
       yield
     end
 

data/lib/avocado/packages/package.rb

@@ -0,0 +1,23 @@
+module Avocado
+  module Packages
+    class Package
+
+      attr_accessor :example, :request, :response
+
+      def initialize(example, request, response)
+        @example = example
+        @request = request
+        @response = response
+      end
+
+      def description
+        raise 'Implement #description'
+      end
+
+      def document?
+        raise 'Implement #document?'
+      end
+
+    end
+  end
+end

data/lib/avocado/packages/rspec_package.rb

@@ -0,0 +1,15 @@
+module Avocado
+  module Packages
+    class RSpecPackage < Package
+
+      def description
+        example.description
+      end
+
+      def document?
+        example.metadata[:document] != false
+      end
+
+    end
+  end
+end

data/lib/avocado/request_store.rb

@@ -0,0 +1,22 @@
+# Temporarily store a JSON request/response. Ultimately RSpec will determine
+# if this request/response gets documented or not in an after(:each) block
+module Avocado
+  class RequestStore
+    include Singleton
+
+    attr_accessor :request, :response, :json
+
+    def store(request, response)
+      @json = {}
+      @request = request
+      @response = response
+    end
+
+    def reset!
+      @json = nil
+      @request = nil
+      @response = nil
+    end
+
+  end
+end

data/lib/avocado/rspec.rb

@@ -8,20 +8,23 @@ RSpec.configure do |config|
   # Invoke all middleware with the request/response stored from the after_action in the controller
   # The final action is to store the request JSON in the Avocado module until after(:suite) executes
   config.after(:each) do |ex|
-    _example = defined?(example) ? example : ex
-    request  = Avocado::Cache.request
-    response = Avocado::Cache.response
+    _ex = defined?(example) ? example : ex
+    request  = Avocado::RequestStore.instance.request
+    response = Avocado::RequestStore.instance.response
 
     if request && response
-      Avocado::Middleware.invoke(_example, request, response) do
-        Avocado.payload << Avocado::Cache.json
+      package = Avocado::Packages::RSpecPackage.new(_ex, request, response)
+      Avocado::Middleware.invoke(package) do
+        Avocado::Uploader.instance.payload << Avocado::RequestStore.instance.json
       end
     end
 
-    Avocado::Cache.clean
+    Avocado::RequestStore.instance.reset!
   end
 
-  # Upload avocado.yml to the configured URL if one is given
-  config.after(:suite) { Avocado.upload! }
+  # Upload avocado.json to the configured URL if one is given
+  config.after(:suite) do
+    Avocado::Uploader.instance.upload!
+  end
 
 end

data/lib/avocado/uploader.rb

@@ -1,22 +1,42 @@
 module Avocado
   class Uploader
+    include Singleton
 
-    def upload(filename)
+    attr_accessor :payload
+
+    def initialize
+      @payload = []
+    end
+
+    def upload!
+      p payload
+      return unless should_upload?
       WebMock.allow_net_connect!
-      uri  = URI.parse Avocado::Config.url
-      file = File.open(filename)
-      req  = Net::HTTP::Post::Multipart.new uri.path, 'file' => UploadIO.new(file, 'text/yaml', 'avocado.yml')
-      Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
+      write_payload_to_json_file do |file|
+        request = Net::HTTP::Post::Multipart.new uri.path, 'file' => UploadIO.new(file, 'text/json', 'avocado.json')
+        Net::HTTP.start(uri.host, uri.port) { |http| http.request(request) }
+      end
     ensure
       WebMock.disable_net_connect!
-      file.close
-      File.delete file.path
     end
 
     private
 
+      def write_payload_to_json_file(&block)
+        File.write 'avocado.json', JSON[payload]
+        file = File.open 'avocado.json'
+        yield(file)
+      ensure
+        file.close
+        # File.delete file.path
+      end
+
+      def should_upload?
+        payload.present? && Avocado::Config.url.presence
+      end
+
       def uri
-        @uri ||= URI.parse Avocado::Config.url
+        @_uri ||= URI.parse Avocado::Config.url
       rescue URI::InvalidURIError
         raise "Avocado::Config.url is set but is not a valid URL!"
       end

data/lib/avocado/version.rb

@@ -1,3 +1,3 @@
 module Avocado
-  VERSION = "2.0.6"
+  VERSION = "3.0.0"
 end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: avocado-docs
 version: !ruby/object:Gem::Version
-  version: 2.0.6
+  version: 3.0.0
 platform: ruby
 authors:
 - Logan Serman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-09 00:00:00.000000000 Z
+date: 2014-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: multipart-post
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.5'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
 description: Avocado listens for JSON responses in the test environment and generates
@@ -104,12 +104,22 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - Rakefile
-- app/assets/javascripts/avocado/application.js
+- app/assets/images/avocado/filter-icon.png
+- app/assets/javascripts/avocado/angular-route.min.js
+- app/assets/javascripts/avocado/angular.min.js
+- app/assets/javascripts/avocado/app.js.coffee
+- app/assets/javascripts/avocado/application.js.coffee
+- app/assets/javascripts/avocado/controllers/avocado_ctrl.js.coffee
+- app/assets/javascripts/avocado/md5.js
+- app/assets/javascripts/avocado/services/endpoint.js.coffee
+- app/assets/javascripts/avocado/services/request.js.coffee
+- app/assets/javascripts/avocado/services/resource.js.coffee
+- app/assets/javascripts/avocado/services/response.js.coffee
+- app/assets/javascripts/avocado/ui-utils.min.js
 - app/assets/stylesheets/avocado/application.css.scss
 - app/assets/stylesheets/avocado/bootstrap.css
 - app/controllers/avocado/avocado_controller.rb
 - app/controllers/avocado/specs_controller.rb
-- app/helpers/avocado/application_helper.rb
 - app/models/avocado/endpoint.rb
 - app/models/avocado/parser.rb
 - app/models/avocado/request.rb
@@ -118,7 +128,6 @@ files:
 - app/views/template.html.erb
 - config/routes.rb
 - lib/avocado-docs.rb
-- lib/avocado/cache.rb
 - lib/avocado/config.rb
 - lib/avocado/controller.rb
 - lib/avocado/engine.rb
@@ -127,9 +136,13 @@ files:
 - lib/avocado/middleware/document_if_configuration.rb
 - lib/avocado/middleware/document_metadata.rb
 - lib/avocado/middleware/example_serialization.rb
+- lib/avocado/middleware/ignore_xhr_requests.rb
 - lib/avocado/middleware/request_serialization.rb
 - lib/avocado/middleware/resource_serialization.rb
 - lib/avocado/middleware/response_serialization.rb
+- lib/avocado/packages/package.rb
+- lib/avocado/packages/rspec_package.rb
+- lib/avocado/request_store.rb
 - lib/avocado/rspec.rb
 - lib/avocado/uploader.rb
 - lib/avocado/version.rb
@@ -142,12 +155,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []