clash 2.0.2 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aa8e17d2b33bdda371233addd72f726f2ca34a59
-  data.tar.gz: eef3b0704b518e294f8e2dc18a22b7b433a21c04
+  metadata.gz: f038c9d8b4b1cc0df3cb05eb1e66a09bcc33e5d6
+  data.tar.gz: 5ffd37edc3f92f74b9268d2fc9eb827cffc77c76
 SHA512:
-  metadata.gz: e15d52a5b5de0b8c02e635f8fbaa286d83245d787fb063829630b1e64f09867d79edda348e702d80758083a0c75882ca8cccb16edd3c88ef378fe6e1b54862ef
-  data.tar.gz: 7b9c122892998a636f7529b114d0b6cc5eee93f3db10909c88d0463ac75a803b0bee4dff1dcfb4584ea197f5aca2acee8c068a87bb60889345c73d60fcad81db
+  metadata.gz: a79902e390843533618c831035f9c6fd20c9df2a148827b826781b6173c75291cf9a834ca7b531e5b4e058b4c324e0b4dc34d60d998bb60f6c1b30b48e23ae49
+  data.tar.gz: 6a45656ef314abe34543bf54312b7b6404e1dc59f335f9686dbfd5829eb85ed88f17d29f21a8c88cb8f090dccfea77325637c46a47250629e6c78e9b3a1655ac

data/bin/clash

@@ -12,19 +12,28 @@ OptionParser.new do |opts|
 
   if ARGV.first == 'accept'
     options[:accept] = ARGV.shift
+  elsif ARGV.first == 'new' || ARGV.first == 'init'
+    options[:new] = ARGV.shift
+  elsif ARGV.first == 'list'
+    options[:list] = ARGV.shift
   end
 
-  if ARGV.first == 'init'
-    options[:init] = ARGV.shift
-
-    opts.on("-f", "--force", "Overwrite existing content") do |f|
-      options[:force] = f
-    end
+  if !(options[:list] || options[:new] || options[:accept])
+    options[:normal] = true
   end
 
   opts.banner = banner(options)
 
-  if !options[:init] and !options[:accept]
+  if options[:new]
+    opts.on("-t", "--title TITLE", String, "Enter a title for your test (default: \"Test Build\")") do |title|
+      options[:title] = title
+    end
+    opts.on("-d", "--dir SITE_DIR", String, "Enter a directory name for your new test site (default: test-site)") do |dir|
+      options[:dir] = dir
+    end
+  end
+
+  if options[:normal]
     opts.on("-b", "--build", "Build mode: Runs only 'before' and 'build' actions") do |b|
       options[:build_only] = b
     end
@@ -37,21 +46,18 @@ OptionParser.new do |opts|
       options[:trace] = t
     end
 
-    opts.on("-l", "--list", "Print a list of tests' numbers and titles") do |l|
-      options[:list] = l
+    opts.on("-v", "--version", "Show version number") do |v|
+      options[:version] = v
     end
   end
 
-  opts.on("-v", "--version", "Show version number") do |v|
-    options[:version] = v
-  end
-
   opts.on("-h", "--help", "Show this message") do |h|
     options[:help] = opts
   end
 
 end.parse!
 
+
 if options[:version]
   puts "Clash #{Clash::VERSION}"
   abort
@@ -60,17 +66,33 @@ end
 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]
+    elsif options[:list]
+      f.puts list_examples
+    end
+
+    if options[:normal]
       f.puts default_examples
+      f.puts config_info
     end
   end
-elsif options[:init]
-  Clash::Scaffold.new(ARGV, options)
 else
 
+  if options[:new]
+    # Grab path from args if it exists
+    #
+    if !(path = ARGV.join(" ")).empty?
+      options[:path] = path
+    end
+
+    Clash::Scaffold.new(options).add_test
+
+    # List tests bceause that's nice.
+    options[:list] = true
+  end
+
   unless ARGV.empty?
     # Parse input `clash 1 2 3` and `clash 1,2,3` and `clash 1-3` the same
     #

data/lib/clash/help.rb

@@ -1,12 +1,14 @@
 def version_banner
-"Clash #{Clash::VERSION} -- a diff based testing suite for Jekyll."
+"Clash #{Clash::VERSION} -- a diff based testing suite for Jekyll sites and plugins."
 end
 
 def banner(options)
-  banner = if options[:init]
-    init_banner
+  banner = if options[:new]
+    new_banner
   elsif options[:accept]
     accept_banner
+  elsif options[:list]
+    list_banner
   else
     default_banner
   end
@@ -17,20 +19,34 @@ 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
+  $ clash [path] [tests] [options]          # Run tests
+  $ clash list [path] [tests] [options]     # Print a list of tests
+  $ clash accept [path] [tests] [options]   # Accept build: overwrite expected files with build files
+  $ clash new [path] [options]              # Add a new testing scaffold
 
 Options:
 BANNER
 end
 
-def init_banner
+def new_banner
 <<-BANNER
-Add testing scaffold.
+Add a new testing scaffold or a new test site to your existing test suite.
 
 Usage:
-  $ clash init PATH [options]
+  $ clash new [path] [options]
+
+Note: path defaults to `./test`.
+
+Options:
+BANNER
+end
+
+def list_banner
+<<-BANNER
+Print a list of test numbers and titles
+
+Usage:
+  $ clash list [path] [tests] [options]
 
 Options:
 BANNER
@@ -41,7 +57,7 @@ def accept_banner
 This accepts a build, overwriting expected files with build files.
 
 Usage:
-  $ clash accept [dir] [tests] [options]
+  $ clash accept [path] [tests] [options]
 
 Options:
 BANNER
@@ -64,6 +80,23 @@ Examples:
 EXAMPLES
 end
 
+def list_examples
+<<-EXAMPLES
+
+Examples:
+  To run only specific tests, pass test numbers separated by commas.
+
+    $ clash list           # List all tests
+    $ clash list 1         # List only the first test
+    $ clash list 2,3       # List the second and third tests
+    $ clash list 2-4       # List the second, third, and fourth tests
+    $ clash list :10       # List the test on line 10
+    $ clash list :10-:35   # List all tests from line 10 to 35
+    $ clash list awesome   # List all tests in the 'awesome' directory, reading awesome/_clash.yml.
+    $ clash list awesome 1 # List the first test in the 'awesome' directory.
+EXAMPLES
+end
+
 def accept_examples
 <<-EXAMPLES
 

data/lib/clash/scaffold.rb

@@ -2,32 +2,98 @@ module Clash
   class Scaffold
     attr_accessor :options
 
-    def initialize(args, options = {})
-      raise 'You must specify a path.' if args.empty?
+    def initialize(options = {})
+      @options = {
+        path: 'test',
+        title: 'Test Build',
+        dir: 'test-site',
+        force: false
+      }.merge(options)
 
-      test_path = File.expand_path(args.join(" "), Dir.pwd)
-      FileUtils.mkdir_p test_path
-      if preserve_source_location?(test_path, options)
-        abort "Conflict: #{test_path} exists and is not empty."
+      @options[:path] = File.expand_path(@options[:path], Dir.pwd)
+    end
+
+    def add_test
+      config = File.join(@options[:path], '_clash.yml')
+
+      prevent_dir_name_collisions
+      content = test_content
+
+      if !File.exist?(config)
+        content.lstrip!
       end
 
-      add_test_scaffold test_path
+      path = File.join(@options[:path], @options[:dir])
+
+      FileUtils.mkdir_p path
+      FileUtils.cp_r test_template + '/.', path
+
 
-      puts "Clash test added to #{test_path}."
+      File.open(config, 'a') do |f|
+        f.write content
+      end
+      
+      puts "New Clash test added to " + @options[:path].yellow
+      print_test_files(path)
+      puts "Tests:"
     end
 
-    def add_test_scaffold(path)
-      FileUtils.cp_r test_template + '/.', path
+    private
+
+    def print_test_files(path)
+      FileUtils.cd path do
+        files = Dir['**/*']
+        files.map! { |f|
+          if f.match /\//
+            f.gsub!(/[^\/]+\//, '  ')
+          end
+          if File.directory?(f)
+            f += '/'
+          end
+          "+    #{f}"
+        }
+        puts "\n+  #{@options[:dir]}/\n#{files.join("\n")}\n".green
+      end
     end
 
     def test_template
-      File.expand_path("../../scaffold", File.dirname(__FILE__))
+      File.expand_path("../../scaffold/site", File.dirname(__FILE__))
     end
 
-    private
+    # If necessary append a number to directory to avoid directory collision
+    #
+    def prevent_dir_name_collisions
+      
+      # Find directories beginning with test directory name
+      #
+      dirs = Dir.glob("#{@options[:path]}/*").select { |d|
+        File.directory?(d) && d.match(/#{@options[:dir]}($|-\d+$)/)
+      }.size
+
+      # If matching directories are found, increment the dir name
+      # e.g. "test-site-2"
+      #
+      if dirs > 0
+        @options[:dir] << "-#{dirs += 1}"
+      end
+    end
+
+    def preserve_source_location?
+      !@options[:force] && !Dir["#{@options[:path]}/**/*"].empty?
+    end
+
+    def dasherize(string)
+      string.gsub(/ /,'-').gsub(/[^\w-]/,'').gsub(/-{2,}/,'-').downcase
+    end
 
-    def preserve_source_location?(path, options)
-      !options[:force] && !Dir["#{path}/**/*"].empty?
+    def test_content
+%Q{
+- 
+  title: "#{@options[:title]}"
+  dir: #{@options[:dir]}
+  build: true
+  compare: _expected _site
+}
     end
   end
 end

data/lib/clash/version.rb

@@ -1,3 +1,3 @@
 module Clash
-  VERSION = "2.0.2"
+  VERSION = "2.2.0"
 end

data/scaffold/site/_config.yml

@@ -1,4 +1,3 @@
 name: Test site
-gems: []
 timezone: UTC
-markdown: redcarpet
+gems: []

data/scaffold/site/_layouts/default.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8"> 
+</head>
+<body>
+<div class='site'>{{ content }}</div>
+</body>
+</html>

data/scaffold/site/index.html

@@ -1,4 +1,5 @@
 ---
+layout: default
 ---
 
 Test content

data/{scaffold → test/test-scaffold}/_clash.yml

@@ -1,5 +1,5 @@
 - 
-  title: Test Build
-  dir: site
+  title: "Test Build"
+  dir: test-site
   build: true
   compare: _expected _site

data/test/test-scaffold/test-site/_config.yml

@@ -0,0 +1,3 @@
+name: Test site
+timezone: UTC
+gems: []

data/test/test-scaffold/test-site/_expected/index.html

@@ -0,0 +1 @@
+Test content

data/test/test-scaffold/test-site/_layouts/default.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+<meta charset="utf-8"> 
+</head>
+<body>
+<div class='site'>{{ content }}</div>
+</body>
+</html>

data/test/test-scaffold/test-site/index.html

@@ -0,0 +1,5 @@
+---
+layout: default
+---
+
+Test content

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clash
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.2.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -125,10 +125,15 @@ files:
 - lib/clash/test.rb
 - lib/clash/tests.rb
 - lib/clash/version.rb
-- scaffold/_clash.yml
 - scaffold/site/_config.yml
 - scaffold/site/_expected/index.html
+- scaffold/site/_layouts/default.html
 - scaffold/site/index.html
+- test/test-scaffold/_clash.yml
+- test/test-scaffold/test-site/_config.yml
+- test/test-scaffold/test-site/_expected/index.html
+- test/test-scaffold/test-site/_layouts/default.html
+- test/test-scaffold/test-site/index.html
 homepage: https://github.com/imathis/clash
 licenses:
 - MIT