cutaneous 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Rakefile

@@ -0,0 +1,150 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = false
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/cutaneous.gemspec

@@ -0,0 +1,103 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'cutaneous'
+  s.version           = '0.1.0'
+  s.date              = '2012-07-23'
+  s.rubyforge_project = 'cutaneous'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Short description used in Gem listings."
+  s.description = "Long description. Maybe copied from the README."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Garry Hill"]
+  s.email    = 'garry@spontaneous.io'
+  s.homepage = 'https://github.com/SpontaneousCMS/cutaneous'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  ## If your gem includes any executables, list them here.
+  # s.executables = ["name"]
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  ## List your runtime dependencies here. Runtime dependencies are those
+  ## that are needed for an end user to actually USE your code.
+  # s.add_dependency('DEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## List your development dependencies here. Development dependencies are
+  ## those that are only needed during development
+  # s.add_development_dependency('DEVDEPNAME', [">= 1.1.0", "< 2.0.0"])
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE
+    README.md
+    Rakefile
+    cutaneous.gemspec
+    lib/cutaneous.rb
+    lib/cutaneous/compiler.rb
+    lib/cutaneous/compiler/expression.rb
+    lib/cutaneous/context.rb
+    lib/cutaneous/engine.rb
+    lib/cutaneous/lexer.rb
+    lib/cutaneous/loader.rb
+    lib/cutaneous/syntax.rb
+    lib/cutaneous/template.rb
+    test/fixtures/a.html.cut
+    test/fixtures/b.html.cut
+    test/fixtures/c.html.cut
+    test/fixtures/comments.html.cut
+    test/fixtures/d.html.cut
+    test/fixtures/e.html.cut
+    test/fixtures/error.html.cut
+    test/fixtures/expressions.html.cut
+    test/fixtures/include.html.cut
+    test/fixtures/include.rss.cut
+    test/fixtures/included_error.html.cut
+    test/fixtures/instance.html.cut
+    test/fixtures/instance_include.html.cut
+    test/fixtures/missing.html.cut
+    test/fixtures/other/different.html.cut
+    test/fixtures/other/error.html.cut
+    test/fixtures/partial.html.cut
+    test/fixtures/partial.rss.cut
+    test/fixtures/render.html.cut
+    test/fixtures/statements.html.cut
+    test/fixtures/target.html.cut
+    test/fixtures/whitespace.html.cut
+    test/helper.rb
+    test/test_blocks.rb
+    test/test_cache.rb
+    test/test_core.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/lib/cutaneous/compiler/expression.rb

@@ -0,0 +1,85 @@
+module Cutaneous
+  class Compiler
+    class Expression
+      def initialize(expression)
+        @expression = expression
+      end
+
+      def to_script
+        %{__buf << __decode_params((} << @expression << %{)) ; }
+      end
+
+      def affect(builder)
+        builder.push(self)
+      end
+    end
+
+    class EscapedExpression < Expression
+      def to_script
+        %{__buf << escape(__decode_params((} << @expression << %{))) ; }
+      end
+    end
+
+    class Statement < Expression
+      def to_script
+        "" << @expression << " ; "
+      end
+    end
+
+    class Text < Expression
+      BEGINNING_WHITESPACE ||= /\A(\s*?[\r\n]+)/
+
+      def initialize(expression, strip_whitespace = false)
+        @whitespace = ""
+        if strip_whitespace && expression =~ BEGINNING_WHITESPACE
+          @whitespace = $1
+          expression.slice!(0, @whitespace.length)
+        end
+        super(expression)
+      end
+
+      def to_script
+        %(__buf << %Q`) << @expression << %(` ; ) << @whitespace << ";"
+      end
+    end
+
+    class Comment < Expression
+      # Need to make sure that the line positions are the same
+      def to_script
+        $/ * (@expression.count($/))
+      end
+    end
+
+    class Extends
+      def initialize(template_name)
+        @template_name = template_name
+      end
+
+      def affect(builder)
+        builder.extends(@template_name)
+      end
+    end
+
+    class BlockStart
+      def initialize(block_name)
+        @block_name = block_name.to_sym
+      end
+
+      def affect(builder)
+        builder.block_start(@block_name)
+      end
+    end
+
+    class BlockEnd
+      def affect(builder)
+        builder.block_end
+      end
+    end
+
+    class BlockSuper
+      def affect(builder)
+        builder.block_super
+      end
+    end
+  end
+end

data/lib/cutaneous/compiler.rb

@@ -0,0 +1,223 @@
+require 'cutaneous/compiler/expression'
+
+module Cutaneous
+  class Compiler
+    # A single named block of template expressions
+    class Block
+      attr_reader :name
+
+      def initialize(name)
+        @name        = name
+        @expressions = []
+      end
+
+      def push(expression)
+        @expressions << expression
+      end
+
+      alias_method :<<, :push
+
+      def to_script
+        script = ""
+        @expressions.each do |expression|
+          script << expression.to_script
+        end
+        script
+      end
+    end
+
+    # Represents the block structure of a top-level master template,
+    # i.e. one with no `extends` call.
+    class BlockSet
+      attr_reader   :current_block
+      attr_accessor :loader
+
+      def initialize
+        @block_order = []
+        @block_store = {}
+        block_start
+      end
+
+      def block_start(name = Object.new)
+        @current_block = Block.new(name)
+        @block_order << name
+        @block_store[name] = @current_block
+      end
+
+      def block_end
+        block_start
+      end
+
+      def push(tag)
+        @current_block << tag
+      end
+
+      def block_order
+        @block_order
+      end
+
+      def super_block
+        raise CompilationError.new("Invalid 'blocksuper' call from top-level template")
+      end
+
+      def block(name)
+        @block_store[name]
+      end
+
+      def each_block
+        block_order.each do |block_name|
+          yield block(block_name)
+        end
+      end
+
+      def to_script
+        script = ""
+        each_block do |block|
+          script << block.to_script
+        end
+        script
+      end
+    end
+
+    # Represents the structure of a sub-template that inherits its
+    # block structure from some parent template defined by an `extends`
+    # tag.
+    class ExtendedBlockSet < BlockSet
+      def initialize(template_name)
+        @super_template_name = template_name
+        super()
+      end
+
+      def super_template
+        @super_template ||= @loader.template(@super_template_name)
+      end
+
+      def super_block
+        super_template.block(current_block.name)
+      end
+
+      def block(name)
+        return @block_store[name] if @block_store.key?(name)
+        super_template.block(name)
+      end
+
+      def block_order
+        super_template.block_order
+      end
+    end
+
+    # Converts a list of expressions into either a master or child block
+    # set.
+    class BlockBuilder
+      def initialize(loader)
+        @loader = loader
+        assign_block_set(BlockSet.new)
+      end
+
+      def build(expressions)
+        expressions.each do |expression|
+          expression.affect(self)
+        end
+        @block_set
+      end
+
+      def extends(parent)
+        assign_block_set(ExtendedBlockSet.new(parent))
+      end
+
+      def assign_block_set(block_set)
+        @block_set = block_set
+        @block_set.loader = @loader
+      end
+
+      def current_block
+        @block_set.current_block
+      end
+
+      def block_start(block_name)
+        @block_set.block_start(block_name)
+      end
+
+      def block_end
+        @block_set.block_end
+      end
+
+      def block_super
+        push(@block_set.super_block)
+      end
+
+      def push(tag)
+        @block_set.push(tag)
+      end
+    end
+
+    def initialize(lexer, loader)
+      @lexer, @loader = lexer, loader
+    end
+
+
+    def blocks
+      @blocks ||= build_hierarchy
+    end
+
+    def build_hierarchy
+      builder = BlockBuilder.new(@loader)
+      builder.build(expressions)
+    end
+
+    def expressions
+      expressions = []
+      strip       = nil
+      @lexer.tokens.each do |type, expression, strip_whitespace|
+        case type
+        when :text
+          expressions << Text.new(expression, strip)
+        when :expression
+          expressions << Expression.new(expression)
+        when :escaped_expression
+          expressions << EscapedExpression.new(expression)
+        when :statement
+          expressions << parse_statement(expression)
+        when :comment
+          expressions << Comment.new(expression)
+        end
+        strip = strip_whitespace
+      end
+      # We don't need this any more so release it
+      @lexer = nil
+      expressions
+    end
+
+    EXTENDS     = /\A\s*extends\s+["']([^"']+)["']\s*\z/o
+    BLOCK_START = /\A\s*block\s+:?([a-zA-Z_][a-zA-Z0-9_]*)\s*\z/o
+    BLOCK_END   = /\A\s*endblock(?:\s+:?[a-zA-Z_][a-zA-Z0-9_]*)?\s*\z/o
+    BLOCK_SUPER = /\A\s*block_?super\s*\z/o
+
+    def parse_statement(statement)
+      case statement
+      when EXTENDS
+        Extends.new($1)
+      when BLOCK_START
+        BlockStart.new($1)
+      when BLOCK_END
+        BlockEnd.new
+      when BLOCK_SUPER
+        BlockSuper.new
+      else
+        Statement.new(statement)
+      end
+    end
+
+    def script
+      blocks.to_script
+    end
+
+    def block_order
+      blocks.block_order
+    end
+
+    def block(name)
+      blocks.block(name)
+    end
+  end
+end

data/lib/cutaneous/context.rb

@@ -0,0 +1,70 @@
+require 'delegate'
+
+module Cutaneous
+  class Context < Delegator
+    attr_accessor :__buf, :__loader, :__target, :__locals
+
+    def initialize(target, locals_or_context = {})
+      super(target)
+      @__target, @__locals = target, {}
+      __update_context(locals_or_context)
+    end
+
+    def __decode_params(params)
+      params.to_s
+    end
+
+    def escape(value)
+      value
+    end
+
+    def include(template_name, locals = {})
+      context = self.dup.__update_with_locals(locals)
+      self.__buf  << __loader.template(template_name).render(context)
+    end
+
+    def respond_to?(name)
+      return true if @__locals.key?(name.to_s) || @__locals.key?(name.to_sym)
+      super
+    end
+
+    def method_missing(name, *args)
+      return @__locals[name.to_s]   if @__locals.key?(name.to_s)
+      return @__locals[name.to_sym] if @__locals.key?(name.to_sym)
+      super
+    rescue NameError => e
+      __handle_error(e)
+    end
+
+    def __handle_error(e)
+      # Default behaviour is to silently discard errors
+    end
+
+    def __update_context(parent)
+      case parent
+      when Hash
+        __update_with_locals(parent)
+      when Cutaneous::Context
+        parent.instance_variables.reject { |var| /^@__/o === var.to_s }.each do |variable|
+          instance_variable_set(variable, parent.instance_variable_get(variable))
+        end
+        __update_with_locals(parent.__locals) if parent.respond_to?(:__locals)
+      end
+    end
+
+    def __update_with_locals(locals)
+      @__locals.update(locals)
+      self
+    end
+
+    # Required by the Delegator class
+    def __setobj__(obj)
+      @__target = obj
+    end
+
+    # Required by the Delegator class
+    def __getobj__
+      @__target
+    end
+  end
+end

data/lib/cutaneous/engine.rb

@@ -0,0 +1,66 @@
+
+module Cutaneous
+  # Manages a set of Loaders that render templates
+  class Engine
+    attr_reader   :roots
+    attr_accessor :loader_class, :default_format
+
+    def initialize(template_roots, syntax, default_format = "html")
+      @roots          = Array(template_roots)
+      @syntax    = syntax
+      @loader_class   = FileLoader
+      @default_format = default_format
+    end
+
+    def render_file(path, context, format = default_format)
+      file_loader(format).render(path, context)
+    end
+
+    alias_method :render, :render_file
+
+    def render_string(template_string, context, format = default_format)
+      string_loader(format).render(template_string, context)
+    end
+
+    # Create and cache a file loader on a per-format basis
+    def file_loader(format)
+      file_loader_instance(format.to_s).tap do |loader|
+        loader.syntax = @syntax
+      end
+    end
+
+    # Not worth caching string templates as they are most likely to be one-off
+    # instances & not repeated in the lifetime of the engine.
+    def string_loader(format)
+      StringLoader.new(file_loader(format))
+    end
+
+    def template_exists?(root, relative_path, format)
+      file_loader(format).exists?(root, relative_path)
+    end
+
+    protected
+
+    def file_loader_instance(format)
+      loader_class.new(@roots, format)
+    end
+  end
+
+  # A caching version of the default Engine implementation
+  class CachingEngine < Engine
+    attr_writer :write_compiled_scripts
+
+    def initialize(template_roots, syntax, default_format = "html")
+      super
+      @loader_class = CachedFileLoader
+      @loaders      = {}
+      @write_compiled_scripts = true
+    end
+
+    def file_loader_instance(format)
+      @loaders[format] ||= super.tap do |loader|
+        loader.write_compiled_scripts = @write_compiled_scripts if loader.respond_to?(:write_compiled_scripts=)
+      end
+    end
+  end
+end