jibe 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1934e5d8e1c100412827dd32a8028beeafd68f4d
-  data.tar.gz: ca820173bb5bcf6d1e108165185fc4fd628036d7
+  metadata.gz: 5bdd84d7feae05580d1c69afcc28d953030ec5f8
+  data.tar.gz: 10308c8778b8996cfed0f8a5de829bce160016a1
 SHA512:
-  metadata.gz: e6862898be25bd60e735de6aaa75d495a174972a87038ea25c8a7d243ec2de6bd15da7bc29207d9ad87482ea58820fa67323be63a4d1b9df21c090ffc877e4b1
-  data.tar.gz: 6ba56ba5725a7d1f352749d7e31be75e451672498122572d6d4a3d139109dcb29729e6cd1cc0df6b140b45ddd69eb636ba7797eb1f014888a7c8b1ea1dd3faf5
+  metadata.gz: 5e8c3b2caa25986d945356b19f4b634cbf0010655b1af33b1484c537cdb8fe2f14c323ff7d1f7f46b6203d98f6ad503a1cf1ce43bb260891ccce418750c9ced2
+  data.tar.gz: bba8e8d2f366636f09b2bfc6038ac224af5b95121a137fb13c804000221d6bc5f3132ab2e0fcc57f396d02461dc3e79c596f7bcfd5bd0cc754c6a76755b94ff5

data/README.md

@@ -6,11 +6,21 @@ Jibe keeps simple data 'n sync with very little setup. For now, it relies on Pus
 
 First, Add `gem 'jibe'` to your application's Gemfile and `bundle`.
 
