snapdragon 0.1.12 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b8aad99b89a86f7409439f78820527090c48188f
-  data.tar.gz: 2707cb606f2f5ae2f3e72783b27e18efa25e4d5b
+  metadata.gz: d91d70e71200c4c41242a3578bde16b234a52152
+  data.tar.gz: 4c01baa008019b3ed66a4e54330e402eaa94d44e
 SHA512:
-  metadata.gz: 9eef67ae9b2468cbf3bedef07fc8219a0a14657a2d2ac4717bc19adfafa382f187621b4f5794775b276c40d89fc7601ef1ecbcf41d0daee6a383e8f8581a0a52
-  data.tar.gz: 719add788cd12f7729f631f39d597bf0e47d68186b6cd03cd9fee92893d83b937a960d2be03ad73d2a6f5ecf25c78073f9d75284c8a69c955f8bb09415b9a837
+  metadata.gz: 081c307e74c3e70e385e425109c28617375c2cc2f4c91f450e7d93b4770de71cda1be26c1795779f774bb345815095279bb41538604494d7d4b62fbafa38716d
+  data.tar.gz: 3cef1deb3c500497ab3bf8f9750ec9a8bdd59e0b6ae30dc34a5e56a29afcced0c12b53ef475c7208356f87b956f92f047d72b1b9364aa3532515ba62f12ed23f

data/ChangeLog.markdown

@@ -6,6 +6,12 @@ versions as well as provide a rough history.
 
 #### Next Release
 
+#### v0.2.0
+
+* added -P, --pattern options to over the test file search pattern as well as
+  a default test file search pattern when not given an explicit file or
+  directory path. 
+
 #### v0.1.12
 
 * add the --color, --no-color, --colour, --no-colour, and -c option to

data/README.markdown

@@ -41,10 +41,10 @@ $ brew install phantomjs
 ## Quick Start Guide
 
 If you are a visual learner Brian Miller and I have put together a Free
-[Snapdragon](http://github.com/reachlocal/snapdragon) Screencast at [The Code
+[Snapdragon Screencast](http://codebreakdown.com/screencasts/7) at [The Code
 Breakdown](http://codebreakdown.com).
 
-[![It in Action](http://media.codebreakdown.com/thumbnails/tcb-0007-thumbnail-400x225.png)](http://codebreakdown.com)
+[![It in Action](http://media.codebreakdown.com/thumbnails/tcb-0007-thumbnail-400x225.png)](http://codebreakdown.com/screencasts/7)
 
 For those of you that like to jump right in and start playing with new tools
 follow the steps below to get started.
@@ -138,6 +138,30 @@ $ snapdragon spec/javascripts
 $ snapdragon spec/javascript custom_js/tests/foo_spec.js custom_js/test/bar_spec.js
 ```
 
+#### Run test files matched by default pattern (`spec/**/*_spec.js`)
+
+```text
+$ snapdragon
+```
+
+#### Run test files matched by custom pattern
+
+The following is an example command that specifies a custom pattern to use to
+match test files to run. Please note the double quote marks around the
+pattern. These are necessary as without them most shells will try and resolve
+the pattern for you. Further details on the glob syntax can be found
+[here](http://ruby-doc.org/core-2.0.0/Dir.html#method-c-glob).
+
+```text
+$ snapdragon -P "spec/assets/javascripts/foo/*_spec.js"
+```
+
+#### Output Usage Details/Help
+
+```text
+$ snapdragon --help
+```
+
 ## Usage (snapdragon_server)
 
 The *snapdragon_server* command allows you to run your
@@ -157,13 +181,13 @@ The following runs the describe or it block that corresponds to line number
 $ snapdragon_server spec/javascript/foo_spec.js:23
 ```
 
-#### Run specific spec files
+#### Run an entire spec file(s)
 
 ```text
 $ snapdragon_server spec/javascript/foo_spec.js spec/javascript/bar_spec.js
 ```
 
-#### Run all the specs in directories
+#### Run an entire directory of spec files
 
 The following recursively explores the given directories contents for
 files that end in `spec.js` or `Spec.js` and runs the tests in the identified
@@ -173,12 +197,82 @@ spec files.
 $ snapdragon_server spec/javascript custom_js/specs
 ```
 
-#### Combine files and directories
+#### Run combination of files and directories
 
 ```text
 $ snapdragon_server spec/javascript custom_js/tests/foo_spec.js custom_js/test/bar_spec.js
 ```
 
+#### Run test files matched by default pattern (`spec/**/*_spec.js`)
+
+```text
+$ snapdragon_server
+```
+
+#### Run test files matched by custom pattern
+
+The following is an example command that specifies a custom pattern to use to
+match test files to run. Please note the double quote marks around the
+pattern. These are necessary as without them most shells will try and resolve
+the pattern for you. Further details on the glob syntax can be found
+[here](http://ruby-doc.org/core-2.0.0/Dir.html#method-c-glob).
+
+```text
+$ snapdragon_server -P "spec/assets/javascripts/foo/*_spec.js"
+```
+
+#### Output Usage Details/Help
+
+```text
+$ snapdragon_server --help
+```
+
+### Additional Options
+
+Below is a listing of the various options that can be passed to either the
+`snapdragon` or `snapdragon_server` commands.
+
+#### Version (`-v`, `--version`)
+
+When given this option it will output the version that you are using
+and exit without running any tests.
+
+#### Help (`-h`, `--help`)
+
+When given this option it will output basic usage summary and exit without
+running any tests.
+
+#### Format (`-f FORMAT`, `--format FORMAT`)
+
+This option allows you to specify the output format of the tests. By default
+it outputs using the `console` format. This option is extremely useful when
+you would like to use `snapdragon` inside of a CI process because you can
+instruct it to output in other formats such as `junit` which CI services
+can parse.
+
+The following are the currently supported `FORMAT` values.
+
+* `console` (default)
+* `junit`
+
+#### Color (`--no-color`, `--no-colour`)
+
+If you would like to disable ANSI color output which is enabled by default,
+include either the `--no-color` or `--no-colour` option.
+
+#### Pattern (`-P PATTERN`, `--pattern PATTERN`)
+
+When this option is not given and no file or directory paths are given it
+uses the default pattern `"spec/**/*_spec.js"`.
+
+When given this option without any explicit file paths or directory paths it
+will use the provided glob pattern to identify which test files to run. Any
+example usage of this option can be seen above in the *Run test files matched
+by custom pattern* section. For more details on the glob pattern syntax please
+refer to the [Ruby
+Dir.glob](http://ruby-doc.org/core-2.0.0/Dir.html#method-c-glob)
+documentation.
+
 ## // require_relative() directive
 
 Snapdragon also provides a `// require_relative()` directive that the

data/lib/snapdragon/command_line_parser.rb

@@ -8,6 +8,7 @@ module Snapdragon
       options = OpenStruct.new
       options.format = "console" 
       options.color = true
+      options.pattern = "spec/**/*_spec.js"
 
       opts = OptionParser.new do |opts|
         opts.banner = "Usage: snapdragon [options] [files or directories]"
@@ -23,8 +24,8 @@ module Snapdragon
         opts.on('-c', '--[no-]color', '--[no-]colour', 'Enable color in the output.') do |o|
           options.color = o
         end
-        if args.empty?
-          puts opts; exit
+        opts.on('-P', '--pattern PATTERN', 'Load files matching pattern (default: "spec/**/*_spec.js").') do |pattern|
+          options.pattern = pattern
         end
       end
       opts.parse!(args)

data/lib/snapdragon/suite.rb

@@ -15,10 +15,15 @@ module Snapdragon
       @options.color
     end
 
+    def pattern
+      @options.pattern
+    end
+
     def spec_files
       spec_file_objs = []
 
-      @paths.each do |raw_path|
+      @paths << Dir[pattern] if @paths.empty?
+      @paths.flatten.uniq.each do |raw_path|
         path = Snapdragon::Path.new(raw_path)
         spec_file_objs.concat(path.spec_files)
       end

data/lib/snapdragon/version.rb

@@ -1,3 +1,3 @@
 module Snapdragon
-  VERSION = "0.1.12"
+  VERSION = "0.2.0"
 end

data/spec/lib/snapdragon/command_line_parser_spec.rb

@@ -25,7 +25,7 @@ describe Snapdragon::CommandLineParser do
     
     context "no args supplied" do
       it "exit" do
-        lambda { hide_stdout { subject.parse([]) } }.should raise_error(SystemExit)
+        lambda { hide_stdout { subject.parse([]) } }.should_not raise_error(SystemExit)
       end
     end
     
@@ -58,5 +58,17 @@ describe Snapdragon::CommandLineParser do
         subject.parse(["--no-color", "spec/hello_spec.rb"]).color.should eq false
       end
     end
+    
+    context "when pattern is provided" do
+      it "sets the pattern value" do
+        subject.parse(["--pattern", "spec/*/*_test.js"]).pattern.should eq "spec/*/*_test.js"
+      end
+    end
+    
+    context "when pattern is not provided" do
+      it "defaults to 'spec/**/*_spec.js'" do
+        subject.parse([]).pattern.should eq "spec/**/*_spec.js"
+      end
+    end
   end
 end

data/spec/lib/snapdragon/suite_spec.rb

@@ -41,24 +41,64 @@ describe Snapdragon::Suite do
     end
   end
 
-  describe "#spec_files" do
-    it "creates a path object to represent the path" do
-      options = stub
-      paths = ['path_a_str', 'path_b_str']
-      suite = Snapdragon::Suite.new(options, paths)
-      Snapdragon::Path.should_receive(:new).with('path_a_str').and_return(stub(spec_files: []))
-      Snapdragon::Path.should_receive(:new).with('path_b_str').and_return(stub(spec_files: []))
-      suite.spec_files
+  describe "#pattern" do
+    it "returns the configured pattern setting" do
+      pattern = stub
+      options = stub(pattern: pattern)
+      suite = Snapdragon::Suite.new(options, stub)
+      suite.pattern.should eq pattern
     end
+  end
+  
+  describe "#spec_files" do
+    context "when paths are provided" do
+      it "does not read pattern from options" do
+        pattern = stub
+        options = stub(pattern: pattern)
+        paths = ['path_a_str', 'path_b_str']
+        suite = Snapdragon::Suite.new(options, paths)
+        suite.should_not_receive(:pattern)
+        suite.spec_files
+      end
+      
+      it "creates a path object to represent the path" do
+        options = stub
+        paths = ['path_a_str', 'path_b_str']
+        suite = Snapdragon::Suite.new(options, paths)
+        Snapdragon::Path.should_receive(:new).with('path_a_str').and_return(stub(spec_files: []))
+        Snapdragon::Path.should_receive(:new).with('path_b_str').and_return(stub(spec_files: []))
+        suite.spec_files
+      end
 
-    it "returns the collection of the spec files of all of the paths" do
-      options = stub
-      paths = ['path_a_str', 'path_b_str']
-      suite = Snapdragon::Suite.new(options, paths)
-      spec_file_a = stub('spec_file_a'), spec_file_b = stub('spec_file_b')
-      Snapdragon::Path.stub(:new).with('path_a_str').and_return(stub(spec_files: [spec_file_a]))
-      Snapdragon::Path.stub(:new).with('path_b_str').and_return(stub(spec_files: [spec_file_b]))
-      suite.spec_files.should eq([spec_file_a, spec_file_b])
+      it "returns the collection of the spec files of all of the paths" do
+        options = stub
+        paths = ['path_a_str', 'path_b_str']
+        suite = Snapdragon::Suite.new(options, paths)
+        spec_file_a = stub('spec_file_a'), spec_file_b = stub('spec_file_b')
+        Snapdragon::Path.stub(:new).with('path_a_str').and_return(stub(spec_files: [spec_file_a]))
+        Snapdragon::Path.stub(:new).with('path_b_str').and_return(stub(spec_files: [spec_file_b]))
+        suite.spec_files.should eq([spec_file_a, spec_file_b])
+      end
+    end
+    
+    context "when paths are empty" do
+      it "reads the pattern from the options" do
+        pattern = stub
+        options = stub(pattern: pattern)
+        suite = Snapdragon::Suite.new(options, [])
+        suite.should_receive(:pattern).and_return(pattern)
+        suite.spec_files
+      end
+      
+      it "returns the collection of spec files matching the pattern" do
+        pattern = stub
+        options = stub(pattern: pattern)
+        Dir.stub!(:[]) { ['path_c_str'] }
+        suite = Snapdragon::Suite.new(options, [])
+        spec_file_c = stub('spec_file_c')
+        Snapdragon::Path.stub(:new).with('path_c_str').and_return(stub(spec_files: [spec_file_c]))
+        suite.spec_files.should eq([spec_file_c])
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snapdragon
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.2.0
 platform: ruby
 authors:
 - Andrew De Ponte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-19 00:00:00.000000000 Z
+date: 2013-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara