markbates-yamler 0.0.3 → 0.0.4

data/README

@@ -9,6 +9,16 @@ several YAML files into one file, because other wise it would be too big
 and unwieldy to manage. Enter Yamler:
 
 === Examples:
-  # This will read the file in, parse it through ERB, and then run it
-  # through YAML#load
+  # Renders said file through ERB, and then through YAML.load:
   Yamler.load('/path/to/file.yml')
+
+  # Does the same as above but makes a method called say_hi
+  # available to the binding of the Yamler::Template instance.
+  Yamler.load('/path/to/file.yml') do
+    def say_hi
+      'hi'
+    end
+  end
+  
+  # Renders said file through ERB, and then through YAML.load:
+  Yamler.load('/path/to/file.yml', {:locals => {:username => 'markbates'}, :foo => :bar})

data/lib/yamler/template.rb

@@ -2,10 +2,24 @@ module Yamler
   
   class Template
     
-    attr_accessor :path # :nodoc:
+    # The path of the YAML file to be rendered
+    attr_accessor :path
+    # Options that are available to the YAML file.
     attr_accessor :options
     
     # Takes the path to the YAML file you wish to render.
+    # An optional <tt>Hash</tt> of options can be passed in.
+    # These options are available via the <tt>options</tt> accessor.
+    # If there is a <tt>Hash</tt> in the <tt>options</tt> called
+    # <tt>:locals</tt> then the keys of that <tt>Hash are available</tt>
+    # as local methods.
+    # 
+    # Examples:
+    #   Yamler::Template.new('/path/to/file.yml', {:locals => {:username => 'markbates'}, :foo => :bar})
+    #   
+    #   # in file.yml:
+    #   username: <%= username %> # => 'markbates'
+    #   foo: <%= options[:foo] %> # => :bar
     def initialize(path, options = {})
       self.path = File.expand_path(path)
       self.options = options
@@ -19,7 +33,7 @@ module Yamler
       res
     end
     
-    def method_missing(sym, *args)
+    def method_missing(sym, *args) # :nodoc:
       raise NoMethodError.new(sym.to_s) if self.options[:locals].nil? || self.options[:locals][sym].nil?
       return self.options[:locals][sym]
     end
@@ -43,6 +57,7 @@ module Yamler
       Yamler::Template.new(path).render(binding)
     end
     
+    # Returns the path of the current YAML file.
     def __FILE__
       self.path
     end

data/lib/yamler/yamler.rb

@@ -5,6 +5,9 @@ module Yamler
     # Mimics <tt>YAML#load</tt>, except that it creates a new <tt>Yamler::Template</tt>
     # class and calls the <tt>render</tt> method on <tt>Yamler::Template</tt>.
     # 
+    # An optional <tt>Hash</tt> of options can be passed in. See <tt>Yamler::Template</tt>
+    # for more information.
+    # 
     # If a block is passed in the contents of that block will be made available to
     # ERB when the rendering occurs.
     # 
@@ -12,8 +15,8 @@ module Yamler
     #   # Renders said file through ERB, and then through YAML.load:
     #   Yamler.load('/path/to/file.yml')
     # 
-    #   Does the same as above but makes a method called say_hi
-    #   available to the binding of the Yamler::Template instance.
+    #   # Does the same as above but makes a method called say_hi
+    #   # available to the binding of the Yamler::Template instance.
     #   Yamler.load('/path/to/file.yml') do
     #     def say_hi
     #       'hi'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: markbates-yamler
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - markbates