static_docs 0.0.1 → 0.1.0

data/test/dummy/sources/namespace/home.html

@@ -0,0 +1 @@
+<p>Hello from namespace!</p>

data/test/dummy/sources/namespace/index.yml

@@ -0,0 +1,9 @@
+special:
+  - title:    Namespace Main Page
+    path:     home
+    file:     home.html
+
+pages:
+  - title:    This is Just Namespaced Page
+    path:     page
+    file:     page.html

data/test/dummy/sources/namespace/page.html

@@ -0,0 +1 @@
+<p>Hello, Namespace!</p>

data/test/dummy/sources/root/getting_started.html

@@ -0,0 +1 @@
+<p>Welcome, Newbie!</p>

data/test/dummy/sources/root/home.html

@@ -0,0 +1 @@
+<p>Hello from homepage!</p>

data/test/dummy/sources/root/index.yml

@@ -0,0 +1,13 @@
+special:
+  - title:    Main Page
+    path:     home
+    file:     home.html
+
+pages:
+  - title:    Getting Started
+    path:     getting-started
+    file:     getting_started.html
+
+  - title:    This is Just Page
+    path:     page
+    file:     page.html

data/test/dummy/sources/root/page.html

@@ -0,0 +1 @@
+<p>Hello, World!</p>

data/test/fixtures/static_docs/pages.yml

@@ -0,0 +1,51 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/Fixtures.html
+
+home_page:
+  title: Main page
+  path: home
+  body: '<h3>This is home page</h3>'
+  extension: html
+
+first_level_page:
+  title: First Level Page
+  path: 'page'
+  body: '<h3>This is first level page</h3>'
+  extension: html
+
+deep_page:
+  title: First Level Page
+  path: 'path/to/page'
+  body: '<h3>This is third level page</h3>'
+  extension: html
+
+namespaced_page:
+  title: Namespaced Page
+  path: 'page'
+  namespace: 'namespace'
+  body: '<h3>This is namespaced page</h3>'
+  extension: html
+
+deep_page_like_namespaced:
+  title: Namespaced Page
+  path: 'namespace/page'
+  body: '<h3>This is not namespaced page</h3>'
+  extension: html
+
+wrong_namespaced_page:
+  title: Wrong Namespaced Page
+  path: 'page'
+  namespace: 'wrong'
+  body: '<h3>This is wrong namespaced page</h3>'
+  extension: html
+  
+markdown_page:
+  title: Markdown Page
+  path: 'markdown'
+  body: '### This is markdown page'
+  extension: md
+
+text_page:
+  title: Text Page
+  path: 'text'
+  body: 'some text'
+  extension: txt

data/test/functional/static_docs/pages_controller_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+
+module StaticDocs
+  class PagesControllerTest < ActionController::TestCase
+    # test "the truth" do
+    #   assert true
+    # end
+  end
+end

data/test/integration/navigation_test.rb

@@ -3,8 +3,26 @@ require 'test_helper'
 class NavigationTest < ActionDispatch::IntegrationTest
   fixtures :all
 
-  # test "the truth" do
-  #   assert true
-  # end
-end
+  test 'browse pages' do
+    get '/'
+    assert_response :success
+    assert_select 'title', {:text => 'Dummy'}, 'Page must be rendered within application layout'
+    assert_select 'h3', {:text => 'This is home page'}
+
+    get '/page'
+    assert_response :success
+    assert_select 'h3', {:text => 'This is first level page'}
+    assert_select 'body', /This is first level page/
+
+    get '/namespace/page'
+    assert_response :success
+    assert_select 'h3', {:text => 'This is namespaced page'}
 
+    get '/markdown'
+    assert_response :success
+    assert_select 'pre', {:text => '### This is markdown page'}
+
+    get '/wrong'
+    assert_response :not_found
+  end
+end

data/test/static_docs_test.rb

@@ -4,4 +4,11 @@ class StaticDocsTest < ActiveSupport::TestCase
   test "truth" do
     assert_kind_of Module, StaticDocs
   end
+
+  test 'setup' do
+    assert_equal StaticDocs.sources[nil], 'sources/root'
+    assert_equal StaticDocs.sources[:namespace], 'sources/namespace'
+
+    assert StaticDocs.renderers[:default].keys.include? 'md'
+  end
 end

data/test/test_helper.rb

@@ -4,8 +4,6 @@ ENV["RAILS_ENV"] = "test"
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 require "rails/test_help"
 
-Rails.backtrace_cleaner.remove_silencers!
-
 # Load support files
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
 

data/test/unit/helpers/static_docs/pages_helper_test.rb

@@ -0,0 +1,6 @@
+require 'test_helper'
+
+module StaticDocs
+  class PagesHelperTest < ActionView::TestCase
+  end
+end

data/test/unit/static_docs/importer_test.rb

@@ -0,0 +1,52 @@
+require 'test_helper'
+require "static_docs/importer"
+
+module StaticDocs
+  class ImporterTest < ActiveSupport::TestCase
+    fixtures 'static_docs/pages'
+
+    def setup
+      @importer = Importer.new(nil)
+    end
+
+    test 'source' do
+      src = File.expand_path("../../../dummy/sources/root", __FILE__)
+      assert_equal src, @importer.source.to_s
+    end
+
+    test 'config' do
+      assert @importer.config['special'].present?
+      assert @importer.config['pages'].present?
+    end
+
+    test 'cleanup' do
+      @importer.cleanup
+      assert_equal Page.find(static_docs_pages(:first_level_page).id), static_docs_pages(:first_level_page)
+      assert_raise(ActiveRecord::RecordNotFound){ Page.find(static_docs_pages(:deep_page).id) }
+    end
+
+    test 'import root' do
+      Importer.import(nil)
+      main = Page.matched('home')
+      assert_equal main.title, 'Main Page'
+      assert_equal main.extension, 'html'
+      assert_equal main.body, "<p>Hello from homepage!</p>\n"
+      assert_equal main.namespace, nil
+
+      assert_equal Page.matched('page').title, 'This is Just Page'
+      assert_equal Page.matched('getting-started').title, 'Getting Started'
+    end
+
+    test 'import namespaced' do
+      Importer.import('namespace')
+      main = Page.matched('namespace/home')
+      assert_equal main.title, 'Namespace Main Page'
+      assert_equal main.extension, 'html'
+      assert_equal main.body, "<p>Hello from namespace!</p>\n"
+      assert_equal main.namespace, 'namespace'
+
+      assert_equal Page.matched('namespace/page').title, 'This is Just Namespaced Page'
+    end
+
+  end
+end

data/test/unit/static_docs/page_test.rb

@@ -0,0 +1,46 @@
+require 'test_helper'
+
+module StaticDocs
+  class PageTest < ActiveSupport::TestCase
+    fixtures 'static_docs/pages'
+
+    setup do
+      @view_context = Object.new.extend ::ApplicationHelper
+    end
+
+    test "first-level search of matched page" do
+      assert_equal Page.matched('page'), static_docs_pages(:first_level_page)
+    end
+
+    test "deep search of matched page" do
+      assert_equal Page.matched('path/to/page'), static_docs_pages(:deep_page)
+    end
+
+    test "namespaced search of matched page" do
+      assert_equal Page.matched('namespace/page'), static_docs_pages(:namespaced_page)
+    end
+
+    test "search in unregistered namespace" do
+      assert_raise(ActiveRecord::RecordNotFound){ Page.matched('wrong/page') }
+    end
+
+    test "search of nonexistent page" do
+      assert_raise(ActiveRecord::RecordNotFound){ Page.matched('wrong') }
+    end
+
+    test 'simple renderer' do
+      assert_equal Page.matched('page').rendered_body(@view_context), '<h3>This is first level page</h3>'
+    end
+
+    test 'contextual renderer' do
+      str = "<h1>This is original markdown text</h1><pre>### This is markdown page</pre>"
+      assert_equal Page.matched('markdown').rendered_body(@view_context), str
+    end
+
+    test 'meta setting in renderer' do
+      page = Page.matched('text')
+      assert_equal page.rendered_body(@view_context), 'testtesttest'
+      assert_equal page.meta[:test], 'test'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: static_docs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,12 +53,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - app/assets/javascripts/static_docs/application.js
+- app/assets/javascripts/static_docs/pages.js
 - app/assets/stylesheets/static_docs/application.css
+- app/assets/stylesheets/static_docs/pages.css
 - app/controllers/static_docs/application_controller.rb
+- app/controllers/static_docs/pages_controller.rb
 - app/helpers/static_docs/application_helper.rb
-- app/views/layouts/static_docs/application.html.erb
+- app/helpers/static_docs/pages_helper.rb
+- app/models/static_docs/page.rb
+- app/views/static_docs/pages/show.html.erb
 - config/routes.rb
+- db/migrate/20130502102206_create_static_docs_pages.rb
 - lib/static_docs/engine.rb
+- lib/static_docs/importer.rb
 - lib/static_docs/version.rb
 - lib/static_docs.rb
 - lib/tasks/static_docs_tasks.rake
@@ -82,10 +89,18 @@ files:
 - test/dummy/config/initializers/mime_types.rb
 - test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/static_docs.rb
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config.ru
+- test/dummy/db/development.sqlite3
+- test/dummy/db/migrate/20130502133441_create_static_docs_pages.static_docs.rb
+- test/dummy/db/schema.rb
+- test/dummy/db/test.sqlite3
+- test/dummy/log/development.log
+- test/dummy/log/production.log
+- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -93,9 +108,21 @@ files:
 - test/dummy/Rakefile
 - test/dummy/README.rdoc
 - test/dummy/script/rails
+- test/dummy/sources/namespace/home.html
+- test/dummy/sources/namespace/index.yml
+- test/dummy/sources/namespace/page.html
+- test/dummy/sources/root/getting_started.html
+- test/dummy/sources/root/home.html
+- test/dummy/sources/root/index.yml
+- test/dummy/sources/root/page.html
+- test/fixtures/static_docs/pages.yml
+- test/functional/static_docs/pages_controller_test.rb
 - test/integration/navigation_test.rb
 - test/static_docs_test.rb
 - test/test_helper.rb
+- test/unit/helpers/static_docs/pages_helper_test.rb
+- test/unit/static_docs/importer_test.rb
+- test/unit/static_docs/page_test.rb
 homepage: https://github.com/Mik-die/static_docs
 licenses: []
 post_install_message: 
@@ -110,7 +137,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2426193905390078025
+      hash: 1507088232620583790
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -119,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2426193905390078025
+      hash: 1507088232620583790
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -144,10 +171,18 @@ test_files:
 - test/dummy/config/initializers/mime_types.rb
 - test/dummy/config/initializers/secret_token.rb
 - test/dummy/config/initializers/session_store.rb
+- test/dummy/config/initializers/static_docs.rb
 - test/dummy/config/initializers/wrap_parameters.rb
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config.ru
+- test/dummy/db/development.sqlite3
+- test/dummy/db/migrate/20130502133441_create_static_docs_pages.static_docs.rb
+- test/dummy/db/schema.rb
+- test/dummy/db/test.sqlite3
+- test/dummy/log/development.log
+- test/dummy/log/production.log
+- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -155,6 +190,18 @@ test_files:
 - test/dummy/Rakefile
 - test/dummy/README.rdoc
 - test/dummy/script/rails
+- test/dummy/sources/namespace/home.html
+- test/dummy/sources/namespace/index.yml
+- test/dummy/sources/namespace/page.html
+- test/dummy/sources/root/getting_started.html
+- test/dummy/sources/root/home.html
+- test/dummy/sources/root/index.yml
+- test/dummy/sources/root/page.html
+- test/fixtures/static_docs/pages.yml
+- test/functional/static_docs/pages_controller_test.rb
 - test/integration/navigation_test.rb
 - test/static_docs_test.rb
 - test/test_helper.rb
+- test/unit/helpers/static_docs/pages_helper_test.rb
+- test/unit/static_docs/importer_test.rb
+- test/unit/static_docs/page_test.rb

data/app/views/layouts/static_docs/application.html.erb

@@ -1,14 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>StaticDocs</title>
-  <%= stylesheet_link_tag    "static_docs/application", :media => "all" %>
-  <%= javascript_include_tag "static_docs/application" %>
-  <%= csrf_meta_tags %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>