deris 0.1.3 → 0.1.4

data/lib/deris.rb

@@ -1 +1,8 @@
-Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), '*.rb')).each {|f| require f }
+require 'rubygems'
+require 'fileutils'
+require 'haml'
+
+# load the files in dependency order to avoid loads of require statements in each file
+['subdirectory_list', 'partial_hasher', 'file', 'directory_writer', 'directory', 'project'].each do |f|
+  require File.join(File.expand_path(File.dirname(__FILE__)), "#{f}.rb")
+end

data/lib/directory.rb

@@ -1,28 +1,23 @@
-require 'rubygems'
-require 'fileutils'
-require ::File.join(::File.dirname(__FILE__), 'partial_hasher')
-require ::File.join(::File.dirname(__FILE__), 'directory_writer')
-require ::File.join(::File.dirname(__FILE__), 'subdirectory_list')
-
-module Deris
-    
-  class Directory
-    include PartialHasher
-    include DirectoryWriter
-    include SubdirectoryList
-    
-    attr_reader :file_name, :partials, :directory
-      
-    def initialize(directory, defaults = {})
-      @directory = directory
-      @file_name = ::File.basename(directory)
-      @partials = defaults.merge(partials_hash)
-    end
-        
-    def sub_output(output)
-      ::File.join(output, @file_name)
-    end
-  
-  end
-  
-end
+module Deris
+    
+  class Directory
+    include PartialHasher
+    include DirectoryWriter
+    include SubdirectoryList
+    
+    attr_reader :file_name, :partials, :directory
+      
+    def initialize(directory, defaults = {}, depth = 0)
+      @directory = directory
+      @file_name = ::File.basename(directory)
+      @partials = defaults.merge(partials_hash)
+      @depth = depth
+    end
+        
+    def sub_output(output)
+      return ::File.join(output, @file_name), @depth + 1
+    end
+  
+  end
+  
+end

data/lib/directory_writer.rb

@@ -1,33 +1,32 @@
-require 'rubygems'
-require 'fileutils'
-require ::File.join(::File.dirname(__FILE__), 'file')
-
-module Deris
-  
-  module DirectoryWriter
-    
-    def write(output)
-      unless respond_to?(:sub_directories) and respond_to?(:partials) and respond_to?(:sub_output)
-        raise 'need to respond to "sub directories", "partials" and "sub_output" to write'
-      end
-      
-      # write out the content from this directory
-      write_file output
-
-      # write out the sub directories
-      sub_directories.each do |dir|        
-        Directory.new(dir, partials).write(sub_output(output))
-      end
-    end
-    
-    def write_file(output)
-      unless respond_to?(:file_name) and respond_to?(:partials)
-        raise 'need to respond to "file_name" and "partials" to use write_file' 
-      end
-      
-      File.new(file_name, partials).write output
-    end
-    
-  end
-  
-end
+module Deris
+  
+  module DirectoryWriter
+    
+    def write(output)
+      unless respond_to?(:sub_directories) and respond_to?(:partials) and respond_to?(:sub_output)
+        raise 'need to respond to "sub directories", "partials" and "sub_output" to write'
+      end
+      
+      # write out the content from this directory
+      write_file output
+
+      # write out the sub directories
+      sub_directories.each do |dir|
+        sub_output_dir, sub_depth = sub_output(output)
+        Directory.new(dir, partials, sub_depth).write(sub_output_dir)
+      end
+      
+      true # don't return anything the client could work with
+    end
+    
+    def write_file(output)
+      unless respond_to?(:file_name) and respond_to?(:partials)
+        raise 'need to respond to "file_name" and "partials" to use write_file' 
+      end
+      
+      File.new(file_name, partials, @depth).write(output)
+    end
+    
+  end
+  
+end

data/lib/file.rb

@@ -1,43 +1,52 @@
-require 'rubygems'
-require 'fileutils'
-require 'haml'
-
-module Deris
-
-  class File
-    
-    attr_reader :name
-    
-    def initialize(name = 'index', partials = {})
-      @name = name
-      @partials = partials
-    end
-    
-    def write(directory)
-      FileUtils.mkdir(directory) unless ::File.exist? directory
-      output_path = ::File.join(directory, "#{@name}.html")
-      ::File.open(output_path, 'w+') do |file|
-        file.write render
-      end
-    end
-    
-    def render(template = nil)
-      if template.nil?
-        template = @partials[:layout]
-      else
-        template = ::File.new(template).read if ::File.exist?(template)
-      end
-      haml_engine = Haml::Engine.new(template)
-      haml_engine.render(self)
-    end
-    
-    def partial(template)
-      if template.is_a? Symbol
-        template = @partials[template] || ''
-      end
-      render(template)
-    end
-    
-  end
-
-end
+module Deris
+
+  class File
+    
+    attr_reader :name
+    
+    def initialize(name = 'index', partials = {}, depth = nil)
+      @name = name
+      @partials = partials
+      @depth = depth || 0
+    end
+    
+    def write(directory)
+      FileUtils.mkdir(directory) unless ::File.exist? directory
+      output_path = ::File.join(directory, "#{@name}.html")
+      ::File.open(output_path, 'w+') do |file|
+        file.write render
+      end
+    end
+    
+    def render(template = nil)
+      if template.nil?
+        template = @partials[:layout]
+      else
+        template = ::File.new(template).read if ::File.exist?(template)
+      end
+      haml_engine = Haml::Engine.new(template)
+      haml_engine.render(self)
+    end
+    
+    def partial(template)
+      if template.is_a? Symbol
+        template = @partials[template] || ''
+      end
+      render(template)
+    end
+    
+    def url(*segments)
+      sections = []
+      @depth.times do
+        sections << '..'
+      end
+      segments.each do |segment|
+        sections << segment
+      end
+      
+      sections.join('/') + '.html'
+    end
+    
+  end
+
+end

data/lib/partial_hasher.rb

@@ -1,27 +1,24 @@
-require 'rubygems'
-require 'fileutils'
-
-module Deris
-
-  module PartialHasher
-    
-    def partials_hash
-      unless respond_to?(:directory)
-        raise 'need to response to  "directory" to create a hash of partials' 
-      end
-      
-      partials = {}
-      partial_file_mask = ::File.join(directory, '*.haml')
-      partial_files = ::Dir.glob(partial_file_mask)
-      
-      partial_files.each do |file|
-        file_sym = ::File.basename(file, '.haml').to_sym
-        partials[file_sym] = ::File.new(file).read      
-      end
-      
-      partials      
-    end
-    
-  end
-  
-end
+module Deris
+
+  module PartialHasher
+    
+    def partials_hash
+      unless respond_to?(:directory)
+        raise 'need to response to  "directory" to create a hash of partials' 
+      end
+      
+      partials = {}
+      partial_file_mask = ::File.join(directory, '*.haml')
+      partial_files = ::Dir.glob(partial_file_mask)
+      
+      partial_files.each do |file|
+        file_sym = ::File.basename(file, '.haml').to_sym
+        partials[file_sym] = ::File.new(file).read      
+      end
+      
+      partials      
+    end
+    
+  end
+  
+end

data/lib/project.rb

