flavored_gherkin 0.1 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2984005e874db23498bb3a6ef00dd9a44d551182
-  data.tar.gz: 2a5dc7a2f413282fe14a24ce1174fbe7f2db1bba
+  metadata.gz: c7000dd4a6449c98993ad1e828cb4fdcc91900bf
+  data.tar.gz: bb365294fe5c6fef118db1db563003f844a312e5
 SHA512:
-  metadata.gz: a394260d7c3ff161c4b4e593104bd3c5637c866f20eaaac56caf99bc13c6ca578a43a416eb85641c06455de651e4b6c49590e3bcaebb92fab59af688fafb4911
-  data.tar.gz: 88a4a62c3592fde1b8d28d8897c1af4acb8377112514199ba6ba977065362875c988a47ab35a95d0029d07fcb151598b90b366f2114fe0b06279f7b64d07299e
+  metadata.gz: 575f4b4a872d21dec210548439e766ba1c699028f848c1e29f479f756e0fa1da4bb59a8995fb956b69563176ad0d6a85afa6179105a4b1c27504339f85fdb004
+  data.tar.gz: 2c4797c56ea45f93db9cd59e7fc83e3dbe96e8c577a48cc5952b6109cb32f2aa88473e2788063f9363b9620f102eb09e0e8b4d5b93b6aa77e3f44632e68ccd14

data/README.md

