hydeweb 0.0.8.pre2 → 0.1.0

data/lib/hyde/sinatra/init.rb

@@ -1,64 +0,0 @@
-require 'rubygems'
-begin
-  require 'sinatra/base'
-rescue LoadError
-  STDERR << "You need the sinatra gem to use `hyde start`. Type: `gem install sinatra`\n"
-  exit
-end
-
-$:.unshift File.dirname(__FILE__) + "/../.."
-require 'hyde'
-
-$project = Hyde::Project.new
-
-class Main < Sinatra::Base
-  @@project ||= $project
-
-  def self.show_start
-    port = $project.config.port
-
-    puts "Starting server..."
-    puts "  http://127.0.0.1:#{port}      Homepage"
-    puts "  http://127.0.0.1:#{port}/-    File list"
-    puts ""
-  end
-
-  get '/-' do
-    @@project.files.inject("") do |a, path|
-      a << "<li><a href='#{path}'>#{path}</a></li>"
-      a
-    end
-  end
-
-  get '/*' do
-    begin
-      path = params[:splat][0]
-      type = File.extname(path)[1..-1]
-      content_type type.to_sym  if type.is_a? String
-
-      page = @@project[path]
-
-      # 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}` line #{e.line} error"
-      puts " *** #{e.message}".gsub("\n","\n *** ")
-      e.message
-
-    rescue Hyde::NotFound
-      raise Sinatra::NotFound
-    end
-  end
-
-  not_found do
-    html_path = File.join(File.dirname(__FILE__), %w[.. .. .. data pages 404.html])
-    File.open(html_path) { |f| f.read } + (" "*4096)
-  end
-end
-
-Main.show_start
-Main.run! :port => $project.config.port

data/lib/hyde/utils.rb

@@ -1,43 +0,0 @@
-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
-
-    def matches_files?(needle, haystack)
-      haystack.inject(false) do |a, match|
-        a ||= same_file?(needle, match)
-      end
-    end
-
-    def force_file_open(filepath, &blk)
-      require 'fileutils'
-      FileUtils.mkdir_p File.dirname(filepath)
-
-      if block_given?
-        File.open filepath, 'w', &blk
-      else
-        File.new filepath, 'w'
-      end
-    end
-
-    # Returns all helper classes under the Hyde::Helpers module.
-    def get_helpers
-      Hyde::Helpers.constants.inject([Hyde::Helpers]) do |a, constant|
-        mod = Hyde::Helpers.const_get(constant)
-        a << mod  if mod.is_a? Module
-        a
-      end
-    end
-  end
-end

data/lib/hyde_misc/console.rb

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

data/manual/Extending/ExtendingHyde.md

@@ -1,118 +0,0 @@
-Extending Hyde
-==============
-
-Creating extensions
--------------------
-
-In your Hyde project's extensions folder (`extensions` by default), create a file called
-`<name>/<name>.rb`, where `<name>` is the name of your extension. This file will automatically loaded.
-
-Example:
-
-    # extensions/hyde-blog/hyde-blog.rb
-    module Hyde
-      # Set up autoload hooks for the other classes
-      prefix = File.dirname(__FILE__)
-      autoload :Blog,   "#{prefix}/lib/blog.rb"
-    end
-
-Creating extensions as gems
----------------------------
-
-You may also create your extensions as gems. It is recommended to name them as `hyde-(name)`,
-for instance, `hyde-blog`.
-
-To load gem extensions in your Hyde project, add them to the `gems` section of your project's 
-config file (typically `hyde.conf`). Example:
-
-    # hyde.conf
-    gems:
-     - hyde-blog
-     - hyde-clean
-
-Adding helpers
---------------
-
-Make a module under `Hyde::Helpers`. Any functions here will be available to your files.
-
-Example:
-
-In this example, we'll create a simple helper function.
-
-    # extensions/hyde-blog/hyde-blog.rb
-    module Hyde
-      module Helpers
-        module FormHelpers
-          def form_tag(meth, action, &b)
-            [ "<form method='#{meth}' action='#{action}'>",
-              b.call,
-              "</form>"
-            ].join("\n")
-          end
-        end
-      end
-    end
-
-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
-      %p
-        %label Your name:
-        %input{ :type => 'text', :name => 'name' }
-      %p
-        %label Your email:
-        %input{ :type => 'text', :name => 'email' }
-
-Adding commands
----------------
-
-Create a subclass of the class {Hyde::CLICommand} and place it under the {Hyde::CLICommands} module.
-The name of the class will be the command it will be accessible as.
-
-This example below defines a new `clean` command, which will be accessible by typing `hyde clean`.
-It will also show under `hyde --help` since it provides a `desc`.
-
-    # extensions/hyde-clean/hyde-clean.rb
-    module Hyde
-      module CLICommands
-        class Clean < CLICommand
-          desc "Cleans up your project's dirt"
-
-          def self.run(*a)
-            if a.size > 0
-              log "Unknown arguments: #{a.join(' ')}"
-              log "Type `hyde --help clean` for more information."
-              exit
-            end
-
-            log "Cleaning..."
-            # Do stuff here
-            log "All clean!"
-          end
-        end
-      end
-    end
-
-This may now be used in the command line.
-
-    $ hyde clean all
-    Unknown arguments: all
-    Type `hyde --help clean` for more information.
-
-    $ hyde clean
-    Cleaning...
-    All done!
-
-    $ hyde --help
-    Usage: hyde <command> arguments
-
-    Commands:
-       ....
-       clean            Cleans up your project's dirt
-
-Adding parsers
---------------
-
-TODO.

data/manual/Hyde.md

@@ -1,63 +0,0 @@
-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}
-
-Tips and tricks
----------------
-
-- `+++-` {file:Tips Tips}
-
-Basic info
-----------
-
-- {file:AUTHORS Credits}
-- {file:LICENSE License}
-

data/manual/Introduction/Configuration.md

@@ -1,70 +0,0 @@
-Configuration
-=============
-
-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

@@ -1,64 +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
---------
-
-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:4833` 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: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:4833/assets/my_style.css`.
-
-Dynamic files
--------------
-
-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
--------------------
-
-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/manual/Introduction/Installation.md

@@ -1,16 +0,0 @@
-Installation
-============
-
-First, make sure that you have Ruby (>= version 1.8) installed. You can do this
-by typing `ruby --version` in the command line.
-
- - For Mac users, there's no need to do anything. Ruby comes with the OS by default.
- - For Windows users, I don't know.
- - For Ubuntu users, `sudo apt-get install ruby`.
-
-Install Hyde by typing:
-
-    gem install hydeweb
-
-If this process fails, you can instead try `sudo gem install hydeweb`.
-

data/manual/Introduction/Layouts.md

@@ -1,14 +0,0 @@
-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,94 +0,0 @@
-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

@@ -1,73 +0,0 @@
-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.' } %>
-
-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

@@ -1,59 +0,0 @@
-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.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.haml`.
-
-...
-
-Headers
--------
-
-...
-
-Layouts
--------
-
-Layouts are supported for HAML, Markdown, Textile and ERB 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