-Then, [Set up Pusher.](https://github.com/pusher/pusher-gem) You'll also need to throw your pusher key into a meta tag named `pusher-key`.
+Then, [Set up Pusher.](https://github.com/pusher/pusher-gem)
+
+You'll need to throw your pusher key into a meta tag named `pusher-key`:
+
+```
+<%= tag :meta, name: "pusher-key", content: CONFIG["pusher_key"] %>
+```
 
 Add `//= require jibe` to your `application.js` file.
 
-Add `jibe` to your model.
+
+## Usage
+
+With only 2 1-word tweaks, your views will stay in sync!
+Add `jibe` to the model you'd like to stay in sync. In our case, `app/models/comment.rb`.
 
 ```
 class Comment < ActiveRecord::Base
@@ -18,7 +28,7 @@ class Comment < ActiveRecord::Base
 end
 ```
 
-Replace a collection render call:
+Replace a collection render call. In our case, its in `app/views/comments/index.html.erb`.
 
 ```
 <table>
@@ -26,7 +36,7 @@ Replace a collection render call:
 </table>
 ```
 
-with:
+should be replaced with:
 
 ```
 <table>
@@ -41,20 +51,21 @@ Now, all those `@comments` will stay in sync. At this point, its probably worth
 ```
 <%=
   jibe @comments, 
-    strategy: "prepend", # by default, new tasks are appended
-    scope: "completed", # useful in conjunction with JS callbacks
-    restrict_to: [@folder, current_user] # limit access
+    strategy: "append", # where should jibe place new records (prepend/append)
+    scope: [@post, "completed"], # checks AR objects against *_id attrs, strings are useful in conjunction with JS callbacks
+    silent: true # don't manipulate the DOM
 %>
 ```
 
-You can hijack the `beforeCreate`, `afterCreate`, `beforeUpdate`, `afterUpdate`, `beforeDestroy`, `afterDestroy` events. This is helpful for transitions.
+You can control the way the DOM is updated by using the `beforeCreate`, `afterCreate`, `beforeUpdate`, `afterUpdate`, `beforeDestroy`, `afterDestroy` events. This is helpful for transitions.
 
 ```
 Jibe.events["comments"] =
 	beforeCreate: (partial, data, scope) ->
     # partial = the DOM node
     # data = the model's attributes (override with jibe_data method in your model)
-    # scope = an optional scope based on the jibe tag in your view
+    # scope = based on the jibe tag in your view
+    # Jibe.inScope("completed", scope) is useful to check if the record is within the scope
     
 ```
 

data/app/assets/javascript/jibe.js.coffee

@@ -8,39 +8,62 @@ Jibe.tearDown = ->
 	
 Jibe.initialized = false
 
+Jibe.inScope = (test, scope) ->
+	!$.inArray test, scope == -1
+
+Jibe.compareScopeWithData = (scope, data) ->
+	if !scope.length
+		in_scope = true
+	else
+		scope_passes = 0
+
+		$.each scope, (index, s) ->
+			s_split = s.split("=")
+			if s_split.length
+				if "#{data.data[s_split[0]]}" == "#{s_split[1]}" || "#{data.data.data[s_split[0]]}" == "#{s_split[1]}"
+					scope_passes += 1
+			else
+				scope_passes += 1
+		
+		in_scope = scope_passes == scope.length
+	
+	in_scope
+
 Jibe.init = ->
 	unless Jibe.initialized
 		Jibe.initialized = true
 		pusher_key = $("meta[name='pusher-key']").attr("content")
 		Jibe.pusher = new Pusher pusher_key
-		channel = Jibe.pusher.subscribe "Jibe"
+		channel = Jibe.pusher.subscribe "jibe"
 		
 		channel.bind "event", (data) ->
 			$("script[type='x-jibe'][data-resource='#{data.collection}']").each ->
-				scope = $(this).data("scope")
+				scope = if typeof $(this).data("scope") == "undefined" then [] else $(this).data("scope").split(" ")
 				wrapper = $(this).parent()
 				before_hook_name = "before#{data.action_capitalized}"
 				after_hook_name = "after#{data.action_capitalized}"
 				partial = $(data.partial)
 				on_page = $(this).parent().find(".#{data.dom_id}, ##{data.dom_id}, .#{data.model}[data-id='#{data.id}']")
 				has_events = typeof Jibe.events[data.collection] != "undefined"
+				in_scope = Jibe.compareScopeWithData scope, data
 				
-				if has_events && typeof Jibe.events[data.collection][before_hook_name] == "function"
-					Jibe.events[data.collection][before_hook_name].call null, partial, data.data, scope
-
-				if data.action_name == "create"
-					if $(this).data("strategy") == "prepend"
-						partial.prependTo wrapper
-					else
-						partial.appendTo wrapper
-				else if data.action_name == "update"
-					on_page.replaceWith partial
+				if in_scope
+					if has_events && typeof Jibe.events[data.collection][before_hook_name] == "function"
+						Jibe.events[data.collection][before_hook_name].call null, partial, data.data, scope
 				
-				if has_events && typeof Jibe.events[data.collection][after_hook_name] == "function"
-					Jibe.events[data.collection][after_hook_name].call null, partial, data.data, scope
+					if typeof $(this).data("silent") == "undefined"
+						if data.action_name == "create"
+							if $(this).data("strategy") == "prepend"
+								partial.prependTo wrapper
+							else
+								partial.appendTo wrapper
+						else if data.action_name == "update"
+							on_page.replaceWith partial
+						else if data.action_name == "destroy"
+							on_page.remove()
 				
-				if data.action_name == "destroy"
-					on_page.remove()
+					if has_events && typeof Jibe.events[data.collection][after_hook_name] == "function"
+						Jibe.events[data.collection][after_hook_name].call null, partial, data.data, scope
 
 $ ->
 	Jibe.init()

data/jibe.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["dallas@excitereative.ca"]
   spec.summary       = %q{Jibe keeps all your data 'n sync!}
   spec.description   = %q{Jibe keeps your pages live - with almost no effort!}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/dallasread/jibe"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")

data/lib/jibe.rb

@@ -31,7 +31,7 @@ module Jibe
         unless skip_jibe
           if Jibe.director == :pusher
             model = self.class.name.downcase
-            Pusher["Jibe"].trigger("event", {
+            Pusher["jibe"].trigger("event", {
               action_name: action_name,
               action_capitalized: action_name.capitalize,
               id: id,
@@ -41,6 +41,7 @@ module Jibe
               partial: Jibe::Render.new.to_string(self),
               data: jibe_data
             })
+            logger.info "\033[0;34mJibing #{model} #{action_name}...\033[0m"
           end
         end
       end

data/lib/jibe/version.rb

@@ -1,3 +1,3 @@
 module Jibe
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/jibe/view_helpers.rb

@@ -4,33 +4,38 @@ module Jibe
       if args.try(:last).is_a? Hash
         strategy = args.try(:last)[:strategy]
         scope = args.try(:last)[:scope]
+        silent = args.try(:last)[:silent]
         restrict_to = args.try(:last)[:restrict_to]
+        partial = args.try(:partial)
       end
-    
-      strategy = "append" if strategy.blank?
-      resource = "#{args.first.first.class.name}".downcase.pluralize
-      data = { 
-        strategy: strategy, 
-        resource: resource,
-        scope: scope
-      }
-    
-      if restrict_to
-        data[:restrict_to] = []
+
+      resource = "#{args.first.class.to_s.split("::").first}".downcase.pluralize
+
+      data = {}
+      data[:resource] = resource
+      data[:strategy] = strategy if strategy
+      data[:silent] = silent if silent
       
-        if restrict_to.is_a? Array
-          restrict_to.each do |restrict|
-            data[:restrict_to].push "#{restrict.class.name.downcase}-#{restrict.id}"
+      if scope
+        if scope.is_a? Array
+          scopes = []
+          
+          scope.each do |s|
+            s = "#{s.class.name.downcase}_id=#{s.id}" unless s.is_a? String
+            scopes.push s
           end
+          
+          data[:scope] = scopes.join(" ")
+        elsif scope.is_a? Object
+          data[:scope] = "#{scope.class.name.downcase}_id=#{scope.id}"
         else
-          data[:restrict_to].push "#{restrict_to.class.name.downcase}-#{restrict_to.id}"
+          data[:scope] = scope
         end
-      
-        data[:restrict_to] = data[:restrict_to].join(",")
       end
-    
+      
+      data[:silent] = true if args.first.nil?
       html = content_tag :script, nil, type: "x-jibe", data: data
-      html += render *args
+      html += render *args unless args.first.nil?
       html.html_safe
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jibe
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Dallas Read
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-25 00:00:00.000000000 Z
+date: 2014-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,7 +56,7 @@ files:
 - lib/jibe/railtie.rb
 - lib/jibe/version.rb
 - lib/jibe/view_helpers.rb
-homepage: ''
+homepage: https://github.com/dallasread/jibe
 licenses:
 - MIT
 metadata: {}