PlainSite 1.2.0

data/lib/PlainSite.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+#coding:utf-8
+module PlainSite
+  VERSION='1.2.0'
+end

data/lib/PlainSite/Commands.rb

@@ -0,0 +1,76 @@
+# coding:utf-8
+module PlainSite
+  module Commands
+    require 'pp'
+    require 'fileutils'
+    require 'commander/import'
+    require 'PlainSite/Site'
+
+    SELF_DIR=File.dirname(__FILE__)
+
+    def self.die(msg="\nExit now.\n")
+      $stderr.puts msg
+      exit 1
+    end
+
+    def self.run(action,args,opts)
+      root=opts.root || Dir.pwd
+
+      trap('INT') {self.die}
+      trap('TERM') {self.die}
+
+      unless File.exist? root
+        say_error "Site root directory does not exist:#{root}"
+        say_error "Create now? [Y/n]"
+        answer=$stdin.gets.strip.downcase # `agree` cannot set default answer
+        answer='y' if answer.empty?
+        if answer =='y'
+          FileUtils.mkdir_p root
+        else
+          self.die
+        end
+      end
+      root=File.realpath root
+      site=Site.new root
+      self.send action,site,args,opts
+    end
+
+    def self.init(site,args,opts)
+      site.init_scaffold opts.override
+      puts 'Site scaffold init success!'
+    end
+
+    def self.build(site,includes,opts)
+      site.build(dest:opts.dest,all:opts.all,local:opts.local,includes:includes)
+      puts 'Posts build finished.'
+      self.clean(site)
+    end
+
+    def self.clean(site,args=nil,opts=nil)
+      if site.isolated_files.empty?
+        puts "No isolated files found."
+      else
+        puts 'Do you really want to remove these isolated files?'
+        puts ((site.isolated_files.map {|f| f[(site.dest.length+1)..-1]}).join "\n")
+        puts "[y/N]"
+        answer=$stdin.gets.strip.downcase
+        answer='n' if answer.empty?
+        if answer =='y'
+          site.clean
+          puts 'Clean finished.'
+        end
+      end
+    end
+
+    def self.serve(site,args,opts)
+      site.serve(host:opts.host,port:opts.port)
+    end
+
+    def self.newpost(site,args,opts)
+      path=site.newpost args[0],args[1]
+      puts "New post created at:#{path}"
+    end
+
+  end
+end
+

data/lib/PlainSite/Data/Category.rb

@@ -0,0 +1,235 @@
+#coding:utf-8
+module PlainSite;end
+module PlainSite::Data
+  require 'safe_yaml'
+  require 'PlainSite/Data/Post'
+  require 'PlainSite/Data/PostList'
+
+  class ConflictNameException<Exception; end
+
+  # The Category directory class.
+  # The category directory can have its custom index post named 'index.md' or 'index.html'.
+  # File '_meta.yml' under category dir decribes it's meta info attributes.
+  # Supported attributes in '_meta.yml':
+  #   display_name - The String category display name
+  class Category
+    META_FILE='_meta.yml'
+    attr_reader(
+      :path, # The String full path of category directory
+      :relpath, # The String path of category directory relative to site.data_path
+      :site,
+      :index,   # The index Post
+      :has_index # Bool
+    )
+    # path - The String category directory abspath
+    # site - The Site belongs to
+    def initialize(path,site)
+      @path=path
+      @relpath=@path[(site.data_path.length+1)..-1] || ''
+      @site=site
+      @is_root = @relpath==''
+
+
+
+      # Alias of :relpath
+      alias :data_id :relpath
+
+      @index =  self / :index
+      @has_index = !! @index
+    end
+
+    # whether this is the root category (aka site.data_path)
+    def root?
+      @is_root
+    end
+
+    # Return parent category or nil if self is root
+    def parent
+      return @parent if @parent
+      return nil if root?
+      @parent=if @relpath['/']
+                Category.new File.join(@site.data_path,File.dirname(@relpath)),@site
+              else
+                Category.new @site.data_path,@site
+              end
+    end
+
+    # Return parent categories array
+    def parents
+      return @parents if @parents
+      @parents=[]
+      return @parents if root?
+      cat=self
+      while cat=cat.parent
+        @parents.unshift cat
+      end
+      @parents
+    end
+
+
+    # Query data tree
+    # path - The String|Symbol *relative* path of post or category,
+    #    It can be an exact file path,or a category/slug path.
+    #    For examples,both 'essay/2011-11-11-live-happy.md' and 'essay/live-happy' are valid.
+    #    '*' Retrieve all posts under this category.
+    #        (But excludes its index post and includes sub category index posts).
+    #    '**' retrieve recursively all posts under this category(include index posts)
+    #    Category path(directory),example 'esssay',will return a new child Category .
+    #    Category path ends with '/*',will return posts array under the category dir.
+    #    Category path end with '/**',will return all posts under the category dir recursively.
+    # Return
+    #    The sub Category  when path is a category path
+    #    The PostList when path is category path end with '/*' or '/**'
+    #    The Post when path is a post path
+    def [](path)
+      path=path.to_s
+      if path['/']
+        return path.split('/').reduce(self)  {|cat,p| cat && cat[p]}
+      end
+
+      return posts if path=='*'
+      return sub_posts if path=='**'
+      get_sub path or get_post path
+
+    end
+    alias :/ :[]
+
+    # Get post by slug or filename
+    # p - The String post slug or filename
+    # Return the Post or nil when not found
+    def get_post(p)
+      if p.to_sym==:index
+        p=(Post.extnames.map {|t|"index.#{t}"}).detect do |f|
+          File.exists? (File.join @path,f)
+        end
+      end
+      return nil unless p
+      if p['.'] # filename
+        post_path=File.join @path,p
+        if (File.exists? post_path) && (File.basename(post_path)[0]!='_')
+
+          return Post.new post_path,@site
+        end
+      end
+      return posts_map[p] if posts_map.has_key? p
+    end
+
+    # The posts under this category,but exclude its index post.
+    # Not contains the sub category's posts but include sub category's index post.
+    # Default sort by date desc,slug asc
+    # Return PostList
+    def posts
+      return @posts if @posts
+
+      posts=Dir.glob(@path+'/*')
+      posts.select! do |f|
+        if File.basename(f)[0]=='_'
+          false
+        elsif File.directory? f # if directory has an index
+          (Category.new f,@site).has_index
+        else
+          (File.file? f) && (Post.extname_ok? f) &&
+            ((File.basename f,(File.extname f))!='index') # exclude index post
+        end
+      end
+
+      return @posts=PostList.new([],@site) if posts.empty?
+
+      posts.map! {|f| Post.new f,@site}
+
+      @posts=PostList.new posts,@site
+    end
+
+
+    # Get all posts under category recursively(include all index posts)
+    # Return PostList
+    def sub_posts
+      return @sub_posts if @sub_posts
+      all_posts=posts.to_a
+      subs.each do |c|
+        all_posts.concat c.sub_posts.to_a
+      end
+      all_posts.push @index if @has_index && root?
+      @sub_posts=PostList.new all_posts,@site
+    end
+
+    # Get the sub categories
+    # Return Category[]
+    def subs
+
+      return @subs if @subs
+      subs=Dir.glob @path+'/*'
+      subs.select! { |d| File.basename(d)[0]!='_' && (File.directory? d) }
+      subs.map! { |d| Category.new d,@site }
+
+      @subs=subs
+    end
+
+    # Get the sub category
+    # sub_path The String path relative to current category
+    # Return Category or nil
+    def get_sub(sub_path)
+      return nil if sub_path[0]=='_'
+      sub_path=File.join @path,sub_path
+      if File.directory? sub_path
+        Category.new sub_path,@site
+      end
+    end
+
+
+    # The Hash map of slug=>post
+    # Return Hash
+    def posts_map
+      return @posts_map if @posts_map
+
+      group=posts.group_by &:slug
+
+      conflicts=group.reject {|k,v| v.length==1} #Filter unconflicts
+      unless conflicts.empty?
+        msg=(conflicts.map {|slug,v|
+          "#{slug}:\n\t"+(v.map &:path).join("\n\t")
+        }).join "\n"
+        raise ConflictNameException,"These posts use same slug:#{msg}"
+      end
+
+      group.merge!(group) {|k,v| v[0] }
+      @posts_map=group
+    end
+
+    # Get the meta info in category path ./_meta.yml
+    def meta_info
+      return @meta_info if @meta_info
+      meta_file=File.join(@path,META_FILE)
+      if File.exists? meta_file
+        @meta_info = YAML.safe_load_file meta_file
+      else
+        @meta_info= {}
+      end
+    end
+
+    # The String category dir name,root category's name is empty string
+    def name
+      return @name unless @name.nil?
+      @name=File.basename(data_id)
+    end
+
+    def display_name
+      return @display_name unless @display_name.nil?
+      @display_name=  if meta_info['display_name'].nil?
+                        name.gsub(/-|_/,' ').capitalize
+                      else
+                        meta_info['display_name']
+                      end
+    end
+
+    def to_s
+      'Category:'+(@relpath.empty? ? '#root#' : @relpath)
+    end
+    alias :to_str :to_s
+
+    def to_a
+      parents+[self]
+    end
+    alias :to_ary :to_a
+  end # end class Category
+end # end PlainSite::Data

data/lib/PlainSite/Data/FrontMatterFile.rb

@@ -0,0 +1,64 @@
+#coding:utf-8
+module PlainSite;end
+module PlainSite::Data
+  # require 'active_support/core_ext/hash' # Silly
+  # require 'active_support/hash_with_indifferent_access' # Fat
+  require 'safe_yaml'
+  class InvalidFrontMatterFileException<Exception;end
+
+  class FrontMatterFile
+    # YAML Front Matter File
+    # Example file content:
+    #   ---
+    #   title: Hello,world!
+    #   tags: [C,Java,Ruby,Haskell]
+    #   ---
+    #   File content Here!
+    #
+    attr_reader :path
+    DELIMITER='---'
+
+    def initialize(path)
+      # The String file path
+      @path=path
+      @content_pos=0
+    end
+
+    def headers
+      File.open(@path) do |f|
+        line=f.readline.strip
+        break if line!=DELIMITER
+        header_lines=[]
+        begin
+          while (line=f.readline.strip)!=DELIMITER
+            header_lines.push line
+          end
+          @headers = YAML.safe_load(header_lines.join "\n")
+          unless Hash===@headers
+            raise InvalidFrontMatterFileException,"Front YAML must be Hash,not #{@headers.class},in file: #{path}"
+          end
+          @content_pos=f.pos
+          @headers['path'] = @path
+          return @headers
+        rescue YAML::SyntaxError => e
+          raise  InvalidFrontMatterFileException,"YAML SyntaxError:#{e.message},in file: #{path}"
+        rescue EOFError => e
+          raise InvalidFrontMatterFileException,"Unclosed YAML in file: #{path}"
+        end
+      end
+
+      return {"path" => @path }
+    end
+
+    # Intended no cache, listen directory changes not work on platforms other than linux
+    def content
+      self.headers # init @content_pos
+      File.open(path) do |f|
+        f.seek @content_pos,IO::SEEK_SET
+        @content=f.read.strip.freeze
+      end
+    end
+
+
+  end
+end # end PlainSite::Data

data/lib/PlainSite/Data/Post.rb

@@ -0,0 +1,237 @@
+#coding:utf-8
+module PlainSite;end
+module PlainSite::Data
+  require 'pygments'
+  require 'kramdown'
+  require 'date'
+  require 'securerandom'
+  require 'PlainSite/Data/FrontMatterFile'
+  require 'PlainSite/Tpl/LayErb'
+  require 'PlainSite/Data/Category'
+
+  class Post
+    attr_reader(
+      :slug, # The String slug of post,default is it's filename without date and dot-extname
+      :path, # The String post file path
+      :relpath, # The String path relative to site.data_path
+      :data_id, # The String data id,format:'category/sub-category/slug'
+      :category_path, # The String category path
+      :filename, # The String filename
+      :site,
+      :is_index # The Bool to indicate if this is an index post.
+    )
+
+    attr_accessor( #These properties are inited by others
+      :prev_post, # The Post previous,set by PostList
+      :next_post, # The Post next,set by PostList
+    )
+
+    DATE_NAME_RE=/^(\d{4})-(\d{1,2})-(\d{1,2})-(.+)$/
+    HIGHLIGHT_RE=/<highlight(\s+[^>]+)?\s*>(.+?)<\/highlight>/m
+    MARKDOWN_CODE_RE=/```(.+?)```/m
+
+
+    # Init a post
+    # path - The String file abs path,at present,only support '.html' and '.md' extname.
+    # site - The Site this post belongs to
+    def initialize(path,site)
+      if File.directory? path # create as category index post
+        path=(@@extnames.map {|x| File.join path+'/index'+x}).detect {|f| File.exists? f}
+        @is_index=true
+      end
+      @site=site
+      @path=path
+      @relpath=@path[(site.data_path.length+1)..-1]
+
+      @filename=File.basename @path
+      @extname=File.extname @filename
+      if DATE_NAME_RE =~ @filename
+        @date=Date.new $1.to_i,$2.to_i,$3.to_i
+        @slug=File.basename $4,@extname
+      end
+      @slug=File.basename @filename,@extname unless @slug
+
+      @category_path=File.dirname(@relpath)
+
+      if @category_path=='/' or @category_path=='.'
+        @category_path=''
+        @data_id=@slug
+      else
+        @data_id=File.join @category_path,@slug
+      end
+
+    end
+    # The Date of post
+    def date
+      return @date if @date
+      @date=get_date 'date'
+    end
+
+    def get_date(k)
+      date=post_file.headers[k]
+
+      date=if String===date
+              begin Date.parse(date) rescue Date.today end
+            elsif Date===date
+              date
+            else
+              Date.today
+            end
+    end
+    private :get_date
+
+    def updated_date
+      return @updated_date if @updated_date
+      @updated_date=get_date 'updated_date'
+    end
+
+    # The Category this post belongs to
+    def category
+      return @category if @category
+      @category=Category.new File.join(@site.data_path,@category_path),@site
+    end
+
+    # The String content type of post,default is it's extname without dot
+    def content_type
+      return @content_type if @content_type
+      @content_type=post_file.headers['content_type']
+      @content_type=@extname[1..-1] if @content_type.nil?
+      @content_type
+    end
+
+    # The Boolean value indicates if this post is a draft,default is false,alias is `draft?`
+    # def draft
+    #   return @draft unless @draft.nil?
+    #   @draft=!!post_file.headers['draft']
+    # end
+    # alias :draft? :draft
+
+    # def deleted
+    #   return @deleted unless @deleted.nil?
+    #   @deleted=!!post_file.headers['deleted']
+    # end
+    # alias :deleted? :deleted
+
+    # Private
+    def post_file
+      return @post_file if @post_file
+      @post_file=FrontMatterFile.new @path
+    end
+    private :post_file
+
+    # Post file raw content
+    def raw_content
+      post_file.content
+    end
+
+    # Rendered html content
+    # It must render highlight code first.
+    # Highlight syntax:
+    #   Html tag style:
+    #     <highlight>puts 'Hello'</highlight>
+    #     With line numbers and language
+    #     <highlight ruby linenos>puts 'Hello'</highlight>
+    #     Set line number start from 10
+    #     <highlight ruby linenos=10>puts 'Hello'</highlight>
+    #     Highlight lines
+    #     <highlight ruby linenos hl_lines=1>puts 'Hello'</highlight>
+    #
+    #     Highlight html tag options:
+    #       linenos - If provide,output will contains line number
+    #       linenos=Int - Line number start from,default is 1
+    #   If no new line in code,the output will be inline nowrap style and no linenos.
+    #
+    #   You can also use markdown style code block,e.g. ```puts 'Code'```.
+    #   But code this style doesn't rendered by Pygments.
+    #   You need to load a browser side renderer,viz. SyntaxHighlighter.
+    #
+    # Then render erb template,context is post itself,you can access self and self.site methods
+    #
+    # Return the String html content
+    def content
+      # quick fix,when build local, current path will change
+      p=@path + "::"+ @site._cur_page_dir
+
+      post_content=raw_content.dup
+      # stash highlight code
+      codeMap={}
+      post_content.gsub! HIGHLIGHT_RE  do
+        placeholder='-HIGHLIGHT '+SecureRandom.uuid+' ENDHIGHLIGHT-'
+        attrs=$1
+        attrs=attrs.split " "
+        lexer=attrs.shift || ""
+        attrs=Hash[attrs.map {|v| v.split "="}]
+        attrs["hl_lines"]=(attrs["hl_lines"] || "").split ","
+        code=$2
+        codeMap[placeholder]={
+          lexer: lexer,
+          linenos: (attrs.key? "linenos") ? 'table' : false ,
+          linenostart: attrs["linenos"] || 1,
+          hl_lines: attrs["hl_lines"],
+          code: code.strip,
+          nowrap: code["\n"].nil?
+        }
+        placeholder
+      end
+
+
+      # Then render erb template if needed
+      if post_content['<%'] && !post_file.headers['disable_erb']
+        post_content=PlainSite::Tpl::LayErb.render_s post_content,self
+      end
+
+      post_content=self.class.content_to_html post_content,content_type
+
+      #put back code
+      codeMap.each do |k,v|
+        code=Pygments.highlight v[:code],lexer: v[:lexer],formatter: 'html',options:{
+            linenos: v[:linenos],
+            linenostart: v[:linenostart],
+            nowrap: v[:nowrap],
+            hl_lines: v[:hl_lines],
+            startinline: v[:lexer] == 'php'
+        }
+        code="<code class=\"highlight\">#{code}</code>" if v[:nowrap]
+        post_content[k]=code # String#sub method has a hole of back reference
+      end
+
+      return post_content
+    end
+
+    # The String url of this post in site
+    def url
+      @site.url_for @data_id
+    end
+
+    # You can use method call to access post file front-matter data
+    def respond_to?(name)
+      return true if post_file.headers.key? name.to_s
+      super
+    end
+
+    def method_missing(name,*args,&block)
+      if args.length==0 && block.nil? &&  post_file.headers.key?(name.to_s)
+        return post_file.headers[name.to_s]
+      end
+      super
+    end
+
+    def self.content_to_html(content,content_type)
+      if content_type=='md'
+        content=Kramdown::Document.new(content,input:'GFM').to_html
+      end
+      content
+    end
+
+    @@extnames=['md','html']
+
+    def self.extnames
+      @@extnames
+    end
+
+    def self.extname_ok?(f)
+      @@extnames.include?  File.extname(f)[1..-1]
+    end
+
+  end # class Post
+end # module PlainSite::Data