ember 0.0.1 → 0.1.0

data/inochi.opts

@@ -0,0 +1,31 @@
+##
+# Location where project documentation will be uploaded by `inochi pub:doc`.
+# This value can utilize any remote/destination syntax supported by `rsync`.
+#
+:pub_doc_target: ~/www/lib/ember
+
+##
+# Options for the `rsync` command used to upload this project's documentation.
+#
+:pub_doc_options: --verbose --compress --archive --update --delete
+
+##
+# Arbitrary Ruby code that will configure this project's RubyGem before it
+# is built by `inochi gem`.  This code has access to a local variable named
+# `gem` which holds a Gem::Specification object representing this project.
+#
+# @example
+#
+#   :gem_spec_logic: |
+#     # show the Inochi-provided specification for this project's RubyGem
+#     puts gem
+#
+#     # add files that are outside this project directory to the RubyGem
+#     gem.files += FileList['/some/outside/**/*.files']
+#
+#     # omit some files in this project's directory from the RubyGem
+#     gem.files.exclude '{some*files,in_this,project/**/directory}'
+#
+#     # and so on...  anything is possible!  use your imagination!
+#
+:gem_spec_logic: |

data/lib/ember.rb

@@ -1,16 +1,2 @@
-#--
-# Copyright protects this work.
-# See LICENSE file for details.
-#++
-
-require 'rubygems'
-gem 'inochi', '~> 1'
-require 'inochi'
-
-Inochi.init :Ember,
-  :version => '0.0.1',
-  :release => '2009-10-03',
-  :website => 'http://snk.tuxfamily.org/lib/ember/',
-  :tagline => 'eRuby template processor'
-
+require 'ember/inochi'
 require 'ember/template'

data/lib/ember/inochi.rb

@@ -0,0 +1,103 @@
+module Ember
+
+  ##
+  # Official name of this project.
+  #
+  PROJECT = "Ember"
+
+  ##
+  # Short single-line description of this project.
+  #
+  TAGLINE = "eRuby template processor"
+
+  ##
+  # Address of this project's official home page.
+  #
+  WEBSITE = "http://snk.tuxfamily.org/lib/ember/"
+
+  ##
+  # Number of this release of this project.
+  #
+  VERSION = "0.1.0"
+
+  ##
+  # Date of this release of this project.
+  #
+  RELDATE = "2010-04-03"
+
+  ##
+  # Description of this release of this project.
+  #
+  def self.inspect
+    "#{PROJECT} #{VERSION} (#{RELDATE})"
+  end
+
+  ##
+  # Location of this release of this project.
+  #
+  INSTDIR = File.expand_path('../../..', __FILE__)
+
+  ##
+  # RubyGems required by this project during runtime.
+  #
+  # @example
+  #
+  #   RUNTIME = {
+  #     # this project needs exactly version 1.2.3 of the "an_example" gem
+  #     "an_example" => [ "1.2.3" ],
+  #
+  #     # this project needs at least version 1.2 (but not
+  #     # version 1.2.4 or newer) of the "another_example" gem
+  #     "another_example" => [ ">= 1.2" , "< 1.2.4" ],
+  #
+  #     # this project needs any version of the "yet_another_example" gem
+  #     "yet_another_example" => [],
+  #   }
+  #
+  RUNTIME = {}
+
+  ##
+  # RubyGems required by this project during development.
+  #
+  # @example
+  #
+  #   DEVTIME = {
+  #     # this project needs exactly version 1.2.3 of the "an_example" gem
+  #     "an_example" => [ "1.2.3" ],
+  #
+  #     # this project needs at least version 1.2 (but not
+  #     # version 1.2.4 or newer) of the "another_example" gem
+  #     "another_example" => [ ">= 1.2" , "< 1.2.4" ],
+  #
+  #     # this project needs any version of the "yet_another_example" gem
+  #     "yet_another_example" => [],
+  #   }
+  #
+  DEVTIME = {
+    "inochi" => [ "~> 2" ], # for managing this project
+    "dfect"  => [ "~> 2" ], # for unit testing
+  }
+
+  ##
+  # Loads the correct version (as defined by the {RUNTIME} or {DEVTIME}
+  # constant in this module) of the given gem or the gem that contains
+  # the given library.
+  #
+  def self.require gem_name_or_library
+    # prepare the correct version of the gem for loading
+    if respond_to? :gem
+      gem_name = gem_name_or_library.to_s.sub(%r{/.*$}, '')
+      if gem_version = RUNTIME[gem_name] || DEVTIME[gem_name]
+        begin
+          gem gem_name, *gem_version
+        rescue LoadError => error
+          warn "#{self.inspect}: #{error}"
+        end
+      end
+    end
+
+    # do the loading
+    super
+  end
+
+end

data/lib/ember/template.rb

@@ -1,8 +1,3 @@
-#--
-# Copyright protects this work.
-# See LICENSE file for details.
-#++
-
 require 'pathname'
 
 module Ember
@@ -13,53 +8,44 @@ module Ember
     #
     # This processor transforms the given input
     # into an executable Ruby program (provided
-    # by the #program() method) which is then
-    # executed by the #render() method on demand.
+    # by the {#program} method) which is then
+    # executed by the {#render} method on demand.
     #
     # eRuby directives that contribute to the output of
     # the given template are called "vocal" directives.
     # Those that do not are called "silent" directives.
     #
-    # ==== Options
+    # @option options [String] :result_variable ("_erbout")
     #
-    # [:result_variable]
     #   Name of the variable which stores the result of
     #   template evaluation during template evaluation.
     #
-    #   The default value is "_erbout".
+    # @option options [Boolean] :continue_result (false)
     #
-    # [:continue_result]
     #   Append to the result variable if it already exists?
     #
-    #   The default value is false.
+    # @option options [String] :source_file ("SOURCE")
     #
-    # [:source_file]
     #   Name of the file which contains the given input.  This
     #   is shown in stack traces when reporting error messages.
     #
-    #   The default value is "SOURCE".
+    # @option options [Integer] :source_line (1)
     #
-    # [:source_line]
     #   Line number at which the given input exists in the :source_file.
     #   This is shown in stack traces when reporting error messages.
     #
-    #   The default value is 1.
+    # @option options [Boolean] :shorthand (false)
     #
-    # [:shorthand]
     #   Treat lines beginning with "%" as eRuby directives?
     #
-    #   The default value is false.
-    #
-    # [:infer_end]
-    #   Add missing <% end %> statements based on indentation?
+    # @option options [Boolean] :infer_end (false)
     #
-    #   The default value is false.
+    #   Add missing +<% end %>+ statements based on indentation?
     #
-    # [:unindent]
-    #   Unindent the content of eRuby blocks (everything
-    #   between <% do %> ...  <% end %>) hierarchically?
+    # @option options [Boolean] :unindent (false)
     #
-    #   The default value is false.
+    #   Unindent the content of eRuby blocks---that is everything
+    #   between the +<% do %>+ and +<% end %>+ tags---hierarchically?
     #
     def initialize input, options = {}
       @options = options
@@ -79,7 +65,7 @@ module Ember
 
     ##
     # Returns the result of executing the Ruby program for this template
-    # (provided by the #program() method) inside the given context binding.
+    # (provided by the {#program} method) inside the given context binding.
     #
     def render context = TOPLEVEL_BINDING, parent_context_id = nil
       context ||= @@contexts[parent_context_id] # inherit parent context
@@ -141,72 +127,71 @@ module Ember
     OPERATION_EVAL_TEMPLATE_STRING = '~'
     OPERATION_INSERT_PLAIN_FILE    = '<'
 
-    #:stopdoc:
+    OPERATIONS = [
+      OPERATION_COMMENT_LINE,
+      OPERATION_BEGIN_LAMBDA,
+      OPERATION_EVAL_EXPRESSION,
+      OPERATION_EVAL_TEMPLATE_FILE,
+      OPERATION_EVAL_TEMPLATE_STRING,
+      OPERATION_INSERT_PLAIN_FILE,
+    ]
 
-    OPERATIONS            = [
-                              OPERATION_COMMENT_LINE,
-                              OPERATION_BEGIN_LAMBDA,
-                              OPERATION_EVAL_EXPRESSION,
-                              OPERATION_EVAL_TEMPLATE_FILE,
-                              OPERATION_EVAL_TEMPLATE_STRING,
-                              OPERATION_INSERT_PLAIN_FILE,
-                            ]
+    SILENT_OPERATIONS = [
+      OPERATION_COMMENT_LINE,
+      OPERATION_BEGIN_LAMBDA,
+    ]
 
