hydeweb 0.1.13 → 0.1.14

data/HISTORY.md

@@ -1,3 +1,14 @@
+v0.1.14 - Jun 04, 2011
+----------------------
+
+### Fixed:
+  * Fixed a syntax error in page.rb.
+  * Don't impose gem versions explicitly, and don't load Rubygems if used as a 
+  library.
+
+### Misc:
+  * Added some doc comments to the main classes.
+
 v0.1.13
 -------
 

data/bin/hyde

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 $:.push File.expand_path('../../lib', __FILE__)
 
+require 'rubygems'  unless defined?(::Gem)
 require 'hyde'
 
 hydefile = Hyde::CONFIG_FILES.inject { |a, fname| a ||= Hyde::CLI.find_in_project(fname) }

data/bin/hyde01

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 $:.push File.expand_path('../../lib', __FILE__)
 
+require 'rubygems'  unless defined?(::Gem)
 require 'hyde'
 
 hydefile = Hyde::CONFIG_FILES.inject { |a, fname| a ||= Hyde::CLI.find_in_project(fname) }

data/lib/hyde/config.rb

@@ -1,4 +1,14 @@
 class Hyde
+# Configuration.
+#
+# == Common usage
+#
+#   Hyde.project.config
+#   Hyde.project.config.tilt_options('sass')[:load_path]
+#
+#   Hyde.project.config.site_path
+#   Hyde.project.config.layouts_path
+#
 class Config < OpenStruct
   DEFAULTS = {
     :site_path => '.',
@@ -38,7 +48,7 @@ class Config < OpenStruct
       h
     end
 
-    @table[key][what.to_s]
+    @table[key][what.to_s] ||= Hash.new
   end
 end
 end

data/lib/hyde/page.rb

@@ -1,4 +1,75 @@
 class Hyde
+# A project.
+#
+# Getting pages from paths:
+#
+#   # Feed it a URL path, not a filename.
+#   page = Hyde::Page['/index.html']        # uses Hyde.project
+#   page = Hyde::Page['/index.html', project]
+#
+# Getting pages from files:
+#
+#   # Feed it a file name, not a URL path.
+#   # Also, this does no sanity checks.
+#   page = Hyde::Page.new('/home/rsc/index.html', project)
+#
+#   page.exists?
+#   page.valid?
+#
+# Paths:
+#
+#   page.filepath          #=> "index.haml"    -- path in the filesystem
+#   page.path              #=> "/index.html"   -- path as a RUL
+#
+# Meta:
+#
+#   page.meta              #=> OpenStruct of the metadata
+#   page.title             #=> "Welcome to my site!"
+#
+#   page.layout            #   Hyde::Layout or nil
+#   page.layout?
+#
+# Types:
+#
+#   page.html?
+#   page.mime_type        #=> "text/html" or nil  -- only for tilt? == true
+#   page.default_ext      #=> "html"
+#
+# Contents:
+#
+#   page.to_html
+#   page.to_html(locals={})
+#   page.content
+#   page.markup
+#
+# Traversion:
+#
+#
+#   # Pages (a Hyde::Page or nil)
+#   page.parent
+#   page.next
+#
+#   # Sets (a Hyde::Set)
+#   page.children
+#   page.siblings
+#   page.breadcrumbs 
+#
+#   # Misc
+#   page.index?            # if it's an index.html
+#   page.parent?
+#   page.root?             # true if no parents
+#   page.depth
+#
+# Tilt:
+#
+#   page.tilt?             #   true, if it's a dynamic file
+#   page.tilt_engine_name  #=> 'RedCloth'
+# 
+# Building:
+#
+#   page.write
+#   page.write('~/foo.html')
+#
 class Page
   attr_reader :project
   attr_reader :file

data/lib/hyde/project.rb

@@ -1,4 +1,40 @@
 class Hyde
+# A project.
+#
+# Instanciating:
+#
+#   project = Project.new('~/spur')
+#   project == Hyde.project          # the last defined project
+#
+# Building:
+#
+#   project.build
+#   project.build { |file| puts "Building #{file}..." }
+#
+# Getting pages:
+#
+#   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
+#
+# Paths:
+#
+#   project.path(:site)              # ~/spur/site (based on config site_path)
+#   project.path(:extensions)
+#
+#   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
+#
 class Project
   def initialize(root=Dir.pwd)
     @root = root

data/lib/hyde.rb

@@ -1,10 +1,5 @@
 $:.push *Dir[File.expand_path('../../vendor/*/lib', __FILE__)]
 
-require 'rubygems'  if !Object.respond_to?(:gem)
-
-gem 'shake', '>= 0.1.2'
-gem 'tilt', '>= 1.2.2'
-
 require 'fileutils'
 require 'ostruct'
 require 'yaml'
@@ -15,7 +10,7 @@ require 'shake'
 Tilt.mappings['html'] = Tilt.mappings['erb']
 
 class Hyde
-  VERSION = "0.1.13"
+  VERSION = "0.1.14"
   PREFIX  = File.expand_path('../', __FILE__)
 
   Error        = Class.new(StandardError)

metadata

@@ -2,7 +2,7 @@
 name: hydeweb
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.13
+  version: 0.1.14
 platform: ruby
 authors: 
 - Rico Sta. Cruz
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-26 00:00:00 +08:00
+date: 2011-06-04 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -219,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Website preprocessor.