appril 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24e685cd503a9c6bfec968166f714202f28f361f
+  data.tar.gz: bdd9a95c3d72a26b5a5684e3787a6d6cd0d3e413
+SHA512:
+  metadata.gz: d22c4a7fdf3e7ba520ccd6bf22412e2b6ad4a7ff58ce524726257f7845e499c42ffa764e56db4a2f1384e2f830f90b26153c2f7fb4f45f453cb8673d2b19395d
+  data.tar.gz: 63c6c60a20397645e84f5048894fe52c640179ea5e388367ab9835430472e46e3bd068b6eecd188e4e68caf8d1cf883126a3049c8737bf9cb59ddc47eb30c486

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in appril.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/app/.gitignore

@@ -0,0 +1,6 @@
+.git
+node_modules
+var
+tmp
+Gemfile.lock
+__tmpbuildir__

data/app/.pryrc

@@ -0,0 +1 @@
+require File.expand_path('../core/load', __FILE__)

data/app/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+# keep this line
+eval File.read(File.expand_path('../core/Gemfile', __FILE__))
+
+# add your gems here

data/app/Rakefile

@@ -0,0 +1 @@
+require File.expand_path('../core/boot', __FILE__)

data/app/base/base_controller.rb

@@ -0,0 +1,3 @@
+class BaseController < Appril::BaseController
+  map Cfg.server_url
+end

data/app/base/boot.rb

@@ -0,0 +1,2 @@
+# first file to be loaded when app starts.
+# it is loaded on bare metal, e.g. before any gems, configs, helpers.

data/app/base/core.coffee

@@ -0,0 +1,91 @@
+_ =
+  merge: require('lodash/merge')
+#end
+
+CONSIDER_IDLE_AFTER = 5 * 60
+
+Core = require('appril')
+Page = require('appril/page')
+Load = require('appril/load')
+Render = require('appril/render')
+ActivityObserver = require('appril/activity_observer')
+
+# require 'appril/polyfills'
+
+window.App = {}
+
+for k, v of require('appril/util')
+  App[k] = v
+#end
+
+# for k, v of require('appril/util/datetime')
+#   App[k] = v
+# #end
+#
+# for k, v of require('appril/util/alert')
+#   App[k] = v
+# #end
+
+Render.default_el = '#content'
+Render.global_data = {App: App}
+Render.global_handlers = {}
+
+
+Core.on_initialize = (msg) ->
+
+  for k, v of msg.data
+    App[k] = v
+  #end
+
+  ActivityObserver CONSIDER_IDLE_AFTER, (status) ->
+    # close connection if user went away
+    Core.disconnect() if status == 'away'
+  #end
+
+#end
+
+
+Core.on_controllers_ready = (controllers) ->
+  for name, controller of controllers
+    App[name] = controller
+  #end
+#end
+
+
+deploy_api = (api) ->
+  try
+    App.layout?.teardown()
+  #end
+
+  env = _.merge({
+    render: Render,
+    render_component: Render.component,
+    render_string: Render.string
+  }, new Page)
+
+  App.layout = env.render
+    el: 'body'
+    template: "<div id='#{Render.default_el}'></div>"
+    oncomplete: ->
+      new api(env)
+    #end
+  #end
+#end
+
+
+Core.on_controller_matched = (controller, context) ->
+  controller.load (api) ->
+    context.save()
+    deploy_api(api)
+#end
+
+# Core.on_socket_open = (socket) ->
+
+# Core.on_socket_close = ->
+
+document.addEventListener 'DOMContentLoaded', ->
+  # make sure this matches the RTCPController URL.
+  # if URL differs on various environments determine effective environment and use appropriate URL.
+  # a good approach to determine effective environment is to look into window.location.hostname
+  Core.connect('__rtcp__')
+#end

data/app/base/helpers/application_helpers.rb

@@ -0,0 +1 @@
+# this file will be loaded before other files found in helpers/ folder

data/app/base/load_controllers.rb

@@ -0,0 +1,2 @@
+# All "official" controllers are loaded by core/load_controllers.rb
+# This file is intended to load any "custom" controllers, ones that are not seen by default loader.

data/app/base/rtcp_controller.rb

@@ -0,0 +1,22 @@
+class RTCPController < Appril::RTCPController
+  map File.join(Cfg.server_url, '__rtcp__')
+
+  private
+  # called after socket connection established
+  def connected
+  end
+
+  # data sent to client after connection established
+  def initialization_data
+    {}
+  end
+
+  # merged into original env when calling a controller
+  def rtcp_env
+    {}
+  end
+
+  # called when socket connection closed
+  def disconnected
+  end
+end

data/app/config/config.rb

@@ -0,0 +1,9 @@
+
+# loading .yml configs from current directory. config.yml will be loaded first.
+Cfg = Appril.load_config(File.expand_path('..', __FILE__))
+
+# it is highly recommended to freeze configs so they stay unaltered on runtime.
+Cfg.freeze
+
+# loading any .rb files in current dir. this one will be skipped automatically.
+Dir[File.expand_path('../**/*.rb', __FILE__)].each {|f| require(f)}

data/app/config/config.yml

@@ -0,0 +1,18 @@
+
+# configs here will be the same on all environments.
+# if some configs differs on some environment,
+# put them into appropriate env/[ENVIRONMENT].yml file
+
+# multiple .yml files allowed in config folder.
+# for example config/db.yml file will be loaded into Cfg.db in server app.
+# arbitrary .yml files can have environment related configs.
+
+
+# base URL for server app
+server_url: /
+
+# base URL for compiled client app
+client_url: /app
+
+# where webpack should install compiled app. relative to webpack.config.js
+client_path: ./public

data/app/config.ru

@@ -0,0 +1,3 @@
+require File.expand_path('../core/load', __FILE__)
+
+run RocketIO::Application.new

data/app/core/Gemfile

@@ -0,0 +1,4 @@
+# do NOT edit this file, edit ../Gemfile instead
+gem 'appril'
+gem 'rocketio'
+gem 'tubesock'

data/app/core/boot.rb

@@ -0,0 +1,16 @@
+# do NOT edit this file, edit base/boot.rb instead
+
+require 'yaml'
+
+Dir.chdir File.expand_path('../..', __FILE__) do
+  require './base/boot'
+
+  require 'bundler/setup'
+  Bundler.require(:default)
+  Bundler.require(RocketIO.environment)
+
+  require './config/config'
+
+  require './base/helpers/application_helpers'
+  Dir['./base/helpers/**/*.rb'].each {|f| require(f)}
+end

data/app/core/generate_configs.rb

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# do NOT edit this file
+
+require File.expand_path('../load', __FILE__)
+
+Appril.generate_configs(File.expand_path('../..', __FILE__))

data/app/core/load.rb

@@ -0,0 +1,7 @@
+# do NOT edit this file, edit base/load.rb instead
+
+%w[
+  boot
+  ../base/load
+  load_controllers
+].each {|f| require File.expand_path("../#{f}", __FILE__)}

data/app/core/load_controllers.rb

@@ -0,0 +1,15 @@
+# do NOT edit this file, edit base/load_controllers.rb instead
+
+Dir.chdir File.expand_path('../..', __FILE__) do
+
+  require './base/base_controller'
+  require './base/rtcp_controller'
+
+  %w[
+    **/server.rb
+  ].each_with_object([]) {|f,o| o.concat(Dir["./base/api/#{f}"])}.sort {|a,b|
+    a.split(/\/+/).size <=> b.split(/\/+/).size
+  }.each {|f| require(f)}
+
+  require './base/load_controllers'
+end

data/app/package.json

@@ -0,0 +1,5 @@
+{
+  "dependencies": {
+    "appril": "*"
+  }
+}

data/app/webpack.config.js

@@ -0,0 +1,48 @@
+var webpack = require('webpack'),
+    fs = require('fs'),
+    child_process = require('child_process')
+;
+
+if (process.env.APP_ENV == 'development') {
+  console.log('Generating configs...');
+  child_process.execSync('./core/generate_configs.rb');
+}
+
+var setup = JSON.parse(fs.readFileSync('./config.json')).webpack;
+console.log(JSON.stringify(setup, null, 2))
+
+module.exports = {
+  entry: setup.entries,
+  output: {
+    path: [setup.path, setup.url].join('/'),
+    filename: '[name].js',
+    publicPath: setup.url + '/',  // trailing slash required
+    libraryTarget: 'commonjs2'
+  },
+  module: {
+    loaders: [
+      // { test: /\.coffee$/, loader: 'coffee-loader' },
+      // { test: /\.css$/, loader: 'style-loader!css-loader' },
+      // { test: /\.json$/, loader: 'json-loader' },
+      // { test: /\.otf($|\?)/, loader: require.resolve('file-loader') },
+      // { test: /\.ttf($|\?)/, loader: require.resolve('file-loader') },
+      // { test: /\.eot($|\?)/, loader: require.resolve('file-loader') },
+      // { test: /\.svg($|\?)/, loader: require.resolve('file-loader') },
+      // { test: /\.png($|\?)/, loader: require.resolve('url-loader') + '?limit=10000&mimetype=image/png' },
+      // { test: /\.jpg($|\?)/, loader: require.resolve('file-loader') },
+      // { test: /\.gif($|\?)/, loader: require.resolve('file-loader') },
+      // { test: /\.woff[2]?($|\?)/, loader: require.resolve('url-loader') + '?limit=10000&mimetype=application/font-woff' },
+    ]
+  },
+  resolve: {
+    extensions: ['', '.js', '.css', '.json', '.coffee', '.html'],
+    alias: {
+      app: __dirname,
+      base: 'app/base',
+      api: 'base/api',
+    }
+  },
+  plugins: [
+    new webpack.optimize.CommonsChunkPlugin('core', 'core.js'),
+  ]
+}

