hydeweb 0.0.5 → 0.0.7

data/CHANGELOG

@@ -1,4 +1,30 @@
-v0.0.5 - 2010-xx-xx
+v0.0.7
+------
+
+ - Add support for Sass and SCSS.
+ - Add support for ignored files.
+
+v0.0.6
+------
+
+ - Added support for blocks for `yield_content` (as default text).
+ - `Page#referrer` now is a page (instead of a string of the name).
+ - Partials path is now not ignored by default.
+ - Add support for page ordering (by the `position` key in metadata).
+ - You can now start an IRB session with the `hyde console` command.
+ - Implement traversion methods for page: #next, #previous, #siblings,
+   and #parent.
+ - Implement the 'page' variable to be available in pages.
+ - Add Page#title.
+ - Add Page#path.
+ - Add Page#breadcrumbs.
+ - Implement Utils#escape_html.
+ - Hyde now always tries 'layouts/default.*' as the default layout, if none's
+   specified. (TODO: layout: false)
+ - Implement Renderer.layoutable?, which dictates if a renderer is capable of
+   having a layout.
+
+v0.0.5 - 2010-05-30
 -------------------
 
  - Implemented `content_for` and `yield_content` helpers
@@ -11,4 +37,5 @@ v0.0.5 - 2010-xx-xx
 
 v0.0.4 - 2010-05-25
 -------------------
+
  - First public release

data/Rakefile

@@ -45,7 +45,7 @@ Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "aoeu #{version}"
+  rdoc.title = "Hyde #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.7

data/data/new_site/hyde.conf

@@ -21,6 +21,10 @@ partials_path: layouts
 # The folder where the HTML files are to be built when typing `hyde build`.
 output_path: public
 
+# Any files matching these in the site_path will be excluded.
+ignore:
+- **/*~
+
 # Put any custom gems here.
 # gems:
 # - hyde-rst

data/data/new_site/layouts/default.haml

@@ -1,9 +1,10 @@
 !!!
 %html
   %head
-    %title= title
+    %title= page.title
   %body
-    =yield
+    #content
+      != yield
     %div#footer
       %hr
       %p Generated by Hyde

data/hydeweb.gemspec

@@ -1,137 +1,147 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{hydeweb}
-  s.version = "0.0.5"
+  s.version = "0.0.7"
 
   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-30}
+  s.date = %q{2010-11-24}
   s.default_executable = %q{hyde}
   s.description = %q{Website preprocessor}
   s.email = %q{rico@sinefunc.com}
   s.executables = ["hyde"]
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.md"
+    "README.md"
   ]
   s.files = [
-    ".gitignore",
-     ".yardopts",
-     "AUTHORS",
-     "CHANGELOG",
-     "LICENSE",
-     "README.md",
-     "Rakefile",
-     "VERSION",
-     "bin/hyde",
-     "data/new_site/.gitignore",
-     "data/new_site/README.md",
-     "data/new_site/hyde.conf",
-     "data/new_site/layouts/default.haml",
-     "data/new_site/site/index.html.haml",
-     "data/pages/404.html",
-     "hydeweb.gemspec",
-     "lib/hyde.rb",
-     "lib/hyde/clicommand.rb",
-     "lib/hyde/clicommands.rb",
-     "lib/hyde/helpers.rb",
-     "lib/hyde/layout.rb",
-     "lib/hyde/meta.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/sinatra/init.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",
-     "test/fixtures/custom/site/foo.html.haml",
-     "test/fixtures/custom/site/index.html.haml",
-     "test/fixtures/custom/site/layout_test.html.haml",
-     "test/fixtures/custom/site/lol.html.erb",
-     "test/fixtures/custom/site/markdown.html.md",
-     "test/fixtures/custom/site/yes.html",
-     "test/fixtures/custom/www_control/about/index.html",
-     "test/fixtures/custom/www_control/assets/common.css",
-     "test/fixtures/custom/www_control/assets/style.css",
-     "test/fixtures/custom/www_control/foo.html",
-     "test/fixtures/custom/www_control/index.html",
-     "test/fixtures/custom/www_control/layout_test.html",
-     "test/fixtures/custom/www_control/lol.html",
-     "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",
-     "test/fixtures/default/site/index.html.haml",
-     "test/fixtures/default/site/layout_test.html.haml",
-     "test/fixtures/default/site/yes.html",
-     "test/fixtures/default/www_control/about/index.html",
-     "test/fixtures/default/www_control/foo.html",
-     "test/fixtures/default/www_control/index.html",
-     "test/fixtures/default/www_control/layout_test.html",
-     "test/fixtures/default/www_control/yes.html",
-     "test/fixtures/two/_config.yml",
-     "test/fixtures/two/layouts/default.haml",
-     "test/fixtures/two/layouts/shared/test.haml",
-     "test/fixtures/two/site/default.html.haml",
-     "test/fixtures/two/site/index.html.haml",
-     "test/fixtures/two/site/var.html.haml",
-     "test/fixtures/two/www_control/default.html",
-     "test/fixtures/two/www_control/index.html",
-     "test/fixtures/two/www_control/var.html",
-     "test/helper.rb",
-     "test/test_all_fixtures.rb",
-     "test/test_build.rb",
-     "test/test_hyde.rb",
-     "test/test_page.rb",
-     "test/test_utils.rb"
+    ".yardopts",
+    "AUTHORS",
+    "CHANGELOG",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "bin/hyde",
+    "data/new_site/.gitignore",
+    "data/new_site/README.md",
+    "data/new_site/hyde.conf",
+    "data/new_site/layouts/default.haml",
+    "data/new_site/site/index.html.haml",
+    "data/pages/404.html",
+    "hydeweb.gemspec",
+    "lib/hyde.rb",
+    "lib/hyde/clicommand.rb",
+    "lib/hyde/clicommands.rb",
+    "lib/hyde/helpers.rb",
+    "lib/hyde/layout.rb",
+    "lib/hyde/meta.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/sinatra/init.rb",
+    "lib/hyde/utils.rb",
+    "lib/hyde_misc/console.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",
+    "manual/Tips/Tips.md",
+    "test/fixtures/content_for/_config.yml",
+    "test/fixtures/content_for/layouts/cf-args.haml",
+    "test/fixtures/content_for/layouts/cf.haml",
+    "test/fixtures/content_for/layouts/default.haml",
+    "test/fixtures/content_for/layouts/shared/test.haml",
+    "test/fixtures/content_for/site/cf-args-default.haml",
+    "test/fixtures/content_for/site/cf-args.haml",
+    "test/fixtures/content_for/site/cf.haml",
+    "test/fixtures/content_for/site/cf2.haml",
+    "test/fixtures/content_for/site/default.html.haml",
+    "test/fixtures/content_for/site/index.html.haml",
+    "test/fixtures/content_for/site/var.html.haml",
+    "test/fixtures/content_for/www_control/cf-args-default.html",
+    "test/fixtures/content_for/www_control/cf-args.html",
+    "test/fixtures/content_for/www_control/cf.html",
+    "test/fixtures/content_for/www_control/cf2.html",
+    "test/fixtures/content_for/www_control/default.html",
+    "test/fixtures/content_for/www_control/index.html",
+    "test/fixtures/content_for/www_control/var.html",
+    "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",
+    "test/fixtures/custom/site/foo.html.haml",
+    "test/fixtures/custom/site/index.html.haml",
+    "test/fixtures/custom/site/layout_test.html.haml",
+    "test/fixtures/custom/site/lol.html.erb",
+    "test/fixtures/custom/site/markdown.html.md",
+    "test/fixtures/custom/site/yes.html",
+    "test/fixtures/custom/www_control/about/index.html",
+    "test/fixtures/custom/www_control/assets/common.css",
+    "test/fixtures/custom/www_control/assets/style.css",
+    "test/fixtures/custom/www_control/foo.html",
+    "test/fixtures/custom/www_control/index.html",
+    "test/fixtures/custom/www_control/layout_test.html",
+    "test/fixtures/custom/www_control/lol.html",
+    "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",
+    "test/fixtures/default/site/index.html.haml",
+    "test/fixtures/default/site/layout_test.html.haml",
+    "test/fixtures/default/site/yes.html",
+    "test/fixtures/default/www_control/about/index.html",
+    "test/fixtures/default/www_control/foo.html",
+    "test/fixtures/default/www_control/index.html",
+    "test/fixtures/default/www_control/layout_test.html",
+    "test/fixtures/default/www_control/yes.html",
+    "test/helper.rb",
+    "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}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   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"
+    "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"
   ]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<sinatra>, [">= 1.0.0"])
       s.add_runtime_dependency(%q<less>, [">= 1.2.21"])
       s.add_runtime_dependency(%q<haml>, [">= 2.2.20"])

data/lib/hyde/clicommand.rb

@@ -25,7 +25,8 @@ module Hyde
 
     def self.project
       if $project.nil?
-        log "Error: Hyde config file not found. (looking for: hyde.conf, _config.yml)"
+        files = Hyde::Project.config_filenames.join(", ")
+        log "Error: Hyde config file not found. (looking for: #{files})"
         log "Run this command in a Hyde project directory.\nTo start a new Hyde project, type `hyde create <name>`"
         exit
       end

data/lib/hyde/clicommands.rb

@@ -67,7 +67,7 @@ module Hyde
         project.build ostream
       end
     end
-
+    
     class Start < CLICommand
       desc "Starts the local webserver"
       def self.run(*a)
@@ -76,17 +76,28 @@ module Hyde
       end
 
       def self.help
+        port = project.config.port
         log "Usage: hyde start"
         log ""
         log "This command starts the local webserver. You may then be able to"
         log "see your site locally by visiting the URL:"
         log ""
-        log "   http://127.0.0.1:4567"
+        log "   http://127.0.0.1:#{port}"
         log ""
         log "You may shut the server down by pressing Ctrl-C."
       end
     end
 
+    class Console < CLICommand
+      desc "Starts a console"
+
+      def self.run(*a)
+        path = File.join(Hyde::LIB_PATH, 'hyde_misc', 'console.rb')
+        cmd = "irb -r\"#{path}\""
+        system cmd
+      end
+    end
+
     class Create < CLICommand
       desc "Starts a new Hyde project"
       def self.run(*a)

data/lib/hyde/helpers.rb

@@ -3,40 +3,47 @@ module Hyde
     def partial(partial_path, locals = {})
       begin
         p = project[partial_path.to_s, :Partial]
-        p.referrer = self.referrer
+        p.referrer = (referrer || self)
         p.render locals
+
       rescue ::Hyde::NotFound
         "<!-- Can't find #{partial_path.to_s} -->"
       end
     end
 
     def content_for(key, &block)
-      content_blocks[key.to_sym] = block
+      content_block[key.to_sym] = block
     end
 
     def has_content?(key)
-      content_blocks.keys.include? key.to_sym
+      content_block.keys.include? key.to_sym
     end
 
-    def yield_content(key, *args)
-      block = content_blocks[key.to_sym]
-      return ''  if block.nil?
+    def yield_content(key, *args, &default_block)
+      block = content_block[key.to_sym]
 
       if respond_to?(:block_is_haml?) && block_is_haml?(block)
         capture_haml *args, &block
-      elsif block.is_a? Proc
+
+      elsif block.respond_to?(:call)
         block.call *args
+
+      elsif block_given? and respond_to(:block_is_haml?) and block_is_haml?(default_block)
+        capture_haml *args, &default_block
+
       elsif block_given?
         yield
+
       else
         ''
       end
     end
 
   protected
-    def content_blocks
+    def content_block
+      file_key = (referrer || self).to_sym
       @@content_blocks ||= Hash.new
-      @@content_blocks[referrer.to_sym] ||= Hash.new { |h, k| h[k] = [] }
+      @@content_blocks[file_key] ||= Hash.new
     end
   end
 end

data/lib/hyde/layout.rb

@@ -3,5 +3,10 @@ module Hyde
     def self.get_filename(path, project)
       project.root(:layouts, path)
     end
+
+    def layout
+      # Don't try a default layout.
+      @layout
+    end
   end
 end

data/lib/hyde/meta.rb

@@ -15,7 +15,7 @@ module Hyde
     def layout=(value)
       super value
       @page.layout = @page.project[value, :Layout]
-      @page.layout.referrer = page.referrer
+      @page.layout.referrer = (page.referrer || page)
     end
   end
 end

data/lib/hyde/page.rb

@@ -25,9 +25,9 @@ module Hyde
     # A reference to the parent {Project} instance
     attr_reader :project
 
-    attr_accessor :layout
+    attr_accessor :referrer
 
-    attr_writer :referrer
+    DEFAULT_LAYOUT = 'default'
 
     # Factory
     #
@@ -35,22 +35,139 @@ module Hyde
       PageFactory.create path, project, def_page_class
     end
 
-    def referrer
-      @referrer.nil? ? name : @referrer
-    end
-
     # Returns the rendered output.
     def render(data = {}, &block)
       data = @meta | data
+      data[:page] ||= self
       output = @renderer.render(data, &block)
-      output = @layout.render(data) { output }  unless @layout.nil?
+      output = layout.render(data) { output }  unless layout.nil?
       output
     end
 
+    def layout=(val)
+      @layout = val
+    end
+
+    def layout
+      begin
+        @layout ||= project[DEFAULT_LAYOUT, :Layout]  if !@renderer.nil? and @renderer.layoutable?
+        @layout
+      rescue NotFound
+        nil
+      end
+    end
+
+    def title
+      @title ||= if meta.title
+        meta.title
+      elsif is_index?
+        File.basename(File.dirname(filename))
+      else
+        File.basename(filename, '.*')
+      end
+    end
+
+    # Returns the URL path for the page.
+    def path
+      return @url  unless @url.nil?
+
+      url = File.split(@name)
+      url[1] = File.basename(url[1], '.*')
+      url[1] = (url[1] + @renderer.default_ext)  unless url[1].include?('.')
+      @url = '/' + url.join('/')
+    end
+
     def get_binding #(&blk)
       binding
     end
 
+    def to_s
+      name
+    end
+
+    def to_sym
+      (filename).to_sym
+    end
+
+    def <=>(other)
+      result = self.position <=> other.position
+      result ||= self.position.to_s <=> other.position.to_s
+      result
+    end
+
+    def position
+      meta.position || title
+    end
+
+    def parent
+      folder = File.dirname(@name)
+      folder = File.join(folder, '..')  if is_index?
+      folder = File.expand_path(folder)
+
+      files = Dir[File.join(folder, 'index.*')]
+      return nil  if files.empty?
+
+      page = PageFactory.create(files.first, @project)
+      return nil  if page === self
+
+      page
+    end
+
+    def children
+      return []  unless is_index?
+      folder = File.dirname(@name)
+
+      get_pages_from folder
+    end
+
+    def siblings
+      folder = File.dirname(@name)
+      folder = File.join(folder, '..')  if is_index?
+
+      get_pages_from folder
+    end
+
+    def get_pages_from(folder)
+      # Sanity check: don't go beyond the root
+      return []  unless File.expand_path(folder).include?(File.expand_path(@project.root(:site)))
+
+      files  = Dir[@project.root(:site, folder, '*')]
+      files.inject([]) do |a, name|
+        if File.directory?(name)
+          name = Dir[File.join(name, 'index.*')].first
+          a << PageFactory.create(name, @project)  unless name.nil?
+
+        else
+          page = PageFactory.create name, @project
+          a << page  unless page.is_index?
+
+        end
+        a
+      end.sort
+    end
+
+    # Returns an array of the page's ancestors, starting from the root page.
+    def breadcrumbs
+      @crumbs ||= parent.nil? ? [] : (parent.breadcrumbs + [parent])
+    end
+
+    def ===(other)
+      return false  if other.nil?
+      super || (File.expand_path(self.filename) === File.expand_path(other.filename))
+    end
+
+    def next
+      siblings.each_cons(2) { |(i, other)| return other  if i === self }
+    end
+
+    def previous
+      siblings.each_cons(2) { |(other, i)| return other  if i === self }
+    end
+
+    def is_index?
+      !@name.match(/(^|\/)index/).nil?
+    end
+
     protected
 
     # Constructor.

data/lib/hyde/page_factory.rb

@@ -1,6 +1,15 @@
 module Hyde
   class PageFactory
+    # Creates a Page with the right class, as defined in the Page's metadata.
+    #
+    # Params:
+    #   path   - A path, or a filename
+    #
     def self.create(path, project, def_page_class = Page)
+      # Remove prefix
+      path.gsub!(project.root(:site), '')
+      path.gsub!(/^\/+/, '')
+
       ext = File.extname(path)
       begin
         do_create path, project, def_page_class
@@ -29,7 +38,8 @@ module Hyde
         raise NotFound, "`#{path}` is a directory, not a file"
 
       elsif File.exists? filename
-        renderer = Hyde::Renderer::Passthru
+        ext = File.extname(filename)[1..-1]
+        renderer = Hyde::Renderer.get(ext)
 
       else
         # Look for the file
@@ -43,7 +53,7 @@ module Hyde
           begin
             ext      = File.extname(match)[1..-1].capitalize.to_sym
             exts     << File.extname(match)
-            r_class  = Hyde::Renderers.const_get(ext)
+            r_class  = Hyde::Renderers.const_get(ext) # .get(ext, nil)
             renderer ||= r_class
             filename = match
           rescue NoMethodError