genit 0.1

data/NEWS

@@ -0,0 +1,7 @@
+v0.1  2011-06-25
+
+  * Create a project
+  
+  * Compile a project (one template, multiple pages)
+  
+  * A page can be in html or in markdown format

data/README.markdown

@@ -0,0 +1,100 @@
+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.
+
+The project is in early development stage, see
+[project guidelines](https://github.com/lkdjiin/genit/blob/master/project_guidelines.markdown).
+
+Description
+-----------
+
+It is a command line framework, essentially based on conventions.
+
+Genit must above all be :
+
+  + **simple**
+  + **readable**
+  + **minimalist**
+
+Genit is based on the idea that *we don't have* to learn any new languages to manage templates
+because **xml can do it well**.
+
+For example, to generate the xhtml including the 4 latest news:
+
+    <generate class="news" number="4" />
+
+And more simply, to generate the footer:
+
+    <generate class="footer" />
+
+
+Install
+-------------------------
+
+First install ruby and rubygem (if there are not installed on your system) then:
+
+    gem install genit
+
+
+Usage
+--------------------------
+
+    genit create my-site
+    cd my-site
+(*edit some pages*)
+
+    genit compile
+
+Take a look at the [tutorial](https://github.com/lkdjiin/genit/blob/master/documentation/tutorial.markdown) 
+for more information.
+
+
+Dependencies
+--------------------------
+
+  * ruby >= 1.9.2
+  
+  * nokogiri (xml parser)
+  * bluecloth (markdown parser)
+
+### Contributors dependencies
+
+  * rspec for tests
+  * [coco](https://github.com/lkdjiin/coco) (code coverage must be 90% minimum)
+  * [tomdoc](http://tomdoc.org/) to document your code
+
+
+License
+--------------------------
+
+Expat License (also known as MIT)
+
+    Copyright (c) 2011 Xavier Nayrac
+
+    Permission is hereby granted, free of charge, to any person obtaining
+    a copy of this software and associated documentation files (the
+    "Software"), to deal in the Software without restriction, including
+    without limitation the rights to use, copy, modify, merge, publish,
+    distribute, sublicense, and/or sell copies of the Software, and to
+    permit persons to whom the Software is furnished to do so, subject to
+    the following conditions:
+
+    The above copyright notice and this permission notice shall be included
+    in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+    IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+    TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+    SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+Questions and/or Comments
+--------------------------
+
+Feel free to email [Xavier Nayrac](mailto:xavier.nayrac@gmail.com)
+with any questions.

data/Rakefile

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc 'Test genit'
+task :default => :spec
+
+desc 'Test genit with rspec'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_opts = ['--color --format documentation']
+end
+
+desc 'Check for code smells'
+task :reek do
+  puts 'Checking for code smells...'
+  files = Dir.glob 'lib/**/*.rb'
+  # files.delete FILE_TO_EXCLUDE
+  args = files.join(' ')
+  sh "reek --quiet #{args} | ./reek.sed"
+end
+
+desc 'Build genit & install it'
+task :install do
+  sh "gem build genit.gemspec"
+	f = FileList['genit*gem'].to_a
+	sh "gem install #{f.first} --no-rdoc --no-ri"
+end

data/TODO

@@ -0,0 +1,11 @@
+push gem
+
+essayer quickl
+
+freshmeat: v0.1
+------------------
+i18n
+
+per page style
+
+per page script

data/VERSION

@@ -0,0 +1 @@
+0.1

data/bin/genit

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+#Copyright (c) 2011 Xavier Nayrac
+#
+#Permission is hereby granted, free of charge, to any person obtaining
+#a copy of this software and associated documentation files (the
+#"Software"), to deal in the Software without restriction, including
+#without limitation the rights to use, copy, modify, merge, publish,
+#distribute, sublicense, and/or sell copies of the Software, and to
+#permit persons to whom the Software is furnished to do so, subject to
+#the following conditions:
+#
+#The above copyright notice and this permission notice shall be included
+#in all copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+#EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+#MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+#IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+#CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+#TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+#SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+$GENIT_PATH = File.expand_path(File.dirname(__FILE__)) + '/..'
+
+require 'genit'
+include Genit
+
+def usage
+  puts %q{usage: genit command
+
+where command is:
+  create project-name
+  compile | cc}
+end
+
+case ARGV[0]
+  when "create"
+    case ARGV[1]
+      when /\w/
+        project = ProjectCreator.new ARGV[1]
+        project.create
+      else
+        usage
+    end
+  when "compile", "cc"
+    compiler = Compiler.new Dir.getwd
+    compiler.compile
+  else
+    usage
+end

data/data/pages/index.html

@@ -0,0 +1,6 @@
+<h1>Welcome to Genit !</h1>
+
+<p>
+This is a generated index page. Change it as you want
+to suit your needs.
+</p>

data/data/templates/main.html

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html 
+     PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+    "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>
+  </head>
+  <body>
+    <genit class="pages" />
+  </body>
+</html>

data/lib/genit.rb

@@ -0,0 +1,10 @@
+# -*- encoding: utf-8 -*-
+
+require 'genit/project_creator'
+
+require 'genit/html_document'
+require 'genit/compiler'
+require 'genit/builder'
+
+module Genit
+end

data/lib/genit/builder.rb

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+require 'nokogiri'
+
+module Genit
+
+  # Build a document from various sources.
+  class Builder
+  
+    # Public: Constructor.
+    #
+    # document - A Nokogiri::HTML document
+    def initialize document
+      @document = document
+    end
+    
+    # Public: Replace a tag (and its children) from the current document by a 
+    # string.
+    #
+    # css_rule    - The String css rule to find the tag
+    # replacement - The replacement String
+    #
+    # Examples
+    #
+    #   doc = builder.replace('genit.pages', "<working />")
+    #
+    # Return the changed Nokogiri::HTML document.
+    def replace css_rule, replacement
+      tag = @document.at_css(css_rule)
+      tag.replace replacement
+      @document
+    end
+    
+  end
+  
+end

data/lib/genit/compiler.rb

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+
+module Genit
+
+  # Build the web site.
+  class Compiler
+  
+    # Public: Constructor.
+    #
+    # working_dir - The String working directory, where live the project.
+    def initialize working_dir
+      @working_dir = working_dir
+    end
+  
+    # Public: Build the web site.
+    def compile
+      Dir.foreach(File.join(@working_dir, 'pages')) do |file|
+        next if (file == ".") or (file == "..")
+        process file
+      end
+    end
+    
+    private
+    
+    def process file
+      load_files file
+      build_file
+      write_file file
+    end
+    
+    def load_files file
+      @template = HtmlDocument.open(File.join(@working_dir, 'templates/main.html'))
+      @page_content = HtmlDocument.open_as_string(File.join(@working_dir, 'pages', file))
+    end
+    
+    def build_file
+      builder = Builder.new(@template)
+      @template = builder.replace('genit.pages', @page_content)
+    end
+    
+    def write_file file
+      file.gsub! /\.markdown$/, '.html'
+      File.open(File.join(@working_dir, 'www', file), "w") do |out| 
+        out.puts @template.to_html
+      end
+    end
+    
+  end
+  
+end

data/lib/genit/html_document.rb

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+require 'nokogiri'
+require 'bluecloth'
+
+module Genit
+
+  # Open an html file in various format.
+  class HtmlDocument
+  
+    # Public: Open a html document.
+    #
+    # file - Full path String filename
+    #
+    # Returns a Nokogiri::HTML document
+    def self.open file
+      Nokogiri::HTML(File.open(file))
+    end
+    
+    # Public: Open a html or markdown 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
+    end
+    
+  end
+
+end

data/lib/genit/project_creator.rb

@@ -0,0 +1,68 @@
+# -*- encoding: utf-8 -*-
+
+require "fileutils"
+
+module Genit
+
+  # Create a skeleton project.
+  class ProjectCreator
+  
+    # Sole constructor.
+    #
+    # name  - The String name of the future project folder.
+    def initialize name
+      @name = name
+    end
+    
+    # Public: Create the structure of the project, that is many
+    # files and folders.
+    #
+    # Returns nothing.
+    def create
+      begin
+				FileUtils.makedirs @name
+        create_dirs ['news', 'pages', 'scripts', 'styles', 'templates', 'www']
+        create_dirs ['styles/css', 'styles/css/alsa', 'styles/css/yui', 'styles/images']
+        copy_files ['templates/main.html', 'pages/index.html']
+			rescue SystemCallError
+				puts "Cannot create project..."
+			end
+    end
+    
+    private
+    
+    # Create some subfolders inside the project folder.
+    #
+    # a_array - An Array of String subfolder names
+    #
+    # Examples
+    #
+    #   create_dirs ['styles', 'scripts']
+    #
+    #   create_dirs ['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) }
+    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 @name, file
+        FileUtils.cp src, dest
+      end
+    end
+    
+  end
+
+end

data/spec/bluecloth_spec.rb

@@ -0,0 +1,12 @@
+# -*- encoding: utf-8 -*-
+
+require './spec/helper'
+require 'bluecloth'
+
+describe "BlueCloth library" do
+
+  it "should convert markdown to html" do
+    BlueCloth.new("#title").to_html.should == '<h1>title</h1>'
+  end
+  
+end

data/spec/builder_spec.rb

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+require './spec/helper'
+
+describe Builder do
+
+  before :all do
+    @template = Nokogiri::HTML(File.open("data/templates/main.html"))
+  end
+
+  it "should replace a css rule by a string" do
+    builder = Builder.new(@template)
+    doc = builder.replace('genit.pages', "<working />")
+    doc.css("body working").size.should == 1
+  end
+  
+end

data/spec/compiler_spec.rb

@@ -0,0 +1,35 @@
+# -*- encoding: utf-8 -*-
+
+require './spec/helper'
+
+describe Compiler do
+
+  before :all do
+    @project = ProjectCreator.new('spec/project-name')
+    @project.create
+    @compiler = Compiler.new File.expand_path('spec/project-name')
+  end
+  
+  after :all 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
+    @compiler.compile
+    File.exist?('spec/project-name/www/index.html').should == 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
+  end
+  
+end

data/spec/helper.rb

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+
+require 'coco'
+
+$GENIT_PATH = File.expand_path(File.join(File.expand_path(File.dirname(__FILE__)), '..'))
+
+require './lib/genit'
+include Genit
+
+TEST_REPOSITORY = 'spec/project-name'
+
+def clean_test_repository
+  Dir.foreach(TEST_REPOSITORY) do |file|
+    next if (file == ".") or (file == "..")
+    filename = File.join(TEST_REPOSITORY, file)
+    FileUtils.remove_dir(filename) if File.directory?(filename)
+    FileUtils.remove_file(filename) if File.file?(filename)
+  end
+end

data/spec/html_document_spec.rb

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+require './spec/helper'
+
+describe HtmlDocument do
+
+  it "should load as a document" do
+    doc = HtmlDocument.open("data/templates/main.html")
+    doc.css("body genit").size.should >= 1
+  end
+  
+  it "should load html as a string" do
+    content = HtmlDocument.open_as_string("data/pages/index.html")
+    content.class.should == String
+    content.size.should > 0
+  end
+  
+  it "should load markdown as a string" do
+    content = HtmlDocument.open_as_string("spec/test-files/test.markdown")
+    content.should == '<h1>title</h1>'
+  end
+  
+end

data/spec/nokogiri_spec.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+require './spec/helper'
+require 'nokogiri'
+
+describe "Nokogiri library" do
+
+  before :all do
+    f = File.open("data/templates/main.html")
+    @doc = Nokogiri::HTML(f)
+    f.close
+  end
+
+  it "should retrieve all genit tag" do
+    @doc.css("body genit").size.should == 1
+  end
+  
+  it "should retrieve a tag" do
+    @doc.at_css("body genit").to_s.should == '<genit class="pages"></genit>'
+  end
+  
+  it "should retrieve class of tag" do
+    @doc.at_css("body genit")['class'].should == "pages"
+  end
+  
+end

data/spec/project_creator_spec.rb

@@ -0,0 +1,90 @@
+# -*- encoding: utf-8 -*-
+
+require './spec/helper'
+
+describe ProjectCreator do
+
+  before :all do
+    @project = ProjectCreator.new('spec/project-name')
+    @project.create
+  end
+  
+  after :all do
+    clean_test_repository
+  end
+  
+  describe "Folder structure" do
+
+    it "should create a project folder" do
+      File.exist?('spec/project-name').should == true
+    end
+    
+    it "should say it if it cannot create a project" do
+      project = ProjectCreator.new('/root/project')
+      $stdout.should_receive(:puts).with("Cannot create project...")
+      project.create
+    end
+
+    it "should create a news folder" do
+      File.exist?('spec/project-name/news').should == true
+    end
+    
+    it "should create a pages folder" do
+      File.exist?('spec/project-name/pages').should == true
+    end
+    
+    it "should create a scripts folder" do
+      File.exist?('spec/project-name/scripts').should == true
+    end
+    
+    it "should create a styles folder" do
+      File.exist?('spec/project-name/styles').should == true
+    end
+    
+    it "should create a templates folder" do
+      File.exist?('spec/project-name/templates').should == true
+    end
+    
+    it "should create a www folder" do
+      File.exist?('spec/project-name/www').should == true
+    end
+    
+    it "should create a css folder inside the styles" do
+      File.exist?('spec/project-name/styles/css').should == true
+    end
+    
+    it "should create a css/alsa folder inside the styles" do
+      File.exist?('spec/project-name/styles/css/alsa').should == true
+    end
+    
+    it "should create a css/yui folder inside the styles" do
+      File.exist?('spec/project-name/styles/css/yui').should == true
+    end
+    
+    it "should create a images folder inside the styles" do
+      File.exist?('spec/project-name/styles/images').should == true
+    end
+  
+  end # "Folder structure"
+  
+  describe "The files" do
+    
+    it "should have got templates/main.html" do
+      File.exist?('data/templates/main.html').should be_true
+    end
+    
+    it "should copy templates/main.html" do
+      File.exist?('spec/project-name/templates/main.html').should be_true
+    end
+  
+    it "should have got pages/index.html" do
+      File.exist?('data/pages/index.html').should be_true
+    end
+    
+    it "should copy pages/index.html" do
+      File.exist?('spec/project-name/pages/index.html').should be_true
+    end
+    
+  end # "The files"
+  
+end

data/spec/test-files/test.markdown

@@ -0,0 +1 @@
+#title

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: genit
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Xavier Nayrac
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-06-25 00:00:00.000000000 +02:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coco
+  requirement: &82179570 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *82179570
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &82179260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *82179260
+- !ruby/object:Gem::Dependency
+  name: bluecloth
+  requirement: &82178960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *82178960
+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,
+  essentially based on conventions.\nGenit is based on the idea that we don't have
+  to learn any new languages to manage templates\nbecause xml can do it well.\nGenit
+  is design to be simple, readable and minimalist."
+email: xavier.nayrac@gmail.com
+executables:
+- genit
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/genit/project_creator.rb
+- lib/genit/html_document.rb
+- lib/genit/builder.rb
+- lib/genit/compiler.rb
+- lib/genit.rb
+- bin/genit
+- data/templates/main.html
+- data/pages/index.html
+- spec/compiler_spec.rb
+- spec/builder_spec.rb
+- spec/helper.rb
+- spec/html_document_spec.rb
+- spec/nokogiri_spec.rb
+- spec/project_creator_spec.rb
+- spec/bluecloth_spec.rb
+- spec/test-files/test.markdown
+- VERSION
+- NEWS
+- README.markdown
+- Rakefile
+- TODO
+has_rdoc: true
+homepage: https://github.com/lkdjiin/genit
+licenses:
+- Expat (also known as MIT)
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Static web site framework
+test_files: []