genit 0.9 → 0.99

data/NEWS

@@ -1,3 +1,8 @@
+v0.99  2011-09-25
+
+  * Genit create an RSS feed for your news articles
+  
+
 v0.9  2011-09-04
 
   * You can add news to your site with ease

data/TODO

@@ -1,45 +1,3 @@
 
 
 
-
-BUG
-==================
-
-
-
-
-LES NEWS
-====================
-
-D'abord simple, en html et en markdown:
-
-<genit class="news" number="4" />
-<genit class="news" />
-
-
-Puis avec un wrapper:
-
-<genit class="news" number="4" wrapper="a_news" />
-<genit class="news" wrapper="a_news" />
-
-
-TAG HERE & WHAT remplacent var
-===============================
-
-DOSSIER PUBLIC
-================================
-
-SCRIPTS
-=============================
-
-Les liens <img src> doivent être relativisés (comme les <a>)
-============================================================
-
-les scripts doivent être relativisés
-==========================================================
-
-switch --empty pour commande create
-======================================
-
-supprimer le contenu de www/ avant compilation
-==================================================

data/VERSION

@@ -1 +1 @@
-0.9
+0.99

data/lib/genit/project.rb

@@ -2,3 +2,4 @@
 require 'genit/project/project_creator'
 require 'genit/project/compiler'
 require 'genit/project/page_compiler'
+require 'genit/project/rss_feed'

data/lib/genit/project/compiler.rb

@@ -41,9 +41,8 @@ module Genit
     
     def compile_site
       compile_pages
-      FileUtils.cp_r File.join(@working_dir, 'styles'), File.join(@working_dir, 'www')
-      FileUtils.cp_r File.join(@working_dir, 'public'), File.join(@working_dir, 'www')
-      FileUtils.cp_r File.join(@working_dir, 'scripts'), File.join(@working_dir, 'www')
+      copy_static_content
+      create_rss_feed
     end
     
     def compile_pages
@@ -65,6 +64,20 @@ module Genit
       doc_writer.save_as_xhtml @page, @filename
     end
     
+    def copy_static_content
+      destination = File.join(@working_dir, 'www')
+      FileUtils.cp_r File.join(@working_dir, 'styles'), destination
+      FileUtils.cp_r File.join(@working_dir, 'public'), destination
+      FileUtils.cp_r File.join(@working_dir, 'scripts'), destination
+    end
+    
+    def create_rss_feed
+      all_news_files = Dir.glob(File.join(@working_dir, 'news', '*')).sort.reverse
+      config_file = YAML.load_file(File.join(@working_dir, '.config'))
+      return unless config_file[:rss]
+      RssFeed.new(@working_dir, all_news_files, config_file).generate_rss
+    end
+    
   end
   
 end

data/lib/genit/project/page_compiler.rb

@@ -37,12 +37,12 @@ module Genit
       # ai un jour besoin de faire une boucle du genre :
       # "Tant qu'il reste des tags"
       2.times { replace_all_genit_tags }
-      
-      builder = BodyLinkBuilder.new @template
-      @template = builder.build_for_page @filename
-      
-      builder = ImgBuilder.new @template
-      @template = builder.build_for_page @filename
+      build BodyLinkBuilder
+      build ImgBuilder
+    end
+    
+    def build a_class
+      @template = a_class.new(@template).build_for_page(@filename)
     end
     
     def replace_all_genit_tags

data/lib/genit/project/project_creator.rb

@@ -1,6 +1,7 @@
 # -*- encoding: utf-8 -*-
 
 require "fileutils"
+require "yaml"
 
 module Genit
 
@@ -13,7 +14,7 @@ module Genit
     # doctype - The String document type definition.
     # empty   - A Boolean telling if we produce a smoke test or not.
     def initialize name, doctype, empty
-      @name = name
+      @project_name = name
       @doctype = doctype
       @empty = empty
     end
@@ -33,16 +34,34 @@ module Genit
     private
     
     def create_the_project
-      FileUtils.makedirs @name
-      create_dirs ['fragments', 'news', 'pages', 'scripts', 'styles', 'templates', 'www',
+      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
-      FileUtils.touch "#{@name}/.genit"
+    end
+
+    def create_the_project_config
+      FileUtils.touch "#{@project_name}/.genit"
+      config_file = { :address => 'http://www.example.com',
+                      :rss => true, 
+                      :rss_title => 'RSS TITLE',
+                      :rss_description => 'RSS DESCRIPTION'}.to_yaml
+      dest =  File.join @project_name, '.config'
+      File.open(dest, "w") {|out| out.puts config_file }
     end
     
     # Create some subfolders inside the project folder.
@@ -51,13 +70,13 @@ module Genit
     #
     # Examples
     #
-    #   create_dirs ['styles', 'scripts']
+    #   create_subfolders ['styles', 'scripts']
     #
-    #   create_dirs ['styles/css/alsa', 'styles/css/yui', 'styles/css/images']
+    #   create_subfolders ['styles/css/alsa', 'styles/css/yui', 'styles/css/images']
     #
     # Returns nothing.
-    def create_dirs a_array
-      a_array.each {|dir| FileUtils.makedirs File.join(@name, dir) }
+    def create_subfolders a_array
+      a_array.each {|dir| FileUtils.makedirs File.join(@project_name, dir) }
     end
     
     # Copy files to project.
@@ -72,13 +91,14 @@ module Genit
     def copy_files a_array
       a_array.each do |file|
         src = File.join $GENIT_PATH, 'data', file
-        dest =  File.join @name, file
+        dest =  File.join @project_name, file
         FileUtils.cp src, dest
       end
     end
     
+    # @TODO document
     def copy_index
-      dest =  File.join @name, 'pages/index.html'
+      dest =  File.join @project_name, 'pages/index.html'
       if @empty
         src = File.join $GENIT_PATH, 'data/pages/index2.html'
       else
@@ -87,8 +107,9 @@ module Genit
       FileUtils.cp src, dest
     end
     
+    # @TODO document
     def copy_screen_css
-      dest =  File.join @name, 'styles/screen.css'
+      dest =  File.join @project_name, 'styles/screen.css'
       if @empty
         FileUtils.touch dest
       else
@@ -97,17 +118,20 @@ module Genit
       end
     end
     
+    # @TODO document
     def copy_main_template
-      dest =  File.join @name, 'templates', 'main.html'
+      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

data/lib/genit/project/rss_feed.rb

@@ -0,0 +1,97 @@
+# -*- encoding: utf-8 -*-
+
+require 'rss/maker'
+
+module Genit
+
+  # RssFeed could generate the RSS (version 2.0) file of the project.
+  # 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.
+    # news_files  - An Array filled with the full path name
+    #               of the news files
+    # config      - A Hash representing the project config file (.config)
+    def initialize working_dir, news_files, config
+      @working_dir = working_dir
+      @news_files = news_files
+      @config = config
+      @destination = File.join(@working_dir, 'www', 'rss.xml')
+    end
+    
+    # Public: Generate the RSS file (named rss.xml) at the web site
+    # root (www/).
+    def generate_rss
+      content = RSS::Maker.make("2.0") do |feed|
+        RssFeedMeta.fill feed, @config
+        RssFeedItems.new(feed, @news_files, @config).fill
+      end
+      File.open(@destination, "w") { |file| file.write(content) }
+    end
+    
+  end
+  
+  # Meta data of an RSS Field
+  class RssFeedMeta
+    def self.fill feed, config
+      channel = feed.channel
+      channel.title = config[:rss_title]
+      channel.link = config[:address]
+      channel.description = config[:rss_description]
+      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
+        item.title = RssFeedItemTitle.new(news).title
+        item.link = @config[:address]
+        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>.
+    # If the news article doesn't contains any <h*> element, the
+    # title() method returns the ISO date string (yyyy-mm-dd) found
+    # in the news article pathname.
+    #
+    # 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
+      doc = HtmlDocument.open_fragment(@news_pathname)
+      ('h1'..'h6').each do |header|
+        tag = doc.at_css(header)
+        if tag
+          @title = tag.inner_html
+          break
+        end
+      end
+    end
+    
+  end
+  
+end

data/lib/genit/tags/class_news_tag.rb

@@ -26,25 +26,22 @@ module Genit
     
     def news_content
       news_string = ''
-      news_files.each do |file|
-        doc = HtmlDocument.open_as_string file
-        if @tag['wrapper']
-          news_string += "<div class='#{@tag['wrapper']}'>" + doc.to_s + '</div>'
-        else
-          news_string += doc.to_s
-        end
-      end
+      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']
-      if number
-        files[0...(number).to_i]
-      else
-        files
-      end
+      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

data/lib/genit/utils.rb

@@ -1,2 +1,3 @@
 # -*- encoding: utf-8 -*-
 require 'genit/utils/file_writer'
+require 'genit/utils/news_utils'

data/lib/genit/utils/news_utils.rb

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+
+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/compiler_spec.rb

@@ -22,14 +22,14 @@ describe Compiler do
   
   it "should build an index.html page in www" do
     @compiler.compile
-    File.exist?('spec/project-name/www/index.html').should == true
+    File.exist?('spec/project-name/www/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 == true
-    File.exist?('spec/project-name/www/doc.html').should == true
+    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
@@ -48,29 +48,41 @@ describe Compiler do
     compiler.compile
   end
   
-  it "should allow template to include a fragment (Bug#37)" do
-    # add a fragment
-    File.open('spec/project-name/fragments/footer.html', "w") {|out| out.puts '<p>footer</p>' }
-    # 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">
-      <head>
-        <title>Genit - Static web site framework</title>
-        <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
-        <link rel="stylesheet" type="text/css" media="all" href="styles/alsa/all.css" /> 
-        <link rel="stylesheet" type="text/css" media="screen" href="styles/screen.css" /> 
-        <link rel="stylesheet" type="text/css" media="print" href="styles/print.css" /> 
-      </head>
-      <body>
-        <genit class="menu" />
-        <genit class="pages" />
-        <genit class="fragment" file="footer.html"/>
-      </body>
-    </html>}
-    File.open('spec/project-name/templates/main.html', "w") {|out| out.puts main }
-    lambda {@compiler.compile}.should_not raise_error
+  describe "RSS feed" do
+  
+    it "should build the rss.xml file" do
+       File.exist?('spec/project-name/www/rss.xml').should be_true
+    end
+    
+  end
+  
+  describe "BUGS" do
+  
+    it "should allow template to include a fragment (Bug#37)" do
+      # add a fragment
+      File.open('spec/project-name/fragments/footer.html', "w") {|out| out.puts '<p>footer</p>' }
+      # 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">
+        <head>
+          <title>Genit - Static web site framework</title>
+          <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
+          <link rel="stylesheet" type="text/css" media="all" href="styles/alsa/all.css" /> 
+          <link rel="stylesheet" type="text/css" media="screen" href="styles/screen.css" /> 
+          <link rel="stylesheet" type="text/css" media="print" href="styles/print.css" /> 
+        </head>
+        <body>
+          <genit class="menu" />
+          <genit class="pages" />
+          <genit class="fragment" file="footer.html"/>
+        </body>
+      </html>}
+      File.open('spec/project-name/templates/main.html', "w") {|out| out.puts main }
+      lambda {@compiler.compile}.should_not raise_error
+    end
+  
   end
   
 end

data/spec/project_creator_spec.rb

@@ -29,6 +29,34 @@ describe ProjectCreator do
       File.exist?('spec/project-name/.genit').should == true
     end
     
+    it "should create a config file" do
+      File.exist?('spec/project-name/.config').should == true
+    end
+    
+  end
+  
+  describe "Config file" do
+    
+    before :each do
+      @config_file = YAML.load_file('spec/project-name/.config')
+    end
+  
+    it "should have an address value of 'http://www.example.com'" do
+      @config_file[:address].should == 'http://www.example.com'
+    end
+    
+    it "should have an rss value at true" do
+      @config_file[:rss].should be_true
+    end
+    
+    it "should have an rss_title value of 'RSS TITLE'" do
+      @config_file[:rss_title].should == 'RSS TITLE'
+    end
+    
+    it "should have an rss_description value of 'RSS DESCRIPTION'" do
+      @config_file[:rss_description].should == 'RSS DESCRIPTION'
+    end
+    
   end
   
   describe "Folder structure" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: genit
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: '0.99'
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-04 00:00:00.000000000 +02:00
+date: 2011-09-25 00:00:00.000000000 +02:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coco
-  requirement: &72980010 !ruby/object:Gem::Requirement
+  requirement: &68826960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 0.4.2
   type: :runtime
   prerelease: false
-  version_requirements: *72980010
+  version_requirements: *68826960
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &72979620 !ruby/object:Gem::Requirement
+  requirement: &68826590 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.4.6
   type: :runtime
   prerelease: false
-  version_requirements: *72979620
+  version_requirements: *68826590
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &72979050 !ruby/object:Gem::Requirement
+  requirement: &68826230 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *72979050
+  version_requirements: *68826230
 - !ruby/object:Gem::Dependency
   name: clamp
-  requirement: &72978470 !ruby/object:Gem::Requirement
+  requirement: &68825890 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: 0.2.2
   type: :runtime
   prerelease: false
-  version_requirements: *72978470
+  version_requirements: *68825890
 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,
@@ -68,6 +68,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/genit/project/rss_feed.rb
 - lib/genit/project/project_creator.rb
 - lib/genit/project/page_compiler.rb
 - lib/genit/project/compiler.rb
@@ -85,6 +86,7 @@ files:
 - lib/genit/documents/fragment.rb
 - lib/genit/documents/document_writer.rb
 - lib/genit/utils/file_writer.rb
+- lib/genit/utils/news_utils.rb
 - lib/genit/builders.rb
 - lib/genit/utils.rb
 - lib/genit/tags/class_menu_tag.rb