reqres_rspec 0.0.25 → 0.0.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ece5a9cd5765fb189266e6ed1105ec3c0e5bbca2
-  data.tar.gz: 2b4f4d9e313f13280311b76f29b774280f99d8ec
+  metadata.gz: 4c6ca4e4259bb1d65278581ef0bd30fd584c5f30
+  data.tar.gz: 1fe08d50de503b97bdd9a7307f95f53ba6f9f69e
 SHA512:
-  metadata.gz: f683c76e4d1031a829ef9b311cd67918a79fd939f7e2b8c570b5e83bddca8c67bef72c85203d3391e73bfc23d25abd567b68aa7179b62ecf2533c08a51b2a1ed
-  data.tar.gz: 8bbdd2ae0d4add46eb439ee737a1b119dcaad7b826a1277d3fbad57225a802c05b87e7fdd5928f79a283a16452ec575007df72ae3ea46e887c1d7266e874d881
+  metadata.gz: b0b91d0c7fcc0f6bf080e8447a490e19699c829a6d1f304dbccf21da96a6a33c217dabaf180c51df90775bcb6acc20aeb98cf07f5932e15e497294d2b73135d7
+  data.tar.gz: 07017e0e97178ad186755dded165667437783c2f8955f911b5f739746b0ef246b974358822d0c841973491eebd66e15bef368dc81d78161a811d3f6debbdc59d

data/lib/reqres_rspec/collector.rb

@@ -31,6 +31,8 @@ module ReqresRspec
     # everything that match items from this list will be stripped
     EXCLUDE_REQUEST_HEADER_PATTERNS = %w[
       rack.
+      sinatra.commonlogger
+      sinatra.route
       ROUTES_
       action_dispatch
       action_controller.
@@ -96,7 +98,7 @@ module ReqresRspec
           content_length: request.content_length,
           content_type: request.content_type,
           headers: read_request_headers(request),
-          accept: request.accept
+          accept: (request.accept rescue nil)
         },
         response: {
           code: response.status,
@@ -142,8 +144,11 @@ 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.env['action_dispatch.request.parameters'].
+      request_params.
         reject { |param| %w[controller action].include? param }.
         each do |key, value|
         if value.is_a? String
@@ -160,7 +165,7 @@ module ReqresRspec
     # returns action comments taken from controller file
     # example TODO
     def get_action_comments(controller, action)
-      lines = File.readlines(File.join(Rails.root, 'app', 'controllers', "#{controller}_controller.rb"))
+      lines = File.readlines(File.join(ENV['REQRES_RSPEC_ROOT'], 'app', 'controllers', "#{controller}_controller.rb"))
 
       action_line = nil
       lines.each_with_index do |line, index|

data/lib/reqres_rspec/generators/pdf.rb

@@ -6,8 +6,8 @@ module ReqresRspec
       def generate
         # http://www.princexml.com/download/
         pdf_tool_path = 'prince'
-        html_docs_root = File.join(Rails.root, 'doc')
-        pdf_doc_path = File.join(Rails.root, 'doc', "rspec_doc_#{Time.now.strftime("%d-%h-%Y_%H-%M")}.pdf")
+        html_docs_root = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc')
+        pdf_doc_path = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', "rspec_doc_#{Time.now.strftime("%d-%h-%Y_%H-%M")}.pdf")
 
         if `which #{pdf_tool_path}`.size > 0
           files = Dir["#{html_docs_root}/rspec_doc_*.html"]
@@ -26,4 +26,4 @@ module ReqresRspec
       end
     end
   end
-end
+end

data/lib/reqres_rspec/version.rb

@@ -1,3 +1,3 @@
 module ReqresRspec
-  VERSION = '0.0.25'
+  VERSION = '0.0.26'
 end

data/lib/reqres_rspec/writers/html.rb

@@ -21,7 +21,7 @@ module ReqresRspec
 
       # recreates /doc dir if it does not exist
       def recreate_doc_dir
-        doc_dir = File.join(Rails.root, 'doc')
+        doc_dir = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc')
         unless Dir.exist?(doc_dir)
           Dir.mkdir(doc_dir)
           puts "#{doc_dir} was recreated"
@@ -31,9 +31,9 @@ module ReqresRspec
       # deletes previous version of HTML docs
       # TODO: more info
       def cleanup
-        FileUtils.rm_rf(Dir.glob("#{Rails.root}/doc/rspec_doc_*.html"), secure: true)
-        FileUtils.rm_rf(Dir.glob("#{Rails.root}/doc/index.html"), secure: true)
-        FileUtils.rm_rf(Dir.glob("#{Rails.root}/doc/panel.html"), secure: true)
+        FileUtils.rm_rf(Dir.glob("#{ENV['REQRES_RSPEC_ROOT']}/doc/rspec_doc_*.html"), secure: true)
+        FileUtils.rm_rf(Dir.glob("#{ENV['REQRES_RSPEC_ROOT']}/doc/index.html"), secure: true)
+        FileUtils.rm_rf(Dir.glob("#{ENV['REQRES_RSPEC_ROOT']}/doc/panel.html"), secure: true)
       end
 
       # generates contents of HTML docs
@@ -42,7 +42,7 @@ module ReqresRspec
         tpl_path = File.join(File.dirname(__FILE__), 'templates', 'header.erb')
         rendered_doc = ERB.new(File.open(tpl_path).read).result(binding)
 
-        path = File.join(Rails.root, 'doc', 'rspec_doc_00000.html')
+        path = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', 'rspec_doc_00000.html')
         file = File.open(path, 'w')
         file.write(rendered_doc)
         file.close
@@ -60,7 +60,7 @@ module ReqresRspec
 
           rendered_doc = ERB.new(File.open(tpl_path).read).result(binding)
 
-          path = File.join(Rails.root, 'doc', "rspec_doc_#{@index.to_s.rjust(5, '0') }.html")
+          path = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', "rspec_doc_#{@index.to_s.rjust(5, '0') }.html")
           file = File.open(path, 'w')
           file.write(rendered_doc)
           file.close
@@ -70,7 +70,7 @@ module ReqresRspec
 
       # creates an index file with iframes if does not exists
       def append_index
-        index_file = File.join(Rails.root, 'doc', 'index.html')
+        index_file = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', 'index.html')
         unless File.exists?(index_file)
           tpl_path = File.join(File.dirname(__FILE__), 'templates', 'index.erb')
           rendered_doc = ERB.new(File.open(tpl_path).read).result(binding)
@@ -79,7 +79,7 @@ module ReqresRspec
       end
 
       def append_panel
-        index_file = File.join(Rails.root, 'doc', 'panel.html')
+        index_file = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', 'panel.html')
         unless File.exists?(index_file)
           tpl_path = File.join(File.dirname(__FILE__), 'templates', 'panel.erb')
           rendered_doc = ERB.new(File.open(tpl_path).read).result(binding)

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

@@ -1,6 +1,6 @@
 <html>
 <head>
-  <title><%= Rails.application.class.to_s.sub('::Application', '') %> API Documentation</title>
+  <title><%= ENV['REQRES_RSPEC_APP'] %> API Documentation</title>
   <link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700' rel='stylesheet' type='text/css'>
   <link href='http://fonts.googleapis.com/css?family=Droid+Sans+Mono' rel='stylesheet' type='text/css'>
   <style>
@@ -58,7 +58,7 @@
 </head>
 <body>
 <div class="container">
-  <h1><%= Rails.application.class.to_s.sub('::Application', '') %> API Documentation</h1>
+  <h1><%= ENV['REQRES_RSPEC_APP'] %> API Documentation</h1>
   <p>Generated <%= Time.now.strftime('%d %B %Y at %H:%m:%S')%> with <a href="https://github.com/reqres-api/reqres_rspec">reqres_rspec</a></p>
   <ul>
     <% @records.each_with_index do |record, index| %>

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

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <title><%= Rails.application.class.to_s.sub('::Application', '') %> API Documentation</title>
+    <title><%= ENV['REQRES_RSPEC_APP'] %> API Documentation</title>
     <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8" />
     <link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700' rel='stylesheet' type='text/css'>
     <link href='http://fonts.googleapis.com/css?family=Droid+Sans+Mono' rel='stylesheet' type='text/css'>

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

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <title><%= Rails.application.class.to_s.sub('::Application', '') %> API Documentation</title>
+    <title><%= ENV['REQRES_RSPEC_APP'] %> API Documentation</title>
     <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8" />
     <link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700' rel='stylesheet' type='text/css'>
     <link href='http://fonts.googleapis.com/css?family=Droid+Sans+Mono' rel='stylesheet' type='text/css'>
@@ -86,7 +86,7 @@
   </head>
   <body>
     <h1><a href="rspec_doc_00000.html" target="specs">
-      <%= Rails.application.class.to_s.sub('::Application', '') %> API
+      <%= ENV['REQRES_RSPEC_APP'] %> API
     </a></h1>
     <% @records.group_by{|h| h[:group]}.each do |group, items| %>
       <h2><%= group %></h2>

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

@@ -1,6 +1,6 @@
 <html>
 <head>
-  <title><%= Rails.application.class.to_s.sub('::Application', '') %> API Documentation</title>
+  <title><%= ENV['REQRES_RSPEC_APP'] %> API Documentation</title>
   <link href='http://fonts.googleapis.com/css?family=Droid+Sans:400,700' rel='stylesheet' type='text/css'>
   <link href='http://fonts.googleapis.com/css?family=Droid+Sans+Mono' rel='stylesheet' type='text/css'>
   <style>
@@ -139,12 +139,12 @@
       margin: 0;
       padding: 0 4px;
     }
