clash 1.6.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c03aaafb33c3668c4f61af1da5d246441686254
-  data.tar.gz: 3fa8e1338d51c83468718718464cb5b9feb5b3e8
+  metadata.gz: 7578dd8975d4a2863c507063edeeb8c6e81b6947
+  data.tar.gz: 962ab2b1352c0d12cc081eea1cf7f99bca702659
 SHA512:
-  metadata.gz: 42b3f13aa63fd678d7bf2301dfc7eed12e18d1b237a8a78bfa8e57b37998c8c488d262d1f407f961c079bf2f320461b8860991573f6ad85628f0e0a044bd7aee
-  data.tar.gz: ccafd711ab65b82d79900cb43b482c5981e8a643ad449b6fab2c20c99258c053d71f24996080d9aa76919760e8c31af311d7c77d3fcbbe953cd386c917df0f84
+  metadata.gz: 72c7df0ac47463d509b9e86fcd6a3972ca62b4a2dc56e9de835b0fe683f2159dbc6f03c09a2096258040d2b8ea3ab63e4543482a4eb9a10757906ec862a49cb4
+  data.tar.gz: 79727676a8ff21a233e9d0e61536bf0c60cf8f8d54bcf672c8fb268a51bdc2391b3413f1b5f2a474258275b7e1e468eea1d18b4c72aa9c8d7bce35e6f3581a8b

data/bin/clash

@@ -3,48 +3,16 @@
 $LOAD_PATH.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
 
 require 'clash'
+require 'clash/help'
 require 'optparse'
 
 options = {}
 
-banner = <<-BANNER
-clash #{Clash::VERSION} -- Clash is a diff based testing suite for static sites.
-
-Usage:
-  # Run tests
-  clash [path] [tests] [options]
-
-  To run only specific tests, pass test numbers separated by commas.
-
-    $ clash           # Run all tests
-    $ clash 1         # Run only the first test
-    $ clash 2,3       # Run the second and third tests
-    $ clash 2-4       # Run the second, third, and fourth tests
-    $ clash :10       # Run the test on line 10
-    $ clash :10-:35   # Run all tests from line 10 to 35
-    $ clash test      # Run all tests in the 'test' directory, reading test/_clash.yml.
-    $ clash test 1    # Run the first test in the 'test' directory.
-  
-  # Add testing scaffold
-  clash init [path] [options]
-
-Options:
-
-BANNER
-
-config_info = <<-CONFIG
-
-Configuration:
-
-  Clash reads its configuration from a .clash.yml file in the root of your project. Use the --file
-  option to choose a different configuration file.
-
-  View the README or visit https://github.com/imathis/clash for configuration info.
-
-CONFIG
-
 OptionParser.new do |opts|
-  opts.banner = banner
+
+  if ARGV.first == 'accept'
+    options[:accept] = ARGV.shift
+  end
 
   if ARGV.first == 'init'
     options[:init] = ARGV.shift
@@ -52,12 +20,12 @@ OptionParser.new do |opts|
     opts.on("-f", "--force", "Overwrite existing content") do |f|
       options[:force] = f
     end
-  else
-    opts.on("-a", "--accept", "Accept failure: Copy test(s) build to expected path.") do |a|
-      options[:accept] = a
-    end
+  end
+
+  opts.banner = banner(options)
 
-    opts.on("-b", "--build", "Build mode: Runs only 'before' and 'build' actions.") do |b|
+  if !options[:init] and !options[:accept]
+    opts.on("-b", "--build", "Build mode: Runs only 'before' and 'build' actions") do |b|
       options[:build_only] = b
     end
 
@@ -65,36 +33,39 @@ OptionParser.new do |opts|
       options[:context] = context
     end
 
-    opts.on("-d", "--debug", "Display output from system commands") do |d|
-      options[:debug] = d
+    opts.on("-t", "--trace", "Display output while running tests") do |t|
+      options[:trace] = t
     end
 
     opts.on("-l", "--list", "Print a list of tests' numbers and titles") do |l|
       options[:list] = l
     end
-
-    opts.on("-f FILE", "--file FILE", "Use a specific test file (default: [PATH]/.clash.yml)") do |f|
-      options[:file] = f
-    end
-
   end
 
   opts.on("-h", "--help", "Show this message") do |h|
-    puts opts
-    puts config_info
-    options[:help] = h
+    options[:help] = opts
   end
 
 end.parse!
 
-if options[:init]
+if options[:help]
+  IO.popen("less", "w") do |f| 
+    f.puts options[:help]
+    f.puts config_info
+    if options[:accept]
+      f.puts accept_examples
+    elsif !options[:init]
+      f.puts default_examples
+    end
+  end
+elsif options[:init]
   Clash::Scaffold.new(ARGV, options)
-elsif !options[:help]
+else
 
   unless ARGV.empty?
     # Parse input `clash 1 2 3` and `clash 1,2,3` and `clash 1-3` the same
     #
-    options[:path] = ARGV.shift if ARGV.first =~ /^[^\d:].+/
+    options[:dir]  = ARGV.shift if ARGV.first =~ /^[^\d:].+/
     options[:only] = ARGV
   end
 

data/lib/clash/help.rb

@@ -0,0 +1,110 @@
+def version_banner
+"Clash #{Clash::VERSION} -- a diff based testing suite for Jekyll."
+end
+
+def banner(options)
+  banner = if options[:init]
+    init_banner
+  elsif options[:accept]
+    accept_banner
+  else
+    default_banner
+  end
+
+  "#{version_banner}\n\n#{banner}"
+end
+
+def default_banner
+<<-BANNER
+Usage:
+  $ clash [dir] [tests] [options]          # Run tests
+  $ clash accept [dir] [tests] [options]   # Accept build: overwrite expected files with build files
+  $ clash init PATH [options]              # Add testing scaffold
+
+Options:
+BANNER
+end
+
+def init_banner
+<<-BANNER
+Add testing scaffold.
+
+Usage:
+  $ clash init PATH [options]
+
+Options:
+BANNER
+end
+
+def accept_banner
+<<-BANNER
+This accepts a build, overwriting expected files with build files.
+
+Usage:
+  $ clash accept [dir] [tests] [options]
+
+Options:
+BANNER
+end
+
+def default_examples
+<<-EXAMPLES
+
+Examples:
+  To run only specific tests, pass test numbers separated by commas.
+
+    $ clash           # Run all tests
+    $ clash 1         # Run only the first test
+    $ clash 2,3       # Run the second and third tests
+    $ clash 2-4       # Run the second, third, and fourth tests
+    $ clash :10       # Run the test on line 10
+    $ clash :10-:35   # Run all tests from line 10 to 35
+    $ clash awesome   # Run all tests in the 'awesome' directory, reading awesome/_clash.yml.
+    $ clash awesome 1 # Run the first test in the 'awesome' directory.
+EXAMPLES
+end
+
+def accept_examples
+<<-EXAMPLES
+
+Examples:
+  To run only specific tests, pass test numbers separated by commas.
+
+    $ clash accept           # Accept all test builds
+    $ clash accept 1         # Accept build from test 1
+    $ clash accept 2,3       # Accept builds from tests 2 and 3
+    $ clash accept :10       # Accept build from test on line 10
+    $ clash accept :10-:35   # Accept builds from tests on line 10 through 35
+    $ clash accept awesome 1 # Accept the first build from tests in the awesome dir
+EXAMPLES
+end
+
+def config_info
+<<-CONFIG_INFO
+
+Configuration:
+  Clash loads tests from a _clash.yml file in the current directory or the './test' directory if not found.
+  A simple clash file with one test might look like this:
+
+    title: Test Build           # Name for your test
+    dir: site                   # Dir containing your Jekyll test site
+    build: true                 # Run Jekyll build
+    compare: _expected _site    # Compare the contents of _expected/ to _site/
+
+  A clash test can be configured with the following options. Each of these is optional.
+
+  | Option           | Type           | Description                                                |
+  |:-----------------|:---------------|:-----------------------------------------------------------|
+  | title            | String         | A descriptive name for the test                            |
+  | dir              | String         | Scope tests to this directory.                             |
+  | before           | String/Array   | Run system command(s) before running tests.                |
+  | build            | Boolean        | Build the site with Jekyll.                                |
+  | config           | Hash           | Configure Jekyll, Octopress Ink plugins. (Info below)      |
+  | compare          | String/Array   | Compare files or directories. Format: "_expected _site"    |
+  | after            | String/Array   | Run system command(s) after running tests.                 |
+  | enforce_missing  | String/Array   | Ensure that these files are not found.                     |
+  
+  View the README or visit https://github.com/imathis/clash to learn about configuration clash tests.
+
+CONFIG_INFO
+end

