hydeweb 0.0.3.pre → 0.0.4

data/.yardopts

@@ -1,2 +1,5 @@
---files="docs/*/*"
---main="docs/Hyde.md"
+--files="manual/*/*"
+--files="AUTHORS"
+--files="LICENSE"
+--files="CHANGELOG"
+--main="manual/Hyde.md"

data/AUTHORS

@@ -0,0 +1,6 @@
+Credits
+=======
+
+Hyde was created and being developed and maintained by Rico Sta. Cruz of Sinefunc, Inc.
+
+A hat tip goes to Tom Preston-Werner (mojombo) for Jekyll, the very project that inspired Hyde.

data/CHANGELOG

@@ -0,0 +1 @@
+

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Sinefunc, Inc.
+Copyright (c) 2010 Rico Sta. Cruz and Sinefunc, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -17,11 +17,14 @@ Usage
 To do
 -----
 
- - partials support
+ - ignores
+ - error pages
  - _meta.yml 
 
 Done:
 
+ - last_modified
+ - partials support
  - hyde build
  - extensions support
  - hyde gen

data/Rakefile

@@ -49,3 +49,7 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+task :autotest do
+  system "rstakeout 'rake test' **/*.rb"
+end

data/VERSION

@@ -1 +1 @@
-0.0.3.pre
+0.0.4

data/hydeweb.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hydeweb}
-  s.version = "0.0.3.pre"
+  s.version = "0.0.4"
 
-  s.required_rubygems_version = Gem::Requirement.new("> 1.3.1") if s.respond_to? :required_rubygems_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rico Sta. Cruz", "Sinefunc, Inc."]
-  s.date = %q{2010-05-04}
+  s.date = %q{2010-05-25}
   s.default_executable = %q{hyde}
   s.description = %q{Website preprocessor}
   s.email = %q{rico@sinefunc.com}
@@ -21,6 +21,8 @@ Gem::Specification.new do |s|
   s.files = [
     ".gitignore",
      ".yardopts",
+     "AUTHORS",
+     "CHANGELOG",
      "LICENSE",
      "README.md",
      "Rakefile",
@@ -31,14 +33,6 @@ Gem::Specification.new do |s|
      "data/new_site/hyde.conf",
      "data/new_site/layouts/default.haml",
      "data/new_site/site/index.html.haml",
-     "docs/Extending/ExtendingHyde.md",
-     "docs/Hyde.md",
-     "docs/Introduction/Configuration.md",
-     "docs/Introduction/GettingStarted.md",
-     "docs/Introduction/Installation.md",
-     "docs/Introduction/Layouts.md",
-     "docs/Introduction/Partials.md",
-     "docs/Introduction/TemplateLanguages.md",
      "hydeweb.gemspec",
      "lib/hyde.rb",
      "lib/hyde/clicommand.rb",
@@ -48,14 +42,26 @@ Gem::Specification.new do |s|
      "lib/hyde/layout.rb",
      "lib/hyde/ostruct.rb",
      "lib/hyde/page.rb",
+     "lib/hyde/page_factory.rb",
+     "lib/hyde/partial.rb",
      "lib/hyde/project.rb",
      "lib/hyde/renderer.rb",
      "lib/hyde/renderers.rb",
      "lib/hyde/utils.rb",
+     "manual/Extending/ExtendingHyde.md",
+     "manual/Hyde.md",
+     "manual/Introduction/Configuration.md",
+     "manual/Introduction/GettingStarted.md",
+     "manual/Introduction/Installation.md",
+     "manual/Introduction/Layouts.md",
+     "manual/Introduction/Metadata.md",
+     "manual/Introduction/Partials.md",
+     "manual/Introduction/TemplateLanguages.md",
      "test/fixtures/custom/_config.yml",
      "test/fixtures/custom/extensions/custom/custom.rb",
      "test/fixtures/custom/layouts/default.haml",
      "test/fixtures/custom/layouts/erbtest.erb",
+     "test/fixtures/custom/layouts/shared/sidebar.haml",
      "test/fixtures/custom/site/about/index.html",
      "test/fixtures/custom/site/assets/common.css.less",
      "test/fixtures/custom/site/assets/style.css.less",
@@ -75,6 +81,7 @@ Gem::Specification.new do |s|
      "test/fixtures/custom/www_control/markdown.html",
      "test/fixtures/custom/www_control/yes.html",
      "test/fixtures/default/_config.yml",
+     "test/fixtures/default/extensions/custom/custom.rb",
      "test/fixtures/default/layouts/default.haml",
      "test/fixtures/default/site/about/index.html",
      "test/fixtures/default/site/foo.html.haml",
@@ -90,6 +97,7 @@ Gem::Specification.new do |s|
      "test/test_all_fixtures.rb",
      "test/test_build.rb",
      "test/test_hyde.rb",
+     "test/test_page.rb",
      "test/test_utils.rb"
   ]
   s.homepage = %q{http://github.com/sinefunc/hyde}
@@ -99,10 +107,12 @@ Gem::Specification.new do |s|
   s.summary = %q{Website preprocessor}
   s.test_files = [
     "test/fixtures/custom/extensions/custom/custom.rb",
+     "test/fixtures/default/extensions/custom/custom.rb",
      "test/helper.rb",
      "test/test_all_fixtures.rb",
      "test/test_build.rb",
      "test/test_hyde.rb",
+     "test/test_page.rb",
      "test/test_utils.rb"
   ]
 

data/lib/hyde/helpers.rb

@@ -1,8 +1,15 @@
 module Hyde
   module Helpers
     module Default
-      # def render # partial support
-      # end
+      def render_partial(partial_path, args = {})
+        locals = args[:locals] || {}
+        p = Partial.create partial_path.to_s, project
+        p.render locals
+      end
+
+      def partial(*a)
+        render_partial *a
+      end
     end
   end
 end

data/lib/hyde/init.rb

@@ -33,13 +33,23 @@ class Main < Sinatra::Base
       path = params[:splat][0]
       type = File.extname(path)[1..-1]
       content_type type.to_sym  if type.is_a? String
-      @@project.render path
+
+      page = Hyde::Page.create path, @@project
+
+      # Send the last modified time
+      last_modified File.mtime(page.filename)
+      cache_control :public, :must_revalidate, :max_age => 60
+
+      page.render
+
     rescue Hyde::RenderError => e
       puts " * `#{path}` error"
       puts " *** #{e.message}".gsub("\n","\n *** ")
       e.message
+
     rescue Hyde::NotFound
       raise Sinatra::NotFound
+
     end
   end
 end

data/lib/hyde/page.rb

@@ -13,6 +13,7 @@ module Hyde
     # @example
     #   puts page.name
     #   puts page.filename
+    #
     #   # about/index.html
     #   # about/index.html.haml
     attr_accessor :filename
@@ -28,17 +29,13 @@ module Hyde
     attr_reader :project
 
     # Factory
-    # Try {Project#get_page} instead
-    def self.create(path, project, page_class = Page)
-      info = get_page_info(path, project)
-      page = page_class.new(path, project, info[:renderer], info[:filename])
+    #
+    def self.create(path, project, def_page_class = Page)
+      PageFactory.create path, project, def_page_class
     end
 
     # Returns the rendered output.
     def render(data = {}, &block)
-      if self.is_a? Layout
-        # puts debug
-      end
       output = @renderer.render(data, &block)
       # BUG: @layout should build on top of that data
       output = @layout.render(@meta.merge data) { output }  unless @layout.nil?
@@ -46,13 +43,7 @@ module Hyde
     end
 
     def method_missing(meth, *args, &blk)
-      if meta.keys.include?(meth.to_s)
-        meta[meth.to_s]
-      elsif meta.keys.include?(meth.to_sym)
-        meta[meth.to_sym]
-      else
-        raise NoMethodError.new "Undefined method `#{self.class}::#{meth}`"
-      end
+      meta[meth.to_s] || meta[meth.to_sym] || super
     end
 
     def get_binding
@@ -67,18 +58,21 @@ module Hyde
     # Called by Renderer::Base.
     #
     def set_meta(meta)
+      # TODO: OStruct and stuff
       # Merge
       @meta ||= Hash.new
       @meta.merge! meta
 
       # Set the Layout
-      @layout = @project.get_layout(@meta['layout'])  if @meta['layout']
+      @layout = Layout.create(@meta['layout'], @project)  if @meta['layout']
     end
 
     protected
+
     # Constructor.
     # The `page` argument is a page name
     # Don't use me: use {Project#create}
+    #
     def initialize(path, project, renderer, filename)
       @project    = project
       @name     ||= path
@@ -90,43 +84,5 @@ module Hyde
     def self.get_filename(path, project)
       project.root(:site, path)
     end
-
-    def self.get_page_info(path, project)
-      renderer = nil
-      filename = get_filename(path, project)
-
-      if File.exists? filename
-        renderer = Hyde::Renderer::Passthru
-
-      else
-        # Look for the file
-        matches = Dir["#{filename}.*"]
-        raise NotFound.new("Can't find `#{path}{,.*}` -- #{filename}") \
-          if matches.empty?
-
-        # Check for a matching renderer
-        exts = []
-        matches.each do |match|
-          begin
-            ext      = File.extname(match)[1..-1].capitalize.to_sym
-            exts     << File.extname(match)
-            r_class  = Hyde::Renderers.const_get(ext)
-            renderer ||= r_class
-            filename = match
-          rescue NoMethodError
-            # pass
-          rescue NameError # Renderer not found
-            # pass
-          end
-        end
-
-        raise NotFound.new("No matching (#{exts.join(", ")}) renderers found for `#{path}`") \
-          if renderer.nil?
-      end
-
-      { :renderer => renderer,
-        :filename => filename
-      }
-    end
   end
 end

data/lib/hyde/page_factory.rb

@@ -0,0 +1,63 @@
+module Hyde
+  class PageFactory
+    def self.create(path, project, def_page_class = Page)
+      begin
+        do_create path, project, def_page_class
+      rescue NotFound
+        do_create "#{path}/index.html".squeeze('/'), project, def_page_class
+      rescue NotFound => e
+        raise e
+      end
+    end
+
+    def self.do_create(path, project, def_page_class = Page)
+      info = get_page_info(path, project, def_page_class)
+      page_class = info[:page_class]
+      page_class.new(path, project, info[:renderer], info[:filename])
+    end
+
+    protected
+
+    def self.get_page_info(path, project, page_class)
+      renderer = nil
+      filename = page_class.get_filename(path, project)
+
+      if File.directory? filename
+        raise NotFound, "`#{path}` is a directory, not a file"
+
+      elsif File.exists? filename
+        renderer = Hyde::Renderer::Passthru
+
+      else
+        # Look for the file
+        matches = Dir["#{filename}.*"]
+        raise NotFound, "Can't find `#{path}{,.*}` -- #{filename}" \
+          if matches.empty?
+
+        # Check for a matching renderer
+        exts = []
+        matches.each do |match|
+          begin
+            ext      = File.extname(match)[1..-1].capitalize.to_sym
+            exts     << File.extname(match)
+            r_class  = Hyde::Renderers.const_get(ext)
+            renderer ||= r_class
+            filename = match
+          rescue NoMethodError
+            # pass
+          rescue NameError # Renderer not found
+            # pass
+          end
+        end
+
+        raise NotFound, "No matching (#{exts.join(", ")}) renderers found for `#{path}`" \
+          if renderer.nil?
+      end
+
+      { :renderer   => renderer,
+        :filename   => filename,
+        :page_class => page_class
+      }
+    end
+  end
+end

data/lib/hyde/partial.rb

@@ -0,0 +1,7 @@
+module Hyde
+  class Partial < Layout
+    def self.create(path, project, page_class = Partial)
+      super path, project, page_class
+    end
+  end
+end

data/lib/hyde/project.rb

@@ -4,9 +4,12 @@ module Hyde
     include Hyde::Utils
 
     # The root path (String).
+    #
+    # @example
     #   root
     #   root :layouts
     #   root :site, 'blah'
+    #
     def root(*args)
       where = ''
       where = send("#{args.shift.to_s}_path")  if args[0].class == Symbol
@@ -14,68 +17,57 @@ module Hyde
       File.expand_path(File.join [@root, where, path].reject(&:empty?))
     end
 
-    # The filename of the configuration file, relative to the project root.
+    # The filename of the configuration file, relative to the project root. (String)
+    #
     attr :config_file
 
-    # The configuration k/v storage (Hash)
+    # The configuration k/v storage (OStruct)
+    #
     attr_accessor :config
 
     # Can raise a NoRootError
-    def initialize( root = Dir.pwd )
+    #
+    def initialize(root = Dir.pwd)
       @config = OStruct.new defaults
       @root, @config_file = find_root_from root
       @config.merge! YAML::load_file(@config_file)  if File.exists? @config_file
       load_extensions
     end
 
-    def find_root_from(start)
-      check = File.expand_path(start)
-      ret = nil
-      while ret.nil?
-        # See if any of these files exist
-        ['_config.yml', 'hyde.conf'].each do |config_name|
-          config_file = File.join(check, config_name)
-          ret ||= [check, config_file]  if File.exists? config_file
-        end
-
-        # Traverse back (die if we reach the root)
-        old_check = check
-        check = File.expand_path(File.join(check, '..'))
-        raise NoRootError  if check == old_check
-      end
-      ret
-    end
-
     def method_missing(meth, *args, &blk)
-      raise NoMethodError, "No method `#{meth}`"  unless @config.include?(meth)
+      super  unless @config.include?(meth)
       @config.send meth
     end
 
     # Returns a page in a certain URL path.
     # @return {Page} or a subclass of it
+    #
     def get_page(path)
-      path = "index.html"  if path.empty?
-      Page.create path, self
+     Page.create path, self
     end
 
+    # Returns a layout
+    # (Try Layout.create path, @project instead)
+    #
     def get_layout(path)
       Layout.create path, self
     end
 
     # Can throw a NotFound.
+    #
     def render(path)
-      get_page(path).render
+      Page.create(path, self).render
     end
 
     # Writes the output files.
     # @param
     #   ostream    - (Stream) Where to send the messages
+    #
     def build(ostream = nil)
       raise Errno::EEXISTS  if File.exists? root(:output) and not File.directory? root(:output)
-      Dir.mkdir root(:output)  unless File.directory? root(:output)
+      Dir.mkdir(root :output)  unless File.directory?(root :output)
 
       begin
-        continue = true
         files.each do |path|
           ostream << " * #{output_path}/#{path}\n"  if ostream
           begin
@@ -88,11 +80,12 @@ module Hyde
           end
         end
       rescue NoGemError => e
-        ostream << "Error: #{e.message}\n"
+        ostream << " *** Error: #{e.message}\n"
       end
     end
 
     # Returns a list of all URL paths
+    #
     def files
       @file_list = Dir[File.join(root(:site), '**', '*')].inject([]) do |a, match|
         # Make sure its the canonical name
@@ -111,6 +104,9 @@ module Hyde
       end
     end
 
+    # Returns a list of file specs to be excluded from processing.
+    # @see {#ignored_files}
+    #
     def ignore_list
       @ignore_list ||= [
         root(:layouts, '**/*'),
@@ -120,21 +116,47 @@ module Hyde
       ]
     end
 
-    # Returns a list of ignored files.
+    # Returns a list of ignored files based on the {ignore_list}.
     # TODO: This is innefficient... do it another way
+    #
     def ignored_files
-      @ignored_files ||= ignore_list.inject([]) { |a, spec|
+      @ignored_files ||= ignore_list.inject([]) do |a, spec|
         Dir[spec].each { |file| a << File.expand_path(file) }; a
-      }
+      end
     end
 
     protected
 
-    def load_extensions
-      @config.gems.each do |gem|
-        require gem
+    # Looks for the hyde config file to determine the project root.
+    #
+    def find_root_from(start)
+      check = File.expand_path(start)
+      ret = nil
+      while ret.nil?
+        # See if any of these files exist
+        ['_config.yml', 'hyde.conf'].each do |config_name|
+          config_file = File.join(check, config_name)
+          ret ||= [check, config_file]  if File.exists? config_file
+        end
+
+        # Traverse back (die if we reach the root)
+        old_check = check
+        check = File.expand_path(File.join(check, '..'))
+        raise NoRootError  if check == old_check
       end
+      ret
+    end
+
+    # Loads the ruby files in the extensions folder
+    #
+    def load_extensions
+      # Load the init.rb file
+      require(root 'init.rb')  if File.exists?(root 'init.rb')
 
+      # Load the gems in the config file
+      @config.gems.each { |gem| require gem }
+
+      # Load the extensions
       ext_roots = Dir[root :extensions, '*'].select { |d| File.directory? d }
       ext_roots.each do |dir|
         ext = File.basename(dir)
@@ -149,6 +171,7 @@ module Hyde
         require ext_files[0]  if ext_files[0]
       end
     end
+
     def defaults
       { 'layouts_path'    => 'layouts',
         'extensions_path' => 'extensions',
@@ -159,6 +182,7 @@ module Hyde
     end
 
     # Returns the renderer associated with the given file extension.
+    #
     def get_renderer(name)
       begin
         class_name = name.to_s.capitalize.to_sym

data/lib/hyde.rb

@@ -2,17 +2,19 @@ require 'yaml'
 
 module Hyde
   prefix = File.dirname(__FILE__)
-  autoload :OStruct,    "#{prefix}/hyde/ostruct"
-  autoload :Project,    "#{prefix}/hyde/project"
-  autoload :Layout,     "#{prefix}/hyde/layout"
-  autoload :Page,       "#{prefix}/hyde/page"
-  autoload :Renderer,   "#{prefix}/hyde/renderer"
-  autoload :Renderers,  "#{prefix}/hyde/renderers"
-  autoload :Utils,      "#{prefix}/hyde/utils"
-  autoload :Scope,      "#{prefix}/hyde/scope"
-  autoload :CLICommand, "#{prefix}/hyde/clicommand"
-  autoload :CLICommands,"#{prefix}/hyde/clicommands"
-  autoload :Helpers,    "#{prefix}/hyde/helpers"
+  autoload :OStruct,     "#{prefix}/hyde/ostruct"
+  autoload :Project,     "#{prefix}/hyde/project"
+  autoload :Layout,      "#{prefix}/hyde/layout"
+  autoload :Page,        "#{prefix}/hyde/page"
+  autoload :PageFactory, "#{prefix}/hyde/page_factory"
+  autoload :Renderer,    "#{prefix}/hyde/renderer"
+  autoload :Renderers,   "#{prefix}/hyde/renderers"
+  autoload :Utils,       "#{prefix}/hyde/utils"
+  autoload :Scope,       "#{prefix}/hyde/scope"
+  autoload :CLICommand,  "#{prefix}/hyde/clicommand"
+  autoload :CLICommands, "#{prefix}/hyde/clicommands"
+  autoload :Helpers,     "#{prefix}/hyde/helpers"
+  autoload :Partial,     "#{prefix}/hyde/partial"
 
   Error = Class.new(::StandardError)
   NoGemError  = Class.new(Error)

data/{docs → manual}/Extending/ExtendingHyde.md

@@ -77,7 +77,7 @@ It will also show under `hyde --help` since it provides a `desc`.
     # extensions/hyde-clean/hyde-clean.rb
     module Hyde
       module CLICommands
-        class Clean
+        class Clean < CLICommand
           desc "Cleans up your project's dirt"
 
           def self.run(*a)

data/manual/Hyde.md

@@ -0,0 +1,58 @@
+Hyde
+====
+
+Hyde is a website preprocessor.
+
+ - __Layouts and Partials:__ Hyde lets you define your site's header and footer
+   layouts in a separate file, and even separate snippets of your site
+   into reuseable components (partials). Your code will be much cleaner and
+   DRYer!
+
+ - __Template languages:__ Hyde lets you write your site in any template
+   language you need -- the translation will be taken care of for you.
+   Hyde supports HAML, LessCSS, Markdown, SASS and Textile by default, and
+   more can be added through extensions.
+
+ - __Extendable:__ Hyde is easily customizable with extensions. You can add
+   new helpers, new commands, support for new languages and many more by
+   simply adding the extensions to your project folder. Some are even
+   available as simple Ruby gems!
+
+ - __Design fast:__ Hyde comes with a web server that lets you serve up
+   your site locally. Any changes to your files will be seen on your next
+   browser refresh!
+
+ - __Build your site as static HTMLs:__ You can export your site as plain
+   HTML files with one simple command.
+
+Why use Hyde?
+-------------
+
+It's like building a static site, but better! You can use Hyde for:
+
+ - Building HTML prototypes
+ - Building sites with no dynamic logic
+ - Creating a blog where the entries are stored in a source repository
+
+Introduction
+------------
+
+- `++++` {file:Installation Installation} -- Start here
+- `++++` {file:GettingStarted Getting started}
+- `++--` {file:TemplateLanguages Template languages}
+- `----` {file:Layouts Layouts}
+- `----` {file:Partials Partials}
+- `----` {file:Metadata Metadata}
+- `----` {file:Configuration Configuration}
+
+Extending Hyde
+--------------
+
+- `+++-` {file:ExtendingHyde Extending Hyde}
+
+Basic info
+----------
+
+- {file:AUTHORS Credits}
+- {file:LICENSE License}
+

data/{docs → manual}/Introduction/Configuration.md

@@ -1,2 +1,4 @@
 Configuration
 =============
+
+`hyde.conf`

data/manual/Introduction/GettingStarted.md

@@ -0,0 +1,66 @@
+Getting started
+===============
+
+Starting your first project
+---------------------------
+
+Create your first project with:
+
+    hyde create <name>
+
+Where `<name>` is the name of your project. This will create a folder with that
+name, along with some sample files to get you started.
+
+Starting
+--------
+
+Begin working on your project by starting the Hyde webserver. This is optional,
+but is recommended as it's a nice way to see your changes in real time.
+
+    hyde start
+
+After typing this, you will see the server has started. Point your web browser to
+`http://localhost:4567` to see your site. You should now see your project's
+default "welcome" page.
+
+
+Editing your site
+-----------------
+
+Your project has a subfolder called `site` -- this is where all the site's files are
+stored. In general, dropping any file in this folder will make it accessible with the
+same filename.
+
+Try this: create a file called `products.html` and fill it up like you would an
+HTML page. After that, point your browser to `http://localhost:4567/products.html`,
+which should now show the page you were working on.
+
+You may also put your files in subfolders. If you were to create the file
+`site/assets/my_style.css`, it should be accessible through
+`http://localhost:4567/assets/my_style.css`.
+
+Dynamic files
+-------------
+
+There are files with two extensions, for instance, `index.html.haml`. If a file
+ends in one of Hyde's dynamic file extensions (like `.haml`), it will be stripped
+out and the file will be rendered using the template engine in that extension (in
+this case, HAML).
+
+More about this in the next section.
+
+Building HTML files
+-------------------
+
+The `hyde start` webserver is good for local development, but when it's time to
+deploy your site, you will need to build your files. This process outputs raw
+HTML files for your entire site (for the dynamic files), with Hyde translating
+any files that need translation (e.g., HAML and ERB files).
+
+Build your files by typing this in the command prompt:
+
+    hyde build
+
+This will create a folder called `public/` where the built files are stored.
+You can now deploy this folder to your webserver.
+

data/{docs/Introduction/Partials.md → manual/Introduction/Metadata.md}

@@ -1,2 +1,2 @@
-Partials
+Metadata
 ========

data/manual/Introduction/Partials.md

@@ -0,0 +1,63 @@
+Partials
+========
+
+A partial is a snippet of code that you can reuse in any page of your site.
+This is particularly useful for repetitive sections, and for sections that may
+make your files too large to manage.
+
+Creating partials
+-----------------
+
+Put your partial file anywhere in the `layouts` folder, e.g.:
+
+    <!-- layouts/shared/sidebar.erb -->
+    <div id='#sidebar'>
+      <h2><span>Sidebar</span><h2>
+      <div class='description'>
+        <p>This is a sidebar partial defined in a separate file.</p>
+      </div>
+    </div>
+
+In your site's files, you can invoke a partial through:
+
+    <!-- site/index.html.erb -->
+    <h1>Partial:</h1>
+    <%= partial 'shared/sidebar' %>
+    <span>End of partial.</span>
+    <span>This is now text from index.html.</span>
+
+This will output:
+    
+    <!-- public/index.html -->
+    <h1>Partial:</h1>
+    <div id='#sidebar'>
+      <h2><span>Sidebar</span><h2>
+      <div class='description'>
+        <p>This is a sidebar partial defined in a separate file.</p>
+      </div>
+    </div>
+    <span>End of partial.</span>
+    <span>This is now text from index.html.</span>
+
+Partials with local variables
+-----------------------------
+
+You can define a partial with some local variables that will be passed
+to it by the caller.
+
+    <!-- layouts/shared/product.erb -->
+    <div class='product'>
+      <div class='title'>
+        <h2><%= name %></h2>
+      </div>
+      <div class='desc'>
+        <p><%= description %></p>
+      </div>
+    </div>
+
+In your files, call a partial by:
+      
+    <!-- site/index.html.erb -->
+    <%= partial 'shared/product', { :name => '5MP Camera CX-300', :description => 'This is a camera with an adjustable focal length and Bluetooth support.' } %>
+
+

data/manual/Introduction/TemplateLanguages.md

@@ -0,0 +1,59 @@
+Template languages
+==================
+
+Hyde comes with support for some common template languages. This means you can
+write your site in a language like Markdown or HAML, and have Hyde take care
+of translating them accordingly.
+
+If a file ends in one of Hyde's supported file extensions (like `.haml`), it will be stripped
+out and the file will be rendered using the template engine in that extension (in
+this case, HAML).
+
+Supported languages
+-------------------
+
+Hyde supports the following languages out-of-the-box:
+
+ - HTML template languages
+   - `.haml` -- HAML
+   - `.md` -- Markdown
+   - `.textile` -- Textile
+   - `.erb` -- ERB (Embedded Ruby)
+
+ - CSS template languages
+   - `.less` -- LessCSS
+   - `.sass` -- SASS
+
+This means that the following files will be translated accordingly:
+
+ | products.html.haml       | becomes `products.html` (rendered through HAML)       |
+ | control.css.less         | becomes `control.css` (rendered through Less CSS)     |
+ | site.xml.erb             | becomes `site.xml` (rendered through Embedded Ruby)   |
+
+Example
+-------
+
+When creating a new site, have a look at `index.html.haml`.
+
+...
+
+Headers
+-------
+
+...
+
+Layouts
+-------
+
+Layouts are supported for these languages.
+
+...
+
+Embedded Ruby features
+----------------------
+
+Some languages (like HAML and ERB) has support for embedding Ruby code in the
+documents. This will let you do some nifty things in Hyde:
+
+ - Partials
+ - Helpers

data/test/fixtures/custom/layouts/default.haml

@@ -4,4 +4,5 @@ title: Site
 != "<!-- (default layout) -->"
 %h2 Template
 %div
+  =render_partial 'shared/sidebar'
   =yield

data/test/fixtures/custom/layouts/shared/sidebar.haml

@@ -0,0 +1,4 @@
+%div#sidebar
+  %ul
+    %li
+      Hello!

data/test/fixtures/custom/site/about/index.html

@@ -1 +1 @@
-
+About page.

data/test/fixtures/custom/www_control/about/index.html

@@ -1 +1 @@
-
+About page.

data/test/fixtures/custom/www_control/index.html

@@ -2,6 +2,13 @@
 <!-- (default layout) -->
 <h2>Template</h2>
 <div>
+  <div id='sidebar'>
+    <ul>
+      <li>
+        Hello!
+      </li>
+    </ul>
+  </div>
   This is the index
   <strong>
     Welcome to the index page!

data/test/fixtures/custom/www_control/layout_test.html

@@ -2,6 +2,13 @@
 <!-- (default layout) -->
 <h2>Template</h2>
 <div>
+  <div id='sidebar'>
+    <ul>
+      <li>
+        Hello!
+      </li>
+    </ul>
+  </div>
   This is the index
   <strong>
     Welcome to the index page!

data/test/fixtures/custom/www_control/markdown.html

@@ -2,6 +2,13 @@
 <!-- (default layout) -->
 <h2>Template</h2>
 <div>
+  <div id='sidebar'>
+    <ul>
+      <li>
+        Hello!
+      </li>
+    </ul>
+  </div>
   <h1 id='markdown_test'>Markdown test</h1>
   
   <ul>

data/test/fixtures/default/extensions/custom/custom.rb

@@ -0,0 +1,2 @@
+class CustomExtensionClass
+end

data/test/helper.rb

@@ -11,4 +11,12 @@ class Test::Unit::TestCase
   def assert_same_file(a, b)
     assert same_file?(a, b)
   end
+
+  def get_project(site)
+    Hyde::Project.new fixture(site)
+  end
+
+  def fixture(site)
+    File.join File.dirname(__FILE__), 'fixtures', site
+  end
 end

data/test/test_all_fixtures.rb

@@ -28,13 +28,17 @@ class TestAllFixtures < Test::Unit::TestCase
         @project = Hyde::Project.new File.join(@@root, site)
         @project.build
 
-        unknown_root = @project.root :site
+        unknown_root = @project.root :output
         control_root = @project.root 'www_control'
 
         if not File.directory? control_root
           flunk "No www_control"
         else
-          @project.files.select { |f| File.directory? f }.each do |path|
+          @project.files.reject { |f| File.directory? f }.each do |path|
+            unknown_path = File.join(unknown_root, path)
+            flunk "file #{unknown_path} doesn't exist" \
+              unless File.exists?(unknown_path)
+
             unknown = File.open(File.join(unknown_root, path)).read
             control = File.open(File.join(control_root, path)).read
 

data/test/test_hyde.rb

@@ -5,20 +5,12 @@ class TestHyde < Test::Unit::TestCase
     @project = get_project site
   end
 
-  def get_project(site)
-    Hyde::Project.new fixture(site)
-  end
-
-  def fixture(site)
-    File.join File.dirname(__FILE__), 'fixtures', site
-  end
-
   should "return the right paths" do
     root_path = fixture 'default'
     assert_same_file root_path, @project.root
-    assert_same_file File.join(root_path, '_layouts'), \
+    assert_same_file File.join(root_path, 'layouts'), \
                  @project.root(:layouts)
-    assert_same_file File.join(root_path, '_layouts', 'abc'), \
+    assert_same_file File.join(root_path, 'layouts', 'abc'), \
                  @project.root(:layouts, 'abc')
     assert_same_file File.join(root_path, 'layouts', 'abc'), \
                  @project.root('layouts', 'abc')
@@ -35,12 +27,39 @@ class TestHyde < Test::Unit::TestCase
     end
   end
 
+  should "load extensions" do
+    begin
+      CustomExtensionClass # Defined in the site's extensions/custom/custom.rb
+    rescue NameError
+      flunk "Extension wasn't loaded"
+    end
+  end
+
   should "use layouts" do
     output = @project.render 'layout_test.html'
     assert_match /This is the meta title/, output
     assert_match /<!-- \(default layout\) -->/, output
   end
 
+  should "account for index.html" do
+    home_output = @project.render('index.html')
+    assert_equal home_output, @project.render('/')
+    assert_equal home_output, @project.render('/index.html')
+
+    about_output = @project.render('/about/index.html')
+    assert_equal about_output, @project.render('/about')
+    assert_equal about_output, @project.render('/about/')
+  end
+
+  should "get types right" do
+    page = @project.get_page('index.html')
+    assert page.is_a? Hyde::Page
+
+    layout = Hyde::Layout.create 'default', @project
+    assert layout.is_a? Hyde::Layout
+    assert layout.is_a? Hyde::Page
+  end
+
   should "list the project files properly" do
     files = @project.files
     assert files.include? 'index.html'

data/test/test_page.rb

@@ -0,0 +1,26 @@
+require 'helper'
+
+class TestPage < Test::Unit::TestCase
+  def setup(site = 'default')
+    @project = get_project site
+    @page = @project.get_page 'index.html'
+  end
+
+  should "raise a method missing error" do
+    assert_raises NoMethodError do
+      @page.xxx
+    end
+
+    # Should NOT raise a method missing error
+    @page.layout
+    @page.filename
+    @page.renderer
+    @page.meta
+    @page.layout
+    @page.project
+  end
+
+  should "register the right project" do
+    assert_equal @project, @page.project
+  end
+end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: hydeweb
 version: !ruby/object:Gem::Version 
-  prerelease: true
+  prerelease: false
   segments: 
   - 0
   - 0
-  - 3
-  - pre
-  version: 0.0.3.pre
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Rico Sta. Cruz
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-04 00:00:00 +08:00
+date: 2010-05-25 00:00:00 +08:00
 default_executable: hyde
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,6 +72,8 @@ extra_rdoc_files:
 files: 
 - .gitignore
 - .yardopts
+- AUTHORS
+- CHANGELOG
 - LICENSE
 - README.md
 - Rakefile
@@ -83,14 +84,6 @@ files:
 - data/new_site/hyde.conf
 - data/new_site/layouts/default.haml
 - data/new_site/site/index.html.haml
-- docs/Extending/ExtendingHyde.md
-- docs/Hyde.md
-- docs/Introduction/Configuration.md
-- docs/Introduction/GettingStarted.md
-- docs/Introduction/Installation.md
-- docs/Introduction/Layouts.md
-- docs/Introduction/Partials.md
-- docs/Introduction/TemplateLanguages.md
 - hydeweb.gemspec
 - lib/hyde.rb
 - lib/hyde/clicommand.rb
@@ -100,14 +93,26 @@ files:
 - lib/hyde/layout.rb
 - lib/hyde/ostruct.rb
 - lib/hyde/page.rb
+- lib/hyde/page_factory.rb
+- lib/hyde/partial.rb
 - lib/hyde/project.rb
 - lib/hyde/renderer.rb
 - lib/hyde/renderers.rb
 - lib/hyde/utils.rb
+- manual/Extending/ExtendingHyde.md
+- manual/Hyde.md
+- manual/Introduction/Configuration.md
+- manual/Introduction/GettingStarted.md
+- manual/Introduction/Installation.md
+- manual/Introduction/Layouts.md
+- manual/Introduction/Metadata.md
+- manual/Introduction/Partials.md
+- manual/Introduction/TemplateLanguages.md
 - test/fixtures/custom/_config.yml
 - test/fixtures/custom/extensions/custom/custom.rb
 - test/fixtures/custom/layouts/default.haml
 - test/fixtures/custom/layouts/erbtest.erb
+- test/fixtures/custom/layouts/shared/sidebar.haml
 - test/fixtures/custom/site/about/index.html
 - test/fixtures/custom/site/assets/common.css.less
 - test/fixtures/custom/site/assets/style.css.less
@@ -127,6 +132,7 @@ files:
 - test/fixtures/custom/www_control/markdown.html
 - test/fixtures/custom/www_control/yes.html
 - test/fixtures/default/_config.yml
+- test/fixtures/default/extensions/custom/custom.rb
 - test/fixtures/default/layouts/default.haml
 - test/fixtures/default/site/about/index.html
 - test/fixtures/default/site/foo.html.haml
@@ -142,6 +148,7 @@ files:
 - test/test_all_fixtures.rb
 - test/test_build.rb
 - test/test_hyde.rb
+- test/test_page.rb
 - test/test_utils.rb
 has_rdoc: true
 homepage: http://github.com/sinefunc/hyde
@@ -161,13 +168,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version 
       segments: 
-      - 1
-      - 3
-      - 1
-      version: 1.3.1
+      - 0
+      version: "0"
 requirements: []
 
 rubyforge_project: 
@@ -177,8 +182,10 @@ specification_version: 3
 summary: Website preprocessor
 test_files: 
 - test/fixtures/custom/extensions/custom/custom.rb
+- test/fixtures/default/extensions/custom/custom.rb
 - test/helper.rb
 - test/test_all_fixtures.rb
 - test/test_build.rb
 - test/test_hyde.rb
+- test/test_page.rb
 - test/test_utils.rb

data/docs/Hyde.md

@@ -1,17 +0,0 @@
-Hyde manual
-===========
-
-Introduction
-------------
-
-- `++++` {file:Installation Installation}
-- `++--` {file:GettingStarted Getting started}
-- `+---` {file:TemplateLanguages Template languages}
-- `----` {file:Layouts Layouts}
-- `----` {file:Partials Partials}
-- `----` {file:Configuration Configuration}
-
-Extending Hyde
---------------
-
-- `+++-` {file:ExtendingHyde Extending Hyde}

data/docs/Introduction/GettingStarted.md

@@ -1,32 +0,0 @@
-Getting started
-===============
-
-Starting your first project
----------------------------
-
-Create your first project with:
-
-    hyde create <name>
-
-Where `<name>` is the name of your project. This will create a folder with that
-name, along with some sample files to get you started.
-
-Starting
---------
-
-    hyde start
-
-Making your site files
-----------------------
-
-Edit files under the `site` folder
-
-(todo)
-
-Building HTML files
--------------------
-
-Build your files by typing
-
-    hyde build
-

data/docs/Introduction/TemplateLanguages.md

@@ -1,15 +0,0 @@
-Template languages
-==================
-
-Hyde supports the following languages out-of-the-box:
-
- - HTML template languages
-   - HAML
-   - Markdown
-   - Textile
-   - ERB
- - CSS template languages
-   - LessCSS
-   - SASS
-
-