genit 1.0.1 → 2.0

data/lib/genit/server.rb

@@ -0,0 +1,2 @@
+# -*- encoding: utf-8 -*-
+require 'genit/server/server'

data/lib/genit/server/server.rb

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+require 'webrick'
+
+module Genit
+
+  # I use WEBrick to serve the html from the root directory.
+  class Server
+
+    # Public: Constructor.
+    #
+    # wd - The String working directory, where live the project.
+    def initialize wd
+      @server = WEBrick::HTTPServer.new(:Port => 3000, :DocumentRoot => wd)
+      ['INT', 'TERM'].each {|signal| trap_this signal }
+    end
+
+    # Start the web server.
+    #
+    # Returns nothing.
+    def start
+      puts "Press Ctrl-C to close."
+      @server.start
+    end
+
+    private
+
+      def trap_this signal
+         trap(signal) { @server.shutdown } 
+      end
+  end
+
+end

data/lib/genit/tags/class_fragment_tag.rb

@@ -14,8 +14,8 @@ module Genit
     def initialize working_dir, template, filename, tag
       super working_dir, template, filename, tag
       @file = @tag['file']
-      error "Incomplete #{@tag}" if @file.nil?
-      @full_path = File.join(@working_dir, 'fragments', @file)
+      error "Incomplete #{@tag}" unless @tag.key?('file')
+      @full_path = File.join(@working_dir, FRAGMENTS_DIR, @file)
       error "No such file #{@tag}" unless File.exists?(@full_path)
     end
     

data/lib/genit/tags/class_menu_tag.rb

@@ -26,7 +26,8 @@ module Genit
     private
     
     def build_menu
-      menu = XmlDocument.open(File.join(@working_dir, "templates/menu.html"))
+      file = File.join(@working_dir, TEMPLATES_DIR, "menu.html")
+      menu = XmlDocument.open(file)
       builder = MenuBuilder.new(menu)
       @menu = builder.build_for_page(@filename)
     end

data/lib/genit/tags/class_news_tag.rb

@@ -14,36 +14,36 @@ module Genit
     def initialize working_dir, template, filename, tag
       super working_dir, template, filename, tag
     end
-    
+
     # Public: Do the replacement.
     #
     # Returns the template as a Nokogiri::XML::Document
     def process
       replace_tag_into_template! 'genit.news', news_content
     end
-    
+
     private
-    
-    def news_content
-      news_string = ''
-      news_files.each { |file| news_string += process_the_news(file) }
-      news_string
-    end
-    
-    def news_files
-      files = Dir.glob(File.join(@working_dir, 'news', '*')).sort.reverse
-      number = @tag['number']
-      return files[0...(number).to_i] if number
-      files
-    end
-    
-    def process_the_news file 
-      doc_as_string = HtmlDocument.open_as_string(file).to_s
-      wrapper = @tag['wrapper']
-      return "<div class='#{wrapper}'>" + doc_as_string + '</div>' if wrapper
-      doc_as_string
-    end
-    
+
+      def news_content
+        news_string = ''
+        news_files.each { |file| news_string += process_the_news(file) }
+        news_string
+      end
+
+      def news_files
+        files = Dir.glob(File.join(@working_dir, NEWS_DIR, '*')).sort.reverse
+        number = @tag['number']
+        return files[0...(number).to_i] if number
+        files
+      end
+
+      def process_the_news file 
+        doc_as_string = HtmlDocument.open_as_string(file).to_s
+        wrapper = @tag['wrapper']
+        return "<div class='#{wrapper}'>" + doc_as_string + '</div>' if wrapper
+        doc_as_string
+      end
+
   end
-  
+
 end

data/lib/genit/tags/class_pages_tag.rb

@@ -25,7 +25,7 @@ module Genit
     private
     
     def page_content
-      filename = File.join(@working_dir, 'pages', @filename)
+      filename = File.join(@working_dir, PAGES_DIR, @filename)
       HtmlDocument.build_page_content filename, @working_dir
     end
     

data/lib/genit/tags/here_tag.rb

@@ -16,7 +16,7 @@ module Genit
     def initialize working_dir, template, filename, tag
       super working_dir, template, filename, tag
     end
-    
+
     # Public: Replace a variable in the template. The variable content is found
     # in the tag in the page.
     #
@@ -25,25 +25,29 @@ module Genit
       replace_tag_into_template! get_css_rule, get_variable_value
       @template
     end
-    
+
     private
-    
-    def get_css_rule
-      var_name = @tag['here']
-      "genit[here='#{var_name}']"
-    end
-    
-    def get_variable_value
-      doc = HtmlDocument.open_fragment File.join(@working_dir, 'pages', @filename)
-      elem = doc.at_css "genit[what='#{@tag['here']}']"
-      if elem.nil?
-        warning "here without what #{@tag}"
-        ""
-      else
-        elem.inner_html
+
+      def get_css_rule
+        var_name = @tag['here']
+        "genit[here='#{var_name}']"
       end
-    end
-    
+
+      def get_variable_value
+        file = File.join(@working_dir, PAGES_DIR, @filename)
+        doc = HtmlDocument.open_fragment file
+        html_or_nothing_from(doc.at_css("genit[what='#{@tag['here']}']"))
+      end
+
+      def html_or_nothing_from element
+        if element.nil?
+          warning "here without what #{@tag}"
+          ""
+        else
+          element.inner_html
+        end
+      end
+
   end
 
 end

data/lib/genit/utils/news_utils.rb

@@ -4,11 +4,11 @@ module Genit
 
   # Utily methods for a news (an article).
   class NewsUtils
-    
+
     def self.get_date_from_filename filename
        File.basename(filename).gsub(/\..*$/, '')
     end
-    
+
   end
-  
+
 end

data/spec/class_news_tag_spec.rb

@@ -7,11 +7,11 @@ describe ClassNewsTag do
   after :all do
     clean_test_repository
   end
-  
+
   def create_sample_project
-    FileUtils.makedirs('spec/project-name/news')
-    File.open('spec/project-name/news/2011-01-01.html', "w") {|out| out.puts '<h1>2011-01-01</h1>' }
-    File.open('spec/project-name/news/2011-02-02.html', "w") {|out| out.puts '<h1>2011-02-02</h1>' }
+    FileUtils.makedirs('spec/project-name/src/news')
+    File.open('spec/project-name/src/news/2011-01-01.html', "w") {|out| out.puts '<h1>2011-01-01</h1>' }
+    File.open('spec/project-name/src/news/2011-02-02.html', "w") {|out| out.puts '<h1>2011-02-02</h1>' }
   end
 
   it "should replace all news" do
@@ -22,7 +22,7 @@ describe ClassNewsTag do
     doc = cnt.process
     doc.css('h1').size.should == 2
   end
-  
+
   it "should replace X news" do
     create_sample_project
     template = Nokogiri::XML.fragment '<genit class="news" number="1"/>'

data/spec/compiler_spec.rb

@@ -5,41 +5,36 @@ require './spec/helper'
 describe Compiler do
 
   before :each do
-    @project = ProjectCreator.new('spec/project-name', 'html_5', false)
+    @project = ProjectCreator.new('spec/project-name', false)
     @project.create
     @compiler = Compiler.new test_project_path
   end
-  
+
   after :each do
     clean_test_repository
   end
-  
+
   def write_file name, content
     File.open(File.join('spec/project-name', name), "w") do |file| 
       file.puts content
     end
   end
-  
-  it "should build an index.html page in www" do
+
+  it "should build an index.html page" do
     @compiler.compile
-    File.exist?('spec/project-name/www/index.html').should be_true
+    File.exist?('spec/project-name/index.html').should be_true
   end
-  
+
   it "should build two pages" do
-    write_file 'pages/doc.html', '<h1>documentation</h1>'
-    @compiler.compile
-    File.exist?('spec/project-name/www/index.html').should be_true
-    File.exist?('spec/project-name/www/doc.html').should be_true
-  end
-    
-  it "should copy the styles/ into www/" do
+    write_file 'src/pages/doc.html', '<h1>documentation</h1>'
     @compiler.compile
-    File.exist?('spec/project-name/www/styles/screen.css').should be_true
+    File.exist?('spec/project-name/index.html').should be_true
+    File.exist?('spec/project-name/doc.html').should be_true
   end
-  
+
   it "should set the menu in index page" do
     @compiler.compile
-    doc = Nokogiri::HTML(File.open("spec/project-name/www/index.html"))
+    doc = Nokogiri::HTML(File.open("spec/project-name/index.html"))
     doc.at_css("ul#menu a#selected")['href'].should == 'index.html'
   end
   
@@ -50,10 +45,10 @@ describe Compiler do
     end
   end
   
-  context "with no '.config' file" do
+  context "with no 'config' file" do
     it "should exit" do
       $stdout.should_receive(:puts).with(/Missing config file/i)
-      FileUtils.rm 'spec/project-name/.config'
+      FileUtils.rm 'spec/project-name/config'
       lambda{Compiler.new test_project_path}.should raise_error(SystemExit)
     end
   end
@@ -61,21 +56,21 @@ describe Compiler do
   describe "RSS feed" do
     it "should build the rss.xml file" do
       @compiler.compile
-      File.exist?('spec/project-name/www/rss.xml').should be_true
+      File.exist?('spec/project-name/rss.xml').should be_true
     end
   end
   
   describe "Sitemap XML" do
     it "should build the 'sitemap.xml'" do
       a_news = %q{<h1>title</h1>}
-      File.open('spec/project-name/news/2011-10-01.html', "w") do |out|
+      File.open('spec/project-name/src/news/2011-10-01.html', "w") do |out|
         out.puts a_news
       end
       @compiler.compile
-      File.exist?('spec/project-name/www/sitemap.xml').should be_true
+      File.exist?('spec/project-name/sitemap.xml').should be_true
     end
   end
-  
+
   context "with bad tag syntax" do
     context "with unknown class into template" do
       it "should exit" do
@@ -87,7 +82,7 @@ describe Compiler do
             </body>
           </html>
         }
-        File.open('spec/project-name/templates/main.html', "w") do |out|
+        File.open('spec/project-name/src/templates/main.html', "w") do |out|
           out.puts main
         end
         
@@ -97,22 +92,22 @@ describe Compiler do
         end.should raise_error(SystemExit)
       end
     end
-    
+
     context "with unknown class into page" do
       it "should exit" do
         # replace index.html
         index = %q{<genit class="foo"/>}
-        File.open('spec/project-name/pages/index.html', "w") do |out|
+        File.open('spec/project-name/src/pages/index.html', "w") do |out|
           out.puts index
         end
-        
+
         $stdout.should_receive(:puts).with(/Unknown tag <genit class="foo"/i)
         lambda do
           Compiler.new(test_project_path).compile
         end.should raise_error(SystemExit)
       end
     end
-    
+
     context "with incomplete fragment tag into template" do
       it "should exit" do
         # replace main.html
@@ -123,22 +118,22 @@ describe Compiler do
             </body>
           </html>
         }
-        File.open('spec/project-name/templates/main.html', "w") do |out|
+        File.open('spec/project-name/src/templates/main.html', "w") do |out|
           out.puts main
         end
-        
+
         $stdout.should_receive(:puts).with(/Incomplete <genit class="fragment"/i)
         lambda do
           Compiler.new(test_project_path).compile
         end.should raise_error(SystemExit)
       end
     end
-    
+
     context "with incomplete fragment tag into page" do
       it "should exit" do
         # replace index.html
         index = %q{<genit class="fragment"/>}
-        File.open('spec/project-name/pages/index.html', "w") do |out|
+        File.open('spec/project-name/src/pages/index.html', "w") do |out|
           out.puts index
         end
         
@@ -148,7 +143,7 @@ describe Compiler do
         end.should raise_error(SystemExit)
       end
     end
-    
+
     context "with unknown file in fragment tag into template" do
       it "should exit" do
         # replace main.html
@@ -159,10 +154,10 @@ describe Compiler do
             </body>
           </html>
         }
-        File.open('spec/project-name/templates/main.html', "w") do |out|
+        File.open('spec/project-name/src/templates/main.html', "w") do |out|
           out.puts main
         end
-        
+
         rx = /No such file <genit class="fragment" file=/i
         $stdout.should_receive(:puts).with(rx)
         lambda do
@@ -170,15 +165,15 @@ describe Compiler do
         end.should raise_error(SystemExit)
       end
     end
-    
+
     context "with unknown file in fragment tag into page" do
       it "should exit" do
         # replace index.html
         index = %q{<genit class="fragment" file="unknown.html"/>}
-        File.open('spec/project-name/pages/index.html', "w") do |out|
+        File.open('spec/project-name/src/pages/index.html', "w") do |out|
           out.puts index
         end
-        
+
         rx = /No such file <genit class="fragment" file=/i
         $stdout.should_receive(:puts).with(rx)
         lambda do
@@ -186,7 +181,7 @@ describe Compiler do
         end.should raise_error(SystemExit)
       end
     end
-    
+
     context "with here tag without what tag" do
       it "should warn" do
         # replace main.html
@@ -199,19 +194,19 @@ describe Compiler do
             </body>
           </html>
         }
-        File.open('spec/project-name/templates/main.html', "w") do |out|
+        File.open('spec/project-name/src/templates/main.html', "w") do |out|
           out.puts main
         end
         $stdout.should_receive(:puts).with(/here without what/i)
         Compiler.new(test_project_path).compile
       end
     end
-    
+
   end
-  
-  context "with bad '.config' syntax" do
+
+  context "with bad 'config' syntax" do
     it "should exit" do
-      # replace .config
+      # replace config
       main = 
 %q{--- 
 :address: http://www.example.com
@@ -219,38 +214,34 @@ describe Compiler do
  :rss_title: RSS TITLE
 :rss_description: RSS DESCRIPTION
 }
-      File.open('spec/project-name/.config', "w") {|out| out.puts main }
-      
-      $stdout.should_receive(:puts).with(/in .config file/i)
+      File.open('spec/project-name/config', "w") {|out| out.puts main }
+
+      $stdout.should_receive(:puts).with(/in config file/i)
       lambda do
         Compiler.new(test_project_path).compile
       end.should raise_error(SystemExit)
     end
   end
-  
+
   describe "BUGS" do
 
     it "should compile to valid HTML5" do
       @compiler.compile
-      file = File.open("spec/project-name/www/index.html", "r")
+      file = File.open("spec/project-name/index.html", "r")
       contents = file.read
-      puts "*************"
-      puts contents
       expected = '<!DOCTYPE html>'
       contents.start_with?(expected).should be_true
     end
-  
+
     it "should allow template to include a fragment (Bug#37)" do
       # add a fragment
-      File.open('spec/project-name/fragments/footer.html', "w") do |out|
+      File.open('spec/project-name/src/fragments/footer.html', "w") do |out|
         out.puts '<p>footer</p>'
       end
       # replace main.html
       main = %q{
-      <?xml version="1.0" encoding="UTF-8"?>
-      <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-                     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-      <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+      <!DOCTYPE html>
+      <html lang="en">
         <head>
           <title>Genit - Static web site framework</title>
           <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
@@ -267,12 +258,12 @@ describe Compiler do
           <genit class="fragment" file="footer.html"/>
         </body>
       </html>}
-      File.open('spec/project-name/templates/main.html', "w") do |out|
+      File.open('spec/project-name/src/templates/main.html', "w") do |out|
         out.puts main
       end
       lambda {@compiler.compile}.should_not raise_error
     end
-  
+
   end
-  
+
 end