snowy_owl 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: faa64162b2877381d0681c26c743202388059960
-  data.tar.gz: da3867a1189f65550a733022b4ee955f25d01d30
+  metadata.gz: 8a2cda9d116073fa7f2a3077f04b15601f8e1de8
+  data.tar.gz: 2f7c8fd431635eab7f2a814b3cf2a60859067005
 SHA512:
-  metadata.gz: 55ab8558c1b6d20aa49948c367fe9c683102e807b0c822d9ec066331a940ab6edaf801ced75bfa310ef8b0a9f8a5720c4d9d942d3a66c21fc2609661dc582b1d
-  data.tar.gz: 6de88a50bf2ad51f50716d72603a840b2c74cb77cabc241f813c7622962a0dcccd017dc7856e409c793b50358d76c25208404e260e3271120b1ade32d597d363
+  metadata.gz: 72893bc9063fdd463e0927f6952aa13caaefeb368c6c7d27f9f4b735653c53fc0cce16cf8b98eb9d92e9a8ff4f490de67070b33fd638af28188e718ac2bcdb19
+  data.tar.gz: d2174104a82ef6cd780cd9b69e2053b7a17672c7ca18c1869322ad762b288c94478e61f08b1b363a2720bb1071a8438ebd73bc2ab9e80e271ba54ef3ed5aad21

data/.rubocop.yml

@@ -0,0 +1,10 @@
+AllCops:
+  Include:
+    - '**/Rakefile'
+  Exclude:
+    - 'bin/**/*'
+    - 'spec/**/*'
+    - '*.gemspec'
+    - 'Gemfile'
+Documentation:
+  Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    snowy_owl (0.2.2)
+    snowy_owl (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -2,7 +2,7 @@
 
 [![Code Climate](https://codeclimate.com/github/hanystudy/snowy_owl/badges/gpa.svg)](https://codeclimate.com/github/hanystudy/snowy_owl)
 
-Owl exploratory testing. Go to [SnowyOwl Wiki](https://github.com/hanystudy/snowy_owl/wiki) for background story and concepts.
+Owl exploratory testing. A demo project can be found [here](https://github.com/hanystudy/snowy_owl_demo). Go to [SnowyOwl Wiki](https://github.com/hanystudy/snowy_owl/wiki) for background story and concepts.
 
 ## Installation
 
@@ -41,11 +41,14 @@ require 'snowy_owl'
 SnowyOwl.play
 ```
 
-### Used with RSpec
+### Used with RSpec and Capybara
+
+Confirm you have rspec and rspec-rerun in your project.
 
 Add this to spec_helper.rb:
 
 ```ruby
+require 'capybara/rspec'
 require 'snowy_owl'
 require 'snowy_owl/rspec'
 ```

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/snowy_owl/config.rb

@@ -1,25 +1,24 @@
 module SnowyOwl
   class Config
-
-    OPTIONS = [
-      :props_path,
-      :determine_context,
-      :determinations_path,
-      :play_books_path,
-      :is_persisting,
-      :is_recovering,
-      :persist_path,
-      :plots_path,
-      :persist_callback,
-      :recover_callback,
-      :spec_file
-    ]
+    OPTIONS = %i[
+      props_path
+      determine_context
+      determinations_path
+      play_books_path
+      is_persisting
+      is_recovering
+      persist_path
+      plots_path
+      persist_callback
+      recover_callback
+      spec_file
+    ].freeze
 
     attr_accessor :props_path, :determinations_path, :play_books_path
     attr_accessor :is_persisting, :is_recovering, :persist_path, :plots_path
     attr_accessor :spec_file
 
-    def determine_context key, &determine_block
+    def determine_context(key, &determine_block)
       @determine_context ||= {}
       if block_given?
         @determine_context[key] = determine_block
@@ -28,11 +27,11 @@ module SnowyOwl
       end
     end
 
-    def persist_callback &block
+    def persist_callback(&block)
       @persist_callback = block || @persist_callback
     end
-    
-    def recover_callback &block
+
+    def recover_callback(&block)
       @recover_callback = block || @recover_callback
     end
   end

data/lib/snowy_owl/determinations.rb

@@ -3,8 +3,7 @@ require 'ostruct'
 
 module SnowyOwl
   module Determinations
-
-    def self.determine name, &block
+    def self.determine(name, &block)
       SnowyOwl.determine_context SnowyOwl::Support.to_underscore(name).to_sym, &block
     end
 

data/lib/snowy_owl/digest.rb

@@ -0,0 +1,18 @@
+require 'digest'
+
+module SnowyOwl
+  module Digest
+    def self.generate_full_path_digest(candidate_plots)
+      pre_digest = nil
+      candidate_plots.each do |plot|
+        pre_digest = pre_digest.nil? ? digest(plot['plot_name']) : digest(pre_digest + plot['plot_name'])
+        plot['digest'] = pre_digest
+      end
+      candidate_plots
+    end
+
+    def self.digest string
+      ::Digest::SHA1.hexdigest string
+    end
+  end
+end

data/lib/snowy_owl/owl_field.rb

@@ -1,6 +1,6 @@
 module SnowyOwl
   class OwlField
-    def play *args, &block
+    def play(*args, &block)
       instance_exec *args, &block
     end
 
@@ -10,37 +10,36 @@ module SnowyOwl
       plots_range = expression.match /(.*)(\.{2})(.*)/
       if plots_range.nil?
         scope = expression.split("\n")
-        candidate_plots.select { |plot| scope.include? plot['plot_name'] }
+        candidate_plots.select { |plot| scope.include?(plot['plot_name']) || scope.include?(plot['digest']) }
       else
         sequence_run_from_starting_point candidate_plots, plots_range
       end
     end
 
-    def sequence_run_from_starting_point candidate_plots, plots_range
+    def sequence_run_from_starting_point(candidate_plots, plots_range)
       starting_point = plots_range[1]
       range_type = plots_range[2]
       ending_point = plots_range[3]
       in_scope = false
-      candidate_plots.inject([]) do |acc, plot|
+      candidate_plots.each_with_object([]) do |plot, acc|
         plot_name = plot['plot_name']
-        in_scope = true if plot_name == starting_point
+        plot_digest = plot['digest']
+        in_scope = true if plot_name == starting_point || plot_digest == starting_point
         acc << plot if in_scope
-        in_scope = false if plot_name == ending_point
-        acc
+        in_scope = false if plot_name == ending_point || plot_digest == ending_point
       end
     end
 
-    def sequence_run candidate_play_books
-      candidate_play_books.each do |play_book|
-        candidate_plots = YAML.load_file(play_book)
-        expression = ENV['PLOTS_SCOPE']
-        candidate_plots = plots_scope(candidate_plots, expression)
-        candidate_plots.each do |plot|
-          plot_name = plot['plot_name']
-          SnowyOwl::Persist.recover_state plot_name if SnowyOwl.is_recovering
-          SnowyOwl::Persist.persist_state plot_name if SnowyOwl.is_persisting
-          instance_exec plot_name, &SnowyOwl::Plots.plot(plot_name)
-        end
+    def sequence_run(candidate_play_books)
+      candidate_plots = SnowyOwl::Plays.build_plays(candidate_play_books)
+      expression = ENV['PLOTS_SCOPE']
+      candidate_plots = plots_scope(candidate_plots, expression)
+      candidate_plots.each do |plot|
+        plot_name = plot['plot_name']
+        digest = plot['digest']
+        SnowyOwl::Persist.recover_state digest if SnowyOwl.is_recovering
+        SnowyOwl::Persist.persist_state digest if SnowyOwl.is_persisting
+        instance_exec plot_name, &SnowyOwl::Plots.plot(plot_name)
       end
     end
   end

data/lib/snowy_owl/persist.rb

@@ -4,21 +4,19 @@ require 'fileutils'
 
 module SnowyOwl
   module Persist
-
     class << self
-      def persist_state(plot_name)
-        plot_name_path = SnowyOwl::Support.to_underscore plot_name
+      def persist_state(digest)
         temp_persist_path = SnowyOwl.persist_path + '/.tmp/'
-        path = temp_persist_path + plot_name_path
-        FileUtils::mkdir_p path
-        args = [plot_name_path, temp_persist_path]
+        sub_path = digest
+        path = temp_persist_path + sub_path
+        FileUtils.mkdir_p path
+        args = [sub_path, temp_persist_path]
         SnowyOwl.persist_callback.call(args)
       end
 
-      def recover_state(plot_name)
-        plot_name_path = SnowyOwl::Support.to_underscore plot_name
-        path = SnowyOwl.persist_path + plot_name_path
-        args = [plot_name_path, SnowyOwl.persist_path]
+      def recover_state(digest)
+        sub_path = digest
+        args = [sub_path, SnowyOwl.persist_path]
         SnowyOwl.recover_callback.call(args)
       end
     end

data/lib/snowy_owl/plays.rb

@@ -0,0 +1,73 @@
+module SnowyOwl
+  module Plays
+    class PlotNodeHash
+      attr_accessor :children, :digest, :parent, :name
+
+      def initialize
+        @children = []
+      end
+
+      def append_child(digest)
+        @children << digest
+      end
+
+      def to_h
+        {'digest' => @digest,
+         'parent' => @parent,
+         'plot_name' => @name }
+      end
+    end
+
+    class << self
+      def build_plays(candidate_play_books)
+        @play_hash = {}
+        @starting_node = nil
+        candidate_play_books.each do |play_book|
+          candidate_plots = YAML.load_file(play_book)
+          generate_full_path_digest(candidate_plots)
+        end
+        generate_deep_first_plays
+      end
+
+      def generate_deep_first_plays
+        plays = []
+        deep_stack = [@starting_node.digest]
+        while !deep_stack.empty?
+          node = deep_stack.pop
+          deep_stack = deep_stack.concat @play_hash[node].children
+          plays << @play_hash[node].to_h
+        end
+        plays
+      end
+
+      def generate_full_path_digest(candidate_plots)
+        pre_digest = nil
+        candidate_plots.each do |plot|
+          parent_digest = plot['parent']
+          digest = plot['digest']
+          plot['digest'] = SnowyOwl::Digest.digest((parent_digest || pre_digest).to_s + plot['plot_name']) if digest.nil?
+          plot['parent'] = pre_digest if parent_digest.nil?
+          pre_digest = plot['digest']
+          node = create_node plot
+          @starting_node = node if node.parent.nil?
+        end
+        candidate_plots
+      end
+
+      def create_node plot
+        plot_node = @play_hash[plot['digest']] || PlotNodeHash.new
+        plot_node.name = plot['plot_name']
+        plot_node.parent = plot['parent']
+        plot_node.digest = plot['digest']
+        @play_hash[plot['digest']] = plot_node
+        if !plot['parent'].nil?
+          parent_node = @play_hash[plot['parent']] || PlotNodeHash.new
+          plot_node.parent = plot['parent']
+          parent_node.append_child plot['digest']
+          @play_hash[plot['parent']] = parent_node
+        end
+        @play_hash[plot['digest']]
+      end
+    end
+  end
+end

data/lib/snowy_owl/plots.rb

@@ -1,10 +1,8 @@
 module SnowyOwl
   module Plots
-
     class << self
-
       def write(plot_name, &block)
-        proc = Proc.new do |*args|
+        proc = proc do |*args|
           extend SnowyOwl::Props
           extend SnowyOwl::Determinations
           instance_exec(*args, &block)
@@ -13,7 +11,7 @@ module SnowyOwl
         @__plots__[plot_name] = proc
       end
 
-      def plot plot_name
+      def plot(plot_name)
         @__plots__[plot_name]
       end
     end

data/lib/snowy_owl/props.rb

@@ -4,10 +4,9 @@ require 'yaml'
 
 module SnowyOwl
   module Props
-
     def init_props
       props_path = SnowyOwl.props_path
-      raise RuntimeError.new 'Invalid props path' if props_path.empty?
+      raise 'Invalid props path' if props_path.empty?
       props_hash = {}
       Dir[props_path].each do |f|
         field_name = File.basename f, '.yml'

data/lib/snowy_owl/rspec/rerun.rb

@@ -4,7 +4,7 @@ module RSpec
   module Rerun
     class Formatter
       def retry_command(example)
-        example.description
+        example.metadata[:digest]
       end
     end
 

data/lib/snowy_owl/rspec.rb

@@ -2,7 +2,7 @@ require 'snowy_owl/rspec/rerun'
 
 module SnowyOwl
   class Config
-    alias_options = OPTIONS
+    alias_options = OPTIONS.dup
     alias_options << :spec_file
     remove_const :OPTIONS
     const_set :OPTIONS, alias_options.uniq
@@ -12,39 +12,60 @@ module SnowyOwl
 
   module Plots
     class << self
-      alias :old_write :write
+      alias old_write write
 
       def write(plot_name, &block)
         proc = old_write plot_name, &block
-        RSpec.shared_examples plot_name do
+        RSpec.shared_examples plot_name do |args|
+          @metadata[:digest] = args[:digest]
           scenario plot_name, &proc
         end
       end
     end
   end
 
-  def self.play *args
+  def self.play(*args)
     RSpec.feature *args do
       Dir[SnowyOwl.plots_path].each { |f| require f }
       Dir[SnowyOwl.determinations_path].each { |f| require f }
 
       before do |plot|
-        SnowyOwl::Persist.recover_state plot.description if SnowyOwl.is_recovering
-        SnowyOwl::Persist.persist_state plot.description if SnowyOwl.is_persisting
+        digest = plot.metadata[:digest]
+        SnowyOwl::Persist.recover_state digest if SnowyOwl.is_recovering
+        SnowyOwl::Persist.persist_state digest if SnowyOwl.is_persisting
       end
 
       candidate_play_books = Dir[SnowyOwl.play_books_path]
 
       owl_field = OwlField.new
 
-      candidate_play_books.each do |play_book|
-        candidate_plots = YAML.load_file(play_book)
-        expression = ENV['PLOTS_SCOPE']
-        candidate_plots = owl_field.plots_scope(candidate_plots, expression)
-        candidate_plots.each do |plot|
-          it_behaves_like plot['plot_name']
-        end
+      candidate_plots = SnowyOwl::Plays.build_plays(candidate_play_books)
+      expression = ENV['PLOTS_SCOPE']
+      candidate_plots = owl_field.plots_scope(candidate_plots, expression)
+      candidate_plots.each do |plot|
+        plot_name = plot['plot_name']
+        digest = plot['digest']
+        it_behaves_like plot_name, digest: digest
       end
     end
   end
+
+  class StatusFormatter
+    RSpec::Core::Formatters.register self, :example_failed
+
+    def initialize(out)
+      @out = out
+    end
+
+    def example_failed(notification)
+      example = notification.example
+      @out.puts "\nplot name: #{example.description}"
+      @out.puts "plot digest: #{example.metadata[:digest]}"
+    end
+  end
+
+  RSpec.configure do |c|
+    c.add_formatter 'progress'
+    c.add_formatter StatusFormatter
+  end
 end

data/lib/snowy_owl/version.rb

@@ -1,3 +1,3 @@
 module SnowyOwl
-  VERSION = "0.2.2"
+  VERSION = '0.3.0'.freeze
 end

data/lib/snowy_owl.rb

@@ -2,18 +2,19 @@ require 'forwardable'
 require 'yaml'
 require 'snowy_owl/support'
 require 'snowy_owl/config'
+require 'snowy_owl/digest'
 
 module SnowyOwl
   class << self
     extend Forwardable
 
     SnowyOwl::Config::OPTIONS.each do |method|
-      def_delegators :config, "#{method}=" , "#{method}="
+      def_delegators :config, "#{method}=", "#{method}="
       def_delegators :config, method, method
     end
 
     def configure
-      yield self.config
+      yield config
     end
 
     def config
@@ -41,6 +42,7 @@ SnowyOwl.configure do |config|
   config.persist_path = ''
 end
 
+require 'snowy_owl/plays'
 require 'snowy_owl/persist'
 require 'snowy_owl/plots'
 require 'snowy_owl/props'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snowy_owl
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Yi Han
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-30 00:00:00.000000000 Z
+date: 2017-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -89,6 +89,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -101,8 +102,10 @@ files:
 - lib/snowy_owl.rb
 - lib/snowy_owl/config.rb
 - lib/snowy_owl/determinations.rb
+- lib/snowy_owl/digest.rb
 - lib/snowy_owl/owl_field.rb
 - lib/snowy_owl/persist.rb
+- lib/snowy_owl/plays.rb
 - lib/snowy_owl/plots.rb
 - lib/snowy_owl/props.rb
 - lib/snowy_owl/rspec.rb