ood_appkit 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5bd9a3d74e5231ff95a1cb60b518b71d0510264
-  data.tar.gz: bded663456ec091f01d351bec351966f263e9466
+  metadata.gz: c177ccb73485ccb2b696d81115449f50bb62d9dc
+  data.tar.gz: 049ae0e1579bd53c6eee7b1f7135b0c8ad151058
 SHA512:
-  metadata.gz: a0d2ab585bd6f4edb8d8752248b038d4819942fc93f6d0f475b0455e0e4c7e00672ebec356284519c55ecb7c401180f841ee9d7b29c5934e71f20cd3ff3526ea
-  data.tar.gz: f1503287f6655d66c5a68a55c51bceb68aa4a54d4a1790e0e4a83c6daa5f8e7463d40d86bb6c8e12d8a486a4791be6894f1145591a93fdfc6d987816da0d4f7d
+  metadata.gz: cf19980e306e95b4d9d6cb5993a83440ad3c33efbe5bf0a1814e52240f1ef7e036ebed9301600f8f5bd856c4f96e10354ba8065a319b895c5eb71babf337c26f
+  data.tar.gz: 181bb0a5e7b14196416fde67e9fa51b66ab8a1390094204fd47a8efef7cd25ca70b9aa455e80e158f7509ab0ec50502e1535887b0995fe8ab418b518e15a54fd

data/README.md

@@ -1,12 +1,32 @@
+# OOD App Kit
+
+The `ood_appkit` gem is a package of utility functions and engines for
+applications running on the Open OnDemand platform.
+
+Functionality includes:
+* [Rake tasks](#rake-tasks)
+* [URL handlers for OOD System applciations](#url-handlers-for-system-apps)
+* [Rack middleware for handling files under a configured dataroot](#rack-middleware-for-handling-files-under-dataroot)
+* [A wiki static page engine](#wiki-static-page-engine)
+* [Override Bootstrap Variables](#override-bootstrap-variables)
+* [A markdown handler](#markdown-handler)
+* [Custom Log Formatting](#custom-log-formatting)
+* [Branding Features](#branding-features)
+* [Information on Configured Clusters](#cluster-information)
+
 ## Installation
 
 To use, add this line to your application's Gemfile:
 
-    gem 'ood_appkit'
+```bash
+gem 'ood_appkit'
+```
 
 And then execute:
 
-    bundle install
+```bash
+bundle install
+```
 
 ## Usage
 
@@ -329,6 +349,17 @@ for these to take effect
 @import "bootstrap";
 ```
 
+**Note:** After changing an environment variable or configuration option in the
+initalizer you must **clobber** your assets and **restart** the app:
+
+```bash
+# clobber assets
+bin/rake assets:clobber
+
+# restart app
+touch tmp/restart.txt
+```
+
 ### Markdown Handler
 
 A simple markdown handler is included with this gem. Any views with the
@@ -359,6 +390,16 @@ rendered markdown to resemble GitHub's display of markdown.
 ```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";
+
+// this MUST occur after the bootstrap import
 @import "ood_appkit/markdown";
 ```
 
@@ -368,6 +409,16 @@ It is also included if you import the default stylesheet:
 ```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";
+
+// this MUST occur after the bootstrap import
 @import "ood_appkit";
 ```
 
@@ -411,6 +462,16 @@ To take advantage of branding features you must import it in your stylesheet:
 ```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";
+
+// this MUST occur after the bootstrap import
 @import "ood_appkit/branding";
 ```
 
@@ -420,6 +481,16 @@ It is also included if you import the default stylesheet:
 ```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";
+
+// this MUST occur after the bootstrap import
 @import "ood_appkit";
 ```
 
@@ -599,6 +670,8 @@ cluster):
 OOD_CLUSTERS="/path/to/configs.d"
 ```
 
+The default location is: `/etc/ood/config/clusters.d`
+
 ## Develop
 
 Generated using:

data/lib/ood_appkit/configuration.rb

@@ -65,10 +65,14 @@ module OodAppkit
       self.dataroot = ENV['OOD_DATAROOT'] || ENV['RAILS_DATAROOT']
 
       # Initialize list of available clusters
+      c_config = Pathname.new(ENV['OOD_CLUSTERS'] || '/etc/ood/config/clusters.d')
       self.clusters = Clusters.new(
-        ConfigParser.parse(
-          config: ENV['OOD_CLUSTERS'] || Pathname.new('/etc/ood/config/clusters.d')
-        ).map { |k, v| ClusterDecorator.new(id: k.to_sym, **v) }
+        begin
+          ConfigParser.parse(config: c_config).map { |k, v| ClusterDecorator.new(id: k.to_sym, **v) }
+        rescue ConfigParser::InvalidConfigPath
+          STDERR.puts "Invalid cluster config specified: #{c_config}"
+          []
+        end
       )
 
       # Add markdown template support

data/lib/ood_appkit/version.rb

@@ -1,4 +1,4 @@
 module OodAppkit
   # The current version of OodAppkit
-  VERSION = "0.3.2"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ood_appkit
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Eric Franz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-02 00:00:00.000000000 Z
+date: 2016-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails