ood_appkit 0.0.2

data/lib/ood_appkit/configuration.rb

@@ -0,0 +1,100 @@
+require 'redcarpet'
+require 'ostruct'
+
+module OodAppkit
+  # An object that stores and adds configuration options.
+  module Configuration
+    # Location where app data is stored on local filesystem
+    # @return [Pathname, nil] path to app data
+    def dataroot
+      Pathname.new(@dataroot) if @dataroot
+    end
+    attr_writer :dataroot
+
+    # A markdown renderer used when rendering `*.md` or `*.markdown` views
+    # @return [Redcarpet::Markdown] the markdown renderer used
+    attr_accessor :markdown
+
+    # Public assets url handler
+    # @return [PublicUrl] the url handler for the publicly available assets
+    attr_accessor :public
+
+    # System dashboard app url handler
+    # @return [DashboardUrl] the url handler for the system dashboard app
+    attr_accessor :dashboard
+
+    # System shell app url handler
+    # @return [ShellUrl] the url handler for the system shell app
+    attr_accessor :shell
+
+    # System files app url handler
+    # @return [FilesUrl] the url handler for the system files app
+    attr_accessor :files
+
+    # Whether to auto-generate default routes for helpful apps/features
+    # @return [OpenStruct] whether to generate routes for apps
+    attr_accessor :routes
+
+    # Override Boostrap SASS variables in app
+    # @return [OpenStruct] bootstrap variables to override
+    attr_accessor :bootstrap
+
+    # Customize configuration for this object.
+    # @yield [self]
+    def configure
+      yield self
+    end
+
+    # Sets the default configuration for this object.
+    # @return [void]
+    def set_default_configuration
+      ActiveSupport::Deprecation.warn("The environment variable RAILS_DATAROOT will be deprecated in an upcoming release, please use OOD_DATAROOT instead.") if ENV['RAILS_DATAROOT']
+      self.dataroot = ENV['OOD_DATAROOT'] || ENV['RAILS_DATAROOT']
+
+      # Add markdown template support
+      self.markdown = Redcarpet::Markdown.new(
+        Redcarpet::Render::HTML,
+        autolink: true,
+        tables: true,
+        strikethrough: true,
+        fenced_code_blocks: true,
+        no_intra_emphasis: true
+      )
+
+      # Initialize URL handlers for system apps
+      self.public    = PublicUrl.new(
+        title:    ENV['OOD_PUBLIC_TITLE'] || 'Public Assets',
+        base_url: ENV['OOD_PUBLIC_URL']   || '/public'
+      )
+      self.dashboard = DashboardUrl.new(
+        title:    ENV['OOD_DASHBOARD_TITLE'] || 'Dashboard',
+        base_url: ENV['OOD_DASHBOARD_URL']   || '/pun/sys/dashboard'
+      )
+      self.shell     = ShellUrl.new(
+        title:    ENV['OOD_SHELL_TITLE'] || 'Shell',
+        base_url: ENV['OOD_SHELL_URL']   || '/pun/sys/shell'
+      )
+      self.files     = FilesUrl.new(
+        title:    ENV['OOD_FILES_TITLE'] || 'Files',
+        base_url: ENV['OOD_FILES_URL']   || '/pun/sys/files'
+      )
+
+      # Add routes for useful features
+      self.routes = OpenStruct.new(
+        files_rack_app: true,
+        wiki: true
+      )
+
+      # Override Bootstrap SASS variables
+      self.bootstrap = OpenStruct.new(
+        navbar_inverse_bg: '#53565a',
+        navbar_inverse_link_color: '#fff',
+        navbar_inverse_color: '$navbar-inverse-link-color',
+        navbar_inverse_link_hover_color: 'darken($navbar-inverse-link-color, 20%)',
+        navbar_inverse_brand_color: '$navbar-inverse-link-color',
+        navbar_inverse_brand_hover_color: '$navbar-inverse-link-hover-color'
+      )
+      ENV.each {|k, v| /^BOOTSTRAP_(?<name>.+)$/ =~ k ? self.bootstrap[name.downcase] = v : nil}
+    end
+  end
+end

data/lib/ood_appkit/dashboard_url.rb

@@ -0,0 +1,26 @@
+module OodAppkit
+  # A class used to handle URLs for the system Dashboard app.
+  class DashboardUrl
+    # The title for this URL
+    # @return [String] the title of the URL
+    attr_reader :title
+
+    # @param title [String] the title of the URL
+    # @param base_url [String] the base URL used to access this app
+    # @param template [String] the template used to generate URLs for this app
+    # @see https://www.rfc-editor.org/rfc/rfc6570.txt RFC describing template format
+    def initialize(title: '', base_url: '/', template: '{/url*}/')
+      @title = title
+      @template = Addressable::Template.new template
+
+      # Break up into arrays of strings
+      @base_url = base_url.split('/').reject(&:empty?)
+    end
+
+    # URL to access this app
+    # @return [Addressable::URI] the url used to access the app
+    def url
+      @template.expand url: @base_url
+    end
+  end
+end

data/lib/ood_appkit/engine.rb

@@ -0,0 +1,23 @@
+module OodAppkit
+  # The Rails Engine that defines the OodAppkit environment
+  class Engine < Rails::Engine
+    # Set default configuration options before initializers are called
+    config.before_initialize do
+      OodAppkit.set_default_configuration
+    end
+
+    # Confirm the `OodAppkit.dataroot` configuration option was set
+    config.after_initialize do
+      raise UndefinedDataroot, "OodAppkit.dataroot must be defined (default: ENV['OOD_DATAROOT'])" unless OodAppkit.dataroot
+    end
+
+    config.to_prepare do
+      # TODO:
+      # make the helper available to all views
+      # i.e. ApplicationController.helper(OodBannerHelper)
+    end
+
+    # An exception raised when `OodAppkit.dataroot` configuration option is undefined
+    class UndefinedDataroot < StandardError; end
+  end
+end

data/lib/ood_appkit/files_rack_app.rb

@@ -0,0 +1,21 @@
+module OodAppkit
+  # Middleware that serves entries below the `root` given, according to the
+  # path info of the Rack request.
+  # @see http://www.rubydoc.info/github/rack/rack/master/Rack/Directory Descripton of `Rack::Directory`
+  class FilesRackApp
+    # The root path on file system that this app serves entries from below
+    # @return [String] the root path
+    attr_accessor :root
+
+    # @param root [String, #to_s] the root path
+    def initialize(root: OodAppkit.dataroot)
+      @root = root.to_s
+    end
+
+    # Use `Rack::Directory` as middleware with `root` set as `dataroot` by
+    # default
+    def call(env)
+      Rack::Directory.new(root).call(env)
+    end
+  end
+end

data/lib/ood_appkit/files_url.rb

@@ -0,0 +1,38 @@
+module OodAppkit
+  # A class used to handle URLs for the system Files app.
+  class FilesUrl
+    # The title for this URL
+    # @return [String] the title of the URL
+    attr_reader :title
+
+    # @param title [String] the title of the URL
+    # @param base_url [String] the base URL used to access this app
+    # @param fs_url [String] the URL used to request a filesystem view in the app
+    # @param api_url [String] the URL used to request the app's api
+    # @param template [String] the template used to generate URLs for this app
+    # @see https://www.rfc-editor.org/rfc/rfc6570.txt RFC describing template format
+    def initialize(title: '', base_url: '/', fs_url: '/fs', api_url: '/api/v1/fs', template: '{/url*}{+path}')
+      @title = title
+      @template = Addressable::Template.new template
+
+      # Break up into arrays of strings
+      @base_url = base_url.split('/').reject(&:empty?)
+      @fs_url   = fs_url.split('/').reject(&:empty?)
+      @api_url  = api_url.split('/').reject(&:empty?)
+    end
+
+    # URL to access this app for a given absolute file path
+    # @param path [String, #to_s] the absolute path to the file on the filesystem
+    # @return [Addressable::URI] absolute url to access path in files app
+    def url(path: '')
+      @template.expand url: @base_url + @fs_url, path: path.to_s
+    end
+
+    # URL to access this app's API for a given absolute file path
+    # @param path [String, #to_s] the absolute path to the file on the filesystem
+    # @return [Addressable::URI] absolute url to access path in files app api
+    def api(path: '')
+      @template.expand url: @base_url + @api_url, path: path.to_s
+    end
+  end
+end

data/lib/ood_appkit/markdown_template_handler.rb

@@ -0,0 +1,27 @@
+module OodAppkit
+  # Class used to handle markdown views in `ActionView::Template`
+  module MarkdownTemplateHandler
+    # String of ruby code to be evaluated when rendering the view
+    # @param template [ActionView::Template] the template to be rendered
+    # @return [String] string of ruby code to be evaluated
+    def self.call(template)
+      "begin;#{render(template.source)}.html_safe;end"
+    end
+
+    # Render markdown to HTML
+    # @param text [String] markdown text
+    # @return [String] escaped version of html text surrounded by quote marks
+    def self.render(text)
+      markdown.render(text).inspect
+    end
+
+    private
+      # Markdown renderer used
+      def self.markdown
+        @markdown ||= OodAppkit.markdown
+      end
+  end
+end
+
+# Register this handler for the various markdown extensions
+ActionView::Template.register_template_handler :md, :markdown, OodAppkit::MarkdownTemplateHandler

data/lib/ood_appkit/public_url.rb

@@ -0,0 +1,26 @@
+module OodAppkit
+  # A class used to handle URLs for the publicly available assets.
+  class PublicUrl
+    # The title for this URL
+    # @return [String] the title of the URL
+    attr_reader :title
+
+    # @param title [String] the title of the URL
+    # @param base_url [String] the base URL used to access this app
+    # @param template [String] the template used to generate URLs for this app
+    # @see https://www.rfc-editor.org/rfc/rfc6570.txt RFC describing template format
+    def initialize(title: '', base_url: '/', template: '{/url*}/')
+      @title = title
+      @template = Addressable::Template.new template
+
+      # Break up into arrays of strings
+      @base_url = base_url.split('/').reject(&:empty?)
+    end
+
+    # URL to access this app
+    # @return [Addressable::URI] the url used to access the app
+    def url
+      @template.expand url: @base_url
+    end
+  end
+end

data/lib/ood_appkit/shell_url.rb

@@ -0,0 +1,29 @@
+module OodAppkit
+  # A class used to handle URLs for the system Shell app.
+  class ShellUrl
+    # The title for this URL
+    # @return [String] the title of the URL
+    attr_reader :title
+
+    # @param title [String] the title of the URL
+    # @param base_url [String] the base URL used to access this app
+    # @param template [String] the template used to generate URLs for this app
+    # @see https://www.rfc-editor.org/rfc/rfc6570.txt RFC describing template format
+    def initialize(title: '', base_url: '/', ssh_url: '/ssh', template: '{/url*}/{host}{+path}')
+      @title = title
+      @template = Addressable::Template.new template
+
+      # Break up into arrays of strings
+      @base_url = base_url.split('/').reject(&:empty?)
+      @ssh_url  = ssh_url.split('/').reject(&:empty?)
+    end
+
+    # URL to access this app for a given host and absolute file path
+    # @param host [String] the host the app will make an ssh connection with
+    # @param path [String, #to_s] the absolute path to the directory ssh app opens up in
+    # @return [Addressable::URI] the url used to access the app
+    def url(path: '', host: 'default')
+      @template.expand url: @base_url + @ssh_url, path: path.to_s, host: host
+    end
+  end
+end

data/lib/ood_appkit/version.rb

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

data/lib/ood_appkit.rb

@@ -0,0 +1,16 @@
+require 'addressable'
+
+require 'ood_appkit/version'
+require 'ood_appkit/configuration'
+require 'ood_appkit/public_url'
+require 'ood_appkit/dashboard_url'
+require 'ood_appkit/shell_url'
+require 'ood_appkit/files_url'
+require 'ood_appkit/files_rack_app'
+require 'ood_appkit/markdown_template_handler'
+
+# The main namespace for OodAppkit. Provides a global configuration.
+module OodAppkit
+  extend Configuration
+  require 'ood_appkit/engine' if defined?(Rails)
+end

data/lib/tasks/ood_appkit_tasks.rake

@@ -0,0 +1,6 @@
+namespace :ood_appkit do
+  desc "Restart the Passenger process for this App"
+  task :restart => "tmp:clear" do
+    touch "tmp/restart.txt"
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

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

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "ood_appkit"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

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

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

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

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end

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

@@ -0,0 +1,36 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  config.serve_static_assets  = true
+  config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+end

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

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!