clash 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13ac19a35a839e89433534afd9ad62d50043423a
-  data.tar.gz: 850cef298bfd22ed9a9890473b1397da86a15e23
+  metadata.gz: 23f6c62c10e72f88582594bf9a1251839898862a
+  data.tar.gz: d6819aa56879e5288583f7034b8bf6a21a24cc2f
 SHA512:
-  metadata.gz: eebbea76d8eae56c606b4e78eb48603a3b7a7ead4ed2a7720b91bc325ff9e11f7279bd7c2f0e5782638e1a8f235d3056987fa11f654e316d87a7886bd5945a1c
-  data.tar.gz: 3d157c408778103392fc5d50062e607cf1a330e3b8181edf2d2c24d1cdfb0b72d39b1983e0656ddf5a5f2b026122af862ed8a76f07708d6216048a32c5ecbf1f
+  metadata.gz: 7a3763cc4049da6ceccd8b26b35dda08d712367fd6220ee1f7dd2df4ddf736f4f3cca0cbb1ffde0db48832f741899e9c3f08bdcbb5f78b722f95ae7f8bd39b1d
+  data.tar.gz: 0a669aecd5bfc7f0519dff40f35eb129276ca7d4a3a1063ad8f93f40c0f93ca6432b3d03f9c190a8a4bacdea194c4e1788570d8738bb2562a9807474578deb6d

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+### 1.0.1 - 2014-07-07
+- compare no longer needs a comma (to be more like diff)
+
+### 1.0.0 - 2014-07-07
+- Initial release

data/README.md

@@ -23,12 +23,13 @@ Or install it yourself as:
 ## Usage
 
 ```
-clash [test(s)] [options]
+clash [test] [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
 ```
@@ -41,20 +42,32 @@ $ clash 2,3   # run the second and third tests
 -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/.
+### Example usage:
+
+If you have a simple liquid tag you want to test:
+
+ 1. Create a simple Jekyll site with tags.
+ 2. Create one or more pages which test the tags features.
+ 3. Manually check that the compiled site looks right.
+ 4. Copy `_site` to `_expected`.
+ 5. Create a test file like the one below.
+ 6. **Code with confidence!**
+
+### Simple configuration:
+
+Clash will build your site with Jekyll, and compare the contents of _site/ to _expected/.
 
 ```
 build: true
-compare: _site, expected
+compare: _site _expected
 ```
 
-### Configuration options
+Of course, there is a lot more you can do.
+
+## Configuration
 
 | Option           | Type           | Description                                              |
 |:-----------------|:---------------|:---------------------------------------------------------|
@@ -62,7 +75,7 @@ compare: _site, expected
 | 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"          |
+| 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.               |
 
@@ -70,11 +83,11 @@ Note: in the table above, String/Array means a single argument can be a string,
 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
+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:
@@ -83,10 +96,10 @@ To run multiple tests each test should be an array, for example:
 -
   name: Check site build
   build: true
-  compare: _site, _expected
+  compare: _site _expected
 -
   name: Check asset compression
-  compare: _cdn_build, _cdn_expected
+  compare: _cdn_build _cdn_expected
 ```
 
 Note: When running multiple tests, adding a name can help the reading of test failures.

data/lib/clash/test.rb

@@ -85,9 +85,9 @@ module Clash
 
     def compare
       default_array(@options['compare']).each do |files|
-        f = files.split(',')
+        f = files.gsub(',',' ').split
 
-        differ = Diff.new(f[0].strip, f[1].strip, context: @options['context'])
+        differ = Diff.new(f.first, f.last, context: @options['context'])
         diff = differ.diff
 
         @test_failures.concat differ.test_failures

data/lib/clash/version.rb

@@ -1,3 +1,3 @@
 module Clash
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/test/.clash.yml

@@ -1,7 +1,7 @@
 -
   title: Standard build
   build: true
-  compare: _site/index.html, _expected/default.html
+  compare: _site/index.html _expected/default.html
 -
   title: Build Jekyll with alternate configuration
   build: true
@@ -9,7 +9,7 @@
     jekyll: 
       - _config.yml
       - _test1.yml
-  compare: _site/index.html, _expected/alternate.html
+  compare: _site/index.html _expected/alternate.html
 -
   title: Test Octopress configuration
   config:
@@ -29,19 +29,19 @@
 -
   title: Compare matching files
   compare:
-    - a/1.txt, _site/a/1.txt
-    - a/2.txt, _site/a/2.txt
+    - a/1.txt _site/a/1.txt
+    - a/2.txt _site/a/2.txt
 -
   title: (Should fail) Compare files with differences
   compare:
-    - a/1.txt, _c/1.txt
-    - _site/a/1.txt, _c/1.txt
+    - a/1.txt _c/1.txt
+    - _site/a/1.txt _c/1.txt
 -
   title: Compare two matching dirs
-  compare: a, _site/a
+  compare: a _site/a
 -
   title: (Should fail) Compare two dirs with differences
-  compare: a, _c
+  compare: a _c
 -
   title: File shouldn't exist.
   enforce_missing:

data/test/.test.yml

@@ -1 +1 @@
-compare: _output, _expected_output
+compare: _output _expected_output

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clash
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-07 00:00:00.000000000 Z
+date: 2014-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: diffy
@@ -118,6 +118,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md