reqres_rspec 0.0.18 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83cf44dd4f8288fbef887908a138cce36923a3bf
-  data.tar.gz: 5aadd68e1fca3c9af61794675e136e0622fe1d7f
+  metadata.gz: 7ae933f710a7d0f2d94ede0720c9a23cdfc03fc8
+  data.tar.gz: 5642b23a4cdb3b15dfb684a56efd01b93f9c1e73
 SHA512:
-  metadata.gz: 615fbc3c9a72d24fa388dae09e6f1d9cba01675752196db5318ead5a981a0db70ac07b674fe5567301f4767dedbe2e984b5a57b3bd0b702818285e3d9a43252a
-  data.tar.gz: f7254d3347f227dd6af8023c084a38667f14e48622b54dc0f46461cd877e276ba60a18c15351a7ddc691b9cfd05d026fd0fb67447d52095c48f68c8d6801bfd7
+  metadata.gz: dc223b883e456fcb6d1a195df35920b8003f00517c0934d37c12553c6880c16a755b61868e2b5d3b28e312ce3a6321098091bd620023c14ead2f5cd62a314ec2
+  data.tar.gz: b30f31e8fc315f6b96cf335a731c5ee096629d3c9ac315dd25d75338a5377b9b7374f2956c6ac8f5bf2e503bb1eab8cd3570c57c4e71bd3fd37a80fe7300b762

data/README.md

@@ -42,8 +42,8 @@ Documentation will be put into your application's `/doc` folder
 ```ruby
   # @description creates Category from given parameters
   # description text may be multiline
-  # @params category[title] required String Category title
-  # @params category[weight] in which order Category will be shown
+  # @param category[title] required String Category title
+  # @param category[weight] in which order Category will be shown
   # param text may also be multiline
   def create
     category = Category.new(create_category_params)
@@ -57,7 +57,7 @@ Documentation will be put into your application's `/doc` folder
 ```
 
 Description param text is started with `@description` and may be multiline.
-Each param text is started with `@params` and first word will be param name, then optionally `required`, then optionally type (`Integer`, `String` etc), and finally param description, which may be multiline as well.
+Each param text is started with `@param` and first word will be param name, then optionally `required`, then optionally type (`Integer`, `String` etc), and finally param description, which may be multiline as well.
 
 ### Sample rspec test
 

data/lib/reqres_rspec/collector.rb

@@ -16,7 +16,9 @@ module ReqresRspec
     # everything that match items from this list will be stripped
     EXCLUDE_REQUEST_HEADER_PATTERNS = %w[
       rack.
+      ROUTES_
       action_dispatch
+      action_controller.
       REQUEST_METHOD
       SERVER_NAME
       SERVER_PORT
@@ -28,6 +30,10 @@ module ReqresRspec
       HTTP_USER_AGENT
       REMOTE_ADDR
       PATH_INFO
+      ORIGINAL_FULLPATH
+      ORIGINAL_SCRIPT_NAME
+      HTTP_COOKIE
+      HTTP_ORIGIN
     ]
 
     def initialize
@@ -179,7 +185,7 @@ module ReqresRspec
         if line.match /\s*#\s*@description/ # @description blah blah
           description << line.gsub(/\A\s*#\s*@description/, '').strip
           comment_lines[(index + 1)..-1].each do |multiline|
-            if !multiline.match /\s*#\s*@params/
+            if !multiline.match /\s*#\s*@param/
               description << multiline.gsub(/\A\s*#\s*/, '').strip
             else
               break
@@ -199,12 +205,12 @@ module ReqresRspec
       text_params = []
       has_param = false
       comment_lines.each do |line|
-        if line.match /\s*#\s*@params/ # @params id required Integer blah blah
+        if line.match /\s*#\s*@param/ # @param id required Integer blah blah
           has_param = true
           text_params << ''
         end
         if has_param
-          line = line.gsub(/\A\s*#\s*@params/, '').strip
+          line = line.gsub(/\A\s*#\s*@param/, '').strip
           line = line.gsub(/\A\s*#\s*/, '').strip
           text_params.last << line
         end

data/lib/reqres_rspec/version.rb

@@ -1,3 +1,3 @@
 module ReqresRspec
-  VERSION = '0.0.18'
+  VERSION = '0.0.19'
 end

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

@@ -97,7 +97,7 @@
             <li>
               <a href="rspec_doc_<%= (@records.index(record) + 1).to_s.rjust(5, '0') %>.html" target="specs">
                 <span class="method <%= record[:request][:method].downcase %>"><%= record[:request][:method] %></span>
-                <%= record[:description] %><br />
+                <%= record[:title] %><br />
               </a>
             </li>
           <% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reqres_rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.18
+  version: 0.0.19
 platform: ruby
 authors:
 - rilian