rspec_api_docs 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ec7c0ef83d3f6f2707a9c107495e711f807f1f0
-  data.tar.gz: 5abb86689a0fdfcf3e5e4bbaf0c5a6058e29f55d
+  metadata.gz: e3a6353f8e992283d35976b79f700f89bb288190
+  data.tar.gz: 11e539b4e35b9b9d5fe99f27cc4217c9ddbede47
 SHA512:
-  metadata.gz: 97c8b0f6fc41589fc312325e81f03161536e934e85d0b785e3c424b83a9d9c90fce743b76dd033757faaef29e407228f15ce5b7b0a43395d9e6a9162b907f4b8
-  data.tar.gz: 26c7238588d78e74ee89f4c62c53923eb398beaedd3577c9b7ce1615542723cf8185338ade81856938451b6e0b03721c7ad0ffc89aec2670d02929c791a2b02c
+  metadata.gz: 3699d25bf8194de10124fa7009bd44290b4a1f9397153fab79553591f091d5f6174c79fd2ad719a2067318bc42279cbc7d8351eee4bbd1fa632c060c66c1b6db
+  data.tar.gz: f7a1d04367e61049031b464b065788930238dee1a3a3307cc54dbc153abe52a230ddc34f2c7716ff299a83e87d73d3e4ffa8009668b2310289229bddfc04083e

data/lib/rspec_api_docs/version.rb

@@ -1,3 +1,3 @@
 module RspecApiDocs
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/rspec_api_docs.rb

@@ -1,24 +1,23 @@
 require 'rspec/core'
 require "rspec_api_docs/version"
 require "rspec_api_docs/dir"
-require "rspec_api_docs/file"
 
 RSpec.configure do |config|
   config.before(:suite) do
-    api_docs_folder_path = RspecApiDocs::Dir.find_or_create_api_docs_folder_in(Rails.root)
+    files_to_run = config.instance_variable_get(:@files_or_directories_to_run)
+    next unless files_to_run == ["test/controllers/api/"]
 
-    RspecApiDocs::File.files_to_remove(config.files_to_run, api_docs_folder_path).each do |f|
-      next unless f.match(/api\/v*.\/.*/)
+    api_docs_folder_path = RspecApiDocs::Dir.find_or_create_api_docs_folder_in(Rails.root)
 
-      file = f.match(/api\/v*.\/.*/)[0].gsub('/', '_').gsub('api_', '').gsub('_controller_test.rb', '.txt')
-      file = "api_docs/#{file}"
-      File.delete(file) if File.exists?(file)
-    end
+    file = File.join(Rails.root, "apiary.apib")
+    File.delete(file) if File.exists?(file)
   end
 
   config.after(:each) do |example|
     begin
       # exit unless this is under api/v*
+      files_to_run = config.instance_variable_get(:@files_or_directories_to_run)
+      next unless files_to_run == ["test/controllers/api/"]
       next unless example.metadata[:file_path].match(/api\/v\d*/)
       next unless request && request.try(:symbolized_path_parameters)
 
@@ -37,16 +36,14 @@ RSpec.configure do |config|
         optional_param = request.symbolized_path_parameters[id_symbol] ? "/{:#{id_symbol}}" : ""
         action = "#{request.request_method} #{request.symbolized_path_parameters[:controller]}#{optional_param}"
 
-        if defined? Rails
-          file = File.join(Rails.root, "/api_docs/#{file_name}.txt")
-        else
-          file = File.join(File.expand_path('.'), "/api_docs/#{file_name}.txt")
-        end
+        file = File.join(Rails.root, "apiary.apib")
 
         collection = action.match(/(POST|GET|PATCH|DELETE) (portal\/api|api)\/v\d*\/(.*)/)[3]
+        version_and_collection = action.match(/(POST|GET|PATCH|DELETE) (portal\/api|api)(.*)/)[3]
+
         action_title = "#{collection.capitalize} #{request.symbolized_path_parameters[:action].capitalize} [#{request.method}]"
         File.open(file, 'a') do |f|
-          if File.zero?(File.join(Rails.root, "/api_docs/#{file_name}.txt"))
+          if File.zero?(File.join(file))
             f.write "FORMAT: 1A\n"
             f.write "HOST: https://qa1.google.co.uk/api\n\n"
 
@@ -56,9 +53,9 @@ RSpec.configure do |config|
           end
 
           # skip if the action is already defined
-          next if File.read(File.join(Rails.root, "/api_docs/#{file_name}.txt")).include?(action_title)
+          next if File.read(File.join(file)).include?(action_title)
 
-          f.write "## #{collection.capitalize} collection [/#{collection}]\n\n"
+          f.write "## #{collection.capitalize} collection [#{version_and_collection}]\n\n"
 
           f.write "### #{action_title}\n\n"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec_api_docs
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Tom Kadwill
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-19 00:00:00.000000000 Z
+date: 2016-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,7 +71,6 @@ files:
 - bin/setup
 - lib/rspec_api_docs.rb
 - lib/rspec_api_docs/dir.rb
-- lib/rspec_api_docs/file.rb
 - lib/rspec_api_docs/version.rb
 - rspec_api_docs.gemspec
 homepage: https://github.com/tomkadwill/rspec_api_docs
@@ -94,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Generate API blueprint docs when running Rspec

data/lib/rspec_api_docs/file.rb

@@ -1,9 +0,0 @@
-class RspecApiDocs::File
-  def self.files_to_remove(files, api_docs_folder_path)
-    if files == []
-      Dir.glob(File.join(api_docs_folder_path, '*'))
-    else
-      files
-    end
-  end
-end