reqres_rspec 0.0.27 → 0.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ca3be66232efeb3f2c63616b4ef984e3e17c279
-  data.tar.gz: 193a47aa41e609e19642ec6caef650b0de3ce9fe
+  metadata.gz: 5bb6f6c25de702cda33d7ade7d745595581f2b47
+  data.tar.gz: 8431098e926bc378384c6ccfc9fb7effbfa3b64b
 SHA512:
-  metadata.gz: 66c749ebc70f9af15a708c7d1123d2e1ea7c3bc2032ab8c2b61b68dd6e1ad88d62a8afdcc98d2379d7862c4fc08f0b4a7db9c47db503dfdb534ada54324b805c
-  data.tar.gz: a6723cd536d268926cddb36d7da569a4930fa733b4a1553bde53be7a49864bb6ea2c4b12ac5e1aeaae703a74b7a55cab08329ad41a7882abee84c8cd6766160d
+  metadata.gz: 47a37d830c57ce22e437f447b36871071511b29ede79ebb84d14acea4291956cc7bf246cd02df1fe7c7f333b47fa38fd1e02bc5c82ce471c12d35890e6d57d56
+  data.tar.gz: fe276e431fe0c53d9e757fb7b02974b0814ee07f214560e3103d3f78d5ed6f7b2dbac88e9aa62dcdcd3fbb0dcd8b85830e5bf662b891f1afe78bd4eff7c5edf2

data/lib/reqres_rspec/collector.rb

@@ -82,6 +82,7 @@ module ReqresRspec
       end
 
       self.records << {
+        filename: prepare_filename_for(spec.class.metadata),
         group: section, # Top level example group
         title: spec.class.example.full_description,
         description: description,
@@ -108,6 +109,21 @@ module ReqresRspec
       }
     end
 
+    def prepare_filename_for(metadata)
+      description = metadata[:description]
+      example_group = if metadata.key?(:example_group)
+                        metadata[:example_group]
+                      else
+                        metadata[:parent_example_group]
+                      end
+
+      if example_group
+        [prepare_filename_for(example_group), description].join('/')
+      else
+        description
+      end.gsub!(/[\W]+/, '_')
+    end
+
     # sorts records alphabetically
     def sort
       self.records.sort!{ |x,y| x[:request_path] <=> y[:request_path] }

data/lib/reqres_rspec/version.rb

@@ -1,3 +1,3 @@
 module ReqresRspec
-  VERSION = '0.0.27'
+  VERSION = '0.0.28'
 end

data/lib/reqres_rspec/writers/html.rb

@@ -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(ENV['REQRES_RSPEC_ROOT'], 'doc', 'rspec_doc_00000.html')
+        path = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', 'rspec_doc_table_of_content.html')
         file = File.open(path, 'w')
         file.write(rendered_doc)
         file.close
@@ -54,13 +54,11 @@ module ReqresRspec
       def generate_specs
         tpl_path = File.join(File.dirname(__FILE__), 'templates', 'spec.erb')
 
-        @records.each_with_index do |record, index|
+        @records.each do |record|
           @record = record
-          @index = index + 1
-
           rendered_doc = ERB.new(File.open(tpl_path).read).result(binding)
 
-          path = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', "rspec_doc_#{@index.to_s.rjust(5, '0') }.html")
+          path = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', "rspec_doc_#{record[:filename]}.html")
           file = File.open(path, 'w')
           file.write(rendered_doc)
           file.close

data/lib/reqres_rspec/writers/json_formatter.rb

@@ -0,0 +1,37 @@
+require 'coderay'
+
+module ReqresRspec
+  module Writers
+    class JSONFormatter
+      def initialize(records)
+        @records = records
+      end
+
+      def write
+        recreate_doc_dir
+        cleanup
+
+        path = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc', 'reqres_rspec.json')
+        File.write(path, JSON.pretty_generate(@records))
+        puts "Reqres::Writers::JSONFormatter saved doc spec to #{path}"
+      end
+
+      private
+
+      # recreates /doc dir if it does not exist
+      def recreate_doc_dir
+        doc_dir = File.join(ENV['REQRES_RSPEC_ROOT'], 'doc')
+        unless Dir.exist?(doc_dir)
+          Dir.mkdir(doc_dir)
+          puts "#{doc_dir} was recreated"
+        end
+      end
+
+      # deletes previous version of HTML docs
+      # TODO: more info
+      def cleanup
+        FileUtils.rm_rf(Dir.glob("#{ENV['REQRES_RSPEC_ROOT']}/doc/reqres_rspec.json"), secure: true)
+      end
+    end
+  end
+end

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

@@ -64,7 +64,7 @@
     <% @records.each_with_index do |record, index| %>
       <li>
         <%= index+1 %>.
-        <a href="rspec_doc_<%= ('0000' + (index + 1).to_s)[-5, 5] %>.html">
+        <a href="rspec_doc_<%= record[:filename] %>.html">
           <%= record[:title] %>
         </a>
       </li>

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

@@ -19,6 +19,6 @@
   </head>
   <frameset cols="350,*" frameborder="1" border="1" bordercolor="#999999" framespacing="1">
     <frame name="panel" src="./panel.html">
-    <frame name="specs" src="./rspec_doc_00000.html">
+    <frame name="specs" src="./rspec_doc_table_of_content.html">
   </frameset>
 </html>

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

@@ -85,7 +85,7 @@
     </style>
   </head>
   <body>
-    <h1><a href="rspec_doc_00000.html" target="specs">
+    <h1><a href="rspec_doc_table_of_content.html" target="specs">
       <%= ENV['REQRES_RSPEC_APP'] %> API
     </a></h1>
     <% @records.group_by{|h| h[:group]}.each do |group, items| %>
@@ -95,7 +95,7 @@
         <ul>
           <% records.each do |record| %>
             <li>
-              <a href="rspec_doc_<%= (@records.index(record) + 1).to_s.rjust(5, '0') %>.html" target="specs">
+              <a href="rspec_doc_<%= record[:filename] %>.html" target="specs">
                 <span class="method <%= record[:request][:method].downcase %>"><%= record[:request][:method] %></span>
                 <%= record[:title] %><br />
               </a>

data/lib/reqres_rspec.rb

@@ -1,6 +1,7 @@
 require 'reqres_rspec/version'
 require 'reqres_rspec/collector'
 require 'reqres_rspec/writers/html'
+require 'reqres_rspec/writers/json_formatter'
 require 'reqres_rspec/generators/pdf'
 
 if defined?(RSpec) && ENV['REQRES_RSPEC'] == '1'
@@ -40,8 +41,25 @@ if defined?(RSpec) && ENV['REQRES_RSPEC'] == '1'
     config.after(:suite) do
       if collector.records.size > 0
         collector.sort
-        ReqresRspec::Writers::Html.new(collector.records).write
-        ReqresRspec::Generators::Pdf.new.generate
+        formatters = %w(html pdf json)
+
+        requested_formats = (ENV['REQRES_RSPEC_FORMATTERS'] || 'html').split(',')
+        requested_formats.sort_by!{|fmt| [formatters.index(fmt), fmt]}
+        requested_formats.each do |fmt|
+          case fmt
+          when 'html'
+            ReqresRspec::Writers::Html.new(collector.records).write
+          when 'pdf'
+            ReqresRspec::Writers::Html.new(collector.records).write unless requested_formats.include?('html')
+            ReqresRspec::Generators::Pdf.new.generate
+          when 'json'
+            ReqresRspec::Writers::JSONFormatter.new(collector.records).write
+          else
+            puts "No formatters defined, define one of #{formatters} in REQRES_RSPEC_FORMATTERS"
+          end
+        end
+
+        #
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reqres_rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.27
+  version: 0.0.28
 platform: ruby
 authors:
 - rilian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-30 00:00:00.000000000 Z
+date: 2014-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coderay
@@ -72,6 +72,7 @@ files:
 - lib/reqres_rspec/generators/pdf.rb
 - lib/reqres_rspec/version.rb
 - lib/reqres_rspec/writers/html.rb
+- lib/reqres_rspec/writers/json_formatter.rb
 - lib/reqres_rspec/writers/templates/header.erb
 - lib/reqres_rspec/writers/templates/index.erb
 - lib/reqres_rspec/writers/templates/panel.erb