gabrielg-oughta 0.0.0 → 0.1.1

data/README.rdoc

@@ -1,6 +1,10 @@
 = oughta
 
-Description goes here.
+This little gem here contains a bunch of Shoulda extensions, including:
+
+* macro / use_macro
+
+See the RDocs for more details, until this README is complete.
 
 == Copyright
 

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 1

data/lib/thumblemonks/oughta/macro_macros.rb

@@ -3,12 +3,46 @@ module Thumblemonks
     module MacroMacros
       module ClassMethods
         
+        # Defines a macro for use in a TestCase or Context with the given name and block.
+        # For example, this defines a macro called :should_be_cool
+        #
+        #   macro :should_be_cool do
+        #     
+        #     should("be true") { assert(true) }
+        #     should("be cool") { assert_equal("cool", @message) }
+        #     should_eventually "do something else"
+        #
+        #   end
+        #
+        # To then use this macro, see the documentation for use_macro
+        #
         def macro(name, &block)
           (class << self; self; end).instance_eval do 
             define_method(:"Macro: #{name}") { |context| context.instance_eval(&block) }
           end
         end
         
+        # Uses a macro defined using the macro method. For example:
+        #
+        #   class TooLazyToSubmitPatchesToThoughtbotTest < Test::Unit::TestCase 
+        #
+        #     macro :should_be_cool do
+        #       should("be cool") { assert_equal("cool", @message) }
+        #     end
+        #
+        #     def setup
+        #       @message = "cool"
+        #     end
+        #     
+        #     use_macro :should_be_cool
+        #
+        #     context "intentionally fails" do
+        #       setup { @message = "not cool yo" }
+        #       use_macro :should_be_cool
+        #     end
+        #
+        #   end
+        #
         def use_macro(name)
           send(:"Macro: #{name}", Shoulda.current_context || self)
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: gabrielg-oughta
 version: !ruby/object:Gem::Version 
-  version: 0.0.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Gabriel Gironda
@@ -24,6 +24,7 @@ extra_rdoc_files:
 - LICENSE
 files: 
 - README.rdoc
+- VERSION.yml
 - lib/oughta.rb
 - lib/thumblemonks
 - lib/thumblemonks/oughta