data/lib/clash/helpers.rb

@@ -73,9 +73,9 @@ module Clash
 
     def system(*cmd)
       cmd = cmd.join(' ')
-      # Don't ouput to /dev/null if in debug mode
+      # Don't ouput to /dev/null if in trace mode
       # or if a command supplies its own ouput
-      if !ENV['DEBUG'] && !(cmd =~ / > /)
+      if !ENV['TRACE'] && !(cmd =~ / > /)
         cmd << " > /dev/null"
       end
 

data/lib/clash/tests.rb

@@ -9,8 +9,8 @@ module Clash
 
       ENV['JEKYLL_ENV'] = 'test'
 
-      if @options[:debug]
-        ENV['DEBUG'] = 'true'
+      if @options[:trace]
+        ENV['TRACE'] = 'true'
       end
 
       @results = []
@@ -20,7 +20,7 @@ module Clash
 
       @options[:only]    ||= []
       @options[:exit]    ||= true
-      @options[:path]    ||= '.'
+      @options[:dir]     ||= '.'
       @options[:file]    ||= '_clash.yml'
 
       @clashfile = read_config
@@ -43,7 +43,7 @@ module Clash
     end
 
     def run
-      Dir.chdir(@options[:path]) do
+      Dir.chdir(@options[:dir]) do
         @tests.each_with_index do |options, index|
           # If tests are limited, only run specified tests
           #
@@ -56,7 +56,7 @@ module Clash
     end
 
     def accept
-      Dir.chdir(@options[:path]) do
+      Dir.chdir(@options[:dir]) do
         @tests.each_with_index do |options, index|
           # If tests are limited, only run specified tests
           #
@@ -114,6 +114,7 @@ module Clash
     def read_config
       # Find the config file (fall back to legacy filename)
       if path = config_path || config_path('.clash.yml')
+
         read_test_line_numbers(path)
         config = SafeYAML.load_file(path)
         config = [config] unless config.is_a?(Array)
@@ -126,15 +127,27 @@ module Clash
 
     def config_path(file=nil)
       file ||= @options[:file]
-      path = File.join('./', @options[:path])
+      path = File.join('./', @options[:dir])
       paths = []
 
+      # By default search for clash config in the test directory.
+      default_path = "test/_clash.yml"
+
+      # Walk up the directory tree looking for a clash file.
       (path.count('/') + 1).times do
         paths << File.join(path, file)
         path.sub!(/\/[^\/]+$/, '')
       end
 
-      paths.find {|p| File.file?(p) }
+      path = paths.find {|p| File.file?(p) }
+
+      # If path wasn't found, try default path
+      if !path && File.file?(default_path)
+        @options[:dir] = File.dirname(default_path)
+        path = default_path
+      end
+
+      path
     end
 
     def print_results

data/lib/clash/version.rb

@@ -1,3 +1,3 @@
 module Clash
-  VERSION = "1.6.1"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clash
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-05 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -119,6 +119,7 @@ files:
 - bin/clash
 - lib/clash.rb
 - lib/clash/diff.rb
+- lib/clash/help.rb
 - lib/clash/helpers.rb
 - lib/clash/scaffold.rb
 - lib/clash/test.rb