-    SILENT_OPERATIONS     = [
-                              OPERATION_COMMENT_LINE,
-                              OPERATION_BEGIN_LAMBDA,
-                            ]
+    VOCAL_OPERATIONS = OPERATIONS - SILENT_OPERATIONS
 
-    VOCAL_OPERATIONS      = OPERATIONS - SILENT_OPERATIONS
+    DIRECTIVE_HEAD = '<%'
+    DIRECTIVE_BODY = '(?:(?#
+                        there is nothing here, before the alternation,
+                        because we want to match the "<%%>" base case
+                      )|[^%](?:.(?!<%))*?)'
+    DIRECTIVE_TAIL = '-?%>'
 
-    DIRECTIVE_HEAD        = '<%'
-    DIRECTIVE_BODY        = '(?:(?#
-                                there is nothing here before the alternation
-                                because we want to match the "<%%>" base case
-                              )|[^%](?:.(?!<%))*?)'
-    DIRECTIVE_TAIL        = '-?%>'
+    SHORTHAND_HEAD = '%'
+    SHORTHAND_BODY = '(?:(?#
+                        there is nothing here, before the alternation,
+                        because we want to match the "<%%>" base case
+                      )|[^%].*)'
+    SHORTHAND_TAIL = '$'
 
-    SHORTHAND_HEAD        = '%'
-    SHORTHAND_BODY        = '(?:(?#
-                                there is nothing here before the alternation
-                                because we want to match the "<%%>" base case
-                              )|[^%].*)'
-    SHORTHAND_TAIL        = '$'
+    NEWLINE = '\r?\n'
+    SPACING = '[[:blank:]]*'
 
-    NEWLINE               = '\r?\n'
-    SPACING               = '[[:blank:]]*'
+    MARGIN_REGEXP = /^#{SPACING}(?=\S)/o
 
-    MARGIN_REGEXP         = /^#{SPACING}(?=\S)/o
+    LAMBDA_BEGIN_REGEXP = /\b(do)\b\s*(\|.*?\|)?\s*$/
 
-    LAMBDA_BEGIN_REGEXP   = /\b(do)\b\s*(\|.*?\|)?\s*$/
+    build_keyword_regexp = lambda {|*words| /\A\s*\b(#{words.join '|'})\b/ }
 
-    build_keyword_regexp  = lambda {|*words| /\A\s*\b(#{words.join '|'})\b/ }
+    BLOCK_BEGIN_REGEXP = build_keyword_regexp[
+      # generic
+      :begin,
 
-    BLOCK_BEGIN_REGEXP    = build_keyword_regexp[
-                              # generic
-                              :begin,
+      # conditional
+      :if, :unless, :case,
 
-                              # conditional
-                              :if, :unless, :case,
+      # loops
+      :for, :while, :until,
 
-                              # loops
-                              :for, :while, :until
-                            ]
+      # scopes
+      :def, :class, :module
+    ]
 
     BLOCK_CONTINUE_REGEXP = build_keyword_regexp[
-                              # generic
-                              :rescue, :ensure,
+      # generic
+      :rescue, :ensure,
 
-                              # conditional
-                              :else, :elsif, :when
-                            ]
+      # conditional
+      :else, :elsif, :when
+    ]
 
-    BLOCK_END_REGEXP      = build_keyword_regexp[
-                              # generic
-                              :end
-                            ]
-
-    #:startdoc:
+    BLOCK_END_REGEXP = build_keyword_regexp[
+      # generic
+      :end
+    ]
 
     ##
     # Transforms the given eRuby template into an executable Ruby program.
@@ -237,6 +222,9 @@ module Ember
           template = contents.zip(directives).join
         end
 
+      # convert single-line comment directives into nothing
+        template.gsub!(/^#{SPACING}#{DIRECTIVE_HEAD}##{DIRECTIVE_BODY}#{DIRECTIVE_TAIL}#{SPACING}$/, '')
+
       # translate template into Ruby code
         @margins = []
         @crowns  = []
@@ -593,4 +581,4 @@ module Ember
       Statement = Struct.new :type, :value
     end
   end
-end
+end

data/test/combinatorics.rb

@@ -0,0 +1,188 @@
+# Simple combinatorics library for Ruby 1.8, 1.9, and (hopefully) beyond.
+#
+# (the ISC license)
+#
+# Copyright 2007 Suraj N. Kurapati <sunaku@gmail.com>
+#
+# Permission to use, copy, modify, and/or distribute this software for any
+# purpose with or without fee is hereby granted, provided that the above
+# copyright notice and this permission notice appear in all copies.
+#
+# THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+# WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+# MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+# ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+# ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+# OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+#
+class Array
+  unless method_defined? :enumeration
+    ##
+    # Returns all possible enumerations made from
+    # sample_size number of items from this list.
+    #
+    # @param [Integer] sample_size
+    #   The length of each enumeration.
+    #
+    # @param [Proc] sampler
+    #   If given, each enumeration is passed to this block.
+    #
+    def enumeration(sample_size = self.length, &sampler)
+      return [] if sample_size < 1
+
+      results = []
+
+      visitor = lambda do |parents|
+        each do |child|
+          result = parents + [child]
+
+          if result.length < sample_size
+            visitor.call result
+          else
+            yield result if block_given?
+            results << result
+          end
+        end
+      end
+
+      visitor.call []
+      results
+    end
+  end
+
+  unless method_defined? :enumerations
+    ##
+    # Returns all possible enumerations of all possible lengths.
+    #
+    # @param [Proc] sampler
+    #   If given, each enumeration is passed to this block.
+    #
+    def enumerations &sampler
+      all_lengths_impl :enumeration, &sampler
+    end
+  end
+
+  unless method_defined? :combination
+    ##
+    # Returns all possible combinations made from
+    # sample_size number of items from this list.
+    #
+    # @param [Integer] sample_size
+    #   The length of each combination.
+    #
+    # @param [Proc] sampler
+    #   If given, each combination is passed to this block.
+    #
+    def combination(sample_size = self.length, &sampler)
+      pnk_cnk_impl(sample_size, true, &sampler)
+    end
+  end
+
+  unless method_defined? :combinations
+    ##
+    # Returns all possible combinations of all possible lengths.
+    #
+    # @param [Proc] sampler
+    #   If given, each combination is passed to this block.
+    #
+    def combinations &sampler
+      all_lengths_impl :combination, &sampler
+    end
+  end
+
+  unless method_defined? :permutation
+    ##
+    # Returns all possible permutations made from
+    # sample_size number of items from this list.
+    #
+    # @param [Integer] sample_size
+    #   The length of each permutation.
+    #
+    # @param [Proc] sampler
+    #   If given, each permutation is passed to this block.
+    #
+    def permutation(sample_size = self.length, &sampler)
+      pnk_cnk_impl(sample_size, false, &sampler)
+    end
+  end
+
+  unless method_defined? :permutations
+    ##
+    # Returns all possible permutations of all possible lengths.
+    #
+    # @param [Proc] sampler
+    #   If given, each permutation is passed to this block.
+    #
+    def permutations &sampler
+      all_lengths_impl :permutation, &sampler
+    end
+  end
+
+  private
+
+  ##
+  # Returns results of the given method name for all possible sample sizes.
+  #
+  def all_lengths_impl method_name, &sampler
+    results = []
+
+    0.upto(length) do |i|
+      results << __send__(method_name, i, &sampler)
+    end
+
+    results
+  end
+
+  ##
+  # Common implementation for permutation and combination functions.
+  #
+  # @param [Integer] sample_size
+  #   Maximum depth of traversal, at which point to stop
+  #   further traversal and to start collecting results.
+  #
+  # @param [boolean] exclude_parents
+  #   Prevent already visited vertices from being
+  #   visited again in subsequent iterations?
+  #
+  def pnk_cnk_impl sample_size, exclude_parents
+    results = []
+
+    if sample_size >= 0 && sample_size < self.length
+      ##
+      # @param [#each] parents
+      #   list of visited vertices, including the current vertex
+      #
+      # @param [#each] children
+      #   list of unvisited vertices adjacent to current vertex
+      #
+      # @param [Integer] depth
+      #   current depth of the traversal tree
+      #
+      visitor = lambda do |parents, children, depth|
+        # traverse the graph until we reach the fringe
+        # vertices (leaf nodes of the traversal tree)
+        if depth < sample_size - 1
+          children.each do |c|
+            next_children = children - (exclude_parents ? parents : [c])
+            next_parents  = parents + [c]
+            next_depth    = depth + 1
+
+            visitor.call next_parents, next_children, next_depth
+          end
+        else
+          # now we have reached the fringe vertices
+          children.each do |c|
+            result = parents + [c]
+            yield result if block_given?
+            results << result
+          end
+        end
+      end
+
+      visitor.call [], self, 0
+    end
+
+    results
+  end
+end