frontend_notifier 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+  gem "rails", ">= 3.1.0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Roman Snitko
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,55 @@
+FrontendNotifier
+=================
+
+![Screenshot](https://github.com/snitko/frontend_notifier/raw/master/Screenshot.png)
+
+Shows cute notifications in frontend. No need to manually create your own html/css/js to show Rails's flash[:notice] or other flashes. This gem handles it nicely + you can customize it.
+
+INSTALLATION
+------------
+
+1. `gem install frontend_notifier`
+2. put the following in your .scss file: `@import "frontend_notifier";`
+3. put the following in your .js or .coffee file: `#= require lib/_frontend_notifier`
+
+USAGE
+-----
+
+**Regular reuqests**
+FrontendNotifier will pick up any flash with the names `:error`, `:alert`, `:success` or `:notice`. You can customize this by creating your own `views/shared/frontend_notifier` template.
+
+**Ajax requests**
+Sometimes you may need to display the notification after an ajax request. For that, you may want to use `#notify_frontend` method now available in your controller and pass it either a model with (or without) errors:
+
+    def create
+      ...    
+      notify_frontend(@user)
+    end
+
+or a message and an error type:
+
+    def create
+      ...
+      notify_frontend("Email can't be blank", :error)
+    end
+
+Both will result in rendering the following json:
+
+    { type: "error", message: "Email can't be blank" }
+
+Now you can deal with this in your ajax request callback. Assuming this is a jQuery $.ajax function:
+
+    success: function(response) { FrontendNotifier.show(response) }
+
+In this case, `FrontendNotifier.show` will recognize the type of the notification (either "success" or "error") and display appropriately styled notification (by default, green background for success and red for error).
+
+You can also specify the type of error to the FrontendNotifier class manually and call the .show() function anywhere in your js:
+    FrontendNotifier.show("Testing notifications", "success")
+
+There's also a handy #join_model_errors method added to the ApplicationController, which you might want to look at. It basically takes errors from the model and compiles them into a one line message which may then be handed to the FrontendNotifier. So, you may want to use it like this:
+
+    flash[:error] = join_model_errors(@user, include_field_names: true) # :include_field_names is true by default
+
+USAGE
+-----
+For now, the gem lacks generators, so if you want to customize scss styles or haml templates, just copy .scss/.haml files from their gem dirs into your app dirs and change them.

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "frontend_notifier"
+  gem.homepage = "http://github.com/snitko/frontend_notifier"
+  gem.license = "MIT"
+  gem.summary = %Q{Rails extension, shows cute notifications in frontend.}
+  gem.description = %Q{Shows cute notifications in frontend. No need to manually create your own html/css/js to show Rails's flash[:notice] or other flashes. This handles it nicely + you can customize it.}
+  gem.email = "subscribe@snitko.ru"
+  gem.authors = ["Roman Snitko"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+#require 'rake/testtask'
+#Rake::TestTask.new(:test) do |test|
+#  test.libs << 'lib' << 'test'
+#  test.pattern = 'test/**/test_*.rb'
+#  test.verbose = true
+#end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "frontend_notifier #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/app/assets/javascripts/lib/_frontend_notifier.js.coffee

@@ -0,0 +1,45 @@
+jQuery ($) ->
+
+  class _FrontendNotifier
+    
+    constructor: () ->
+      @block   = $("#frontend_notification")
+      @message = $(".message", @block)
+      @timer   = $(".closingCounter .number", @block)
+      @update_timer = () =>
+        unless @stop_timer
+          if @timer.text() != "1"
+            @timer.text (@timer.text() - 1)
+            setTimeout @update_timer, 1000
+          else
+            this.close()
+      $("#close_notification_ico").click () =>
+        @stop_timer = true
+        this.close()
+
+    show: (message, type) ->
+      unless typeof(message) == "string"
+        type    = message.type
+        message = message.message
+      @block.removeClass("error").removeClass("success").addClass(type)
+      @timer.text 5
+      @message.html(message)
+      @block.show()
+      @current_timestamp = new Date().getTime()
+      this.start_timer(@current_timestamp)
+
+    show_error: () ->
+      this.show $("#frontend_notification_error500").text(), "error"
+
+    close: () ->
+      @block.slideUp(300)
+
+    start_timer: (timestamp) ->
+      @stop_timer = false
+      setTimeout () =>
+        @update_timer() if timestamp == @current_timestamp
+      ,1000
+
+  window.FrontendNotifier = new _FrontendNotifier
+  if $("#frontend_notification_content span").size() > 0
+    FrontendNotifier.show $("#frontend_notification_content span").text(), $("#frontend_notification_content span").attr("class")

data/app/assets/stylesheets/_frontend_notifier.css.scss

@@ -0,0 +1,24 @@
+@mixin clearfix {
+  display: block;
+  &:after { content: "."; display: block; height: 0; clear: both; visibility: hidden; }
+}
+
+#frontend_notification {
+  height: 77px; position: fixed; color: #fff; z-index: 1999; width: 100%; display: none;
+  .contentWrapper { float: left; width: 100%; @include clearfix; }
+  .message { text-align: center; margin-right: 150px; padding-top: 28px; padding-left: 150px; padding-right: 20px; }
+  .info    {
+    float: left; width: 132px; margin-left: -150px; padding: 10px 8px 10px 10px; font-size: 11px; text-align: right;
+    .closingCounter { opacity: 0.5; }
+    img#close_notification_ico { opacity: 0.5; float: right; margin-left: 5px; cursor: pointer; }
+    img#close_notification_ico:hover { opacity: 1; }
+    .reportBug {
+      background-color: #670000; padding: 5px; font-size: 11px; margin: 0 auto; margin: 10px 10px 0 0; display: inline-block;
+      a, a:visited { opacity: 0.5; color: #fff; text-decoration: none; }
+      a:hover { opacity: 1; }
+    }
+  }
+}
+#frontend_notification.error   { background-color: #a90000; }
+#frontend_notification.success { background-color: #57a900; .reportBug { display: none; } }
+#frontend_notification_content, #frontend_notification_error500 { display: none; }

data/app/config/locales/en.yml

@@ -0,0 +1,4 @@
+frontend_notifier:
+  closes_in: closes in
+  sec: sec
+  error500_text: You've just discovered an error in our application, we've been notified and will take care of it.

data/app/views/shared/_frontend_notifier.html.haml

@@ -0,0 +1,17 @@
+#frontend_notification
+  .contentWrapper
+    .message
+  .info
+    %span.closingCounter
+      = t("frontend_notifier.closes_in")
+      %span.number 10
+      = t("frontend_notifier.sec")
+    = image_tag "frontend_notifier_close_notification_ico.png", :id => "close_notification_ico"
+
+#frontend_notification_content
+  - if error = flash[:error] || flash[:alert]
+    %span.error= error
+  - elsif success = flash[:success] || flash[:notice]
+    %span.success= success
+
+#frontend_notification_error500= t("frontend_notifier.error500_text")

data/lib/frontend_notifier/application_controller.rb

@@ -0,0 +1,35 @@
+module FrontendNotifierControllerExtension
+  
+  def notify_frontend(message, error_type="error")
+    unless message.kind_of? String || message.nil?
+      if message.errors.empty?  
+        message = "Success"
+        error_type = "success"
+      else
+        message = join_model_errors(message) 
+      end
+    end
+    render :json => { :type => error_type, :message => message  }
+  end
+
+  private
+
+    def join_model_errors(model, options = { include_field_names: true })
+      result = []
+      model.errors.each do |k,v|
+        if k == :base
+          result << v
+        else
+          if options[:include_field_names]
+            result << "#{k} #{v}"
+          else
+            result << v
+          end
+        end
+      end
+      result = result.join("; ")
+      dot_at_the_end = (result =~ /\.\Z/) ? "" : "."
+      result + dot_at_the_end
+    end
+
+end

data/lib/frontend_notifier/frontend_notifier_engine.rb

@@ -0,0 +1,10 @@
+class FrontendNotifier < Rails::Engine
+
+  initializer 'frontend_notifier.controller' do |app|  
+    ActiveSupport.on_load(:action_controller) do  
+      include FrontendNotifierControllerExtension  
+      helper_method :notify_frontend
+    end
+  end 
+
+end

data/lib/frontend_notifier.rb

@@ -0,0 +1,2 @@
+require "frontend_notifier/application_controller"
+require "frontend_notifier/frontend_notifier_engine"

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: frontend_notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Roman Snitko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &20884280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *20884280
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &20883400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *20883400
+- !ruby/object:Gem::Dependency
+  name: rcov
+  requirement: &20881600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *20881600
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &20903460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: *20903460
+description: Shows cute notifications in frontend. No need to manually create your
+  own html/css/js to show Rails's flash[:notice] or other flashes. This handles it
+  nicely + you can customize it.
+email: subscribe@snitko.ru
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.markdown
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.markdown
+- Rakefile
+- Screenshot.png
+- VERSION
+- app/assets/images/frontend_notifier_close_notification_ico.png
+- app/assets/javascripts/lib/_frontend_notifier.js.coffee
+- app/assets/stylesheets/_frontend_notifier.css.scss
+- app/config/locales/en.yml
+- app/views/shared/_frontend_notifier.html.haml
+- lib/frontend_notifier.rb
+- lib/frontend_notifier/application_controller.rb
+- lib/frontend_notifier/frontend_notifier_engine.rb
+homepage: http://github.com/snitko/frontend_notifier
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1967541642647775528
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Rails extension, shows cute notifications in frontend.
+test_files: []