kindred 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98d0f43a8b8e5ab779ef396a9efc3c0fa3876075
-  data.tar.gz: d4aaa6ad2ee96a901c1a8da7a02816d0b34301f5
+  metadata.gz: 1e03bccd44f384512d021142b9c05e55432834f2
+  data.tar.gz: 7a82f21f14b9fcfed70848620ae80e0505da041d
 SHA512:
-  metadata.gz: c1bfe9d5dfb80638e4f3ff0cf5dbd9437d08449b1b83d09ddb975fa75d9185764ff0daaaf16ebd3410c696280a6b53388524847f0ead0cfb9daca62f9d78f62f
-  data.tar.gz: 87f37d9b4ea4daf4c71bcb3b6a3cb14e3c7764b6f2b47fefa869bc43d3afaa1d490053cec5e79a91cd4144ede5dc3e2b22842f58392c984f48369085918d459a
+  metadata.gz: 76f08bed0689360d3765562774575bf006593e162499eb2ce5e6284f58e95ab0060c4202e84c8e0acc4c4172f5706f0243353ea09e7839d5e842b833162146b6
+  data.tar.gz: 99e97908c9dccf760e01ab940da6d4fa5357b34af60f1a93375f26502f2ab07ce1a677c88c92ca2f6deb4e783f219c66a07bd2f884c6861c0b806340572fc52e

data/README.md

@@ -12,6 +12,7 @@ kindred
 | Homepage                |  [http://mfpiccolo.github.io/kindred][homepage] |
 | Documentation           |  [http://rdoc.info/github/mfpiccolo/kindred/frames][documentation] |
 | Issues                  |  [https://github.com/mfpiccolo/kindred/issues][issues] |
+| Conversation            |  [![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/mfpiccolo/kindred?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 ## Description
 Kindred is an open source project that intends to optimize programmers happiness and productivity for client-heavy rails applications. Kindred aims to allow developers to create robust client side applications with minimal code while maintaining best practices and conventions.
@@ -38,12 +39,45 @@ Add `gem "kindred"` to gemfile
 
 Add `//= require kindred` to application.js manifest
 
-Change your asset pipeline configuration to prevent uglifying of JS class names:
+If you are using uglifier you may need to add the following to assets.rb:
 
 ```ruby
 Rails.application.config.assets.js_compressor = Uglifier.new(mangle: false)
 ```
 
+The following config needs to be abstracted to the gem or refactored but for now:
+
+Add this configuration to application.html.erb:
+
+```
+<%= kindred_model_data %>
+<%= content_for :kindred_script %>
+<script type="text/javascript">
+  App.BaseUrl = '<%= "#{request.protocol}#{request.host_with_port}" %>';
+</script>
+```
+
+In the controller that you will be rendering kindred models you need to add:
+
+```
+...
+  after_action :setup_kindred
+
+  helper_method :js
+...
+```
+
+```
+  def setup_kindred
+    view_context.content_for :kindred_script do
+      js(js_class: "App.Template", function: "set_templates", args: @kindred_hash, rendered: true)
+    end
+  end
+```
+
+One again, much of this configuration will be removed in the future but is neccesary at the moment.
+
+
 ## Demo
 
 If you would like to see kindred in action check out [kindred-demo](https://kindred-demo.herokuapp.com/invoices/1/edit).
@@ -57,12 +91,12 @@ The `#template` method takes the following keyword arguments:
 
 `collection:` Collection of json serializable ruby objects
 
-`target:` String of the data-target attribute wrapper
+`target_uuid:` String of the uuid for the data-target-uuid attribute wrapper
 
 `&block` In the block pass html that will be used for that model
 
 ```HTML
-  <div data-target="line-item">
+  <div <%= target @invoice %>>
     <%= template(collection: @line_items, target: "line-item", model: "line_item") do %>
       <tr>
         <td><%= k_text_field_tag(:line_item, :description) %></td>
@@ -85,13 +119,31 @@ You could then get access to the collection or the template by using those prope
 
 `li_info.collection` would return the json collection
 
+###Interpolation
+Inside of templates, it is possible to interpolate dynamic data by using the {{}} syntax.
+
+For example, you could interpolate the id of the line item by doing the following
+```HTML
+  <div <%= target @invoice %>>
+    <%= template(collection: @line_items, target: "line-item", model: "line_item") do %>
+      <tr>
+        <td>{{line_item.id}}</td>
+        <td><%= k_text_field_tag(:line_item, :description) %></td>
+        <td><%= k_text_field_tag(:line_item, :qty) %></td>
+        <td><%= k_text_field_tag(:line_item, :price_cents) %></td>
+        <td><%= k_check_box_tag(:line_item, :complete) %></td>
+      </tr>
+    <% end %>
+  </div>
+ ```
+
 ###Controllers
 In kindred, javascript controllers are a client side augmentation of your ruby controllers.  They are just client side code that gets run on page load.
 
 ```coffeescript
-  class this.InvoicesController
-    @edit: ->
-       console.log "Run this on invoice edit view"
+class this.InvoicesController
+  @edit: ->
+     console.log "Run this on invoice edit view"
 ```
 
 To ensure that this code is run on the client side call the js method from your view or controller:

data/app/assets/javascripts/models/active_page.coffee

@@ -25,9 +25,10 @@ class App.ActivePage
       if select.length
         select.val(value)
 
-      span = $template.find("span[data-attr='" + key + "']")
-      if span.length
-        span.html(value)
+      display = $template.find("div[data-attr='" + key + "'], span[data-attr='" + key + "'], p[data-attr='" + key + "']")
+      if display.length
+        new_display = display.html(value)
+        display.replaceWith(new_display)
 
     @_append_data_model_to_page()
 
@@ -40,6 +41,11 @@ class App.ActivePage
     $.each @attributes, (attr, val) =>
       $("[data-k-uuid='" + @uuid + "'][data-attr='" + attr + "']").val(val)
 
+  update_displays_on_page: ->
+    $.each @attributes, (attr, val) =>
+      # TODO make this work with span and p
+      $("div[data-k-uuid='" + @uuid + "'][data-attr='" + attr + "'], span[data-k-uuid='" + @uuid + "'][data-attr='" + attr + "'], p[data-k-uuid='" + @uuid + "'][data-attr='" + attr + "']").html(val)
+
   dirty_from_page: ->
     dirty = []
     $.each $("input[data-k-uuid='" + @uuid + "'], select[data-k-uuid='" + @uuid + "']"), (i, input) =>
@@ -65,9 +71,9 @@ class App.ActivePage
       else
         @set $input.data("attr"), $input.val()
 
-      model_data = $("[data-kindred-model]").find("[data-k-uuid='" + @uuid + "']")
-      if !isNaN(parseFloat(model_data.data("id"))) && isFinite(model_data.data("id"))
-        @id = model_data.data("id")
+    model_data = $("[data-kindred-model]").find("[data-k-uuid='" + @uuid + "']")
+    if !isNaN(parseFloat(model_data.data("id"))) && isFinite(model_data.data("id"))
+      @id = model_data.data("id")
 
     $("select[data-k-uuid='" + @uuid + "']").each (i, select) =>
       @set $(select).data("attr"), $(select).val()

data/app/assets/javascripts/models/base.coffee

@@ -101,7 +101,9 @@ class App.Base extends App.VirtualClass App.ActivePage, App.Setup
     @assign_attributes(data)
     @_clear_errors()
     @_update_data_vals_on_page()
+    @update_vals_on_page()
     @_setup_interpolated_vars()
+    @update_displays_on_page()
 
   #overridable hook
   after_save_error: (xhr) ->

data/app/helpers/template_helper.rb

@@ -1,10 +1,6 @@
 module TemplateHelper
   def template(model: nil, collection: nil, target_uuid: nil, &block)
-    model_name = if collection.present?
-      ActiveModel::Naming.singular(collection.first)
-    else
-      model
-    end
+    model_name = model
 
     @kindred_hash ||= {}
     @kindred_hash.merge!({
@@ -23,7 +19,7 @@ module TemplateHelper
   end
 
   def k_content_tag(element, attribute = nil, object = nil, content_or_options_with_block = nil, options = {}, escape = true, &block)
-    content_tag(element, nil, options.merge({data: { attr: attribute, k_uuid: k_try(object, :uuid), val: ""} }))
+    content_tag(element, nil, options.merge({data: { attr: attribute, k_uuid: k_try(object, :uuid), val: object.try(attribute.to_sym)} }))
   end
 
   def k_hidden_field_tag(name, value=nil, object=nil, delegate_to=nil, options = {})

data/lib/kindred/version.rb

@@ -1,3 +1,3 @@
 module Kindred
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kindred
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mike Piccolo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-06 00:00:00.000000000 Z
+date: 2015-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -91,6 +91,7 @@ files:
 - app/assets/javascripts/utilities/uuid.coffee
 - app/assets/javascripts/utilities/virtual_class.coffee
 - app/helpers/template_helper.rb
+- kindred-0.0.1.gem
 - kindred.gemspec
 - lib/kindred.rb
 - lib/kindred/engine.rb
@@ -115,9 +116,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: ''
 test_files: []
-has_rdoc: