sauerkraut 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5bb434c28c53b22154ef383692ef708c1a5915bd
-  data.tar.gz: 8ebc4213c01eec7929cb2f70595fb2b2bee617b9
+  metadata.gz: 3f805ce797baa943041777e9c9d7a962d4e35193
+  data.tar.gz: 2fefa04558823bec9c95b4c5765b67a43c4920c1
 SHA512:
-  metadata.gz: 6deb022974415c9d5248b43769ecc6033ecb8c20cb45fab0429cb7bce6a43f2d17c1268866fe1c5bd219ec2cb7959784f6044612a5436a6e2b28f56be2e5ab66
-  data.tar.gz: 334719a454260a19d48ec0e156cb7457c34cd2c05f3626655eca79108efb12822ead62a0e525ae1e42e1288062d392c0a395d47c40889c71e6c55317de26df9a
+  metadata.gz: a90eb6f7631ad62c829670a007282822a85b589824d0395e74e73f47bdcbbc97c9fed65bd44939fb163eeddb86d7523ef8267124c431861fb5259ad23c2fbad6
+  data.tar.gz: d585f6ef70f834c32c1354a53cc20a7a83eedade9e35b8bd020df089b0eb8aa00f5a0865a9c59e7f6f1078a7036c9bee556bbaebef1201c2db5f2a76a37545d7

data/.gitignore

@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+*.text

data/lib/sauerkraut/version.rb

@@ -1,3 +1,3 @@
 module Sauerkraut
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/sauerkraut.rb

@@ -6,7 +6,7 @@ module Sauerkraut
   @options = {
     :output => nil,
   }
-  @banner = "\nUsage: sauerkraut FEATURE_FILE:N[:M] [-o FILE]".cyan
+  @banner = "\nUsage: sauerkraut FEATURE_FILE[:N][:M] [-o FILE]".cyan
 
   def self.display_help
     puts @banner
@@ -116,13 +116,30 @@ module Sauerkraut
     f.close
   end
 
+
+  def self.colorize_output(output)
+    output.map! do |line|
+      if line =~ /^#/
+        line.chomp.cyan
+      else
+        line
+      end
+    end
+  end
+
+
+  def self.highlight_bvar!(bvar, line)
+    #line.gsub!(/([\W])(#{bvar})(\W)/) {|m| "#{$1}" + "#{bvar}".magenta + "#{$3}"}
+    line.gsub!(/([\[\(-\/=\\& :\+\-])(#{bvar})([^\w]|\z)/) {|m| "#{$1}" + "#{bvar}".magenta + "#{$3}"}
+  end
+
   def self.run(args)
     @args = args
 
+    # PARSING
     exit_with_help("must specify a feature file") if no_feature_file?
     exit_with_help("must specify a valid feature file") if invalid_feature_file?
     exit_with_help("must specify an existing feature file") if !feature_file_exists?
-    exit_with_help("must specify a line number") if no_line_number?
     exit_with_help("specify range with :N:M") if invalid_range?
 
     exit_with_help("must specify an output file") if no_output_file_specified?
@@ -130,42 +147,57 @@ module Sauerkraut
 
 
     # get feature file
-    feature_file = @args[0].split(":").first
-    line_number = @args[0].split(":")[1].to_i
-    range_number = range? ? (@args[0].split(":").last.to_i) : nil
+    if no_line_number?
+      feature_file = @args[0]
+      line_number = 0
+      range_number = nil
+    else
+      feature_file = @args[0].split(":").first
+      line_number = @args[0].split(":")[1].to_i
+      range_number = range? ? (@args[0].split(":").last.to_i) : nil
+    end
     feature_file_array = IO.readlines feature_file
 
 
 
 
-
-
-    # if one line, get scenario
-    if !range?
-      exit_with_help("specify a line number that is a scenario") if !is_line_scenario?(feature_file_array[line_number-1])
-      scenario = feature_file_array[line_number-1]
+    # if no lines, get entire file
+    if no_line_number?
       steps = []
-      feature_file_array[line_number..-1].each do |line|
-        break if is_line_scenario?(line)
+      feature_file_array[0..-1].each do |line|
+        next if is_line_scenario?(line)
         steps << line.strip
       end
-    end
+    else
 
-    # if two lines, gather given when thens
-    if range?
-      steps = []
-      feature_file_array[line_number..range_number].each do |line|
-        next if is_line_scenario?(line)
-        steps << line.strip
+
+      # if one line, get scenario
+      if !range?
+        exit_with_help("specify a line number that is a scenario") if !is_line_scenario?(feature_file_array[line_number-1])
+        scenario = feature_file_array[line_number-1]
+        steps = []
+        feature_file_array[line_number..-1].each do |line|
+          break if is_line_scenario?(line)
+          steps << line.strip
+        end
       end
+
+      # if two lines, gather given when thens
+      if range?
+        steps = []
+        feature_file_array[line_number..range_number].each do |line|
+          next if is_line_scenario?(line)
+          steps << line.strip
+        end
+      end
+
     end
 
 
     # get regexes
-    pattern = /(?:Given|When|Then|And).+\/(.*)\/.+/
+    pattern = /(?:Given|When|Then|And|But).+\/(.*)\/.+/
     pattern2 = /\/(.*)\//
     all_the_regexes = []
-    linenumber = 1
     stepfiles = File.join("**", "*steps.rb")
     Dir.glob(stepfiles) do |file|
       linenumber = 1
@@ -182,12 +214,17 @@ module Sauerkraut
 
     # use stepfinder to find sources
     # compute block variables
-    stepdeflocations = []
+    headlands = []
     steps.each do |step|
       next if !is_step_def?(step)
       all_the_regexes.each do |regexarr|
         if remove_first_word(step) =~ regexarr.first
-          stepdeflocations << {:step => step, :sourcefile => regexarr[1], :lineno => regexarr[2], :block_vars => remove_first_word(step).scan(regexarr[0]).flatten}
+          headlands << {
+            :step => step,
+            :sourcefile => regexarr[1],
+            :lineno => regexarr[2],
+            :block_vars => remove_first_word(step).scan(regexarr[0]).flatten,
+          }
         end
       end
     end
@@ -195,23 +232,23 @@ module Sauerkraut
 
 
     # get each code section from source
-    stepdeflocations.each do |stepdeflocation|
+    headlands.each do |headland|
 
       # get code block
-      code_barrel = IO.readlines stepdeflocation[:sourcefile]
-      stepdeflocation[:step_def] = code_barrel[stepdeflocation[:lineno]-1]
+      patch = IO.readlines headland[:sourcefile]
+      headland[:step_def] = patch[ headland[:lineno]-1]
 
       # get block variables
-      if has_block_variables?( code_barrel[stepdeflocation[:lineno]-1])
-        stepdeflocation[:block_var_names] = code_barrel[stepdeflocation[:lineno]-1].reverse.scan(/\|(.*?)\|/).flatten.first.reverse.split(",").map{|v| v.strip}
+      if has_block_variables?( patch[headland[:lineno]-1])
+        headland[:block_var_names] = patch[ headland[:lineno]-1].reverse.scan(/\|(.*?)\|/).flatten.first.reverse.split(",").map{|v| v.strip}
       else
-        stepdeflocation[:block_var_names] = nil
+        headland[:block_var_names] = nil
       end
 
       #step through until the next given when then,
       #  collecting the lines
       cabbage = []
-      code_barrel[stepdeflocation[:lineno]..-1].each do |line|
+      patch[ headland[:lineno]..-1].each do |line|
         break if (is_step_def?(line) || is_def?(line))
         cabbage << line
       end
@@ -231,7 +268,7 @@ module Sauerkraut
       end
       cabbage.reverse!
       array_trim(cabbage)
-      stepdeflocation[:cabbage] = cabbage
+      headland[:cabbage] = cabbage
 
     end
 
@@ -242,19 +279,36 @@ module Sauerkraut
     # display cabbages
 
     output = []
-    stepdeflocations.each do |stepdeflocation|
-      output <<  "#{encomment stepdeflocation[:step_def]}"
+    headlands.each do |headland|
+      output <<  "#{encomment headland[:step_def]}"
+
+      if headland[:block_var_names]
+        output << "# block vars ------"
+        headland[:block_var_names].each_with_index do |name,i|
+          bvar = "#{name}"
+          bvar = bvar.magenta if !@options[:output]
+          line = bvar + " = #{enquote headland[ :block_vars][i]}"
+          output << line
+        end
+        output << "# -----------------"
+      end
 
-      if stepdeflocation[:block_var_names]
-        output << "# block vars"
-        stepdeflocation[:block_var_names].each_with_index do |name,i|
-          output <<  "#{name} = #{enquote stepdeflocation[:block_vars][i]}"
+      # search for block vars and highlight
+      if !@options[:output] && headland[:block_var_names]
+        cabbage = headland[:cabbage].map! do |line|
+          headland[:block_var_names].each do |bvar|
+            if line =~ /\W#{bvar}\W/
+              highlight_bvar!(bvar, line)
+            end
+          end
+          line
         end
-        output << "# |"
-        output << "# V"
+      else
+        cabbage = headland[:cabbage]
       end
 
-      output += stepdeflocation[:cabbage]
+
+      output += cabbage
 
       output <<  "\n"
     end
@@ -267,7 +321,8 @@ module Sauerkraut
       write_array_to_file(output, @options[:output])
       puts "output written to #{@options[:output]}"
     else
-      puts output
+      puts colorize_output output
+      #puts output
     end
 
   end

data/sauerkraut.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["rubycoder@example.com"]
   spec.summary       = %q{Helps refactor cucumber steps.}
   spec.description   = %q{Gathers all step definition source code for a given scenario or range, and outputs it in one place.}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/cartoloupe/sauerkraut"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/spec/sauerkraut_spec.rb

@@ -8,6 +8,7 @@ describe "parsing" do
     expect {Sauerkraut.run "blah.feature".split}.to raise_error
     expect {Sauerkraut.run "blah.feature:39".split}.to raise_error
     expect {Sauerkraut.run "features/test.feature:39".split}.to raise_error
+    expect {Sauerkraut.run "features/test.feature".split}.to_not raise_error
     expect {Sauerkraut.run "features/test.feature:15".split}.to_not raise_error
     expect {Sauerkraut.run "features/test.feature:15:".split}.to raise_error
     expect {Sauerkraut.run "features/test.feature:15:17".split}.to_not raise_error

data/test/runtest1.output

@@ -1,39 +1,34 @@
 #Given(/^([\w]+) slices of vegetables$/) do |vegetable_size|
-# block vars
+# block vars ------
 vegetable_size = "small"
-# |
-# V
+# -----------------
   @vegetable_slice_size = vegetable_size.to_sym
 
 #Given(/^a(nother)? layer of vegetables is placed in the jar$/) do |repeat|
-# block vars
+# block vars ------
 repeat = ""
-# |
-# V
+# -----------------
   @jar ||= []
   put_vegetables_in_jar
 
 #Given(/^then (more )?salt is added$/) do |more|
-# block vars
+# block vars ------
 more = ""
-# |
-# V
+# -----------------
   @salt = 1
   @salt += 1 if more
 
 #Given(/^a(nother)? layer of vegetables is placed in the jar$/) do |repeat|
-# block vars
+# block vars ------
 repeat = "nother"
-# |
-# V
+# -----------------
   @jar ||= []
   put_vegetables_in_jar
 
 #Given(/^then (more )?salt is added$/) do |more|
-# block vars
+# block vars ------
 more = "more "
-# |
-# V
+# -----------------
   @salt = 1
   @salt += 1 if more
 

data/test/runtest2.output

@@ -1,31 +1,27 @@
 #Given(/^([\w]+) slices of vegetables$/) do |vegetable_size|
-# block vars
+# block vars ------
 vegetable_size = "small"
-# |
-# V
+# -----------------
   @vegetable_slice_size = vegetable_size.to_sym
 
 #Given(/^a(nother)? layer of vegetables is placed in the jar$/) do |repeat|
-# block vars
+# block vars ------
 repeat = ""
-# |
-# V
+# -----------------
   @jar ||= []
   put_vegetables_in_jar
 
 #Given(/^then (more )?salt is added$/) do |more|
-# block vars
+# block vars ------
 more = ""
-# |
-# V
+# -----------------
   @salt = 1
   @salt += 1 if more
 
 #Given(/^a(nother)? layer of vegetables is placed in the jar$/) do |repeat|
-# block vars
+# block vars ------
 repeat = "nother"
-# |
-# V
+# -----------------
   @jar ||= []
   put_vegetables_in_jar
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sauerkraut
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Vasanth Pappu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-20 00:00:00.000000000 Z
+date: 2014-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,7 +104,7 @@ files:
 - spec/sauerkraut_spec.rb
 - test/runtest1.output
 - test/runtest2.output
-homepage: ''
+homepage: https://github.com/cartoloupe/sauerkraut
 licenses:
 - MIT
 metadata: {}
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Helps refactor cucumber steps.
@@ -134,3 +134,4 @@ test_files:
 - spec/sauerkraut_spec.rb
 - test/runtest1.output
 - test/runtest2.output
+has_rdoc: