rspec-axlsx-formatter 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cf35884f591642312cbe72c2f463b606ddb6c9a
-  data.tar.gz: 8b56708adbc43c36955362b0e2bc78562fad9ca8
+  metadata.gz: 0bba59518d6e5ee9421165fd3a67b2877ad5b903
+  data.tar.gz: 9e62dbf5b2c980a695cd765445d045e7b8be3cf5
 SHA512:
-  metadata.gz: 4ab87387b1aa65a642d09218693f113710f51fb13523b39b3f25dc742a014fe182326fc0dbf115af4631b3b96c4d54ef62ea36f28400e11e1a2036fa9bb29dad
-  data.tar.gz: fbb3d0d89d299dd03862a9f7182e07a0833046da61412ccbe5c172b7234cd5812a34dc4041ee0faa0367eb5948467ba02513eb6d6cf7db228489116125478fe8
+  metadata.gz: 43b18f85b51db674dcc98ce4576933131a84752d5802c43a252e36bf53457f4a21795e027badfe7cabeeb7069fe04ef2815e8f1a0e5f0b444ba84a59759172bc
+  data.tar.gz: 92c4a968577e60195dfece2f81b10be656de96639506b841884129338d05fb11bc0859e5dec7c4471a30347e8bd2b2fc8a70dfa1310c420ecf314ab3863c54c5

data/README.md

@@ -1,6 +1,6 @@
 # Rspec::Axlsx::Formatter
 
-TODO: Write a gem description
+"rspec-axlsx-formatter" is a [RSpec](http://github.com/rspec) custom formatter that uses [Axlsx](https://github.com/randym/axlsx) and generate xlsx file as spec result.
 
 ## Installation
 
@@ -18,7 +18,23 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Require the follow in your Rakefile.
+
+```
+require 'rspec/axlsx/rake/rspec'
+```
+
+And, add `axlsx:setup:rspec` at rake command.
+
+
+Example)
+
+```
+rake axlsx:setup:rspec spec
+```
+
+This usage is similar to ci_report_rspec.
+(In actuality, I use ci_report_rspec as reference.)
 
 ## Contributing
 
@@ -27,3 +43,7 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Liscense
+
+MIT

data/lib/rspec/axlsx/formatter.rb

@@ -1,18 +1,16 @@
 require "rspec/axlsx/formatter/version"
 require "rspec/core"
-#require "rspec/core/formatters/base_formatter"
 
 module Rspec
-    #class Formatter < ::RSpec::Core::Formatters::BaseFormatter
-    rspec_version = Gem::Version.new(::RSpec::Core::Version::STRING)
-    rspec_3 = Gem::Version.new('3.0.0')
-    RSPEC_3_AVAILABLE = rspec_version >= rspec_3
+  rspec_version = Gem::Version.new(::RSpec::Core::Version::STRING)
+  rspec_3 = Gem::Version.new('3.0.0')
+  RSPEC_3_AVAILABLE = rspec_version >= rspec_3
 
-    if RSPEC_3_AVAILABLE
-      require "rspec/axlsx/formatter_rspec3"
-      AxlsxFormatter = Rspec::Axlsx::FormatterRSpec3
-    else
-      require "rspec/axlsx/formatter_rspec2"
-      AxlsxFormatter = Rspec::Axlsx::FormatterRSpec2
-    end
+  if RSPEC_3_AVAILABLE
+    require "rspec/axlsx/formatter_rspec3"
+    AxlsxFormatter = Rspec::Axlsx::FormatterRSpec3
+  else
+    require "rspec/axlsx/formatter_rspec2"
+    AxlsxFormatter = Rspec::Axlsx::FormatterRSpec2
+  end
 end

data/lib/rspec/axlsx/formatter/core.rb

@@ -1,9 +1,176 @@
 require "axlsx"
+require "axlsx/package"
 
 module Rspec
   module Axlsx
     module Formatter
       class Core
+
+        ALL_IN_ONE_SHEET = 0
+
+        def initialize()
+          @p = ::Axlsx::Package.new
+          @workbook = @p.workbook
+          @report_dir = ENV["XLSX_REPORT"] || "spec/xlsx"
+
+          @example_num = 0
+
+          #@describe_column = ["Expected"]
+          @describe_column = []
+
+          @sheet_mode = ALL_IN_ONE_SHEET
+        end
+
+        def to_sheet(example_groups)
+          @example_groups = example_groups
+          convert_to_sheet do |worksheet|
+          end
+          @p.use_shared_strings = true
+          FileUtils.mkdir_p(@report_dir)
+          @p.serialize("#{@report_dir}/report.xlsx")
+        end
+
+        private
+
+        def success?(example)
+          result = example.execution_result
+          return result[:status] == "passed" if result.kind_of?(Hash) # RSpec2
+          return result.status == :passed
+        end
+
+        def has_status?(example)
+          example.respond_to?(:execution_result)
+        end
+
+        def sheet_style(worksheet)
+          worksheet.column_widths(*[nil].concat(max_example_depth.times.map{5}))
+          #worksheet.column_widths(nil, 5, 5)
+        end
+
+        def sheet_header(worksheet)
+          worksheet.add_row do |row|
+            row.add_cell('No'        , style: header_style)
+            row.add_cell('Test Case' , style: header_style)
+            max_example_depth.times{row.add_cell('', style: header_style)}
+            @describe_column.each do |c|
+              row.add_cell(c, style: header_style)
+            end
+            row.add_cell('Result'    , style: header_style)
+          end
+        end
+
+        def convert_to_sheet
+          if @sheet_mode == ALL_IN_ONE_SHEET
+            @workbook.add_worksheet do |worksheet|
+              sheet_header(worksheet)
+              @example_groups.each do |example_group|
+                add_sheet_row(worksheet, example_group)
+              end
+              sheet_style(worksheet)
+            end
+          else
+            transepose = 
+              @example_groups.inject({}) do |h, example_group|
+              h[example_group.example.file_path] ||= []
+              h[example_group.example.file_path].push(example_group)
+              h
+              end
+            transepose.each do |k, v|
+              @workbook.add_worksheet do |worksheet|
+                yield(worksheet)
+              end
+            end
+          end
+        end
+
+        def add_sheet_row(worksheet, example_group)
+          worksheet.add_row do |row|
+            if has_status?(example_group)
+              @example_num += 1
+              row.add_cell(@example_num, style: idx_column_style)
+              example_depth(example_group).times do
+                row.add_cell("", style: grey_style)
+              end
+              row.add_cell(example_group.description)
+              offset = max_example_depth - example_depth(example_group) + @describe_column.length
+              offset.times do
+                row.add_cell("")
+              end
+              if success?(example_group)
+                row.add_cell("T", style: success_style)
+              else
+                row.add_cell("F", style: failed_style)
+              end
+            else
+              row.add_cell("", style: pink_style)
+              example_depth(example_group).times do
+                row.add_cell("", style: grey_style)
+              end
+              row.add_cell(example_group.description)
+            end
+          end
+        end
+
+        def max_example_depth
+          @max_example_depth ||=
+            @example_groups.map{|e| example_depth(e)}.max
+        end
+
+        def example_depth(example)
+          if has_status?(example)
+            example.example_group.parent_groups.select{|p| p != example}.length
+          else
+            example.parent_groups.select{|p| p != example}.length
+          end
+        end
+
+        def style_hash
+          {
+            header_style: {
+              bg_color: 'F4FA58',
+              b: true,
+              border: { style: :thin, color: '666666' },
+            },
+            idx_column_style: {
+              bg_color: 'FFDD99',
+              b: true,
+              border: { style: :thin, color: '666666', edges: [:right] },
+            },
+            test_case_style: {
+            },
+            success_style: {
+              bg_color: '58FA58',
+            },
+            failed_style: {
+              bg_color: 'FE2E2E',
+            },
+            grey_space_style: {
+              bg_color: 'CCCCCC',
+            },
+            pink_space_style: {
+              bg_color: '6CEEC',
+            },
+          }
+        end
+
+        def header_style
+          @header_style ||= @workbook.styles.add_style(style_hash[:header_style])
+        end
+        def pink_style
+          @pink_style ||= @workbook.styles.add_style(style_hash[:idx_column_style].merge(style_hash[:pink_space_style]))
+        end
+        def grey_style
+          @grey_style ||= @workbook.styles.add_style(style_hash[:grey_space_style])
+        end
+        def success_style
+          @success_style ||= @workbook.styles.add_style(style_hash[:success_style])
+        end
+        def failed_style
+          @failed_style ||= @workbook.styles.add_style(style_hash[:failed_style])
+        end
+        def idx_column_style
+          @idx_column_style ||= @workbook.styles.add_style(style_hash[:idx_column_style])
+        end
       end
     end
   end

data/lib/rspec/axlsx/formatter/version.rb

@@ -1,7 +1,7 @@
 module Rspec
   module Axlsx
     module Formatter
-      VERSION = "0.0.1"
+      VERSION = "0.0.2"
     end
   end
 end

data/lib/rspec/axlsx/formatter_rspec2.rb

@@ -0,0 +1,34 @@
+require "rspec/core/formatters/base_formatter"
+require "rspec/axlsx/formatter/core"
+
+module Rspec
+  module Axlsx
+    #class Formatter < ::RSpec::Core::Formatters::BaseFormatter
+    class FormatterRSpec2 < ::RSpec::Core::Formatters::BaseFormatter
+
+      def initialize(*)
+        super
+        @example_groups = []
+        @core = Rspec::Axlsx::Formatter::Core.new
+      end
+
+      def example_group_started(example_group)
+        @example_groups.push(example_group)
+      end
+
+      def example_passed(example)
+        @example_groups.push(example)
+      end
+
+      def example_failed(example)
+        @example_groups.push(example)
+      end
+
+      def dump_summary(*args)
+        @core.to_sheet(@example_groups)
+      end
+
+    end
+  end
+end
+

data/lib/rspec/axlsx/formatter_rspec3.rb

@@ -1,46 +1,24 @@
 require "rspec/core"
-require "axlsx"
-require "axlsx/package"
 require "rspec/core/formatters/base_formatter"
 require "rspec/axlsx/formatter/core"
 
-require "pp"
-
 module Rspec
   module Axlsx
     #class Formatter < ::RSpec::Core::Formatters::BaseFormatter
     class FormatterRSpec3 < ::RSpec::Core::Formatters::BaseFormatter
       ::RSpec::Core::Formatters.register self,
-        :start, :example_group_started, :stop,
+        :example_group_started, :stop,
         :example_passed, :example_failed
 
-      ALL_IN_ONE_SHEET = 0
-
       def initialize(*)
-        super ::Axlsx::Package.new
-
-        @workbook = output.workbook
         @example_groups = []
-        @current_time = Time.now
-
-        @example_num = 0
-
-        #@describe_column = ["Expected"]
-        @describe_column = []
-
-        @sheet_mode = ALL_IN_ONE_SHEET
-      end
-
-      def start(notification)
+        @core = Rspec::Axlsx::Formatter::Core.new
       end
 
       def example_group_started(notification)
         @example_groups.push(notification.group)
       end
 
-      def example_group_finished(notification)
-      end
-
       def example_passed(notification)
         @example_groups.push(notification.example)
       end
@@ -50,155 +28,9 @@ module Rspec
       end
 
       def stop(notification)
-        to_sheet
-        output.use_shared_strings = true
-        output.serialize("report.xlsx")
-      end
-
-      private
-
-      def success?(example)
-        example.execution_result.status == :passed
-      end
-
-      def has_status?(example)
-        example.respond_to?(:execution_result)
-      end
-
-      def to_sheet
-        convert_to_sheet do |worksheet|
-        end
-      end
-
-      def sheet_style(worksheet)
-        worksheet.column_widths(*[nil].concat(max_example_depth.times.map{5}))
-        #worksheet.column_widths(nil, 5, 5)
+        @core.to_sheet(@example_groups)
       end
 
-      def sheet_header(worksheet)
-        worksheet.add_row do |row|
-          row.add_cell('No'        , style: header_style)
-          row.add_cell('Test Case' , style: header_style)
-          max_example_depth.times{row.add_cell('', style: header_style)}
-          @describe_column.each do |c|
-            row.add_cell(c, style: header_style)
-          end
-          row.add_cell('Result'    , style: header_style)
-        end
-      end
-
-      def convert_to_sheet
-        if @sheet_mode == ALL_IN_ONE_SHEET
-          @workbook.add_worksheet do |worksheet|
-            sheet_header(worksheet)
-            @example_groups.each do |example_group|
-              add_sheet_row(worksheet, example_group)
-            end
-            sheet_style(worksheet)
-          end
-        else
-          transepose = 
-            @example_groups.inject({}) do |h, example_group|
-              h[example_group.example.file_path] ||= []
-              h[example_group.example.file_path].push(example_group)
-              h
-            end
-          transepose.each do |k, v|
-            @workbook.add_worksheet do |worksheet|
-              yield(worksheet)
-            end
-          end
-        end
-      end
-
-      def add_sheet_row(worksheet, example_group)
-        worksheet.add_row do |row|
-          if has_status?(example_group)
-            @example_num += 1
-            row.add_cell(@example_num, style: idx_column_style)
-            example_depth(example_group).times do
-              row.add_cell("", style: grey_style)
-            end
-            row.add_cell(example_group.description)
-            offset = max_example_depth - example_depth(example_group) + @describe_column.length
-            offset.times do
-              row.add_cell("")
-            end
-            if success?(example_group)
-              row.add_cell("T", style: success_style)
-            else
-              row.add_cell("F", style: failed_style)
-            end
-          else
-            row.add_cell("", style: pink_style)
-            example_depth(example_group).times do
-              row.add_cell("", style: grey_style)
-            end
-            row.add_cell(example_group.description)
-          end
-        end
-      end
-
-      def max_example_depth
-        @max_example_depth ||=
-          @example_groups.map{|e| example_depth(e)}.max
-      end
-
-      def example_depth(example)
-        if has_status?(example)
-          example.example_group.parent_groups.select{|p| p != example}.length
-        else
-          example.parent_groups.select{|p| p != example}.length
-        end
-      end
-
-      def style_hash
-        {
-          header_style: {
-            bg_color: 'F4FA58',
-            b: true,
-            border: { style: :thin, color: '666666' },
-          },
-          idx_column_style: {
-            bg_color: 'FFDD99',
-            b: true,
-            border: { style: :thin, color: '666666', edges: [:right] },
-          },
-          test_case_style: {
-          },
-          success_style: {
-            bg_color: '58FA58',
-          },
-          failed_style: {
-            bg_color: 'FE2E2E',
-          },
-          grey_space_style: {
-            bg_color: 'CCCCCC',
-          },
-          pink_space_style: {
-            bg_color: '6CEEC',
-          },
-        }
-      end
-
-      def header_style
-        @header_style ||= @workbook.styles.add_style(style_hash[:header_style])
-      end
-      def pink_style
-        @pink_style ||= @workbook.styles.add_style(style_hash[:idx_column_style].merge(style_hash[:pink_space_style]))
-      end
-      def grey_style
-        @grey_style ||= @workbook.styles.add_style(style_hash[:grey_space_style])
-      end
-      def success_style
-        @success_style ||= @workbook.styles.add_style(style_hash[:success_style])
-      end
-      def failed_style
-        @failed_style ||= @workbook.styles.add_style(style_hash[:failed_style])
-      end
-      def idx_column_style
-        @idx_column_style ||= @workbook.styles.add_style(style_hash[:idx_column_style])
-      end
     end
   end
 end

data/lib/rspec/axlsx/rake/rspec.rb

@@ -11,7 +11,7 @@ namespace :axlsx do
     def setup_spec_opts(*extra_options)
       base_opts = [
         "--require", "#{File.dirname(__FILE__)}/rspec_loader.rb",
-        "--format", "Rspec::Axlsx::FormatterRSpec3"
+        "--format", "Rspec::AxlsxFormatter"
       ]
 
       spec_opts = (base_opts + extra_options).join(" ")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-axlsx-formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - yasuhiroki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: axlsx