hydeweb 0.0.5 → 0.0.7

data/lib/hyde/project.rb

@@ -22,7 +22,7 @@ module Hyde
       where = ''
       where = @config.send("#{args.shift.to_s}_path")  if args[0].class == Symbol
       path = args
-      File.expand_path(File.join [@root, where, path].reject(&:empty?))
+      File.expand_path File.join([@root, where, path].reject { |s| s.empty? })
     end
 
     # Can raise a NoRootError
@@ -112,9 +112,15 @@ module Hyde
         root(:layouts, '**/*'),
         root(:extensions, '**/*'),
         root(:output, '**/*'),
-        root(:partials, '**/*'),
+        custom_ignored_files,
         @config_file
-      ].uniq
+      ].flatten.uniq
+    end
+
+    def custom_ignored_files
+      list = @config.send("ignore")
+      return []  unless list.is_a?(Array)
+      Dir[*(list.map { |path| root(:site, path) })]
     end
 
     # Returns a list of ignored files based on the {ignore_list}.
@@ -126,6 +132,10 @@ module Hyde
       end
     end
 
+    def self.config_filenames
+      ['_config.yml', 'hyde.conf', '.hyderc']
+    end
+
     protected
 
     # Looks for the hyde config file to determine the project root.
@@ -135,7 +145,7 @@ module Hyde
       ret = nil
       while ret.nil?
         # See if any of these files exist
-        ['_config.yml', 'hyde.conf'].each do |config_name|
+        self.class.config_filenames.each do |config_name|
           config_file = File.join(check, config_name)
           ret ||= [check, config_file]  if File.exists? config_file
         end
@@ -152,13 +162,13 @@ module Hyde
     #
     def load_extensions
       # Load the init.rb file
-      require(root 'init.rb')  if File.exists?(root 'init.rb')
+      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 = Dir[root(:extensions, '*')].select { |d| File.directory? d }
       ext_roots.each do |dir|
         ext = File.basename(dir)
 
@@ -179,6 +189,7 @@ module Hyde
         'partials_path'   => 'layouts',
         'site_path'       => 'site',
         'output_path'     => 'public',
+        'port'            => 4833,
         'gems'            => []
       }
     end

data/lib/hyde/renderer.rb

@@ -2,6 +2,18 @@ require "ostruct"
 
 module Hyde
   module Renderer
+    extend self
+
+    def get(extname, default=Hyde::Renderer::Passthru)
+      klass = extname.to_s.capitalize.to_sym
+
+      begin
+        Hyde::Renderers.const_get(klass)
+      rescue NameError
+        default
+      end
+    end
+
     class Base
       include Hyde::Utils
 
@@ -26,9 +38,11 @@ module Hyde
         @markup
       end
 
-      def self.default_ext
-        ''
-      end
+      def layoutable?(*a) self.class.layoutable?(*a); end
+      def default_ext(*a) self.class.default_ext(*a); end
+
+      def self.layoutable?() false; end
+      def self.default_ext() ''; end
 
     protected
       def require_lib(lib, gem=lib)

data/lib/hyde/renderers.rb

@@ -1,18 +1,29 @@
 module Hyde
   module Renderers
     class Haml < Renderer::Parsable
+      def self.layoutable?()  true; end
+      def self.default_ext() '.html'; end
+
       def evaluate(scope, data={}, &block)
-        require_lib 'haml'
+        require 'haml'
         begin
-          @engine = ::Haml::Engine.new(markup, {})
+          @engine = ::Haml::Engine.new(markup, engine_options)
           @engine.render scope, data, &block
         rescue ::Haml::SyntaxError => e
           raise Hyde::RenderError.new(e.message, :line => e.line)
         end
       end
+
+    protected
+      def engine_options
+        { :escape_html => true }
+      end
     end
 
     class Erb < Renderer::Parsable
+      def self.layoutable?()  true; end
+      def self.default_ext() '.html'; end
+
       def evaluate(scope, data={}, &block)
         require_lib 'erb'
         @engine = ::ERB.new markup
@@ -20,6 +31,33 @@ module Hyde
       end
     end
 
+    class Sass < Haml
+      def self.layoutable?()  false; end
+      def self.default_ext() '.css'; end
+
+      def evaluate(scope, data={}, &block)
+        require 'sass'
+        begin
+          @engine = ::Sass::Engine.new(markup, engine_options)
+          @engine.render
+        rescue ::Sass::SyntaxError => e
+          raise Hyde::RenderError.new(e.message, :line => e.line)
+        end
+      end
+
+    protected
+      def engine_options
+        { :syntax => :sass, :load_paths => [File.dirname(@filename)], :cache => false }
+      end
+    end
+
+    class Scss < Sass
+    protected
+      def engine_options
+        super.merge :syntax => :scss
+      end
+    end
+
     class Less < Renderer::Base
       def self.default_ext
         '.css'
