clash 1.4.1 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b7b82b5cd0a85820950dd5c99efd17b691ccf03
-  data.tar.gz: 64531edccef8ecddf75f0e1213e21b9b5d707029
+  metadata.gz: 39d92dbce4ec886753820de001ead65ecc70c7ab
+  data.tar.gz: 5bf66afe83d476c95eb86698958e6433253b612c
 SHA512:
-  metadata.gz: 9d92cafe484dca27c591d2baa9efd779b72e2d5acd77244fb7f7c23b8896a9dc5ca43b464cd949aa96fe01cac48333646afa694af6a38e7a2c5e92413e6cdc45
-  data.tar.gz: 6a5db7204b32c9ad95c5fb2346063feaf1e9c8afbc5f3a446e59402c246425947a3b24c6d1e845b1d57c9a7fc3d728b520b0eb5cc13dc2e514fcd79c769208a4
+  metadata.gz: 7997bbf948e49ec53adf60f533f123f53aca55e337fcfa6025f653901ea7a62c99694a0a629b541d1642a3a3facd706e999a54662b40fc6d25ac390e4ea1186e
+  data.tar.gz: bc012514d2a41d416ee165f6eaea817ad0b624d8a89ff4eac74587b534f40ba62aa909b2c529e082568f6090af04969edf61c40951269a3046aca14c96a0d698

data/bin/clash

@@ -11,16 +11,22 @@ 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 test   # Compare files in the 'test' directory
-    $ 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 test 1 # Run the first test in the 'test' directory.
+    $ 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:
 
@@ -40,20 +46,32 @@ CONFIG
 OptionParser.new do |opts|
   opts.banner = banner
 
-  opts.on("-f FILE", "--file FILE", "Use a specific test file (default: [PATH]/.clash.yml)") do |f|
-    options[:file] = f
-  end
+  if ARGV.first == 'init'
+    options[:init] = ARGV.shift
 
-  opts.on("-c", "--context NUMBER", Integer, "On diff errors, show NUMBER of lines of surrounding context (default: 2)") do |context|
-    options[:context] = context
-  end
+    opts.on("-f", "--force", "Overwrite existing content") do |f|
+      options[:force] = f
+    end
+  else
+    opts.on("-b", "--build", "Build mode: Runs only 'before' and 'build' actions.") do |b|
+      options[:build_only] = b
+    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
+
+    opts.on("-c", "--context NUMBER", Integer, "On diff errors, show NUMBER of lines of surrounding context (default: 2)") do |context|
+      options[:context] = context
+    end
 
-  opts.on("-d", "--debug", "Display output from system commands") do |d|
-    options[:debug] = d
+    opts.on("-l", "--list", "Print a list of tests' numbers and titles") do |l|
+      options[:list] = l
+    end
+
+    opts.on("-d", "--debug", "Display output from system commands") do |d|
+      options[:debug] = d
+    end
   end
 
   opts.on("-h", "--help", "Show this message") do |h|
@@ -64,15 +82,19 @@ OptionParser.new do |opts|
 
 end.parse!
 
-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[:only] = Clash::Helpers.expand_list_of_numbers ARGV
-end
+if options[:init]
+  Clash::Scaffold.new(ARGV, options)
+elsif !options[:help]
+
+  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[:only] = ARGV
+  end
 
-unless options[:help]
   tests = Clash::Tests.new(options)
+
   if options[:list]
     tests.list
   else

data/lib/clash.rb

@@ -5,17 +5,18 @@ require 'safe_yaml'
 require 'diffy'
 
 module Clash
-  autoload :Tests,   'clash/tests'
-  autoload :Test,    'clash/test'
-  autoload :Diff,    'clash/diff'
-  autoload :Helpers, 'clash/helpers'
+  autoload :Tests,    'clash/tests'
+  autoload :Test,     'clash/test'
+  autoload :Diff,     'clash/diff'
+  autoload :Helpers,  'clash/helpers'
+  autoload :Scaffold, 'clash/scaffold'
 end
 
 if defined? Octopress::Docs
   Octopress::Docs.add({
     name:        "Clash",
     gem:         "clash",
-    description: "A super simple testing framework for static sites.",
+    description: "Clash is an integration test framework designed for Jekyll developers",
     path:        File.expand_path(File.join(File.dirname(__FILE__), "../")),
     source_url:  "https://github.com/imathis/clash",
     version:     Clash::VERSION

data/lib/clash/helpers.rb

@@ -7,20 +7,62 @@ module Clash
       if only.is_a?(Array)
         only = only.join(',')
       end
-      only.split(',').map do |n|
-        if n.include?("-")
-          expand_range(n)
+      only.split(',').map do |num|
+        if num.include?("-")
+          expand_range(num)
         else
-          n.to_i
+          get_number(num)
         end
       end.flatten.sort.uniq
     end
 
     def expand_range(string_range)
-      lower, upper = string_range.split("-").map(&:to_i).take(2).sort
+      lower, upper = string_range.split("-").map{|n| get_number(n)}.take(2).sort
       Array.new(upper+1 - lower).fill { |i| i + lower }
     end
 
+    def get_number(num)
+      if num.start_with?(':')
+        test_at_line_number(num)
+      else
+        num.to_i
+      end
+    end
+
+    def read_test_line_numbers(path)
+      @test_lines ||= []
+      count = 1
+      strip_tasks(File.read(path)).each_line do |line|
+        @test_lines << count if line =~ /^-/
+        count += 1
+      end
+    end
+
+    def strip_tasks(content)
+      content.gsub(/-\s+tasks:.+?^-/im) do |match|
+        match.gsub(/.+?\n/,"\n")
+      end
+    end
+
+    def test_at_line_number(line_number)
+      ln = line_number.sub(':', '').to_i
+      test_number = nil
+      lines = @test_lines
+      lines.each_with_index do |line, index|
+        last = index == lines.size - 1
+
+        if line <= ln && ( last || ln <= lines[index + 1] )
+          test_number = index + 1
+        end
+      end
+
+      if test_number
+        test_number
+      else
+        puts "No test found on line #{ln}"
+      end
+    end
+
     def default_array(option)
       o = option || []
       o = [o] unless o.is_a?(Array)
@@ -40,7 +82,7 @@ module Clash
       # Don't ouput to /dev/null if in debug mode
       # or if a command supplies its own ouput
       if !ENV['DEBUG'] && !(cmd =~ / > /)
-        cmd += " > /dev/null"
+        cmd << " > /dev/null"
       end
 
       Kernel.system cmd

data/lib/clash/scaffold.rb

@@ -0,0 +1,33 @@
+module Clash
+  class Scaffold
+    attr_accessor :options
+
+    def initialize(args, options = {})
+      raise 'You must specify a path.' if args.empty?
+
+      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."
+      end
+
+      add_test_scaffold test_path
+
+      puts "Clash test added to #{test_path}."
+    end
+
+    def add_test_scaffold(path)
+      FileUtils.cp_r test_template + '/.', path
+    end
+
+    def test_template
+      File.expand_path("../../scaffold", File.dirname(__FILE__))
+    end
+
+    private
+
+    def preserve_source_location?(path, options)
+      !options[:force] && !Dir["#{path}/**/*"].empty?
+    end
+  end
+end

data/lib/clash/test.rb

@@ -8,27 +8,30 @@ module Clash
       @test_failures = []
       @options  = options
       @options['config'] ||= {}
+      @options['dir'] ||= '.'
       @cleanup = []
     end
 
     def run
-      system_cmd(@options['before'])
-      config
-      build if @options['build']
-      compare
-      enforce_missing
-      system_cmd(@options['after'])
-      cleanup_config
+      Dir.chdir(@options['dir']) do
+        system_cmd(@options['before'])
+        config
+        build if @options['build']
+        unless @options['build_only']
+          compare
+          enforce_missing
+          system_cmd(@options['after'])
+        end
+        cleanup_config
+      end
       print_result
       results
     end
 
     def config
       @options['config'].each do |name, file|
-        case name
-        when 'jekyll' then next
-        when 'octopress' then config_octopress(file)
-        else config_plugin(name, file)
+        if name != 'jekyll'
+          config_plugin(name, file)
         end
       end
     end
@@ -70,12 +73,13 @@ module Clash
     end
 
     def build
+      options = "--trace"
+
       if jekyll_config = @options['config']['jekyll']
-        configs = default_array(jekyll_config).join(',')
-        system("jekyll build --trace --config #{configs}")
-      else
-        system("jekyll build --trace")
+        options << " --config #{default_array(jekyll_config).join(',')}"
       end
+
+      system "jekyll build #{options}"
     end
 
     def system_cmd(cmds)

data/lib/clash/tests.rb

@@ -21,14 +21,15 @@ module Clash
       @options[:only]    ||= []
       @options[:exit]    ||= true
       @options[:path]    ||= '.'
-      @options[:file]    ||= '.clash.yml'
+      @options[:file]    ||= '_clash.yml'
 
+      @clashfile = read_config
       @tests = read_tests
     end
 
     def list
       @tests.each_with_index do |options, index|
-        # If tests are limited, only run specified tests
+        # If tests are limited, only show specified tests
         #
         next if options.nil?
         list_test(options, index)
@@ -42,7 +43,6 @@ module Clash
     end
 
     def run
-
       Dir.chdir(@options[:path]) do
         @tests.each_with_index do |options, index|
           # If tests are limited, only run specified tests
@@ -60,6 +60,7 @@ module Clash
       options['index'] = index + 1
       options['context'] = @options[:context]
       options['tasks'] = @tasks
+      options['build_only'] = @options[:build_only]
 
       results = Test.new(options).run
 
@@ -72,12 +73,11 @@ module Clash
     end
 
     def read_tests
-      return [] unless File.file?(@options[:file])
-      tests = SafeYAML.load_file(@options[:file])
       index = 0
       delete_tests = []
+      @options[:only] = expand_list_of_numbers(@options[:only])
 
-      tests = default_array(tests).map do |test|
+      tests = default_array(@clashfile).map do |test|
         if !test['tasks'].nil?
           @tasks.merge! test['tasks']
           delete_tests << test
@@ -100,6 +100,30 @@ module Clash
 
     end
 
+    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)
+        SafeYAML.load_file(path)
+      else
+        # If config file still not found, complain
+        raise "Config file #{@options[:file]} not found."
+      end
+    end
+
+    def config_path(file=nil)
+      file ||= @options[:file]
+      path = File.join('./', @options[:path])
+      paths = []
+
+      (path.count('/') + 1).times do
+        paths << File.join(path, file)
+        path.sub!(/\/[^\/]+$/, '')
+      end
+
+      paths.find {|p| File.file?(p) }
+    end
+
     def print_results
 
 

data/lib/clash/version.rb

@@ -1,3 +1,3 @@
 module Clash
-  VERSION = "1.4.1"
+  VERSION = "1.5.0"
 end

data/scaffold/_clash.yml

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

data/scaffold/site/_config.yml

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

data/scaffold/site/_expected/index.html

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

data/scaffold/site/index.html

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clash
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.5.0
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-10 00:00:00.000000000 Z
+date: 2015-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -120,9 +120,14 @@ files:
 - lib/clash.rb
 - lib/clash/diff.rb
 - lib/clash/helpers.rb
+- lib/clash/scaffold.rb
 - 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/index.html
 homepage: https://github.com/imathis/clash
 licenses:
 - MIT