kea-rails 1.0.0

data/lib/generators/kea/install/install_generator.rb

@@ -0,0 +1,197 @@
+class Kea::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+  argument :namespace, type: :string, required: false, default: nil
+ 
+  def init_js
+    copy_file "init.js", namespaced_path("app/assets/javascripts/", "init.js")
+  end
+ 
+  def directories
+    empty_directory namespaced_path("app/assets/javascripts", "bindings")
+    create_file     namespaced_path("app/assets/javascripts", "bindings/.keep")
+    empty_directory namespaced_path("app/assets/javascripts", "extenders")
+    create_file     namespaced_path("app/assets/javascripts", "extenders/.keep")
+    empty_directory namespaced_path("app/assets/javascripts", "initializers")
+    empty_directory namespaced_path("app/assets/javascripts", "models")
+    create_file     namespaced_path("app/assets/javascripts", "models/.keep")
+    empty_directory namespaced_path("app/assets/javascripts", "services")
+    create_file     namespaced_path("app/assets/javascripts", "services/.keep")
+    empty_directory namespaced_path("app/assets/javascripts", "viewmodels")
+    empty_directory namespaced_path("app/assets/javascripts", "sherlock")
+    create_file     namespaced_path("app/assets/javascripts", "sherlock/.keep")
+  end
+ 
+  def global_initializer
+    copy_file "global.js", namespaced_path("app/assets/javascripts/", "initializers/global.js")
+  end
+  
+  def main_viewmodel
+    copy_file "main.js", namespaced_path("app/assets/javascripts/", "viewmodels/main.js")
+  end
+ 
+  def application_js
+    insert_into_file namespaced_path("app/assets/javascripts", "application.js"), :after => "jquery_ujs\n" do <<-'JS'
+//= require kea/kea_dependencies
+
+//= require ./init
+
+//= require kea/kea
+//= require_directory ./bindings
+//= require_directory ./extenders
+//= require_directory ./models
+//= require_directory ./services
+//= require ./viewmodels/main
+//= require_directory ./viewmodels
+
+//= require_directory ./sherlock
+
+//= require_directory ./initializers
+    JS
+    end
+    
+    append_to_file namespaced_path("app/assets/javascripts", "application.js") do <<-'JS'
+
+
+$(document).ready(function() {
+  "use strict";
+
+  $.ajaxSetup({
+    timeout: 30000
+  });
+
+  window.app.page.MainVm = new window.app.viewmodels.Main();
+  
+  var $body = $('body');
+    
+  app.initializers.forEach(function(initializer) {
+    
+    if (initializer.selectors.length === 0) {
+      initializer.callback();
+      return;
+    }
+    
+    initializer.selectors.forEach(function(selector) {
+      if (selector.charAt(0) === '#') {
+        if ($body.attr('id') === selector.slice(1, selector.length)) {
+          initializer.callback();
+        }
+        
+      } else if (selector.charAt(0) === '.') {
+        if ($body.hasClass(selector)) {
+          initializer.callback();
+        }
+      }
+    });
+    
+  });
+
+  ko.applyBindings(app.page.MainVm);
+  
+  app.page.MainVm.pageInitComplete(true);
+  
+  if (app.errors.length > 0) {
+    app.errors.forEach(function(error) {
+      kea.notify(error.message, error.level);
+    });
+  }
+  
+});
+    JS
+    end
+  end
+  
+  def application_css
+    copy_file "_komplete.sass", namespaced_path("app/assets/stylesheets", "_komplete.sass")
+    copy_file "_sherlock.sass", namespaced_path("app/assets/stylesheets", "_sherlock.sass")
+    
+    insert_into_file namespaced_path("app/assets/stylesheets", "application.css.sass"), "*= require kea/kea", :before => "*= require_self"
+    
+    append_to_file namespaced_path("app/assets/stylesheets", "application.css.sass") do <<-'CSS'
++keyframes(overlay)
+  0%
+    +transform(translateY(-100%) scale(0.8))
+    box-shadow: 0px 40px 20px 5px $grey-20
+  50%
+    +transform(translateY(0%) scale(0.8))
+    box-shadow: 0px 0px 20px 5px $grey-20
+  90%
+    +transform(translateY(0%) scale(0.8))
+    box-shadow: 0px 0px 20px 5px $grey-20
+  100%
+    +transform(translateY(0%) scale(1))
+    box-shadow: 0px 0px 0px 0px $grey-20
+
+// Imported elements
+
+@import sherlock
+@import komplete
+
+.attache-popover
+  display: none
+  position: absolute
+  z-index: 2
+  padding: 1em
+  opacity: 0
+  transition: opacity 0.3s ease
+  +triangles(grey)
+  &.inactive
+    display: none
+  &.activating, &.active
+    display: block
+  &.active
+    opacity: 1
+  &.formerror
+    z-index: 11
+    background: opacify(red, 0.3)
+    border-color: red
+    color: white
+    +triangles(opacify(red, 0.3))
+
+.veil-overlay
+  position: fixed
+  top: 0
+  left: 0
+  display: none
+  z-index: 10
+  // +transition(all 1s $cubic-transition)
+  // +transform(scale(0.5))
+  &.fullscreen
+    width: 100%
+    height: 100vh
+    padding: 2rem
+  &.activating, &.active, &.deactivating
+    display: block
+    visibility: visible
+  &.active
+    +animation(overlay 1s $cubic-transition 0s 1 normal forwards)
+  &.deactivating
+    +transform(scale(0))
+    // +animation(overlay 1s $cubic-transition 0s 1 reverse forwards)
+    CSS
+    end
+  end
+   
+  def layout_setup
+    copy_file "application.html.erb", "app/views/layouts/#{namespace ? namespace.underscore : "application"}.html.erb"
+  end
+  
+  def helpers
+    inject_into_class "app/controllers/application_controller.rb", ApplicationController do
+      "  helper Kea::ApplicationHelper\n"
+    end
+  end
+  
+    private
+    
+  def namespaced_path(path, suffix = nil)
+    app_namespace = case namespace
+    when 'none', nil
+      nil
+    else
+      namespace.underscore
+    end
+    
+    File.join [path, app_namespace, suffix].compact
+  end
+  
+end

data/lib/generators/kea/install/templates/_komplete.sass

@@ -0,0 +1,17 @@
+.komplete
+  position: relative
+  .komplete-dropdown
+    position: absolute
+    left: 0
+    z-index: 2
+    background-color: white
+    border: 1px solid black
+    ul
+      margin: 0
+      padding: 0
+      list-style-type: none
+      li
+        padding: 0.5rem
+        border-bottom: 1px solid grey
+        &.has-focus, &:hover
+          background-color: lightgrey

data/lib/generators/kea/install/templates/_sherlock.sass

@@ -0,0 +1,105 @@
+$primary-highlight-color: #932F6D !default
+$primary-highlight-hover-color: #420039 !default
+$grey-10: #e0e0e0 !default
+$grey-20: #c2c2c2 !default
+$grey-30: #a3a3a3 !default
+$grey-40: #858585 !default
+$base-font-size: 16px !default
+$light: white !default
+
+$standard-action-color: $primary-highlight-color !default
+
+$text-on-light: black !default
+$subtle-text-on-light: $grey-30 !default
+
+$text-on-dark: $light !default
+$subtle-text-on-dark: $grey-30 !default
+
+$standard-border-color-on-light: $grey-20 !default
+$standard-border-color-on-dark: $grey-10 !default
+
+.sherlock-search-bar
+  +display(flex)
+  +flex-flow(row wrap)
+  min-height: 2rem
+  padding: 0.5rem
+  border: 1px solid $grey-30
+  .fragment, .provider-search-field
+    +flex(0 0 auto)
+  .fragment
+    +display(flex)
+    +flex-flow(row nowrap)
+    height: 40px
+    margin-right: 0.5rem
+    border: 2px solid $primary-highlight-color
+    border-radius: 10px
+    .fragment-name, .fragment-predicate, .fragment-search-value, .fragment-remove
+      +flex(0 0 auto)
+    .fragment-name
+      padding: 0 1rem
+      background-color: $primary-highlight-color
+      color: $text-on-dark
+      line-height: 40px
+    .fragment-search-value
+      padding: 0 0.5rem
+      font-size: $base-font-size
+      border: none
+      color: $primary-highlight-color
+      border-left: 2px solid $primary-highlight-color
+      background-color: none
+      &:focus
+        outline: none
+    .fragment-search-value-display
+      padding: 0 1rem
+      font-size: $base-font-size
+      border: none
+      color: $primary-highlight-color
+      border-left: 2px solid $primary-highlight-color
+      background-color: none
+      line-height: 40px
+    select.fragment-search-value
+      +flex(0 1 auto)
+    .fragment-remove
+      i
+        color: $primary-highlight-color
+      &:hover
+        color: $primary-highlight-hover-color
+  .provider-search-field
+    position: relative
+    & > input
+      line-height: 40px
+      font-size: $base-font-size
+      border: none
+      &:focus
+        outline: none
+    .provider-search-dropdown
+      display: none
+      position: absolute
+      z-index: 2
+      width: 200px
+      background-color: $light
+      border: 1px solid $grey-30
+      &.active
+        display: block
+      ul
+        margin: 0
+        list-style-type: none
+        li
+          padding: 0.5rem
+          cursor: pointer
+          &.has-focus, &:hover
+            background-color: $standard-action-color
+            color: $text-on-dark
+      article
+        position: relative
+        h2
+          padding: 0.5rem
+          margin-bottom: 0
+          padding-bottom: 0
+          border-top: 1px solid $standard-border-color-on-light
+          font-size: $base-font-size
+          color: $subtle-text-on-light
+        .activity-indicator
+          position: absolute
+          top: 0.5rem
+          right: 0.5rem

data/lib/generators/kea/install/templates/application.html.erb

@@ -0,0 +1,38 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+
+    <title><%= content_for?(:title) ? yield(:title) : "" %></title>
+
+    <%= stylesheet_link_tag    "backend/application" %>
+    <%= csrf_meta_tags %>
+  </head>
+
+  <body id="<%= body_id %>" class="<%= body_class %> <%= yield(:body_class) if yield(:body_class) %>">
+    <%= yield %>
+    
+    <%= content_for :knockout_templates if content_for? :knockout_templates %>
+    
+    <script type="application/javascript">
+      <% unless Rails.env.production? %>
+        window.DEBUG = true;
+      <% else %>
+        window.DEBUG = false;
+      <% end %>
+      
+      window.app        = window.app || {};
+      window.app.config = window.app.config || {};
+      window.app.errors = window.app.errors || [];
+      
+      <% flash.each do |key, message| %>  
+        window.app.errors.push({level: "<%= key %>", message: "<%= message.html_safe %>"});
+      <% end %>
+      
+      <%= content_for(:json_cache) if content_for?(:json_cache) %>
+    </script>
+    
+    <%= javascript_include_tag "application" %>
+  </body>
+</html>

data/lib/generators/kea/install/templates/global.js

@@ -0,0 +1,7 @@
+(function(app, ko, $) {
+  "use strict";
+
+  app.initialize_on(function() {
+    
+  });
+})(window.app, ko, $);

data/lib/generators/kea/install/templates/init.js

@@ -0,0 +1,18 @@
+window.app            = window.app || {};
+window.app.models     = window.app.models || {};
+window.app.services   = window.app.services || {};
+window.app.viewmodels = window.app.viewmodels || {};
+
+window.app.initializers = window.app.initializers || [];
+window.app.page         = window.app.page || {};
+window.app.paths        = window.app.paths || {};
+
+// window.app.paths.users   = '/users';
+
+window.app.sherlock = {
+  providers: []
+};
+
+moment.lang('de');
+
+Veil.globalOptions.backdropMarkup = null;

data/lib/generators/kea/install/templates/main.js

@@ -0,0 +1,18 @@
+(function(app, kea, ko) {
+  "use strict";
+
+  var Main = function Main() {
+    kea.viewmodels.Parent.apply(this);
+
+    var that = this;
+
+    this._viewmodelName = function _viewmodelName() { return "Main"; };
+    
+    // this.listener = new window.keypress.Listener();
+    
+    this.pageInitComplete = ko.observable(false);
+  };
+
+  app.viewmodels.Main = Main;
+
+})(window.app, window.kea, ko);

data/lib/generators/kea/model/USAGE

@@ -0,0 +1,7 @@
+Description:
+    Generate a Knockout data model, optionally in a namespace such as 'backend'
+
+Example:
+    rails generate kea:model User
+    
+    rails generate kea:model User backend

data/lib/generators/kea/model/model_generator.rb

@@ -0,0 +1,68 @@
+class Kea::ModelGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  argument :namespace, type: :string, required: false, default: nil, banner: "APPLICATION NAMESPACE|none"
+  argument :attributes, type: :array, required: false, banner: "model_attribute1 model_attribute1 …"
+  
+  class_option :validatable, type: :boolean, :aliases => "-v", desc: "add model validations", default: false
+  
+  def install_templates
+    @klass = name.camelize.safe_constantize
+    
+    if @klass
+      @model_attributes       = reflected_model_attributes
+      @model_associations     = reflected_model_associations
+      @attribute_initializers = attribute_initializers
+      
+      if options[:validatable]
+        @validators = @klass.validators.select {|v| v.is_a?(ActiveRecord::Validations::PresenceValidator) }
+      end
+    end
+    
+    template "model.js.erb", namespaced_path("app/assets/javascripts", "models/#{name.underscore}.js")
+  end
+  
+    private
+    
+  def namespaced_path(path, suffix = nil)
+    app_namespace = case namespace
+    when 'none', nil
+      nil
+    else
+      namespace.underscore
+    end
+    
+    File.join [path, app_namespace, suffix].compact
+  end
+  
+  def reflected_model_attributes
+    attributes.any? ? attributes.map(&:name) : @klass.attribute_names - ["id", "created_at", "updated_at"]
+  end
+  
+  def reflected_model_associations
+    @klass.reflect_on_all_associations.select { |assoc| assoc.macro == :has_one || assoc.macro == :has_many }
+  end
+  
+  def attribute_initializers
+    max_string_length        = 0
+    attribute_initializers   = []
+    association_initializers = []
+    
+    attribute_initializers = @model_attributes.collect do |attribute_name|
+      ["this.#{attribute_name}", "ko.observable();"]
+    end
+    
+    association_initializers = @model_associations.collect do |assoc|
+      if assoc.macro == :has_one
+        ["this.#{assoc.name}", "ko.observable();"]
+      elsif assoc.macro == :has_many
+        ["this.#{assoc.name}", "ko.observableArray([]);"]
+      end
+    end
+    
+    initializers = attribute_initializers + association_initializers
+    
+    max_string_length = initializers.map { |a| a.first.length }.max
+    
+    initializers.map { |i| [i.first.ljust(max_string_length + 1), " = ", i.last].join('') }
+  end
+end

data/lib/generators/kea/model/templates/model.js.erb

@@ -0,0 +1,96 @@
+(function(app, kea, ko) {
+  "use strict";
+
+  var model_name = '<%= name.camelize %>',
+      ModelClass;
+
+  ModelClass = function <%= name.camelize %>(json) {
+<% if options[:validatable] -%>
+    kea.models.Validatable.call(this);
+<% end -%>
+    
+    var that = this;
+
+    this.id            = null;
+    this.resource_path = null;
+
+<% if @klass -%>
+<% @attribute_initializers.each do |attribute| -%>
+    <%= attribute %>
+<% end -%>
+<% end -%>
+<% if options[:validatable] && @validators.any? -%>
+
+    this.validatableFields = function validatableFields() {
+      return <%= @validators.collect(&:attributes).flatten.map(&:to_s).to_s %>;
+    };
+
+    this.attachValidators = function attachValidators() {
+<% @validators.each do |validator| -%>
+
+      that.<%= validator.attributes.first %>.extend({
+        required: {
+          message: "Pflichtfeld"
+        }
+      });
+<% end -%>
+    };
+<% end -%>
+
+    this.fromJSON = function fromJSON(json) {
+      this.id            = json.id;
+      this.resource_path = json.resource_path;
+      
+<% if @klass -%>
+<% @model_attributes.each do |attribute| -%>
+      this.<%= attribute %>( json.<%= attribute %> );
+<% end -%>
+<% @model_associations.each do |assoc| -%>
+<% if assoc.macro == :has_one -%>
+
+      if (json.<%= assoc.name %>) {
+        this.<%= assoc.name %>( new app.models.<%= assoc.name.to_s.singularize.camelize %>(json.<%= assoc.name %>) );
+      }
+<% elsif assoc.macro == :has_many -%>
+
+      if (json.<%= assoc.name %>) {
+        this.<%= assoc.name %>.removeAll();
+        
+        json.<%= assoc.name %>.forEach(function(<%= assoc.name.to_s.singularize %>) {
+          that.<%= assoc.name %>.push( new app.models.<%= assoc.name.to_s.singularize.camelize %>(<%= assoc.name.to_s.singularize %>) );
+        });
+      }
+<% end -%>
+<% end -%>
+<% end -%>
+    };
+    
+    this.serialize = function serialize() {
+      return {
+<% if @klass -%>
+<% @model_attributes.each do |attribute| -%>
+        <%= attribute %>: this.<%= attribute %>(),
+<% end -%>
+<% @model_associations.each do |assoc| -%>
+<% if assoc.macro == :has_one -%>
+        <%= assoc.name %>: this.<%= assoc.name %>().serialize(),
+<% elsif assoc.macro == :has_many -%>
+        <%= assoc.name %>: this.<%= assoc.name %>().map(function(<%= assoc.name.to_s.singularize %>) { <%= assoc.name.to_s.singularize %>.serialize(); }),
+<% end -%>
+<% end -%>
+<% end -%>
+      };
+    };
+
+    if (json) {
+      this.fromJSON(json);
+    }
+  };
+
+  kea.u.inherit(ModelClass, kea.models.Base);
+
+  ModelClass.prototype._modelName = function _modelName() { return model_name; };
+
+  app.models[model_name] = ModelClass;
+
+})(window.app, window.kea, ko);

data/lib/generators/kea/service/USAGE

@@ -0,0 +1,7 @@
+Description:
+    Generate a Knockout service, optionally in a namespace such as 'backend'
+
+Example:
+    rails generate kea:service User
+    
+    rails generate kea:service User backend

data/lib/generators/kea/service/service_generator.rb

@@ -0,0 +1,21 @@
+class Kea::ServiceGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('../templates', __FILE__)
+  argument :namespace, type: :string, required: false, default: nil
+  
+  def install_templates
+    template "service.js.erb", namespaced_path("app/assets/javascripts", "services/#{name.underscore}.js")
+  end
+  
+    private
+    
+  def namespaced_path(path, suffix = nil)
+    app_namespace = case namespace
+    when 'none', nil
+      nil
+    else
+      namespace.underscore
+    end
+    
+    File.join [path, app_namespace, suffix].compact
+  end
+end

data/lib/generators/kea/service/templates/model.js.erb

@@ -0,0 +1,58 @@
+(function(app, kea, ko) {
+  "use strict";
+
+  var model_name  = "<%= name.camelize %>",
+      resourcePath,
+      collectionPath,
+      getCollection,
+      get,
+      refresh,
+      create,
+      update,
+      destroy;
+  
+  resourcePath = function resourcePath(id) {
+    return collectionPath() + '/' + id;
+  };
+  
+  collectionPath = function collectionPath() {
+    return app.paths.<%= name.underscore %>;
+  };
+
+  getCollection = function getCollection(params) {
+    return kea.services.Base.get(model_name, collectionPath(), params);
+  };
+  
+  get = function get(id, params, try_cache) {
+    return kea.services.Base.get(model_name, resourcePath(id), params, try_cache);
+  };
+  
+  refresh = function refresh(model_instance, params) {
+    return kea.services.Base.refresh(model_name, model_instance, params, resourcePath(model_instance.id));
+  };
+  
+  create = function create(model_instance) {
+    return kea.services.Base.create(model_name, model_instance, collectionPath())
+              .fail(kea.services.Base.failure422Handler);
+  };
+  
+  update = function update(model_instance, params) {
+    return kea.services.Base.update(model_name, model_instance, params, resourcePath(model_instance.id))
+            .fail(kea.services.Base.failure422Handler);
+  };
+  
+  destroy = function destroy(model_instance) {
+    return kea.services.Base.destroy(model_name, model_instance, resourcePath(model_instance.id))
+            .fail(kea.services.Base.failure422Handler);
+  };
+
+  app.services[model_name] = {
+    getCollection: getCollection,
+    get: get,
+    refresh: refresh,
+    create: create,
+    update: update,
+    destroy: destroy
+  };
+
+})(window.app, window.kea, ko);

data/lib/generators/kea/viewmodel/USAGE

@@ -0,0 +1,6 @@
+Description:
+    Generate a Knockout viewmodel, optionally in a namespace such as 'backend'
+
+Example:
+    rails generate kea:viewmodel UserEditor
+    rails generate kea:viewmodel UserEditor backend