clay 1.6 → 1.7

data/README.md

@@ -31,7 +31,8 @@ In your project directory You will find following subdirectories
 
 * layouts
 * pages
-* public
+* static
+* texts
    
 The _layouts_ directory is for the global layouts of your pages. 
 There must be a layout called default.html
@@ -40,11 +41,42 @@ In the _pages_ directory You create each page You want to have.
 The pages are created in html or markdown.
 The filename of an html page must be <pagename>.html 
 Markdown pages however can be either <pagename>.md or <pagename>.markdown
-	 
+
 *NOTE* Your pages may have any names You want. However given your domain 
 name is foo.com, and You want that the main page shows up at http://foo.com
 You will have to create page named index in the pages directory
 
+The static files like css stylesheets, javascript files and images/videos
+all should be placed in the _static_ folder. 
+
+The _texts_ is a directory, in which You can create the texts with images, 
+which will then be available to the layouts and the pages. 
+A text file in _texts_ directory must be written in 
+[markdown](http://daringfireball.net/projects/markdown/) and have the extension
+of either .md or .markdown in order to be used. You can then use any text with
+filename *some-article.md* as *{{{text-some-article}}}* in Your pages. Please
+note, that in pages or layouts You should do a tripple brackets, otherwise
+the tags will be escaped and You will see html instead of nice formatted text.
+
+## Configurations
+
+Clay can be configured to behave specifically to Your development needs.
+To use this, You can create config.yaml in your project directory with 
+following options:
+
+* `autoreload: true|false` - This option will autoreload Your site, when you run it via
+  `clay run` and something changes in pages, layouts, texts or static files.
+  This way You can just update the files and immediately see the changes
+  when You reload the page. This is very useful for the page development 
+  or when You write some text and want to see how does it actually look 
+  like on the page.
+
+* `target_dir: <custom/target/directory>` - This option makes clay generate the site into
+  a specific location. For example a pubic directory. This directory can be then served
+  by a webserver. This way one can install clay on a remote server and update the site
+  on the fly. It also provides more flexibility in choosing the place of output.
+  Please make sure, that the target is writable.
+	
 ----------------------------------------
 
 ## Licence

data/src/clay.rb

@@ -6,29 +6,42 @@ require 'fileutils'
 require 'yaml'
 
 module Clay
-  VERSION = "1.6"
+  VERSION = "1.7"
   
-  def self.init project_name
-    puts "Creating the folder structure... "
-    project.init project_name
-    puts "OK."
+  def self.init project_name, silent=false
+    mute(silent) {
+      puts "Creating the folder structure... "
+      project.init project_name
+      puts "OK."
+    }
   end
   
-  def self.form
-    puts "Forming... "
-    project.check_consistency
-    project.build
-    puts "OK."
+  def self.form silent=false
+    mute(silent){
+      puts "Forming... "
+      project.check_consistency
+      project.build
+      puts "OK."
+    }
   end
   
-  def self.run
-    puts "Starting server on http://localhost:9292/"
-    project.prepare_rack_config
-    `rackup config.ru`
+  def self.run silent=false
+    mute(silent) {
+      puts "Starting server on http://localhost:9292/"
+      project.prepare_rack_config
+      exec "rackup config.ru"
+    }
   end
 
   private
 
+  def self.mute silent
+    stdout = STDOUT.dup
+    $stdout.reopen(File.open("/dev/null", "w")) if silent
+    yield
+    $stdout.reopen(stdout)
+  end
+  
   def self.project
     Project.new project_root
   end
@@ -53,16 +66,17 @@ class Project
   end
 
   def check_consistency
-    init_clay_project? and layouts_exist? and pages_exist? and public_exist?
+    init_clay_project? and layouts_exist? and pages_exist? and static_exist? and texts_exist?
   end
     
   def build
-    unless File.directory?(path("build"))
-      create_directory path("build")
+    target = configs["target_dir"] ? configs["target_dir"] : "build"
+    unless File.directory?(path(target))
+      create_directory path(target)
     end
-    publish_public
+    publish_static target
     texts = interpret_texts
-    publish_pages texts
+    publish_pages target, texts
   end
     
   def prepare_rack_config
@@ -72,8 +86,17 @@ class Project
       file.close
     end
   end
+
+  def configs
+    result = YAML.load(File.read(path("config.yaml")))
+    conf_options = result.keys - ["autoreload", "target_dir"]
+    raise "ERROR in config.yaml" if conf_options.length > 0
+    result
+  rescue Errno::ENOENT
+    {}
+  end
   
-  private
+private
   
   def init_clay_project?
     `touch #{path(".clay")}` unless File.exists? path(".clay")
@@ -87,8 +110,12 @@ class Project
     create_directory path("pages")
   end
 
-  def public_exist?
-    create_directory path("public")
+  def static_exist?
+    create_directory path("static")
+  end
+
+  def texts_exist?
+    create_directory path("texts")
   end
   
   def create_directory dirname
@@ -103,8 +130,8 @@ class Project
     end
   end
 
-  def publish_public
-    FileUtils.cp_r(Dir.glob("public/*"), "build")
+  def publish_static target
+    FileUtils.cp_r(Dir.glob("static/*"), target)
   end
   
   def interpret_texts
@@ -120,10 +147,10 @@ class Project
     data
   end
 
-  def publish_pages data=nil
+  def publish_pages target, data=nil
     Dir.glob("pages/*.*").each { |page_path|
       begin
-        page = Page.new(page_path, data)
+        page = Page.new(page_path, target, data)
         File.open(page.target, "w") {|f| f.write page.content }
       rescue RuntimeError => e
         puts "Warning: ", e.message
@@ -139,12 +166,13 @@ end
 
 class Page
   attr_reader :content
-  def initialize filename, data=nil
+  def initialize filename, target=nil, data=nil
     case filename.split(".").last
     when "md", "markdown" then @page_type = "markdown"
     when "html" then @page_type = "html"
-    else raise "File type of #{filename} unknown. Shouldn\'t it be in the public directory?"
+    else raise "File type of #{filename} unknown. Shouldn\'t it be in the static directory?"
     end
+    @target = target.nil? ? "build" : target
     @filename = filename_within_pages filename
     file_content = File.read(filename)
     data ||= {}
@@ -155,7 +183,7 @@ class Page
   
   def target
     file_base = @filename.split(".")[0..-2].join('.')
-    "build/#{file_base}.html"
+    "#{@target}/#{file_base}.html"
   end
   
 private

data/src/rack/clay.rb

@@ -12,19 +12,13 @@ module Rack
       if ::File.exist?(@configfile)
         puts "Reading configs... "
         @config = ::YAML.load(::File.read(@configfile))
-        @config = (@config.class == FalseClass ? {} : @config)
-        if @config[:destination].nil?
-          @path = opts[:destination].nil? ? "build" : opts[:destination]
-        else
-          opts.merge!(@config)
-          @path = @config[:destination].nil? ? "build" : @config[:destination]
-        end
+        @config = @config ? @config : {} 
         puts @config.inspect
         puts "Ready."
       end
 
       @path = "build"
-      @path = @config["build_path"] if @config["build_path"]
+      @path = @config["target_dir"] if @config["target_dir"]
       @mimes = Rack::Mime::MIME_TYPES.map{|k,v| /#{k.gsub('.','\.')}$/i }
     end
     def call(env)
@@ -82,11 +76,11 @@ module Rack
         new_file_hashes = get_file_hashes
         changes = compare_file_hashes old_file_hashes, new_file_hashes.to_json
         unless changes
-          begin                                   
-            require 'clay'                        
-            ::Clay.form                           
-          rescue LoadError                        
-            raise "Could not load clay"
+          begin
+            require 'clay'
+            ::Clay.form
+          rescue LoadError
+            raise "Could not load clay. Please reinstall: [sudo] gem install clay"
           end
         end
         ::File.open(clayfile, "w") {|f| f.write(new_file_hashes.to_json)}
@@ -94,6 +88,7 @@ module Rack
     end
 
     def get_file_hashes
+      return {"Build_Path_Is_Empty"=>true} unless ::File.exists? @path
       files = ::Dir.glob("**/*") - [@path] - ::Dir.glob(@path + "/**/*")
       file_hashes_array = files.map {|filename| [filename, file_hash(filename)]}
       file_hashes = Hash[*file_hashes_array.flatten]

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: clay
 version: !ruby/object:Gem::Version 
-  hash: 3
+  hash: 1
   prerelease: 
   segments: 
   - 1
-  - 6
-  version: "1.6"
+  - 7
+  version: "1.7"
 platform: ruby
 authors: 
 - Pavlo Kerestey
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-03 00:00:00 +01:00
+date: 2011-01-11 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -107,7 +107,41 @@ has_rdoc: true
 homepage: http://github.com/kerestey/clay
 licenses: []
 
-post_install_message: 
+post_install_message: |
+  **************************************************
+  
+    Dear User, Thank you for installing clay - a lightweight cms for static websites.
+  
+    IMPORTANT CHANGES WITH THIS RELEASE (ver. 1.7): 
+    directory public changed to be static Please rename Your project structure 
+    to incorporate this change. This had to be done because of the way some 
+    ruby webservers (like passenger for example) deal with the public directory.
+    If You want to further use passenger or nginx to serve your site, You can
+    leave the public directory intact. Just move its contents to the static
+    directory, so the files will be copied over to the build directory when
+    forming the site.
+  
+    Additionally You can now specify the build directory in config.yaml file
+    by adding build_directory: "/path/to/the/build/dir". Your site will be 
+    served out of this directory when You run $ clay run
+  
+    These Changes will allow to use passenger and putting the built site into
+    the public directory so they are served by fast webservers like nginx or
+    apache.
+  
+    The users who do not want to change anything, don't worry. All Your data
+    will stay intact. You have to manually change your config.yaml to actually
+    make the public directory be the build target location.
+  
+    Please be sure to look at the CHANGES to see what might have changed since 
+    the last release:
+  
+    https://github.com/kerestey/clay/blob/master/CHANGES.md
+  
+    And happy New Year by the way :)
+  
+  **************************************************
+
 rdoc_options: []
 
 require_paths: 
@@ -135,9 +169,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: clay
-rubygems_version: 1.4.1
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
-summary: A very lightweight CMS to automatically form a static website.
+summary: A lightweight CMS for static websites
 test_files: []