ultimate-flash 0.6.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+pkg/*
+.idea/

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in ultimate-flash.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,16 @@
+PATH
+  remote: .
+  specs:
+    ultimate-flash (0.6.0)
+      ultimate-base (~> 0.2)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ultimate-base (0.2.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ultimate-flash!

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011-2012 Dmitry Karpunin (aka KODer) koderfunk@gmail.com
+
+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.md

@@ -0,0 +1,32 @@
+Ruby on Rails oriented jQuery plugin for smart notifications
+
+**Binding**:
+
+```javascript
+//= require ultimate/flash
+window.flash = $(".l-page__flashes").ultimateFlash({locale: "ru"}, true);
+```
+
+## Licence ##
+
+The MIT License
+
+Copyright (c) 2011-2012 Dmitry Karpunin (aka KODer) koderfunk@gmail.com
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/assets/javascripts/ultimate/flash.js.coffee

@@ -0,0 +1,235 @@
+###*
+ * Ultimate Flash 0.6.0 - Ruby on Rails oriented jQuery plugin based on Ultimate Backbone
+ *
+ * Copyright 2011-2012 Karpunin Dmitry (KODer) / Evrone.com
+ *
+ * Dual licensed under the MIT and GPL licenses:
+ *   http://www.opensource.org/licenses/mit-license.php
+ *   http://www.gnu.org/licenses/gpl.html
+ *
+###
+
+###*
+ * $.fn.ultimateFlash() invoke Ultimate Flash functionality at first call on jQuery object
+ * for the first element in the set of matched elements.
+ * Subsequent calls forwarding on view methods or return view property.
+ * If last argument {Boolean} true, then returns {Flash}.
+ * @usage
+ *   standart actions:
+ *     construction    .ultimateFlash([Object options = {}])                  : {jQuery} jContainer
+ *     updateOptions   .pluginName({Object} options)                          : {Object} view options
+ *     get options     .pluginName("options")                                 : {Object} view options
+ *     show            .ultimateFlash("show", String type, String text)       : {jQuery} jFlash | {Boolean} false
+ *     notice          .ultimateFlash("notice", String text)                  : {jQuery} jFlash | {Boolean} false
+ *     alert           .ultimateFlash("alert", String text)                   : {jQuery} jFlash | {Boolean} false
+ *   extended actions:
+ *     auto            .ultimateFlash("auto", {ArrayOrObject} obj)            : {Array} ajFlashes | {Boolean} false
+ *     ajaxSuccess     .ultimateFlash("ajaxSuccess"[, Arguments successArgs = []])
+ *     ajaxError       .ultimateFlash("ajaxError"[, String text = translations.defaultErrorText][, Arguments errorArgs = []])
+###
+
+# TODO customizable show() and hide()
+# TODO improve English
+# TODO jGrowl features
+
+#= require ultimate/backbone/view
+#= require ultimate/backbone/extra/jquery-plugin-adapter
+
+Ultimate.Backbone.Plugins ||= {}
+
+class Ultimate.Backbone.Plugins.Flash extends Ultimate.Backbone.View
+
+  el: ".l-page__flashes"
+
+  @defaultLocales:
+    en:
+      defaultErrorText: "Error"
+      defaultThrownError: "server connection error"
+      formFieldsError: "Form filled with errors"
+    ru:
+      defaultErrorText: "Ошибка"
+      defaultThrownError: "ошибка соединения с сервером"
+      formFieldsError: "Форма заполнена с ошибками"
+
+  slideTime: 200
+  showTime: 3600
+  showTimePerChar: 30
+  showAjaxErrors: true                  # catch global jQuery.ajaxErrors(), try detect message and show it
+  showAjaxSuccesses: true               # catch global jQuery.ajaxSuccessess(), try detect message and show it
+  detectFormErrors: true                # can be function (parsedJSON)
+  detectPlainTextMaxLength: 200         # if response has plain text and its length fits, show it
+  hideOnClick: true                     # click on notice fire hide()
+  removeOnHide: true                    # remove notice DOM-element on hide
+  forceAddDotsAfterLastWord: false
+  forceRemoveDotsAfterLastWord: false
+  regExpLastWordWithoutDot: /[\wа-яёА-ЯЁ]{3,}$/
+  regExpLastWordWithDot: /([\wа-яёА-ЯЁ]{3,})\.$/
+
+  events:
+    "click   .flash:not(:animated)" : "closeFlashClick"
+
+  initialize: (options) ->
+    super
+    # init flashes come from server in page
+    @jFlashes().each (index, flash) =>
+      jFlash = $(flash)
+      jFlash.html @_prepareText(jFlash.html())
+      @_setTimeout jFlash
+    # binding hook ajaxError handler
+    @$el.ajaxError =>
+      if @showAjaxErrors
+        a = @_ajaxSuccessParseArguments(arguments)
+        Ultimate.Backbone.debug ".Plugins.Flash.ajaxError", a
+        @ajaxError a.data, a.jqXHR
+    # binding hook ajaxSuccess handler
+    @$el.ajaxSuccess =>
+      if @showAjaxSuccesses
+        a = @_ajaxSuccessParseArguments(arguments)
+        Ultimate.Backbone.debug ".Plugins.Flash.ajaxSuccess", a
+        @ajaxSuccess a.data, a.jqXHR
+
+  # delegate event for hide on click
+  closeFlashClick: (event) ->
+    if @hideOnClick
+      @_hide $(event.currentTarget)
+      false
+
+  jFlashes: (filterSelector) ->
+    _jFlashes = @$(".flash")
+    if filterSelector then _jFlashes.filter(filterSelector) else _jFlashes
+
+  _prepareText: (text) ->
+    text = _.clean(text)
+    # Add dot after last word (if word has minimum 3 characters)
+    text += "."  if @forceAddDotsAfterLastWord and @regExpLastWordWithoutDot.test(text)
+    text = text.replace(@regExpLastWordWithDot, "$1")  if @forceRemoveDotsAfterLastWord
+    text
+
+  _hide: (jFlash) ->
+    clearTimeout jFlash.data("timeoutId")
+    jFlash.slideUp @slideTime, =>
+      jFlash.remove()  if @removeOnHide
+
+  _setTimeout: (jFlash, timeout = @showTime + jFlash.text().length * @showTimePerChar) ->
+    if timeout
+      jFlash.data "timeoutId", setTimeout =>
+          jFlash.removeData("timeoutId")
+          @_hide jFlash
+        , timeout
+
+  show: (type, text, timeout = null) ->
+    return false  if not _.isString(text) or _.isBlank(text)
+    jFlash = $("<div class=\"flash #{type}\" style=\"display: none;\">#{@_prepareText(text)}</div>")
+    jFlash.appendTo(@$el).slideDown @slideTime
+    @_setTimeout jFlash, timeout
+    jFlash
+
+  notice: (text, timeout = null) -> @show "notice", text, timeout
+
+  alert:  (text, timeout = null) -> @show "alert",  text, timeout
+
+  auto: (obj) ->
+    if _.isArray(obj)
+      @show(pair[0], pair[1])  for pair in obj
+    else if _.isObject(obj)
+      @show(key, text)  for key, text of obj
+    else false
+
+  ###*
+   * @param  {Arguments} successArgs=[]   аргументы колбэка jQuery.success()
+   * @return {data: data, jqXHR: jqXHR}
+  ###
+  _ajaxSuccessParseArguments: (successArgs) ->
+    # detect event as first element
+    if successArgs[0] instanceof jQuery.Event
+      # convert arguments to Array
+      successArgs = args(successArgs)
+      # remove event
+      successArgs.shift()
+    # arrange arguments
+    if _.isString(successArgs[0])
+      # from jQuery.ajax().success()
+      [data, _textStatus, jqXHR] = successArgs
+    else
+      # from jQuery.ajaxSuccess() or jQuery.ajaxError()
+      [jqXHR, _ajaxSettings, data] = successArgs
+    data: data
+    jqXHR: jqXHR
+
+  ###*
+   * @param  {String|Object} data       some data from ajax response
+   * @param  {jqXHR} jqXHR              jQuery XHR
+   * @return {Boolean}                  статус выполнения показа сообщения
+  ###
+  # MAYBE jqXHR set default as jQuery.hxr or similar
+  ajaxSuccess: (data, jqXHR) ->
+    # prevent recall
+    return false  if jqXHR.breakFlash
+    jqXHR.breakFlash = true
+    # detect notice
+    if _.isString(data)
+      # catch plain text message
+      data = _.trim(data)
+      return @notice(data)  if data.length <= @detectPlainTextMaxLength and not $.isHTML(data)
+    else if _.isObject(data)
+      # catch json data with flash-notice
+      return @auto(data["flash"])  if data["flash"]
+    false
+
+  ###*
+   * @param  {String}    [text="Ошибка"]   вступительный (либо полный) текст формируемой ошибки
+   * @param  {String}     thrownError      some error from ajax response
+   * @param  {jqXHR}      jqXHR            jQuery XHR
+   * @return {Boolean}                     статус выполнения показа сообщения
+  ###
+  ajaxError: (text, thrownError, jqXHR) ->
+    unless _.isObject(jqXHR)
+      jqXHR = thrownError
+      thrownError = text
+      text = @translations.defaultErrorText
+    # prevent undefined responses
+    return false  if jqXHR.status < 100
+    # prevent recall
+    return false  if jqXHR.breakFlash
+    jqXHR.breakFlash = true
+    if jqXHR.responseText
+      try
+        # try parse respose as json
+        if parsedJSON = $.parseJSON(jqXHR.responseText)
+          # catch "flash" object and call auto() method with autodetecting flash-notice type
+          return @auto(parsedJSON["flash"])  if parsedJSON["flash"]
+          # catch "error" object and call alert() method
+          return @alert(parsedJSON["error"])  if parsedJSON["error"]
+          # may be parsedJSON is form errors
+          if @detectFormErrors is true
+            # show message about form with errors
+            return @alert(@translations.formFieldsError)
+          else if _.isFunction(@detectFormErrors)
+            # using showFormError as callback
+            return @detectFormErrors.apply(@, [parsedJSON])
+          else
+            # nothing
+            return false
+      catch e
+        # nop
+    if jqXHR.status >= 400 and jqXHR.responseText
+      # try detect Rails raise message
+      if raiseMatches = jqXHR.responseText.match(/<\/h1>\n<pre>(.+?)<\/pre>/)
+        Ultimate.Backbone.debug "replace thrownError = \"#{thrownError}\" with raiseMatches[1] = \"#{raiseMatches[1]}\""
+        thrownError = raiseMatches[1]
+      else
+        # try detect short text message as error
+        if jqXHR.responseText.length <= @detectPlainTextMaxLength
+          Ultimate.Backbone.debug "replace thrownError = \"#{thrownError}\" with jqXHR.responseText = \"#{jqXHR.responseText}\""
+          thrownError = jqXHR.responseText
+    else
+      if _.isString(thrownError) and not _.isBlank(thrownError)
+        Ultimate.Backbone.debug "replace thrownError = \"#{thrownError}\" with @translations.defaultThrownError = \"#{@translations.defaultThrownError}\""
+        thrownError = @translations.defaultThrownError
+    text += ": "  if text
+    text += "#{thrownError} [#{jqXHR.status}]"
+    return @alert(text)
+
+
+
+Ultimate.Backbone.createJQueryPlugin "ultimateFlash", Ultimate.Backbone.Plugins.Flash

data/app/assets/stylesheets/ultimate/flash.scss

@@ -0,0 +1,54 @@
+@mixin ultimate-flash(
+  $notice-background:     #393,
+  $notice-border-color:   #6c6,
+  $alert-background:      #c33,
+  $alert-border-color:    #e66,
+  $default-background:    #06c,
+  $default-border-color:  #39e,
+  $text-color:            #fff,
+  $opacity:               1,
+  $background-alpha:      1
+){
+  position:   fixed;
+  width:      100%;
+  left:       0;
+  z-index:    9999;
+  text-align: center;
+// >>> recomendations:
+// @include invert_link_decoration();
+// white-space: nowrap;
+
+  > .flash {
+    @if $background-alpha < 1 {
+      $notice-background:   rgba($notice-background,  $background-alpha);
+      $alert-background:    rgba($alert-background,   $background-alpha);
+      $default-background:  rgba($default-background, $background-alpha);
+    }
+    padding:       10px;
+    top:           0;
+    width:         100%;
+    font-size:     24px;
+    line-height:   30px;
+    color:         $text-color;
+    @include pie-bg($default-background);
+    border-bottom: 2px solid $default-border-color;
+    @if $opacity < 1 {
+      @include opacity($opacity);
+    }
+    // >>> recomendations:
+    // @include text-shadow_hard(#000 0 1px 0);
+    z-index:       9999;
+    a {
+      color: $text-color;
+    }
+    &.notice {
+      @include pie-bg($notice-background);
+      border-color: $notice-border-color;
+    }
+    &.alert {
+      @include pie-bg($alert-background);
+      border-color: $alert-border-color;
+    }
+  }
+
+}

data/app/views/application/_flashes.html.haml

@@ -0,0 +1,3 @@
+%section.l-page__flashes
+  - flash.each do |key, text|
+    .flash{class: key}= text

data/lib/ultimate-flash.rb

@@ -0,0 +1,8 @@
+require "ultimate-flash/version"
+require "ultimate-flash/engine"
+
+module Ultimate
+  module Flash
+
+  end
+end

data/lib/ultimate-flash/engine.rb

@@ -0,0 +1,6 @@
+module Ultimate
+  module Flash
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/ultimate-flash/version.rb

@@ -0,0 +1,5 @@
+module Ultimate
+  module Flash
+    VERSION = "0.6.0"
+  end
+end

data/ultimate-flash.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ultimate-flash/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ultimate-flash"
+  s.version     = Ultimate::Flash::VERSION
+  s.authors     = ["Dmitry KODer Karpunin"]
+  s.email       = ["koderfunk@gmail.com"]
+  s.homepage    = "http://github.com/KODerFunk/ultimate-flash"
+  s.summary     = %q{Ruby on Rails oriented jQuery plugin for smart notifications}
+  s.description = %q{Ruby on Rails oriented jQuery plugin for smart notifications}
+
+  s.rubyforge_project = "ultimate-flash"
+
+  s.add_dependency "ultimate-base", "~> 0.2"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: ultimate-flash
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+  prerelease: 
+platform: ruby
+authors:
+- Dmitry KODer Karpunin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ultimate-base
+  requirement: &17170900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: *17170900
+description: Ruby on Rails oriented jQuery plugin for smart notifications
+email:
+- koderfunk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/ultimate/flash.js.coffee
+- app/assets/stylesheets/ultimate/flash.scss
+- app/views/application/_flashes.html.haml
+- lib/ultimate-flash.rb
+- lib/ultimate-flash/engine.rb
+- lib/ultimate-flash/version.rb
+- ultimate-flash.gemspec
+homepage: http://github.com/KODerFunk/ultimate-flash
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: ultimate-flash
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby on Rails oriented jQuery plugin for smart notifications
+test_files: []