golden_silk 0.0.3.cardboard → 0.0.4.builders

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dae16601c21ac170ec594b547db698302e6d58f3
-  data.tar.gz: 5905ee2e8c0ad150ec94327571b701969bf1280e
+  metadata.gz: 126e16c8f9f102e4822151c6f325316430b1f441
+  data.tar.gz: 8fd0d2c891234ae8be26681d755b5fe3138eb71f
 SHA512:
-  metadata.gz: 3088cfb1e1119af61efae609d9d70d8d9d3b9b2d4cf00de6d118f14876f53011658087c54e1ff9f75c990adc4ee6f7ae8644a1f67b66f623b5a13ea9a491a1b5
-  data.tar.gz: 93c1e903ca9010115a7e90277811db631f68b0199a85e849ec10ae0ac63eeee81b6f221a635518f76b44dde1ee0ebbdb4b7c757eca8f5786ad0e302e2e4b68ca
+  metadata.gz: 50fc6ebeb33b7966711d9ac51be11da1112e09d0b69615132ff0e96566827e1019f3298ec05ed31cb1766c9a1d095d97a2f593305fdaa57d0471494a300a692e
+  data.tar.gz: 6165461801b143f4c15698c9de5f21c4752e8f9ad6a9bbe9bccfa65942e1acf456d42ce147712481493b9a8f913ed1a8d56a7e139e7e68ecd2644f93ae6f3483

data/bin/golden_silk

@@ -1,7 +1,42 @@
 #!/usr/bin/env ruby
 
 require 'golden_silk'
+require 'optparse'
 
-# TODO: quiet mode (or quiet by default and verbose mode)
-# TODO: take URL as an argument
-GoldenSilk::Spinner.new('http://0.0.0.0:9001/avatar_builder').run
+# TODO: Add a pretty progress bar when verbose is off
+options = {}
+
+opt_parser = OptionParser.new do |opts|
+  opts.banner = "Usage: golden_silk [options] starting_url"
+
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on("-v", "--verbose", "Run verbosely. Default is no output.") do |v|
+    options[:verbose] = true
+  end
+
+  opts.on("-d", "--depth NUM", Integer, "The maximum depth (number of steps) from the starting URL that should be explored. Default is 3.") do |d|
+    options[:depth] = d
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+
+  opts.on_tail("--version", "Show version") do
+    puts GoldenSilk::VERSION
+    exit
+  end
+end
+
+opt_parser.parse!(ARGV)
+
+starting_url = ARGV.first
+if starting_url
+  GoldenSilk::Spinner.new(starting_url, options).run
+else
+  puts "Starting URL is required."
+  exit
+end

data/lib/golden_silk/result/diff.rb

@@ -15,10 +15,12 @@ module GoldenSilk
     #{@steps.last}
     sleep 2
     html_after = html
-    diff = Diffy::Diff.new(html_before, html_after, context: 1).to_s
-    expect(diff).to eql('#{@diff.gsub("'", "\\\\'")}')
-  end
+    diff = Diffy::Diff.new(html_before, html_after, context: 0).each_chunk.to_a
 RSPEC
+        @diff.each_chunk do |chunk|
+          s << "    expect(diff).to include('#{chunk.gsub("'", "\\\\'")}')\n"
+        end
+        s << "  end\n"
       end
     end
   end

data/lib/golden_silk/result/no_effect.rb

@@ -7,7 +7,7 @@ module GoldenSilk
 
       def to_s
         s = <<RSPEC
-  it 'has no effect' do
+  it 'has no effect, consider disabling this action in this case' do
     #{@steps[0...-1].join("\n    sleep 2\n    ")}
     sleep 2
     html_before = html

data/lib/golden_silk/spinner.rb

@@ -6,39 +6,39 @@ module GoldenSilk
   class Spinner
     include Capybara::DSL
 
-    # TODO: configurable depth
-    MAX_DEPTH = 3
-
     # TODO: configurable capybara driver
     Capybara.default_driver = :webkit
 
     Diffy::Diff.default_format = :text
 
-    def initialize(root_url)
-      @root_url = root_url
-      # TODO: configurable click selector, take into account disabled states
+    # TODO: allow for the thing we start with to be calling a method in your test_helper? Maybe?
+    # If the interesting part to test requires you to do a few steps like visit and log in...
+    def initialize(root_url, options = {})
+      @root_url  = root_url
+      @verbose   = options.fetch(:verbose, false)
+      @max_depth = options.fetch(:depth, 3)
+
+      # TODO: configurable click selector
+      # TODO: have the default take into account disabled states
       @click_selector = 'button, .store-accessory'
+
       @results = []
       @queue   = []
     end
 
     def run
-      # TODO: get host from root_url
-      page.driver.allow_url("0.0.0.0")
+      host = URI(@root_url).host
+      page.driver.allow_url(host)
       page.driver.block_unknown_urls
 
       visit @root_url
       # TODO: configurable wait time
       sleep 2
-      all(@click_selector).each { |node|
-        @queue << [
-          Step::Visit.new(url: @root_url, on: self),
-          Step::Click.new(xpath: node.path, text: node.text, on: self)
-        ]
-      }
-      stuff(@queue, @results)
+      enqueue_clickables([Step::Visit.new(url: @root_url, on: self)])
+      crawl
 
       # TODO: configurable output dir, test file(s), preamble
+      # TODO: provide helper methods so that diffy doesn't have to be required explicitly
       # TODO: stream results so that all is not lost if you have to kill the generation
       FileUtils.mkdir_p("test/integration")
       File.open('test/integration/golden_silk_spec.rb', 'w') do |f|
@@ -49,51 +49,67 @@ module GoldenSilk
       end
     end
 
