genit 0.3 → 0.4

data/NEWS

@@ -1,4 +1,15 @@
-v0.3  2001-07-23
+v0.4  2011-07-25
+
+  * better smoke test
+  
+  * basic user documentation 
+  
+  * genit use a simple project file
+  
+  * use clamp as a command line framework 
+  
+
+v0.3  2011-07-23
 
   * You can split a page in a multitude of fragments.
 

data/README.markdown

@@ -4,7 +4,7 @@ Genit
 Genit builds a **static web site**, that is a web site without server side programing language
 and database. A genit site consists only of xhtml code (+ css, medias and eventually javascript).
 
-There is no needs to know the Ruby language.
+Genit is written in Ruby but 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).
@@ -50,8 +50,7 @@ Usage
 
     genit compile
 
-Take a look at the [tutorial](https://github.com/lkdjiin/genit/blob/master/documentation/tutorial.markdown) 
-for more information.
+See the wiki for user documentation and a tutorial.
 
 
 Dependencies
@@ -62,6 +61,7 @@ Dependencies
   * ruby >= 1.9.2
   * nokogiri (xml parser)
   * bluecloth (markdown parser)
+  * clamp (command line utility)
 
 ### Contributors dependencies
 

data/TODO

@@ -1,23 +1,16 @@
-release v0.3
 
+release v0.4
 
 
-smoke test
-
-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
+web site for genit
 
+announce site (freshmeat et blog)
 
 
 
-web site for genit
 
-announce site (freshmeat et blog)
 
 news
 

data/VERSION

@@ -1 +1 @@
-0.3
+0.4

data/bin/genit

@@ -26,28 +26,48 @@ $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 $GENIT_PATH = File.expand_path(File.dirname(__FILE__)) + '/..'
 
 require 'genit'
+require 'clamp'
 include Genit
 
-def usage
-  puts %q{usage: genit command
+module Genit
 
-where command is:
-  create project-name
-  compile | cc}
-end
+  class AbstractCommand < Clamp::Command
+    
+    option ['-v', '--version'], :flag, "print version" do
+      puts "genit #{File.read('VERSION').strip}"
+      exit 0
+    end
+
+  end
+  
+  class CreateCommand < AbstractCommand
+  
+    parameter "NAME", "the name of the project", :attribute_name => :project_name
+
+    def execute
+      project = ProjectCreator.new project_name
+      project.create
+    end
+    
+  end
+  
+  class CompileCommand < AbstractCommand
 
-case ARGV[0]
-  when "create"
-    case ARGV[1]
-      when /\w/
-        project = ProjectCreator.new ARGV[1]
-        project.create
-      else
-        usage
+    def execute
+      compiler = Compiler.new Dir.getwd
+      compiler.compile
     end
-  when "compile", "cc"
-    compiler = Compiler.new Dir.getwd
-    compiler.compile
-  else
-    usage
+    
+  end
+  
+  class MainCommand < AbstractCommand
+    
+    subcommand "create", "Create a project.", CreateCommand
+    subcommand "compile", "Compile the web site.", CompileCommand
+    subcommand "cc", "Compile the web site.", CompileCommand
+
+  end
+
 end
+
+Genit::MainCommand.run

data/data/pages/index.html

@@ -1,6 +1,28 @@
 <h1>Welcome to Genit !</h1>
 
 <p>
-This is a generated index page. Change it as you want
-to suit your needs.
+Genit is a framework to build a <strong>static web site</strong>, that is a web site without server 
+side programing language and database. A genit site consists only of xhtml code (+ css, medias and 
+eventually javascript).
+</p>
+
+<p>
+<em>Genit is written in Ruby but there is no needs to know the Ruby language.</em>
+</p>
+
+<p>
+The Genit project is hosted on 
+<a href="https://github.com/lkdjiin/genit" title="Source code of Genit">GitHub</a> under the terms 
+of the MIT license. Feel free to fork it. Each new release will be announced on the 
+<a href="http://freshmeat.net/projects/genit" title="Genit project on freshmeat">freshmeat</a> site.
+The development progress will be announced on Twitter:<br/>
+<a href="http://twitter.com/lkdjiin" class="twitter-follow-button" data-show-count="false">Follow @lkdjiin</a>
+<script src="http://platform.twitter.com/widgets.js" type="text/javascript"></script>
+</p>
+
+<h1>Get started</h1>
+
+<p>
+Read the <a href="https://github.com/lkdjiin/genit/blob/master/documentation/tutorial.markdown"
+"A short get started tutorial for Genit">tutorial</a> and make your site !
 </p>

data/data/styles/screen.css

@@ -1 +1,26 @@
-/* Write your rules */
+/* Delete this content and write your own rules */
+
+body {
+width:600px;
+margin:0 auto;
+font-family: Arial, Helvetica, FreeSans, sans-serif;
+}
+
+#menu { display:none;}
+
+p {
+font-size:1.2em;
+color:#555;
+}
+
+p:hover {color:#001;}
+
+p:hover a {
+background-color:#001 !important;
+color:white !important;
+text-decoration:none !important;
+}
+
+a {
+color:#334 !important;
+}

data/data/templates/menu.html

@@ -1,5 +1,4 @@
 <ul id="menu">
   <li><a href="index.html">home</a></li>
-  <li><a href="help.html">help</a></li>
 </ul>
 

data/lib/genit/compiler.rb

@@ -16,12 +16,24 @@ module Genit
   
     # Public: Compile the web site.
     def compile
-      compile_pages
-      FileUtils.cp_r File.join(@working_dir, 'styles'), File.join(@working_dir, 'www')
+      if genit_project_folder?
+        compile_site
+      else
+        puts 'Not a genit project folder'
+      end
     end
     
     private
     
+    def genit_project_folder?
+      File.exist?(File.join(@working_dir, '.genit'))
+    end
+    
+    def compile_site
+      compile_pages
+      FileUtils.cp_r File.join(@working_dir, 'styles'), File.join(@working_dir, 'www')
+    end
+    
     def compile_pages
       Dir.foreach(File.join(@working_dir, 'pages')) do |file|
         next if (file == ".") or (file == "..")

data/lib/genit/project_creator.rb

@@ -20,16 +20,17 @@ module Genit
     # Returns nothing.
     def create
       begin
-				FileUtils.makedirs @name
-        create_dirs ['fragments', 'news', 'pages', 'scripts', 'styles', 'templates', 'www']
-        create_dirs ['styles/alsa', 'styles/yui', 'styles/images']
+        FileUtils.makedirs @name
+        create_dirs ['fragments', 'news', 'pages', 'scripts', 'styles', 'templates', 'www',
+                     'styles/alsa', 'styles/yui', 'styles/images']
         copy_files ['templates/main.html', 'templates/menu.html',
                     'pages/index.html', 'styles/handheld.css', 'styles/print.css',
                     'styles/screen.css', 'styles/alsa/all.css', 'styles/yui/all.css', 'styles/yui/base.css',
                     'styles/yui/fonts.css', 'styles/yui/reset.css']
-			rescue SystemCallError
-				puts "Cannot create project..."
-			end
+        FileUtils.touch "#{@name}/.genit"
+      rescue SystemCallError
+        puts "Cannot create project..."
+      end
     end
     
     private

data/spec/compiler_spec.rb

@@ -19,7 +19,7 @@ describe Compiler do
       file.puts content
     end
   end
-
+  
   it "should build an index.html page in www" do
     @compiler.compile
     File.exist?('spec/project-name/www/index.html').should == true
@@ -31,7 +31,7 @@ describe Compiler do
     File.exist?('spec/project-name/www/index.html').should == true
     File.exist?('spec/project-name/www/doc.html').should == true
   end
-  
+    
   it "should copy the styles/ into www/" do
     File.exist?('spec/project-name/www/styles/screen.css').should be_true
   end
@@ -42,4 +42,10 @@ describe Compiler do
     doc.at_css("ul#menu a#selected")['href'].should == 'index.html'
   end
   
+  it "should take care of the hidden project file" do
+    compiler = Compiler.new File.expand_path('.')
+    $stdout.should_receive(:puts).with("Not a genit project folder")
+    compiler.compile
+  end
+  
 end

data/spec/project_creator_spec.rb

@@ -13,8 +13,8 @@ describe ProjectCreator do
     clean_test_repository
   end
   
-  describe "Folder structure" do
-
+  describe "Project folder" do
+    
     it "should create a project folder" do
       File.exist?('spec/project-name').should == true
     end
@@ -24,6 +24,14 @@ describe ProjectCreator do
       $stdout.should_receive(:puts).with("Cannot create project...")
       project.create
     end
+    
+    it "should create a project file" do
+      File.exist?('spec/project-name/.genit').should == true
+    end
+    
+  end
+  
+  describe "Folder structure" do
 
     it "should create a news folder" do
       File.exist?('spec/project-name/news').should == true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: genit
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: '0.4'
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-23 00:00:00.000000000 +02:00
+date: 2011-07-25 00:00:00.000000000 +02:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coco
-  requirement: &75668220 !ruby/object:Gem::Requirement
+  requirement: &80775510 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 0.4.2
   type: :runtime
   prerelease: false
-  version_requirements: *75668220
+  version_requirements: *80775510
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &75643120 !ruby/object:Gem::Requirement
+  requirement: &80775070 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: 1.4.6
   type: :runtime
   prerelease: false
-  version_requirements: *75643120
+  version_requirements: *80775070
 - !ruby/object:Gem::Dependency
   name: bluecloth
-  requirement: &75642670 !ruby/object:Gem::Requirement
+  requirement: &80774600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +44,18 @@ dependencies:
         version: 2.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *75642670
+  version_requirements: *80774600
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: &80774180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.2.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *80774180
 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,