reqres_rspec 0.0.20 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01c69919cded3fc726e8b5f548c0b46788a2fcaa
-  data.tar.gz: 6b70f035c8406224f4ba64fcd041e5f1996b269b
+  metadata.gz: 85c05723ee091bb7320037e073ab67109ca2e22f
+  data.tar.gz: ae6d4ebfedfb2d5a5933d2ffb146b61959d9b103
 SHA512:
-  metadata.gz: 68b3d8736b6376b5e31982fa011e36ce023023ad6f00809bddeeb40408df4a670183992115bdb5c714a28ee5d81121eafd1200e4305c63450c387e2b04698ac7
-  data.tar.gz: a359888d091f877c69e8bee6f39c78d86fba3faa08911b32c7bc6f8f547d91317b6d000f7db4002edca3e9e849a850287e0a98a57832824b0fa1a1ac790c1a75
+  metadata.gz: 131b3a90632fcf9eba91c05b065d6054d165c1a2884434924516b309a5e52def7f9ca5b1a78303254a1f4259dcb2c40c0c81f28e96938aba511746d98078402a
+  data.tar.gz: 6edca5c0fbb7cba3ae34065258f2ee70882ac76f8b5da96b8ff04f153d8af7062a06a69000a863b0f92b73afc000dcfad009edcd64a0b2f67fd971876add7750

data/README.md

@@ -62,19 +62,20 @@ Each param text is started with `@param` and first word will be param name, then
 ### Sample rspec test
 
 ```ruby
-  describe 'Create' do
-    it 'creates category' do
-      post :create, category: { name: 'Cookies' }
+  context 'With valid params' do
+    it 'bakes pie' do
       ...
     end
+  end
 
-    it 'some other example', :skip_reqres do
+  context 'With invalid params', :skip_reqres do
+    it 'returns errors' do
       ...
     end
   end
 ```
 
- By default all examples will be added to docs. Example 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)may be excluded from docs with option `:skip_reqres`
 
  Doc will use full example description, as a title for each separate spec
 

data/lib/reqres_rspec/collector.rb

@@ -3,6 +3,12 @@ module ReqresRspec
     # Contains spec values read from rspec example, request and response
     attr_accessor :records
 
+    # param importances
+    PARAM_IMPORTANCES = %w[required optional]
+
+    # param types
+    PARAM_TYPES = %w[Integer Boolean String Text Float Date DateTime File Array]
+
     # response headers contain many unnecessary information,
     # everything from this list will be stripped
     EXCLUDE_RESPONSE_HEADER_PATTERNS = %w[
@@ -212,7 +218,6 @@ module ReqresRspec
           comments_raw << ''
         end
         if has_param
-          #text_params.last << "\n"
           line = line.gsub(/\A\s*#\s*@param/, '')
           line = line.gsub(/\A\s*#\s*/, '').strip
 
@@ -223,7 +228,7 @@ module ReqresRspec
 
       comments = []
       comments_raw.each do |comment|
-        match_data = comment.match /(?<name>[a-z0-9A-Z_\[\]]+)?\s*(?<required>required|optional)?\s*(?<type>Integer|Boolean|String|Text|Float|Date|DateTime|File|Array)?\s*(?<description>.*)/m
+        match_data = comment.match /(?<name>[a-z0-9A-Z_\[\]]+)?\s*(?<required>#{PARAM_IMPORTANCES.join('|')})?\s*(?<type>#{PARAM_TYPES.join('|')})?\s*(?<description>.*)/m
 
         if match_data
           comments << {

data/lib/reqres_rspec/version.rb

@@ -1,3 +1,3 @@
 module ReqresRspec
-  VERSION = '0.0.20'
+  VERSION = '0.0.21'
 end

data/lib/reqres_rspec/writers/templates/spec.erb

@@ -171,7 +171,13 @@
           </tr>
           <% @record[:params].each do |param| %>
             <tr>
-              <td><%= param[:name] %> <i class="required"><%= param[:required] %></i></td>
+              <td>
+                <%= param[:name] %>
+                <% if param[:required].present? %>
+                  <br/>
+                  <i class="required"><%= param[:required] %></i>
+                <% end %>
+              </td>
               <td><%= param[:type] %></td>
               <td><%= param[:description].gsub("\n", '<br>'.html_safe) %></td>
             </tr>

data/lib/reqres_rspec.rb

@@ -11,9 +11,9 @@ if defined?(RSpec) && ENV['REQRES_RSPEC'] == '1'
       # TODO: remove boilerplate code
       # TODO: better options
       meta_data = self.class.example.metadata
-      if meta_data[:type] == :request
+      if meta_data[:type] == :request && !meta_data[:skip_reqres] == true
         begin
-          collector.collect(self, self.request, self.response) unless meta_data[:skip_reqres] == true
+          collector.collect(self, self.request, self.response)
         rescue NameError
           raise $!
         end
@@ -28,6 +28,4 @@ if defined?(RSpec) && ENV['REQRES_RSPEC'] == '1'
       end
     end
   end
-else
-  puts "\nNOTICE: ReqresRspec is disabled. run `REQRES_RSPEC=1 bundle exec rspec --order=defined`\n"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reqres_rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.21
 platform: ruby
 authors:
 - rilian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2014-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay