PlainSite 1.2.0

data/lib/PlainSite/Site.rb

@@ -0,0 +1,330 @@
+#coding:utf-8
+module PlainSite
+  require 'git'
+  require 'uri'
+  require 'pathname'
+  require 'fileutils'
+  require 'webrick'
+  require 'listen'
+  require 'PlainSite/Data/Category'
+  require 'PlainSite/Data/Post'
+  require 'PlainSite/RenderTask'
+  require 'PlainSite/Utils'
+  require 'PlainSite/SocketPatch'
+
+  SELF_SRC_DIR=File.realpath File.dirname(__FILE__)
+  SCAFFOLD_DIR=File.join(SELF_SRC_DIR,'_scaffold')
+
+  class Site
+    attr_reader(
+      :root,
+      :local,
+      :assets_path,
+      :dest, # Alter build destination directory,default same as root
+      :data_path, # The String data posts directory path
+      :templates_path # The String templates directory path
+    )
+
+    attr_accessor :_cur_page_dir # global var -_-!
+
+    # Params
+    # root - The String root path of site,must be an exists path
+    def initialize(root)
+      @root= File.realpath root
+      @dest= @root
+      @src_path=File.join(@root,'_src')
+      @data_path=File.join(@src_path,'data')
+      @routes_rb=File.join(@src_path,'routes.rb')
+      @templates_path=File.join(@src_path,'templates')
+      @assets_path=File.join(@src_path,'assets')
+      @config_file= File.join(@src_path,'config.yml')
+      @extensions= File.join(@src_path,'extensions')
+
+      @_cur_page_dir = ''
+
+      load_extensions
+      create_pygments_css
+    end
+
+    # Reload,clean cached instance variables read from file
+    def reload
+      @config=nil
+      @render_task=nil
+      @data=nil
+      create_pygments_css
+      load_extensions
+    end
+
+    # The Hash config defined if config.yml
+    def config
+      return @config if @config
+      @config = (File.exists? @config_file) ? (YAML.safe_load_file @config_file) : {}
+    end
+
+    # Access config.yml data through site's property
+    def method_missing(name,*args,&block)
+      return config[name.to_s] if args.empty? && block.nil? && (config.key? name.to_s)
+      super
+    end
+
+    # Return the Category object represents _site/data
+    def data
+      return @data if @data
+      @data=Data::Category.new @data_path,self
+    end
+
+    # Init site structure
+    def init_scaffold(override=false)
+      Utils.merge_folder SCAFFOLD_DIR,@root,override
+      reload
+    end
+
+    # Create a new post file
+    def newpost(p,title)
+      ext=File.extname p
+      unless ext.empty? || (Data::Post.extname_ok? p)
+        raise Exception,"Unsupported file type:#{ext}.Supported extnames:"+Data::Post.extnames.join(",")
+      end
+
+      name=File.basename p,ext
+      ext='.'+Data::Post.extnames[0] unless ext
+      name= "#{name}#{ext}"
+
+      if Data::Post::DATE_NAME_RE =~ name
+        date=''
+      else
+        date="date: #{Date.today}\n"
+      end
+
+      if p['/']
+        path=File.join @data_path,(File.dirname p)
+        FileUtils.mkdir_p  path
+      else
+        path=@data_path
+      end
+      path="#{path}/#{name}"
+      File.open(path,'wb') do |f|
+        f.write "---\ntitle: #{title}\n#{date}---\n\n#{title}\n====="
+      end
+      path
+    end
+
+    # Config route specified data with ordered template and url path.
+    # See: RenderTask#route
+    def route(opt)
+      render_task.route(opt)
+    end
+
+    # Get the url for object
+    # obj - The Post|PageListPage|Category|String
+    # Return the String url prefix with site root url(site.url) or relative path if build --local
+    def url_for(x)
+      render_task.url_for(x)
+    end
+
+    # Build static pages
+    # all - The Boolean value to force build all posts.Default only build updated posts.
+    # dest - The String path of destination directory
+    # includes - The String[] path of posts or templates to force regeneration
+    def build(opts={})
+      @local=opts[:local]
+      @dest= opts[:dest] if opts[:dest]
+      includes= opts[:includes]
+      if includes && ! includes.empty?
+        includes.map! &(File.method :realpath)
+      else
+        includes=nil
+      end
+
+
+      files=diff_files includes
+
+      if opts[:all] || files.nil?
+        render_task.render
+      else
+        render_task.render(files)
+      end
+      copy_assets
+    end
+
+    # Clean isolated files under dest directory
+    # If file is neither generated by `routes.rb` nor copied from `_src/assets/`,it will be deleted.
+    def clean
+      isolated_files.each do |f|
+        File.delete f
+      end
+    end
+
+    def isolated_files
+      all_path= render_task.all_urlpath.map do |p|
+        File.join @dest,p
+      end
+      files= (Dir.glob "#{@dest}/*")
+      files.reject! {|f| f==@src_path} # Skip src
+      _isolated_files= files.reduce([]) do |a,f|
+        if File.directory? f
+          # concat is not pure
+          a.concat (Dir.glob "#{f}/**/**")
+        else
+          a.push f
+        end
+        next a
+      end
+      _isolated_files.select! do |f|
+        next false if all_path.include? f
+        f=File.join @assets_path,f[@dest.length..-1]
+        not (File.exists? f)  # Keep static assets
+      end
+
+      return _isolated_files
+    end
+
+    # Run a preview server on localhost:1990
+    def serve(opts={})
+      host=opts[:host] || 'localhost'
+      port=opts[:port] || '1990'
+      origin_url=config['url']
+
+      Listen.to(@src_path) do |m, a, d|
+        puts "\nReloaded!\n"
+        self.reload
+      end
+
+      server = WEBrick::HTTPServer.new(Port:port,BindAddress:'0.0.0.0')
+      server.mount_proc '/' do |req,res|
+        url= req.path_info
+        url= '/index.html' if url=='/'
+        res.status=404 if url=='/404.html'
+        prevent_caching(res)
+        static_file=File.join @assets_path,url
+        if (File.exists? static_file) && !(File.directory? static_file)
+          serve_static server,static_file,req,res
+          next
+        end
+        config['url']= "http://#{host}:#{port}"
+        result=render_task.render_url url
+        config['url']=origin_url
+        if result
+          res.body=result
+          res['Content-Type']='text/html'
+          if req.request_method == 'HEAD'
+            res['Content-Length'] = 0
+          end
+          next
+        end
+        static_file=File.join @dest,url
+        if File.exists? static_file
+          serve_static server,static_file,req,res
+          next
+        end
+        res.status=301
+        res['Location']='/404.html'
+      end
+      t = Thread.new { server.start }
+
+      quitServer = proc { exit;server.shutdown }
+      trap('INT',quitServer)
+      trap('TERM',quitServer)
+
+      puts "\nServer running on http://#{host}:#{port}/\n"
+      t.join
+
+    end
+
+    # Get diff_files
+    #
+    # Return Hash
+    # Structure:
+    # {
+    #   updated_posts:[],
+    #   updated_templates:[],
+    #   has_deleted_posts:Bool
+    # }
+    def diff_files(includes=nil)
+      deleted_posts=[]
+      begin
+        repo=Git.open @root
+        files=%w(untracked added changed).map {|m|(repo.status.send m).keys}.flatten
+        files.map! {|f|File.join @root,f}
+        deleted_posts=repo.status.deleted.keys.map {|f|File.join @root,f}
+        deleted_posts.select! do |f|
+          f.start_with? @data_path
+        end
+      rescue Git::GitExecuteError,ArgumentError => e
+        $stderr.puts("\nMaybe site root is not a valid git repository:#{@root}. Error: " + e.to_s)
+        return nil if includes.nil?
+      end
+      files||=[]
+      files.concat includes if includes
+      files=files.group_by do |f|
+        if f.start_with? @data_path+'/'
+          :updated_posts
+        elsif f.start_with? @templates_path+'/'
+          :updated_templates
+        else
+          :unrelated
+        end
+      end
+      files.delete :unrelated
+      files[:has_deleted_posts]= ! deleted_posts.empty?
+      files
+    end
+
+
+  private
+    def render_task
+      return @render_task if @render_task
+      @render_task=RenderTask.new self
+
+      $site=self
+      load @routes_rb,true
+      @render_task
+    end
+
+    def serve_static(server,static_file,req,res)
+      handler=WEBrick::HTTPServlet::DefaultFileHandler.new server,static_file
+      handler.do_GET req,res
+    end
+
+    def prevent_caching(res)
+      res['ETag']          = nil
+      res['Last-Modified'] = Time.now + 100**4
+      res['Cache-Control'] = 'no-store, no-cache, must-revalidate, post-check=0, pre-check=0'
+      res['Pragma']        = 'no-cache'
+      res['Expires']       = Time.now - 100**4
+    end
+
+
+    # Copy _src/assets to dest root directory
+    def copy_assets
+      Utils.merge_folder @assets_path,@dest,true
+    end
+
+    def load_extensions
+      if File.directory? @extensions
+        (Dir.glob "#{@extensions}/*.rb").each do |f|
+          load f
+        end
+      end
+    end
+
+    def create_pygments_css
+      return unless config['code_highlight'] && config['code_highlight']['engine']=='pygments'
+      cls='.highlight'
+      css_list=config['code_highlight']['pygments_css_list']
+      css_list= css_list.each_pair.to_a if css_list
+      css_list=[:native,'/css/pygments.css'] unless css_list
+      css_list.each do |a|
+        style,css_path=a
+        css_path=File.join @assets_path,css_path
+        next if File.exists? css_path
+        FileUtils.mkdir_p File.dirname(css_path)
+        css_content=Pygments.css(cls,style:style)
+        File.open(css_path,'wb') do |f|
+          f.write css_content
+        end
+      end
+    end
+
+  end
+end

data/lib/PlainSite/SocketPatch.rb

@@ -0,0 +1,15 @@
+
+#coding:utf-8
+module PlainSite
+  require 'socket'
+  module SocketPatch
+    class ::TCPSocket
+      def peeraddr(*args,&block)
+        # Prevent reverse hostname resolve
+        args.push :numeric unless args.include? :numeric
+        super *args,&block
+      end
+    end
+  end
+end
+

data/lib/PlainSite/Tpl/ExtMethods.rb

@@ -0,0 +1,55 @@
+#coding:utf-8
+
+module PlainSite;end
+module PlainSite::Tpl
+  require 'erb'
+  module ExtMethods
+    require 'uri'
+    require 'json'
+    require 'securerandom'
+    include ERB::Util
+    def echo_block(&block)
+      old=@_erbout_buf
+      @_erbout_buf=""
+      block.call
+      block_content=@_erbout_buf.strip
+      @_erbout_buf=old
+      block_content
+    end
+
+    def raw(&block)
+      code=echo_block &block
+      @_erbout_buf << (html_escape code)
+    end
+
+    def iframe(attrs={},&block)
+      attrs[:width]=attrs[:width] || "100%"
+      attrs[:height]=attrs[:height] || "100%"
+      attrs= attrs.to_a.map do |a|
+        k,v=a
+        "#{k}=\"#{v}\""
+      end.join " "
+      html=echo_block &block
+      html="
+      <!DOCTYPE html>
+      <html>
+      <head>
+        <title>IFrame</title>
+      </head>
+      <body>#{html}</body>
+      </html>
+      "
+
+      html=html.to_json
+      id='ID_'+(SecureRandom.uuid.gsub '-','')
+      @_erbout_buf << "
+      <iframe #{attrs} src='about:blank' id='#{id}'></iframe>
+      <script>
+        setTimeout(function () {
+          document.getElementById('#{id}').contentWindow.document.write(#{html})
+        },0);
+      </script>
+      "
+    end
+  end
+end

data/lib/PlainSite/Tpl/LayErb.rb

@@ -0,0 +1,73 @@
+#coding:utf-8
+module PlainSite;end
+module PlainSite::Tpl
+  require 'erb'
+  require 'PlainSite/Data/FrontMatterFile'
+  require 'PlainSite/Utils'
+  require 'PlainSite/Tpl/ExtMethods'
+
+  class LayoutNameException<Exception;end
+
+  # Layout enhanced ERB.Template file is also YAMLFrontMatterFile
+  # Example Template Files:
+  #   body.html :
+  #     ---
+  #     layout: layout.html
+  #     ---
+  #     Store layout content :<% content_for :name %>CONTENT<%end%>
+  #
+  #   layout.html :
+  #     Retrieve content: <%=yield :name%>
+  class LayErb
+    # Huh? For short name!
+    ObjectProxy=PlainSite::Utils::ObjectProxy # module include has many pitfalls
+    def initialize(path)
+      @path=path
+      @template_file=PlainSite::Data::FrontMatterFile.new path
+      @layout=@template_file.headers['layout']
+    end
+    # Render template with context data
+    # context - The Object|Hash data
+    # yield_contents - The Hash for layout yield retrieves
+    def render(context,yield_contents={})
+      context=ObjectProxy.new context unless ObjectProxy===context
+      contents_store={}
+      context.define_singleton_method(:content_for) do |name,&block|
+        contents_store[name.to_sym]=echo_block &block
+        nil
+      end unless context.respond_to? :content_for
+
+      tpl_path=@path
+      context.define_singleton_method(:include) do |file|
+        file=File.join File.dirname(tpl_path),file
+        new_context=context.dup
+        LayErb.new(file).render new_context
+      end unless context.respond_to? :include
+
+      begin
+        result=LayErb.render_s(@template_file.content,context,yield_contents)
+      rescue Exception=>e
+        $stderr.puts "\nError in template:#{@path}\n"
+        raise e
+      end
+      if @layout
+        layout_path=File.join (File.dirname @path), @layout
+        return  LayErb.new(layout_path).render context,contents_store
+      end
+      result
+    end
+
+    # Render content with context data
+    # content - The String template content
+    # context - The Object|Hash data
+    # yield_contents - The Hash for layout yield retrieve
+    def self.render_s(content,context,yield_contents={})
+      context=ObjectProxy.new context unless ObjectProxy===context
+      context.singleton_class.class_eval { include ExtMethods }
+      erb=ERB.new content,nil,nil,'@_erbout_buf'
+      result=erb.result(context.get_binding { |k| yield_contents[k.to_sym] })
+      result.strip
+    end
+  end
+
+end