@@ -1,15 +1,17 @@
-# Flavored Gherkin
+# FlavoredGherkin
 
 [![Gem Version](https://badge.fury.io/rb/flavored_gherkin.svg)](https://badge.fury.io/rb/flavored_gherkin)
 [![Build status](https://travis-ci.org/rajatthareja/FlavoredGherkin.svg?branch=master)](https://travis-ci.org/rajatthareja/FlavoredGherkin)
 [![Windows Build status](https://ci.appveyor.com/api/projects/status/agvyur7bg5ul1444/branch/master?svg=true)](https://ci.appveyor.com/project/rajatthareja/flavoredgherkin)
  
 
-Ruby gem to convert gherkin feature files into html flavour. 
+Ruby gem to convert gherkin feature files into html and pdf flavour.
 
-**[View Sample](http://flavoredgherkin.rajatthareja.com/sample/Flavored_Gherkin_Sample.html)**
+**[Html Flavour Sample](http://flavoredgherkin.rajatthareja.com/sample/Flavored_Gherkin_Sample.html)**
 
-More flavours coming soon!
+**[Pdf Flavour Sample](http://flavoredgherkin.rajatthareja.com/sample/Flavored_Gherkin_Sample.pdf)**
+
+**More flavours coming soon!**
 
 ## Installation
 
@@ -33,12 +35,13 @@ gem install flavored_gherkin
 | title                     | [String]    | 'Flavored Gherkin'         | Flavored Gherkin Title        |
 | feature_path / input_path | [String]    | Present Working Directory  | Feature Files Path            |
 | output_path               | [String]    | Present Working Directory  | Flavored Gherkin Output Path  |
+| flavour                   | [String]    | 'Html'                     | 'Html' or 'Pdf'               |
 
 ### Code Examples:
 
 ```ruby
 
-     require 'report_builder'
+     require 'flavored_gherkin'
     
     # Example 1:
     
@@ -73,6 +76,7 @@ gem install flavored_gherkin
     FlavoredGherkin.title = 'My Features'
     FlavoredGherkin.feature_path = 'myFolder/features'
     FlavoredGherkin.output_path  = 'myFolder/my_features'
+    FlavoredGherkin.flavour  = 'pdf'
     
     FlavoredGherkin.build
                 
@@ -85,6 +89,7 @@ gem install flavored_gherkin
 | -t, --source               | TITLE         | Flavored Gherkin Title         |
 | -f, --features / -i, --in  | FEATURE_PATH  | Feature Files Path             |
 | -o, --out                  | OUTPUT_PATH   | Flavored Gherkin Output Path   |
+| -F, --flavour              | FLAVOUR       | 'Html' or 'Pdf'                |
 
 ### CLI Example:
 

data/bin/flavored_gherkin

@@ -10,7 +10,7 @@ opt_parser = OptionParser.new do |opts|
   opts.separator 'Flavored Gherkin options:'
 
   opts.on('-F', '--flavour FLAVOUR', String, 'Flavored Gherkin Flavour') do |flavour|
-    options[:flavour] = flavour
+    options[:flavour] = flavour.capitalize
   end
 
   opts.on('-f', '--features FEATURE_PATH', String, 'Feature Files Path') do |feature_path|

data/flavored_gherkin.gemspec

@@ -1,20 +1,22 @@
 Gem::Specification.new do |s|
   s.name        = 'flavored_gherkin'
-  s.version     = '0.1'
+  s.version     = '0.3'
   s.bindir      = 'bin'
-  s.summary     = 'Ruby gem to convert gherkin feature files into html flavour.'
-  s.description = ''
+  s.summary     = 'FlavoredGherkin'
+  s.description = 'Ruby gem to convert gherkin feature files into html and pdf flavour.'
+  s.post_install_message = 'More flavours coming soon!'
   s.authors     = ['Rajat Thareja']
   s.email       = 'rajat.thareja.1990@gmail.com'
   s.homepage    = 'http://flavoredgherkin.rajatthareja.com'
   s.license     = 'MIT'
-  s.required_ruby_version = '>= 1.9.1'
+  s.required_ruby_version = '>= 2.1'
 
   s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(sample/|css/|js/|pkg/|testing/|coverage/|CNAME|.gitignore|appveyor.yml|.travis.yml|_config.yml|Gemfile|Rakefile|fg.ico)}) }
   s.executables = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.test_files  = s.files.grep(%r{^(testing)/})
 
-  s.add_runtime_dependency 'gherkin', '>= 4.0.0'
+  s.add_runtime_dependency 'gherkin', '>= 3.2.0'
+  s.add_runtime_dependency 'prawn', '>= 2.2.0'
 
   s.add_development_dependency 'rake', '< 13.0'
   s.add_development_dependency 'rspec', '< 4.0'

data/lib/flavored_gherkin.rb

@@ -1,5 +1,6 @@
 require 'pathname'
 require_relative 'flavored_gherkin/html_flavour'
+require_relative 'flavored_gherkin/pdf_flavour'
 
 ##
 # Flavored Gherkin
@@ -49,7 +50,7 @@ module FlavoredGherkin
   #
   def self.flavour=(flavour)
     @options ||= {}
-    @options[:flavour] = flavour
+    @options[:flavour] = flavour.capitalize
   end
 
   ##
@@ -126,7 +127,7 @@ module FlavoredGherkin
     elsif options.is_a? Hash
       @options.merge! options
     end
-    const_get(flavour).new.build title, feature_files, output_path
+    const_get(flavour + 'Flavour').new.build title, feature_files, output_path
   end
 
   ##
@@ -136,7 +137,7 @@ module FlavoredGherkin
   #
   def self.flavour
     @options ||= {}
-    ['HtmlFlavour'].include?(@options[:flavour]) ? @options[:flavour] : 'HtmlFlavour'
+    %w[Html Pdf].include?(@options[:flavour]) ? @options[:flavour] : 'Html'
   end
 
   ##
@@ -146,7 +147,7 @@ module FlavoredGherkin
   #
   def self.title
     @options ||= {}
-    @options[:title] || (@options[:feature_path] || @options[:input_path] || 'Gherkin/Flavored').split('/').reverse[0..5].join(' ').gsub('.', '')
+    @options[:title] || (@options[:feature_path] || @options[:input_path] || 'Gherkin/Flavored').split('/').reverse[0..5].join(' ').delete('.')
   end
 
   ##

data/lib/flavored_gherkin/flavour.rb

@@ -5,6 +5,13 @@ module FlavoredGherkin
   # Base for Flavored Gherkin Flavours
   #
   class Flavour
+    ##
+    # Parser Feature Files and Returns List of Gherkin Documents
+    #
+    # @param [Array] feature_files List of feature files
+    #
+    # @return [Array] List of Gherkin Documents
+    #
     def get_gherkins(feature_files)
       parser = Gherkin::Parser.new
       feature_files.map do |file|

data/lib/flavored_gherkin/pdf_flavour.rb

@@ -0,0 +1,127 @@
+require 'prawn'
+require_relative 'flavour'
+
+module FlavoredGherkin
+  ##
+  # PDF Flavored Gherkin
+  #
+  class PdfFlavour < Flavour
+    ##
+    # Build PDF Flavored Gherkin
+    #
+    def build(title, feature_files, output_path)
+      info = {
+        Title: title,
+        Author: 'FlavoredGherkin',
+        CreationDate: Time.now
+      }
+
+      gherkins = Flavour.new.get_gherkins(feature_files)
+
+      tags = {}
+
+      Prawn::Document.generate("#{output_path}.pdf", info: info) do |pdf|
+        pdf.font_size 30
+        pdf.text title, align: :center, color: '3a5b93', stylr: :bold
+        pdf.move_down 30
+
+        pdf.font_size 20
+        pdf.text 'Index', color: '3a5b93', stylr: :bold
+        pdf.move_down 10
+
+        pdf.font_size 12
+        pdf.bounding_box([10, pdf.cursor], width: pdf.bounds.right) do
+          gherkins.each_with_index do |g, fid|
+            pdf.move_down 10
+
+            pdf.text "<color rgb='3a5b93'>O</color> <link anchor='Feature #{fid}'>#{g[:feature][:name]}</link>", inline_format: true
+
+            pdf.bounding_box([10, pdf.cursor], width: pdf.bounds.right) do
+              g[:feature][:children].each_with_index do |scenario, sid|
+                next if scenario[:type] == :Background
+                pdf.text "<color rgb='3a5b93'>o</color> <link anchor='Scenario #{fid} #{sid}'>#{scenario[:name]}</link>", inline_format: true
+              end
+            end
+          end
+        end
+
+        gherkins.each_with_index do |g, fid|
+          pdf.start_new_page
+
+          pdf.add_dest "Feature #{fid}", pdf.dest_xyz(pdf.bounds.absolute_left, pdf.y)
+
+          feature_tags = g[:feature][:tags].map { |t| t[:name] }
+          pdf.text(feature_tags.join(' '), color: '00695c')
+          feature_tags.each do |tag|
+            count = 0
+            g[:feature][:children].each do |scenario|
+              next if scenario[:type] == :Background
+              count += scenario[:examples] ? scenario[:examples].map { |e| e[:tableBody] }.flatten.size : 1
+            end
+            tags[tag] ? tags[tag] += count : tags[tag] = count
+          end
+
+          pdf.font_size 14
+          pdf.text "<b><color rgb='3a5b93'>" + g[:feature][:keyword] + '</color></b> ' + g[:feature][:name], inline_format: true, style: :bold
+          pdf.font_size 12
+
+          pdf.bounding_box([10, pdf.cursor], width: pdf.bounds.right) do
+            pdf.text g[:feature][:description]
+
+            g[:feature][:children].each_with_index do |scenario, sid|
+              pdf.move_down 10
+
+              pdf.add_dest "Scenario #{fid} #{sid}", pdf.dest_xyz(pdf.bounds.absolute_left, pdf.y)
+
+              if scenario[:tags]
+                scenario_tags = scenario[:tags].map { |tag| tag[:name] }
+                pdf.text(scenario_tags.join(' '), color: '00695c')
+                scenario_tags.each do |tag|
+                  count = scenario[:examples] ? scenario[:examples].map { |e| e[:tableBody] }.flatten.size : 1
+                  tags[tag] ? tags[tag] += count : tags[tag] = count
+                end
+              end
+
+              pdf.text "<b><color rgb='3a5b93'>" + scenario[:keyword] + '</color></b> ' + scenario[:name], inline_format: true
+
+              scenario[:steps].each do |step|
+                pdf.bounding_box([10, pdf.cursor], width: pdf.bounds.right) do
+                  pdf.text "<b><color rgb='3a5b93'>" + step[:keyword] + '</color></b> ' + step[:text].gsub('<', "<color rgb='558b2f'>").gsub('>', '</color>'), inline_format: true
+
+                  if step[:argument]
+                    pdf.bounding_box([10, pdf.cursor], width: pdf.bounds.right) do
+                      step[:argument][:rows].each do |row|
+                        pdf.text('| ' + row[:cells].map { |cell| cell[:value] }.join(' | ') + ' |')
+                      end
+                    end
+                  end
+                end
+              end
+              next unless scenario[:examples]
+              scenario[:examples].each do |example|
+                pdf.text example[:keyword], color: '3a5b93', style: :bold
+
+                pdf.bounding_box([10, pdf.cursor], width: pdf.bounds.right) do
+                  pdf.text('| ' + example[:tableHeader][:cells].map { |cell| cell[:value] }.join(' | ') + ' |', style: :bold, color: '558b2f')
+                  example[:tableBody].each do |row|
+                    pdf.text('| ' + row[:cells].map { |cell| cell[:value] }.join(' | ') + ' |')
+                  end
+                end
+              end
+            end
+          end
+        end
+        pdf.start_new_page
+
+        pdf.font_size 20
+        pdf.text 'Tags', color: '3a5b93', stylr: :bold
+        pdf.move_down 10
+
+        pdf.font_size 12
+        tags.each do |tag, count|
+          pdf.text "<b>#{tag} : </b>#{count}", inline_format: true
+        end
+      end
+    end
+  end
+end

data/template/footer.erb

@@ -34,4 +34,4 @@
     });
 </script>
 
-<script type="text/javascript" src="https://cdn.rawgit.com/rajatthareja/FlavoredGherkin/4e2eb7d0c725b45eac6647de07d01403287771f7/js/flavored.gherkin.min.js"></script>
+<script type="text/javascript" src="https://cdn.rawgit.com/rajatthareja/FlavoredGherkin/v0.1/js/flavored.gherkin.min.js"></script>

data/template/head.erb

@@ -8,5 +8,5 @@
   <link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
   <link href="https://cdn.datatables.net/1.10.16/css/jquery.dataTables.min.css" rel="stylesheet">
   <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/materialize/0.100.2/css/materialize.min.css" media="screen,projection"/>
-  <link href="https://cdn.rawgit.com/rajatthareja/FlavoredGherkin/4e2eb7d0c725b45eac6647de07d01403287771f7/css/flavored.gherkin.min.css" rel="stylesheet">
+  <link href="https://cdn.rawgit.com/rajatthareja/FlavoredGherkin/v0.1/css/flavored.gherkin.min.css" rel="stylesheet">
 </head>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flavored_gherkin
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.3'
 platform: ruby
 authors:
 - Rajat Thareja
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2018-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,7 +66,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: ''
+description: Ruby gem to convert gherkin feature files into html and pdf flavour.
 email: rajat.thareja.1990@gmail.com
 executables:
 - flavored_gherkin
@@ -66,6 +80,7 @@ files:
 - lib/flavored_gherkin.rb
 - lib/flavored_gherkin/flavour.rb
 - lib/flavored_gherkin/html_flavour.rb
+- lib/flavored_gherkin/pdf_flavour.rb
 - template/background.erb
 - template/feature.erb
 - template/footer.erb
@@ -80,7 +95,7 @@ homepage: http://flavoredgherkin.rajatthareja.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: More flavours coming soon!
 rdoc_options: []
 require_paths:
 - lib
@@ -88,7 +103,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.1
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -99,5 +114,5 @@ rubyforge_project:
 rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
-summary: Ruby gem to convert gherkin feature files into html flavour.
+summary: FlavoredGherkin
 test_files: []