snowy_owl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c72a2f1a1a15005f141d3e520b259047733dcf06
+  data.tar.gz: 225d86b735a628217e75aa64fce9d3ca8fa9f5b4
+SHA512:
+  metadata.gz: 66eeaf97e58dbc87906d51fb91bb052ed384d11966537923dfe8041d3fc93088fa3de12d87c45cfbe768fca8fe28005039d352f7aca2efc44bb8dab3780a83b2
+  data.tar.gz: 940f890c0467cf17571d07dbad138b8e898d540665f8f0df1eb2c7d21057e8e5e77ba606831e739dd0517e4040d83666886c4b39cd17affc1b6a764495571b33

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at hanystudy@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    snowy_owl (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-rerun (1.1.0)
+      rspec (~> 3.0)
+    rspec-support (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-rerun (~> 1.1)
+  snowy_owl!
+
+BUNDLED WITH
+   1.15.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yi Han
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# SnowyOwl
+
+Owl exploratory testing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'snowy_owl'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snowy_owl
+
+## Usage
+
+Make sure you have directory structure like below:
+
+```markdown
+your_test_directory/
+├── props/
+├── determinations/
+├── plots/
+├── play_books/
+└── play.rb
+```
+
+Add this line to play.rb:
+
+```ruby
+require 'snowy_owl'
+
+SnowyOwl.play
+```
+
+### Used with RSpec
+
+Use play_spec.rb instead of play.rb, and add this line to play_spec.rb:
+
+```ruby
+require 'spec_helper'
+require 'snowy_owl/rspec'
+
+SnowyOwl.play
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hanystudy/snowy_owl. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the SnowyOwl project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hanystudy/snowy_owl/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "snowy_owl"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/snowy_owl/config.rb

@@ -0,0 +1,37 @@
+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,
+    ]
+
+    attr_accessor :props_path, :determinations_path, :play_books_path
+    attr_accessor :is_persisting, :is_recovering, :persist_path, :plots_path
+
+    def determine_context key, &determine_block
+      @determine_context ||= {}
+      if block_given?
+        @determine_context[key] = determine_block
+      else
+        @determine_context[key]
+      end
+    end
+
+    def persist_callback &block
+      @persist_callback = block || @persist_callback
+    end
+    
+    def recover_callback &block
+      @recover_callback = block || @recover_callback
+    end
+  end
+end

data/lib/snowy_owl/determinations.rb

@@ -0,0 +1,22 @@
+require 'json'
+require 'ostruct'
+
+module SnowyOwl
+  module Determinations
+
+    def self.determine name, &block
+      SnowyOwl.determine_context SnowyOwl::Support.to_underscore(name).to_sym, &block
+    end
+
+    def method_missing(name, *args, &block)
+      context_key = name.to_s.gsub /determine_/, ''
+      determine_context = SnowyOwl.determine_context context_key.downcase.to_sym
+      if determine_context.nil?
+        super(name, *args, &block)
+      else
+        args.unshift context_key.tr('_', ' ')
+        instance_exec(*args, &determine_context)
+      end
+    end
+  end
+end

data/lib/snowy_owl/persist.rb

@@ -0,0 +1,25 @@
+require 'json'
+require 'ostruct'
+require 'fileutils'
+
+module SnowyOwl
+  module Persist
+
+    class << self
+      def persist_state(plot_name)
+        plot_name_path = SnowyOwl::Support.to_underscore plot_name
+        path = SnowyOwl.persist_path + '/.tmp/' + plot_name_path
+        FileUtils::mkdir_p path
+        args = [plot_name_path, 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, path]
+        SnowyOwl.recover_callback.call(args)
+      end
+    end
+  end
+end

data/lib/snowy_owl/plots.rb

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

data/lib/snowy_owl/props.rb

@@ -0,0 +1,25 @@
+require 'json'
+require 'ostruct'
+require 'yaml'
+
+module SnowyOwl
+  module Props
+
+    def init_props
+      props_path = SnowyOwl.props_path
+      raise RuntimeError.new 'Invalid props path' if props_path.empty?
+      props_hash = {}
+      Dir[props_path].each do |f|
+        field_name = File.basename f, '.yml'
+        props_hash[field_name] = YAML.load_file(f)
+      end
+      @__props__ = JSON.parse(props_hash.to_json, object_class: OpenStruct)
+    end
+
+    def method_missing(name, *args, &block)
+      @__props__ ||= init_props
+      return @__props__.send name if @__props__.respond_to? name
+      super name, *args, &block
+    end
+  end
+end

data/lib/snowy_owl/rspec/rerun.rb

@@ -0,0 +1,32 @@
+require 'rspec-rerun/tasks'
+
+module RSpec
+  module Rerun
+    class Formatter
+      def retry_command(example)
+        example.description
+      end
+    end
+
+    module Tasks
+      class << self
+        def spec_files
+          File.read(RSpec::Rerun::Formatter::FILENAME)
+        end
+
+        def failing_specs
+          [SnowyOwl.spec_file]
+        end
+
+        def failed_count
+          spec_files.split("\n").count
+        end
+
+        def rerun(args)
+          ENV['PLOTS_SCOPE'] = spec_files
+          Rake::Task['rspec-rerun:rerun'].execute(args)
+        end
+      end
+    end
+  end
+end

data/lib/snowy_owl/rspec.rb

@@ -0,0 +1,52 @@
+require 'snowy_owl/rspec/rerun'
+
+module SnowyOwl
+  class Config
+    alias_options = OPTIONS
+    alias_options << :spec_file
+    remove_const :OPTIONS
+    const_set :OPTIONS, alias_options.uniq
+
+    attr_accessor :spec_file
+  end
+
+  module Plots
+    class << self
+      alias :old_write :write
+
+      def write(plot_name, &block)
+        proc = old_write plot_name, &block
+        RSpec.shared_examples plot_name do
+          scenario plot_name, &proc
+        end
+      end
+    end
+  end
+
+  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
+      end
+
+      candidate_play_books = Dir[SnowyOwl.play_books_path]
+
+      candidate_play_books.each do |play_book|
+        candidate_plots = YAML.load_file(play_book)
+        plots_scope = ENV['PLOTS_SCOPE']
+        if plots_scope.present?
+          SnowyOwl.is_recovering = true
+          scope = plots_scope.split("\n")
+          candidate_plots = candidate_plots.select {|plot| scope.include? plot['plot_name']}
+        end
+        candidate_plots.each do |plot|
+          it_behaves_like plot['plot_name']
+        end
+      end
+    end
+  end
+end

data/lib/snowy_owl/support.rb

@@ -0,0 +1,9 @@
+module SnowyOwl
+  module Support
+    # Avoid conflict with other libraries when using open class for compatibility
+    # refine can be well supported in ruby 2.3.0 and above
+    def self.to_underscore(str)
+      str.downcase.tr(' ', '_')
+    end
+  end
+end

data/lib/snowy_owl/version.rb

@@ -0,0 +1,3 @@
+module SnowyOwl
+  VERSION = "0.1.0"
+end

data/lib/snowy_owl.rb

@@ -0,0 +1,71 @@
+require 'forwardable'
+require 'yaml'
+require 'snowy_owl/support'
+require 'snowy_owl/config'
+
+module SnowyOwl
+  class OwlField
+    def play *args, &block
+      instance_exec *args, &block
+    end
+
+    def sequence_run candidate_play_books
+      candidate_play_books.each do |play_book|
+        candidate_plots = YAML.load_file(play_book)
+        plots_scope = ENV['PLOTS_SCOPE']
+        unless plots_scope.nil?
+          SnowyOwl.is_recovering = true
+          scope = plots_scope.split("\n")
+          candidate_plots = candidate_plots.select {|plot| scope.include? plot['plot_name']}
+        end
+        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
+      end
+    end
+  end
+
+  class << self
+    extend Forwardable
+
+    SnowyOwl::Config::OPTIONS.each do |method|
+      def_delegators :config, "#{method}=" , "#{method}="
+      def_delegators :config, method, method
+    end
+
+    def configure
+      yield self.config
+    end
+
+    def config
+      @config ||= SnowyOwl::Config.new
+    end
+
+    def play
+      owl_field = OwlField.new
+      owl_field.play 'Snowy Owl' do
+        Dir[SnowyOwl.plots_path].each { |f| require f }
+        Dir[SnowyOwl.determinations_path].each { |f| require f }
+        sequence_run Dir[SnowyOwl.play_books_path]
+      end
+    end
+  end
+end
+
+SnowyOwl.configure do |config|
+  config.props_path = ''
+  config.determinations_path = ''
+  config.plots_path = ''
+  config.play_books_path = ''
+  config.is_persisting = false
+  config.is_recovering = false
+  config.persist_path = ''
+end
+
+require 'snowy_owl/persist'
+require 'snowy_owl/plots'
+require 'snowy_owl/props'
+require 'snowy_owl/determinations'

data/snowy_owl.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "snowy_owl/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "snowy_owl"
+  spec.version       = SnowyOwl::VERSION
+  spec.authors       = ["Yi Han"]
+  spec.email         = ["hanystudy@gmail.com"]
+
+  spec.summary       = %q{Owl exploratory testing}
+  spec.homepage      = "https://github.com/hanystudy/snowy_owl"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-rerun", "~> 1.1"
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: snowy_owl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yi Han
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rerun
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: 
+email:
+- hanystudy@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/snowy_owl.rb
+- lib/snowy_owl/config.rb
+- lib/snowy_owl/determinations.rb
+- lib/snowy_owl/persist.rb
+- lib/snowy_owl/plots.rb
+- lib/snowy_owl/props.rb
+- lib/snowy_owl/rspec.rb
+- lib/snowy_owl/rspec/rerun.rb
+- lib/snowy_owl/support.rb
+- lib/snowy_owl/version.rb
+- snowy_owl.gemspec
+homepage: https://github.com/hanystudy/snowy_owl
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Owl exploratory testing
+test_files: []