rspec-todo 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5dd31131ee403a76e605cecfedcc10fabc021471
-  data.tar.gz: fcb29ec1bf71a68d1c8fe6cec08330e62dec6bd4
+  metadata.gz: 6764d77a1678c01bcb539d36765616f320bc4dac
+  data.tar.gz: a83e031ba64123414a56157352b8f50163c96c3b
 SHA512:
-  metadata.gz: ae826bd4f4c505688ae5e4a86749dcc62768c81ca70d1405f2b789013c7028f0b4799b31ed8eb6142740440d314363e8f79a3350819c8576891408293ce28f2f
-  data.tar.gz: a5ecad56e6c3e04d4cc3f1390f185067b158881a8882e849a28375bf32cde62f3171b0df4c80380edccac12c568941b4ccebeb3722bfe5d90e1439b520715b1b
+  metadata.gz: 2d600f60892ad3aac75b23f72f2a96d9a5d817ce97230979a87cd87f1b48094ac7fec9f2d02e82ae7cc6e7cc4be223e5f9ca6992245b1a7eca15d4dfd4b7d110
+  data.tar.gz: d215d3693a6095caf5c7919b6d36ab9ce03642f0a00bd7b09b637614888554613a54298f4d5e65d4b8b5e6c1853a652f80fb3bcda13513611f301a78845bfb40

data/README.md

@@ -1,7 +1,9 @@
 # Rspec::Todo [![Build Status](https://travis-ci.org/okitan/rspec-todo.png?branch=master)](https://travis-ci.org/okitan/rspec-todo)
 
-todo: pending if failed
-not_todo: result errors if passed
+* todo
+ * pending if failed
+* not_todo
+ * result errors if passed
 
 ## Installation
 
@@ -40,6 +42,32 @@ describe "rspec-todo" do
 end
 ```
 
+### if: and unless:
+
+switch use to_do and not to_do with options.
+
+
+```ruby
+it "todo results pending if failed and if: is true" do
+  todo(if: true) {
+    # your code which may fail and will fix later
+  }
+end
+
+it "todo ignored if if: is true" do
+  todo(if: false) { # todo is ignored and expectation is evaled directly
+  }
+end
+```
+
+## Comparison
+
+| methods  | no errors (passed) | raise error (failed) |
+|----------|-------------|-------------|
+| pending  | failure | pending |
+| todo     | success | pending |
+| not_todo | failure | success |
+
 ## Contributing
 
 1. Fork it

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/rspec/todo.rb

@@ -1,36 +1,58 @@
+require "tapp"
+
 module RSpec
   module Todo
-    def todo(reason = nil, &block)
-      if block_given?
-        begin
-          yield
-        rescue => e
-          if reason
-            pending(reason)
-          else
-            pending(e.inspect)
+    def rspec_todo_works_for(opts = {})
+      if opts[:if].nil? && opts[:unless].nil?
+        true
+      else
+        opts[:if] || (opts[:unless].nil? ? false : !opts[:unless])
+      end
+    end
+
+    def todo(reason = nil, opts = {}, &block)
+      reason, opts = nil, reason if reason.is_a?(Hash)
+
+      if rspec_todo_works_for(opts)
+        if block_given?
+          begin
+            yield
+          rescue => e
+            if reason
+              pending(reason)
+            else
+              pending(e.inspect)
+            end
           end
+        else
+          pending(reason)
         end
       else
-        pending(reason)
+        yield
       end
     end
 
-    def not_todo(reason = nil, *errors_expected, &block)
-      if block_given?
-        begin
-          yield
-        rescue RSpec::Expectations::ExpectationNotMetError, *errors_expected => e
-          # do nothing
-        else
-          if reason
-            raise(reason)
+    def not_todo(reason = nil, opts = {}, &block)
+      reason, opts = nil, reason if reason.is_a?(Hash)
+
+      if rspec_todo_works_for(opts)
+        if block_given?
+          begin
+            yield
+          rescue RSpec::Expectations::ExpectationNotMetError, *opts[:errors] => e
+            # do nothing
           else
-            raise "not todo but passed"
+            if reason
+              raise(reason)
+            else
+              raise "not todo but passed"
+            end
           end
+        else
+          pending(reason)
         end
       else
-        pending(reason)
+        yield
       end
     end
   end

data/spec/rspec/todo_spec.rb

@@ -1,45 +1,264 @@
 require "spec_helper"
 
+shared_examples "pending" do |sub_description, opts = {}|
+  context(sub_description, opts) do
+    it "works" do
+      begin
+        expect { expectation }.to raise_exception(pending_exception)
+      ensure
+        # if not example comes to be pending and cannot determine green or red
+        example.metadata[:pending] = false
+      end
+    end
+  end
+end
+
+shared_examples "being passed" do |sub_description, opts = {}|
+  context(sub_description, opts) do
+    it "works" do
+      expectation
+    end
+  end
+end
+
+shared_examples "error" do |sub_description, opts = {}|
+  context(sub_description, opts) do
+    it "works" do
+      begin
+        expect { expectation }.to raise_exception {|exception|
+          exception.should_not be_a(pending_exception)
+        }
+      ensure
+        # if not example may come to be pending and cannot detect failre
+        example.metadata[:pending] = false
+      end
+    end
+  end
+end
+
 describe "rspec-todo" do
+  let(:pending_exception) { ::RSpec::Core::Pending::PendingDeclaredInExample }
+
+  context "#rspec_todo_works_for" do
+    [ [ true,  true,  true ],
+      [ true,  false, true ],
+      [ true,  nil,   true ],
+      [ false, true,  false ],
+      [ false, false, true ],
+      [ false, nil,   false ],
+      [ nil,   true,  false ],
+      [ nil,   false, true ],
+      [ nil,   nil,   true ],
+    ].each do |if_value, unless_value, result|
+      it "returns #{result} when if is #{if_value.inspect} and unless is #{unless_value.inspect}" do
+        rspec_todo_works_for(if: if_value, unless: unless_value).should == result
+      end
+    end
+  end
+
   context "todo" do
     context "with description" do
-      it "becomes pending if failed" do
-        todo("will raise hoge") { raise "hoge" }
+      it_behaves_like "pending", "when expectation failed" do
+        let(:expectation) do
+          todo("with raise hoge") { raise "hoge" }
+        end
       end
     end
 
     context "without description" do
-      it "passes" do
-        todo { true }
+      it_behaves_like "being passed", "when expectation succeeded" do
+        let(:expectation) do
+          todo { true }
+        end
+      end
+
+      it_behaves_like "pending", "when expectation failed" do
+        let(:expectation) do
+          todo { raise "hoge" }
+        end
       end
+    end
+
+    context "with if opts" do
+      context "are true" do
+        it_behaves_like "being passed", "when expectation succeeded" do
+          let(:expectation) do
+            todo(if: true) { true }
+          end
+        end
 
-      it "becomes pending if failed" do
-        todo { raise "hoge" }
+        it_behaves_like "pending", "when expectation failed" do
+          let(:expectation) do
+            todo(if: true) { raise "hoge" }
+          end
+        end
+      end
+
+      context "are false" do
+        it_behaves_like "being passed", "when expectation succeeded" do
+          let(:expectation) do
+            todo(if: false) { true }
+          end
+        end
+
+        it_behaves_like "error", "when expectation failed" do
+          let(:expectation) do
+            todo(if: false) { raise "hoge" }
+          end
+        end
+      end
+    end
+
+    context "with unless opts" do
+      context "are false" do
+        it_behaves_like "being passed", "when expectation succeeded" do
+          let(:expectation) do
+            todo(unless: false) { true }
+          end
+        end
+
+        it_behaves_like "pending", "when expectation failed" do
+          let(:expectation) do
+            todo(unless: false) { raise "hoge" }
+          end
+        end
+      end
+
+      context "are true" do
+        it_behaves_like "being passed", "when expectation succeeded" do
+          let(:expectation) do
+            todo(unless: true) { true }
+          end
+        end
+
+        it_behaves_like "error", "when expectation failed" do
+          let(:expectation) do
+            todo(unless: true) { raise "hoge" }
+          end
+        end
       end
     end
   end
 
   context "not todo" do
-    it "result error if successed" do
-      expect {
+    it_behaves_like "error", "when succeeded" do
+      let(:expectation) do
         not_todo { true }
-      }.to raise_exception
+      end
     end
 
-    it "results nothing when expectation not matched" do
-      not_todo { 1.should == 2 }
+    it_behaves_like "being passed", "when expectation not matched" do
+      let(:expectation) do
+        not_todo { 1.should == 2 }
+      end
     end
 
-    it "results nothing when specified error occured" do
-      not_todo("runtime error occured", RuntimeError) do
-        raise
+    context "when expectation raise exception" do
+      it_behaves_like "being passed", "when error is specified" do
+        let(:expectation) do
+          not_todo("runtime error occured", errors: RuntimeError) do
+            raise
+          end
+        end
+      end
+
+      it_behaves_like "being passed", "when errors are specified" do
+        let(:expectation) do
+          not_todo("runtime error occured", errors: [ RuntimeError ]) do
+            raise
+          end
+        end
+      end
+
+      it_behaves_like "error", "when errors are not specified" do
+        let(:expectation) do
+          not_todo { raise "unexpected" }
+        end
       end
     end
 
-    it "results error if runtime error occured" do
-      expect {
-        not_todo { raise }
-      }.to raise_exception
+    context "with if opts" do
+      context "are true" do
+        it_behaves_like "error", "when expectation succeeded" do
+          let(:expectation) do
+            not_todo(if: true) { true }
+          end
+        end
+
+        it_behaves_like "being passed", "when expectation failed" do
+          let(:expectation) do
+            not_todo(if: true) { 1.should == 2 }
+          end
+        end
+
+        it_behaves_like "being passed", "when errors are specified" do
+          let(:expectation) do
+            not_todo(if: true, errors: RuntimeError) { raise }
+          end
+        end
+      end
+
+      context "are false" do
+        it_behaves_like "being passed", "when expectation succeeded" do
+          let(:expectation) do
+            not_todo(if: false) { true }
+          end
+        end
+
+        it_behaves_like "error", "when expectation failed" do
+          let(:expectation) do
+            not_todo(if: false) { 1.should == 2 }
+          end
+        end
+
+        it_behaves_like "error", "even if errors are specified" do
+          let(:expectation) do
+            not_todo(if: false, errors: RuntimeError) { raise }
+          end
+        end
+      end
+    end
+
+    context "with unless opts" do
+      context "are false" do
+        it_behaves_like "error", "when expectation succeeded" do
+          let(:expectation) do
+            not_todo(unless: false) { true }
+          end
+        end
+
+        it_behaves_like "being passed", "when expectation failed" do
+          let(:expectation) do
+            not_todo(unless: false) { 1.should == 2 }
+          end
+        end
+
+        it_behaves_like "being passed", "when errors are specified" do
+          let(:expectation) do
+            not_todo(unless: false, errors: RuntimeError) { raise }
+          end
+        end
+      end
+
+      context "are true" do
+        it_behaves_like "being passed", "when expectation succeeded" do
+          let(:expectation) do
+            not_todo(unless: true) { true }
+          end
+        end
+
+        it_behaves_like "error", "when expectation failed" do
+          let(:expectation) do
+            not_todo(unless: true) { 1.should == 2 }
+          end
+        end
+
+       it_behaves_like "error", "even if errors are specified" do
+          let(:expectation) do
+            not_todo(unless: true, errors: RuntimeError) { raise }
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-todo
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - okitan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-06 00:00:00.000000000 Z
+date: 2013-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec