clash 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e086e99ba358f5f3e581e62126580da77445d4f
-  data.tar.gz: 783c022e86eea8404dec8bd3c221e2937597650d
+  metadata.gz: 9a969d31ec8e0bcf1c77d5e833a0c26c64d64943
+  data.tar.gz: 74eb10c9644a5dd2fbcfe0850bdfa535cb669ed8
 SHA512:
-  metadata.gz: f84d11e79801cc332e17c3568afb05d0911343b7ba4bae19c4a94db62ae5fdc6f515c2d2433b110259f5366c6cca2cbb1964b3ecf9391a1d92c7b63a167f1a5a
-  data.tar.gz: b0110c3bafcbd65872f03c087d190a43cdf5e35c3de3d2a1e5e2394d0fdb47dd83a5e0f6bf82d3e9214611e315c095b249bccea4aa9ccdf159636ba2261a0491
+  metadata.gz: aa5e1e84f305381673abfbb14796d040306910af540af05439eee4a21d85dd75afaa8c6e549ef9457043f67b1d2bfe579394714676196f3f852d68d05ce9ce7c
+  data.tar.gz: 7a312c1e095626a8a984cac7503340c0e46376656bb4a3e92b12bd44522c6ca76ac3d6f8ec83930460a24d568110e72693a8736ce4936e6bfe696a7e4f1a1ec6

data/README.md

@@ -18,7 +18,94 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+clash [test(s)] [options]
+```
+
+To run only specific tests, pass test numbers separated by commas.
+
+```
+$ clash 1     # run only the first test
+$ clash 2,3   # run the second and third tests
+```
+
+### CLI options
+  
+```
+-f, --file    FILE      Use a specific test file (default: .clash.yml)
+-c, --context NUMBER    On diff errors, show NUMBER of lines of surrounding context (default: 2)
+-h, --help              show this message
+```
+
+## 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.
+
+Simple configuration:
+Clash will build the site with Jekyll, and compare the contents of _site/ to expected/.
+
+```
+build: true
+compare: _site, expected
+```
+
+### Configuration options
+
+| Option           | Type           | Description                                              |
+|:-----------------|:---------------|:---------------------------------------------------------|
+| name             | String         | Include a descriptive name with test output.             |
+| before           | String/Array   | Run system command(s) before running tests.              |
+| build            | Boolean        | Build the site with Jekyll.                              |
+| config           | Hash           | Configure Jekyll, Octopress or Ink plugins. (Info below) |
+| compare          | String/Array   | Compare files or directories. e.g. "a.md, b.md"          |
+| enforce_missing  | String/Array   | Ensure that these files are not found.                   |
+| after            | String/Array   | Run system command(s) after running tests.               |
+
+Note: in the table above, String/Array means a single argument can be a string, but mutliples
+can be passed as an array. For example:
+
+```yaml
+compare: _site, expected                      # Compare two directories
+compare:                                      # Compare mutiple items
+  - _site/index.html, expected/index.html
+  - _site/atom.xml, expected/atom.xml
+  - _site/posts, expected/posts
+```
+
+To run multiple tests each test should be an array, for example:
+
+```
+-
+  name: Check site build
+  build: true
+  compare: _site, _expected
+-
+  name: Check asset compression
+  compare: _cdn_build, _cdn_expected
+```
+
+Note: When running multiple tests, adding a name can help the reading of test failures.
+
+### Configuring Jekyll, Octopress and Octopress Ink plugins
+
+```
+build: true
+config:
+  jekyll:    
+    - _configs/config.yml
+    - _configs/test1.yml
+  octopress: _configs/octopress.yml
+  feed:      _configs/feed.yml
+```
+
+In this example:
+
+- Jekyll will build with `--config _configs/config.yml,_configs/test1.yml`
+- _configs/octopress.yml will be copied to ./_octopress.yml (and removed after tests)
+- _configs/feed.yml will be copied to ./_plugins/feed/config.yml (and removed after tests)
+
+This will not overwrite existing files as they will be backed up an restored after tests.
 
 ## Contributing
 

data/bin/clash

@@ -0,0 +1,117 @@
+#! /usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
+
+require 'clash'
+require 'optparse'
+
+options = {}
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: clash [options]"
+
+  opts.on("-f FILE", "--file FILE", "Set test file (default: .clash.yml).") do |f|
+    options[:file] = f
+  end
+
+  opts.on("-c", "--context NUMBER", Integer, "Number of lines of context on a diff") do |context|
+    options[:context] = context
+  end
+
+  opts.on("-h", "--help", "Show help message") do |h|
+    options[:help] = h
+  end
+
+end.parse!
+
+if !ARGV.empty?
+  # Parse input `clash 1 2 3` and `clash 1,2,3` the same
+  #
+  options[:only] = ARGV.join(',').split(',').map{ |n| n.to_i }
+end
+
+if options[:help]
+  puts <<-HELP
+clash #{Clash::VERSION} -- Clash is a diff based testing suite for static sites.
+
+Usage:
+
+  clash [test(s)] [options]
+
+  To run only specific tests, pass test numbers separated by commas.
+
+    `clash 1`   # run only the first test
+    `clash 2,3` # run the second and third tests
+
+Options:
+  
+  -f, --file    FILE      Use a specific test file (default: .clash.yml)
+  -c, --context NUMBER    On diff errors, show NUMBER of lines of surrounding context (default: 2)
+  -h, --help              show this message
+
+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.
+
+  Simple configuration:
+  Clash will build the site with Jekyll, and compare the contents of _site/ to expected/.
+
+    build: true
+    compare: _site, expected
+
+  Full configuration:
+
+  | Option           | Type           | Description                                              |
+  |:-----------------|:---------------|:---------------------------------------------------------|
+  | before           | String/Array   | Run system command(s) before running tests.              |
+  | build            | Boolean        | Build the site with Jekyll.                              |
+  | config           | Hash           | Configure Jekyll, Octopress or Ink plugins. (Info below) |
+  | compare          | String/Array   | Compare files or directories. e.g. "a.md, b.md"          |
+  | enforce_missing  | String/Array   | Ensure that these files are not found.                   |
+  | after            | String/Array   | Run system command(s) after running tests.               |
+
+  Note: in the table above, String/Array means a single argument can be a string, but mutliples
+  can be passed as an array. For example:
+
+    compare: _site, expected                      # Compare two directories
+    compare:                                      # Compare mutiple items
+      - _site/index.html, expected/index.html
+      - _site/atom.xml, expected/atom.xml
+      - _site/posts, expected/posts
+
+
+  To run multiple tests each test should be an array, for example:
+
+    -
+      name: Check site build
+      build: true
+      compare: _site, _expected
+    -
+      name: Check asset compression
+      compare: _cdn_build, _cdn_expected
+
+  Note: When running multiple tests, adding a name can help the reading of test failures.
+
+
+  Configuring Jekyll, Octopress and Octopress Ink plugins:
+
+    build: true
+    config:
+      jekyll:    
+        - _configs/config.yml
+        - _configs/test1.yml
+      octopress: _configs/octopress.yml
+      feed:      _configs/feed.yml
+
+    In this example:
+
+      - Jekyll will build with `--config _configs/config.yml,_configs/test1.yml`
+      - _configs/octopress.yml will be copied to ./_octopress.yml (and removed after tests)
+      - _configs/feed.yml will be copied to ./_plugins/feed/config.yml (and removed after tests)
+
+    This will not overwrite existing files as they will be backed up an restored after tests.
+HELP
+else
+  Clash::Tests.new(options).run
+end

data/clash.gemspec

@@ -18,6 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_runtime_dependency "diffy", "~> 3.0"
+  spec.add_runtime_dependency "safe_yaml", "~> 1.0"
+  spec.add_runtime_dependency "colorator", "~> 0.1"
+
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry-debugger"
 end

data/lib/clash.rb

@@ -1,5 +1,13 @@
-require "clash/version"
+require 'clash/version'
+require 'colorator'
+require 'find'
+require 'safe_yaml'
+require 'diffy'
 
 module Clash
-  # Your code goes here...
+
+  autoload :Tests,   'clash/tests'
+  autoload :Test,    'clash/test'
+  autoload :Diff,    'clash/diff'
+  autoload :Helpers, 'clash/helpers'
 end

data/lib/clash/diff.rb

@@ -0,0 +1,110 @@
+module Clash
+  class Diff
+    include Helpers
+
+    def initialize(a, b, options={})
+      @diffs   = {}
+      @a       = a
+      @b       = b
+      @context = options[:context] || 2
+    end
+
+    def diff
+      if File.directory?(@a)
+        diff_dirs(@a, @b)
+      else
+        diff_files(@a, @b)
+      end
+
+      @diffs
+    end
+
+    def diff_files(a, b)
+      if exists(a) && exists(b)
+        diffy = Diffy::Diff.new(a,b, :source => 'files', :context => @context)
+        file_diff = diffy.to_a
+
+        if !file_diff.empty?
+          file_diff = format_diff(file_diff)
+          @diffs["Compared #{colorize(a, 'yellow')} to #{colorize(b,'yellow')}"] = file_diff 
+        end
+      end
+    end
+    
+    # Recursively diff common files between dir1 and dir2
+    #
+    def diff_dirs(dir1, dir2)
+      mattching_dir_files(dir1, dir2).each do |file|
+        a = File.join(dir1, file)
+        b = File.join(dir2, file)
+        diff_files(a,b)
+      end
+    end
+
+    # Return files that exist in both directories (without dir names)
+    #
+    def mattching_dir_files(dir1, dir2)
+      dir1_files = dir_files(dir1).map {|f| f.sub(dir1,'') }
+      dir2_files = dir_files(dir2).map {|f| f.sub(dir2,'') }
+
+      matches = dir1_files & dir2_files
+
+      unique_files(dir1, dir1_files, matches)
+      unique_files(dir2, dir2_files, matches)
+
+      matches
+    end
+
+    # Find all files in a given directory
+    #
+    def dir_files(dir)
+      Find.find(dir).to_a.reject!{|f| File.directory?(f) }
+    end
+
+    # Find files which aren't common to both directories
+    #
+    def unique_files(dir, dir_files, common_files)
+      unique = dir_files - common_files
+      if !unique.empty?
+        @test_failures << colorize("Files missing from #{dir}/", 'red')
+        unique.each {|f| @test_failures << "- #{f}"}
+      end
+    end
+
+    def exists(f)
+      file_exists = File.exists?(f)
+
+      if !file_exists
+        @test_failures << "#{colorize('File not found:', 'red')} #{f}"
+      end
+
+      file_exists
+    end
+
+
+    def format_diff(diff)
+      count = 0
+
+      diff = diff.map { |line|
+        case line
+        when /^\+/ then 
+          count = 0
+          colorize(line, 'green')
+        when /^-/ then 
+          count = 0
+          colorize(line, 'red')
+        else 
+          if count == @context
+            count = 0
+            "...\n#{line}"
+          else
+            count += 1
+            line
+          end
+        end
+      }
+      diff.join('')
+    end
+
+  end
+end

data/lib/clash/helpers.rb

@@ -0,0 +1,34 @@
+module Clash
+  module Helpers
+    def default_array(option)
+      o = option || []
+      o = [o] unless o.is_a?(Array)
+      o
+    end
+
+    def colorize(str, color)
+      if STDOUT.tty?
+        str.send(color)
+      else
+        str
+      end
+    end
+
+    # Print a single character without a newline
+    #
+    def pout(str)
+      print str
+      if STDOUT.tty?
+        $stdout.flush
+      end
+    end
+
+    def print_fail
+      pout colorize('F', 'red')
+    end
+
+    def print_pass
+      pout colorize('.', 'green')
+    end
+  end
+end

data/lib/clash/test.rb

@@ -0,0 +1,129 @@
+module Clash
+  class Test
+    attr_accessor :title
+
+    include Helpers
+
+    def initialize(options={})
+      @test_failures = []
+      @options  = options
+      @options['config'] ||= {}
+      @cleanup = []
+    end
+
+    def run
+      system_cmd(@options['before'])
+      config
+      build if @options['build']
+      cleanup_config
+      compare
+      enforce_missing
+      print_result
+      system_cmd(@options['after'])
+      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)
+        end
+      end
+    end
+
+    def cleanup_config
+      @cleanup.each do |file|
+        if File.extname(file) == '.bak'
+          FileUtils.mv(file, file.sub(/\.bak$/,''), force: true)
+        else
+          FileUtils.rm(file)
+        end
+      end
+    end
+
+    def config_octopress(file)
+      copy_config(file, '_octopress.yml')
+    end
+
+    def config_plugin(name, file)
+      copy_config(file, "_plugins/#{name}/config.yml")
+    end
+
+    def copy_config(file, target)
+      if File.exists?(file)
+        # Make a backup of existing files first
+        #
+        if File.exists?(target)
+          FileUtils.mv target, "#{target}.bak"
+          @cleanup << "#{target}.bak"
+        else
+          @cleanup << target
+        end
+
+        FileUtils.mkdir_p(File.dirname(target))
+        FileUtils.cp file, target
+      else
+        @test_failures << "Config file: #{file} cannot be found.\n"
+      end
+    end
+
+    def build
+      if jekyll_config = @options['config']['jekyll']
+        configs = default_array(jekyll_config).join(',')
+        system("jekyll build --trace --config #{configs}")
+      else
+        system("jekyll build --trace")
+      end
+    end
+
+    def system_cmd(cmds)
+      cmds = default_array(cmds)
+      cmds.each {|cmd| system(cmd) }
+    end
+
+    def compare
+      default_array(@options['compare']).each do |files|
+        f = files.split(',')
+        diff = Diff.new(f[0].strip, f[1].strip, context: @options['context']).diff
+        diff.each do |title, diff|
+          @test_failures << "#{title}\n#{diff}\n"
+        end
+      end
+    end
+
+    def enforce_missing
+      default_array(@options['enforce_missing']).each do |files|
+        if File.exists?(file)
+          @test_failures << "File #{file} shouldn't exist."
+        end
+      end
+    end
+
+    def print_result
+      if @test_failures.empty?
+        print_pass
+      else
+        print_fail
+      end
+    end
+
+    def results
+      if !@test_failures.empty?
+        @test_failures.unshift(test_title)
+        @test_failures
+      end
+    end
+
+    def test_title
+      title = colorize("Test ##{@options['index']}", 'bold')
+      title << " - #{@options['title']}" unless @options['title'].nil?
+      <<-HERE
+Failed #{title}
+========================================================
+HERE
+    end
+
+  end
+end

data/lib/clash/tests.rb

@@ -0,0 +1,58 @@
+module Clash
+  class Tests
+    include Helpers
+    
+    def initialize(options={})
+      @options = options
+
+      @options[:file]    ||= '.clash.yml'
+      @options[:context] ||= 2
+      @options[:only]      = default_array(@options[:only])
+
+      @tests = default_array(SafeYAML.load_file(@options[:file]))
+    end
+
+    def run
+      @results = {}
+      @passed = []
+      @failed = []
+      @tests.each_with_index do |options, index|
+
+        # If tests are limited, only run specified tests
+        #
+        next if !@options[:only].empty? && !@options[:only].include?(index + 1)
+
+        options['index'] = index + 1
+        options['context'] = @options[:context]
+
+        results = Test.new(options).run
+
+        if results.nil?
+          @passed << index + 1
+        else
+          @failed << index + 1
+          @results[index + 1] = results
+        end
+      end
+
+      print_results
+    end
+
+    def print_results
+      puts "" # newline
+
+      if @results.empty?
+        puts colorize("Passed #{@passed.size} of #{@passed.size} tests", "green")
+      else
+        @results.each do |test, results|
+          if !results.empty?
+            puts "\n#{results.join('')}"
+          end
+        end
+
+        puts "#{colorize("Passed #{@passed.size}", "green")}: Tests: #{@passed.join(',')}"
+        puts "#{colorize("Failed #{@failed.size}", "red")}: Tests: #{@failed.join(',')}"
+      end
+    end
+  end
+end

data/lib/clash/version.rb

@@ -1,3 +1,3 @@
 module Clash
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/test/.clash.yml

@@ -0,0 +1,14 @@
+-
+  title: Checking a and b
+  compare: 'a.txt, b.txt'
+-
+  title: Checking a and c
+  compare: 'a.txt, c.txt'
+  config:
+    feed: _test.yml
+-
+  title: Checking dirs a and b
+  compare: 'a, b'
+-
+  title: Checking dirs a and c
+  compare: 'a, c'

data/test/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem "clash", path: "../"
+gem "pry-debugger"

data/test/_plugins/feed/config.yml

@@ -0,0 +1 @@
+name: Clashing

data/test/_test.yml

@@ -0,0 +1 @@
+name: Clash

data/test/a.txt

@@ -0,0 +1,5 @@
+this is awesome
+you guys
+it's pretty great
+you should have
+lots of fun

data/test/a/1.txt

@@ -0,0 +1,17 @@
+This is a file.
+There is some content.
+It's not particularly imaginative.
+
+
+
+
+asdf
+asdf
+asdf
+asdf
+awesome
+
+asdfa
+dsfa
+sdfasdf
+adsf

data/test/a/2.txt

@@ -0,0 +1,2 @@
+This file is fantastic.
+It has words and everything.

data/test/b.txt

@@ -0,0 +1,5 @@
+this is awesome
+you guys
+it's pretty great
+you should have
+lots of fun

data/test/b/1.txt

@@ -0,0 +1,17 @@
+This is a file.
+There is some content.
+It's not particularly imaginative.
+
+
+
+
+asdf
+asdf
+asdf
+asdf
+awesome
+
+asdfa
+dsfa
+sdfasdf
+adsf

data/test/b/2.txt

@@ -0,0 +1,2 @@
+This file is fantastic.
+It has words and everything.

data/test/c.txt

@@ -0,0 +1,4 @@
+this is awesome
+it's pretty great
+you should have
+lots of fun

data/test/c/1.txt

@@ -0,0 +1,17 @@
+This is a file.
+There is content.
+It's not particularly imaginative.
+
+
+
+
+asdf
+asdf
+asdf
+asdf
+awesome
+sweet
+asdfa
+dsfa
+sdfasdf
+adsf

data/test/c/2.txt

@@ -0,0 +1,3 @@
+This file is fantastic.
+It has words and things.
+Ladies…

metadata

@@ -1,15 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: clash
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-04 00:00:00.000000000 Z
+date: 2014-07-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: diffy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: safe_yaml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: colorator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,10 +80,25 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A diff based testing framework for static sites.
 email:
 - brandon@imathis.com
-executables: []
+executables:
+- clash
 extensions: []
 extra_rdoc_files: []
 files:
@@ -50,9 +107,27 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/clash
 - clash.gemspec
 - lib/clash.rb
+- lib/clash/diff.rb
+- lib/clash/helpers.rb
+- lib/clash/test.rb
+- lib/clash/tests.rb
 - lib/clash/version.rb
+- test/.clash.yml
+- test/Gemfile
+- test/_plugins/feed/config.yml
+- test/_test.yml
+- test/a.txt
+- test/a/1.txt
+- test/a/2.txt
+- test/b.txt
+- test/b/1.txt
+- test/b/2.txt
+- test/c.txt
+- test/c/1.txt
+- test/c/2.txt
 homepage: https://github.com/imathis/clash
 licenses:
 - MIT
@@ -77,4 +152,17 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A diff based testing framework for static sites.
-test_files: []
+test_files:
+- test/.clash.yml
+- test/Gemfile
+- test/_plugins/feed/config.yml
+- test/_test.yml
+- test/a.txt
+- test/a/1.txt
+- test/a/2.txt
+- test/b.txt
+- test/b/1.txt
+- test/b/2.txt
+- test/c.txt
+- test/c/1.txt
+- test/c/2.txt