fuci 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c51a2d0ad456cb773cc634a1e33cebcbd1c03af5
-  data.tar.gz: 80ad9fb11b2b88c86f3de73f27b57baa8e29c216
+  metadata.gz: 34faa150063416bf1ca042b6a3c741bc9d8ea46c
+  data.tar.gz: 1487f25d0712faf4af545dabf7798bb0474eb72b
 SHA512:
-  metadata.gz: 1e17548470e39a72f4e81fe41f8fcb5f96db0446f5b044f8b30d0eb53021d52a0fc33d4816092a13442dac5be26c6dc81da7f276088bda1e5ecc71c507c2c304
-  data.tar.gz: 1fe119206c7956c8f0f7e965bd54aa0377b38ad1c98349e304d9a52aa9d68114a6daa7b51dc66e30256b66fbd9a687ead75f7a9c6a3dfd700f821995e33ea5d4
+  metadata.gz: e10f99678214657933a6bf26c575c6a12f8c7958a59dc7c7632efc90d081c6527ae63f96e5345425e64abffc54efdc2f3c0aa0f79e48bb5d432a374550eb8642
+  data.tar.gz: 49aa7e85bd20e66a1cbc9e7a2946f844d4601186b6b00c5355cfb7628d178a2ee3568ae0edca1fce0a4ebd44a10ca71f18fc6c620729aa3564c7ba8f98a44bde

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### version 0.1.1 *July 30, 2013*
+* Logs that no failure was detected by a plugin.
+
+### version 0.1.0 *July 29, 2013*
+* Initial release

data/README.md

@@ -1,7 +1,7 @@
 # Fuci
-[![Build Status](https://travis-ci.org/davejachimiak/fuci.png?branch=dj-initial_functionality)](https://travis-ci.org/davejachimiak/fuci)
+[![Build Status](https://travis-ci.org/davejachimiak/fuci.png?branch=master)](https://travis-ci.org/davejachimiak/fuci)
 
-Run failed tests from your last build on the command line.
+A base gem providing the general case for running CI failures locally.
 
 ## Installation
 
@@ -9,10 +9,55 @@ Add this line to your fuci extension's Gemspec:
 
     .add_dependency 'fuci', '~> 0.1'
 
+## Known server extensions
+* [Fuci::Travis](https://github.com/davejachimiak/fuci-travis)
+
 ## Usage
-### Server extensions
-Coming soon...
-### Tester extensions
+### Creating server extensions
+#### Configuring Fuci base with the server
+Somewhere in the required code of the server extension, the server must
+be set like so:
+```ruby
+Fuci.configure do |fu|
+  fu.server = Fuci::MyCiAgent::ServerClass
+end
+```
+or
+```ruby
+module Fuci
+  configure do |fu|
+    fu.server = Fuci::MyCiAgent::ServerClass
+  end
+
+  module MyCiAgent
+    ...
+    ...
+  end
+end
+```
+
+The ServerClass in this example must be an initializable constant whose
+instance implements the server interface.
+
+#### The server interface
+The `Fuci::Server` interface class that tells what the runner
+expects of server extensions. As of this version, it expects two
+methods: `#build_status` and `#fetch_log`. See that file for more
+details on what they should return.
+
+#### The binstub
+Server extensions should ship with their own binstub. `fuci` is
+preffered. It's short and easy to type. To avoid possible conflicts
+between local server extensions, prefer that users execute
+`bundle binstubs <server-extension>`.
+
+Fuci binstubs should do the following:
+* Require the extension
+* Load a configuration file, if necessary
+* Handle command-line arguments
+* Call `Fuci.run`
+
+### Creating tester extensions
 Coming soon...
 ## Contributing
 

data/lib/fuci/runner.rb

@@ -38,7 +38,12 @@ module Fuci
       self.detected_tester = testers.detect do |tester|
         tester.indicates_failure? log
       end
-      puts "Failure detected: #{detected_tester.class.name.split('::').last}"
+
+      if detected_tester
+        puts "Failure detected: #{detected_tester.class.name.split('::').last}"
+      else
+        puts_with_exit 'No failure was detected by any tester plugins.'
+      end
     end
 
     def run_failures

data/lib/fuci/server.rb

@@ -10,7 +10,7 @@ module Fuci
       raise NotImplementedError
     end
 
-    # must return a string with characters
+    # must return a log as as string string with characters
     # denoting ascii color removed
     def fetch_log
       raise NotImplementedError

data/lib/fuci/version.rb

@@ -1,3 +1,3 @@
 module Fuci
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

data/spec/lib/fuci/runner_spec.rb

@@ -52,19 +52,31 @@ describe Fuci::Runner do
   end
 
   describe '.detect_tester_failure' do
-    it 'detects the first tester failure in the log' do
-      rspec, konacha, cucumber = mock, mock, mock
-      @runner.stubs(:log).returns log = mock
-      [rspec, cucumber].each { |t| t.stubs :indicates_failure? }
-      konacha.stubs(:indicates_failure?).with(log).returns true
-      konacha.class.stubs(:name).returns 'Fuci::Konacha'
-      testers = [rspec, konacha, cucumber]
-      @runner.expects(:puts).with 'Failure detected: Konacha'
-      @runner.stubs(:testers).returns testers
+    describe 'a failure is detected by a tester plugin' do
+      it 'detects the first tester failure in the log' do
+        rspec, konacha, cucumber = mock, mock, mock
+        @runner.stubs(:log).returns log = mock
+        [rspec, cucumber].each { |t| t.stubs :indicates_failure? }
+        konacha.stubs(:indicates_failure?).with(log).returns true
+        konacha.class.stubs(:name).returns 'Fuci::Konacha'
+        testers = [rspec, konacha, cucumber]
+        @runner.expects(:puts).with 'Failure detected: Konacha'
+        @runner.stubs(:testers).returns testers
+
+        @runner.send :detect_tester_failure
+
+        expect(@runner.send :detected_tester ).to_equal konacha
+      end
+    end
 
-      @runner.send :detect_tester_failure
+    describe 'if there was no detected tester' do
+      it 'logs that no failure was detected by any tester plugin' do
+        @runner.stubs(:testers).returns []
+        @runner.expects(:puts_with_exit).
+          with 'No failure was detected by any tester plugins.'
 
-      expect(@runner.send :detected_tester ).to_equal konacha
+        @runner.send :detect_tester_failure
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fuci
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Dave Jachimiak
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md