static_cms 0.0.0

data/README.rdoc

@@ -0,0 +1,17 @@
+= StaticCms
+
+== Description
+Simple Static HTML file generation based on Haml and Sass.
+
+== Features
+StaticCMS is a very small and simple contents management system based on YAML, Haml and Sass.
+
+== Usage
+Please type
+  static_cms init DIR
+on the command line to initialize DIR directory as a working directory of the StaticCms.
+Please goto DIR and type
+  rake
+on the command line to generate site or
+  rake PAGE_NAME
+to generate individual pages.

data/bin/static_cms

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'static_cms'
+::StaticCms::Runner.start

data/data/site_template/.gitignore

@@ -0,0 +1 @@
+root

data/data/site_template/articles/news.html.yhaml

@@ -0,0 +1,6 @@
+---
+title: News
+...
+%dl
+  %dt 120930
+  %dd Launch the website.

data/data/site_template/articles/short_profile.html.yhaml

@@ -0,0 +1,6 @@
+---
+title: Profile (Short Version)
+...
+%dl
+  %dt Name
+  %dd John Smith

data/data/site_template/config.yaml

@@ -0,0 +1,8 @@
+---
+lang: ja
+www: .                          # http://www.john_smith.com
+dir: root                       # john@smith:~/www
+author: John Smith
+robots: noarchive
+favicon: images/favicon.png
+charset: utf-8

data/data/site_template/pages.yaml

@@ -0,0 +1,18 @@
+---
+.:
+  title: Jon Smith's Website
+  articles:
+    - news
+    - short_profile
+  statics:
+    - ht_files/top/.htaccess
+  sources:
+    - default.css.sass
+stylesheets:
+  template: blank
+  sources:
+    - default.css.sass
+images:
+  template: blank
+  statics:
+    - favicon.png

data/data/site_template/rakefile

@@ -0,0 +1,17 @@
+require 'static_cms'
+
+::SITE = StaticCms::Site.new
+task default: :generate
+desc "Generate all pages."
+task generate: SITE.pages.map(&:name)
+
+::SITE.pages.each{|page|
+  task page.name do
+    page.generate
+  end
+}
+
+desc "Update templates, sources, statics (and more)."
+task :update do
+  ::StaticCms::Command.update
+end

data/data/site_template/statics/ht_files/top/.htaccess

@@ -0,0 +1,10 @@
+AddType image/svg+xml .svg
+DirectoryIndex index.html .forbidden_directive
+<Files ~ "^\.">
+  deny from all
+</Files>
+<Files ~ "(~|#|\.log)$">
+  deny from all
+</Files>
+order allow,deny
+allow from all

data/data/site_template/templates/blank.html.haml

@@ -0,0 +1,6 @@
+!!! 5
+%html{lang: :en}
+  = haml(File.read('templates/head.html.haml'))
+  %body
+    This page is intentionally left blank.
+    %a{href: @site.www} Please go to the top page.

data/data/site_template/templates/default.html.haml

@@ -0,0 +1,10 @@
+!!! 5
+%html{lang: @site.lang}
+  = haml(File.read('templates/head.html.haml'))
+  %link{rel: :stylesheet, href: "stylesheets/default.css", type: "text/css"}
+  %body
+    - @articles.each do |article|
+      %article{id: article.name}
+        %header
+          %h1= article.title
+        = haml(article.data)

data/data/site_template/templates/head.html.haml

@@ -0,0 +1,7 @@
+%head
+  %meta{charset: @site.charset}
+  %base{href: @base}
+  %link{rel: :icon, href: @site.favicon}
+  %meta{name: :author, content: @site.author}
+  %meta{name: :robots, content: @site.robots}
+  %title= @title

data/data/site_template/templates/moved.html.haml

@@ -0,0 +1,6 @@
+!!! 5
+%html{lang: :en}
+  = haml(File.read('templates/head.html.haml'))
+  %body
+    Contents of this page have moved or removed.
+    %a{href: @site.www} Please go to the top page.

data/lib/static_cms/version.rb

@@ -0,0 +1,3 @@
+module ::StaticCms
+  VERSION = '0.0.0'
+end

data/lib/static_cms.rb

@@ -0,0 +1,170 @@
+module StaticCms
+  require 'fileutils'
+  require 'ruby_patch'
+
+  SITE_TEMPLATE_DIR = File.join(__DIR__, '../data/site_template')
+
+  module Command
+    def self.init(dir = '.')
+      FileUtils.mkdir_p(dir)
+      success = false
+      FileUtils.cd(dir){|dir|
+        success = system <<-EOS
+git init > #{File::NULL}
+git commit --allow-empty -m 'Empty commit.' > #{File::NULL}
+cp -r #{File.join(SITE_TEMPLATE_DIR, '*')} . > #{File::NULL}
+git add . > #{File::NULL}
+git commit -m 'Copied from site template.' > #{File::NULL}
+        EOS
+      }
+
+      success
+    end
+
+    def self.update
+      site_template_dir = File.join(__DIR__, '../data/site_template')
+      FileUtils.cp_r(File.join(site_template_dir, 'templates'), '.')
+      FileUtils.cp_r(File.join(site_template_dir, 'sources'), '.')
+      FileUtils.cp_r(File.join(site_template_dir, 'statics'), '.')
+      FileUtils.cp(File.join(site_template_dir, 'rakefile'), '.')
+    end
+  end
+
+  class Site
+    require 'yaml'
+
+    CONFIG_DEFAULT = {
+      'lang' => 'en',
+      'www' => '.',
+      'dir' => File.join(__DIR__, 'root'),
+      'author' => '',
+      'robots' => 'noarchive',
+      'favicon' => 'images/favicon.png',
+      'charset' => 'utf-8',
+    }
+
+    attr_accessor :pages
+    attr_accessor *(CONFIG_DEFAULT.keys)
+
+    def initialize
+      @pages = YAML.load_file('pages.yaml')\
+        .to_a.map{|name, params| ::StaticCms::Page.new(self, name, params)}
+      config = CONFIG_DEFAULT.merge(YAML.load_file('config.yaml'))
+      config.each{|k, v| instance_variable_set("@#{k}", v)}
+    end
+  end
+
+  class Page
+    require 'fileutils'
+    require 'haml'
+
+    PARAMS_DEFAULT ={
+      'visible' => true,
+      'titile' => '',
+      'template' => 'default',
+      'articles' => [],
+      'statics' => [],
+      'sources' => [],
+      'base' => ::StaticCms::Site::CONFIG_DEFAULT['www'],
+    }
+
+    attr_accessor :site, :name, :dir
+    attr_accessor *(PARAMS_DEFAULT.keys)
+
+    def initialize(site, name, params = {})
+      @site = site
+      @name = name
+      @dir = File.join("root", @name)
+      params = PARAMS_DEFAULT.merge(params)
+      @template = File.join('templates', params.delete('template')) + '.html.haml'
+      @articles = params.delete('articles').map{|name| ::StaticCms::Article.new(name)}
+      @statics = params.delete('statics').map{|file| File.join('statics', file)}
+      @sources = params.delete('sources').map{|file| File.join('sources', file)}
+      params.each{|k, v|
+        instance_variable_set("@#{k}", v)
+      }
+    end
+
+    def generate
+      FileUtils.mkdir_p @dir
+
+      if @visible
+        @statics.each{|file| cp_if_new(file)}
+        @sources.each{|file| compile(file)}
+        template = @template
+      else
+        @statics.each{|file| FileUtils.rm_rf(static_target(file))}
+        @sources.each{|file| FileUtils.rm_rf(compile_target(file))}
+        template = 'templates/moved.html.haml'
+      end
+
+      html = ::Haml::Engine.new(File.read(template)).render(self)
+      target = File.join(@dir, 'index.html')
+      open(target, 'w'){|io|
+        io.write(html)
+        io.flush
+        io.fsync
+      }
+    end
+
+    private
+
+    def haml(text)
+      ::Haml::Engine.new(text).render(self)
+    end
+
+    def cp_if_new(source)
+      target = static_target(source)
+      if !File.file?(target) || File.mtime(source) > File.mtime(target)
+        FileUtils.cp(source, target)
+        FileUtils.chmod(0644, target)
+      end
+    end
+
+    def compile(source)
+      ext = File.extname(source)
+      target = compile_target(source)
+
+      case ext
+      when /\A\.sass\z/
+        system "sass #{source} > #{target}"
+      else
+        raise NotImplementedError, file
+      end
+    end
+
+    def static_target(source)
+      File.join(@dir, File.basename(source))
+    end
+
+    def compile_target(source)
+      ext = File.extname(source)
+      File.join(@dir, File.basename(source, ext))
+    end
+  end
+
+  class Article
+    PARAMS_DEFAULT = {
+      'title' => '',
+    }
+
+    attr_accessor :name, :file, :data
+    attr_accessor *(PARAMS_DEFAULT.keys)
+
+    def initialize(name)
+      @name = name
+      @file = File.join('articles', name) + '.html.yhaml'
+      yaml, @data = File.read(@file).split(/^\.\.\.$/, 2)
+      params = PARAMS_DEFAULT.merge(YAML.load(yaml))
+      params.each{|k, v| instance_variable_set("@#{k}", v)}
+    end
+  end
+
+  require 'thor'
+  class Runner < Thor
+    desc "init [DIR]", "Initialize DIR directory for StaticCms [default: .]."
+    def init(dir = '.')
+      ::StaticCms::Command.init(dir)
+    end
+  end
+end

