RubyGems - sitepack - Versions diffs - 0.6 - Mend

sitepack 0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

data/README +9 -0
data/lib/sitepack.rb +189 -0
data/test.rb +75 -0
metadata +85 -0

data/README ADDED

@@ -0,0 +1,9 @@
+Sinatra Static Pages
+--------------------
+Sinatra makes websites easy, but when it's time to deploy running ruby can be a pain.
+ContentPack makes it easy.  Just export your sinatra application as static html and upload to any webserver - Done!
+All the power of ruby, but really how many times are you changing that content and why can't you traverse your content store
+before deploying.  Do you really have so many pages you need a database for every request?

data/lib/sitepack.rb ADDED

@@ -0,0 +1,189 @@
+require 'stringio'
+require 'pathname'
+require 'hpricot'
+require 'redcloth'
+require 'erubis'
+module SitePack
+  RackDefaultEnv = {
+    'REQUEST_METHOD' => 'GET',
+    'SCRIPT_NAME' => 'app.rb',
+    'SERVER_NAME' => 'localhost',
+    'SERVER_PORT' => 9999,
+    'rack.url_scheme' => 'http',
+    'rack.version' => [1,1],
+    'rack.input' => StringIO.new,
+    'rack.errors' => StringIO.new,
+    'rack.run_once' => true,
+    'rack.multiprocess' => false,
+    'rack.multithread' => false
+  }.freeze
+  #
+  # Generate a static site using sinatra
+  #
+  # Given a content root folder, Builder will auto generate a site.
+  #
+  # builder = SitePack::Builder.new(MyAppKlass, 'mydomain.com', './site/')
+  #
+  # # walk all .xml files in the './content/' directory
+  # # calling builder.save with the computed path will
+  # # write out a rendered .html file into the ./site/ directory at the path
+  # # ./content/#{path}.html
+  #
+  # builder.content('./content/') do|path|
+  #   builder.save(path)
+  # end
+  #
+  class Builder
+    def initialize(appklass, domain, sitedir)
+      @appklass = appklass
+      @domain   = domain
+      @sitedir  = sitedir
+    end
+    #
+    # yield each sub path of each content file within the content directory
+    # or return an array of all paths
+    #
+    def content(dir)
+      @content_dir = dir
+      dir_path = Pathname.new(File.expand_path(dir))
+      paths = Dir["#{dir}/**/**.xml"].map{|p| Pathname.new(File.expand_path(p)).relative_path_from(dir_path) }
+      paths.each {|p| yield p } if block_given?
+      @content_dir = nil
+      paths
+    end
+    #
+    # save a given path into the site output directory
+    #
+    def save(path)
+      doc = Hpricot.XML(File.read(File.expand_path(File.join(@content_dir, path))))
+      ext = doc.at(:page)['extension'] || 'html'
+      output_path = path.sub(/\.xml$/,".#{ext}")
+      file = "#{@sitedir}/#{output_path}"
+      url = "http://#{@domain}/#{output_path}"
+      env = RackDefaultEnv.dup
+      uri = URI.parse(url)
+      env['PATH_INFO'] = uri.path
+      env['QUERY_STRING'] = uri.query || ''
+      req = Rack::Request.new(env) #Rack::MockRequest.env_for(url, env)
+      status, headers, body = @appklass.call(req.env)
+      res = Rack::MockResponse.new(status, headers, body, req.env["rack.errors"].flush)
+      case status
+      when 200
+        puts "render: #{url} as #{file}"
+        FileUtils.mkdir_p(File.dirname(file)) unless File.exist?(File.dirname(file))
+        File.open(file,'wb') { |f| f << res.body }
+        return file
+      else
+        raise "error #{status} status code: #{status} when requesting: #{url}\n#{res.body}"
+      end
+      nil
+    end
+  end
+  #
+  # enable content by including this module in your sinatra application
+  #
+  # class MyApp  < Sinatra::Application
+  #   include SitePack::Content
+  #   set :content_path, 'content'
+  #   set :public, 'public'
+  #
+  #   get '/:page.html' do
+  #     erb site_content(options.content_path, params)
+  #   end
+  # end
+  #
+  # sample page content format:
+  #
+  # <?xml version="1.0"?>
+  # <page>
+  # <title>Title Content</title>
+  # <body template="special" filter="redcloth">
+  # h1. Foo Bar
+  #
+  # A *simple* paragraph with
+  # a line break, some _emphasis_ and a "link":http://redcloth.org
+  #
+  # * an item
+  # * and another
+  #
+  # # one
+  # # two
+  #
+  # </body>
+  # </page>
+  #
+  # template = by default is page, e.g. views/page.erb
+  # filter   = by default is redcloth, but can be html -> in which case use <![CDATA[ html ]]>
+  #
+  module Config
+    def site_pack_config(yaml_file)
+      config = YAML.load_file(yaml_file)
+      @vars = config['vars']
+      @filter = config['filter'] || 'redcloth'
+      @verbose = config['verbose']
+      puts "Site Pack!\nVars:#{@vars.inspect}\nFilter(default):#{@filter.inspect}" if @verbose
+    end
+    def _site_pack_get_opt(opt)
+      instance_variable_get("@#{opt}".to_sym)
+    end
+  end
+  module Content
+    def site_content(content_path, params)
+      if params[:splat].nil?
+        file_path = "#{content_path}/index.xml"
+      else
+        file_path = "#{content_path}/#{params[:splat].join('/')}.xml"
+      end
+      halt 404, "page not found: #{file_path.inspect}" unless File.exists?(file_path)
+      doc = Hpricot.XML(File.read(file_path))
+      @title = doc.at(:title) ? doc.at(:title).inner_html : nil
+      body = doc.at(:body)
+      if body
+        template = body[:template] || 'page'
+        @body = content_processor(body)
+      else
+        halt 500, "Missing body tag!"
+      end
+      vars = self.class._site_pack_get_opt('vars')
+      if vars and vars.respond_to?(:each)
+        vars.each do|var|
+          node = doc.at(var.to_sym)
+          instance_variable_set("@#{var}".to_sym, content_processor(node)) if node
+        end
+      end
+      sidebar = doc.at(:sidebar)
+      @sidebar = content_processor(sidebar) if sidebar
+      template.to_sym
+    end
+    def content_processor(node)
+      filter = node[:filter] || self.class._site_pack_get_opt('filter')
+      puts "Render(#{node.name.inspect}) with #{filter.inspect}" if self.class._site_pack_get_opt('verbose')
+      output = case filter
+      when 'redcloth'
+        RedCloth.new(node.inner_html).to_html
+      when 'html'
+        node.inner_html
+      when 'erubis'
+        Erubis::Eruby.new(node.inner_html).result(binding())
+      else
+        halt 500, "Unsupported filter: #{filter} when rendering #{file_path}"
+      end
+      output
+    end
+  end
+end

data/test.rb ADDED

@@ -0,0 +1,75 @@
+require 'app'
+require 'test/unit'
+require 'rack/test'
+class TestApp < Test::Unit::TestCase
+  include Rack::Test::Methods
+  def app
+    App
+  end
+  def test_index_redirect
+    get '/'
+    assert_equal 302, last_response.status
+  end
+  def test_404
+    get '/foobar.html'
+    assert_equal 404, last_response.status
+    assert_match /That page is missing/, last_response.body
+  end
+  def test_500
+    get '/badcontent.html'
+    assert_equal 500, last_response.status
+    assert_match /Missing body tag/, last_response.body
+  end
+  def test_200
+    get '/index.html'
+    assert_equal 200, last_response.status
+    assert_match /Home Page/, last_response.body
+  end
+  def test_html
+    get '/html.html'
+    assert_equal 200, last_response.status
+    assert_match /<h1>we have html tags<\/h1>/, last_response.body
+  end
+  def test_erubis
+    get '/erubis.html'
+    assert_equal 200, last_response.status
+    assert_match /Yes this is erubis/, last_response.body
+  end
+  def test_package
+    system("mv content/badcontent.xml .")
+    system("rake package")
+    assert File.exist?("site/index.html")
+    assert File.exist?("site/page2.html")
+    assert File.exist?("site/services/foo.html")
+    assert File.exist?("site/404.html")
+    assert File.exist?("site/altfile_extension.php")
+  ensure
+    system("mv badcontent.xml content/badcontent.xml")
+  end
+  def test_alt_extensions
+    get '/altfile_extension.php'
+    assert_equal 200, last_response.status
+    assert_match /<\? echo 'hello' \?>/, last_response.body # /
+  end
+  def test_extravars
+    get '/extravars.html'
+    assert_equal 200, last_response.status
+    assert_match(/footer/,last_response.body)
+    assert_match(/sidebar/,last_response.body)
+    assert_match(/head/,last_response.body)
+  end
+end

metadata ADDED

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: sitepack
+version: !ruby/object:Gem::Version
+  version: "0.6"
+platform: ruby
+authors:
+- Todd A. Fisher
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-03-02 00:00:00 -05:00
+default_executable:
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+- !ruby/object:Gem::Dependency
+  name: RedCloth
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+- !ruby/object:Gem::Dependency
+  name: erubis
+  type: :runtime
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: "0"
+    version:
+description: Sinatra Static Pages
+email: todd.fisher@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README
+- lib/sitepack.rb
+has_rdoc: true
+homepage:
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.5
+signing_key:
+specification_version: 3
+summary: Sinatra Static Pages
+test_files:
+- test.rb