notifly 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65940f99d804f1a248f21de334ca2cfd2eb749c3
-  data.tar.gz: d4b365df60e2712776ee90b72eed3feee96e0905
+  metadata.gz: 079f1db58c119ea5ec0aa5b487c0aa45f6b24d61
+  data.tar.gz: b1a215bc6e1d3caccafedd29e86c2ee5e90467df
 SHA512:
-  metadata.gz: 231ce6dc564754be301b7e682e42e4c26bea55fa2bac4676a8dfe9fefb7469edd720565ccd22051ea3c8d645471b41372139e282c6bbf59a724695ab7671ccdd
-  data.tar.gz: c6f8ae0734c6162cbcbe13c92ccfbe3fd91528294e89cdd088d2cfe3e0c598b8d93ef5387759f445db032698f6b8b14deede3b810fc1e2c0de230ac95efad179
+  metadata.gz: 3aa005a8e84945e9228599e91a3b791a8ff8a9923af1cc5cff9e043e5bcd0e8a47ad9c17586ba5002183e2a28032be4b32d83f4ed93cc7ad48044f96ab3a2991
+  data.tar.gz: a31efb84696178c8126b037f221a4e0cab4e5f4e3f4779eea11071fbcc5422c04be383b9b8820769726dc9ff8e71a83a3d695828e315ede74707f816d1fda7bb

data/README.md

@@ -161,7 +161,8 @@ end
 | `template: :foo`             | send email using `foo` mail template and a notification using notifly template |
 
 Notiflies with `mail: { only: true }` will persist notifications, but them won't
-be in receivers notifications views. If you use [delayed_job](https://github.com/collectiveidea/delayed_job)
+be in receivers notifications views. If you use
+[delayed_job](https://github.com/collectiveidea/delayed_job)
 or [sidekiq](https://github.com/mperham/sidekiq) mails will be sent async.
 
 ### Notifications access
@@ -181,15 +182,33 @@ You can access the notifications using the following methods:
 
 ## Front-end
 
-First, you need to have a `current_user` in `ApplicationController`, if you use
-[Devise](https://github.com/plataformatec/devise) it is already there.
+First, you need to have a `current_user`, if you use
+[Devise](https://github.com/plataformatec/devise) maybe it is already there. If you
+haven't a `current_user`, just define a method in `ApplicationController` and
+add it to the helpers methods. Your controller should look like this:
 
-After that you need our assets, add them to your `application.js`
+```ruby
+class ApplicationController < ActionController::Base
+  def current_user
+    current_talker
+  end
+
+  ActiveSupport.on_load(:action_controller) do
+    helper_method :current_user
+  end
+end
+``
+
+After that you need our assets, add them to your `application.js` and `application.css`.
 
 ```javascript
 //= require notifly
 ```
 
+The `notifly` contain the code to do all requests and notifications injection, if
+you do not use [Twitter bootstrap](http://getbootstrap.com/) you will need
+to add `//= notifly_dropdown` to the code above.
+
 ```css
 /*
 *= require notifly
@@ -206,11 +225,7 @@ This will inject our views and it will be like that
 
 ![image](http://upl.io/i/4i26o3.png)
 
-Notifications and Mails are rendered with their templates. They use a simple default
-template but if you want to change or create new ones run the generate below
-with the option that you want or create them in `app/views/notifly/templates/`.
-Remember that notifications templates should be in `notifications` folder and
-mails templates in `mails` folder.
+If you want to change something just use the code below
 
 ```shell
   $ rails generate notifly:views
@@ -222,6 +237,12 @@ mails templates in `mails` folder.
 | `--layout`       | generates layout files |
 | `--mail`         | generates mail templates files |
 
+Notifications and Mails are rendered with their templates. They use a simple default
+template but if you want to change or create new ones run the generate above
+with the option that you want or create them in `app/views/notifly/templates/`.
+Remember that notifications templates should be in `notifications` folder and
+mails templates in `mails` folder.
+
 If you already have a layout and just want add our features to it, take a look
 at [Adapting your layout](#adapting).
 
@@ -235,11 +256,11 @@ you can change it in `config/locales/notifly.en.yaml` or create your own.
 All partials that we insert in your layout are in the gem or if you generated them,
 they will be in `app/views/notifly/layouts/`
 
-Above are the elements that will loading the Notifly in your layout
+Below are the elements that will loading the Notifly in your layout
 
   - **Counter**: this element will show how many notifications are not seen. It
-    should have the id `#notifly-counter`, and the html rendered in will be
-    the `_counter.html.erb`
+    should have the id `#notifly-counter`, and it will be replaced by the
+    `_counter.html.erb`
   - **Notifications icon**: this element is the trigger to load the notifications
     and you should have an icon to show when the user "have notifications" and
     "do not have notifications" this element should have the id `#notifly-icon`. The
@@ -261,6 +282,10 @@ Above are the elements that will loading the Notifly in your layout
   - **Toggle read**: this link will be rendered by `_actions.html.erb' in
     `_notification.html.erb`
 
+Those elements should be inside an element with id `#notifly` and the dropdown
+trigger should have the id `#notifly-trigger`. For more info and examples, just
+take a look at `_notifly.html.erb`
+
 # Contributing
 
 Consider to use [zenhub](https://www.zenhub.io/), with it will know what issues

data/app/assets/javascripts/notifly.js

@@ -1,5 +1,6 @@
 //= require 'jquery'
 //= require 'jquery_ujs'
+//= require 'tinycon'
 //= require 'notifly/get_notifications'
 //= require 'notifly/seen_notifications'
 //= require 'notifly/read_notifications'
@@ -9,4 +10,6 @@ $(document).ready(function() {
   $(document).on('click', '#notifly-notifications-panel.dropdown-menu', function (e) {
     $('#notifly').hasClass('keep_open') && e.stopPropagation();
   });
+
+  Tinycon.setBubble(0);
 });

data/app/assets/javascripts/notifly_dropdown.js

@@ -1 +1 @@
-//= require 'twitter/bootstrap'
+//= require 'twitter/bootstrap/dropdown'

data/app/controllers/notifly/notifications_controller.rb

@@ -40,7 +40,8 @@ module Notifly
       end
 
       def current_user_notifications
-        current_user.notifly_notifications.not_only_mail
+        @user = current_user
+        @user.notifly_notifications.not_only_mail
       end
 
       def count_unseen

data/app/models/notifly/notification.rb

@@ -4,7 +4,7 @@ module Notifly
     belongs_to :sender, polymorphic: true
     belongs_to :receiver, polymorphic: true
 
-    before_validation :convert_data, :set_template
+    before_validation :convert_data, :set_template, :set_mail
 
     scope :all_from,      -> (receiver) { where(receiver: receiver) }
     scope :unseen,        -> { where(seen: false) }
@@ -44,5 +44,9 @@ module Notifly
       def set_template
         self.template ||= :default
       end
+
+      def set_mail
+        self.mail ||= :never
+      end
   end
 end

data/app/views/notifly/layouts/_empty.html.erb

@@ -0,0 +1,3 @@
+<div class="notifly-empty">
+  You have no notifications
+</div>

data/app/views/notifly/layouts/_notifly.html.erb

@@ -1,5 +1,3 @@
-<!-- This partial requires the locals: receiver -->
-
 <div id="notifly" class="dropdown keep_open">
 
   <a id="notifly-trigger" href="#" class="dropdown-toggle" data-toggle="dropdown">
@@ -18,7 +16,7 @@
     </div>
 
     <div id="notifly-notifications-content">
-       <div class="loading">Loading notifications...</div>
+       <div class="notifly-loading">Loading notifications...</div>
     </div>
 
     <div id="notifly-notifications-footer">

data/app/views/notifly/notifications/index.js.erb

@@ -3,8 +3,10 @@
 <% last_notification = @notifications.last.try(:id) %>
 <% first_notification = @notifications.first.try(:id) %>
 
+$('#notifly-notifications-content .notifly-loading').remove();
+$('#notifly-notifications-content .notifly-empty').remove();
+
 <% if @notifications.any? %>
-  $('#notifly-notifications-content .loading').remove();
 
   <% if @scope_param == 'older' %>
     $('#notifly-notifications-content').append("<%= j rendered_notifications %>");
@@ -20,14 +22,17 @@
   <% end %>
 
 <% else %>
-    if (notiflyLastNotification == undefined)
+    if (notiflyLastNotification == undefined) {
       $('#notifly-more-notifications-link').remove();
+      $('#notifly-notifications-content').append("<%= j(render 'notifly/layouts/empty')%>")
+    }
 
 <% end %>
 
-<% if @scope_param == 'older' and Notifly::Notification.older(than: last_notification).blank? %>
+<% if @scope_param == 'older' and @user.notifly_notifications.older(than: last_notification).blank? %>
   $('#notifly-more-notifications-link').remove();
 <% end %>
 
 $('#notifly-counter').replaceWith("<%= j(render 'notifly/layouts/counter', counter: @counter)%>");
 $('#notifly-icon').replaceWith("<%= j notifly_icon(@counter > 0) %>")
+Tinycon.setBubble(<%= @counter %>);

data/app/views/notifly/notifications/seen.js.erb

@@ -1,2 +1,3 @@
 $('#notifly-counter').replaceWith("<%= j(render 'notifly/layouts/counter', counter: @counter)%>");
-$('#notifly-icon').replaceWith("<%= j notifly_icon(@counter > 0) %>")
+$('#notifly-icon').replaceWith("<%= j notifly_icon(@counter > 0) %>");
+Tinycon.setBubble(<%= @counter %>);

data/vendor/assets/javascripts/tinycon.js

@@ -0,0 +1,279 @@
+/*!
+ * Tinycon - A small library for manipulating the Favicon
+ * Tom Moor, http://tommoor.com
+ * Copyright (c) 2012 Tom Moor
+ * @license MIT Licensed
+ * @version 0.6.3
+ */
+
+(function(){
+
+	var Tinycon = {};
+	var currentFavicon = null;
+	var originalFavicon = null;
+	var faviconImage = null;
+	var canvas = null;
+	var options = {};
+	var r = window.devicePixelRatio || 1;
+	var size = 16 * r;
+	var defaults = {
+		width: 7,
+		height: 9,
+		font: 10 * r + 'px arial',
+		colour: '#ffffff',
+		background: '#F03D25',
+		fallback: true,
+		crossOrigin: true,
+		abbreviate: true
+	};
+
+	var ua = (function () {
+		var agent = navigator.userAgent.toLowerCase();
+		// New function has access to 'agent' via closure
+		return function (browser) {
+			return agent.indexOf(browser) !== -1;
+		};
+	}());
+
+	var browser = {
+		ie: ua('msie'),
+		chrome: ua('chrome'),
+		webkit: ua('chrome') || ua('safari'),
+		safari: ua('safari') && !ua('chrome'),
+		mozilla: ua('mozilla') && !ua('chrome') && !ua('safari')
+	};
+
+	// private methods
+	var getFaviconTag = function(){
+
+		var links = document.getElementsByTagName('link');
+
+		for(var i=0, len=links.length; i < len; i++) {
+			if ((links[i].getAttribute('rel') || '').match(/\bicon\b/)) {
+				return links[i];
+			}
+		}
+
+		return false;
+	};
+
+	var removeFaviconTag = function(){
+
+		var links = document.getElementsByTagName('link');
+		var head = document.getElementsByTagName('head')[0];
+
+		for(var i=0, len=links.length; i < len; i++) {
+			var exists = (typeof(links[i]) !== 'undefined');
+			if (exists && (links[i].getAttribute('rel') || '').match(/\bicon\b/)) {
+				head.removeChild(links[i]);
+			}
+		}
+	};
+
+	var getCurrentFavicon = function(){
+
+		if (!originalFavicon || !currentFavicon) {
+			var tag = getFaviconTag();
+			originalFavicon = currentFavicon = tag ? tag.getAttribute('href') : '/favicon.ico';
+		}
+
+		return currentFavicon;
+	};
+
+	var getCanvas = function (){
+
+		if (!canvas) {
+			canvas = document.createElement("canvas");
+			canvas.width = size;
+			canvas.height = size;
+		}
+
+		return canvas;
+	};
+
+	var setFaviconTag = function(url){
+		removeFaviconTag();
+
+		var link = document.createElement('link');
+		link.type = 'image/x-icon';
+		link.rel = 'icon';
+		link.href = url;
+		document.getElementsByTagName('head')[0].appendChild(link);
+	};
+
+	var log = function(message){
+		if (window.console) window.console.log(message);
+	};
+
+	var drawFavicon = function(label, colour) {
+
+		// fallback to updating the browser title if unsupported
+		if (!getCanvas().getContext || browser.ie || browser.safari || options.fallback === 'force') {
+			return updateTitle(label);
+		}
+
+		var context = getCanvas().getContext("2d");
+		var colour = colour || '#000000';
+		var src = getCurrentFavicon();
+
+		faviconImage = document.createElement('img');
+		faviconImage.onload = function() {
+
+			// clear canvas
+			context.clearRect(0, 0, size, size);
+
+			// draw the favicon
+			context.drawImage(faviconImage, 0, 0, faviconImage.width, faviconImage.height, 0, 0, size, size);
+
+			// draw bubble over the top
+			if ((label + '').length > 0) drawBubble(context, label, colour);
+
+			// refresh tag in page
+			refreshFavicon();
+		};
+
+		// allow cross origin resource requests if the image is not a data:uri
+		// as detailed here: https://github.com/mrdoob/three.js/issues/1305
+		if (!src.match(/^data/) && options.crossOrigin) {
+			faviconImage.crossOrigin = 'anonymous';
+		}
+
+		faviconImage.src = src;
+	};
+
+	var updateTitle = function(label) {
+
+		if (options.fallback) {
+			// Grab the current title that we can prefix with the label
+			var originalTitle = document.title;
+
+			// Strip out the old label if there is one
+			if (originalTitle[0] === '(') {
+				originalTitle = originalTitle.slice(originalTitle.indexOf(' '));
+			}
+
+			if ((label + '').length > 0) {
+				document.title = '(' + label + ') ' + originalTitle;
+			} else {
+				document.title = originalTitle;
+			}
+		}
+	};
+
+	var drawBubble = function(context, label, colour) {
+
+		// automatic abbreviation for long (>2 digits) numbers
+		if (typeof label == 'number' && label > 99 && options.abbreviate) {
+			label = abbreviateNumber(label);
+		}
+
+		// bubble needs to be larger for double digits
+		var len = (label + '').length-1;
+
+		var width = options.width * r + (6 * r * len),
+			height = options.height * r;
+
+		var top = size - height,
+            left = size - width - r,
+            bottom = 16 * r,
+            right = 16 * r,
+            radius = 2 * r;
+
+		// webkit seems to render fonts lighter than firefox
+		context.font = (browser.webkit ? 'bold ' : '') + options.font;
+		context.fillStyle = options.background;
+		context.strokeStyle = options.background;
+		context.lineWidth = r;
+
+		// bubble
+		context.beginPath();
+        context.moveTo(left + radius, top);
+		context.quadraticCurveTo(left, top, left, top + radius);
+		context.lineTo(left, bottom - radius);
+        context.quadraticCurveTo(left, bottom, left + radius, bottom);
+        context.lineTo(right - radius, bottom);
+        context.quadraticCurveTo(right, bottom, right, bottom - radius);
+        context.lineTo(right, top + radius);
+        context.quadraticCurveTo(right, top, right - radius, top);
+        context.closePath();
+        context.fill();
+
+		// bottom shadow
+		context.beginPath();
+		context.strokeStyle = "rgba(0,0,0,0.3)";
+		context.moveTo(left + radius / 2.0, bottom);
+		context.lineTo(right - radius / 2.0, bottom);
+		context.stroke();
+
+		// label
+		context.fillStyle = options.colour;
+		context.textAlign = "right";
+		context.textBaseline = "top";
+
+		// unfortunately webkit/mozilla are a pixel different in text positioning
+		context.fillText(label, r === 2 ? 29 : 15, browser.mozilla ? 7*r : 6*r);
+	};
+
+	var refreshFavicon = function(){
+		// check support
+		if (!getCanvas().getContext) return;
+
+		setFaviconTag(getCanvas().toDataURL());
+	};
+
+	var abbreviateNumber = function(label) {
+		var metricPrefixes = [
+			['G', 1000000000],
+			['M',    1000000],
+			['k',       1000]
+		];
+
+		for(var i = 0; i < metricPrefixes.length; ++i) {
+			if (label >= metricPrefixes[i][1]) {
+				label = round(label / metricPrefixes[i][1]) + metricPrefixes[i][0];
+				break;
+			}
+		}
+
+		return label;
+	};
+
+	var round = function (value, precision) {
+		var number = new Number(value);
+		return number.toFixed(precision);
+	};
+
+	// public methods
+	Tinycon.setOptions = function(custom){
+		options = {};
+
+		for(var key in defaults){
+			options[key] = custom.hasOwnProperty(key) ? custom[key] : defaults[key];
+		}
+		return this;
+	};
+
+	Tinycon.setImage = function(url){
+		currentFavicon = url;
+		refreshFavicon();
+		return this;
+	};
+
+	Tinycon.setBubble = function(label, colour) {
+		label = label || '';
+		drawFavicon(label, colour);
+		return this;
+	};
+
+	Tinycon.reset = function(){
+		setFaviconTag(originalFavicon);
+	};
+
+	Tinycon.setOptions(defaults);
+	window.Tinycon = Tinycon;
+
+	if(typeof define === 'function' && define.amd) {
+		define(Tinycon);
+	}
+
+})();

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: notifly
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Pedro Passalini
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -73,62 +73,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: capybara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.4.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.4.4
-- !ruby/object:Gem::Dependency
-  name: poltergeist
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.5.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.5.1
-- !ruby/object:Gem::Dependency
-  name: shoulda-matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.7.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: pry-rails
   requirement: !ruby/object:Gem::Requirement
@@ -171,20 +115,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: launchy
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: better_errors
   requirement: !ruby/object:Gem::Requirement
@@ -255,6 +185,7 @@ files:
 - app/models/notifly/notification.rb
 - app/views/notifly/layouts/_actions.html.erb
 - app/views/notifly/layouts/_counter.html.erb
+- app/views/notifly/layouts/_empty.html.erb
 - app/views/notifly/layouts/_index.html.erb
 - app/views/notifly/layouts/_notification.html.erb
 - app/views/notifly/layouts/_notifly.html.erb
@@ -284,7 +215,8 @@ files:
 - lib/notifly/models/options/fly.rb
 - lib/notifly/railtie.rb
 - lib/tasks/notifly_tasks.rake
-- vendor/assets/javascripts/twitter/bootstrap.js
+- vendor/assets/javascripts/tinycon.js
+- vendor/assets/javascripts/twitter/bootstrap/dropdown.js
 - vendor/assets/stylesheets/twitter/bootstrap.css
 homepage: https://github.com/algorich/notifly
 licenses: