hydeweb 0.2.2 → 0.2.3

data/Rakefile

@@ -3,9 +3,3 @@ task :test do
 end
 
 task :default => :test
-
-task :gembuild do
-  require './lib/hyde'
-  v = Hyde.version
-  system "joe build && git commit -a -m \"Update to version #{v}.\" && git tag v#{v}"
-end

data/data/new_site/config.ru

@@ -1,6 +1,16 @@
 # This file exists to make this project Rack-compatible.
 # You may delete it if you're not concerned about this.
 
+if File.file?('Gemfile') && File.file?('Gemfile.lock')
+  # Use Bundler to load hydeweb, if a Gemfile is around.
+  require 'bundler'
+  Bundler.setup
+else
+  # Else, just go Rubygems.
+  require 'rubygems'  unless defined?(::Gem)
+  gem 'hydeweb', '~> 0.2.0'
+end
+
 require 'hyde'
 require 'hyde/server'
 

data/lib/hyde.rb

@@ -13,6 +13,9 @@ Encoding.default_external = 'utf-8' if defined?(::Encoding)
 # HTML files as ERB
 Tilt.mappings['html'] = Tilt.mappings['erb']
 
+# Class: Hyde
+# The Hyde class.
+
 class Hyde
   PREFIX  = File.expand_path('../', __FILE__)
 
@@ -36,7 +39,12 @@ class Hyde
   require "#{PREFIX}/hyde/version"
 
   class << self
-    # The latest project.
+    # Attribute: project (Hyde)
+    # Returns the latest project.
+    #
+    # ##  Example
+    #     Hyde.project.path(:site)
+
     attr_accessor :project
   end
 end

data/lib/hyde/cli.rb

@@ -1,3 +1,6 @@
+# Class: Hyde::CLI (Hyde)
+# Command line runner.
+
 class Hyde
 class CLI < Shake
   autoload :Helpers, "#{PREFIX}/hyde/cli/helpers"
@@ -192,6 +195,7 @@ class CLI < Shake
 
   def self.run!(options={})
     @hydefile = options[:file]
+    project rescue nil
     super *[]
   end
 end

data/lib/hyde/config.rb

@@ -1,13 +1,24 @@
 class Hyde
+# Class: Hyde::Config
 # Configuration.
 #
-# == Common usage
+# ## Common usage
 #
-#   Hyde.project.config
-#   Hyde.project.config.tilt_options('sass')[:load_path]
+# Access it via `Hyde.project`.
 #
-#   Hyde.project.config.site_path
-#   Hyde.project.config.layouts_path
+#     Hyde.project.config
+#
+# You may access config variables as attributes.
+#
+#     Hyde.project.config.site_path
+#     Hyde.project.config.layouts_path
+#     Hyde.project.config.extensions_path
+#     Hyde.project.config.output_path
+#
+# Tilt options:
+#
+#     Hyde.project.config.tilt_options('sass')[:load_path]
+#     Hyde.project.config.tilt_options_for('filename.haml')[:style]
 #
 class Config
   DEFAULTS = {
@@ -60,8 +71,15 @@ class Config
     @table.send meth, *args
   end
 
+  # Method: tilt_options_for (Hyde::Config)
   # Returns tilt options for a given file.
-  # @example tilt_options('index.haml')  # { :escape_html => ... }
+  #
+  # ##  Usage
+  #     tilt_options_for(filename, options={})
+  #
+  # ##  Example
+  #     tilt_options_for('index.haml')  # { :escape_html => ... }
+  #
   def tilt_options_for(file, options={})
     ext = file.split('.').last.downcase
     opts = tilt_options(ext) || Hash.new
@@ -70,8 +88,15 @@ class Config
     to_hash opts
   end
 
+  # Method: tilt_options (Hyde::Config)
   # Returns tilt options for a given engine.
-  # @example tilt_options('haml')  # { :escape_html => ... }
+  #
+  # ##  Usage
+  #     tilt_options(engine_name)
+  #
+  # ##  Example
+  #     tilt_options('haml')  # { :escape_html => ... }
+  #
   def tilt_options(what, key=:tilt_options)
     @table[key] ||= Hash.new
     @table[key][what.to_s] ||= Hash.new

data/lib/hyde/helpers.rb

@@ -1,16 +1,84 @@
+# Module: Hyde::Helpers (Hyde)
+# Helpers you can use in your pages.
+#
+# ## Creating your own helpers
+#    To create for own helpers, make an extension. See [Extending Hyde: 
+#    Helpers][1] for more info.
+#
+# [1]: /extending/helpers.html
+
 class Hyde
 module Helpers
+
+  # Method: partial (Hyde::Helpers)
+  # Renders a partial.
+  #
+  # ## Usage
+  #     <%= partial path, locals %>
+  #
+  # ## Description
+  #    See [Introduction: Partials](/introduction/partials.html) for more 
+  #    info.
+  #
+  # ## Example
+  #
+  # If your `_layouts/_banner.erb` looks like this:
+  #
+  #     <div class='banner'>
+  #       Welcome to <%= start.title %>
+  #     </div>
+  #
+  # ...Then this will embed the partial `_layouts/_nav.erb`. The partial
+  # will be rendered with `start` being set to the current page.
+  #
+  #     <%= partial '_banner', :start => page %>
+  #
   def partial(path, locals={})
     partial = Partial[path.to_s, page]  or return ''
     partial.to_html locals.merge(:page => self)
   end
 
+  # Method: rel (Hyde::Helpers)
+  # Turns a path into a relative path.
+  #
+  # ##  Usage
+  #     <%= rel(path) %>
+  #
+  # ## Description
+  #    `rel` takes a given absolute path that begins with a `/` (for instance, 
+  #    `/x/y/z.html`) and returns a relative path (maybe `../y/z.html`). This is
+  #    useful if your site will not be be hosted on it's own domain.
+  #
+  # ##  Example
+  #     <% page.children.each do |child| %>
+  #       <a href="<%= rel(child.path) %>">
+  #         <%= child.title %>
+  #       </a>
+  #     <% end %>
+  #
+  #  This may output:
+  #
+  #     <a href="../../foo.html">
+  #       Foobar
+  #     </a>
+  #
+  # ...where the `../../` depends on the current page's path.
+  #
   def rel(path)
-    depth = page.depth
-    dotdot = depth > 1 ? ('../' * (page.depth-1)) : './'
+    depth = page.path.count('/')
+    dotdot = depth > 1 ? ('../' * (depth-1)) : './'
     (dotdot[0...-1] + path)
   end
 
+  # Method: content_for (Hyde::Helpers)
+  # Content for.
+  #
+  # ## See also
+  #
+  #  * {Hyde::Helpers::has_content?}
+  #  * {Hyde::Helpers::content_for}
+  #  * {Hyde::Helpers::yield_content}
+  #
   def content_for(key, &blk)
     content_blocks[key.to_sym] = blk
   end
@@ -20,10 +88,32 @@ module Helpers
     $content_blocks[page.path] ||= Hash.new
   end
 
+  # Method: has_content? (Hyde::Helpers)
+  # Checks if there's something defined for a given content block.
+  #
+  # ## Example
+  #    See {Hyde::Helpers::content_for} for an example.
+  #
+  # ## See also
+  #  * {Hyde::Helpers::has_content?}
+  #  * {Hyde::Helpers::content_for}
+  #  * {Hyde::Helpers::yield_content}
+  #
   def has_content?(key)
     content_blocks.member? key.to_sym
   end
 
+  # Method: yield_content (Hyde::Helpers)
+  # Yield
+  #
+  # ## Example
+  #    See {Hyde::Helpers::content_for} for an example.
+  #
+  # ## See also
+  #  * {Hyde::Helpers::has_content?}
+  #  * {Hyde::Helpers::content_for}
+  #  * {Hyde::Helpers::yield_content}
+  #
   def yield_content(key, *args)
     content = content_blocks[key.to_sym]
     if respond_to?(:block_is_haml?) && block_is_haml?(content)

data/lib/hyde/meta.rb

@@ -1,3 +1,8 @@
+# Class: Hyde::Meta
+# Metadata.
+#
+# This is usually accessed via {Hyde::Page.meta}.
+
 class Hyde
 class Meta < OpenStruct
   def merge!(hash)

data/lib/hyde/page.rb

@@ -298,7 +298,10 @@ class Page
       File.expand_path("../#{base}/*", @file)
     end
 
-    Set.new Dir[files].reject { |f| f == @file }.map { |f| self.class[f, project] }.compact.sort
+    Set.new Dir[files].
+      reject { |f| f == @file || project.ignored_files.include?(f) }.
+      map { |f| self.class[f, project] }.
+      compact.sort
   end
 
   def siblings

data/lib/hyde/project.rb

@@ -1,39 +1,42 @@
 class Hyde
+# Class: Hyde::Project
 # A project.
 #
+# ## Common usage
+#
 # Instanciating:
 #
-#   project = Project.new('~/spur')
-#   project == Hyde.project          # the last defined project
+#     project = Project.new('~/spur')
+#     project == Hyde.project          # the last defined project
 #
 # Building:
 #
-#   project.build
-#   project.build { |file| puts "Building #{file}..." }
+#     project.build
+#     project.build { |file| puts "Building #{file}..." }
 #
 # Getting pages:
 #
-#   Hyde::Page['/index.html']        # ~/spur/index.md; uses Hyde.project
+#     Hyde::Page['/index.html']        # ~/spur/index.md; uses Hyde.project
 #
 # Configuration:
 #
-#   project.config_file              # ~/spur/hyde.conf
-#   project.config                   # Config from above file (OpenStruct)
-#   project.config.site_path
+#     project.config_file              # ~/spur/hyde.conf
+#     project.config                   # Config from above file (OpenStruct)
+#     project.config.site_path
 #
 # Paths:
 #
-#   project.path(:site)              # ~/spur/site (based on config site_path)
-#   project.path(:extensions)
+#     project.path(:site)              # ~/spur/site (based on config site_path)
+#     project.path(:extensions)
 #
-#   project.root('a/b', 'c')         # ~/spur/a/b/c
+#     project.root('a/b', 'c')         # ~/spur/a/b/c
 #
 # Indexing:
 #
-#   project.pages                    # [<#Page>, <#Page>, ...]
-#   project.files                    # ['/index.md', '/style.sass', ...]
-#                                    # (only site files)
-#   project.ignored_files
+#     project.pages                    # [<#Page>, <#Page>, ...]
+#     project.files                    # ['/index.md', '/style.sass', ...]
+#                                      # (only site files)
+#     project.ignored_files
 #
 class Project
   def initialize(root=Dir.pwd)
@@ -69,6 +72,9 @@ class Project
     ).sort.each { |f| require f }  if path
   end
 
+  # Method: config_file (Hyde::Project)
+  # Returns the configuration file for the project.
+
   def config_file
     try = lambda { |path| p = root(path); p if File.file?(p) }
     try['hyde.conf'] || try['.hyderc']
@@ -78,26 +84,43 @@ class Project
     config_file
   end
 
+  # Method: config (Hyde::Project)
+  # Returns a Hyde::Config instance.
+
   def config
     @config ||= Config.load(config_file)
   end
 
+  # Method: path (Hyde::Project)
   # Returns the path for a certain aspect.
-  # @example path(:site)
+  #
+  # ## Example
+  #
+  #     Hyde.project.path(:site)
+  #
   def path(what, *a)
     return nil unless [:output, :site, :layouts, :extensions, :partials].include?(what)
     path = config.send(:"#{what}_path")
     root path, *a  if path
   end
 
+  # Method: root (Hyde::Project)
+  # Returns the root path of the project.
+
   def root(*args)
     File.join @root, *(args.compact)
   end
 
+  # Method: pages (Hyde::Project)
+  # Returns the pages for the project.
+
   def pages
     files.map { |f| Page[f, self] }.compact
   end
 
+  # Method: files (Hyde::Project)
+  # Returns the site files for the project, free from the ignored files.
+
   def files
     files = Dir[File.join(path(:site), '**', '*')]
     files = files.select { |f| File.file?(f) }
@@ -105,6 +128,9 @@ class Project
     files - ignored_files
   end
 
+  # Method: ignored_files (Hyde::Project)
+  # Returns the files to be ignored for the project.
+
   def ignored_files
     specs  = [*config.ignore].map { |s| root(s) }
     specs << config_file
@@ -120,6 +146,9 @@ class Project
     specs.compact.map { |s| glob(s) }.flatten.uniq
   end
 
+  # Method: build (Hyde::Project)
+  # Builds.
+
   def build(&blk)
     pages.each do |page|
       yield page

data/lib/hyde/server.rb

@@ -2,6 +2,9 @@ require 'cuba'
 require 'rack'
 require 'hyde'
 
+# Module: Hyde::Server
+# The Hyde server rack application.
+
 class Hyde
   Server = Cuba.dup
 

data/lib/hyde/set.rb

@@ -1,9 +1,13 @@
+# Class: Hyde::Set
+# A set of pages.
+
 class Hyde
 class Set < Array
+  # Method: find (Hyde::Set)
   # Filters a set by given metadata criteria.
   #
-  # @example
-  #   Page['/'].children.find(layout: 'default')
+  # ##  Example
+  #     Page['/'].children.find(layout: 'default')
   #
   def find(by={})
     self.class.new(select do |page|
@@ -11,8 +15,13 @@ class Set < Array
     end)
   end
 
+  # Method: except (Hyde::Set)
   # Filters a set by removing items matching the given metadata criteria.
-  # This is the opposite of #find.
+  #
+  # This is the opposite of {Hyde::Set::find}.
+  #
+  # ##  Example
+  #     Page['/'].children.find(layout: 'default')
   #
   def except(by={})
     self.class.new(reject do |page|

data/lib/hyde/version.rb

@@ -1,5 +1,11 @@
 class Hyde
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
+
+  # Attribute: version (Hyde)
+  # Returns the version.
+  #
+  # ##  Example
+  #     Hyde.version    #=> "0.2.0"
 
   def self.version
     VERSION

metadata

@@ -2,7 +2,7 @@
 name: hydeweb
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Rico Sta. Cruz
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-16 00:00:00 +08:00
+date: 2011-06-20 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency