cucumberhtml 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f3ffe9eb3e7f52c8e521f4bed6a7a9093fb5f3da96143730810f40dc8b429552
+  data.tar.gz: 7711e792161c894f6979618d7be656040480a5a866278a3e6da9038ee79d2e27
+SHA512:
+  metadata.gz: 3a8b58f48b2b2ba4175212261c61cff3077ec37fd52b3250f1716b2d011d874f6fcbb8fe2e338cc8a1884b0450629db18c263c288da2a6a00989cdbe67f9d407
+  data.tar.gz: 37b1536738eb16fa4d46960a023aa14cf02250159495ee83a383c5144d974a90ef26aeca2929fc332d67d35a753ff22772ac856a56a0f428b2060e408fae9fb5

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Erik Axel Nielsen
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,36 @@
+# Cucumberhtml
+Create nice HTML from cucumber result JSON. As a controller (for test/dev) and a rake task.
+
+## Usage
+Mount the controller
+```ruby
+mount Cucumberhtml::Engine, at: '/cucumber' unless Rails.env.production?
+```
+It will by default read results from `tmp/cucumber_result.json`
+
+```ruby
+rake cucumberhtml:export[tmp/cucumber_result.json, tmp/cucumber_result2.html]
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cucumberhtml', group :development, :test 
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install cucumberhtml
+```
+
+## Contributing
+PR are welcome
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cucumberhtml'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+# load 'rails/tasks/engine.rake'
+
+# load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/concepts/cucumber_to_html/cell/element.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CucumberToHtml::Cell
+  class Element < Cucumberhtml::Cell
+    def name
+      model['name']
+    end
+
+    def keyword
+      model['keyword']
+    end
+
+    def steps
+      model['steps']
+    end
+
+    def step(step)
+      Step.call(step).call
+    end
+  end
+end

data/app/concepts/cucumber_to_html/cell/feature.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module CucumberToHtml::Cell
+  class Feature < Cucumberhtml::Cell
+    def feature
+      model
+    end
+
+    def feature_menu_item
+      render :feature_menu_item
+    end
+
+    def active
+      options[:active]
+    end
+
+    def feature_classes
+      'show active' if active
+    end
+
+    def menu_classes
+      "list-group-item list-group-item-action #{'active' if active}"
+    end
+
+    def feature_id
+      "list-#{model['id']}"
+    end
+
+    def name
+      model['name']
+    end
+
+    def description
+      Kramdown::Document.new(model['description']).to_html
+    end
+
+    def element_list
+      model['elements']
+    end
+
+    def element(element)
+      case element['keyword']
+      when 'Scenario'
+        Scenario.call(element).call
+      when 'Background'
+        Element.call(element).call if element == element_list[0]
+      else
+        raise 'Unknown element'
+      end
+    end
+  end
+end

data/app/concepts/cucumber_to_html/cell/gherkin.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module CucumberToHtml::Cell
+  class Gherkin < Cucumberhtml::Cell
+    def feature_menu_list
+      res = '<div class="list-group" id="list-tab" role="tablist">'
+      model.each_with_index do |feature, index|
+        res += Feature.call(feature, active: index == 0).call(:feature_menu_item)
+      end
+      res + '</div>'
+    end
+
+    def feature_list
+      res = '<div class="tab-content" id="nav-tabContent">'
+      model.each_with_index do |feature, index|
+        res += Feature.call(feature, active: index == 0).call
+      end
+      res + '</div>'
+    end
+  end
+end

data/app/concepts/cucumber_to_html/cell/scenario.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module CucumberToHtml::Cell
+  class Scenario < Element
+    # class     CucumberToHtml::Cell::Scenario < Element
+    def success?
+      model['steps'].all? do |step|
+        step.dig('result', 'status') == 'passed'
+      end
+        end
+
+    def failure?
+      false # TBD
+    end
+
+    def border_classes
+      if success?
+        'border-success'
+      elsif failure?
+        'border-danger'
+      end
+    end
+
+    def body_classes
+      if success?
+        'text-success'
+      elsif failure?
+        'text-danger'
+      end
+    end
+  end
+end

data/app/concepts/cucumber_to_html/cell/step.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+class CucumberToHtml::Cell::Step < Cucumberhtml::Cell
+  def keyword
+    model['keyword']
+  end
+
+  def name
+    model['name']
+  end
+
+  def success?
+    model['result']['status'] == 'passed'
+  end
+
+  def text_classes
+    # Difficult to read
+    # 'text-success' if success?
+  end
+
+  # Others are line, match, duration
+end

data/app/concepts/cucumber_to_html/view/element.slim

@@ -0,0 +1,4 @@
+strong = keyword
+ul
+  - steps.each do |step|
+    = step(step)

data/app/concepts/cucumber_to_html/view/feature.slim

@@ -0,0 +1,6 @@
+.tab-pane.fade class="#{feature_classes}" id="#{feature_id}" role="tabpanel" aria-labelledby="#{feature_id}-list"
+  h2 = name
+  = description
+  - element_list.each do |element|
+    = element(element)
+

data/app/concepts/cucumber_to_html/view/feature_menu_item.slim

@@ -0,0 +1,2 @@
+a class="#{menu_classes}" id="#{feature_id}-list" data-toggle="list" href="##{feature_id}" role='tab' aria-controls='#{feature_id}'
+  = name

data/app/concepts/cucumber_to_html/view/gherkin.slim

@@ -0,0 +1,17 @@
+html
+  head
+    meta charset="utf-8"
+    meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"
+    link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta.3/css/bootstrap.min.css" integrity="sha384-Zug+QiDoJOrZ5t4lssLdxGhVrurbmBWopoEl+M6BdEfwnCJZtKxi1KgxUyJq13dy" crossorigin="anonymous"
+    script src="https://code.jquery.com/jquery-3.2.1.slim.min.js" integrity="sha384-KJ3o2DKtIkvYIK3UENzmM7KCkRr/rE9/Qpg6aAZGJwFDMVNA/GpGFF93hXpG5KkN" crossorigin="anonymous"
+    script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.12.9/umd/popper.min.js" integrity="sha384-ApNbgh9B+Y1QKtv3Rn7W3mgPxhU9K/ScQsAP7hUibX39j7fakFPskvXusvfa0b4Q" crossorigin="anonymous"
+    script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-beta.3/js/bootstrap.min.js" integrity="sha384-a5N7Y/aK3qNeh15eJKGWxsqtnX/wWdSZSKp+81YjTmS15nvnvxKHuzaWwXHDli+4" crossorigin="anonymous"
+    title Stories
+  body
+    .container
+      h1 Stories
+      .row
+        .col-3
+          = feature_menu_list
+        .col-9
+          = feature_list

data/app/concepts/cucumber_to_html/view/scenario.slim

@@ -0,0 +1,7 @@
+.card.mb-3 class=border_classes
+  .card-body
+    /h5.card-title = "Scenario: #{name}"
+    h5.card-title = name
+    p.card-text
+      - steps.each do |step|
+        = step(step)

data/app/concepts/cucumber_to_html/view/step.slim

@@ -0,0 +1,3 @@
+li class=text_classes
+  strong = keyword
+  = name

data/app/controllers/cucumberhtml/application_controller.rb

@@ -0,0 +1,5 @@
+module Cucumberhtml
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/controllers/cucumberhtml/cucumber_to_html_controller.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Cucumberhtml
+  class CucumberToHtmlController < ApplicationController
+    def index
+      file = File.read('tmp/cucumber_result.json')
+      json = JSON.parse(file)
+      render html: CucumberToHtml::Cell::Gherkin.call(json)
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Cucumberhtml::Engine.routes.draw do
+  get 'index', to: 'cucumber_to_html#index'
+end

data/lib/cucumberhtml/cell.rb

@@ -0,0 +1,6 @@
+module Cucumberhtml
+  class Cell < Trailblazer::Cell # Cell::Concept
+    # raise Cucumberhtml::Engine.root.inspect
+    self.view_paths = ["#{Cucumberhtml::Engine.root}/app/concepts/"]
+  end
+end

data/lib/cucumberhtml/engine.rb

@@ -0,0 +1,5 @@
+module Cucumberhtml
+  class Engine < ::Rails::Engine
+    isolate_namespace Cucumberhtml
+  end
+end

data/lib/cucumberhtml/version.rb

@@ -0,0 +1,3 @@
+module Cucumberhtml
+  VERSION = '0.1.1'.freeze
+end

data/lib/cucumberhtml.rb

@@ -0,0 +1,8 @@
+require 'cucumberhtml/engine'
+require 'cucumberhtml/cell'
+# require_relative '../app/concepts/cucumber_to_html/cell/gherkin'
+# require 'app/concepts/cucumber_to_html/cell/gherkin'
+
+module Cucumberhtml
+  # Your code goes here...
+end

data/lib/tasks/cucumberhtml_tasks.rake

@@ -0,0 +1,35 @@
+module CucumberToHtml
+end
+
+require 'cells-rails'
+
+require_relative '../../app/concepts/cucumber_to_html/cell/gherkin'
+
+
+namespace :cucumberhtml do
+  task :export, [:filename, :outfile] => :environment do |_t, args|
+    desc 'Exporting cucumber html'
+    filename = args[:filename] || 'tmp/cucumber_result.json'
+    outfile = args[:outfile] || 'tmp/cucumber_result.html'
+
+    file = File.read(filename)
+    json = JSON.parse(file)
+    html = CucumberToHtml::Cell::Gherkin.call(json)
+    open(outfile, 'w') do |f|
+      f << html
+    end
+  end
+
+  # task export3: :environment, :filename do |_t, args|
+  #   desc 'Exporting cucumber html'
+  #   filename ='tmp/cucumber_result.json'
+  #   outfile = 'tmp/cucumber_result.html'
+  #
+  #   file = File.read(filename)
+  #   json = JSON.parse(file)
+  #   html = CucumberToHtml::Cell::Gherkin.call(json)
+  #   open(outfile, 'w') do |f|
+  #     f << html
+  #   end
+  # end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: cucumberhtml
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Erik Axel Nielsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cells-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: cells-slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: trailblazer-cells
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Cucumber to HTML converter.
+email:
+- erikaxel@lucalabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/concepts/cucumber_to_html/cell/element.rb
+- app/concepts/cucumber_to_html/cell/feature.rb
+- app/concepts/cucumber_to_html/cell/gherkin.rb
+- app/concepts/cucumber_to_html/cell/scenario.rb
+- app/concepts/cucumber_to_html/cell/step.rb
+- app/concepts/cucumber_to_html/view/element.slim
+- app/concepts/cucumber_to_html/view/feature.slim
+- app/concepts/cucumber_to_html/view/feature_menu_item.slim
+- app/concepts/cucumber_to_html/view/gherkin.slim
+- app/concepts/cucumber_to_html/view/scenario.slim
+- app/concepts/cucumber_to_html/view/step.slim
+- app/controllers/cucumberhtml/application_controller.rb
+- app/controllers/cucumberhtml/cucumber_to_html_controller.rb
+- config/routes.rb
+- lib/cucumberhtml.rb
+- lib/cucumberhtml/cell.rb
+- lib/cucumberhtml/engine.rb
+- lib/cucumberhtml/version.rb
+- lib/tasks/cucumberhtml_tasks.rake
+homepage: https://www.github.com/lucalabs/cucumberhtml
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Cucumber to HTML converter.
+test_files: []