@@ -1,46 +1,39 @@
-require 'rubygems'
-require 'fileutils'
-require ::File.join(::File.dirname(__FILE__), 'directory')
-require ::File.join(::File.dirname(__FILE__), 'partial_hasher')
-require ::File.join(::File.dirname(__FILE__), 'directory_writer')
-require ::File.join(::File.dirname(__FILE__), 'subdirectory_list')
-
-module Deris
-
-  class Project
-    include PartialHasher
-    include DirectoryWriter
-    include SubdirectoryList
-    
-    attr_reader :file_name, :partials, :directory
-  
-    def initialize(source, defaults = {})
-      @source = source
-      @file_name = 'index'
-      @directory = ::File.join(@source, '_src')
-      @partials = defaults.merge(partials_hash)
-    end
-    
-    def write(output)
-      # adds additional behaviour on top of the DirectoryWriter mixin
-      
-      # recreate the output directory
-      FileUtils.rm_rf(output) if ::File.exists?(output)
-      FileUtils.mkdir(output)
-      
-      # find and copy all static content
-      static_content_mask = ::File.join(@source, "**")
-      static_content = Dir[static_content_mask].reject{|path| path =~ /_src$/}      
-      static_content.each{|path| FileUtils.cp_r(path, output)}
-      
-      # call the DirectoryWriter mixin
-      super
-    end
-    
-    def sub_output(output)
-      output
-    end
-        
-  end
-
-end
+module Deris
+
+  class Project
+    include PartialHasher
+    include DirectoryWriter
+    include SubdirectoryList
+    
+    attr_reader :file_name, :partials, :directory
+  
+    def initialize(source, defaults = {})
+      @source = source
+      @file_name = 'index'
+      @directory = ::File.join(@source, '_src')
+      @partials = defaults.merge(partials_hash)
+    end
+    
+    def write(output)
+      # adds additional behaviour on top of the DirectoryWriter mixin
+      
+      # recreate the output directory
+      FileUtils.rm_rf(output) if ::File.exists?(output)
+      FileUtils.mkdir(output)
+      
+      # find and copy all static content
+      static_content_mask = ::File.join(@source, "**")
+      static_content = Dir[static_content_mask].reject{|path| path =~ /_src$/}      
+      static_content.each{|path| FileUtils.cp_r(path, output)}
+      
+      # call the DirectoryWriter mixin
+      super
+    end
+    
+    def sub_output(output)
+      return output, 0 # zero default depth
+    end
+        
+  end
+
+end

data/lib/subdirectory_list.rb

@@ -1,21 +1,18 @@
-require 'rubygems'
-require 'fileutils'
-
-module Deris
-  
-  module SubdirectoryList
-  
-    def sub_directories
-      unless respond_to?(:directory)
-        raise 'need to respond to  "directory" to list sub directories'
-      end
-      
-      sub_directory_mask = ::File.join(directory, '*')
-      ::Dir[sub_directory_mask].find_all do |dir|
-        ::File.directory?(dir)
-      end
-    end
-    
-  end
-
-end
+module Deris
+  
+  module SubdirectoryList
+  
+    def sub_directories
+      unless respond_to?(:directory)
+        raise 'need to respond to  "directory" to list sub directories'
+      end
+      
+      sub_directory_mask = ::File.join(directory, '*')
+      ::Dir[sub_directory_mask].find_all do |dir|
+        ::File.directory?(dir)
+      end
+    end
+    
+  end
+
+end

data/tests/examples/file/initial.haml

@@ -1,23 +1,23 @@
-%html
-
-  %head
-    %title 
-      Documentation
-    
-  %body
-  
-    #menu
-      =partial :menu
-      
-    :markdown
-          void test()
-          {
-              return 'some code';
-          }
-  
-    #content
-      =partial 'examples/file/nested.haml'
-      
-    #subnav
-      =partial :subnav
-  
+%html
+
+  %head
+    %title 
+      Documentation
+    
+  %body
+  
+    #menu
+      =partial :menu
+      
+    :markdown
+          void test()
+          {
+              return 'some code';
+          }
+  
+    #content
+      =partial 'examples/file/nested.haml'
+      
+    #subnav
+      =partial :subnav
+  

data/tests/examples/file/nested.haml

@@ -1,2 +1,2 @@
-.nested
-  woot! nested content
+.nested
+  woot! nested content

data/tests/examples/project/_src/content.haml

@@ -1,2 +1,2 @@
-%p
-  This is the home page
+%p
+  This is the home page

data/tests/examples/project/_src/layout.haml

@@ -1,21 +1,21 @@
-!!! 5
-%html
-
-  %head
-    %title 
-      Deris example
-    
-  %body{:class => name}
-  
-    %h1 Deris example
-    
-    #content_wrapper
-    
-      #menu
-        =partial :menu
-          
-      #content
-        =partial :content
-              
-      #subnav
+!!! 5
+%html
+
+  %head
+    %title 
+      Deris example
+    
+  %body{:class => name}
+  
+    %h1 Deris example
+    
+    #content_wrapper
+    
+      #menu
+        =partial :menu
+          
+      #content
+        =partial :content
+              
+      #subnav
         =partial :subnav

data/tests/examples/project/_src/menu.haml

@@ -1,6 +1,5 @@
-%ul
-  %li 
-    %a{:href => 'index.html'} Home
-  %li 
-    %a{:href => 'morrisons.html'} Morrisons
-  %li Third
+%ul
+  %li 
+    %a{:href => url(:index)} Home
+  %li 
+    %a{:href => url(:morrisons)} Morrisons

data/tests/examples/project/_src/morrisons/bread/content.haml

@@ -1,2 +1,2 @@
-%p
-  Freshly baked in store, every day
+%p
+  Freshly baked in store, every day

data/tests/examples/project/_src/morrisons/content.haml

@@ -1,5 +1,5 @@
-%p
-  I enjoy locally sourced produce, particularly fish
-  
-%p
-  Advertised by Richard Hammond
+%p
+  I enjoy locally sourced produce, particularly fish
+  
+%p
+  Advertised by Richard Hammond

data/tests/examples/project/_src/morrisons/fish/content.haml

@@ -0,0 +1,2 @@
+%p
+  Caught locally by fishermen

data/tests/examples/project/_src/morrisons/subnav.haml

@@ -1,5 +1,5 @@
-%h3 Morrisons
-
-%ul
-  %li Sub one
-  %li Sub two
+%ul
+  %li
+    %a{:href => url(:morrisons, :bread)} Bread  
+  %li
+    %a{:href => url(:morrisons, :fish)} Fish  

data/tests/examples/project/_src/subnav.haml

@@ -1,3 +1 @@
-%ul
-  %li Sub one
-  %li Sub two
+Empty

data/tests/project_specs/nested_files.rb

@@ -1,33 +1,41 @@
-require 'spec'
-require File.join(File.dirname(__FILE__), '..', '..', 'lib', 'project')
-
-describe Deris::Project do
-  
-  let(:examples) { File.join(File.dirname(__FILE__), '..', 'examples') }
-  let(:output) { File.join(File.dirname(__FILE__), '..', '..', 'output') }
-
-  context 'with nested templates' do
-    
-    let(:project) { Deris::Project.new(File.join(examples, 'project')) }
-    let(:morrisons_directory) { File.join(output, 'morrisons') }
-    let(:bread_file) { File.join(morrisons_directory, 'bread.html') }
-    
-    before do
-      project.write(output)
-    end
-
-    it 'should create the morrisons directory' do
-      File.exist?(morrisons_directory).should be_true
-    end
-    
-    it 'should create a file called "bread.html" in the morrisons directory' do
-      File.exist?(bread_file).should be_true
-    end
-    
-    it 'should have the phrase "Freshly baked in store, every day" in "bread.html"' do
-      File.read(bread_file).should =~ /Freshly baked in store, every day/
-    end
-  
-  end  
-  
-end
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Deris::Project do
+
+  let(:output) { File.join(File.dirname(__FILE__), '..', '..', 'output') }
+  let(:examples) { File.join(File.dirname(__FILE__), '..', 'examples') }
+
+  context 'with nested templates' do
+    
+    let(:project) { Deris::Project.new(File.join(examples, 'project')) }
+    let(:morrisons_directory) { File.join(output, 'morrisons') }
+    let(:morrisons_file) { File.join(output, 'morrisons.html') }
+    let(:bread_file) { File.join(morrisons_directory, 'bread.html') }
+    
+    before do
+      project.write(output)
+    end
+
+    it 'should create the morrisons directory' do
+      File.exist?(morrisons_directory).should be_true
+    end
+    
+    it 'should create a file called "bread.html" in the morrisons directory' do
+      File.exist?(bread_file).should be_true
+    end
+    
+    it 'should have the phrase "Freshly baked in store, every day" in "bread.html"' do
+      File.read(bread_file).should =~ /Freshly baked in store, every day/
+    end
+    
+    it 'should have a relative link to "index.html" in "morrisons.html"' do
+      File.read(morrisons_file).should include("href='index.html'")
+    end
+    
+    it 'should have a relative link to "index.html" in "bread.html"' do
+      File.read(bread_file).should include("href='../index.html'")
+    end
+  
+  end  
+  
+end

data/tests/spec_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'rspec'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'deris')

data/tests/spec_tasks.rake

@@ -0,0 +1,8 @@
+require 'rake'
+require 'rubygems'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = File.join(File.dirname(__FILE__), '*_specs', '**', '*.rb')
+end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deris
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 1
-  - 3
-  version: 0.1.3
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Garry Shutler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-08 00:00:00 +01:00
+date: 2010-06-09 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,13 +42,15 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 62196465
         segments: 
-        - 1
-        - 3
+        - 2
         - 0
-        version: 1.3.0
-  type: :runtime
+        - 0
+        - beta
+        - 9
+        version: 2.0.0.beta.9
+  type: :development
   version_requirements: *id002
 description: Simple documentation creation engine based on HAML
 email: garry@robustsoftware.co.uk
@@ -66,17 +68,19 @@ files:
 - lib/partial_hasher.rb
 - lib/project.rb
 - lib/subdirectory_list.rb
-- tests/build_project.rb
-- tests/examples/file/initial.haml
+- tests/project_specs/nested_files.rb
+- tests/spec_helper.rb
 - tests/examples/file/nested.haml
-- tests/examples/project/_src/content.haml
-- tests/examples/project/_src/layout.haml
+- tests/examples/file/initial.haml
 - tests/examples/project/_src/menu.haml
+- tests/examples/project/_src/layout.haml
+- tests/examples/project/_src/morrisons/subnav.haml
+- tests/examples/project/_src/morrisons/fish/content.haml
 - tests/examples/project/_src/morrisons/bread/content.haml
 - tests/examples/project/_src/morrisons/content.haml
-- tests/examples/project/_src/morrisons/subnav.haml
 - tests/examples/project/_src/subnav.haml
-- tests/project_specs/nested_files.rb
+- tests/examples/project/_src/content.haml
+- tests/spec_tasks.rake
 has_rdoc: true
 homepage: http://github.com/gshutler/deris
 licenses: []
@@ -112,14 +116,16 @@ signing_key:
 specification_version: 3
 summary: Simple documentation creation engine based on HAML
 test_files: 
-- tests/build_project.rb
-- tests/examples/file/initial.haml
+- tests/project_specs/nested_files.rb
+- tests/spec_helper.rb
 - tests/examples/file/nested.haml
-- tests/examples/project/_src/content.haml
-- tests/examples/project/_src/layout.haml
+- tests/examples/file/initial.haml
 - tests/examples/project/_src/menu.haml
+- tests/examples/project/_src/layout.haml
+- tests/examples/project/_src/morrisons/subnav.haml
+- tests/examples/project/_src/morrisons/fish/content.haml
 - tests/examples/project/_src/morrisons/bread/content.haml
 - tests/examples/project/_src/morrisons/content.haml
-- tests/examples/project/_src/morrisons/subnav.haml
 - tests/examples/project/_src/subnav.haml
-- tests/project_specs/nested_files.rb
+- tests/examples/project/_src/content.haml
+- tests/spec_tasks.rake

data/tests/build_project.rb

@@ -1,16 +0,0 @@
-#!/usr/bin/env ruby
-
-# work out base paths
-current_dir = File.dirname(__FILE__)
-root_dir = File.join(current_dir, '..')
-
-# require the project class
-require File.join(root_dir, 'lib', 'project')
-
-# work out paths for test
-project_path = File.join(current_dir, 'examples', 'project')
-output_path = File.join(root_dir, 'output')
-
-# create and write out project
-project = Deris::Project.new project_path
-project.write output_path