appril-cli 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c4ee73b112f5a00aab967429c4d6f5625f23764
-  data.tar.gz: 8290fa13dd21b4de97b87603bfc83d1dbcc9a640
+  metadata.gz: 8622cacea4e9095a3daeb67ca1bdba3d8605b7d3
+  data.tar.gz: 5faf96d70dae4558522bc115a79a92bbe9f4e0e7
 SHA512:
-  metadata.gz: 103fcc739853591314068ea3c2571542bd02449c97197968bb67d05b4f6284b93252ea8bb7786ea18323a522d4578e6c94591e78df74fac2301ba519f293a47d
-  data.tar.gz: 5ed2ec0f096f78bdbabff15bedb0ada7635b7cfb92bc2e568ce4754c2c7685cdbb4756fe4ba50813c25a58f6adf0b19ed05cec8821bc1151608a02ede9309f3e
+  metadata.gz: 6941fa537bc497e8bc123348a4f80d721872ad2c4c4ad4a51c515df5e375e5efd19508c5c6360ee627f83c342c32d15909c8df9bbfa972abdf341505187a6951
+  data.tar.gz: c96ab1b7493828767ed27771fa7717a8e59aeac5cbf80d719ec3826c60e90aa9ac5418dd25d3f843d3e70e78ea201ba1d6b880f4d0fca64ba0f014962f75b014

data/app/base/assets/styles.css

@@ -0,0 +1,2 @@
+/** delete this line to enable Crudle styles
+@import url(~crudle/styles.css); /* */

data/{boilerplate/app/base/api → app/base/components}/base_controller.rb

@@ -7,7 +7,9 @@ class BaseController < Appril::BaseController
   layout :layout
   engine :Liquid
   define_template(:index) {''}
-  define_template_var(:client_url, Cfg.client_url)
+
+  # highly important setup, do NOT remove
+  define_template_var(:client_url, File.join(Cfg.client_url, environment).freeze)
 
   def index
     render

data/app/base/components/deploy.js

@@ -0,0 +1,25 @@
+import {find} from 'lodash'
+import Vue from 'vue/dist/vue.js'
+
+import 'assets/styles'
+// import 'appril-polyfills'
+
+/** default deployer */
+export default function(components, component, constructor) {
+  return constructor
+} /* */
+
+/** Crudle deployer
+import Crudle from 'crudle'
+export default function(components, component, constructor) {
+  Crudle.Menu = {
+    template: require('templates/menu'),
+    data() {
+      return {
+        ...components,
+        is_active(...a) {return find(a, (c) => c.url == component.url) ? true : false}
+      }
+    }
+  }
+  return Crudle(constructor)
+} /* */

data/app/base/components/index/index.js

@@ -0,0 +1,3 @@
+export default {
+  template: require('./template')
+}

data/app/base/components/index/server.rb

@@ -0,0 +1,13 @@
+class Index < BaseController
+  map Cfg.server_url
+
+  # environmental data to be sent to client at App initialization
+  def _env
+    {}
+  end
+
+  # data to be sent to client at Component initialization
+  def _options
+    {}
+  end
+end

data/{boilerplate/app/base/api → app/base/components}/rtcp_controller.rb

@@ -7,15 +7,13 @@ class RTCPController < Appril::RTCPController
   def connected
   end
 
-  # data sent to client after connection established
-  def initialization_data
-    {
-      client_url: Cfg.client_url, # this is highly important setup, do NOT remove
-    }
+  # environmental data to be sent to client at App initialization
+  def _env
+    {}
   end
 
-  # merged into original env when calling a controller
-  def rtcp_env
+  # merged into original env when calling a controller method
+  def controller_env
     {}
   end
 

data/app/base/core.js

@@ -0,0 +1,77 @@
+import {merge, cloneDeep} from 'lodash'
+import deep_freeze from 'deep-freeze-strict'
+import Router from 'appril/router'
+import Vue from 'vue/dist/vue.js'
+import Vuex from 'vuex'
+import VuexLogger from 'vuex/logger'
+
+import {server_url, client_url, default_api} from 'app/config.js'
+
+import {state, mutations} from 'appril/store'
+import {vue_plugin, vuex_plugins} from 'appril/plugins'
+import components from 'appril/components'
+import async_components_loader from 'appril/components/async_loader'
+import ApiBuilder from 'appril/api'
+
+/** delete or comment this line if your components piped through Crudle
+import {state as crudle_state, mutations as crudle_mutations} from 'crudle/store'
+merge(state, crudle_state)
+merge(mutations, crudle_mutations) /* */
+
+const DEVELOPMENT = APP_ENV === 'development'
+
+Vue.use(Vuex)
+if (DEVELOPMENT) {
+  Vue.config.devtools = true
+  vuex_plugins.push(VuexLogger())
+}
+
+const api = ApiBuilder(default_api)
+
+const initialize = function(data) {
+  deep_freeze(data)
+
+  // /* uncomment this line to disable RealTime Communication Protocol
+  api.rtcp.connect({
+    // make sure this url to match RTCPController url
+    path: server_url + '__rtcp__',
+    // disconnect if user is idle for N seconds
+    disconnect_after: 60
+  }) /* */
+
+  Vue.use(vue_plugin({
+    ...data,
+    api,
+    components
+  }))
+
+  const router = new Router(components)
+
+  const store = new Vuex.Store({
+    state: cloneDeep(state),
+    mutations,
+    strict: DEVELOPMENT,
+    plugins: vuex_plugins
+  })
+
+  new Vue({
+    store,
+    el: '#app',
+    template: `<component :is="$store.state.__ROOT_COMPONENT__"></component>`,
+    components: async_components_loader(components, client_url + APP_ENV, api[default_api])
+  })
+
+  router.component_matched = function(component) {
+    if (store.state.__ROOT_COMPONENT__ === component.name)
+      return
+    store.replaceState(merge(cloneDeep(state), {__ROOT_COMPONENT__: component.name}))
+  }
+
+  router.start()
+}
+
+document.addEventListener('DOMContentLoaded', function() {
+  api.Index._env().get({
+    success: initialize
+  })
+})

data/app/base/templates/layout.liquid

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
+    <script type="text/javascript">window.module = {}</script>
+    <link rel="stylesheet" media="all" href="{{client_url}}/core.css">
+    <script src="{{client_url}}/core.js"></script>
+  </head>
+  <body>
+    <div id="app"></div>
+  </body>
+</html>

data/app/config/config.rb

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

data/{sandbox → app}/config/config.yml

@@ -9,10 +9,14 @@
 
 
 # base URL for server app
-server_url: /
+server_url: / # trailing slash required
 
 # base URL for compiled client app
-client_url: /app
+client_url: /compiled/ # trailing slash required
 
-# where webpack should install compiled app. relative to webpack.config.js
-client_path: ./public
+# where webpack should install compiled app (relative to webpack.config.js)
+# will append client_url so by default it will be installed in ./compiled/
+build_path: ./
+
+# either xhr or rtcp
+default_api: xhr

data/{boilerplate/app → app}/core/Gemfile

@@ -1,4 +1,4 @@
 # do NOT edit this file, edit ../Gemfile instead
-gem 'appril',   '>= 0.0.7'
-gem 'rocketio', '>= 0.2'
+gem 'appril',   '>= 0.2'
+gem 'rocketio', '>= 0.3'
 gem 'tubesock', '>= 0.2.7'

data/{sandbox → app}/core/boot.rb

@@ -1,6 +1,7 @@
 # do NOT edit this file, edit base/boot.rb instead
 
-require 'yaml'
+require 'appril'
+require 'appril/load_configs'
 
 Dir.chdir File.expand_path('../..', __FILE__) do
   require './base/boot'
@@ -10,7 +11,4 @@ Dir.chdir File.expand_path('../..', __FILE__) do
   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 'appril/generate_configs'
+require File.expand_path('../load', __FILE__)
+Appril.generate_configs(File.expand_path('../..', __FILE__))

data/{boilerplate/app → app}/core/load.rb

@@ -1,9 +1,9 @@
-# do NOT edit this file, edit ../base/load.rb instead
+# do NOT edit this file, edit base/load.rb instead
 
 Dir.chdir File.expand_path('../..', __FILE__) do
   require './core/boot'
   require './base/load'
   require './core/load_helpers'
   require './core/load_models'
