reqres_rspec 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 732124d70415e37926cd069f84f5493b4b175f92
-  data.tar.gz: 6d01be1fa076e1009bd24492bf060a7172fdcae4
+  metadata.gz: 3ef47ab9f939487583f2efd322e173120d15c8ea
+  data.tar.gz: fd9555da5430109cfd9a8f13cdd1411f7c513274
 SHA512:
-  metadata.gz: bf658e46d38571f9657967b2833d4afebf5cab7ae4b5b8d64c5ea4bf17af89afd862640696c1b7ae39d2a55cfd757a38b314c1b18f904a42012b90c59fdb549a
-  data.tar.gz: d5f2e7b8763670a4549644fbfa4f0da0c97f02a0365382e84be3d7d99613c19680f0ee1560a1990de5ff1755715540d4a61c25fcc2da4e579ad9ae3df5db56a9
+  metadata.gz: 2cdaf34b43028cf6951c2851d452ec095de2c76a3f6c98488b4c4d6904817b045afc69f6862d43d3107d9fe2c69b3704765b0ba19577d5955cc083231900a191
+  data.tar.gz: 06e8a973c4d0dcc532e17e30f122ee14961070dc30432bad9fb9dd611b08ad3444d4ccd9da91368f14aa57c24be11f9e7be8e4de97961e58699ef5ab3065b85f

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+version 0.1.8
+
+cleanup code
+fix regression with skipping spec examples
+improve function to create symbolized path
+
 version 0.1.7
 
 symbolized path moved to request key in record

data/README.md

@@ -69,6 +69,10 @@ Each param text is started with `@param` and first word will be param name, then
 ### Sample rspec test
 
 ```ruby
+  it 'validates params', :skip_reqres do
+    ...
+  end
+
   context 'With valid params' do
     it 'bakes pie' do
       ...
@@ -82,7 +86,7 @@ Each param text is started with `@param` and first word will be param name, then
   end
 ```
 
- By default all examples will be added to docs. A context of examples (`context` and `describe` blocks)may be excluded from docs with option `:skip_reqres`
+ By default all examples will be added to docs. A context of examples (`context` and `describe` blocks) or any particular examples may be excluded from docs with option `:skip_reqres`
 
  Doc will use full example description, as a title for each separate spec
 
@@ -94,6 +98,10 @@ describe 'Something', reqres_section: 'Foo' do
     it 'works' do
       ...
     end
+
+    it 'tires baker', reqres_title: 'Tires baker' do
+      ...
+    end
   end
 end
 ```

data/lib/reqres_rspec.rb

@@ -14,12 +14,13 @@ if defined?(RSpec) && ENV['REQRES_RSPEC'] == '1'
   collector = ReqresRspec::Collector.new
 
   RSpec.configure do |config|
-    config.after(:each) do
+    config.after(:each) do |example|
       if defined?(Rails)
         meta_data = self.class.example.metadata
-        if meta_data[:type] == :request && !meta_data[:skip_reqres] == true
+
+        if meta_data[:type] == :request && process_example?(meta_data, example)
           begin
-            collector.collect(self, self.request, self.response)
+            collector.collect(self, example, self.request, self.response)
           rescue NameError
             raise $!
           end
@@ -43,4 +44,8 @@ if defined?(RSpec) && ENV['REQRES_RSPEC'] == '1'
       end
     end
   end
+
+  def process_example?(meta_data, example)
+    !(meta_data[:skip_reqres] || example.metadata[:skip_reqres])
+  end
 end

data/lib/reqres_rspec/collector.rb

@@ -8,11 +8,11 @@ module ReqresRspec
 
     # Param types
     # NOTE: make sure sub-strings go at the end
-    PARAM_TYPES = ['Boolean', 'Text', 'Float', 'DateTime', 'Date', 'File', 'UUID',
+    PARAM_TYPES = ['Boolean', 'Text', 'Float', 'DateTime', 'Date', 'File', 'UUID', 'Hash',
                    'Array of Integer', 'Array of String', 'Array', 'Integer', 'String']
 
     # Exclude replacement in symbolized path
-    EXCLUDE_PATH_SYMBOLS = %w[limit offset format description]
+    EXCLUDE_PARAMS = %w[limit offset format description controller action]
 
     # response headers contain many unnecessary information,
     # everything from this list will be stripped
@@ -60,7 +60,7 @@ module ReqresRspec
     end
 
     # collects spec data for further processing
-    def collect(spec, request, response)
+    def collect(spec, example, request, response)
       # TODO: remove boilerplate code
       return if request.nil? || response.nil? || !defined?(request.env)
 
@@ -85,7 +85,7 @@ module ReqresRspec
       self.records << {
         filename: prepare_filename_for(spec.class.metadata),
         group: spec.class.metadata[:reqres_section] || section, # Top level example group
-        title: spec.class.metadata[:reqres_title] || spec.class.example.full_description,
+        title: example_title(spec, example),
         description: description,
         params: params,
         request: {
@@ -137,10 +137,17 @@ module ReqresRspec
 
     # sorts records alphabetically
     def sort
-      self.records.sort!{ |x,y| x[:request][:symbolized_path] <=> y[:request][:symbolized_path] }
+      self.records.sort! do |x,y|
+        comp = x[:request][:symbolized_path] <=> y[:request][:symbolized_path]
+        comp.zero? ? (x[:title] <=> y[:title]) : comp
+      end
     end
 
-  private
+    private
+
+    def example_title(spec, example)
+      spec.class.metadata[:reqres_title] || example.metadata[:reqres_title] || spec.class.example.full_description
+    end
 
     # read and cleanup response headers
     # returns Hash
@@ -188,20 +195,15 @@ module ReqresRspec
     #
     def get_symbolized_path(request)
       request_path = request.path
-      request_params = request.env['action_dispatch.request.parameters'] ||
-                       request.env['rack.request.form_hash'] ||
-                       request.env['rack.request.query_hash']
-
-      request_params.
-        reject { |param| %w[controller action].include? param }.
-        each do |key, value|
-        if value.is_a? String
-          index = request_path.index(value)
-          if index && index >= 0 && !EXCLUDE_PATH_SYMBOLS.include?(key)
-            request_path = request_path.sub(value, ":#{key}")
-          end
-        end
-      end
+      request_params =
+        request.env['action_dispatch.request.parameters'] ||
+        request.env['rack.request.form_hash'] ||
+        request.env['rack.request.query_hash']
+
+      request_params
+        .except(*EXCLUDE_PARAMS)
+        .select { |_, value| value.is_a?(String) }
+        .each { |key, value| request_path.sub!("/#{value}", "/:#{key}") }
 
       request_path
     end

data/lib/reqres_rspec/version.rb

@@ -1,3 +1,3 @@
 module ReqresRspec
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reqres_rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - rilian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-14 00:00:00.000000000 Z
+date: 2014-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay