hydeweb 0.1.1 → 0.1.2

data/HISTORY.md

@@ -1,3 +1,15 @@
+v0.1.2
+------
+
+ - Allow `hyde create .` to add a hyde.conf in the current folder.
+ - Revamp the help screen.
+ - Fix: change the default load path for Sass/SCSS to 'css'.
+ - Add Page#depth.
+ - Fix Page#breadcrumbs.
+ - Fix Page#parent.
+ - Add the `rel` helper.
+ - Generated Hyde projects are now Rack-compatible.
+
 v0.1.1
 ------
 
@@ -11,8 +23,13 @@ v0.1.1
 v0.1.0
 ------
 
- - Complete rewrite. Many thing have been deprecated.
- - Now uses Tilt and Shake.
+**Complete rewrite.** Many thing have been deprecated.
+
+ - Now uses Tilt (for templates), Shake (for CLI) and Cuba (for the server).
+ - Now supports everything Tilt supports: CoffeeScript, Liquid, etc.
+ - Allow `tilt_options` in hyde.conf.
+ - Old extensions will be broken (but who made any yet, anyway?)
+ - Update the `hyde create` template's gitignore file to account for _public.
 
 v0.0.8
 ------

data/data/new_site/README.md

@@ -1,18 +1,10 @@
-{sitename}
-==========
-
-This is my site.
-
-
 Instructions
 ------------
 
  1. Make sure Ruby (>= v1.8) is installed.
- 2. Install the hydeweb gem: `gem install hydeweb --pre -v "~> 0.1"`
+ 2. Install the hydeweb gem: `gem install hydeweb`
  3. Build the site HTML files by typing: `hyde build`
 
- You may also type `hyde start` to serve the files in a local web server.
-
- (If #2 fails, you may need to type `sudo gem install hydeweb` instead)
+(If #2 fails, you may need to type `sudo gem install hydeweb` instead)
 
 

data/data/new_site/_layouts/default.haml

@@ -2,9 +2,26 @@
 %html
   %head
     %title= page.title
+
+    %meta(charset='UTF-8')
+    -# Use the latest IE engine, or Chrome frame.
+    %meta(http-equiv='X-UA-Compatible' content='IE=edge,chrome=1')
+
+    -# Mobile viewport optimization. j.mp/bplateviewport
+    %meta(name='viewport' content='width=device-width, initial-scale=1.0')
+
+    -# Standard SEO meta
+    - if page.meta.keywords
+      %meta{:name => 'keywords', :content => page.meta.keywords}
+    - if page.meta.description
+      %meta{:name => 'description', :content => page.meta.description}
+
+    %link{:rel => 'stylesheet', :href => '/css/style.css'}
+
   %body
     #content
       != yield
+
     %div#footer
       %hr
       %p Generated by Hyde

data/data/new_site/config.ru

@@ -0,0 +1,8 @@
+# This file exists to make this project Rack-compatible.
+# You may delete it if you're not concerned about this.
+
+require 'hyde'
+require 'hyde/server'
+
+Hyde::Project.new File.dirname(__FILE__)
+run Hyde::Server

data/data/new_site/hyde.conf

@@ -15,6 +15,8 @@ partials_path:   _layouts
 ignore:
 - **/*~
 - README*
+- config.ru
+- **/.*
 - **/_*.scss
 
 # Optional options for layout engines
@@ -22,5 +24,5 @@ tilt_options:
   haml:
     :escape_html: true
   scss:
-    :load_paths: [ 'site/css' ]
+    :load_paths: [ 'css' ]
 

data/lib/hyde/cli/helpers.rb

@@ -1,6 +1,29 @@
 class Hyde
 class CLI
 module Helpers
+  def show_help_for(task)
+    name = params.first
+    task = task(name)
+    pass "No such command. Try: #{executable} help"  unless task
+
+    help = task.help
+    if help
+      help.each { |line| err line }
+      err
+    else
+      err "Usage: #{executable} #{task.usage || name}"
+      err "#{task.description}."  if task.description
+    end
+  end
+
+  def tasks_for(category)
+    tasks.select { |name, t| t.category == category }
+  end
+
+  def other_tasks
+    tasks.select { |name, t| t.category.nil? }
+  end
+
   def say_info(str)
     say_status '*', str, 30
   end
@@ -12,12 +35,20 @@ module Helpers
   end
 
   def no_project
-    "No project file here."
+    "Error: This is not a Hyde project.\n" +
+    "You may convert it into one by creating a config file:\n" +
+    "  $ #{executable} create .\n\n" +
+    "You may also create an empty project in a new directory:\n" +
+    "  $ #{executable} create NAME\n"
+  end
+
+  def project?
+    !! @hydefile
   end
 
   def project
     @project ||= begin
-      pass no_project unless @hydefile
+      pass no_project unless project?
       Dir.chdir File.dirname(@hydefile)
 
       begin

data/lib/hyde/cli.rb

@@ -7,10 +7,16 @@ class CLI < Shake
 
   task(:create) do
     wrong_usage  unless params.size == 1
-
     template = File.expand_path('../../../data/new_site', __FILE__)
     target   = params.first
 
+    if target == '.'
+      pass "This is already a Hyde project."  if @hydefile
+      FileUtils.cp_r File.join(template, 'hyde.conf'), target
+      say_status :create, 'hyde.conf'
+      pass
+    end
+
     pass "Error: target directory already exists."  if File.directory?(target)
 
     puts "Creating files in #{target}:"
@@ -36,6 +42,7 @@ class CLI < Shake
 
   task.description = "Starts a new Hyde project"
   task.usage = "create NAME"
+  task.category = :create
 
   task(:build) do
     pre = project.config.output_path
@@ -56,6 +63,7 @@ class CLI < Shake
   end
 
   task.description = "Builds the current project"
+  task.category = :project
 
   task(:start) do
     project
@@ -69,12 +77,58 @@ class CLI < Shake
   end
 
   task.description = "Starts the server"
+  task.category = :project
 
   task(:version) do
     puts "Hyde #{Hyde::VERSION}"
   end
 
   task.description = "Shows the current version"
+  task.category = :misc
+
+  task(:help) do
+    show_help_for(params.first) and pass  if params.any?
+
+    show_task = Proc.new { |name, t| err "  %-20s %s" % [ t.usage || name, t.description ] }
+
+    err "Usage: #{executable} <command>"
+
+    err "\nCommands:"
+    tasks_for(:create).each &show_task
+    err "\nProject commands:"
+    tasks_for(:project).each &show_task
+    if other_tasks.any?
+      err "\nOthers:"
+      other_tasks.each &show_task
+    end
+    err "\nMisc commands:"
+    tasks_for(:misc).each &show_task
+
+    unless project?
+      err
+      err "Get started by typing:"
+      err "  $ #{executable} create my_project"
+      err
+      err "Type `#{executable} help COMMAND` for additional help on a command."
+    end
+  end
+
+  task.description = "Shows help for a given command"
+  task.usage = "help [COMMAND]"
+  task.category = :misc
+
+  invalid do
+    task = task(command)
+    if task
+      err "Invalid usage."
+      err "Try: #{executable} #{task.usage}"
+      err
+      err "Type `#{executable} help` for more info."
+    else
+      err "Invalid command: #{command}"
+      err "Type `#{executable} help` for more info."
+    end
+  end
 
   def self.run!(options={})
     @hydefile = options[:file]

data/lib/hyde/config.rb

@@ -28,6 +28,8 @@ class Config < OpenStruct
     @tilt_options ||= begin
       o = @table[:tilt_options] || Hash.new
       o['haml'] ||= { :escape_html => true }
+      o['scss'] ||= { :load_path => ['css'] }
+      o['sass'] ||= { :load_path => ['css'] }
       o
     end
 

data/lib/hyde/helpers.rb

@@ -4,5 +4,11 @@ module Helpers
     partial = Partial[path.to_s, page]  or return ''
     partial.to_html :page => self
   end
+
+  def rel(path)
+    depth = page.depth
+    dotdot = depth > 1 ? ('../' * (page.depth-1)) : './'
+    (dotdot[0...-1] + path)
+  end
 end
 end

data/lib/hyde/page.rb

@@ -205,9 +205,15 @@ class Page
   end
 
   def parent
-    parts = path.split('/')
-    parent_path = index? ? parts[0...-2] : parts[0...-1]
-    self.class[parent_path.join('/'), project]
+    parts = path.split('/') # ['', 'about', 'index.html']
+
+    try = lambda { |newpath| p = self.class[newpath, project]; p if p && p.path != path }
+
+    # Absolute root
+    return nil  if index? and parts.size <= 2
+
+    parent   = try[parts[0...-1].join('/')]  # ['','about'] => '/about'
+    parent ||= try['/']                      # Home
   end
 
   def children
@@ -243,6 +249,10 @@ class Page
     parent.nil?
   end
 
+  def depth
+    breadcrumbs.size
+  end
+
 protected
   def default_layout
     'default'  if html?

data/lib/hyde/server.rb

@@ -32,10 +32,12 @@ class Hyde
       on default do
         begin
           page = Hyde::Page[env['PATH_INFO']]  or break not_found
-          res['Content-Type'] = page.mime_type
+          type = page.mime_type
+          res['Content-Type'] = type  if type
           res.write page.to_html
           show_status page
         rescue => e
+          res['Content-Type'] = 'text/html'
           res.write "<h1>#{e.class}: #{e.message}</h1><ul>#{e.backtrace.map{|l|"<li>#{l}</li>"}.join('')}</ul>"
         end
       end

data/lib/hyde.rb

@@ -9,7 +9,7 @@ require 'tilt'
 require 'shake'
 
 class Hyde
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
   PREFIX  = File.expand_path('../', __FILE__)
 
   Error        = Class.new(StandardError)

data/test/fixture/one/control/about/us.html

@@ -0,0 +1 @@
+<h1>hi</h1>

data/test/fixture/one/site/about/us.haml

@@ -0,0 +1,3 @@
+layout: false
+--
+%h1 hi

data/test/unit/page_test.rb

@@ -0,0 +1,27 @@
+require File.expand_path('../../helper', __FILE__)
+
+class PageTest < TestCase
+  setup do
+    @path = fixture('one')
+    @project = Project.new(@path)
+    Dir.chdir @path
+  end
+
+  test "root" do
+    @page = Page['/']
+    assert @page.index?
+    assert @page.root?
+  end
+
+  test "breadcrumbs" do
+    assert_equal %w(/index.html /about/index.css), Page['/about/index.css'].breadcrumbs.map(&:path)
+    assert_equal %w(/index.html /about/index.css /about/us.html), Page['/about/us.html'].breadcrumbs.map(&:path)
+    assert_equal %w(/index.html /css/style.css), Page['/css/style.css'].breadcrumbs.map(&:path)
+    assert_equal %w(/index.html), Page['/'].breadcrumbs.map(&:path)
+  end
+
+  test "parent" do
+    assert Page['/'].parent.nil?
+    assert Page['/css/style.css'].parent.path == '/index.html'
+  end
+end

metadata

@@ -2,7 +2,7 @@
 name: hydeweb
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors: 
 - Rico Sta. Cruz
@@ -106,6 +106,7 @@ files:
 - test/fixture/nested_layout/layouts/post.haml
 - test/fixture/nested_layout/site/index.haml
 - test/fixture/one/control/about/index.css
+- test/fixture/one/control/about/us.html
 - test/fixture/one/control/cheers.html
 - test/fixture/one/control/css/style.css
 - test/fixture/one/control/hello.html
@@ -115,6 +116,7 @@ files:
 - test/fixture/one/layouts/default.haml
 - test/fixture/one/partials/menu.haml
 - test/fixture/one/site/about/index.scss
+- test/fixture/one/site/about/us.haml
 - test/fixture/one/site/cheers.html.haml
 - test/fixture/one/site/css/style.scss
 - test/fixture/one/site/hello.haml
@@ -141,7 +143,9 @@ files:
 - test/unit/extensions_test.rb
 - test/unit/fixture_test.rb
 - test/unit/hyde_test.rb
+- test/unit/page_test.rb
 - data/new_site/_layouts/default.haml
+- data/new_site/config.ru
 - data/new_site/hyde.conf
 - data/new_site/index.haml
 - data/new_site/README.md