rspec_table_formatter 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94b51d726c20d5cfbf82f5b5571478d952020bfe610646392785c0ca6035d4a3
-  data.tar.gz: 0abd12e21a4e9762c22c79a7d6d37e2ab7be2a4706a17c696f7ae7008646d81f
+  metadata.gz: 426fd4e25e8d1ab26edf8352bd0e41c5cf00a828d4f85402e79af8f9c0c35f52
+  data.tar.gz: b289d69ab7ff91c1d95fa87f203f28191d3bdaa60ce07903cad03b5c85c8c30a
 SHA512:
-  metadata.gz: 52a6f106be0bf557c3fa12f3e2aaa1989fe601fefc2f55f0963ab135f1079cf8a2f218bc7cea52c63fa904f74931dfe479ecd289700adcfc18b438127c832d5b
-  data.tar.gz: 10122b23103422f2b33cb4755f0b1ef7c4dd23a50f25cd2b7fa50782bebad8cfc255b348c908ede7fcfa568b3cbfd0e3914fd1f1c03d93c1052e373b94c43d42
+  metadata.gz: '053811037ae1d12a747402f474f790f43351588bdb0ee26d28bb024dadf8c18cda14dcb1bc4f5302efa976b14e37745d435e3430eb9f5faea497947c4b9146a4'
+  data.tar.gz: '094ebce9f66d254a454407929630977ef9eb3f758f415871ef5b0e066e652b7dcc8578104d1284179e9f0a6ddc97f81d9be9f797f6a0f51c4de405aff43d3a12'

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    rspec_table_formatter (0.1.9)
+    rspec_table_formatter (0.1.11)
+      terminal-table (~> 3.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,9 +1,6 @@
 # RspecTableFormatter
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec_table_formatter`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-
-I have created this gem to be used specifially confluvance, it might not work on other tableformaters 
+`RspecTableFormatter` is a customizable formatter for displaying RSpec test results in a table format with customizable headers, messages, and styles.
 
 ## Installation
 
@@ -23,7 +20,56 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+So to use the formatter 
+
+```
+rspec --format RspecTableFormatter
+```
+
+or if always want the formatter to be used, add the following to end of your `.rspec` file
+
+```
+--format RspecTableFormatter
+```
+
+## Configuration
+
+You can configure `RspecTableFormatter` to display custom messages and headers for your test results. You can also set the table style using a hash.
+
+To configure the formatter, use the `configure` method and pass in a block. In the block, you can customize the following options:
+
+- `passed_message`: The message displayed for passed tests.
+- `failed_message`: The message displayed for failed tests.
+- `pending_message`: The message displayed for pending tests.
+- `test_case_header`: The header for the test case column.
+- `expected_result_header`: The header for the expected result column.
+- `status_header`: The header for the status column.
+- `table_style`: A hash defining the table style.
+
+### Example:
+
+```ruby
+# Configuration example
+RspecTableFormatter.configure do |config|
+  # Customize status messages
+  config.passed_message = '✔️  Test Passed'
+  config.failed_message = '❌ Test Failed'
+  config.pending_message = '⚠️ Test Pending'
+
+  # Customize table headers
+  config.test_case_header = 'Test Description'
+  config.expected_result_header = 'Expected Outcome'
+  config.status_header = 'Test Status'
+
+  # Customize table style
+  config.table_style = { border_left: true, border_right: true, border: :ascii }
+end
+```
+
+#### Table Style
+We use [terminal-table](https://github.com/tj/terminal-table) to render the table. 
+Any of the styles supported by `terminal-table` can be used.
+
 
 ## Development
 
@@ -42,4 +88,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the RspecTableFormatter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rspec_table_formatter/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RspecTableFormatter project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nijeesh4all/rspec_table_formatter/blob/master/CODE_OF_CONDUCT.md).

data/lib/rspec_table_formatter/configuration.rb

@@ -0,0 +1,27 @@
+module RspecTableFormatter
+  class Configurations
+
+    attr_accessor :passed_message, :failed_message, :pending_message,
+                  :test_case_header, :expected_result_header, :status_header,
+                  :table_style
+
+    def initialize
+      # messages to be displayed in the status column
+      @passed_message = '✔️  Passed'
+      @failed_message = '❌ Failed'
+      @pending_message = '⚠️ Test case pending'
+
+      # headers for the table
+      @test_case_header = 'Test Case'
+      @expected_result_header = 'Expected result'
+      @status_header = 'Status'
+
+      # table style
+      @table_style = { border_left: false, border_right: false, border: :markdown }
+    end
+
+    def headers
+      [@test_case_header, @expected_result_header, @status_header]
+    end
+  end
+end

data/lib/rspec_table_formatter/version.rb

@@ -2,6 +2,6 @@
 
 class RspecTableFormatter
   module Version
-    VERSION = '0.1.9'
+    VERSION = '0.1.11'
   end
 end

data/lib/rspec_table_formatter.rb

@@ -7,6 +7,8 @@ require_relative './table_builder'
 class RspecTableFormatter
   class Error < StandardError; end
 
+  @configs = Configurations.new
+
   RSpec::Core::Formatters.register self, :dump_summary
 
   def initialize(output)
@@ -15,6 +17,12 @@ class RspecTableFormatter
 
   def dump_summary(notification)
     examples = notification.examples
-    @output << TableBuilder.new(examples).generate_table.to_s + "\n"
+    @output << TableBuilder.new(examples, @configs).generate_table.to_s + "\n"
+  end
+
+  class << self
+    def configure
+      yield @configs if block_given?
+    end
   end
 end

data/lib/table_builder.rb

@@ -4,15 +4,16 @@ require 'terminal-table'
 
 # converts the examples array to a table string
 class TableBuilder
-  def initialize(examples)
+  def initialize(examples, configs)
     @examples = examples
+    @configs = configs
   end
 
   def generate_table
     Terminal::Table.new do |t|
-      t.headings = ['Test Case', 'Expected result', 'status']
+      t.headings = @configs.headers
       t.rows = map_examples(@examples)
-      t.style = { border_left: false, border_right: false, border: :markdown }
+      t.style = @configs.table_style
     end
   end
 
@@ -31,14 +32,13 @@ class TableBuilder
   end
 
   def execution_status(example)
-    puts example.execution_result.status
     case example.execution_result.status
     when :passed
-      '✔️  Passed'
+      @configs.passed_message
     when :failed
-      '❌ Failed'
+      @configs.failed_message
     when :pending
-      '⚠️ Test case pending'
+      @configs.pending_message
     else
       ''
     end

data/rspec_table_formatter.gemspec

@@ -27,4 +27,8 @@ Gem::Specification.new do |spec|
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
+
+
+  # dependencies
+  spec.add_dependency 'terminal-table', '~>3.0.2'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: rspec_table_formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Nijeesh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-07 00:00:00.000000000 Z
-dependencies: []
+date: 2024-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.2
 description: a simple gem to output the rspec run summery in markdown table formatso
   you can copy paste the content to any documentation of your choice
 email:
@@ -36,6 +50,7 @@ files:
 - bin/console
 - bin/setup
 - lib/rspec_table_formatter.rb
+- lib/rspec_table_formatter/configuration.rb
 - lib/rspec_table_formatter/version.rb
 - lib/table_builder.rb
 - rspec_table_formatter.gemspec