rspec_piccolo 0.0.4 → 0.0.5

data/.rspec

@@ -1,2 +1,2 @@
---color
---format progress
+--color
+--format progress

data/README.md

@@ -144,6 +144,326 @@ describe SomeClass do
 end
 ~~~
 
+### Case class_name, class_place, method_names with report
+you can output report by -r(reportable) option.
+
+~~~
+piccolo execute Hoge hoge/hige/hoge hoge hige -r
+~~~
+
+product code
+~~~
+# encoding: utf-8
+
+class Hoge
+  def hoge
+    "hoge"
+  end
+  def hige
+    "hige"
+  end
+end
+
+~~~
+
+Result, spec/hoge/hige/hoge_spec.rb
+~~~
+# encoding: utf-8
+require "spec_helper"
+require "hoge/hige/hoge"
+
+describe Hoge do
+  REPORT = "rspec_report"
+  DIRS = File.path(__FILE__).gsub(/^.*\/spec\//, '').gsub(File.basename(__FILE__), '')
+  OUT_DIR = "./#{REPORT}/#{DIRS}"
+  REPORT_NAME = report_name = File.basename(__FILE__, ".rb")
+  REPORT_FILE = "#{OUT_DIR}#{REPORT_NAME}.tsv"
+
+  mkspec_report = Proc.new do
+    Dir.mkdir(REPORT) unless File.exists?(REPORT)
+    FileUtils.mkdir_p(OUT_DIR) unless File.exists?(OUT_DIR)
+    File.open(REPORT_FILE, "w") {|f|f.puts "method\tcase\ttitle\tsuccess\/failure"}
+  end.call
+
+  success = Proc.new {|c|File.open(REPORT_FILE, "a") {|f|f.puts "\tsuccess"}}
+  failure = Proc.new {|c|File.open(REPORT_FILE, "a") {|f|f.puts "\tfailure"}}
+
+  context :hoge do
+    cases = [
+      {
+        case_no: 1,
+        case_title: "case_title",
+        expected: "expected",
+        success_hook: success,
+        failure_hook: failure
+      },
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          hoge = Hoge.new
+
+          # -- when --
+          # TODO: implement execute code
+          # actual = hoge.hoge
+
+          # -- then --
+          # TODO: implement assertion code
+          # ret = expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+          sf_hook = ret ? c[:success_hook] : c[:failure_hook]
+          sf_hook.call(c)
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+        File.open(REPORT_FILE, "a") {|f|f.print "hoge\t#{c[:case_no]}\t#{c[:case_title]}"}
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+
+  context :hige do
+    cases = [
+      {
+        case_no: 1,
+        case_title: "case_title",
+        expected: "expected",
+        success_hook: success,
+        failure_hook: failure
+      },
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          hoge = Hoge.new
+
+          # -- when --
+          # TODO: implement execute code
+          # actual = hoge.hige
+
+          # -- then --
+          # TODO: implement assertion code
+          # ret = expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+          sf_hook = ret ? c[:success_hook] : c[:failure_hook]
+          sf_hook.call(c)
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+        File.open(REPORT_FILE, "a") {|f|f.print "hige\t#{c[:case_no]}\t#{c[:case_title]}"}
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+
+end
+~~~
+
+Edit manually, spec/hoge/hige/hoge_spec.rb
+~~~
+# encoding: utf-8
+require "spec_helper"
+require "hoge/hige/hoge"
+
+describe Hoge do
+  REPORT = "rspec_report"
+  DIRS = File.path(__FILE__).gsub(/^.*\/spec\//, '').gsub(File.basename(__FILE__), '')
+  OUT_DIR = "./#{REPORT}/#{DIRS}"
+  REPORT_NAME = report_name = File.basename(__FILE__, ".rb")
+  REPORT_FILE = "#{OUT_DIR}#{REPORT_NAME}.tsv"
+
+  mkspec_report = Proc.new do
+    Dir.mkdir(REPORT) unless File.exists?(REPORT)
+    FileUtils.mkdir_p(OUT_DIR) unless File.exists?(OUT_DIR)
+    File.open(REPORT_FILE, "w") {|f|f.puts "method\tcase\ttitle\tsuccess\/failure"}
+  end.call
+
+  success = Proc.new {|c|File.open(REPORT_FILE, "a") {|f|f.puts "\tsuccess"}}
+  failure = Proc.new {|c|File.open(REPORT_FILE, "a") {|f|f.puts "\tfailure"}}
+
+  context :hoge do
+    cases = [
+      {
+        case_no: 1,
+        case_title: "valid",
+        expected: "hoge",
+        success_hook: success,
+        failure_hook: failure
+      },
+      {
+        case_no: 2,
+        case_title: "invalid",
+        expected: "hige",
+        success_hook: success,
+        failure_hook: failure
+      },
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          hoge = Hoge.new
+
+          # -- when --
+          actual = hoge.hoge
+
+          # -- then --
+          ret = expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+          sf_hook = ret ? c[:success_hook] : c[:failure_hook]
+          sf_hook.call(c)
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+        File.open(REPORT_FILE, "a") {|f|f.print "hoge\t#{c[:case_no]}\t#{c[:case_title]}"}
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+
+  context :hige do
+    cases = [
+      {
+        case_no: 1,
+        case_title: "valid",
+        expected: "hige",
+        success_hook: success,
+        failure_hook: failure
+      },
+      {
+        case_no: 2,
+        case_title: "invalid",
+        expected: "hoge",
+        success_hook: success,
+        failure_hook: failure
+      },
+    ]
+
+    cases.each do |c|
+      it "|case_no=#{c[:case_no]}|case_title=#{c[:case_title]}" do
+        begin
+          case_before c
+
+          # -- given --
+          hoge = Hoge.new
+
+          # -- when --
+          actual = hoge.hige
+
+          # -- then --
+          ret = expect(actual).to eq(c[:expected])
+        ensure
+          case_after c
+          sf_hook = ret ? c[:success_hook] : c[:failure_hook]
+          sf_hook.call(c)
+        end
+      end
+
+      def case_before(c)
+        # implement each case before
+        File.open(REPORT_FILE, "a") {|f|f.print "hige\t#{c[:case_no]}\t#{c[:case_title]}"}
+      end
+
+      def case_after(c)
+        # implement each case after
+      end
+    end
+  end
+
+end
+~~~
+
+Execute rspec command. 
+~~~
+$rspec
+Run options: include {:focus=>true}
+
+All examples were filtered out; ignoring {:focus=>true}
+.F.F
+
+Failures:
+
+  1) Hoge hoge |case_no=2|case_title=invalid
+     Failure/Error: ret = expect(actual).to eq(c[:expected])
+
+       expected: "hige"
+            got: "hoge"
+
+       (compared using ==)
+     # ./spec/hoge/hige/hoge_spec.rb:51:in `block (4 levels) in <top (required)>'
+
+  2) Hoge hige |case_no=2|case_title=invalid
+     Failure/Error: ret = expect(actual).to eq(c[:expected])
+
+       expected: "hoge"
+            got: "hige"
+
+       (compared using ==)
+     # ./spec/hoge/hige/hoge_spec.rb:100:in `block (4 levels) in <top (required)>'
+
+Finished in 0.009 seconds
+4 examples, 2 failures
+
+Failed examples:
+
+rspec ./spec/hoge/hige/hoge_spec.rb:40 # Hoge hoge |case_no=2|case_title=invalid
+rspec ./spec/hoge/hige/hoge_spec.rb:89 # Hoge hige |case_no=2|case_title=invalid
+~~~
+
+you get tsv report.
+~~~
+tree
+┠ lib
+┃┗ hoge
+┃     ┗ hige
+┃         ┗ hoge.rb
+┠ rspec_report
+┃┗ hoge
+┃     ┗ hige
+┃         ┗ hoge_spec.tsv
+┗ spec
+    ┠ hoge
+    ┃ ┗ hige
+    ┃     ┗ hoge_spec.rb
+    ┗ spec_helper.rb
+
+$cat rspec_report/hoge/hige/hoge_spec.tsv
+method	case	title	success/failure
+hoge	1	valid	success
+hoge	2	invalid	failure
+hige	1	valid	success
+hige	2	invalid	failure
+~~~
+
 ## Pragmatic Usase
 You can edit your spec template like this sample.
 
@@ -315,6 +635,12 @@ Finished in 0.0045 seconds
 4 examples, 0 failures
 ~~~
 
+## History
+* version 0.0.5 : add reportable option.
+* version 0.0.4 : you can get multi level directory spec case.
+* version 0.0.2 : fix bin.(use thor).
+* version 0.0.1 : first release.
+
 ## Contributing
 
 1. Fork it

data/bin/piccolo

@@ -8,6 +8,7 @@ module RSpecPiccolo
   class CLI < Thor
     class_option :help, :type => :boolean, :aliases => 'h', :desc => 'help message.'
     class_option :version, :type => :boolean, :aliases => 'v', :desc => 'version'
+    class_option :reportable, :type => :boolean, :aliases => 'r', :desc => 'reportable'
     default_task :execute
 
     desc "execute", "generate rspec spec_file with list_cases"
@@ -16,7 +17,7 @@ module RSpecPiccolo
       class_path = args[1]
       method_names = args[2..-1] if args.size > 2
 
-      RSpecPiccolo::Core.new.generate class_name, class_path, method_names
+      RSpecPiccolo::Core.new.generate class_name, class_path, method_names, options[:reportable]
     end
 
     desc "version", "version"

data/lib/rspec_piccolo.rb

@@ -13,10 +13,28 @@ require "spec_helper"
 require "<%=class_path%>"
 
 describe <%=class_name%> do
+<%=reportable_prepare%>
 <%=methods_template%>
 end
     EOS
 
+    REPORTABLE_PREPARE =<<-EOS
+  REPORT = "rspec_report"
+  DIRS = File.path(__FILE__).gsub(/^.*\\/spec\\//, '').gsub(File.basename(__FILE__), '')
+  OUT_DIR = "./#\{REPORT}/#\{DIRS}"
+  REPORT_NAME = report_name = File.basename(__FILE__, ".rb")
+  REPORT_FILE = "#\{OUT_DIR}#\{REPORT_NAME}.tsv"
+
+  mkspec_report = Proc.new do
+    Dir.mkdir(REPORT) unless File.exists?(REPORT)
+    FileUtils.mkdir_p(OUT_DIR) unless File.exists?(OUT_DIR)
+    File.open(REPORT_FILE, "w") {|f|f.puts "method\\tcase\\ttitle\\tsuccess\\/failure"}
+  end.call
+
+  success = Proc.new {|c|File.open(REPORT_FILE, "a") {|f|f.puts "\\tsuccess"}}
+  failure = Proc.new {|c|File.open(REPORT_FILE, "a") {|f|f.puts "\\tfailure"}}
+    EOS
+
     #== RSPec method template
     METHOD_TEMPLATE=<<-EOS
   context :<%=method_name%> do
@@ -24,7 +42,8 @@ end
       {
         case_no: 1,
         case_title: "case_title",
-        expected: "expected"
+        expected: "expected",
+<%=reportable_case%>
       },
     ]
 
@@ -42,14 +61,16 @@ end
 
           # -- then --
           # TODO: implement assertion code
-          # expect(actual).to eq(c[:expected])
+          # ret = expect(actual).to eq(c[:expected])
         ensure
           case_after c
+<%=reportable_case_after%>
         end
       end
 
       def case_before(c)
         # implement each case before
+<%=reportable_case_before%>
       end
 
       def case_after(c)
@@ -58,6 +79,18 @@ end
     end
   end
 EOS
+    
+    REPORTABLE_CASE =<<-EOS
+        success_hook: success,
+        failure_hook: failure
+    EOS
+
+    REPORTABLE_CASE_BEFORE = '        File.open(REPORT_FILE, "a") {|f|f.print "method_name\\t#{c[:case_no]}\\t#{c[:case_title]}"}'
+
+    REPORTABLE_CASE_AFTER =<<-EOS
+          sf_hook = ret ? c[:success_hook] : c[:failure_hook]
+          sf_hook.call(c)
+    EOS
 
     #== initialize
     def initialize
@@ -69,11 +102,11 @@ EOS
     #- class_name: spec's module+class full name
     #- class_path: spec's class_path(if you want to create spec/hoge_spec.rb, you should set 'hoge_spec.rb')
     #- method_names: target class's method list
-    def generate(class_name, class_path, method_names)
+    def generate(class_name, class_path, method_names, reportable = false)
       validate_class_name class_name
       validate_class_path class_path
-      methods_template = generate_method_template(class_name, method_names)
-      @contents = generate_class_template(class_name, class_path, methods_template)
+      methods_template = generate_method_template(class_name, method_names, reportable)
+      @contents = generate_class_template(class_name, class_path, methods_template, reportable)
       create_spec_directory class_path
       File.open("./spec/#{class_path}_spec.rb", "w") {|f|f.puts @contents}
     end
@@ -89,11 +122,15 @@ EOS
       raise RSpecPiccoloError.new("class_path is not allowed empty value") if class_path.empty?
     end
 
-    def generate_method_template(class_name, method_names)
+    def generate_method_template(class_name, method_names, reportable)
       return "" if method_names.nil?
+      reportable_case = reportable ? REPORTABLE_CASE.chop : ""
       instance_name = class_name.gsub('::', '_').underscore.downcase
       method_templates = []
       method_names.each do |method_name|
+        reportable_case_before = reportable ? REPORTABLE_CASE_BEFORE.dup : ""
+        reportable_case_before.gsub!("method_name", method_name)
+        reportable_case_after = reportable ? REPORTABLE_CASE_AFTER.dup.chop : ""
         method_templates << ERB.new(METHOD_TEMPLATE).result(binding)
       end
       method_templates.join("\n")
@@ -104,7 +141,8 @@ EOS
       FileUtils.mkdir_p("./spec/#{File.dirname(class_path)}")
     end
 
-    def generate_class_template(class_name, class_path, methods_template)
+    def generate_class_template(class_name, class_path, methods_template, reportable)
+      reportable_prepare = reportable ? REPORTABLE_PREPARE : ""
       ERB.new(CLASS_TEMPLATE).result(binding)
     end
   end