-    ol li:first-child{
+    ol li:first-child {
       padding-top: 5px;
-	}
-    ol li:last-child{
+    }
+    ol li:last-child {
       padding-bottom: 5px;
-	}
+    }
   </style>
 </head>
 <body>
@@ -155,7 +155,7 @@
     </h3>
 
     <p>
-      <%= @record[:description].gsub("\n", '<br>'.html_safe) %>
+      <%= @record[:description].gsub("\n", ('<br>'.respond_to?(:html_safe) && '<br>'.html_safe) || '<br>') %>
     </p>
 
     <code><%= @record[:request][:method] %> <%= @record[:request_path] %></code>
@@ -179,7 +179,7 @@
                 <% end %>
               </td>
               <td><%= param[:type] %></td>
-              <td><%= param[:description].gsub("\n", '<br>'.html_safe) %></td>
+              <td><%= param[:description].gsub("\n", ('<br>'.respond_to?(:html_safe) && '<br>'.html_safe) || '<br>') %></td>
             </tr>
           <% end %>
         </table>

data/lib/reqres_rspec.rb

@@ -10,10 +10,27 @@ if defined?(RSpec) && ENV['REQRES_RSPEC'] == '1'
     config.after(:each) do
       # TODO: remove boilerplate code
       # TODO: better options
-      meta_data = self.class.example.metadata
-      if meta_data[:type] == :request && !meta_data[:skip_reqres] == true
+
+      if defined?(Rails)
+        ENV['REQRES_RSPEC_ROOT'] = Rails.root.to_s
+        ENV['REQRES_RSPEC_APP'] = Rails.application.class.to_s.sub('::Application', '')
+
+        meta_data = self.class.example.metadata
+        if meta_data[:type] == :request && meta_data[:skip_reqres] == true
+          begin
+            collector.collect(self, self.request, self.response)
+          rescue NameError
+            raise $!
+          end
+        end
+      elsif defined?(Sinatra)
+        raise 'REQRES_RSPEC_ROOT is not defined' if ENV['REQRES_RSPEC_ROOT'].blank?
+        raise 'REQRES_RSPEC_APP is not defined' if ENV['REQRES_RSPEC_APP'].blank?
+
         begin
-          collector.collect(self, self.request, self.response)
+          collector.collect(self, self.last_request, self.last_response)
+        rescue Rack::Test::Error
+          #
         rescue NameError
           raise $!
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reqres_rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.26
 platform: ruby
 authors:
 - rilian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-26 00:00:00.000000000 Z
+date: 2014-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay