ood_appkit 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a7f419914552815e3d0bb2c9af6bd27c0fca870
+  data.tar.gz: 7a0f816f4127b63a478cd018b69e7ab01a82f50e
+SHA512:
+  metadata.gz: 68fd62b19a15d3c5ab89a45ce538dd7ab14deb664d4d6df69de87ae34dbfed859821341f9c0efdadaba47c4405ec7196a00ef82451bd4de943261d8fe0a53a79
+  data.tar.gz: ec99f9ae001b642eb4e2dbbd7a47858037c7f6b085319c04029423325b5ed4c5126f5fded3b5d5a25aa168b2c4c6d0d3a3f230c5e78dc54ff7b7486ca8f507ee

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015-2016 Ohio Supercomputer Center
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,395 @@
+## Installation
+
+To use, add this line to your application's Gemfile:
+
+    gem 'ood_appkit'
+
+And then execute:
+
+    bundle install
+
+## Usage
+
+### Rake Tasks
+
+#### reset
+
+Running this rake task
+
+```bash
+bin/rake ood_appkit:reset
+```
+
+will clear the Rails cache and update the timestamp on the `tmp/restart.txt`
+file that is used by Passenger to decide whether to restart the application.
+
+### URL Handlers for System Apps
+
+#### Public URL
+
+This is the URL used to access publicly available assets provided by the OOD
+infrastructure, e.g., the `favicon.ico`.
+
+```erb
+<%= favicon_link_tag nil, href: OodAppkit.public.url.join('favicon.ico') %>
+```
+
+Note: We used `nil` here as the source otherwise Rails will try to prepend the
+`RAILS_RELATIVE_URL_ROOT` to it. We explicitly define the link using `href:`
+instead.
+
+You can change the options using environment variables:
+
+```bash
+OOD_PUBLIC_URL='/public'
+OOD_PUBLIC_TITLE='Public Assets'
+```
+
+Or by modifying the configuration in an initializer:
+
+```ruby
+# config/initializers/ood_appkit.rb
+
+OodAppkit.configure do |config|
+  # Defaults
+  config.public = OodAppkit::PublicUrl.new title: 'Public Assets', base_url: '/public'
+end
+```
+
+#### Dashboard URL
+
+```erb
+<%= link_to OodAppkit.dashboard.title, OodAppkit.dashboard.url.to_s %>
+```
+
+You can change the options using environment variables:
+
+```bash
+OOD_DASHBOARD_URL='/pun/sys/dashboard'
+OOD_DASHBOARD_TITLE='Dashboard'
+```
+
+Or by modifying the configuration in an initializer:
+
+```ruby
+# config/initializers/ood_appkit.rb
+
+OodAppkit.configure do |config|
+  # Defaults
+  config.dashboard = OodAppkit::DashboardUrl.new title: 'Dashboard', base_url: '/pun/sys/dashboard'
+end
+```
+
+#### Files App
+
+```erb
+<%# Link to the Files app %>
+<%= link_to OodAppkit.files.title, OodAppkit.files.url.to_s %>
+
+<%# Link to open files app to specified directory %>
+<%= link_to "/path/to/file", OodAppkit.files.url(path: "/path/to/file").to_s %>
+<%= link_to "/path/to/file", OodAppkit.files.url(path: Pathname.new("/path/to/file")).to_s %>
+
+<%# Link to retrieve API info for given file %>
+<%= link_to "/path/to/file", OodAppkit.files.api(path: "/path/to/file").to_s %>
+```
+
+You can change the options using environment variables:
+
+```bash
+OOD_FILES_URL='/pun/sys/files'
+OOD_FILES_TITLE='Files'
+```
+
+Or by modifying the configuration in an initializer:
+
+```ruby
+# config/initializers/ood_appkit.rb
+
+OodAppkit.configure do |config|
+  # Defaults
+  config.files = OodAppkit::FilesUrl.new title: 'Files', base_url: '/pun/sys/files'
+end
+```
+
+#### Shell App
+
+```erb
+<%# Link to the Shell app %>
+<%= link_to OodAppkit.shell.title, OodAppkit.shell.url.to_s %>
+
+<%# Link to launch Shell app for specified host %>
+<%= link_to "Ruby Shell", OodAppkit.shell.url(host: "ruby").to_s %>
+
+<%# Link to launch Shell app in specified directory %>
+<%= link_to "Shell in /path/to/dir", OodAppkit.shell.url(path: "/path/to/dir").to_s %>
+
+<%# Link to launch Shell app for specified host in directory %>
+<%= link_to "Ruby in /path/to/dir", OodAppkit.shell.url(host: "ruby", path: "/path/to/dir").to_s %>
+```
+
+You can change the options using environment variables:
+
+```bash
+OOD_SHELL_URL='/pun/sys/shell'
+OOD_SHELL_TITLE='Shell'
+```
+
+Or by modifying the configuration in an initializer:
+
+```ruby
+# config/initializers/ood_appkit.rb
+
+OodAppkit.configure do |config|
+  # Defaults
+  config.shell = OodAppkit::ShellUrl.new title: 'Shell', base_url: '/pun/sys/shell'
+end
+```
+
+### Rack Middleware for handling Files under Dataroot
+
+This mounts all the files under the `OodAppkit.dataroot` using the following route
+by default:
+
+```ruby
+# config/routes.rb
+
+mount OodAppkit::FilesRackApp.new => '/files', as: :files
+```
+
+To disable this generated route:
+
+```ruby
+# config/initializers/ood_appkit.rb
+
+OodAppkit.configure do |config|
+  config.routes.files_rack_app = false
+end
+```
+
+To add a new route:
+
+```ruby
+# config/routes.rb
+
+# rename URI from '/files' to '/dataroot'
+mount OodAppkit::FilesRackApp.new => '/dataroot', as: :files
+
+# create new route with root set to '/tmp' on filesystem
+mount OodAppkit::FilesRackApp.new(root: '/tmp') => '/tmp', as: :tmp
+```
+
+### Wiki Static Page Engine
+
+This gem comes with a wiki static page engine. It uses the supplied markdown
+handler to display GitHub style wiki pages.
+
+By default the route is generated for you:
+
+```ruby
+# config/routes.rb
+
+get 'wiki/*page' => 'ood_appkit/wiki#show', as: :wiki, content_path: 'wiki'
+```
+
+and can be accessed within your app by
+
+```erb
+<%= link_to "Documentation", wiki_path('Home') %>
+```
+
+To disable this generated route:
+
+```ruby
+# config/initializers/ood_appkit.rb
+
+OodAppkit.configure do |config|
+  config.routes.wiki = false
+end
+```
+
+To change (disable route first) or add a new route:
+
+```ruby
+# config/routes.rb
+
+# can modify URI as well as file system content path where files reside
+get 'tutorial/*page' => 'ood_appkit/wiki#show', as: :tutorial, content_path: '/path/to/my_tutorial'
+
+# can use your own controller
+get 'wiki/*page' => 'my_wiki#show', as: :wiki, content_path: 'wiki'
+```
+
+You can use your own controller by including the appropriate concern:
+
+```ruby
+# app/controllers/my_wiki_controller.rb
+class MyWikiController < ApplicationController
+  include OodAppkit::WikiPage
+
+  layout :layout_for_page
+
+  private
+    def layout_for_page
+      'wiki_layout'
+    end
+end
+```
+
+And add a show view for this controller:
+
+```erb
+<%# app/views/my_wiki/show.html.erb %>
+
+<div class="ood-appkit markdown">
+  <div class="row">
+    <div class="col-md-8 col-md-offset-2">
+      <%= render file: @page %>
+    </div>
+  </div>
+</div>
+```
+
+### Override Bootstrap Variables
+
+You can easily override any bootstrap variable using environment variables:
+
+```bash
+# BOOTSTRAP_<variable>='<value>'
+
+# Change font sizes
+BOOTSTRAP_FONT_SIZE_H1='50px'
+BOOTSTRAP_FONT_SIZE_H2='24px'
+
+# Re-use variables
+BOOTSTRAP_GRAY_BASE='#000'
+BOOTSTRAP_GRAY_DARKER='lighten($gray-base, 13.5%)'
+BOOTSTRAP_GRAY_DARK='lighten($gray-base, 20%)'
+```
+
+The variables can also be overridden in an initializer:
+
+```ruby
+# config/initializers/ood_appkit.rb
+
+OodAppkit.configure do |config|
+  # These are the defaults
+  config.bootstrap.navbar_inverse_bg = '#53565a'
+  config.bootstrap.navbar_inverse_link_color = '#fff'
+  config.bootstrap.navbar_inverse_color = '$navbar-inverse-link-color'
+  config.bootstrap.navbar_inverse_link_hover_color = 'darken($navbar-inverse-link-color, 20%)'
+  config.bootstrap.navbar_inverse_brand_color = '$navbar-inverse-link-color'
+  config.bootstrap.navbar_inverse_brand_hover_color = '$navbar-inverse-link-hover-color'
+end
+```
+
+You **MUST** import the bootstrap overrides into your stylesheets
+for these to take effect
+
+```scss
+// app/assets/stylesheets/application.scss
+
+// load the bootstrap sprockets first
+@import "bootstrap-sprockets";
+
+// this MUST occur before you import bootstrap
+@import "ood_appkit/bootstrap-overrides";
+
+// this MUST occur after the bootstrap overrides
+@import "bootstrap";
+```
+
+### Markdown Handler
+
+A simple markdown handler is included with this gem. Any views with the
+extensions `*.md` or `*.markdown` will be handled using the `Redcarpet` gem.
+The renderer can be modified as such:
+
+```ruby
+# config/initializers/ood_appkit.rb
+
+OodAppkit.configure do |config|
+  # Default
+  config.markdown = Redcarpet::Markdown.new(
+    Redcarpet::Render::HTML,
+    autolink: true,
+    tables: true,
+    strikethrough: true,
+    fenced_code_blocks: true,
+    no_intra_emphasis: true
+  )
+end
+```
+
+Really any object can be used that responds to `#render`.
+
+Note: You will need to import the appropriate stylesheet if you want the
+rendered markdown to resemble GitHub's display of markdown.
+
+```scss
+// app/assets/stylesheets/application.scss
+
+@import "ood_appkit/markdown";
+```
+
+It is also included if you import the default stylesheet:
+
+
+```scss
+// app/assets/stylesheets/application.scss
+
+@import "ood_appkit";
+```
+
+## Branding Features
+
+To take advantage of branding features you must import it in your stylesheet:
+
+```scss
+// app/assets/stylesheets/application.scss
+
+@import "ood_appkit/branding";
+```
+
+It is also included if you import the default stylesheet:
+
+
+```scss
+// app/assets/stylesheets/application.scss
+
+@import "ood_appkit";
+```
+
+### Navbar Breadcrumbs
+
+One such branding feature is the `navbar-breadcrumbs`. It is used to accentuate
+the tree like style of the app in the navbar. It is used as such:
+
+```erb
+<nav class="ood-appkit navbar navbar-inverse navbar-static-top" role="navigation">
+  <div class="navbar-header">
+    ...
+    <ul class="navbar-breadcrumbs">
+      <li><%= link_to OodAppkit.dashboard.title, OodAppkit.dashboard.url.to_s %></li>
+      <li><%= link_to 'MyApp', root_path %></li>
+      <li><%= link_to 'Meshes', meshes_path %></li>
+    </ul>
+  </div>
+
+  ...
+</nav>
+```
+
+Note that you must include `ood-appkit` as a class in the `nav` tag. The
+breadcrumbs style will resemble the `navbar-brand` style.
+
+## Develop
+
+Generated using:
+
+    rails plugin new ood_appkit --full --skip-bundle
+
+
+## License
+
+This gem is released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'OodAppkit'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/stylesheets/_ood_appkit.scss

@@ -0,0 +1,2 @@
+@import "ood_appkit/branding";
+@import "ood_appkit/markdown";

data/app/assets/stylesheets/ood_appkit/_bootstrap-overrides.scss.erb

@@ -0,0 +1,3 @@
+<% OodAppkit.bootstrap.each_pair do |k, v| %>
+$<%= k.to_s.dasherize %>: <%= v %>;
+<% end %>

data/app/assets/stylesheets/ood_appkit/_branding.scss

@@ -0,0 +1,2 @@
+// @import "branding/bootstrap-overrides";
+@import "branding/navbar";

data/app/assets/stylesheets/ood_appkit/_markdown.scss

@@ -0,0 +1,66 @@
+.ood-appkit.markdown {
+  font-size: 16px;
+  line-height: 1.6;
+  h1 {
+    margin-right: 150px;
+    font-size: 30px;
+    font-weight: normal;
+    line-height: 1.1;
+  }
+  h2 {
+    padding-bottom: 0.3em;
+    margin-top: 1em;
+    margin-bottom: 16px;
+    font-size: 1.75em;
+    font-weight: bold;
+    line-height: 1.225;
+  }
+  h3 {
+    margin-top: 1em;
+    margin-bottom: 16px;
+    font-size: 1.5em;
+    font-weight: bold;
+    line-height: 1.43;
+  }
+  h4 {
+    margin-top: 1em;
+    margin-bottom: 16px;
+    font-size: 1.25em;
+    font-weight: bold;
+    line-height: 1.4;
+  }
+  img {
+    border: 0;
+    max-width: 100%;
+  }
+  p {
+    margin-top: 0;
+    margin-bottom: 16px;
+  }
+  li > p {
+    margin-top: 16px;
+  }
+  table {
+    display: block;
+    width: 100%;
+    overflow: auto;
+    word-break: keep-all;
+
+    // .markdown p, .markdown table, ...
+    margin-top: 0;
+    margin-bottom: 16px;
+
+    tr {
+      border-top: 1px solid #ccc;
+    }
+
+    tr:nth-child(2n) td{
+      background-color: #f8f8f8;
+    }
+
+    th, td {
+      padding: 6px 13px;
+      border: 1px solid #ddd;
+    }
+  }
+}

data/app/assets/stylesheets/ood_appkit/branding/_navbar.scss

@@ -0,0 +1,96 @@
+%navbar-brand {
+  float: left;
+  padding: $navbar-padding-vertical $navbar-padding-horizontal;
+  font-size: $font-size-large;
+  line-height: $line-height-computed;
+  height: $navbar-height;
+
+  &:hover,
+  &:focus {
+    text-decoration: none;
+  }
+
+  > img {
+    display: block;
+  }
+
+  @media (min-width: $grid-float-breakpoint) {
+    .navbar > .container &,
+    .navbar > .container-fluid & {
+      margin-left: -$navbar-padding-horizontal;
+    }
+  }
+}
+
+.ood-appkit.navbar {
+  ul.navbar-breadcrumbs {
+    list-style-type: none;
+    display: inline;
+    margin: 0;
+    padding: 0;
+
+    > li {
+      display: inline;
+
+      > a {
+        @extend %navbar-brand;
+      }
+
+      + li:before {
+        @extend %navbar-brand;
+        padding: $navbar-padding-vertical 0;
+        content: '/';
+      }
+    }
+  }
+
+  &.navbar-default {
+    ul.navbar-breadcrumbs > li {
+      > a {
+        color: $navbar-default-brand-hover-color;
+        &:hover,
+        &:focus {
+          color: $navbar-default-brand-color;
+          background-color: $navbar-default-brand-hover-bg;
+        }
+      }
+
+      &:last-child > a {
+        color: $navbar-default-brand-color;
+        &:hover,
+        &:focus {
+          color: $navbar-default-brand-hover-color;
+        }
+      }
+
+      + li:before {
+        color: $navbar-default-brand-hover-color;
+      }
+    }
+  }
+
+  &.navbar-inverse {
+    ul.navbar-breadcrumbs > li {
+      > a {
+        color: $navbar-inverse-brand-hover-color;
+        &:hover,
+        &:focus {
+          color: $navbar-inverse-brand-color;
+          background-color: $navbar-inverse-brand-hover-bg;
+        }
+      }
+
+      &:last-child > a {
+        color: $navbar-inverse-brand-color;
+        &:hover,
+        &:focus {
+          color: $navbar-inverse-brand-hover-color;
+        }
+      }
+
+      + li:before {
+        color: $navbar-inverse-brand-hover-color;
+      }
+    }
+  }
+}

data/app/controllers/concerns/ood_appkit/wiki_page.rb

@@ -0,0 +1,23 @@
+# A concern that can be included into an `ApplicationController` that displays
+# static relative-linked pages.
+module OodAppkit::WikiPage
+  extend ActiveSupport::Concern
+
+  # 'included do' causes the included code to be evaluated in the context where
+  # it is included (wiki_controller.rb), rather than being executed in the
+  # module's context (wiki_page.rb).
+  included do
+    # prepend_view_path "docs"
+  end
+
+  # GET /wiki/Home
+  # GET /wiki/uploads/project.zip
+  def show
+    @page = Rails.root.join(params['content_path']).join("#{params['page']}")
+
+    respond_to do |format|
+      format.html
+      format.all { send_file "#{@page}.#{params[:format]}", disposition: 'inline' }
+    end
+  end
+end

data/app/controllers/ood_appkit/wiki_controller.rb

@@ -0,0 +1,4 @@
+# A controller for a GitHub style wiki
+class OodAppkit::WikiController < ApplicationController
+  include OodAppkit::WikiPage
+end

data/app/views/ood_appkit/wiki/show.html.erb

@@ -0,0 +1,7 @@
+<div class="ood-appkit markdown">
+  <div class="row">
+    <div class="col-md-8 col-md-offset-2">
+      <%= render file: @page %>
+    </div>
+  </div>
+</div>

data/config/routes.rb

@@ -0,0 +1,11 @@
+Rails.application.routes.draw do
+  # Route for a Rack::Directory middleware app
+  if OodAppkit.routes.files_rack_app
+    mount OodAppkit::FilesRackApp.new => '/files', as: :files
+  end
+
+  # Route for hosting GitHub style wiki
+  if OodAppkit.routes.wiki
+    get 'wiki/*page' => 'ood_appkit/wiki#show', as: :wiki, content_path: 'wiki'
+  end
+end