{"id":13721539,"url":"https://github.com/rajatthareja/ReportBuilder","last_synced_at":"2025-05-07T13:33:16.516Z","repository":{"id":3626664,"uuid":"50345777","full_name":"rajatthareja/ReportBuilder","owner":"rajatthareja","description":"Ruby gem to merge Cucumber JSON reports and build mobile-friendly HTML Test Report, JSON report and retry file.","archived":false,"fork":false,"pushed_at":"2023-11-30T18:42:06.000Z","size":15394,"stargazers_count":81,"open_issues_count":18,"forks_count":47,"subscribers_count":17,"default_branch":"master","last_synced_at":"2024-10-20T06:25:34.513Z","etag":null,"topics":["cucumber-reports","rubygem"],"latest_commit_sha":null,"homepage":"https://reportbuilder.rajatthareja.com","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rajatthareja.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-01-25T11:16:54.000Z","updated_at":"2023-09-05T08:41:38.000Z","dependencies_parsed_at":"2024-01-06T01:07:27.160Z","dependency_job_id":null,"html_url":"https://github.com/rajatthareja/ReportBuilder","commit_stats":{"total_commits":256,"total_committers":24,"mean_commits":"10.666666666666666","dds":0.50390625,"last_synced_commit":"57fdd658f9127a173b07c80f7d4418c9e151fe36"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rajatthareja%2FReportBuilder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rajatthareja%2FReportBuilder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rajatthareja%2FReportBuilder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rajatthareja%2FReportBuilder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rajatthareja","download_url":"https://codeload.github.com/rajatthareja/ReportBuilder/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224605026,"owners_count":17339248,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cucumber-reports","rubygem"],"created_at":"2024-08-03T01:01:18.366Z","updated_at":"2024-11-14T10:31:44.715Z","avatar_url":"https://github.com/rajatthareja.png","language":"HTML","funding_links":[],"categories":["Tools, Libraries \u0026 Frameworks","Tools"],"sub_categories":["Ruby"],"readme":"# ReportBuilder\n\n[![Gem Version](https://img.shields.io/gem/v/report_builder.svg)](https://badge.fury.io/rb/report_builder)\n[![Build status](https://github.com/rajatthareja/ReportBuilder/actions/workflows/ci.yml/badge.svg)](https://github.com/rajatthareja/ReportBuilder/actions/workflows/ci.yml)\n[![Join the chat at https://gitter.im/rajatthareja/ReportBuilder](https://badges.gitter.im/rajatthareja/ReportBuilder.svg)](https://gitter.im/rajatthareja/ReportBuilder?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\nRuby gem to merge Cucumber JSON reports and build mobile-friendly HTML Test Report, JSON report and retry file.\n\n## Sample Reports\n\n**[Features Report](https://reportbuilder.rajatthareja.com/sample/report.html)**\n\n**[Grouped Features Report](https://reportbuilder.rajatthareja.com/sample/group_report.html)**\n\n## Installation\n\n```bash\n\ngem install report_builder\n\n```\n\n## Information\n\n* RDoc documentation [available on RubyDoc.info](http://www.rubydoc.info/gems/report_builder)\n* Source code [available on GitHub](https://github.com/rajatthareja/ReportBuilder)\n\n## Usage\n\n**Note:** Works with cucumber(\u003e= 2.1.0) test results in JSON format.\n\n### Config Options:\n\n| Option               | Type                    | Default             | Values                                                                                   |\n|----------------------|-------------------------|---------------------|------------------------------------------------------------------------------------------|\n| json_path/input_path | [String]/[Array]/[Hash] | (current directory) | input json files path / array of json files or path / hash of json files or path         |\n| report_path          | [String]                | 'test_report'       | reports output file path with file name without extension                                |\n| json_report_path     | [String]                | (report_path)       | json report output file path with file name without extension                            |\n| html_report_path     | [String]                | (report_path)       | html report output file path with file name without extension                            |\n| retry_report_path    | [String]                | (report_path)       | retry report output file path with file name without extension                           |\n| report_types         | [Array]                 | [:html]             | :json, :html, :retry (output file types)                                                 |\n| report_title         | [String]                | 'Test Results'      | report and html title                                                                    |\n| include_images       | [Boolean]               | true                | true / false (If false, the size of HTML report is reduced by excluding embedded images) |\n| voice_commands       | [Boolean]               | false               | true / false (Enable voice commands for easy navigation and search)                      |\n| additional_info      | [Hash]                  | {}                  | additional info for report summary                                                       |\n| additional_css       | [String]                | nil                 | additional CSS string or CSS file path or CSS file url for customizing html report       |\n| additional_js        | [String]                | nil                 | additional JS string or JS file path or JS file url for customizing html report          |\n| color                | [String]                | brown               | report color, Ex: indigo, cyan, purple, grey, lime etc.                                  |\n\n### Code Examples:\n\n```ruby\n\n     require 'report_builder'\n    \n    # Ex 1:\n    ReportBuilder.configure do |config|\n      config.input_path = 'results/cucumber_json'\n      config.report_path = 'my_test_report'\n      config.report_types = [:retry, :html]\n      config.report_title = 'My Test Results'\n      config.additional_info = {browser: 'Chrome', environment: 'Stage 5'}\n    end\n    \n    ReportBuilder.build_report\n    \n    # Ex 2:\n    ReportBuilder.input_path = 'results/cucumber_json'\n    ReportBuilder.report_path = 'my_test_report'\n    ReportBuilder.report_types = [:retry, :html]\n    ReportBuilder.report_title = 'My Test Results'\n    ReportBuilder.additional_info = {Browser: 'Chrome', Environment: 'Stage 5'}\n    \n    ReportBuilder.build_report\n    \n    # Ex 3:\n    options = {\n       input_path: 'results/cucumber_json',\n       report_path: 'my_test_report',\n       report_types: ['retry', 'html'],\n       report_title: 'My Test Results',\n       additional_info: {'Browser' =\u003e 'Chrome', 'Environment' =\u003e 'Stage 5'}\n     }\n    \n    ReportBuilder.build_report options\n    \n    # Ex 4:\n    ReportBuilder.input_path = 'results/cucumber_json'\n    \n    ReportBuilder.configure do |config|\n      config.report_path = 'my_test_report'\n      config.report_types = [:json, :html]\n    end\n    \n   options = {\n       report_title: 'My Test Results'\n   }\n   \n   ReportBuilder.build_report options\n        \n```\n\n### Grouped Features Report Example:\n\n```ruby\n\nReportBuilder.configure do |config|\n     config.input_path = {\n      'Group A' =\u003e ['path/of/json/files/dir1', 'path/of/json/files/dir2'],\n      'Group B' =\u003e ['path/of/json/file1', 'path/of/json/file2'],\n      'Group C' =\u003e 'path/of/json/files/dir'}\n  end\n\nReportBuilder.build_report\n\n```\n\n\n### CLI Options:\n\n| Option                | Values       | Explanation                                                                        |\n|-----------------------|--------------|------------------------------------------------------------------------------------|\n| -s, --source          | x,y,z        | List of input json path or files                                                   |\n| -o, --out             | [PATH]NAME   | Reports path with name without extension                                           |\n| --json_out            | [PATH]NAME   | JSON report path with name without extension                                       |\n| --html_out            | [PATH]NAME   | HTML report path with name without extension                                       |\n| --retry_out           | [PATH]NAME   | Retry report path with name without extension                                      |\n| -f, --format          | x,y,z        | List of report format - html,json,retry                                            |\n| --[no-]images         |              | Reduce HTML report size by excluding embedded images                               |\n| -T, --title           | TITLE        | Report title                                                                       |\n| -c, --color           | COLOR        | Report color                                                                       |\n| -I, --info            | a:x,b:y,c:z  | List of additional info about test - key:value                                     |\n| --css                 | CSS/PATH/URL | Additional CSS string or CSS file path or CSS file url for customizing html report |\n| --js                  | JS/PATH/URL  | Additional JS string or JS file path or JS file url for customizing html report    |\n| -vc, --voice_commands |              | Enable voice commands for easy navigation and search                               |\n| -h, --help            |              | Show available command line switches                                               |\n| -v, --version         |              | Show gem version                                                                   |\n\n### CLI Example:\n\n```bash\n\n     report_builder\n     report_builder -s 'path/of/json/files/dir'\n     report_builder -s 'path/of/json/files/dir' -o my_report_file\n\n```\n\n### Hook Example:\n\n```ruby\n\nrequire 'report_builder'\n    \nat_exit do\n  ReportBuilder.configure do |config|\n    config.input_path = 'results/cucumber_json'\n    config.report_path = 'results/report'\n  end\n  ReportBuilder.build_report\nend\n\n```\n\n### Voice Commands:\nUse voice commands for easy navigation and search\n* show ( overview, features, summary, errors )\n* search { Keywords }\n\n## Report Builder Java API\n[Report Builder Java](https://reportbuilderjava.rajatthareja.com)\n\n## Contributing\n\nWe're open to any contribution. It has to be tested properly though.\n\n## License\n\nCopyright (c) 2017 [MIT LICENSE](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frajatthareja%2FReportBuilder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frajatthareja%2FReportBuilder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frajatthareja%2FReportBuilder/lists"}