deris 0.1.4 → 0.1.5

data/README.markdown

@@ -0,0 +1,119 @@
+# Deris
+
+A documentation templating engine based on [HAML](http://haml-lang.com/)
+
+## Installation
+
+Whenever significant functionality is added to deris a new gem will be added to
+[rubygems](http://rubygems.org/gems/deris) so installation is easy:
+
+    gem install deris
+
+## Getting started
+
+Deris takes and transforms the contents of one directory and transforms and 
+writes it out to another directory. Your source directory should be laid out
+something like this:
+
+    myproject/
+      _src/
+        layout.haml
+
+`_src/layout.haml` is the only file deris expects to exist.
+
+Any files and directories within `myproject` that aren't within `_src` will be
+copied over to the output directory. This lets you have static content such as
+CSS files and images.
+
+To get deris to generate HTML from this directory you'll want to call it like 
+this:
+  
+    require 'rubygems'
+    require 'deris'
+    
+    Deris::Project.new('myproject/').write('myoutput/')
+
+Which will result in an output like this:
+
+    myoutput/
+      index.html
+
+This is because the contents of the `_src` directory are used to create the
+`index.html` for your site.
+
+If you want to take advantage of the templating capabilities you will want to
+create a `layout.haml` something like this:
+
+    -# myproject/_src/layout.haml
+    !!! 5
+    %html
+
+      %head
+        %title 
+          Deris example
+        
+      %body
+      
+        %h1 Deris example
+        
+        #content_wrapper
+                      
+          #content
+            =partial :content
+
+You will now want to create a `content.haml` to provide the markup for the 
+`:content` partial:
+
+    -# myproject/_src/content.haml
+    %h3 Home page
+    
+    %p
+      As this is in the _src directory it will be used to create index.html
+
+If you want to add another generated page to the site you need to create a new
+directory under the `_src`:
+
+    myproject/
+      _src/
+        morrisons/
+          content.haml
+        content.haml
+        layout.haml
+
+When the page is generated it will take the name of the directory, in this case
+that means the file will be called `morrisons.html`. Each directory can override
+the partials from its parent. This means that `morrisons.html` will be created
+by the combination of `_src/layout.haml` and `_src/morrisons/content.haml`. 
+
+You can nest directories within other directories as well:
+
+    myproject/
+      _src/
+        morrisons/
+          bread/
+            content.haml
+          content.haml
+        content.haml
+        layout.haml
+
+Which will result in an output like this:
+
+    myoutput/
+      morrisons/
+        bread.html   # _src/layout.haml + _src/morrisons/bread/content.haml
+      index.html     # _src/layout.haml + _src/content.haml
+      morrisons.html # _src/layout.haml + _src/morrisons/content.haml
+
+You can create URLs relative to the root of your generated content by using the 
+`url` helper in your HAML files:
+
+    %a{:href => url('morrisons/bread.html')} Bread
+
+This will look at the current "depth" of the file within your project and 
+prepend the correct quantity of `../` to your URL. 
+
+## Getting help
+
+You can get hold of me [on twitter](http://twitter.com/gshutler), [through a
+message on github](http://github.com/inbox/new/gshutler) or even via ye olde 
+email at garry@robustsoftware.co.uk

data/lib/file.rb

@@ -35,16 +35,14 @@ module Deris
       render(template)
     end
     
-    def url(*segments)
+    def url(path)
       sections = []
       @depth.times do
         sections << '..'
       end
-      segments.each do |segment|
-        sections << segment
-      end
+      sections << path
       
-      sections.join('/') + '.html'
+      sections.join('/')
     end
     
   end

data/lib/partial_hasher.rb

@@ -15,7 +15,13 @@ module Deris
         file_sym = ::File.basename(file, '.haml').to_sym
         partials[file_sym] = ::File.new(file).read      
       end
-      
+
+      # apply the convention where a partial with the same name as the file
+      # being output is set as the content partial unless it already exists
+      if !partials[:content] and partials[@file_name.to_sym]
+        partials[:content] = partials[@file_name.to_sym]
+      end
+            
       partials      
     end
     

data/tests/directory_specs/content_convention.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__), '..', 'spec_helper')
+
+describe Deris::Directory do
+
+  let(:examples) { File.join(File.dirname(__FILE__), '..', 'examples') }
+
+  context 'with content defined by convention' do
+  
+    let(:directory) { Deris::Directory.new(File.join(examples, 'contentconvention')) }
+    let(:partials) { directory.partials_hash }
+        
+    it 'should have the same value for :content as :contentconvention' do
+      partials[:content].should_not be_nil
+      partials[:content].should == partials[:contentconvention]
+    end
+
+  end
+  
+  context 'with content defined and a partial matching the convention' do
+    
+    let(:directory) { Deris::Directory.new(File.join(examples, 'contentconventionclash')) }
+    let(:partials) { directory.partials_hash }
+    
+    it 'should not overwrite the :content partial with the partial matching the convention' do
+      partials[:content].should_not == partials[:contentconventionclash]
+    end
+    
+  end
+
+end

data/tests/examples/contentconventionclash/content.haml

@@ -0,0 +1 @@
+Content!

data/tests/examples/contentconventionclash/contentconventionclash.haml

@@ -0,0 +1 @@
+Clash! Ahhh!

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

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

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

@@ -1,5 +1,5 @@
 %ul
   %li
-    %a{:href => url(:morrisons, :bread)} Bread  
+    %a{:href => url('morrisons/bread.html')} Bread  
   %li
-    %a{:href => url(:morrisons, :fish)} Fish  
+    %a{:href => url('morrisons/fish.html')} Fish  

data/tests/spec_tasks.rake

@@ -2,7 +2,21 @@ require 'rake'
 require 'rubygems'
 require 'rspec/core/rake_task'
 
+SPEC_PATTERN = File.join(File.dirname(__FILE__), '*_specs', '**', '*.rb')
+
 RSpec::Core::RakeTask.new do |spec|
-  spec.pattern = File.join(File.dirname(__FILE__), '*_specs', '**', '*.rb')
+  spec.pattern = SPEC_PATTERN
 end
 
+namespace :spec do
+  
+  task :doc do
+    cmd = ['spec']
+    cmd << '-f n'
+    cmd += FileList[SPEC_PATTERN].to_a
+    cmd = cmd.join(' ')
+    system cmd
+  end
+  
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: deris
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - Garry Shutler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-09 00:00:00 +01:00
+date: 2010-06-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -58,8 +58,8 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.markdown
 files: 
 - lib/deris.rb
 - lib/directory.rb
@@ -68,8 +68,13 @@ files:
 - lib/partial_hasher.rb
 - lib/project.rb
 - lib/subdirectory_list.rb
+- README.markdown
 - tests/project_specs/nested_files.rb
 - tests/spec_helper.rb
+- tests/directory_specs/content_convention.rb
+- tests/examples/contentconventionclash/contentconventionclash.haml
+- tests/examples/contentconventionclash/content.haml
+- tests/examples/contentconvention/contentconvention.haml
 - tests/examples/file/nested.haml
 - tests/examples/file/initial.haml
 - tests/examples/project/_src/menu.haml
@@ -118,6 +123,10 @@ summary: Simple documentation creation engine based on HAML
 test_files: 
 - tests/project_specs/nested_files.rb
 - tests/spec_helper.rb
+- tests/directory_specs/content_convention.rb
+- tests/examples/contentconventionclash/contentconventionclash.haml
+- tests/examples/contentconventionclash/content.haml
+- tests/examples/contentconvention/contentconvention.haml
 - tests/examples/file/nested.haml
 - tests/examples/file/initial.haml
 - tests/examples/project/_src/menu.haml