-  require './core/load_api'
+  require './core/load_components'
 end

data/{boilerplate/app/core/load_api.rb → app/core/load_components.rb}

@@ -3,8 +3,9 @@
   base_controller.rb
   rtcp_controller.rb
   **/server.rb
+  **/*.rb
 ].each do |p|
-  Dir[File.expand_path("../../base/api/#{p}", __FILE__)].sort {|a,b|
+  Dir[File.expand_path("../../base/components/#{p}", __FILE__)].sort {|a,b|
     a.split(/\/+/).size <=> b.split(/\/+/).size
   }.each {|f| require(f)}
 end

data/app/generators/_component/index.js

@@ -0,0 +1,3 @@
+export default {
+  template: require('./template')
+}

data/app/generators/_component/template.html

@@ -0,0 +1,3 @@
+<div>
+  
+</div>

data/app/generators/component

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+require 'pathname'
+
+opts, args = $*.partition {|x| x =~ /\A\-/}
+args[0] || fail("\n\n\t\u2716 No destination path provided\n\n")
+
+dst = Pathname.new(args[0] =~ /\A\// ? args[0] : File.expand_path("../../base/components/#{args[0].sub(/\Abase\/+components/, '')}", __FILE__))
+File.exists?(dst) && fail("\n\n\t\u2716 #{dst.sub(/.*(base\/components\/.+)/, '\1')} already exists\n\n")
+
+FileUtils.mkdir_p(dst.dirname)
+FileUtils.cp_r(File.expand_path("../_component", __FILE__), dst)
+
+puts "\n\t\u2713 Installed #{dst.sub(/.*(base\/components\/.+)/, '\1')}"
+
+parent_component = dst.dirname / 'index.js'
+if File.file?(parent_component)
+  header = "import %s from './%s'\n" % [
+    dst.basename.to_path.split(/\W+/).map(&:capitalize).join,
+    dst.basename
+  ]
+  content = File.read(parent_component)
+  unless content =~ /#{header}/
+    content = header + content
+    File.open(parent_component, 'w') {|f| f << content}
+    puts "\t\u2713 Updated #{parent_component.sub(/.*(base\/components\/.+)/, '\1')}"
+  end
+end
+puts

data/app/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "MyApp",
+  "version": "0.0.0",
+  "description": "...",
+  "devDependencies": {
+    "appril": ">= 0.2.8",
+    "appril-polyfills": ">= 0.0.2",
+    "appril-url": ">= 0.0.5",
+    "appril-utils": ">= 0.1.5",
+    "babel-core": "6",
+    "babel-loader": "6",
+    "babel-plugin-transform-object-rest-spread": "6",
+    "babel-plugin-transform-runtime": "6",
+    "babel-preset-es2015": "6",
+    "babel-preset-stage-2": "6",
+    "babel-preset-stage-3": "6",
+    "css-loader": "*",
+    "deep-freeze-strict": "1",
+    "extract-text-webpack-plugin": "^2.0.0-beta.2",
+    "file-loader": "*",
+    "json-loader": "*",
+    "optimize-css-assets-webpack-plugin": "1",
+    "style-loader": "*",
+    "url-loader": "*",
+    "vue": "^2.0.0-beta.3",
+    "vue-html-loader": "1",
+    "vuex": "^2.0.0-rc.3",
+    "webpack": "^2.1.0-beta.18"
+  }
+}

data/{boilerplate/app → app}/webpack/alias.js

@@ -1,10 +1,10 @@
-var path = require('path')
+const path = require('path')
 
 module.exports = {
   app: path.resolve(__dirname, '..'),
   base: 'app/base',
-  api: 'base/api',
-  helpers: 'base/helpers',
   assets: 'base/assets',
+  components: 'base/components',
+  helpers: 'base/helpers',
   templates: 'base/templates'
 }

data/app/webpack/entry.js

@@ -0,0 +1,3 @@
+const config = require('../config.js')
+
+module.exports = config.webpack_entries

data/{boilerplate/app → app}/webpack/extensions.js

@@ -2,7 +2,6 @@ module.exports = [
   '',
   '.js',
   '.css',
+  '.html',
   '.json',
-  '.coffee',
-  '.html'
 ]

data/app/webpack/loaders.js

@@ -0,0 +1,47 @@
+const ExtractTextPlugin = require('extract-text-webpack-plugin')
+
+const babel_query = {
+  presets: ['es2015', 'stage-2'],
+  plugins: ['transform-runtime']
+}
+
+const assets_regex = /base\/+assets\/[^/]+\.css$/
+
+module.exports = [
+  {
+    test: /\.js$/,
+    exclude: /node_modules/,
+    loader: 'babel',
+    query: babel_query
+  },
+  { // libs published as ES6 modules
+    test: /node_modules\/+(appril|crudle).*\.js$/,
+    loader: 'babel',
+    query: babel_query
+  },
+  { // css files inside base/assets/
+    test: assets_regex,
+    loader:  ExtractTextPlugin.extract({
+      notExtractLoader: "style-loader",
+      loader: "css-loader"
+    })
+  },
+  { // css files outside base/assets/
+    test: function(path) {
+      if (!path.match(/\.css$/))
+        return false
+      return path.match(assets_regex) ? false : true
+    },
+    loader: 'style-loader!css-loader'
+  },
+  { test: /\.html$/,     loader: 'vue-html' },
+  { 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' },
+]

data/app/webpack/output.js

@@ -0,0 +1,9 @@
+const path = require('path')
+const config = require('../config.js')
+
+module.exports = {
+  path: path.join(config.build_path, config.client_url, APP_ENV),
+  filename: '[name].js',
+  publicPath: path.join(config.client_url, APP_ENV, '/'), // trailing slash required
+  libraryTarget: 'commonjs2'
+}

data/app/webpack/plugins.js

@@ -0,0 +1,38 @@
+const webpack = require('webpack')
+const ExtractTextPlugin = require('extract-text-webpack-plugin')
+const OptimizeCssAssetsPlugin = require('optimize-css-assets-webpack-plugin')
+
+const plugins = [
+  new webpack.optimize.CommonsChunkPlugin({names: ['core'], minChunks: 2}),
+
+  // new webpack.ProvidePlugin({
+  //   $: 'jquery',
+  //   jQuery: 'jquery'
+  // }),
+
+  new webpack.DefinePlugin({
+    APP_ENV: JSON.stringify(APP_ENV),
+    'process.env': {
+      NODE_ENV: JSON.stringify(APP_ENV)
+    }
+  }),
+
+  new ExtractTextPlugin('[name].css')
+]
+
+if (APP_ENV === 'production') {
+  plugins.push(
+    new webpack.optimize.UglifyJsPlugin({
+      compress: { warnings: false },
+      screwIE8: true,
+      sourceMap: false,
+      mangle: true
+    })
+  ),
+
+  plugins.push(
+    new OptimizeCssAssetsPlugin
+  )
+}
+
+module.exports = plugins

data/app/webpack.config.js

@@ -0,0 +1,29 @@
+const child_process = require('child_process')
+
+APP_ENV = process.env.APP_ENV || 'development'
+
+if (APP_ENV === 'development') {
+  process.stdout.write('Generating configs... ')
+  try {
+    child_process.execSync('./core/generate_configs.rb')
+    console.log('done')
+  } catch(e) {
+    console.log(e.stdout.toString() + e.stderr.toString())
+    process.exit(1)
+  }
+}
+
+process.stdout.write('Webpacking... ')
+
+module.exports = {
+  entry: require('./webpack/entry.js'),
+  output: require('./webpack/output.js'),
+  module: {
+    loaders: require('./webpack/loaders.js')
+  },
+  resolve: {
+    extensions: require('./webpack/extensions.js'),
+    alias: require('./webpack/alias.js')
+  },
+  plugins: require('./webpack/plugins.js')
+}

data/lib/appril-cli/assertions.rb

@@ -2,28 +2,18 @@ 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)
+      def assert_installable_path path
+        if path == WORKING_DIR
+          assert_empty_directory(path)
         else
-          assert_directory_does_not_exists(dir)
+          assert_directory_does_not_exists(path)
         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
+          base/components
           config
         ].all? {|e| File.exists?(dir / e)}
         fatal_error! "#{dir} does not look like a Appril app dir"
@@ -49,12 +39,6 @@ module Appril
         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