rspec-apib 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 384eec940b1092adf3511086a1d277914998a2bf
-  data.tar.gz: 3baef0e080b224033306dc0fdf31b42ebbb9796b
+  metadata.gz: 3a86d793744f7736b09fa16e8cb5f3eb3c092528
+  data.tar.gz: 1978a2e469135b871f26da73ebf3636b8d48fc74
 SHA512:
-  metadata.gz: 9bdf908d36b862e434c22e002d0aa9e4ba57eab60f9f779e2c7cf4b8dd6ef8992a6f4a4f60bdad235bdc098b06045a118d48006e524ea042b917428c0b3a22ea
-  data.tar.gz: 00e1d571d7fc3688e20f3c3b9cba33c0664cf54fb8c1df43962cb46b4774faf9ec3c48420fc0a4beef0ddea32fee34dd7afed8beba8f9b45e3188b744a8c7fd1
+  metadata.gz: 09ec789ce64972bba5d445217521d024e138caa8431e37f59778b529b9a97e3d7263a014e2c355a7838512ac88dd78c04eb95e39c409adcc1680643f4d19ffbb
+  data.tar.gz: 83c8da9ba36881a53826bb14dc09daf8c8cf1d32769861fc1952905e01d8c7c2328b754de52bf80d6071cf0dede0d34fafbb899d9519112c14fdffa7a29cd96c

data/README.md

@@ -45,6 +45,38 @@ end
 RSpec::Apib.start
 ```
 
+### Writing tests
+
+By default, request specs get recorded and written to a `.apib` file afterwards.
+Rspec-apib is trying to make sense of the test run and generates a meaningful
+documentation out of it.
+
+* **Disable single examples:** Add `apib: false` to the examples meta data
+  ```ruby
+  it 'does something', apib: false do
+    # ...
+  end
+  ```
+
+* **Custom example description:** Add an *apib* comment above the example
+  ```ruby
+  # Not contained in the description
+  #
+  # --- apib
+  # Some awesome description of the response
+  #
+  # ```json
+  # {}
+  # ```
+  # ---
+  #
+  # Not contained in the description
+  #
+  it 'has a custom description' do
+    # ...
+  end
+  ```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rspec/apib/recorder.rb

@@ -114,6 +114,7 @@ module RSpec
           next unless k.starts_with?('HTTP_')
           header = k.gsub('HTTP_', '').downcase
           next if request_header_blacklist.include? header
+          next if v.nil? || v.empty?
           action[:request][:headers][header] = v
         end
       end
@@ -135,7 +136,7 @@ module RSpec
       def document_response
         data = {}
         return if response_exists?
-        data[:description]  = example.description
+        data[:description]  = document_extended_description || example.description
         data[:status]       = response.status
         data[:content_type] = response.content_type.to_s
         data[:body]         = response.body
@@ -143,6 +144,35 @@ module RSpec
         action[:response] << data
       end
 
+      def document_extended_description
+        file = example.metadata[:absolute_file_path]
+        line = example.metadata[:line_number]
+        return if file.nil? || file.empty?
+        return if line.nil? || line <= 0
+        return unless File.exists?(file)
+        lines = IO.readlines(file)
+        return if lines.count < line
+        i = line -2
+        m = false
+        while (i >= 0 && lines[i].match(/\A\W*#/)) do
+          if lines[i - 1].match(/\A\W*# --- apib/)
+            m = true
+            break
+          end
+          i -= 1
+        end
+        return unless m
+        result = []
+        while (i < line && lines[i].match(/\A\W*#/)) do
+          if lines[i].match(/\A\W*# ---/)
+            break
+          end
+          result << lines[i].sub(/^\W*#\W*/, '').strip
+          i += 1
+        end
+        return result.join("\n")
+      end
+
       def response_exists?
         action[:response].any? { |r| r[:status] == response.status }
       end

data/lib/rspec/apib/version.rb

@@ -1,5 +1,5 @@
 module RSpec
   module Apib
-    VERSION = "0.2.1"
+    VERSION = "0.3.0"
   end
 end

data/lib/rspec/apib.rb

@@ -25,9 +25,9 @@ module RSpec
         types = config.record_types
         RSpec.configure do |config|
           config.after :each do |example|
-            if types.include?(example.metadata[:type])
-              RSpec::Apib.record(example, request, response, @routes)
-            end
+            return if example.metadata[:apib] === false
+            return unless types.include?(example.metadata[:type])
+            RSpec::Apib.record(example, request, response, @routes)
           end
 
           config.after :all do |example|

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: rspec-apib
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Paul Spieker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-26 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.6.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 4.6.4
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.4'
 description: 
@@ -115,15 +115,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".codeclimate.yml"
-- ".dockerignore"
-- ".envrc"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".ruby-gemset"
-- ".ruby-version"
-- ".travis.yml"
+- .codeclimate.yml
+- .dockerignore
+- .envrc
+- .gitignore
+- .rspec
+- .rubocop.yml
+- .ruby-gemset
+- .ruby-version
+- .travis.yml
 - CODE_OF_CONDUCT.md
 - Dockerfile
 - Gemfile
@@ -150,17 +150,17 @@ 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: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Generates API Blueprint from request specs