genit 0.2 → 0.3

data/NEWS

@@ -1,3 +1,8 @@
+v0.3  2001-07-23
+
+  * You can split a page in a multitude of fragments.
+
+
 v0.2  2011-07-02
 
   * Globally styling your site

data/README.markdown

@@ -2,7 +2,9 @@ Genit
 ================
 
 Genit builds a **static web site**, that is a web site without server side programing language
-and database. A site consists only of xhtml code (+ css and medias) and eventually of javascript.
+and database. A genit site consists only of xhtml code (+ css, medias and eventually javascript).
+
+There is no needs to know the Ruby language.
 
 The project is in early development stage, see
 [project guidelines](https://github.com/lkdjiin/genit/blob/master/project_guidelines.markdown).
@@ -37,6 +39,7 @@ First install ruby and rubygem (if there are not installed on your system) then:
 
     gem install genit
 
+All other dependencies will be downloaded and installed automatically.
 
 Usage
 --------------------------

data/TODO

@@ -1,20 +1,26 @@
-v0.2
-====
+release v0.3
 
-release
 
 
-web site for genit
+smoke test
 
-announce
+mettre un fichier caché pour savoir qu'on a affaire à un projet Genit.
+
+option --version et --help (utiliser un framework cli)
+
+commencer documentation
+
+release v0.4
 
-news
 
-release
 
-------------------
-i18n
 
-per page style
+web site for genit
+
+announce site (freshmeat et blog)
+
+news
+
+release v0.5
 
-per page script
+Trouver / penser à / un framework de test xhtml/css

data/VERSION

@@ -1 +1 @@
-0.2
+0.3

data/lib/genit.rb

@@ -1,13 +1,15 @@
 # -*- encoding: utf-8 -*-
 
+require 'genit/extensions'
 require 'genit/project_creator'
-
 require 'genit/html_document'
 require 'genit/xml_document'
+require 'genit/file_writer'
 require 'genit/document_writer'
 require 'genit/compiler'
 require 'genit/page_compiler'
 require 'genit/builder'
+require 'genit/fragment'
 
 module Genit
 end

data/lib/genit/compiler.rb

@@ -32,13 +32,13 @@ module Genit
     
     def compile_page
       pc = PageCompiler.new @working_dir, @filename
-      @template = pc.compile
+      @page = pc.compile
       save_file_as_html
     end
     
     def save_file_as_html
       doc_writer = DocumentWriter.new @working_dir
-      doc_writer.save_as_html @template, @filename
+      doc_writer.save_as_html @page, @filename
     end
     
   end

data/lib/genit/document_writer.rb

@@ -19,10 +19,13 @@ module Genit
     # document - A Nokogiri::HTML or Nokogiri::XML document
     # filename - The String name of the future saved document
     def save_as_html document, filename
-      filename.gsub! /\.markdown$/, '.html'
-      File.open(File.join(@working_dir, 'www', filename), "w") do |out| 
-        out.puts document.to_html
-      end
+      FileWriter.write document.to_html, get_full_path(filename.force_html_extension)
+    end
+    
+    private
+    
+    def get_full_path filename
+      File.join(@working_dir, 'www', filename)
     end
     
   end

data/lib/genit/extensions.rb

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+class String
+
+  def force_html_extension
+    self.gsub /markdown$/, 'html'
+  end
+  
+  def force_html_extension!
+    self.gsub! /markdown$/, 'html'
+  end
+  
+  def markdown_ext?
+    self.end_with?('.markdown')
+  end
+  
+end

data/lib/genit/file_writer.rb

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+
+require 'fileutils'
+
+module Genit
+
+  # Write a file on disk.
+  class FileWriter
+    
+    def self.write content, full_path
+      File.open(full_path, "w") {|out| out.puts content }
+    end
+    
+  end
+  
+end

data/lib/genit/fragment.rb

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+
+module Genit
+
+  # Replace each fragment in a page.
+  class Fragment
+  
+    # Public: Constructor.
+    #
+    # file        - Full String filename of the page.
+    # working_dir - The String working directory, where live the project.
+    def initialize file, working_dir
+      @page = HtmlDocument.open_fragment file
+      @working_dir = working_dir
+      HtmlDocument.genit_tags_from(@page).each do |tag|
+        case tag['class']
+          when 'fragment'
+            @file = tag['file']
+            replace_fragment 
+        end
+      end
+    end
+    
+    # Public: Get the page in html format.
+    #
+    # Returns the html code of the page as a String.
+    def to_html
+      @page.to_html
+    end
+    
+    private
+    
+    def replace_fragment
+      builder = Builder.new(@page)
+      @page = builder.replace(css_rule, content)
+    end
+    
+    def css_rule
+      "genit.fragment[file='#{@file}']"
+    end
+    
+    def content
+      full_path = File.join(@working_dir, 'fragments', @file)
+      HtmlDocument.open_as_string(full_path)
+    end
+    
+  end
+  
+end

data/lib/genit/html_document.rb

@@ -8,7 +8,9 @@ module Genit
   # Open an html file in various format.
   class HtmlDocument
   
-    # Public: Open a html document.
+    # Public: Open an entire html document.
+    # If the file does not contain a <bogy> tag, a doctype, etc, they will be
+    # automatically added.
     #
     # file - Full path String filename.
     #
@@ -17,20 +19,48 @@ module Genit
       Nokogiri::HTML(File.open(file))
     end
     
-    # Public: Open a html or markdown file as a string.
+    # Public: Open a fragment of html document.
+    #
+    # file - Full path String filename.
+    #
+    # Returns a Nokogiri::HTML document.
+    def self.open_fragment file
+      string = IO.read file
+      Nokogiri::HTML.fragment string
+    end
+    
+    # Public: Open a file as a string.
     #
     # file - Full path String name of a html or markdown file.
     #
     # Returns a String.
     def self.open_as_string file
       string = IO.read file
-      string = BlueCloth.new(string).to_html if file.end_with? '.markdown'
-      string
+      if file.markdown_ext?
+        BlueCloth.new(string).to_html 
+      else
+        string
+      end
+    end
+    
+    # Public: Open a file as a string, taking care of fragment tags.
+    # All fragment tags are replaced by a new content.
+    #
+    # file - Full path String name of a html or markdown file.
+    #
+    # Returns a String.
+    def self.build_page_content(file, working_dir)
+      # TODO éviter le working_dir
+      if file.markdown_ext?
+        BlueCloth.new(IO.read(file)).to_html
+      else
+        Fragment.new(file, working_dir).to_html
+      end
     end
     
     # Public: Get the list of <genit> tag in a document.
     #
-    # file - Nokogiri::HTML document.
+    # file - Nokogiri::HTML or Nokogiri::XML document.
     #
     # Returns a list of Nokogiri::XML::NodeSet.
     def self.genit_tags_from file

data/lib/genit/page_compiler.rb

@@ -37,9 +37,13 @@ module Genit
     
     # Remplace la page au sein du template
     def tag_pages
-      @page_content = HtmlDocument.open_as_string(File.join(@working_dir, 'pages', @filename))
       builder = Builder.new(@template)
-      @template = builder.replace('genit.pages', @page_content)
+      @template = builder.replace('genit.pages', page_content)
+    end
+    
+    def page_content
+      filename = File.join(@working_dir, 'pages', @filename)
+      HtmlDocument.build_page_content filename, @working_dir
     end
     
     def tag_menu

data/lib/genit/project_creator.rb

@@ -21,7 +21,7 @@ module Genit
     def create
       begin
 				FileUtils.makedirs @name
-        create_dirs ['news', 'pages', 'scripts', 'styles', 'templates', 'www']
+        create_dirs ['fragments', 'news', 'pages', 'scripts', 'styles', 'templates', 'www']
         create_dirs ['styles/alsa', 'styles/yui', 'styles/images']
         copy_files ['templates/main.html', 'templates/menu.html',
                     'pages/index.html', 'styles/handheld.css', 'styles/print.css',

data/spec/extensions_spec.rb

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+require './spec/helper'
+
+describe "Standard class String extensions" do
+
+  it "should replace a markdown file ext" do
+    string = "file.markdown"
+    result = string.force_html_extension
+    result.should == "file.html"
+  end
+  
+  it "should replace a markdown file ext !" do
+    string = "file.markdown"
+    string.force_html_extension!
+    string.should == "file.html"
+  end
+  
+  it "should not replace an other file ext" do
+    string = "file.txt"
+    string.force_html_extension!
+    string.should == "file.txt"
+  end
+  
+  it "should say if it has a markdown file extension" do
+    string = "file.markdown"
+    string.markdown_ext?.should be_true
+  end
+  
+  it "should say if it has not a markdown file extension" do
+    string = "file.other"
+    string.markdown_ext?.should be_false
+  end
+
+end

data/spec/fragment_spec.rb

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+require './spec/helper'
+
+describe Fragment do
+
+  it "should replace one fragment tag" do
+    fragment = Fragment.new("spec/test-files/fragment.html", 'spec/test-files')
+    fragment.to_html.start_with?('<h1>title</h1>').should be_true
+  end
+  
+  it "should replace one fragment tag among other tags" do
+    fragment = Fragment.new("spec/test-files/fragment4.html", 'spec/test-files')
+    result = fragment.to_html
+    result.gsub!("\n", '')
+    result.should == '<h1>title</h1><p>para</p><p>footer</p>'
+  end
+  
+  it "should replace one fragment tag in markdown" do
+    fragment = Fragment.new("spec/test-files/fragment3.html", 'spec/test-files')
+    fragment.to_html.start_with?('<h1>title</h1>').should be_true
+  end
+  
+  it "should replace some fragment tags" do
+    fragment = Fragment.new("spec/test-files/fragment2.html", 'spec/test-files')
+    result = fragment.to_html.gsub("\n", '')
+    result.should == ("<p>abcde</p>")
+  end
+
+  it "should not change a file without fragment tag" do
+    fragment = Fragment.new("spec/test-files/nothing.html", 'spec/test-files')
+    fragment.to_html.start_with?("<h1>title</h1>").should be_true
+  end
+  
+end

data/spec/html_document_spec.rb

@@ -26,4 +26,14 @@ describe HtmlDocument do
     tags.size.should == 2
   end
   
+  it "should build a page content from markdown" do
+    content = HtmlDocument.build_page_content("spec/test-files/test.markdown", 'spec/test-files')
+    content.should == '<h1>title</h1>'
+  end
+  
+  it "should build page content from html" do
+    content = HtmlDocument.build_page_content("spec/test-files/fragment.html", 'spec/test-files')
+    content.start_with?('<h1>title</h1>').should be_true
+  end
+  
 end

data/spec/project_creator_spec.rb

@@ -29,6 +29,10 @@ describe ProjectCreator do
       File.exist?('spec/project-name/news').should == true
     end
     
+    it "should create a fragments folder" do
+      File.exist?('spec/project-name/fragments').should == true
+    end
+    
     it "should create a pages folder" do
       File.exist?('spec/project-name/pages').should == true
     end

data/spec/test-files/fragment.html

@@ -0,0 +1 @@
+<genit class="fragment" file="title.html" />

data/spec/test-files/fragment2.html

@@ -0,0 +1,7 @@
+<p>
+a
+<genit class="fragment" file="b.html" />
+c
+<genit class="fragment" file="d.html" />
+e
+</p>

data/spec/test-files/fragment3.html

@@ -0,0 +1 @@
+<genit class="fragment" file="title.markdown" />

data/spec/test-files/fragment4.html

@@ -0,0 +1,5 @@
+<h1>title</h1>
+
+<p>para</p>
+
+<genit class="fragment" file="footer.html"/>

data/spec/test-files/fragments/b.html

@@ -0,0 +1 @@
+b

data/spec/test-files/fragments/d.html

@@ -0,0 +1 @@
+d

data/spec/test-files/fragments/footer.html

@@ -0,0 +1 @@
+<p>footer</p>

data/spec/test-files/fragments/title.html

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

data/spec/test-files/fragments/title.markdown

@@ -0,0 +1,2 @@
+title
+======

data/spec/test-files/nothing.html

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: genit
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-02 00:00:00.000000000 +02:00
+date: 2011-07-23 00:00:00.000000000 +02:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coco
-  requirement: &82395440 !ruby/object:Gem::Requirement
+  requirement: &75668220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 0.4.2
   type: :runtime
   prerelease: false
-  version_requirements: *82395440
+  version_requirements: *75668220
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &82395100 !ruby/object:Gem::Requirement
+  requirement: &75643120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.4.6
   type: :runtime
   prerelease: false
-  version_requirements: *82395100
+  version_requirements: *75643120
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &82394760 !ruby/object:Gem::Requirement
+  requirement: &75642670 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,7 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *82394760
+  version_requirements: *75642670
 description: ! "Genit builds a **static web site**, that is a web site without server
   side \nprograming language and database. The site consists only of xhtml code (+
   css and medias) and \neventually of javascript. It is a command line framework,
@@ -60,9 +60,12 @@ files:
 - lib/genit/project_creator.rb
 - lib/genit/html_document.rb
 - lib/genit/builder.rb
+- lib/genit/file_writer.rb
 - lib/genit/xml_document.rb
 - lib/genit/page_compiler.rb
+- lib/genit/fragment.rb
 - lib/genit/compiler.rb
+- lib/genit/extensions.rb
 - lib/genit/document_writer.rb
 - lib/genit.rb
 - bin/genit
@@ -79,12 +82,24 @@ files:
 - data/pages/index.html
 - spec/compiler_spec.rb
 - spec/builder_spec.rb
+- spec/fragment_spec.rb
 - spec/helper.rb
 - spec/html_document_spec.rb
 - spec/nokogiri_spec.rb
 - spec/project_creator_spec.rb
+- spec/extensions_spec.rb
 - spec/bluecloth_spec.rb
+- spec/test-files/fragment4.html
+- spec/test-files/fragment3.html
 - spec/test-files/test.markdown
+- spec/test-files/fragment2.html
+- spec/test-files/fragment.html
+- spec/test-files/fragments/footer.html
+- spec/test-files/fragments/b.html
+- spec/test-files/fragments/title.html
+- spec/test-files/fragments/title.markdown
+- spec/test-files/fragments/d.html
+- spec/test-files/nothing.html
 - spec/xml_document_spec.rb
 - VERSION
 - NEWS