ferb 0.5

data/LGPL30

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README

@@ -0,0 +1,2 @@
+ferb is a library that makes it easy to call code generated by ERB
+easily from within normal Ruby code

data/lib/ferb.rb

@@ -0,0 +1,303 @@
+# This is a mixin module that makes it easy to define methods on a
+# class that are expanded using an ERB template
+#
+# Author::    Jim Powers (mailto:jim@corruptmemory.com)
+# Copyright:: Copyright (c) 2008-2009 Jim Powers
+# License::   Distributed under the terms of the LGPLv3.0 or newer.  
+#             For details see the LGPL30 file
+#
+# == Example:
+# 
+# class Foo
+#  require 'ferb'
+#  include Ferb
+#
+#  def_template("hello_world(m)","<b><%= m %></b>")
+#
+# end
+#
+module Ferb
+  require 'erb'
+  require 'pathname'
+  require 'stringio'
+  require 'method_args'
+
+  # Enables support for reloading file templates at run-time
+  # if the file timestamp has changed
+  def self.enable_reload?
+    if defined?(@@enable_reload)
+      return @@enable_reload
+    else
+      return false
+    end
+  end
+
+  # Enables support for reloading file templates at run-time
+  # if the file timestamp has changed
+  def self.enable_reload=(val)
+    @@enable_reload = val
+  end
+
+  # The "callback" when this module is included by a class.  Extends
+  # the class with the metods defined in the inner 'ClassMethods'
+  # module
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+
+  def self.build_internal_template(signature,body)
+    body_rb = ERB.new(body,nil,'-').src
+    <<EOS
+def __ferb_#{signature}
+#{body_rb}
+end
+EOS
+  end
+
+
+  # Builds a string representing the definition of the function
+  def self.build_template(signature, clean_sig, source_file_data = nil, function = nil)
+    unless source_file_data
+    <<EOS
+def #{signature}
+  __ferb_#{clean_sig}
+end
+EOS
+    else
+    <<EOS
+def #{signature}
+  if Ferb.enable_reload?
+    full_path = '#{source_file_data[:full_path]}'
+    signature = '#{function}'
+    if should_reload?(full_path)
+      args = {:path => full_path}
+      template = Ferb.load_template(args)
+      add_timestamp(args[:full_path], args[:timestamp])
+      internal_func = Ferb.construct_internal_function_def(signature,template)
+      eval(internal_func)
+    end
+  end
+  __ferb_#{clean_sig}
+end
+EOS
+    end
+  end    
+
+  def self.load_template(args)
+    result = nil
+    path = nil
+    if args.has_key?(:path)
+      path = Pathname.new(args[:path].to_s.strip)
+    elsif args.has_key?(:file)
+      template_root = args[:template_root]
+      unless template_root.is_a?(Pathname)
+        template_root = Pathname.new(args[:template_root].to_s)
+      end
+      args[:template_root] = template_root
+      path = template_root+args[:file]
+    else
+      raise(":file or :path not specified: #{args.inspect}")
+    end
+    args[:full_path] = path.realpath
+    args[:timestamp] = path.mtime
+    path.open do |f|
+      result = f.read
+    end
+    result
+  end
+
+  def self.get_template_parts(template)
+    result = nil
+    if template and !template.strip.empty?
+      strio = StringIO.new(template)
+      first_line = strio.readline
+      if first_line.strip =~ /^<!--.*\|(.*)\|.*-->$/
+        sig = $1
+        body = strio.read
+        result = [sig, body]
+      else
+        body = template
+      end
+    end
+    result
+  end
+
+  def self.construct_function_sig(function, sig)
+    sig = sig.strip
+    if !sig.empty?
+      ["#{function.to_s.strip}(#{sig})", "#{function.to_s.strip}(#{MethodArgsHelper.get_args(sig).join(',')})"]
+    else
+      [function.to_s.strip, nil]
+    end
+  end
+
+  def self.construct_function_def(function, template, args = nil)
+    parts = get_template_parts(template)
+    funsig = nil
+    clean_sig = nil
+    if parts.is_a?(Array)
+      funsig, clean_sig = construct_function_sig(function,parts[0])
+    else
+      funsig = function
+    end
+    build_template(funsig, clean_sig, args, function)
+  end
+
+  def self.construct_internal_function_def(function, template)
+    parts = get_template_parts(template)
+    funsig = nil
+    clean_sig = nil
+    body = nil
+    if parts.is_a?(Array)
+      funsig, clean_sig = construct_function_sig(function,parts[0])
+      body = parts[1]
+    else
+      funsig = function
+      body = template
+    end
+    build_internal_template(funsig, body)
+  end
+
+  # Inner module holding the actual methods to be added to the class
+  module ClassMethods
+
+    public
+    # Hash of file timestamps
+    def file_timestamps
+      unless defined?(@file_timestamps)
+        @file_timestamps = {}
+      end
+      @file_timestamps
+    end
+
+    # Record file timestamps
+    def add_timestamp(path, time)
+      self.file_timestamps[path.to_s] = time
+    end
+
+    # Test file timestamps
+    def should_reload?(path)
+      time = Pathname.new(path.to_s).mtime
+      ts = self.file_timestamps[path]
+      if ts and (ts >= time)
+        return false;
+      else
+        return true
+      end
+    end
+
+    # Returns the root in the file system where ERB templates can be found
+    def template_root
+      if !defined?(@template_root)
+        @template_root = Pathname.new(File.expand_path(File.dirname(__FILE__)))
+      end
+      @template_root
+    end
+
+    # Sets the root in the file system where ERB templates can be found
+    def template_root=(location)
+      @template_root = Pathname.new(File.expand_path(location.to_s))
+    end
+
+
+    # Defines a template function as an instance method.  Creates the
+    # method directly on the class.
+    #
+    # == Arguments:
+    #
+    #  <tt>signature</tt> - (string) The complete signature including parameters
+    #  <tt>body</tt> - (string) The body of the functionusing ERB syntax
+    #
+    # == Example:
+    #
+    # def_template("hello_world(message)","<b><%= message %></b>")
+    #
+    def def_template(signature,args)
+      if args.is_a?(String)
+        internal_func = Ferb.construct_internal_function_def(signature,args)
+        external_func = Ferb.construct_function_def(signature,args)
+        module_eval(internal_func)
+        module_eval(external_func)
+      elsif args.is_a?(Hash)
+        args = { :template_root => template_root}.merge(args)
+        template = Ferb.load_template(args)
+        add_timestamp(args[:full_path], args[:timestamp])
+        internal_func = Ferb.construct_internal_function_def(signature,template)
+        external_func = Ferb.construct_function_def(signature,template,args)
+        module_eval(internal_func)
+        module_eval(external_func)
+      end
+    end
+  end
+
+  def file_timestamps
+    unless defined?(@file_timestamps)
+      @file_timestamps = {}
+    end
+    @file_timestamps
+  end
+
+  # Record file timestamps
+  def add_timestamp(path, time)
+    self.file_timestamps[path] = time
+  end
+
+  # Test file timestamps
+  def should_reload?(path)
+    time = Pathname.new(path).mtime
+    ts = self.file_timestamps[path]
+    if ts and (ts >= time)
+      return false;
+    else
+      return true
+    end
+  end
+
+  # Returns the root in the file system where ERB templates can be found
+  def template_root
+    if !defined?(@template_root)
+      if self.class.respond_to?(:template_root)
+        @template_root = self.class.template_root
+      else
+        @template_root = Pathname.new(File.expand_path(File.dirname(__FILE__)))
+      end
+    end
+    @template_root
+  end
+
+  # Sets the root in the file system where ERB templates can be found
+  def template_root=(location)
+    @template_root = Pathname.new(File.expand_path(location))
+  end
+
+  # Defines a template function in an individual object (only
+  # available to a prticular instance) as an instance method.  Creates
+  # the method directly on the object (instance).
+  #
+  # == Arguments:
+  #
+  #  <tt>signature</tt> - (string) The complete signature including parameters
+  #  <tt>body</tt> - (string) The body of the functionusing ERB syntax
+  #
+  # == Example:
+  #
+  # obj.def_template("hello_world(message)","<b><%= message %></b>")
+  #
+  def def_template(signature,args)
+    if args.is_a?(String)
+      internal_func = Ferb.construct_internal_function_def(signature,args)
+      external_func = Ferb.construct_function_def(signature,args)
+      eval(internal_func)
+      eval(external_func)
+    elsif args.is_a?(Hash)
+      args = { :template_root => template_root}.merge(args)
+      template = Ferb.load_template(args)
+      add_timestamp(args[:full_path], args[:timestamp])
+      internal_func = Ferb.construct_internal_function_def(signature,template)
+      external_func = Ferb.construct_function_def(signature,template,args)
+      eval(internal_func)
+      eval(external_func)
+    end
+  end
+
+end

data/lib/ferb_helper.rb

@@ -0,0 +1,29 @@
+# Helper module to make it easy to use Ferb within Rails
+#
+# Author::    Jim Powers (mailto:jim@corruptmemory.com)
+# Copyright:: Copyright (c) 2008-2009 Jim Powers
+# License::   Distributed under the terms of the LGPLv3.0 or newer.
+#             For details see the LGPL30 file
+#
+# To use require <tt>ferb_helper</tt> in your environment.rb file.  Then
+# include <tt>FerbHelper</tt> in any helper files you wish.  Also, to use
+# within your controllers add the following to your application cotroller:
+#
+# def self.inherited(subclass)
+#   super(subclass)
+#   subclass.send :include, FerbHelper
+# end
+#
+require 'ferb'
+module FerbHelper
+  def self.included(base)
+    base.send :include, Ferb
+    path_suffix = ''
+    if base.name =~ /Helper$/i
+      path_suffix = "#{base.name.gsub(/Helper$/,'').underscore}/"
+    elsif base.name =~ /Controller$/i
+      path_suffix = "#{base.name.gsub(/Controller$/,'').underscore}/"
+    end
+    base.template_root = Pathname.new(RAILS_ROOT)+'app/views/' + path_suffix
+  end
+end

data/lib/method_args.rb

