appril 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24e685cd503a9c6bfec968166f714202f28f361f
-  data.tar.gz: bdd9a95c3d72a26b5a5684e3787a6d6cd0d3e413
+  metadata.gz: 7125903a6b44eb9b35374a65019e001a434f0da7
+  data.tar.gz: 85ca91bed437b1672b372c4bd38f666b3a50ecfa
 SHA512:
-  metadata.gz: d22c4a7fdf3e7ba520ccd6bf22412e2b6ad4a7ff58ce524726257f7845e499c42ffa764e56db4a2f1384e2f830f90b26153c2f7fb4f45f453cb8673d2b19395d
-  data.tar.gz: 63c6c60a20397645e84f5048894fe52c640179ea5e388367ab9835430472e46e3bd068b6eecd188e4e68caf8d1cf883126a3049c8737bf9cb59ddc47eb30c486
+  metadata.gz: b0cf0b7bdf78b228535aee9f43745dbcdfc638b91fc1ed4e5ba7b8153099ecf888c37e2a719e61429d234795580f6d3ec929957aadc9eee5d64b1fc202a39f8b
+  data.tar.gz: 6c0b9f9b486a46e81aee2ef514d0226053f716a546cc60c49487d94205231ef7b5441aa50b112019df14eba2bfcb0ed29d84b705d0e4be223914af208a92481a

data/appril.gemspec

@@ -2,13 +2,13 @@
 require File.expand_path('../lib/appril/version', __FILE__)
 
 Gem::Specification.new do |spec|
-  spec.name = 'appril'
-  spec.version = Appril::VERSION
+  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.homepage    = 'https://github.com/appril/' + spec.name
   spec.license     = 'MIT'
 
   spec.files = Dir['**/{*,.[a-z]*}'].reject {|e| e =~ /(gem|lock)\z/}

data/boilerplate/app/Rakefile

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

data/boilerplate/app/base/core.coffee

@@ -0,0 +1,143 @@
+_ =
+  merge: require('lodash/merge')
+  has: require('lodash/has')
+  isFunction: require('lodash/isFunction')
+#end
+
+Core = require('appril')
+Page = require('appril-page')
+Render = require('appril-ractive')
+Reporter = require('appril-reporter')
+
+require 'appril-polyfills'
+
+CONSIDER_IDLE_AFTER = 5 * 60
+
+window.Cfg = {}
+window.Util = {}
+window.App = {}
+# window.Alert = require('appril-alert')
+
+for k, v of require('appril-util')
+  Util[k] = v
+#end
+
+# for k, v of require('appril-datetime')
+#   Util[k] = v
+# #end
+
+for k, v of require('helpers/application_helpers.coffee')
+  Util[k] = v
+#end
+
+Object.freeze(Util)
+
+Render.default_el = -> '#content'
+Render.global_data = -> {App: App, Cfg: Cfg, Util: Util}
+Render.global_handlers = -> {}
+
+for name, controller of Core.controllers
+  App[name] = controller
+#end
+
+Core.on_initialize = (msg) ->
+  if window.Cfg = msg.data.cfg
+    delete msg.data.cfg
+    Object.freeze(Cfg)
+  #end
+
+  for k, v of msg.data
+    App[k] = v
+  #end
+
+  Reporter CONSIDER_IDLE_AFTER, (status) ->
+    # close connection if user went away
+    Core.disconnect() if status == 'away'
+  #end
+#end
+
+templates =
+  none: require('templates/layouts/none')
+  main: require('templates/layouts/main')
+  access_denied: require('templates/access_denied')
+#end
+
+partials = {}
+
+deploy_api = (api) ->
+
+  env = _.merge({
+    render: Render,
+    render_component: Render.component,
+    render_string: Render.string
+  }, new Page)
+
+  layout = if _.has(api, 'layout')
+    if api.layout == false
+      'none'
+    else
+      api.layout
+  else
+    'main'
+  #end
+
+  if App.body
+    # do not re-render body if current api uses same layout as previous one
+    return new api(env) if App.body.layout == layout
+  #end
+
+  components = {}
+
+  App.body = env.render
+    el: 'body'
+    template: templates[layout] || templates.none
+    partials: partials
+    components: components
+    data: {}
+
+    oncomplete: ->
+      this.layout = layout
+      new api(env)
+    #end
+  #end
+#end
+
+previous_api = null
+Core.on_controller_matched = (controller, context) ->
+
+  controller.load (api) ->
+    context.save()
+
+    api.controller = controller
+
+    if previous_api?.teardown
+      previous_api.teardown()
+    #end
+    previous_api = api
+
+    if _.has(api, 'acl')
+      unless _.isFunction(api.acl)
+        throw new Error("#{controller.name}.acl should be a function")
+
+      if api.acl()
+        deploy_api(api)
+      else
+        Render
+          el: 'body'
+          template: templates.main
+          partials: partials
+          oncomplete: ->
+            Render(template: templates.access_denied)
+      #end
+
+    else
+      deploy_api(api)
+    #end
+
+  #end
+#end
+
+document.addEventListener 'DOMContentLoaded', ->
+  # make sure this matches the RTCPController URL
+  Core.connect('__rtcp__')
+#end

data/boilerplate/app/base/helpers/application_helpers.rb

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

data/boilerplate/app/base/templates/access_denied.html

@@ -0,0 +1,3 @@
+<h4>
+  Please authorize to view this page
+</h4>

data/boilerplate/app/base/templates/layout.html

@@ -0,0 +1,11 @@
+<!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>
+  <script src="/app/core.js"></script>
+  <link rel="stylesheet" href="/app/core.css">
+</head>
+  <body></body>
+</html>

data/boilerplate/app/base/templates/layouts/main.html

@@ -0,0 +1 @@
+<div id="content"></div>

data/boilerplate/app/base/templates/layouts/none.html

@@ -0,0 +1 @@
+<div id="content"></div>

data/boilerplate/app/package.json

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

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

@@ -40,6 +40,8 @@ module.exports = {
       app: __dirname,
       base: 'app/base',
       api: 'base/api',
+      helpers: 'base/helpers',
+      templates: 'base/templates'
     }
   },
   plugins: [

data/boilerplate/crudle/Gemfile

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

data/boilerplate/crudle/base/core.coffee

@@ -0,0 +1,128 @@
+_ =
+  merge: require('lodash/merge')
+  has: require('lodash/has')
+  isFunction: require('lodash/isFunction')
+#end
+
+Core = require('appril')
+Page = require('appril-page')
+Render = require('appril-ractive')
+Reporter = require('appril-reporter')
+
+require 'appril-polyfills'
+
+CONSIDER_IDLE_AFTER = 5 * 60
+
+window.Cfg = {}
+window.Util = {}
+window.App = {}
+# window.Alert = require('appril-alert')
+
+for k, v of require('appril-util')
+  Util[k] = v
+#end
+
+# for k, v of require('appril-datetime')
+#   Util[k] = v
+# #end
+
+for k, v of require('helpers/application_helpers.coffee')
+  Util[k] = v
+#end
+
+Object.freeze(Util)
+
+Render.default_el = -> '#content'
+Render.global_data = -> {App: App, Cfg: Cfg, Util: Util}
+Render.global_handlers = -> {}
+
+for name, controller of Core.controllers
+  App[name] = controller
+#end
+
+Core.on_initialize = (msg) ->
+  if window.Cfg = msg.data.cfg
+    delete msg.data.cfg
+    Object.freeze(Cfg)
+
+  for k, v of msg.data
+    App[k] = v
+  #end
+
+  Reporter CONSIDER_IDLE_AFTER, (status) ->
+    # close connection if user went away
+    Core.disconnect() if status == 'away'
+  #end
+#end
+
+templates =
+  none: require('templates/layouts/none')
+  main: require('templates/layouts/main')
+  access_denied: require('templates/access_denied')
+#end
+
+partials = {}
+
+CrudleLayout = require('crudle/layout')
+CrudleList = require('crudle/list/component')
+CrudleEditor = require('crudle/editor/component')
+
+deploy_api = (api) ->
+
+  page = new Page
+  env = _.merge({
+    render: Render
+    render_component: Render.component
+    render_string: Render.string
+  }, page)
+
+  crudle_layout = CrudleLayout(api.controller.ws, page)
+  crudle_layout.partials.menu = require('templates/menu')
+  crudle_layout.data.url = api.controller.url
+
+  api(
+    env,
+    crudle_layout,
+    CrudleList(api.controller.ws, page),
+    CrudleEditor(api.controller.ws, page)
+  )
+#end
+
+previous_api = null
+Core.on_controller_matched = (controller, context) ->
+
+  controller.load (api) ->
+    context.save()
+
+    api.controller = controller
+
+    if previous_api?.teardown
+      previous_api.teardown()
+    #end
+    previous_api = api
+
+    if _.has(api, 'acl')
+      unless _.isFunction(api.acl)
+        throw new Error("#{controller.name}.acl should be a function")
+
+      if api.acl()
+        deploy_api(api)
+      else
+        Render
+          el: 'body'
+          template: templates.main
+          partials: partials
+          oncomplete: ->
+            Render(template: templates.access_denied)
+      #end
+
+    else
+      deploy_api(api)
+    #end
+  #end
+#end
+
+document.addEventListener 'DOMContentLoaded', ->
+  # make sure this matches the RTCPController URL.
+  Core.connect('__rtcp__')
+#end

data/boilerplate/crudle/generators/api/client.coffee

@@ -0,0 +1,11 @@
+# refer to underlying controller as self.controller
+
+self = (env, layout, list, editor) ->
+  editor.partials.editor = require('./editor')
+  layout.components =
+    list: env.render_component(list)
+    editor: env.render_component(editor)
+  env.render(layout)
+#end
+
+module.exports = self

data/boilerplate/crudle/generators/api/server.rb

@@ -0,0 +1,26 @@
+class CONTROLLER_NAME < BaseController
+  include Crudle::Controller
+
+  private
+  def model; DO_NOT_FORGET_TO_ADD_MODEL end
+
+  # def order; end
+
+  # def filter_by_name params, dataset
+  #   return if params[:name].nil? || params[:name].empty?
+  #   dataset.where('name LIKE ?', params[:name] + '%')
+  # end
+
+  # def list_serializer item
+  #   serializer(item)
+  # end
+
+  # def editor_serializer item
+  #   serializer(item)
+  # end
+
+  # def serializer item
+  #   item
+  # end
+
+end

data/boilerplate/crudle/package.json

@@ -0,0 +1,7 @@
+{
+  "dependencies": {
+    "appril": "*",
+    "appril-ractive": "*",
+    "crudle": "*"
+  }
+}

data/docker/run

@@ -26,12 +26,10 @@ env_prompt() {
   [ "$(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
+echo "Let's set APP_ENV"
+echo "{environments}"
+echo -n "> "
+env_prompt
 
 set -e
 

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

@@ -4,16 +4,19 @@ module Appril
       class Install
         include Helpers
 
-        def initialize dir, namespace: nil, working_dir_opted: false
-          install(dir, working_dir_opted)
+        def initialize dir, namespace: nil, working_dir_opted: false, crudle_app: false
+          install(dir, working_dir_opted, crudle_app)
           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
+        def install dir, working_dir_opted, crudle_app
+          src = working_dir_opted ? APP_DIR.to_path + '/.' : APP_DIR
           FileUtils.cp_r(src, dir)
+          if crudle_app
+            FileUtils.cp_r(CRUDLE_DIR.to_path + '/.', dir)
+          end
           cleanup(dir)
         end
 

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

@@ -6,7 +6,7 @@ module Appril
 
         def initialize dir
           FileUtils.rm_rf(dir / 'core')
-          Dir.chdir BASE_DIR do
+          Dir.chdir APP_DIR do
 
             Dir['**/*'].select {|e| File.file?(e)}.each do |file|
               next if File.file?(dir / file)

data/lib/appril/cli/app.rb

@@ -1,7 +1,8 @@
 module Appril
   class CLI
     class App
-      BASE_DIR = (Appril::BASE_DIR / 'app').freeze
+      APP_DIR = Appril::BOILERPLATE_DIR / 'app'
+      CRUDLE_DIR = Appril::BOILERPLATE_DIR / 'crudle'
     end
   end
 end

data/lib/appril/cli.rb

@@ -7,7 +7,8 @@ require 'appril/cli/helpers'
 require 'appril/cli/assertions'
 
 module Appril
-  BASE_DIR = Pathname.new(File.expand_path('../../..', __FILE__)).freeze
+  BASE_DIR = Pathname.new(File.expand_path('../../..', __FILE__))
+  BOILERPLATE_DIR = BASE_DIR / 'boilerplate'
 
   class CLI
     include Helpers
@@ -34,25 +35,30 @@ module Appril
 
     def usage
       puts "
+      Arguments in round brackets are required.
+      Arguments in square brackets are optional.
+
+
       === Install a new app ===
-      $ appril [app || a] [install || i] [dir || .]
+      $ appril (app || a) (install || i) (dir || .) [-crudle]
+      * If -crudle option provided it will install a Crudle app
 
       === Update existing app ===
-      $ appril [app || a] [update || u] [dir || .]
+      $ appril (app || a) (update || u) (dir || .)
 
       === Generate a new API ===
-      $ appril [generate || g] [api || a] [api name] [dir || .]
+      $ appril (generate || g) (api) (api name) (dir || .)
 
-      === Install Docker recipes ===
-      $ appril [docker || d] [install || i] [dir || .]
+      === Install Docker builder ===
+      $ appril (docker || d) (install || i) (dir || .)
 
-      === Update Docker recipes ===
-      $ appril [docker || d] [update || u] [dir || .]
+      === Update Docker builder ===
+      $ appril (docker || d) (update || u) (dir || .)
 
       === Build Docker image and install run script ===
-      $ appril [docker || d] [build || b] [dir || .] [-u] [-p]
-      If -u option provided it will only update the run script without building the image.
-      If -p option provided it will try to push the image to Docker registry after successful build.
+      $ appril (docker || d) (build || b) (dir || .) [-u] [-p]
+      * If -u option provided it will only update the run script without building the image.
+      * If -p option provided it will try to push the image to Docker registry after successful build.
 
       === Usage ===
       $ appril [-h || --help]
@@ -71,7 +77,8 @@ module Appril
 
           app_install(dir, {
             working_dir_opted: working_dir_opted?(opted_dir),
-            namespace: extract_namespace(args)
+            namespace: extract_namespace(args),
+            crudle_app: args.find {|a| a == '-crudle'}
           })
 
         when 'u', 'update'

data/lib/appril/version.rb

@@ -1,3 +1,3 @@
 module Appril
-  VERSION = '0.0.0'.freeze
+  VERSION = '0.0.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appril
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Slee Woo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rocketio
@@ -48,36 +48,49 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - Rakefile
-- app/.gitignore
-- app/.pryrc
-- app/Gemfile
-- app/Rakefile
-- app/base/api/.ignore
-- app/base/base_controller.rb
-- app/base/boot.rb
-- app/base/core.coffee
-- app/base/helpers/application_helpers.rb
-- app/base/load.rb
-- app/base/load_controllers.rb
-- app/base/rtcp_controller.rb
-- app/config.ru
-- app/config/config.rb
-- app/config/config.yml
-- app/config/env/development.yml
-- app/config/env/production.yml
-- app/config/env/stage.yml
-- app/config/env/test.yml
-- app/core/Gemfile
-- app/core/boot.rb
-- app/core/generate_configs.rb
-- app/core/load.rb
-- app/core/load_controllers.rb
-- app/generators/api/.ignore
-- app/package.json
-- app/public/.ignore
-- app/webpack.config.js
 - appril.gemspec
 - bin/appril
+- boilerplate/app/.gitignore
+- boilerplate/app/.pryrc
+- boilerplate/app/Gemfile
+- boilerplate/app/Rakefile
+- boilerplate/app/base/api/.ignore
+- boilerplate/app/base/base_controller.rb
+- boilerplate/app/base/boot.rb
+- boilerplate/app/base/core.coffee
+- boilerplate/app/base/helpers/application_helpers.coffee
+- boilerplate/app/base/helpers/application_helpers.rb
+- boilerplate/app/base/load.rb
+- boilerplate/app/base/load_controllers.rb
+- boilerplate/app/base/rtcp_controller.rb
+- boilerplate/app/base/templates/access_denied.html
+- boilerplate/app/base/templates/layout.html
+- boilerplate/app/base/templates/layouts/main.html
+- boilerplate/app/base/templates/layouts/none.html
+- boilerplate/app/config.ru
+- boilerplate/app/config/config.rb
+- boilerplate/app/config/config.yml
+- boilerplate/app/config/env/development.yml
+- boilerplate/app/config/env/production.yml
+- boilerplate/app/config/env/stage.yml
+- boilerplate/app/config/env/test.yml
+- boilerplate/app/core/Gemfile
+- boilerplate/app/core/boot.rb
+- boilerplate/app/core/generate_configs.rb
+- boilerplate/app/core/load.rb
+- boilerplate/app/core/load_controllers.rb
+- boilerplate/app/generators/api/.ignore
+- boilerplate/app/package.json
+- boilerplate/app/public/.ignore
+- boilerplate/app/tmp/.ignore
+- boilerplate/app/var/.ignore
+- boilerplate/app/webpack.config.js
+- boilerplate/crudle/Gemfile
+- boilerplate/crudle/base/core.coffee
+- boilerplate/crudle/generators/api/client.coffee
+- boilerplate/crudle/generators/api/editor.html
+- boilerplate/crudle/generators/api/server.rb
+- boilerplate/crudle/package.json
 - docker/Dockerfile
 - docker/run
 - docker/skel/build.sh
@@ -101,7 +114,7 @@ files:
 - lib/appril/cli/helpers.rb
 - lib/appril/rtcp_controller.rb
 - lib/appril/version.rb
-homepage: https://github.com/sleewoo/appril
+homepage: https://github.com/appril/appril
 licenses:
 - MIT
 metadata: {}
@@ -124,5 +137,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: '["appril-0.0.0", "Opinionated framework for building opinionated web applications"]'
+summary: '["appril-0.0.1", "Opinionated framework for building opinionated web applications"]'
 test_files: []

data/app/Rakefile

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

data/app/base/core.coffee

@@ -1,91 +0,0 @@
-_ =
-  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/package.json

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