template-test 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,7 @@
 # Template::Test
 
-TODO: Write a gem description
+Template::Test provides a simple DSL to test the rendering of HTML templates
+defined in ERB or HAML using XPATH expressions.
 
 ## Installation
 
@@ -8,22 +9,16 @@ Add this line to your application's Gemfile:
 
     gem 'template-test'
 
-And then execute:
+## Using with RSpec
 
-    $ bundle
+In your `test_helper.rb` include the `Template::Test module in the rspec config:
 
-Or install it yourself as:
+    require 'template-test'
 
-    $ gem install template-test
+    RSpec.configure do |config|
+       config.include Template::Test
+    end
 
-## Usage
+## Examples
 
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Have a look at the `*_spec.rb` files in the `spec` folder.

data/lib/template-test/version.rb

@@ -1,5 +1,5 @@
 module Template
   module Test
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/lib/template-test.rb

@@ -3,6 +3,10 @@ require 'nokogiri'
 
 module Template
   module Test
+    # Class that holds the context for a template
+    # Variables used by the template can be added to the
+    # context using the set method.
+    # @see #set
     class Context
       attr_accessor :nodes
 
@@ -12,7 +16,7 @@ module Template
         self.instance_eval(&block)
       end
 
-      # @return the parsed Nokogiri::HTML document that wraps the rendered template
+      # @return [Nokogiri::HTML] the document that wraps the rendered template
       # @param [Boolean] reload true if the document should be parsed again
       def document(reload = false)
         if reload
@@ -25,9 +29,9 @@ module Template
       # of the document which wraps the rendered template.
       # The nodes retrieved by the given xpath expression can
       # be accessed through the 'nodes' method.
-      # @param xpath an XPATH search expression
-      # @param block the testing code
-      # @example see #spec/erb_spec.rb
+      # @param [String] xpath an XPATH search expression
+      # @param [Proc] block the testing code
+      # @see {file:spec/erb_spec.rb}
       def xpath(xpath, &block)
         @xpath = xpath
         @nodes = document().xpath(@xpath)
@@ -37,7 +41,7 @@ module Template
       # Creates an instance variable which is available in the rendered template.
       # @param [Symbol] symbol the name of the instance variable
       # @param [Object] value the value of the instance variable
-      # @example see #spec/erb_spec.rb
+      # @see {file:spec/erb_spec.rb}
       def set(symbol, value)
         sym = "@#{symbol.to_s}".to_sym
         instance_variable_set(sym, value)
@@ -80,9 +84,10 @@ module Template
     end
 
     # Runs the test code in the provided block for the specified template.
-    # @param template_path the path to the template
-    # @param block a block containing the template testing code
-    # @example see #spec/erb_spec.rb
+    # @param [String] template_path the path to the template
+    # @param [Proc] block a block with the template testing code
+    # @see {file:spec/erb_spec.rb}
+    # @return [Context] the template test context
     def template(template_path, &block)
       Context.new(template_path, &block)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: template-test
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors: