static_docs 0.0.1 → 0.1.0

data/app/assets/javascripts/static_docs/pages.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/stylesheets/static_docs/pages.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/app/controllers/static_docs/application_controller.rb

@@ -1,4 +1,4 @@
 module StaticDocs
-  class ApplicationController < ActionController::Base
+  class ApplicationController < ::ApplicationController
   end
 end

data/app/controllers/static_docs/pages_controller.rb

@@ -0,0 +1,9 @@
+require_dependency "static_docs/application_controller"
+
+module StaticDocs
+  class PagesController < ApplicationController
+    def show
+      @page = Page.matched(params[:page_path])
+    end
+  end
+end

data/app/helpers/static_docs/application_helper.rb

@@ -1,4 +1,15 @@
 module StaticDocs
   module ApplicationHelper
+    def respond_to?(method)
+      super || main_app.respond_to?(method)
+    end
+
+    def method_missing(method, *args, &block)
+      if main_app.respond_to?(method)
+        main_app.send(method, *args, &block)
+      else
+        super
+      end
+    end
   end
 end

data/app/helpers/static_docs/pages_helper.rb

@@ -0,0 +1,4 @@
+module StaticDocs
+  module PagesHelper
+  end
+end

data/app/models/static_docs/page.rb

@@ -0,0 +1,30 @@
+module StaticDocs
+  class Page < ActiveRecord::Base
+    attr_accessor :meta
+
+    class << self
+      def matched(path)
+        namespace, _, namespaced_path = path.partition('/')
+        namespaced_matched(namespaced_path, namespace) || namespaced_matched(path) || raise(ActiveRecord::RecordNotFound)
+      end
+
+      def namespaced_matched(path, namespace = nil)
+        if path.present? && StaticDocs.namespaces.include?(namespace)
+          where(:namespace => namespace, :path => path).first
+        end
+      end
+    end
+
+    def meta
+      @meta ||= {}
+    end
+
+    def renderer
+      @renderer ||= StaticDocs.renderers[namespace].try(:fetch, extension) || StaticDocs.renderers[:default][extension]
+    end
+
+    def rendered_body(context)
+      context.instance_exec(body, self, &renderer)
+    end
+  end
+end

data/app/views/static_docs/pages/show.html.erb

@@ -0,0 +1,3 @@
+<div class='content'>
+  <%= @page.rendered_body(self) %>
+</div>

data/config/routes.rb

@@ -1,2 +1,6 @@
 StaticDocs::Engine.routes.draw do
+  root :to => 'pages#show', :page_path => 'home'
+  get '*page_path' => 'pages#show'
+
+
 end

data/db/migrate/20130502102206_create_static_docs_pages.rb

@@ -0,0 +1,16 @@
+class CreateStaticDocsPages < ActiveRecord::Migration
+  def change
+    create_table :static_docs_pages do |t|
+      t.string :title
+      t.string :path
+      t.string :namespace
+      t.text :body, :limit => 64.kilobytes + 1
+      t.string :extension
+
+      t.timestamps
+    end
+
+    add_index :static_docs_pages, :path
+    add_index :static_docs_pages, :namespace
+  end
+end

data/lib/static_docs/importer.rb

@@ -0,0 +1,44 @@
+module StaticDocs
+  class Importer
+    attr_accessor :namespace
+
+    def self.import(namespace)
+      new(namespace).import
+    end
+
+    def initialize(namespace)
+      @namespace = namespace
+    end
+
+    def source
+      @source ||= Rails.root.join StaticDocs.sources[namespace]
+    end
+
+    def config
+      @config ||= YAML.load IO.read File.join source, 'index.yml'
+    end
+
+    def import
+      cleanup
+      import_collection config['special'], false
+      import_collection config['pages']
+    end
+
+    def import_collection(pages, show = true)
+      return if pages.empty?
+      pages.each_with_index do |data, index|
+        page = Page.where(:namespace => namespace, :path => data['path']).first_or_initialize
+        page.extension = data['file'][/([^\.]+)$/]
+        page.position = show ? index : nil if page.attributes.include?('position')
+        page.title = data['title']
+        page.body = File.read File.join(source, data['file'])
+        page.save
+      end
+    end
+
+    def cleanup
+      actual_page_urls = (config['pages'] + config['special']).map{ |page| page['path'] }
+      Page.where(:namespace => namespace).where('path not in (?)', actual_page_urls).destroy_all
+    end
+  end
+end

data/lib/static_docs/version.rb

@@ -1,3 +1,3 @@
 module StaticDocs
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/static_docs.rb

@@ -1,4 +1,34 @@
 require "static_docs/engine"
 
 module StaticDocs
+  mattr_accessor :sources
+  @@sources = {}.with_indifferent_access
+
+  mattr_accessor :renderers
+  @@renderers = {
+    :default => {
+      :html => proc{ |body| body.html_safe },
+      :txt => proc{ |body| body }
+    }.with_indifferent_access
+  }.with_indifferent_access
+
+  def self.source(src, options = {})
+    namespace = options[:namespace] || options[:to]
+    @@sources[namespace] = src
+  end
+
+  def self.renderer(format, options = {}, &block)
+    namespace = options[:namespace] || :default
+    @@renderers[namespace] ||= {}.with_indifferent_access
+    @@renderers[namespace][format] = block
+  end
+
+  def self.setup(&block)
+    instance_eval(&block)
+  end
+
+  def self.namespaces
+    @namespaces ||= sources.keys
+  end
+
 end

data/lib/tasks/static_docs_tasks.rake

@@ -1,4 +1,11 @@
-# desc "Explaining what the task does"
-# task :static_docs do
-#   # Task goes here
-# end
+require "static_docs/importer"
+
+namespace :static_docs do
+  desc "Import pages to database. Use `namespace=xxx` or `namespaces=xxx,yyy` to point what namespace to import. Use keyword `root` to point on root namespace."
+  task :import => :environment do
+    namespaces = (ENV['namespace'] || ENV['namespaces']).try(:split, ',')
+    (namespaces ? namespaces.map{ |n| n == 'root' ? nil : n } & c.namespaces : StaticDocs.namespaces).each do |namespace|
+      StaticDocs::Importer.import(namespace)
+    end
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +1,5 @@
 module ApplicationHelper
+  def markdown(text)
+    "<h1>This is original markdown text</h1><pre>#{text}</pre>".html_safe
+  end
 end

data/test/dummy/config/environments/test.rb

@@ -19,7 +19,7 @@ Dummy::Application.configure do
   config.action_controller.perform_caching = false
 
   # Raise exceptions instead of rendering exception templates
-  config.action_dispatch.show_exceptions = false
+  config.action_dispatch.show_exceptions = true
 
   # Disable request forgery protection in test environment
   config.action_controller.allow_forgery_protection    = false

data/test/dummy/config/initializers/static_docs.rb

@@ -0,0 +1,13 @@
+StaticDocs.setup do
+  source 'sources/root'
+  source 'sources/namespace', :namespace => :namespace
+
+  renderer :md do |body|
+    markdown(body)
+  end
+
+  renderer :txt do |body, page|
+    page.meta[:test] = 'test'
+    page.meta[:test] * 3
+  end
+end

data/test/dummy/config/routes.rb

@@ -1,4 +1,4 @@
 Rails.application.routes.draw do
 
-  mount StaticDocs::Engine => "/static_docs"
+  mount StaticDocs::Engine => "/"
 end

data/test/dummy/db/migrate/20130502133441_create_static_docs_pages.static_docs.rb

@@ -0,0 +1,17 @@
+# This migration comes from static_docs (originally 20130502102206)
+class CreateStaticDocsPages < ActiveRecord::Migration
+  def change
+    create_table :static_docs_pages do |t|
+      t.string :title
+      t.string :path
+      t.string :namespace
+      t.text :body, :limit => 64.kilobytes + 1
+      t.string :extension
+
+      t.timestamps
+    end
+
+    add_index :static_docs_pages, :path
+    add_index :static_docs_pages, :namespace
+  end
+end

data/test/dummy/db/schema.rb

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20130502133441) do
+
+  create_table "static_docs_pages", :force => true do |t|
+    t.string   "title"
+    t.string   "path"
+    t.string   "namespace"
+    t.text     "body",       :limit => 65537
+    t.string   "extension"
+    t.datetime "created_at",                  :null => false
+    t.datetime "updated_at",                  :null => false
+  end
+
+  add_index "static_docs_pages", ["namespace"], :name => "index_static_docs_pages_on_namespace"
+  add_index "static_docs_pages", ["path"], :name => "index_static_docs_pages_on_path"
+
+end

data/test/dummy/log/development.log

@@ -0,0 +1,56 @@
+Connecting to database specified by database.yml
+   (0.2ms)  select sqlite_version(*)
+   (1.0ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.4ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (2.8ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Migrating to CreateStaticDocsPages (20130502133441)
+   (0.0ms)  begin transaction
+   (0.4ms)  CREATE TABLE "static_docs_pages" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "path" varchar(255), "body" text(65537), "extension" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20130502133441')
+   (0.9ms)  commit transaction
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Connecting to database specified by database.yml
+   (1.3ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.2ms)  select sqlite_version(*)
+   (1.5ms)  CREATE TABLE "static_docs_pages" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "path" varchar(255), "body" text(65537), "extension" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (1.0ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.1ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (0.8ms)  INSERT INTO "schema_migrations" (version) VALUES ('20130502133441')
+Connecting to database specified by database.yml
+   (4.0ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Migrating to CreateStaticDocsPages (20130502133441)
+   (0.0ms)  select sqlite_version(*)
+   (0.0ms)  begin transaction
+   (1.4ms)  DROP TABLE "static_docs_pages"
+   (0.1ms)  DELETE FROM "schema_migrations" WHERE "schema_migrations"."version" = '20130502133441'
+   (0.8ms)  commit transaction
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Connecting to database specified by database.yml
+   (1.3ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Migrating to CreateStaticDocsPages (20130502133441)
+   (0.1ms)  select sqlite_version(*)
+   (0.1ms)  begin transaction
+   (0.1ms)  rollback transaction
+Connecting to database specified by database.yml
+   (21.8ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Migrating to CreateStaticDocsPages (20130502133441)
+   (0.1ms)  select sqlite_version(*)
+   (0.0ms)  begin transaction
+   (1.6ms)  CREATE TABLE "static_docs_pages" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "path" varchar(255), "namespace" varchar(255), "body" text(65537), "extension" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (0.5ms)  CREATE INDEX "index_static_docs_pages_on_path" ON "static_docs_pages" ("path")
+   (0.2ms)  CREATE INDEX "index_static_docs_pages_on_namespace" ON "static_docs_pages" ("namespace")
+   (0.2ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20130502133441')
+   (1.1ms)  commit transaction
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Connecting to database specified by database.yml
+   (20.9ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.5ms)  select sqlite_version(*)
+   (1.4ms)  CREATE TABLE "static_docs_pages" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "path" varchar(255), "namespace" varchar(255), "body" text(65537), "extension" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
+   (1.0ms)  CREATE INDEX "index_static_docs_pages_on_namespace" ON "static_docs_pages" ("namespace")
+   (0.9ms)  CREATE INDEX "index_static_docs_pages_on_path" ON "static_docs_pages" ("path")
+   (1.1ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (1.0ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (1.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('20130502133441')