@@ -39,14 +77,10 @@ module Hyde
       end
     end
 
-    #class Sass < Renderer::Base
-    #  def evaluate(scope, data={}, &block)
-    #    require 'haml'
-    #    @engine = ::Sass::Engine.new(File.open(filename))
-    #  end
-    #end
-
     class Md < Renderer::Parsable
+      def self.layoutable?()  true; end
+      def self.default_ext() '.html'; end
+
       def evaluate(s, d={}, &block)
         require_lib 'maruku'
         Maruku.new(markup).to_html
@@ -54,9 +88,8 @@ module Hyde
     end
 
     class Textile < Renderer::Parsable
-      def self.default_ext
-        '.css'
-      end
+      def self.layoutable?()  true; end
+      def self.default_ext() '.html'; end
 
       def evaluate(s, d={}, &block)
         require_lib 'redcloth', 'RedCloth'

data/lib/hyde/sinatra/init.rb

@@ -15,9 +15,11 @@ class Main < Sinatra::Base
   @@project ||= $project
 
   def self.show_start
+    port = $project.config.port
+
     puts "Starting server..."
-    puts "  http://127.0.0.1:4567      Homepage"
-    puts "  http://127.0.0.1:4567/-    File list"
+    puts "  http://127.0.0.1:#{port}      Homepage"
+    puts "  http://127.0.0.1:#{port}/-    File list"
     puts ""
   end
 
@@ -59,4 +61,4 @@ class Main < Sinatra::Base
 end
 
 Main.show_start
-Main.run!
+Main.run! :port => $project.config.port

data/lib/hyde/utils.rb

@@ -1,5 +1,15 @@
 module Hyde
   module Utils
+  protected
+    def escape_html(str)
+      str.
+        gsub('&', '&').
+        gsub('"', '"').
+        gsub('<', '&lt;').
+        gsub('>', '&gt;').
+        gsub("'", '&39;')
+    end
+
     def same_file?(a, b)
       File.expand_path(a) == File.expand_path(b)
     end

data/lib/hyde.rb

@@ -1,20 +1,21 @@
 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 :PageFactory, "#{prefix}/hyde/page_factory"
-  autoload :Renderer,    "#{prefix}/hyde/renderer"
-  autoload :Renderers,   "#{prefix}/hyde/renderers"
-  autoload :Utils,       "#{prefix}/hyde/utils"
-  autoload :Meta,        "#{prefix}/hyde/meta"
-  autoload :CLICommand,  "#{prefix}/hyde/clicommand"
-  autoload :CLICommands, "#{prefix}/hyde/clicommands"
-  autoload :Helpers,     "#{prefix}/hyde/helpers"
-  autoload :Partial,     "#{prefix}/hyde/partial"
+  LIB_PATH = File.dirname(__FILE__)
+
+  autoload :OStruct,     "#{LIB_PATH}/hyde/ostruct"
+  autoload :Project,     "#{LIB_PATH}/hyde/project"
+  autoload :Layout,      "#{LIB_PATH}/hyde/layout"
+  autoload :Page,        "#{LIB_PATH}/hyde/page"
+  autoload :PageFactory, "#{LIB_PATH}/hyde/page_factory"
+  autoload :Renderer,    "#{LIB_PATH}/hyde/renderer"
+  autoload :Renderers,   "#{LIB_PATH}/hyde/renderers"
+  autoload :Utils,       "#{LIB_PATH}/hyde/utils"
+  autoload :Meta,        "#{LIB_PATH}/hyde/meta"
+  autoload :CLICommand,  "#{LIB_PATH}/hyde/clicommand"
+  autoload :CLICommands, "#{LIB_PATH}/hyde/clicommands"
+  autoload :Helpers,     "#{LIB_PATH}/hyde/helpers"
+  autoload :Partial,     "#{LIB_PATH}/hyde/partial"
 
   Error = Class.new(::StandardError)
   NoGemError        = Class.new(Error)

data/lib/hyde_misc/console.rb

@@ -0,0 +1,4 @@
+prefix = File.join(File.dirname(__FILE__), '..', 'hyde.rb')
+require prefix
+$project = Hyde::Project.new
+puts "Use $project"

data/manual/Extending/ExtendingHyde.md

@@ -42,7 +42,7 @@ In this example, we'll create a simple helper function.
     # extensions/hyde-blog/hyde-blog.rb
     module Hyde
       module Helpers
-        module BlogHelpers
+        module FormHelpers
           def form_tag(meth, action, &b)
             [ "<form method='#{meth}' action='#{action}'>",
               b.call,
@@ -57,7 +57,7 @@ In your project's site files, you can then now use this helper.
 
     # site/my_page.html.haml
     %h1 My form
-    = form_tag 'post', '/note/new' do
+    != form_tag 'post', '/note/new' do
       %p
         %label Your name:
         %input{ :type => 'text', :name => 'name' }
@@ -115,3 +115,4 @@ This may now be used in the command line.
 Adding parsers
 --------------
 
+TODO.

data/manual/Hyde.md

@@ -40,16 +40,21 @@ 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}
+- `+---` {file:Layouts Layouts}
+- `++++` {file:Partials Partials}
+- `++++` {file:Metadata Metadata}
+- `++++` {file:Configuration Configuration}
 
 Extending Hyde
 --------------
 
 - `+++-` {file:ExtendingHyde Extending Hyde}
 
+Tips and tricks
+---------------
+
+- `+++-` {file:Tips Tips}
+
 Basic info
 ----------
 

data/manual/Introduction/Configuration.md

@@ -1,4 +1,70 @@
 Configuration
 =============
 
-`hyde.conf`
+Configuration is done through the file `hyde.conf` placed in 
+your project's root folder. A sample config file is generated
+when doing `hyde create`.
+
+It is a YAML file, so the basic format of the file is:
+
+     option: value
+     # Lines starting with # are comments that are ignored.
+
+Options
+-------
+
+hyde_requirement
+: The minimum version of Hyde needed by the project. Example:
+
+    hyde_requirement: 0.0.5
+
+site_path
+: The folder where the site's main files are kept. (you can set this to '.')
+  This is the path where your main files are. Example:
+
+    # myproject/hyde.conf
+    site_path: site
+
+    # This will instruct hyde to look at myproject/site/ for the
+    # files of the project.
+
+layouts_path
+: The folder where the layout templates (and partials) are kept. See the
+  {file:Layouts Layouts} section for information on Hyde layouts.
+
+partials_path
+: The folder for partials. See the {file:Partials Partials} section for
+  an overview of what partials are.
+
+extensions_path
+: The folder where the optional extensions are kept. See the
+  {file:ExtendingHyde Extending Hyde} section for more info on extensions.
+
+output_path
+: The folder where the HTML files are to be built when typing `hyde build`.
+
+More options
+------------
+
+These options are not in the default `hyde.conf`, but you may simply
+add them in.
+
+port
+: The port number. Defaults to 4833 unless set. Example:
+
+    port: 4999
+
+gems
+: This is a list of Ruby gems to be autoloaded into Hyde. Some extensions
+  are available as gems and may simply be added here to be used. Example:
+
+    gems:
+      - hyde-rst
+      - hyde-zip
+
+Hidden hyde config file
+-----------------------
+
+Don't like seeing `hyde.conf` littering up your project folder? Rename
+it to `.hyderc`.
+

data/manual/Introduction/GettingStarted.md

@@ -20,7 +20,7 @@ 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
+`http://localhost:4833` to see your site. You should now see your project's
 default "welcome" page.
 
 
@@ -32,22 +32,20 @@ stored. In general, dropping any file in this folder will make it accessible wit
 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`,
+HTML page. After that, point your browser to `http://localhost:4833/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`.
+`http://localhost:4833/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.
+Hyde supports many templating languages like HAML, Less, and ERB (more on this later).
+If your file ends in one of these supported extensions (e.g., `index.haml`), it
+is assumed to be a dynamic file and will be rendered by it's corresponding templating
+engine (in this case, HAML).
 
 Building HTML files
 -------------------

data/manual/Introduction/Installation.md

@@ -10,7 +10,7 @@ by typing `ruby --version` in the command line.
 
 Install Hyde by typing:
 
-    gem install hyde
+    gem install hydeweb
 
-If this process fails, you can instead try `sudo gem install hyde`.
+If this process fails, you can instead try `sudo gem install hydeweb`.
 

data/manual/Introduction/Layouts.md

@@ -1,4 +1,14 @@
 Layouts
 =======
 
-`layouts`
+Defining layouts
+----------------
+
+1. Create a file called layouts/default.haml (or .erb)
+2. use `yield` to show the page's contents
+3. Voila
+
+Using your own layouts
+----------------------
+
+Use the `layout` metadata key. See the next section.

data/manual/Introduction/Metadata.md

@@ -1,2 +1,94 @@
 Metadata
 ========
+
+You may include metadata for pages by placing a YAML document at the beginning
+of your page files. Be sure to separate your actual page from the metadata
+using two hyphens (`--`)!
+
+    # mypage.haml
+    title: This is my page
+    author: Jason White
+    --
+    %div
+      -# You may access metadata in using `page.meta.<key>`.
+      %h1= page.meta.title
+      %cite
+        by
+        = page.meta.author
+
+Special metadata keys
+---------------------
+
+Hyde has a few reserved keys.
+
+### title
+
+You may define a title for a page. You may then access this using `page.title`.
+
+    # mypage-two.haml
+    title: This is my page
+    --
+    %h1= page.title
+
+This shows:
+
+    <h1>This is my page</h1>
+
+If you do not define a title for a page, Hyde automatically uses the page's
+filename instead.
+
+    # mypage-three.haml
+    %h1= page.title
+
+Output:
+
+    <h1>mypage-three</h1>
+
+### position
+
+You may manually define the order of your pages using the 'position' key.
+
+    # about.haml
+    title: About us
+    position: 1
+    --
+
+    # services.haml
+    title: Services
+    position: 2
+    --
+
+    # contact.haml
+    title: Contact us
+    position: 9
+    --
+
+This will affect the sort order of menus and such. Specifically, it the
+outputs of functions such as `page.children`, `page.siblings`, `page.next`,
+and so on.
+
+The pages will then be ordered like so:
+
+  - About us
+  - Services
+  - Contact us
+
+If positions have not been defined, they will be sorted alphabetically by
+filename, i.e.:
+
+  - About us
+  - Contact us
+  - Services
+
+### layout
+
+By default, a page will use the `default` layout. To change this, simply
+define a layout key in your metadata:
+
+    # products/camera_cx-300.haml
+    title: CX-300 Camera
+    layout: product
+
+This will search for `layouts/product.*` (whichever extension it finds) in
+your project, and use that as the layout. (This is assuming, of course, that
+you haven't changed the default `layouts/` path in your Hyde config file.)

data/manual/Introduction/Partials.md

@@ -60,4 +60,14 @@ 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.' } %>
 
+Partials in HAML files
+----------------------
 
+HAML support in Hyde has the `escape_html` option on by default. You
+will need to use `!= partial` instead of `= partial`.
+
+    -# Don't forget the exclamation point!
+    != partial 'shared/product'
+
+If you omit the `!`, the partial will be rendered with it's HTML code
+escaped.

data/manual/Introduction/TemplateLanguages.md

@@ -26,14 +26,14 @@ Hyde supports the following languages out-of-the-box:
 
 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)   |
+ | products.haml       | becomes `products.html` (rendered through HAML)       |
+ | control.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`.
+When creating a new site, have a look at `index.haml`.
 
 ...
 
@@ -45,7 +45,7 @@ Headers
 Layouts
 -------
 
-Layouts are supported for these languages.
+Layouts are supported for HAML, Markdown, Textile and ERB languages.
 
 ...
 

data/manual/Tips/Tips.md

@@ -0,0 +1,42 @@
+Tips
+====
+
+Here are some tips and tricks!
+
+Simpler folder structure
+------------------------
+
+The default folder structure looks like this:
+
+    project/
+      hyde.conf
+      layouts/
+      partials/
+      public/
+      extensions/
+      site/
+        about.html
+        contact.html
+
+Here is a cleaner structure often used in simpler projects:
+
+    project/
+      about.html
+      contact.html
+
+      .hyderc
+      _/
+        layouts/
+        partials/
+        public/
+        extensions/
+
+You may do this by editing your Hyde config file like so:
+
+    site_path:       .
+    layouts_path:    _/layouts
+    extensions_path: _/extensions
+    partials_path:   _/partials
+    output_path:     _/public
+
+Optionally, you can rename `hyde.conf` to `.hyderc` to make it even cleaner.

data/test/fixtures/content_for/layouts/cf-args.haml

@@ -0,0 +1,2 @@
+= yield_content :sidebar, "Aaron" do |name|
+  = "Hola, #{name}!"

data/test/fixtures/content_for/layouts/cf.haml

@@ -0,0 +1,14 @@
+!!! 5
+%html(lang='en')
+  %head
+    %meta(charset='UTF-8')
+    %title Document
+  %body
+    #all
+      #content
+        = yield
+
+      #sidebar
+        = yield_content :sidebar do
+          %div
+            Default sidebar

data/test/fixtures/content_for/site/cf-args-default.haml

@@ -0,0 +1,2 @@
+layout: cf-args
+--

data/test/fixtures/content_for/site/cf-args.haml

@@ -0,0 +1,5 @@
+layout: cf-args
+--
+- content_for :sidebar do |i|
+  Hello,
+  %strong= "#{i}!"