genit 1.0.1 → 2.0

data/lib/genit/project/page_compiler.rb

@@ -4,7 +4,7 @@ module Genit
 
   # Compile a single page.
   class PageCompiler
-  
+
     # Public: Constructor.
     #
     # working_dir - The String working directory, where live the project.
@@ -12,10 +12,10 @@ module Genit
     def initialize working_dir, filename
       @working_dir = working_dir
       @filename = filename
-      @template = XmlDocument.open(File.join(@working_dir, 'templates/main.html'))
-      # @template = XmlDocument.open(File.join(@working_dir, 'templates/main.html'))
+      file = File.join(@working_dir, 'src/templates/main.html')
+      @template = XmlDocument.open(file)
     end
-    
+
     # Public: Compile the page.
     #
     # Returns a Nokogiri::XML document.
@@ -26,44 +26,44 @@ module Genit
       builder = ScriptBuilder.new @template
       builder.build_for_page @filename
     end
-    
+
     private
-    
-    def compile_body
-      # Pourquoi 2 fois ?
-      # Parce que la 1ere fois, on inclus essentiellement la page au sein du
-      # template, et la seconde fois, on s'occupe des tags restants (ceux qui
-      # étaient dans la page).
-      # Suivant comment la hiérarchie de tag évoluera, il est possible qu'on
-      # ai un jour besoin de faire une boucle du genre :
-      # "Tant qu'il reste des tags"
-      2.times { replace_all_genit_tags }
-      build BodyLinkBuilder
-      build ImgBuilder
-    end
-    
-    def build a_class
-      @template = a_class.new(@template).build_for_page(@filename)
-    end
-    
-    def replace_all_genit_tags
-      genit_tags_in_template.each do |tag| 
-        next if tag.genit_what?
-        tp = TagProcessor.new(@working_dir, @template, @filename, tag)
-        @template = tp.process
+
+      def compile_body
+        # Pourquoi 2 fois ?
+        # Parce que la 1ere fois, on inclus essentiellement la page au sein du
+        # template, et la seconde fois, on s'occupe des tags restants (ceux qui
+        # étaient dans la page).
+        # Suivant comment la hiérarchie de tag évoluera, il est possible qu'on
+        # ai un jour besoin de faire une boucle du genre :
+        # "Tant qu'il reste des tags"
+        2.times { replace_all_genit_tags }
+        build BodyLinkBuilder
+        build ImgBuilder
       end
-    end
-    
-    def compile_head
-      builder = HeadLinkBuilder.new @template
-      builder.build_for_page @filename
-    end
-    
-    # Returns all <genit> tags found in the template.
-    def genit_tags_in_template
-      HtmlDocument.genit_tags_from @template
-    end
-  
+
+      def replace_all_genit_tags
+        genit_tags_in_template.each do |tag| 
+          next if tag.genit_what?
+          tp = TagProcessor.new(@working_dir, @template, @filename, tag)
+          @template = tp.process
+        end
+      end
+
+      def build a_class
+        @template = a_class.new(@template).build_for_page(@filename)
+      end
+
+      def compile_head
+        builder = HeadLinkBuilder.new @template
+        builder.build_for_page @filename
+      end
+
+      # Returns all <genit> tags found in the template.
+      def genit_tags_in_template
+        HtmlDocument.genit_tags_from @template
+      end
+
   end
-  
+
 end

data/lib/genit/project/pages_finder.rb

@@ -5,15 +5,15 @@ module Genit
   # I can find the list of all page names, named from
   # the site root.
   class PagesFinder
-  
+
     # Public: Constructor.
     #
     # working_dir - The String working directory, where live the project.
     def initialize working_dir
       @working_dir = working_dir
-      @pages_folder = File.join(@working_dir, 'pages')
+      @pages_folder = File.join(@working_dir, PAGES_DIR)
     end
-  
+
     # Public: Retrieve the list of all page names.
     #
     # Returns an Array of String.
@@ -22,11 +22,11 @@ module Genit
       list.map! { |name| name.gsub(@pages_folder + '/', '')}
       list.map { |name| name.force_html_extension }
     end
-    
+
     def self.pagenames2urls array, url_string
       array.map { |name| File.join(url_string, name) }
     end
-    
+
   end
-  
+
 end

data/lib/genit/project/project_creator.rb

@@ -7,18 +7,16 @@ module Genit
 
   # Create a skeleton project.
   class ProjectCreator
-  
+
     # Sole constructor.
     #
     # name    - The String name of the future project folder.
-    # doctype - The String document type definition.
     # empty   - A Boolean telling if we produce a smoke test or not.
-    def initialize name, doctype, empty
+    def initialize name, empty
       @project_name = name
-      @doctype = doctype
       @empty = empty
     end
-    
+
     # Public: Create the structure of the project, that is many
     # files and folders.
     #
@@ -30,120 +28,127 @@ module Genit
         puts "Cannot create project..."
       end
     end
-    
+
     private
-    
-    def create_the_project
-      create_the_project_folders
-      copy_the_project_files
-      create_the_project_config
-    end
-    
-    def create_the_project_folders
-      FileUtils.makedirs @project_name
-      create_subfolders ['fragments', 'news', 'pages', 'scripts', 'styles', 'templates', 'www',
-                   'styles/alsa', 'styles/yui', 'styles/images', 'public']
-    end
-    
-    def copy_the_project_files
-      copy_main_template
-      copy_files ['templates/menu.html', 'styles/handheld.css', 'styles/print.css',
-                  'styles/alsa/all.css', 'styles/yui/all.css', 'styles/yui/base.css',
-                  'styles/yui/fonts.css', 'styles/yui/reset.css']
-      copy_index
-      copy_screen_css
-    end
 
-    def create_the_project_config
-      version =  File.read(File.join($GENIT_PATH, 'VERSION')).strip
-      write_config version, '.genit'
+      def create_the_project
+        create_the_project_folders
+        copy_the_project_files
+        create_the_project_config
+      end
 
-      config_file = { :address => 'http://www.example.com',
-                      :rss => true, 
-                      :rss_title => 'RSS TITLE',
-                      :rss_description => 'RSS DESCRIPTION'}.to_yaml
-      write_config config_file, '.config'
-    end
-    
-    def write_config content, filename
-      dest =  File.join @project_name, filename
-      File.open(dest, "w") {|out| out.puts content }
-    end
-    
-    # Create some subfolders inside the project folder.
-    #
-    # a_array - An Array of String subfolder names
-    #
-    # Examples
-    #
-    #   create_subfolders ['styles', 'scripts']
-    #
-    #   create_subfolders ['styles/css/alsa', 'styles/css/yui', 'styles/css/images']
-    #
-    # Returns nothing.
-    def create_subfolders a_array
-      a_array.each {|dir| FileUtils.makedirs File.join(@project_name, dir) }
-    end
-    
-    # Copy files to project.
-    #
-    # a_array - An Array of String "subfolder/file" names
-    #
-    # Example
-    #
-    #   copy_files ['templates/main.html', 'pages/index.html']
-    #
-    # Returns nothing.
-    def copy_files a_array
-      a_array.each do |file|
-        src = File.join $GENIT_PATH, 'data', file
-        dest =  File.join @project_name, file
+      def create_the_project_folders
+        FileUtils.makedirs @project_name
+        create_subfolders ['src', 'src/fragments', 'src/news', 'src/pages',
+                           'scripts', 'styles', 'src/templates', 
+                           'styles/images', 'public']
+      end
+
+      # Create some subfolders inside the project folder.
+      #
+      # a_array - An Array of String subfolder names
+      #
+      # Examples
+      #
+      #   create_subfolders ['styles', 'scripts']
+      #
+      #   create_subfolders ['styles/css/alsa', 'styles/css/yui',
+      #                      'styles/css/images']
+      #
+      # Returns nothing.
+      def create_subfolders a_array
+        a_array.each {|dir| FileUtils.makedirs File.join(@project_name, dir) }
+      end
+
+      def copy_the_project_files
+        copy_main_template
+        copy_menu_template
+        copy_files ['styles/handheld.css', 'styles/print.css']
+        copy_index
+        copy_screen_css
+      end
+
+      def create_the_project_config
+        version =  File.read(File.join($GENIT_PATH, 'VERSION')).strip
+        write_config version, '.genit'
+
+        config_file = { :address => 'http://www.example.com',
+                        :rss => true, 
+                        :rss_title => 'RSS TITLE',
+                        :rss_description => 'RSS DESCRIPTION'}.to_yaml
+        write_config config_file, 'config'
+      end
+
+      def write_config content, filename
+        dest =  File.join @project_name, filename
+        File.open(dest, "w") {|out| out.puts content }
+      end
+
+      # Copy files to project.
+      #
+      # a_array - An Array of String "subfolder/file" names
+      #
+      # Example
+      #
+      #   copy_files ['templates/main.html', 'pages/index.html']
+      #
+      # Returns nothing.
+      def copy_files a_array
+        a_array.each do |file|
+          src = File.join $GENIT_PATH, 'data', file
+          dest =  File.join @project_name, file
+          FileUtils.cp src, dest
+        end
+      end
+
+      # TODO document
+      def copy_index
+        dest =  File.join @project_name, 'src/pages/index.html'
+        if @empty
+          src = File.join $GENIT_PATH, 'data/pages/index2.html'
+        else
+          src = File.join $GENIT_PATH, 'data/pages/index.html'
+        end
         FileUtils.cp src, dest
       end
-    end
-    
-    # @TODO document
-    def copy_index
-      dest =  File.join @project_name, 'pages/index.html'
-      if @empty
-        src = File.join $GENIT_PATH, 'data/pages/index2.html'
-      else
-        src = File.join $GENIT_PATH, 'data/pages/index.html'
+
+      # TODO document
+      def copy_screen_css
+        dest =  File.join @project_name, 'styles/screen.css'
+        if @empty
+          FileUtils.touch dest
+        else
+          src = File.join $GENIT_PATH, 'data/styles/screen.css'
+          FileUtils.cp src, dest
+        end
       end
-      FileUtils.cp src, dest
-    end
-    
-    # @TODO document
-    def copy_screen_css
-      dest =  File.join @project_name, 'styles/screen.css'
-      if @empty
-        FileUtils.touch dest
-      else
-        src = File.join $GENIT_PATH, 'data/styles/screen.css'
+
+      # TODO document
+      def copy_main_template
+        dest =  File.join @project_name, 'src/templates', 'main.html'
+        copy_first_part dest
+        ProjectCreator.append_last_part dest
+      end
+
+      def copy_menu_template
+        dest =  File.join @project_name, 'src/templates', 'menu.html'
+        src = File.join $GENIT_PATH, 'data', 'templates', 'menu.html'
         FileUtils.cp src, dest
       end
-    end
-    
-    # @TODO document
-    def copy_main_template
-      dest =  File.join @project_name, 'templates', 'main.html'
-      copy_first_part dest
-      ProjectCreator.append_last_part dest
-    end
-    
-    # @TODO document
-    def copy_first_part dest
-      src = File.join $GENIT_PATH, 'data', 'templates', @doctype
-      FileUtils.cp src, dest
-    end
-    
-    # @TODO document
-    def self.append_last_part dest
-      src = File.join $GENIT_PATH, 'data', 'templates', 'main.html'
-      content = File.open(src, "r").read
-      File.open(dest, "a") {|out| out.puts content }
-    end
-    
+
+      # TODO document
+      def copy_first_part dest
+        src = File.join $GENIT_PATH, 'data', 'templates', "html_5"
+        FileUtils.cp src, dest
+      end
+
+      # TODO document
+      def self.append_last_part dest
+        src = File.join $GENIT_PATH, 'data', 'templates', 'main.html'
+        content = File.open(src, "r").read
+        File.open(dest, "a") {|out| out.puts content }
+      end
+
   end
 
 end

data/lib/genit/project/root_cleaner.rb

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+require 'fileutils'
+
+module Genit
+
+  # My responsability is to clean the root directory before a
+  # compilation. I have to keep alive some files (.genit, config) and
+  # some folders (src/, public/, etc).
+  class RootCleaner
+
+    # Public: Constructor.
+    #
+    # wd - The String working directory, where live the project.
+    def initialize wd
+      @wd = wd
+    end
+
+    # Public: Clean the root directory.
+    #
+    # Returns nothing.
+    def clean
+      Dir.foreach(@wd) do |file|
+        next if file.start_with?('.') or (file == "config")
+        filename = File.join(@wd, file)
+        FileUtils.remove_file(filename) if File.file?(filename)
+      end
+    end
+  end
+
+end

data/lib/genit/project/rss_feed.rb

@@ -8,7 +8,7 @@ module Genit
   # To generate the RSS file, we need data from the project config
   # file (.config) and the list of the news.
   class RssFeed
-  
+
     # Public: Constructor.
     #
     # working_dir - The String working directory, where live the project.
@@ -19,9 +19,9 @@ module Genit
       @working_dir = working_dir
       @news_files = news_files
       @config = config
-      @destination = File.join(@working_dir, 'www', 'rss.xml')
+      @destination = File.join(@working_dir, 'rss.xml')
     end
-    
+
     # Public: Generate the RSS file (named rss.xml) at the web site
     # root (www/).
     def generate_rss
@@ -31,9 +31,9 @@ module Genit
       end
       File.open(@destination, "w") { |file| file.write(content) }
     end
-    
+
   end
-  
+
   # Meta data of an RSS Field
   class RssFeedMeta
     def self.fill feed, config
@@ -44,16 +44,16 @@ module Genit
       feed.items.do_sort = true
     end
   end
-  
+
   # Items of an RSS Field
   class RssFeedItems
-  
+ 
     def initialize feed, news_files, config
       @feed = feed
       @news_files = news_files
       @config = config
     end
-    
+
     def fill
       @news_files.each do |news|
         item = @feed.items.new_item
@@ -62,13 +62,13 @@ module Genit
         item.date = Time.parse(NewsUtils.get_date_from_filename(news))
       end
     end
-    
+
   end
-  
+
   # Retrieve the title element of an item element of an RSS feed
   # from a news article.
   class RssFeedItemTitle
-  
+
     # Public: Get the first title content from a news article.
     #
     # We first search for <h1> header level, then <h2>, etc to <h6>.
@@ -78,7 +78,7 @@ module Genit
     #
     # Returns the String title of the news article.
     attr_reader :title
-    
+
     def initialize news_pathname
       @news_pathname = news_pathname
       @title = NewsUtils.get_date_from_filename @news_pathname
@@ -91,7 +91,7 @@ module Genit
         end
       end
     end
-    
+ 
   end
-  
+
 end