reqres_rspec 0.0.14 → 0.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 489c6ec987e6271ce2774c2dc1d2f75d862d83ce
-  data.tar.gz: 44f7f0c8a4af0972332caa50225f4adcd3106256
+  metadata.gz: 37c81ea83e40e5956d5ac04dc91e70b7c82c71a4
+  data.tar.gz: 426569056ed69c40110d35968089b7bd23ecea7f
 SHA512:
-  metadata.gz: ed35216a3eb1189921cadb4032517b3bc4c90926cd4c0eb15745bb4c3244c98e11560b67615c89e83fca499a389d46fda3669a9fd144f6e57e66f670e9526d6e
-  data.tar.gz: afa5350b12255105840b248ed92ba1d766933897383d8f62f4eca1a843578c9528d27d3be2f1f9f701d87ccf69541ab26e1dd404c1c0ea2d1c3970f0c8d73e72
+  metadata.gz: 0b4ddf6150b33d84f1a9a5be2bdc77a4a8471b5d8ea2ecd6d63b8ad1aafe0f86f0cc8a07b9760fad195e57f00dfdb1c7ad7a40994eeb79f45493de2f31833cc2
+  data.tar.gz: 2ed8b1bb73d1f205d90612770a494d8fd5f463be54c4aa2000df89baa40400b8f8836def7cfa45c1d9ceeb7d778cd761fd1dc19a5cae3c0aaa2f7e177d38d79d

data/README.md

@@ -4,6 +4,8 @@ Gem generates API documentation from your integration tests written with `rspec`
 
 ## Installation
 
+### Gem
+
 Add this line to your application's Gemfile:
 
     gem 'reqres_rspec'
@@ -16,6 +18,19 @@ Or install it yourself as:
 
     $ gem install reqres_rspec
 
+### PDF generator
+
+Install `prince` http://www.princexml.com/download/
+
+For MacOS this will be
+
+```
+wget http://www.princexml.com/download/prince-9.0r2-macosx.tar.gz
+tar -xvf prince-9.0r2-macosx.tar.gz
+cd prince-9.0r2-macosx
+./install.sh
+```
+
 ## Usage
 
 ### Sample controller action

data/lib/reqres_rspec/generators/pdf.rb

@@ -4,23 +4,24 @@ module ReqresRspec
       # generates PDF file from existing HTML docs
       # TODO: more info
       def generate
-        wkhtmltopdf_path = '/Applications/wkhtmltopdf.app/Contents/MacOS/wkhtmltopdf'
+        # 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', "spec_#{Time.now.strftime("%d-%h-%Y_%H-%M")}.pdf")
+        pdf_doc_path = File.join(Rails.root, 'doc', "rspec_doc_#{Time.now.strftime("%d-%h-%Y_%H-%M")}.pdf")
 
-        if File.exists?(wkhtmltopdf_path)
-          files = Dir["#{html_docs_root}/rspec_docs_*.html"]
+        if `which #{pdf_tool_path}`.size > 0
+          files = Dir["#{html_docs_root}/rspec_doc_*.html"]
           if files.size > 0
-            files_arg = files.map { |f| f if f =~ /\/rspec_docs_\d+\.html/ }.compact.sort.join('" "')
+            files_arg = files.map { |f| f if f =~ /\/rspec_doc_\d+\.html/ }.compact.sort.join('" "')
 
-            `#{wkhtmltopdf_path} "#{files_arg}" "#{pdf_doc_path}"`
+            `#{pdf_tool_path} "#{files_arg}" -o "#{pdf_doc_path}"`
 
-            puts "saved to #{pdf_doc_path}" if File.exists? pdf_doc_path
+            puts "ReqresRspec::Generators::Pdf saved doc to #{pdf_doc_path}" if File.exists? pdf_doc_path
           else
             puts 'No HTML files found'
           end
         else
-          puts 'ERROR: wkhtmltopdf app not installed! Please check http://code.google.com/p/wkhtmltopdf/ for more info'
+          puts "ERROR: #{pdf_tool_path} is not installed! Check README.md for more info"
         end
       end
     end

data/lib/reqres_rspec/version.rb

@@ -1,3 +1,3 @@
 module ReqresRspec
-  VERSION = '0.0.14'
+  VERSION = '0.0.15'
 end

data/lib/reqres_rspec/writers/html.rb

@@ -26,7 +26,7 @@ module ReqresRspec
       # deletes previous version of HTML docs
       # TODO: more info
       def cleanup
-        FileUtils.rm_rf(Dir.glob("#{Rails.root}/doc/rspec_docs_*.html"), secure: true)
+        FileUtils.rm_rf(Dir.glob("#{Rails.root}/doc/rspec_doc_*.html"), secure: true)
       end
 
       # generates contents of HTML docs
@@ -35,7 +35,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_docs_00000.html')
+        path = File.join(Rails.root, 'doc', 'rspec_doc_00000.html')
         file = File.open(path, 'w')
         file.write(rendered_doc)
         file.close
@@ -53,7 +53,7 @@ module ReqresRspec
 
           rendered_doc = ERB.new(File.open(tpl_path).read).result(binding)
 
-          path = File.join(Rails.root, 'doc', "rspec_docs_#{('0000' + (@index).to_s)[-5, 5]}.html")
+          path = File.join(Rails.root, 'doc', "rspec_doc_#{('0000' + (@index).to_s)[-5, 5]}.html")
           file = File.open(path, 'w')
           file.write(rendered_doc)
           file.close

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

@@ -4,6 +4,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'>
   <style>
+    @page { size: 24.5cm 35cm } /* http://www.princexml.com/doc/9.0/page-size/ */
+
     body {
       color: #333333;
       font-family: 'Verdana', 'Droid Sans', sans-serif;
@@ -17,7 +19,8 @@
       box-sizing: border-box;
     }
     .container {
-      padding: 40px;
+      padding: 0;
+      width: 100%;
     }
     h1, h2, ul {
       margin: 0 0 10px;
@@ -61,7 +64,7 @@
     <% @records.each_with_index do |record, index| %>
       <li>
         <%= index+1 %>.
-        <a href="rspec_docs_<%= ('0000' + (index + 1).to_s)[-5, 5] %>.html">
+        <a href="rspec_doc_<%= ('0000' + (index + 1).to_s)[-5, 5] %>.html">
           <%= record[:title] %>
         </a>
       </li>

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

@@ -4,6 +4,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'>
   <style>
+    @page { size: 24.5cm 35cm } /* http://www.princexml.com/doc/9.0/page-size/ */
+
     body {
       color: #333333;
       font-family: 'Verdana', 'Droid Sans', sans-serif;
@@ -17,7 +19,8 @@
       box-sizing: border-box;
     }
     .container {
-      padding: 40px;
+      padding: 0;
+      width: 100%;
     }
     h1, h2, ul {
       margin: 0 0 10px;
@@ -141,7 +144,7 @@
 <body>
   <div class="container">
     <h3>
-      <a href="rspec_docs_00000.html">&#9650</a>
+      <a href="rspec_doc_00000.html">&#9650</a>
       <a id="<%= @index %>"></a><%= @index %>. <%= @record[:title] %>
     </h3>
 

data/lib/reqres_rspec.rb

@@ -26,5 +26,5 @@ if defined?(RSpec) && ENV['REQRES_RSPEC'] == '1'
     end
   end
 else
-  puts "\nNOTICE: ReqresRspec is disabled. run RSpec with REQRES_RSPEC=1 environment var\n"
+  puts "\nNOTICE: ReqresRspec is disabled. run `REQRES_RSPEC=1 bundle exec rspec`\n"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reqres_rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.14
+  version: 0.0.15
 platform: ruby
 authors:
 - rilian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-17 00:00:00.000000000 Z
+date: 2013-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler