deris 0.1.2 → 0.1.3

data/lib/deris.rb

@@ -1,2 +1 @@
-Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), 'file.rb')).each {|f| require f }
-Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), 'project.rb')).each {|f| require f }
+Dir.glob(File.join(File.expand_path(File.dirname(__FILE__)), '*.rb')).each {|f| require f }

data/lib/directory.rb

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

data/lib/directory_writer.rb

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

data/lib/file.rb

@@ -14,6 +14,7 @@ module Deris
     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

data/lib/partial_hasher.rb

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

data/lib/project.rb

@@ -1,18 +1,29 @@
 require 'rubygems'
 require 'fileutils'
-require ::File.join(::File.dirname(__FILE__), 'file')
+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)
+    def initialize(source, defaults = {})
       @source = source
-      @source_directory = ::File.join(@source, '_src')
-      @defaults = partials_from @source_directory
+      @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)
@@ -22,40 +33,14 @@ module Deris
       static_content = Dir[static_content_mask].reject{|path| path =~ /_src$/}      
       static_content.each{|path| FileUtils.cp_r(path, output)}
       
-      # generate the index page from defaults
-      File.new('index', @defaults).write output
-
-      # generate the other pages of the site from sub-directories
-      source_directories.each do |dir|
-        partials = partials_from dir
-        partials = @defaults.merge(partials)        
-        file_name = ::File.basename(dir)
-        File.new(file_name, partials).write output
-      end
+      # call the DirectoryWriter mixin
+      super
     end
     
-    private
-    
-    def source_directories
-      source_directory_mask = ::File.join(@source_directory, '*')
-      ::Dir[source_directory_mask].find_all do |dir|
-        ::File.directory?(dir)
-      end      
+    def sub_output(output)
+      output
     end
-  
-    def partials_from(directory)
-      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/subdirectory_list.rb

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

data/tests/build_project.rb

@@ -0,0 +1,16 @@
+#!/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

data/tests/examples/file/initial.haml

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

data/tests/examples/file/nested.haml

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

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

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

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

@@ -0,0 +1,21 @@
+!!! 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

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

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

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

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

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

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

@@ -0,0 +1,5 @@
+%h3 Morrisons
+
+%ul
+  %li Sub one
+  %li Sub two

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

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

data/tests/project_specs/nested_files.rb

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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deris
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Garry Shutler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-07 00:00:00 +01:00
+date: 2010-06-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,6 +34,22 @@ dependencies:
         version: 2.2.0
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :runtime
+  version_requirements: *id002
 description: Simple documentation creation engine based on HAML
 email: garry@robustsoftware.co.uk
 executables: []
@@ -44,8 +60,23 @@ extra_rdoc_files: []
 
 files: 
 - lib/deris.rb
+- lib/directory.rb
+- lib/directory_writer.rb
 - lib/file.rb
+- lib/partial_hasher.rb
 - lib/project.rb
+- lib/subdirectory_list.rb
+- tests/build_project.rb
+- tests/examples/file/initial.haml
+- tests/examples/file/nested.haml
+- tests/examples/project/_src/content.haml
+- tests/examples/project/_src/layout.haml
+- tests/examples/project/_src/menu.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
 has_rdoc: true
 homepage: http://github.com/gshutler/deris
 licenses: []
@@ -80,5 +111,15 @@ rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Simple documentation creation engine based on HAML
-test_files: []
-
+test_files: 
+- tests/build_project.rb
+- tests/examples/file/initial.haml
+- tests/examples/file/nested.haml
+- tests/examples/project/_src/content.haml
+- tests/examples/project/_src/layout.haml
+- tests/examples/project/_src/menu.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