data/rakefile

@@ -0,0 +1,10 @@
+require 'ruby_patch'
+require 'rake/testtask'
+
+task default: [:test]
+
+desc "Run tests."
+::Rake::TestTask.new do |t|
+  t.libs = ['lib', 'test'].map{|dir| File.join(__DIR__, dir)}
+  t.pattern = "test/**/test_*.rb"
+end

data/static_cms.gemspec

@@ -0,0 +1,17 @@
+require "./lib/static_cms/version"
+
+Gem::Specification.new do |s|
+  s.files = `git ls-files`.split
+  s.name = 'static_cms'
+  s.summary = "Simple static contents management system."
+  s.version = StaticCms::VERSION
+  s.add_runtime_dependency 'haml', '~> 3.1'
+  s.add_runtime_dependency 'sass', '~> 3.2'
+  s.add_runtime_dependency 'ruby_patch', '~> 1.1'
+  s.add_runtime_dependency 'thor', '~> 0.16'
+  s.author = 'kshramt'
+  s.description = "Simple static contents management system based on Haml and Sass."
+  s.required_ruby_version = '~> 1.9'
+  s.test_files.concat `git ls-files test`.split.select{|path| path =~ /test_[^\/]*\.rb/}
+  s.executables << 'static_cms'
+end

data/test/helper_for_test.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+
+require 'static_cms'

data/test/test_generate.rb

@@ -0,0 +1,11 @@
+require 'helper_for_test'
+require 'fileutils'
+require 'ruby_patch'
+
+class TestGenerate < ::MiniTest::Unit::TestCase
+  def test_generate
+    FileUtils.cd(File.join(__DIR__, '../data/site_template')){
+      assert system "rake -I ../../lib"
+    }
+  end
+end

data/test/test_init.rb

@@ -0,0 +1,9 @@
+require 'helper_for_test'
+
+class TestInitAndGenerate < ::MiniTest::Unit::TestCase
+  require 'tmpdir'
+
+  def test_init
+    assert ::StaticCms::Command.init(Dir.mktmpdir)
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: static_cms
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- kshramt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: haml
+  requirement: &81251070 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *81251070
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: &81175110 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *81175110
+- !ruby/object:Gem::Dependency
+  name: ruby_patch
+  requirement: &81173090 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: *81173090
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &81172130 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: *81172130
+description: Simple static contents management system based on Haml and Sass.
+email: 
+executables:
+- static_cms
+extensions: []
+extra_rdoc_files: []
+files:
+- README.rdoc
+- bin/static_cms
+- data/site_template/.gitignore
+- data/site_template/articles/news.html.yhaml
+- data/site_template/articles/short_profile.html.yhaml
+- data/site_template/config.yaml
+- data/site_template/pages.yaml
+- data/site_template/rakefile
+- data/site_template/sources/default.css.sass
+- data/site_template/statics/favicon.png
+- data/site_template/statics/ht_files/top/.htaccess
+- data/site_template/templates/blank.html.haml
+- data/site_template/templates/default.html.haml
+- data/site_template/templates/head.html.haml
+- data/site_template/templates/moved.html.haml
+- lib/static_cms.rb
+- lib/static_cms/version.rb
+- rakefile
+- static_cms.gemspec
+- test/helper_for_test.rb
+- test/test_generate.rb
+- test/test_init.rb
+homepage: 
+licenses: []
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Simple static contents management system.
+test_files:
+- test/test_generate.rb
+- test/test_init.rb
+has_rdoc: