RubyGems - fun_with_templates - Versions diffs - 0.0.3 - Mend

fun_with_templates 0.0.3

Files changed (46) hide show

checksums.yaml +15 -0
data/.document +5 -0
data/CHANGELOG.markdown +6 -0
data/Gemfile +18 -0
data/LICENSE.txt +20 -0
data/README.rdoc +67 -0
data/Rakefile +45 -0
data/VERSION +1 -0
data/lib/fun_with/core_extensions/kernel.rb +18 -0
data/lib/fun_with/templates/directory_builder.rb +36 -0
data/lib/fun_with/templates/filename_var_data.rb +42 -0
data/lib/fun_with/templates/template_evaluator.rb +307 -0
data/lib/fun_with_templates.rb +4 -0
data/test/helper.rb +57 -0
data/test/templates/00/a.rb.template +7 -0
data/test/templates/00/dir/subdir/style.css +4 -0
data/test/templates/00/seqfiles/page%0000i%.html.template +12 -0
data/test/templates/00/seqfiles/page%j%.html.template +12 -0
data/test/templates/00/seqfiles/page_about_%critter_name%.html.template +15 -0
data/test/templates/01/%string.length%/%string%-%string.length%.nontemplate +1 -0
data/test/templates/01/%string.length%/%string%-%string.length%.txt.template +1 -0
data/test/templates/02/%class%.rb.template +6 -0
data/test/templates/03/coordinates.%i%-%j%-%k%.html.template +14 -0
data/test/templates/03/dir%0000i%/dir%0000j%/file%0000k%.py.template +1 -0
data/test/templates/03/index.html.template +22 -0
data/test/templates/epf/book/afterword.markdown +4 -0
data/test/templates/epf/book/chapter-%0000chapter%.markdown.template +4 -0
data/test/templates/epf/book/cover.xhtml.template +13 -0
data/test/templates/epf/book/foreword.markdown +6 -0
data/test/templates/epf/book/images/cover.png +0 -0
data/test/templates/epf/book/stylesheets/stylesheet.css +2 -0
data/test/templates/epf/book/title_page.markdown.template +5 -0
data/test/templates/epf/notes/character.%character.name_for_file%.markdown.template +15 -0
data/test/templates/epf/notes/images/cover.png +0 -0
data/test/templates/epf/notes/stylesheets/stylesheet.css +2 -0
data/test/templates/epf/settings/actions/local_action.rb.example +14 -0
data/test/templates/epf/settings/config.rb.template +52 -0
data/test/templates/epf/settings/htmlizers.rb +83 -0
data/test/templates/epf/settings/wordcount.template +6 -0
data/test/test_directory_builder.rb +24 -0
data/test/test_filename_var_data.rb +51 -0
data/test/test_fun_with_templates.rb +21 -0
data/test/test_parse_filename_vars.rb +25 -0
data/test/test_string_templates.rb +14 -0
data/test/test_write_example_templates.rb +149 -0
metadata +202 -0

data/lib/fun_with_templates.rb ADDED Viewed

@@ -0,0 +1,4 @@
+require 'fun_with_gems'
+require 'erb'
+FunWith::Gems.make_gem_fun( "FunWith::Templates" )

data/test/helper.rb ADDED Viewed

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'bundler'
+require 'debugger'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'shoulda'
+require 'fun_with_templates'
+require 'fun_with_testing'
+class FunWith::Templates::TestCase < FunWith::Testing::TestCase
+  gem_to_test( FunWith::Templates )
+  FunWith::Templates.gem_test_mode = true
+  FunWith::Templates.gem_verbose = false
+  # include FunWith::Templates
+  include FunWith::Testing::Assertions::Basics
+  include FunWith::Testing::Assertions::FunWithFiles
+  def epf_template_vars( overrides = {} )
+    vars = {
+      :book => {
+        :title => "The Dawning of the Elluini",
+        :author => "Manchester Von Spittleman",
+        :license => "Creative Commons",
+        :publisher => "PUBLISHER NAME",
+        :original_publication => "2014-01-01"
+      },
+      :character => {
+        :name => "Wilford Brimley",
+        :name_for_file => "wilford_brimley",
+        :age => "Older than time itself",
+        :summary => "The Faceless Old Man Who Secretly Lives In Your Home",
+        :description => "Gentle, wizened, concerned about your bowel movements."
+      },
+      :chapter => (1..20),
+      :git => {
+        :repo => "/home/barry/git/the_dawning_of_the_elluini.epubforge.git",
+        :remote_host => "m.slashdot.org",
+        :remote_user => "barry",
+        :repo_id     => "36ce67680bbf6fc4d64741cbc3980fa5"
+      }
+    }
+    vars.merge( overrides )
+  end
+end

data/test/templates/00/a.rb.template ADDED Viewed

@@ -0,0 +1,7 @@
+module <%= @module %>
+  class <%= @class %>
+    def <%= @method %>( <%= @args.join(", ") %> )
+      <%= @args.join( " * " ) %>
+    end
+  end
+end

data/test/templates/00/dir/subdir/style.css ADDED Viewed

@@ -0,0 +1,4 @@
+h1.title{
+  font-size: 18pt;
+  font-weight: bold;
+}

data/test/templates/00/seqfiles/page%0000i%.html.template ADDED Viewed

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <title>This is page <%= @i %></title>
+</head>
+<body>
+  <h1>Page <%= @i %></h1>
+</body>
+</html>

data/test/templates/00/seqfiles/page%j%.html.template ADDED Viewed

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <title>This is page <%= @j %></title>
+</head>
+<body>
+  <h1>Page <%= @j %></h1>
+</body>
+</html>

data/test/templates/00/seqfiles/page_about_%critter_name%.html.template ADDED Viewed

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <title>Behold the mighty <%= @critter_name %>!</title>
+</head>
+<body>
+  <h1>This page is about the <%= @critter_name %></h1>
+  <% critter = @critters[@critter_name] %>
+  <p>The <%= @critter_name %> is <%= critter[:attributes][0] %> and <%= critter[:attributes][1] %></p>
+</body>
+</html>

data/test/templates/01/%string.length%/%string%-%string.length%.nontemplate ADDED Viewed

	@@ -0,0 +1 @@
1	+ Some strings have some lengths. But who can know for sure?

data/test/templates/01/%string.length%/%string%-%string.length%.txt.template ADDED Viewed

	@@ -0,0 +1 @@
1	+ string <%= @string %> has length <%= @string.length %>

data/test/templates/02/%class%.rb.template ADDED Viewed

@@ -0,0 +1,6 @@
+class <%= @class.camelize %>
+  <% for method in @methods %>
+    def <%= method[:name] %>(<%= method[:args] %>)
+    end
+  <% end %>
+end

data/test/templates/03/coordinates.%i%-%j%-%k%.html.template ADDED Viewed

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <title>This is page for sector (<%= @i %>, <%= @j %>, <%= @k %>)</title>
+</head>
+<body>
+  <h1>This is page for sector (<%= @i %>, <%= @j %>, <%= @k %>)</h1>
+  <p>This sector is full of things.</p>
+</body>
+</html>

data/test/templates/03/dir%0000i%/dir%0000j%/file%0000k%.py.template ADDED Viewed

	@@ -0,0 +1 @@
1	+ <%= @i %>-<%= @j %>-<%= @k %>

data/test/templates/03/index.html.template ADDED Viewed

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <title>Links to all sectors</title>
+</head>
+<body>
+  <h1>Sectors</h1>
+  <ul>
+  <% for i in @i %>
+    <% for j in @j %>
+      <% for k in @k %>
+        <li><a href="coordinates.<%= i %>-<%= j %>-<%= k %>.html">Sector (<%= i %>, <%= j %>, <%= k %>)</a></li>
+      <% end %>
+    <% end %>
+  <% end %>
+  </ul>
+</body>
+</html>

data/test/templates/epf/book/afterword.markdown ADDED Viewed

@@ -0,0 +1,4 @@
+You made it all the way through the book
+========================================
+When I started writing this book, I had no idea someone would make it all the way to the end.  Well done.  Now go find something else to do.

data/test/templates/epf/book/chapter-%0000chapter%.markdown.template ADDED Viewed

@@ -0,0 +1,4 @@
+Chapter <%= @chapter %>
+========<%= "=" * @chapter.to_s.length %>

data/test/templates/epf/book/cover.xhtml.template ADDED Viewed

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8" standalone="no"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+  "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+  <title><%= @book[:title] %>, by <%= @book[:author] %></title>
+</head>
+<body>
+  <p><img class="cover" alt="<%= @book[:title] %>, by <%= @book[:author] %>" src="<%= @book[:cover].nil? ? "../Images/cover.jpg" : @book[:cover].path %>" /></p>
+</body>
+</html>

data/test/templates/epf/book/foreword.markdown ADDED Viewed

@@ -0,0 +1,6 @@
+Foreword
+========
+I dedicate the book to me, without whom none of this would be written.
+And to my cat, for finally getting off the keyboard and letting me type.

data/test/templates/epf/book/images/cover.png ADDED Viewed

Binary file

data/test/templates/epf/book/stylesheets/stylesheet.css ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ div#epubforge_scene_description{ display: none }
2	+

data/test/templates/epf/book/title_page.markdown.template ADDED Viewed

@@ -0,0 +1,5 @@
+<%= @book[:title] %>
+<%= "=" * (@book[:title] || "===").length %>
+by <%= @book[:author] %>

data/test/templates/epf/notes/character.%character.name_for_file%.markdown.template ADDED Viewed

@@ -0,0 +1,15 @@
+<%= @character[:name] %>
+<%= "=" * (@character[:name] || "").length %>
+Summary
+-------
+<%= @character[:summary] %>
+Description
+-----------
+Age: <%= @character[:age] %>
+<%= @character[:description] %>

data/test/templates/epf/notes/images/cover.png ADDED Viewed

Binary file

data/test/templates/epf/notes/stylesheets/stylesheet.css ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ div#epubforge_scene_description{ display: none }
2	+

data/test/templates/epf/settings/actions/local_action.rb.example ADDED Viewed

@@ -0,0 +1,14 @@
+module EpubForge
+  module Action
+    class <%= @class_name %> < ThorAction
+      <% for action in @actions %>
+      desc( "<%= @slug %>:<%= action %>", "do action <%= action %>" )
+      def <%= action %>( project, *args )
+        puts "Do action <%= action %> to your project."
+      end
+      <% end %>
+    end
+  end
+end

data/test/templates/epf/settings/config.rb.template ADDED Viewed

@@ -0,0 +1,52 @@
+# Used by epubforge.
+metadata do
+  name "<%= @book[:title] || "My Book" %>"      # The title of the book
+  author "<%= @book[:author] || "Author" %>"             # Your moniker.  Your Nom de Plume.  The thing people say to get your attention.
+  license "<%= @book[:license] || "All Rights Reserved" %>"
+  publisher "<%= @book[:publisher] || 'My Publisher' %>"
+  original_publication  "<%= @book[:original_publication] || Time.now.strftime('%Y-%m-%d') %>" # The year this work was first published
+end
+filename "<%= (@book[:title] || "my_book").epf_underscorize %>"            # The default filename for your ebook (no extension).
+<% if @git %>
+############### GOT GIT? #####################################
+git do
+  repo_folder  "<%= @git[:repo] %>"
+  remote_host  "<%= @git[:host] %>"
+  remote_user  "<%= @git[:user] %>"
+  repo_id      "<%= @git[:repo_id] %>"
+end
+############### /GOT GIT? #####################################
+<% end %>
+# Any pages not listed here will be added
+# to the ebook after the listed pages, in alphabetical order of
+# filename.  In this example, the title_page.markdown file goes first,
+# then the foreword.markdown page, then chapters 1 and 2 (in alphanumeric order)
+# and finally the afterword.  Any pages not matched will be put after the
+# set of matched pages.
+pages do
+  book [
+    # matches title_page.markdown, title_page.textile, or
+    # title_page.(any other valid extension). This will be the first
+    # scene/chapter/division in the book.
+    "title_page",
+    "foreword",
+    # filename matches chapter, followed by anything.  If you have a page called
+    # chapter_summary that comes after, you might want to define the matcher more
+    # specifically, for example 'chapter-\d+'  (chapter followed by dash followed by any number of numbers).
+    #
+    "chapter-.*",
+    "afterword"
+  ]
+  notes [
+    # You can set the order that the notes entries appear in below.
+    "example89823786",
+    "example89723987"
+  ]
+end

data/test/templates/epf/settings/htmlizers.rb ADDED Viewed

@@ -0,0 +1,83 @@
+# Add htmlizer classes here.  They will be loaded and used in preference over the default htmlizers
+# The default htmlizers are given below as examples.
+#
+#
+# # This htmlizer leaves the input file unaltered
+# EpubForge::Utils::Htmlizer.define do |html|
+#   html.format     :xhtml
+#   html.group      :default
+#   html.executable "false"
+#   html.cmd        "cat {{f}}"
+# end
+#
+# # This htmlizer uses the multimarkdown executable.
+# # cmd explains to the htmlizer how to execute as a
+# # shell command:
+# #    {{x}} - name of the executable
+# #    {{o}} - then come the options
+# #    {{f}} - then the name of the file
+# # The output of the executable is captured.  The command you
+# # use should output html-tagged text (<h1>...</h1>, <p>...</p>, etc.),
+# # but not a complete html page.
+# EpubForge::Utils::Htmlizer.define do |html|
+#   html.format     :markdown
+#   html.group      :default                   # the default is :user, so user-defined ones don't have to set it
+#   html.executable "multimarkdown"
+#   html.cmd        "{{x}} {{o}} {{f}}"
+#   # html.opts       ""                         # the default
+# end
+#
+# EpubForge::Utils::Htmlizer.define do |html|
+#   html.format     :markdown
+#   html.group      :default
+#   html.executable "pandoc"
+#   html.cmd        "{{x}} {{o}} {{f}}"
+#   html.opts       "--from=markdown --to=html"
+# end
+#
+# EpubForge::Utils::Htmlizer.define do |html|
+#   html.format     :textile
+#   html.group      :default
+#   html.executable "pandoc"
+#   html.cmd        "{{x}} {{o}} {{f}}"
+#   html.opts       "--from=textile --to=html"
+# end
+#
+#
+# # Emergency backups
+# EpubForge::Utils::Htmlizer.define do |html|
+#   html.format     :markdown
+#   html.group      :fallback
+#   html.executable "false"
+#   html.cmd        "echo \"<pre>\" && cat {{f}} && echo \"</pre>\""
+# end
+#
+# EpubForge::Utils::Htmlizer.define do |html|
+#   html.format     :textile
+#   html.group      :fallback
+#   html.executable "false"
+#   html.cmd        "echo \"<pre>\" && cat {{f}} && echo \"</pre>\""
+# end
+#
+# EpubForge::Utils::Htmlizer.define do |html|
+#   html.format     :txt
+#   html.group      :fallback
+#   html.executable "false"
+#   html.cmd        "echo \"<pre>\" && cat {{f}} && echo \"</pre>\""
+# end
+#
+# # Would be nice to detect and strip out the outer tags
+# # leaving only the content.
+# EpubForge::Utils::Htmlizer.define do |html|
+#   html.format     :html
+#   html.group      :fallback
+#   html.executable "false"
+#   html.cmd        "cat {{f}}"
+# end
+#
+# EpubForge::Utils::Htmlizer.define do |html|
+#   html.format     :unknown
+#   html.group      :fallback
+#   html.executable "false"
+#   html.cmd        "echo \"<pre>\" && cat {{f}} && echo \"</pre>\""
+# end

data/test/templates/epf/settings/wordcount.template ADDED Viewed

@@ -0,0 +1,6 @@
+# Do not edit this file... I mean, unless you really know what you're doing.
+# If you do, then, please carry on.
+- <%= Time.parse( Time.now.strftime("%Y-%m-%d") ) %>:
+    Notes: 0
+    Book:  0

data/test/test_directory_builder.rb ADDED Viewed

@@ -0,0 +1,24 @@
+# require 'helper'
+# pulling this feature.  May not be worth implementing.
+# class TestDirectoryBuilder < FunWith::Templates::TestCase
+#   context "testing template() function which FWT adds to FunWith::Files::DirectoryBuilder" do
+#     setup do
+#       @templates_dir = FunWith::Templates.root("test", "templates")
+#     end
+#
+#     should "successfully print off a template" do
+#       FunWith::Files::DirectoryBuilder.tmpdir do |b|
+#         b.template( @templates_dir.join("00", "a.rb.template") ) do |coll|
+#           coll.var(:module, "Cats")
+#           coll.var(:class, "Kitten")
+#           coll.var(:args, %w(lick paws?))
+#         end
+#
+#
+#
+#         raise "WORK ON THIS!!!!"
+#       end
+#     end
+#   end
+# end