@@ -0,0 +1,115 @@
+# Code to extract the formal parameter names and types from a function
+# given a standard Ruby function argument signature.  Original code based
+# on the MethodArgs module written by Mauricio Fernandez <mfp@acm.org>
+# (http://eigenclass.org).  Updated to work with function signatures added at
+# runtime, also, peroperly handles block arguments.
+#
+# Author::    Jim Powers (mailto:jim@corruptmemory.com)
+# Copyright:: Copyright (c) 2008-2009 Jim Powers
+# License::   Distributed under the terms of the LGPLv3.0 or newer.
+#             For details see the LGPL30 file
+#
+# == Example:
+#
+# require 'method_args'
+# MethodArgsHelper.get_args("a, b = {}, *c, &d")
+# => ["a", "b", "*c", "&d"]
+#
+# Very useful for building proxy functions that call an underlying function
+#
+class MethodArgs
+  MAX_ARGS = 20
+  attr_reader :params
+
+  def output_method_info(klass, object, meth, is_singleton = false)
+    @params = nil
+    @values = nil
+    num_args = 0
+    unless %w[initialize].include?(meth.to_s)
+      if is_singleton
+        return if class << klass; private_instance_methods(true) end.include?(meth.to_s)
+      else
+        return if class << object; private_instance_methods(true) end.include?(meth.to_s)
+      end
+    end
+    arity = is_singleton ? object.method(meth).arity : klass.instance_method(meth).arity
+    set_trace_func lambda{|event, file, line, id, binding, classname|
+      begin
+        if event[/call/] && classname == MethodArgsHelper && id == meth
+          @params = eval("local_variables", binding)
+          @values = eval("local_variables.map{|x| eval(x)}", binding)
+          throw :done
+        end
+      rescue Exception
+      end
+    }
+    if arity >= 0
+      num_args = arity
+      catch(:done){ object.send(meth, *(0...arity)) }
+    else
+      # determine number of args (including splat & block)
+      MAX_ARGS.downto(arity.abs - 1) do |i|
+        catch(:done) do
+          begin
+            object.send(meth, *(0...i))
+          rescue Exception
+          end
+        end
+        next if !@values || @values.compact.empty?
+        k = nil
+        @values.each_with_index{|x,j| break (k = j) if Array === x}
+        if k
+          num_args = k+1
+        else
+          num_args = i
+        end
+      end
+      args = (0...arity.abs-1).to_a
+      catch(:done) do
+        args.empty? ? object.send(meth) : object.send(meth, *args)
+      end
+    end
+    set_trace_func(nil)
+    fmt_params = lambda do |arr, arity|
+      arr.inject([[], 0]) do |(a, i), x|
+        if Array === @values[i]
+          [a << "*#{x}", i+1]
+        else
+          [a << x, i+1]
+        end
+      end.first
+    end
+    original_params = @params
+    @params ||= []
+    @params = @params[0,num_args]
+    @params = fmt_params.call(@params,arity)
+    if @params.length < original_params.length
+      @params << "&#{original_params[-1]}"
+    end
+    set_trace_func(nil)
+  end
+end
+
+class MethodArgsHelper
+  @@last_args = nil
+
+  def self.method_added(meth)
+    begin
+      o = self.allocate
+    rescue Exception
+      p $!
+    end
+    ma = MethodArgs.new
+    ma.output_method_info(self, o, meth, false)
+    @@last_args = ma.params
+  end
+
+  def self.get_args(sig)
+    class_eval <<EOS
+def tester(#{sig})
+end
+EOS
+    @@last_args
+  end
+end
+

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification 
+name: ferb
+version: !ruby/object:Gem::Version 
+  version: "0.5"
+platform: ruby
+authors: 
+- Jim Powers
+autorequire: erb
+bindir: bin
+cert_chain: 
+date: 2009-08-01 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: jim@corruptmemory.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LGPL30
+files: 
+- lib/ferb.rb
+- lib/method_args.rb
+- lib/ferb_helper.rb
+- README
+- LGPL30
+has_rdoc: true
+homepage: http://www.corruptmemory.com/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 1
+summary: Makes it easy to write functions that expand to arbitrary tempaltes using ERB
+test_files: []
+