+    def output(str)
+      puts str if @verbose
+    end
+
     private
 
-    # TODO: better name, don't take queue/results as arguments
-    def stuff(queue, results)
-      if queue.empty?
-        puts "Queue is empty, we're done!"
+    def enqueue_clickables(previous_steps)
+      all(@click_selector).each { |node|
+        steps_to_queue = previous_steps.clone
+        # TODO: check for Ambiguous matches that may need more identification
+        if node.tag_name == 'button'
+          steps_to_queue << Step::ButtonClick.new(text: node.text, on: self)
+        else
+          steps_to_queue << Step::Click.new(xpath: node.path, text: node.text, on: self)
+        end
+        @queue << steps_to_queue
+      }
+    end
+
+    def crawl
+      if @queue.empty?
+        output "Queue is empty, we're done!"
         return
       end
 
-      current_action_set = queue.shift
+      current_action_set = @queue.shift
       depth = current_action_set.length
 
-      last_action = current_action_set.pop
+      all_but_the_last_action = current_action_set[0...-1]
+      last_action = current_action_set.last
 
-      current_action_set.each { |a| a.execute }
+      all_but_the_last_action.each { |a| a.execute }
       sleep 2
       before_snapshot = html
       last_action.execute
       sleep 2
       after_snapshot = html
-      diff = Diffy::Diff.new(before_snapshot, after_snapshot, context: 1).to_s
 
-      if diff.empty?
-        puts "No change, adding to results but not queue."
-        results << Result::NoEffect.new(steps: current_action_set + [last_action])
+      # Do a (quicker?) simple string comparison to see if there was a change in the page
+      if before_snapshot == after_snapshot
+        output "No change, adding to results but not queue."
+        @results << Result::NoEffect.new(steps: current_action_set)
       else
-        puts "Change, adding to results."
-        results << Result::Diff.new(diff: diff, steps: current_action_set + [last_action])
+        # If there is a change, try and get the smallest change we can
+        before_html = before_snapshot.gsub(/>\s+</, "><").gsub("<", "\n<").gsub(">", ">\n").gsub(/\n\n+/, "\n")
+        after_html  = after_snapshot.gsub(/>\s+</, "><").gsub("<", "\n<").gsub(">", ">\n").gsub(/\n\n+/, "\n")
+        diff        = Diffy::Diff.new(before_html, after_html, context: 0)
+
+        output "Change, adding to results."
+        @results << Result::Diff.new(diff: diff, steps: current_action_set)
 
-        if depth == MAX_DEPTH
-          puts "Hit max depth."
+        if depth == @max_depth
+          output "Hit max depth."
         else
-          puts "Looking for more steps to take."
-
-          all(@click_selector).map { |node|
-            queue << current_action_set + [
-              last_action,
-              Step::Click.new(xpath: node.path, text: node.text, on: self)
-            ]
-          }
+          output "Looking for more steps to take."
+          enqueue_clickables(current_action_set)
         end
       end
 
-      puts "Recursing. Queue length: #{queue.length}, Results length: #{results.length}"
-      stuff(queue, results)
+      output "Recursing. Queue length: #{@queue.length}, Results length: #{@results.length}"
+      crawl
     end
   end
 end

data/lib/golden_silk/step/button_click.rb

@@ -0,0 +1,20 @@
+module GoldenSilk
+  module Step
+    class ButtonClick
+      def initialize(options = {})
+        @text   = options[:text]
+        @tag    = options[:tag]
+        @object = options[:on]
+      end
+
+      def execute
+        @object.output "Following instructions to click button #{@text}"
+        @object.click_button @text
+      end
+
+      def to_s
+        "click_button \"#{@text}\""
+      end
+    end
+  end
+end

data/lib/golden_silk/step/click.rb

@@ -2,13 +2,13 @@ module GoldenSilk
   module Step
     class Click
       def initialize(options = {})
-        @xpath = options[:xpath]
-        @text  = options[:text]
+        @xpath  = options[:xpath]
+        @text   = options[:text]
         @object = options[:on]
       end
 
       def execute
-        puts "Following instructions to click #{@text}"
+        @object.output "Following instructions to click #{@text}"
         @object.find(:xpath, @xpath).click
       end
 

data/lib/golden_silk/step/visit.rb

@@ -2,12 +2,12 @@ module GoldenSilk
   module Step
     class Visit
       def initialize(options = {})
-        @url = options[:url]
+        @url    = options[:url]
         @object = options[:on]
       end
 
       def execute
-        puts "Visiting #{@url}"
+        @object.output "Visiting #{@url}"
         @object.visit @url
       end
 

data/lib/golden_silk/version.rb

@@ -1,3 +1,3 @@
 module GoldenSilk
-  VERSION = "0.0.3.cardboard"
+  VERSION = "0.0.4.builders"
 end

data/lib/golden_silk.rb

@@ -3,4 +3,5 @@ require "golden_silk/spinner"
 require "golden_silk/result/diff"
 require "golden_silk/result/no_effect"
 require "golden_silk/step/click"
+require "golden_silk/step/button_click"
 require "golden_silk/step/visit"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: golden_silk
 version: !ruby/object:Gem::Version
-  version: 0.0.3.cardboard
+  version: 0.0.4.builders
 platform: ruby
 authors:
 - Carol (Nichols || Goulding)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -101,6 +101,7 @@ files:
 - lib/golden_silk/result/diff.rb
 - lib/golden_silk/result/no_effect.rb
 - lib/golden_silk/spinner.rb
+- lib/golden_silk/step/button_click.rb
 - lib/golden_silk/step/click.rb
 - lib/golden_silk/step/visit.rb
 - lib/golden_silk/version.rb