lucid_report 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aa9d8e9b26a342c29d64109680a749b2c86e223f
+  data.tar.gz: 893596e437c5f5ba9540f80b7dd36457efa58f35
+SHA512:
+  metadata.gz: 09cd4d00781c9e2ecb162a55c099d8179c4b7133263b16f9ea2defc432d7bc975d054411a287b546361b65130e732cd1ee147139590784a1079b8ede9d064151
+  data.tar.gz: 85513632312f555ad2208d527e8672768dd5fff1d7d28946ebde44fec410482a7198cf5d92d0f0ae3dc799b584a88809e5979ade83c7da60bebed24d1bec600b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jeff.nyman@sproutsocial.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lucid_report.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jeff Nyman
+
+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,199 @@
+# LucidReport
+
+Lucid Report allows you to merge Cucumber JSON reports in order to build a unified execution report. This works with Cucumber versions of 2.x and up with results generated in the JSON format.
+
+## Installation
+
+To get the latest stable release, add this line to your application's Gemfile:
+
+```ruby
+gem 'lucid_report'
+```
+
+To get the latest code:
+
+```ruby
+gem 'lucid_report', git: 'https://github.com/jeffnyman/lucid_report'
+```
+
+After doing one of the above, execute the following command:
+
+    $ bundle
+
+You can also install Lucid Report just as you would any other gem:
+
+    $ gem install lucid_report
+
+## Usage
+
+You can configure Lucid Report directly from an instance of the class.
+
+```ruby
+require 'report_builder'
+
+LucidReport.configure do |config|
+  config.json_path = 'results'
+  config.report_path = 'execution'
+  config.report_types = [:json, :html]
+  config.report_tabs = [:overview, :features, :scenarios, :errors]
+  config.report_title = 'Test Execution Rport'
+  config.compress_images = true
+  config.additional_info = {browser: 'chrome', environment: 'staging'}
+end
+
+LucidReport.build_report
+```
+
+You can also create your own options hash and pass that in to Lucid Report:
+
+```ruby
+options = {
+   json_path: 'results',
+   report_path: 'execution',
+   report_types: ['json', 'html'],
+   report_tabs:  [ 'overview', 'features', 'scenarios', 'errors'],
+   report_title: 'Test Execution Report',
+   compress_images: true,
+   additional_info: {'browser' => 'chrome', 'environment' => 'staging'}
+ }
+
+LucidReport.build_report(options)
+```
+
+### Rake Task
+
+This is an experimental part of Lucid Report. You can add in a Rake task that Lucid Report provides:
+
+
+```ruby
+require 'lucid_report'
+
+load 'lucid_report.rake'
+```
+
+Then run rake task `lucid_report` as in these examples:
+
+```bash
+rake lucid_report
+rake lucid_report['results']
+rake lucid_report['results', 'lucid-report']
+```
+
+The first command would use all of the default options. The second command provides the location where the JSON files are. The third command provides the JSON location as well as the file name of the report you want to generate.
+
+### Options
+
+There are a few options you can use to configure the execution of Lucid Report. To see these at the command line, just do this:
+
+```bash
+lucid_report -h
+```
+
+#### Parsing JSON
+
+Lucid Report is designed to take JSON output from Cucumber. Thus it needs to know where to find those files. You can do this by using the `-s` (or `source`) switch to provide a directory where the JSON files are. The default will be the current directory. For example:
+
+```bash
+lucid_report -s 'results'
+```
+
+This would look for any JSON files in the `results` directory. If you wanted to run Lucid Report from within the `results` directory, you could just do this:
+
+```bash
+lucid_report
+```
+
+Within Lucid Report, the value of the source location is referred to as `json_path` and is either a string or an array. This means you can provide multiple locations or multiple files for the JSON parsing.
+
+#### Output
+
+You can specify where you want the output to be generated. You do this by using the `-o` (or `--out`) switch to provide a file path and a name. Note that the file name you provide should not have an extension.
+
+```bash
+lucid_report -s 'results' -o execution-results
+```
+
+This command would look for JSON files in a `results` directory and then write its output in whatever the current directory is and call the file `execution-results.html`.
+
+If you don't specify a path or file, a default of `lucid-report.html` will be generated.
+
+Within Lucid Report, the value of the output location is referred to as `report_path` and is a string.
+
+#### Report Format
+
+You can specify the type of format that you want by using the `-f` (or `--format`). This lets you indicate the type of output file you want to build. The default is HTML but you can also specify JSON, which is currently the only other report type supported. You can also specify that you want both types generated.
+
+```bash
+lucid_report -s 'results' -f json
+```
+
+Within Lucid Report, the value of the report type is referred to as `report_types` and is an array holding the types to build. This can be an array of symbols ([:json, :html]) or an array of strings (['html', 'json']).
+
+#### Report Tabs
+
+You can specify the tabs you want to appear on your report by using the `-t` (or `--tabs`). By default Lucid Report will generate an overview tab and a features tab. You can specify others. The options are currently 'overview', 'features', 'scenarios', 'errors'.
+
+```bash
+lucid_report -s 'results' -t overview,features,scenarios,errors
+```
+
+Within Lucid Report, the value of the report tabs is referred to as `report_tabs` and is an array that holds the tab names you want generated. This acn be an array of symbols ([:overview, :features, :scenarios, :errors]) or an array of strings (['overview', 'features', 'scenarios', 'errors']).
+
+#### Image Compression
+
+Since test executions can include embedded images, you can specify whether those images should be compressed by using the `-c` (or `--compress`) switch.
+
+```bash
+lucid_report -s 'results' -c true
+```
+
+You set this value to true to reduce the size of HTML report by compressing any embedded images. Within Lucid Report, this value is referred to as `compress_images` and is a boolean.
+
+#### Report Title
+
+You can specify the title of the report using the `-T` (or `--title`) switch. By default this title will be "Lucid Results".
+
+```bash
+lucid_report -s 'results' -T 'Test Report'
+```
+
+Within Lucid Report, the value of the title is referred to as `report_title` and is a string.
+
+#### Additional Report Information
+
+You can specify additional information that you want generated as part of the report. You can do this using the `-I` (or `--info`) switch. This must be a key, value bit of information and you can include multiple such key, value pairs.
+
+```bash
+lucid_report -s 'results' -I "browser: 'chrome', environment: 'staging"
+```
+
+Within Lucid Report, the value of the additional information is stored in `additional_info` and is a hash.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/jeffnyman/lucid_report](https://github.com/jeffnyman/lucid_report). The testing ecosystem of Ruby is very large and this project is intended to be a welcoming arena for collaboration on yet another test-supporting tool. As such, contributors are very much welcome but are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+The Lucid Report gem follows [semantic versioning](http://semver.org).
+
+To contribute to Lucid Report:
+
+1. [Fork the project](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
+2. Create your feature branch. (`git checkout -b my-new-feature`)
+3. Commit your changes. (`git commit -am 'new feature'`)
+4. Push the branch. (`git push origin my-new-feature`)
+5. Create a new [pull request](https://help.github.com/articles/using-pull-requests).
+
+## Author
+
+* [Jeff Nyman](http://testerstories.com)
+
+## License
+
+Lucid Report is distributed under the [MIT](http://www.opensource.org/licenses/MIT) license.
+See the [LICENSE](https://github.com/jeffnyman/lucid_report/blob/master/LICENSE.md) file for details.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "lucid_report"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start
+
+# require "irb"
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/lucid_report

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+
+require "optparse"
+require "lucid_report"
+
+options = {
+  :json_path => nil,
+  :report_path => 'lucid-report',
+  :report_types => [:html],
+  :report_tabs => [:overview, :features],
+  :report_title => 'Lucid Results',
+  :compress_images => false,
+  :additional_info => {}
+}
+
+opt_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: \n     lucid_report [options]"
+  opts.separator 'Configuration options:'
+
+  opts.on('-s','--source x,y,z', Array, 'List of json path or files') do |list|
+    options[:json_path] = list
+  end
+
+  opts.on('-o', '--out [PATH]NAME', String, 'Report path with name without extension') do |report_path|
+    options[:report_path] = report_path
+  end
+
+  opts.on('-f','--format x,y,z', Array, 'List of report format - html,json') do |list|
+    options[:report_types] = list
+  end
+
+  opts.on('-t','--tabs x,y,z', Array, 'List of report tabs - overview,features,scenarios,errors') do |list|
+    options[:report_tabs] = list
+  end
+
+  opts.on('-c', '--compress', 'Reduce report size if embedding images') do |compress|
+    options[:compress_images] = compress
+  end
+
+  opts.on('-T', '--title TITLE', String, 'Report title') do |report_title|
+    options[:report_title] = report_title
+  end
+
+  opts.on('-I','--info a:x,b:y,c:z', Array, 'List of additional info') do |list|
+    list.each do |i|
+      key, value = i.split(':')
+      options[:additional_info][key] = value
+    end
+  end
+
+  opts.separator 'Common options:'
+
+  opts.on_tail('-h', '--help', 'Show help') do
+    puts opts
+    exit
+  end
+
+  opts.on_tail('-v','--version', 'Show version') do
+    puts 'LucidReport v' + Gem.loaded_specs['lucid_report'].version.to_s rescue puts "Something want wrong. \nUse 'gem list lucid_report'"
+    exit
+  end
+end
+
+opt_parser.parse!(ARGV)
+
+LucidReport.build_report(options)

data/lib/lucid_report.rake

@@ -0,0 +1,6 @@
+desc 'Rake task to build a lucid report'
+task :lucid_report, [:json_path, :report_path] do |t, args|
+  args.with_defaults(:json_path => nil, :report_path => 'lucid-report')
+  options = {:json_path => args.json_path, :report_path => args.report_path}
+  LucidReport.build_report(options)
+end