avocado-docs 3.1.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 123473147cc4247d7969a4915482ed62561d8dc9
-  data.tar.gz: f50e931484bea88717cd4a15dce81719fd89d64d
+  metadata.gz: a53e9c7b26a64f5491ef065942a6bff4326b60fc
+  data.tar.gz: b3bf621f28f386052bd861def025eb6b6bfa48f9
 SHA512:
-  metadata.gz: 49b732845e2af906c9335b13d2640070d051bd4f9bef0b8e4f2e50004de49eb11a9f3728b20cb1790cfdb97ce15e45cfa7f7d1501d8c95cd23a1c8b77579c6ed
-  data.tar.gz: a4d06e826dc8a503d19c7ac71da6ce68c6415d5b20c19a80b8c47e9bedcf420694f330974d6855242c9ce674468ff20b96d2c001dc207ca12dc95b9e401c61d0
+  metadata.gz: f149da4dcfb28fc8aef10fe0b41d407449a18198aba01cafb7cb060488f0fb42bfd0e40aec133eff0a3ed83fe5448c5ad5cc3806e6c9b70c725965b3c7254db9
+  data.tar.gz: 840a45e77a6f6475a991f4d6d84eb1f240fe4f6c4aeef50c031323386229d776de1b15a59619a72e52bc784c4ffb537e1b6f29c0535703b548bc0b16e3306b50

data/app/controllers/avocado/specs_controller.rb

@@ -3,32 +3,22 @@ module Avocado
     layout 'avocado'
 
     def index
-      @data = json_files.map { |filename| File.read filename }
+      @data = storage.read
     end
 
     def create
-      File.open(new_json_filename, 'w+') { |f| f.write params[:file].read }
-      File.delete(*json_files_from_past_uploads)
+      storage.write params[:file].read, upload_id
+      storage.purge_old upload_id
       head :ok
     end
 
     private
-      def upload_id
-        params[:upload_id]
-      end
-
-      def new_json_filename
-        Avocado.json_path.join "avocado-#{Time.current.to_s(:nsec)}-#{upload_id}.json"
+      def storage
+        Avocado.storage
       end
 
-      def json_files
-        Dir.glob Avocado.json_path.join('avocado*.json')
-      end
-
-      def json_files_from_past_uploads
-        json_files.reject do |spec|
-          spec.end_with? "-#{upload_id}.json"
-        end
+      def upload_id
+        params[:upload_id]
       end
   end
 end

data/config/routes.rb

@@ -1,4 +1,4 @@
 Avocado::Engine.routes.draw do
-  resources :specs, only: [:create]
+  post '/', to: 'specs#create'
   root to: 'specs#index'
 end

data/lib/avocado-docs.rb

@@ -2,19 +2,22 @@ require 'avocado/engine'
 require 'avocado/controller_patch'
 require 'avocado/controller_response'
 require 'avocado/logger'
-require 'avocado/storage'
+require 'avocado/cache'
 require 'avocado/uploader'
+require 'avocado/storage/file'
+
 require 'avocado/adapters/base_adapter'
 require 'avocado/adapters/minitest_adapter'
 require 'avocado/adapters/rspec_adapter'
 require 'avocado/adapters/cucumber_adapter'
+
 require 'avocado/serializers/request_serializer'
 require 'avocado/serializers/resource_serializer'
 require 'avocado/serializers/response_serializer'
 
 module Avocado
   class << self
-    attr_accessor :url, :headers, :json_path, :upload_id, :document_if, :ignored_params, :storage, :uploader
+    attr_accessor :url, :headers, :upload_id, :document_if, :ignored_params, :cache, :uploader, :storage
 
     def configure
       yield self
@@ -23,14 +26,14 @@ module Avocado
     def reset!
       self.url = nil
       self.headers = []
-      self.json_path = ::Rails.root
       self.upload_id = proc { SecureRandom.uuid }
       self.document_if = proc { true }
       self.ignored_params = %w(controller action format)
-      self.storage = Avocado::Storage.instance
+      self.cache = Avocado::Cache.instance
       self.uploader = Avocado::Uploader.instance
+      self.storage = Avocado::Storage::File.new ::Rails.root
 
-      storage.clear
+      cache.clear
       uploader.reset
     end
   end

data/lib/avocado/{storage.rb → cache.rb}

@@ -1,7 +1,7 @@
 # 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 Storage
+  class Cache
     include Singleton
 
     attr_accessor :request, :response

data/lib/avocado/controller_patch.rb

@@ -14,7 +14,7 @@ module Avocado
     def _avocado_store_request
       yield
     ensure
-      Avocado.storage.store(request, response) if _avocado_response.documentable?
+      Avocado.cache.store(request, response) if _avocado_response.documentable?
     end
 
     def _avocado_response

data/lib/avocado/minitest.rb

@@ -7,12 +7,12 @@ module Avocado::Minitest
   def before_teardown
     super
 
-    request  = Avocado.storage.request
-    response = Avocado.storage.response
+    request  = Avocado.cache.request
+    response = Avocado.cache.response
     adapter  = Avocado::Adapters::MinitestAdapter.new name, request, response
 
     Avocado.uploader.payload << adapter.to_h if adapter.upload?
-    Avocado.storage.clear
+    Avocado.cache.clear
   end
 end
 

data/lib/avocado/rspec.rb

@@ -7,12 +7,12 @@ RSpec.configure do |config|
     # Older versions of RSpec use the global `example` object
     spec = defined?(example) ? example : ex
 
-    request  = Avocado.storage.request
-    response = Avocado.storage.response
+    request  = Avocado.cache.request
+    response = Avocado.cache.response
     adapter  = Avocado::Adapters::RSpecAdapter.new spec, request, response
 
     Avocado.uploader.payload << adapter.to_h if adapter.upload?
-    Avocado.storage.clear
+    Avocado.cache.clear
   end
 
   config.after(:suite) do

data/lib/avocado/storage/file.rb

@@ -0,0 +1,28 @@
+module Avocado
+  module Storage
+    class File
+      def initialize(dir)
+        @dir = dir
+      end
+
+      def read
+        files.map { |filename| ::File.read filename }
+      end
+
+      def write(data, upload_id)
+        filename = @dir.join "avocado-#{Time.current.to_s(:nsec)}-#{upload_id}.json"
+        ::File.open(filename, 'w+') { |f| f.write data }
+      end
+
+      def purge_old(upload_id)
+        old_files = files.reject { |fn| fn.end_with? "-#{upload_id}.json" }
+        ::File.delete(*old_files)
+      end
+
+      private
+        def files
+          Dir.glob @dir.join('avocado*.json')
+        end
+    end
+  end
+end

data/lib/avocado/version.rb

@@ -1,3 +1,3 @@
 module Avocado
-  VERSION = '3.1.2'.freeze
+  VERSION = '4.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avocado-docs
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 4.0.0
 platform: ruby
 authors:
 - Logan Serman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-18 00:00:00.000000000 Z
+date: 2017-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -139,6 +139,7 @@ files:
 - lib/avocado/adapters/cucumber_adapter.rb
 - lib/avocado/adapters/minitest_adapter.rb
 - lib/avocado/adapters/rspec_adapter.rb
+- lib/avocado/cache.rb
 - lib/avocado/controller_patch.rb
 - lib/avocado/controller_response.rb
 - lib/avocado/cucumber.rb
@@ -149,7 +150,7 @@ files:
 - lib/avocado/serializers/request_serializer.rb
 - lib/avocado/serializers/resource_serializer.rb
 - lib/avocado/serializers/response_serializer.rb
-- lib/avocado/storage.rb
+- lib/avocado/storage/file.rb
 - lib/avocado/uploader.rb
 - lib/avocado/version.rb
 homepage: http://github.com/metova/avocado
@@ -171,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Automatic API documentation from RSpec tests