data/appril.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+require File.expand_path('../lib/appril/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name = 'appril'
+  spec.version = Appril::VERSION
+  spec.authors     = ['Slee Woo']
+  spec.email       = ['mail@sleewoo.com']
+  spec.summary     = [spec.name, spec.version]*'-',
+  spec.description = 'Opinionated framework for building opinionated web applications'
+  spec.homepage    = 'https://github.com/sleewoo/' + spec.name
+  spec.license     = 'MIT'
+
+  spec.files = Dir['**/{*,.[a-z]*}'].reject {|e| e =~ /(gem|lock)\z/}
+  spec.require_paths = ['lib']
+  spec.executables = Dir['bin/*'].map {|f| File.basename(f)}
+
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_runtime_dependency 'rocketio', '~> 0'
+  spec.add_runtime_dependency 'tubesock', '~> 0'
+end

data/bin/appril

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.unshift(File.expand_path('../../lib', __FILE__))
+require 'appril'
+require 'appril/cli'
+Appril::CLI.new($*)

data/docker/Dockerfile

@@ -0,0 +1,5 @@
+FROM  appril/base
+COPY  start /
+COPY  build /build
+RUN   sh /build/build && sh /build/cleanup && mkdir /app
+CMD   sh /start

data/docker/run

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+
+run() {
+  echo -e "\n$ $@"
+  "$@"
+}
+
+container_is_built() {
+  [[ -n $(docker ps -a | grep -E "\s$CONTAINER_NAME\s") ]]
+}
+
+container_is_running() {
+  [[ -n $(docker ps | grep -E "\s$CONTAINER_NAME\s") ]]
+}
+
+stop_container() {
+  run docker stop $CONTAINER_NAME
+}
+
+remove_container() {
+  run docker rm $CONTAINER_NAME
+}
+
+env_prompt() {
+  read APP_ENV
+  [ "$(echo " {environments} " | grep -E "\s$APP_ENV\s")" = "" ] && env_prompt
+}
+
+if [ "$APP_ENV" = "" ]; then
+  echo "APP_ENV not set, please use one of"
+  echo "{environments}"
+  echo -n "> "
+  env_prompt
+fi
+
+set -e
+
+{container_definitions}
+
+if [ "$CONTAINER_NAME" = "" ]; then
+  echo -e "\n\t::: $APP_ENV environment not supported. Use one of: {environments} :::\n"
+  exit 1
+fi
+
+APP_UID="$(id -u)"
+APP_GID="$(id -g)"
+APP_DIR="$(cd "$(dirname ${BASH_SOURCE[0]})/{script_path_traversal}"; pwd)"
+
+if [ "$APP_UID" = "0" ]; then
+  echo -e "\n\t::: No superpowers accepted here! Run this as a regular user :::\n"
+  exit 1
+fi
+
+run docker pull {image}
+container_is_running && stop_container
+container_is_built   && remove_container
+
+run docker run \
+  --name "$CONTAINER_NAME" \
+  -e APP_ENV="$APP_ENV" \
+  -e APP_UID="$APP_UID"  \
+  -e APP_GID="$APP_GID"  \
+  -e LANG="en_US.UTF-8"  \
+  -e LC_ALL="en_US.UTF-8"  \
+  -e LC_TYPE="en_US.UTF-8" \
+  -v "$APP_DIR":/app  \
+  {run_opts} {image}
+echo

data/docker/skel/build.sh

@@ -0,0 +1 @@
+# running inside container.

data/docker/skel/cleanup.sh

@@ -0,0 +1,7 @@
+set -e
+
+apk del build-base libxml2-dev libxslt-dev \
+  ruby-dev postgresql-dev imagemagick-dev \
+  nodejs-dev python git
+
+rm -rf /var/cache/apk/*

data/docker/skel/config.yml

@@ -0,0 +1,24 @@
+# a image with this name will be built (see prepare_build.sh and build.sh)
+IMAGE_NAME:
+
+# the name of container to be run on your server(s).
+# name depends on APP_ENV variable.
+# you can add/remove environments but at least one is required.
+CONTAINER_NAME:
+  development:
+  test:
+  stage:
+  production:
+
+# path to app.
+# should be absolute or relative to this file.
+APP_DIR:
+
+# a file with this name will be generated and installed inside APP_DIR.
+RUN_SCRIPT: docker/run
+
+# options passed to `docker build`
+BUILD_OPTS: --force-rm --no-cache
+
+# options passed to `docker run`
+RUN_OPTS: -d --restart always

data/docker/skel/prepare_build.sh

@@ -0,0 +1,5 @@
+# running before image building started.
+# will run inside building dir so copy into ./ any files you need for building.
+# APP_DIR variable points to your app directory
+# so use it to copy any files from your app into building dir.
+# running outside container, e.g. on your dev machine.

data/docker/skel/start.sh

@@ -0,0 +1 @@
+# start your app

data/docker/start

@@ -0,0 +1,7 @@
+set -e
+
+[ "$(getent group $APP_GID)" = "" ] && addgroup -g $APP_GID app
+
+[ "$(getent passwd $APP_UID)" = "" ] && adduser -D -u $APP_UID -G app app
+
+{start}

data/lib/appril/base_controller.rb

@@ -0,0 +1,5 @@
+module Appril
+  class BaseController < RocketIO::Controller
+
+  end
+end

data/lib/appril/cli/app/install.rb

@@ -0,0 +1,42 @@
+module Appril
+  class CLI
+    class App
+      class Install
+        include Helpers
+
+        def initialize dir, namespace: nil, working_dir_opted: false
+          install(dir, working_dir_opted)
+          make_executable(dir / 'core/generate_configs.rb')
+          add_namespace(dir, namespace) if namespace
+          puts "Done. All files installed into #{dir}"
+        end
+
+        def install dir, working_dir_opted
+          src = working_dir_opted ? BASE_DIR.to_path + '/.' : BASE_DIR
+          FileUtils.cp_r(src, dir)
+          cleanup(dir)
+        end
+
+        def add_namespace dir, namespace
+          %w[
+            base/base_controller.rb
+            base/rtcp_controller.rb
+            config/config.rb
+          ].each do |file|
+            code = File.read(dir / file)
+            File.open dir / file, 'w' do |f|
+              f.puts "module #{namespace}"
+              code.split("\n").each {|l| f.puts "  #{l}"}
+              f.puts "end"
+            end
+          end
+        end
+
+        def cleanup dir
+          Dir[dir / "**/.ignore"].each {|f| FileUtils.rm_f(f)}
+        end
+
+      end
+    end
+  end
+end

data/lib/appril/cli/app/update.rb

@@ -0,0 +1,26 @@
+module Appril
+  class CLI
+    class App
+      class Update
+        include Helpers
+
+        def initialize dir
+          FileUtils.rm_rf(dir / 'core')
+          Dir.chdir BASE_DIR do
+
+            Dir['**/*'].select {|e| File.file?(e)}.each do |file|
+              next if File.file?(dir / file)
+              create_dirname_for(dir / file)
+              puts "Installing #{File.basename(dir)}/#{file}"
+              FileUtils.cp(file, dir / file)
+            end
+
+          end
+          make_executable(dir / 'core/generate_configs.rb')
+          puts "Done"
+        end
+
+      end
+    end
+  end
+end

data/lib/appril/cli/app.rb

@@ -0,0 +1,10 @@
+module Appril
+  class CLI
+    class App
+      BASE_DIR = (Appril::BASE_DIR / 'app').freeze
+    end
+  end
+end
+
+require 'appril/cli/app/install'
+require 'appril/cli/app/update'

data/lib/appril/cli/assertions.rb

@@ -0,0 +1,60 @@
+module Appril
+  class CLI
+    module Assertions
+
+      def assert_directory_provided dir
+        return if dir
+        fatal_error! "Please provide a directory"
+      end
+
+      def assert_installable_dir dir, working_dir_opted
+        if working_dir_opted
+          assert_empty_directory(dir)
+        else
+          assert_directory_does_not_exists(dir)
+        end
+      end
+
+      def assert_is_docker_dir dir
+        return if File.exists?(dir / Docker::CONFIG_FILE)
+        fatal_error! "#{dir} does not look like a Appril docker dir"
+      end
+
+      def assert_is_app_dir dir
+        return if %w[
+          core
+          base/api
+          config
+        ].all? {|e| File.exists?(dir / e)}
+        fatal_error! "#{dir} does not look like a Appril app dir"
+      end
+
+      def assert_empty_directory dir
+        return if Dir[dir / '*'].empty?
+        fatal_error! "#{dir} should be empty"
+      end
+
+      def assert_directory_exists dir
+        return if File.directory?(dir)
+        fatal_error! "#{dir} should be a directory"
+      end
+
+      def assert_directory_does_not_exists dir
+        return unless File.exists?(dir)
+        fatal_error! "#{dir} already exists"
+      end
+
+      def assert_config_file_exists dir
+        return if File.file?(dir / Docker::CONFIG_FILE)
+        fatal_error! "#{dir / Docker::CONFIG_FILE} file is missing"
+      end
+
+      def assert_valid_api_name_given api_name
+        api_name || fatal_error!('Please provide api name')
+        api_name =~ /\W/ && fatal_error!('Api name should contain only alphanumerics')
+        api_name =~ /\A[a-z]/i || fatal_error!('Api name should start with a letter')
+      end
+
+    end
+  end
+end