ultimate-flash 0.6.1.1 → 0.7.1

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    ultimate-flash (0.6.1.1)
-      ultimate-base (~> 0.3.1)
+    ultimate-flash (0.7.1)
+      ultimate-base (~> 0.3.3)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    ultimate-base (0.3.1.1)
+    ultimate-base (0.3.3)
 
 PLATFORMS
   ruby

data/README.md

@@ -7,6 +7,16 @@ Ruby on Rails oriented jQuery plugin for smart notifications
 window.flash = $(".l-page__flashes").ultimateFlash({locale: "ru"}, true);
 ```
 
+**Usage**:
+
+```javascript
+$(".l-page__flashes").ultimateFlash('notice', 'Hello.');
+```
+or
+```javascript
+flash.notice('Hello.');
+```
+
 ## Licence ##
 
 The MIT License

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

@@ -1,11 +1,7 @@
 ###*
- * Ultimate Flash 0.6.1 - Ruby on Rails oriented jQuery plugin
- *
+ * Ultimate Flash 0.7.1 - Ruby on Rails oriented jQuery plugin for smart notifications
  * 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
+ * Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
  *
 ###
 
@@ -18,17 +14,16 @@
  *   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
+ *     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 = []])
+ *     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
 
@@ -39,25 +34,28 @@ Ultimate.Plugins ||= {}
 
 class Ultimate.Plugins.Flash extends Ultimate.Plugin
 
-  el: ".l-page__flashes"
+  el: '.l-page__flashes'
 
-  @defaultLocales:
+  @defaultLocales =
     en:
-      defaultErrorText: "Error"
-      defaultThrownError: "server connection error"
-      formFieldsError: "Form filled with errors"
+      defaultErrorText: 'Error'
+      defaultThrownError: 'server connection error'
+      formFieldsError: 'Form filled with errors'
     ru:
-      defaultErrorText: "Ошибка"
-      defaultThrownError: "ошибка соединения с сервером"
-      formFieldsError: "Форма заполнена с ошибками"
+      defaultErrorText: 'Ошибка'
+      defaultThrownError: 'ошибка соединения с сервером'
+      formFieldsError: 'Форма заполнена с ошибками'
 
-  slideTime: 200
-  showTime: 3600
-  showTimePerChar: 30
+  flashClass: 'flash'                   # css-class of message container
   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
+  productionMode: true
+
+  slideTime: 200                        # show and hide animate duration
+  showTime: 3600                        # base time for show flash message
+  showTimePerChar: 30                   # show time per char of flash message
   hideOnClick: true                     # click on notice fire hide()
   removeOnHide: true                    # remove notice DOM-element on hide
   forceAddDotsAfterLastWord: false
@@ -65,94 +63,103 @@ class Ultimate.Plugins.Flash extends Ultimate.Plugin
   regExpLastWordWithoutDot: /[\wа-яёА-ЯЁ]{3,}$/
   regExpLastWordWithDot: /([\wа-яёА-ЯЁ]{3,})\.$/
 
-  events:
-    "click   .flash:not(:animated)" : "closeFlashClick"
+  events: ->
+    _events = {}
+    _events["click   .#{@flashClass}:not(:animated)"] = 'closeFlashClick'
+    _events
 
   initialize: (options) ->
-    super
     # init flashes come from server in page
     @jFlashes().each (index, flash) =>
       jFlash = $(flash)
-      jFlash.html @_prepareText(jFlash.html())
+      jFlash.html @_prepareText(jFlash.html(), jFlash)
       @_setTimeout jFlash
     # binding hook ajaxError handler
     @$el.ajaxError =>
       if @showAjaxErrors
-        a = @_ajaxSuccessParseArguments(arguments)
-        Ultimate.debug(".Plugins.Flash.ajaxError", a)  if _.isFunction(Ultimate.debug)
+        a = @_ajaxParseArguments(arguments)
         @ajaxError a.data, a.jqXHR
     # binding hook ajaxSuccess handler
     @$el.ajaxSuccess =>
       if @showAjaxSuccesses
-        a = @_ajaxSuccessParseArguments(arguments)
-        Ultimate.debug(".Plugins.Flash.ajaxSuccess", a)  if _.isFunction(Ultimate.debug)
+        a = @_ajaxParseArguments(arguments)
         @ajaxSuccess a.data, a.jqXHR
 
   # delegate event for hide on click
   closeFlashClick: (event) ->
-    if @hideOnClick
-      @_hide $(event.currentTarget)
+    jFlash = $(event.currentTarget)
+    if @_getOptionOverFlash('hideOnClick', jFlash)
+      @hide jFlash
       false
 
   jFlashes: (filterSelector) ->
-    _jFlashes = @$(".flash")
+    _jFlashes = @$(".#{@flashClass}")
     if filterSelector then _jFlashes.filter(filterSelector) else _jFlashes
 
-  _prepareText: (text) ->
-    text = _.clean(text)
+  _getOptionOverFlash: (optionName, jFlashOrOptions = {}) ->
+    option = if jFlashOrOptions instanceof jQuery then jFlashOrOptions.data(optionName) else jFlashOrOptions[optionName]
+    option ? @[optionName]
+
+  _prepareText: (text, jFlashOrOptions) ->
+    text = _.string.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
+    if @_getOptionOverFlash('forceAddDotsAfterLastWord', jFlashOrOptions) and @_getOptionOverFlash('regExpLastWordWithoutDot', jFlashOrOptions).test(text)
+      text += '.'
+    # Remove dot after last word (if word has minimum 3 characters)
+    if @_getOptionOverFlash('forceRemoveDotsAfterLastWord', jFlashOrOptions)
+      text = text.replace(@_getOptionOverFlash('regExpLastWordWithDot', jFlashOrOptions), '$1')
     text
 
-  _hide: (jFlash) ->
-    clearTimeout jFlash.data("timeoutId")
-    jFlash.slideUp @slideTime, =>
-      jFlash.remove()  if @removeOnHide
-
-  _setTimeout: (jFlash, timeout = @showTime + jFlash.text().length * @showTimePerChar) ->
+  _setTimeout: (jFlash, timeout) ->
+    timeout ?= @_getOptionOverFlash('showTime', jFlash) + jFlash.text().length * @_getOptionOverFlash('showTimePerChar', jFlash)
     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
+      jFlash.data 'timeoutId', setTimeout =>
+        jFlash.removeData 'timeoutId'
+        @hide jFlash
+      , timeout
+
+  hide: (jFlashes = @jFlashes()) ->
+    jFlashes.each (index, element) =>
+      jFlash = $(element)
+      clearTimeout jFlash.data('timeoutId')
+      jFlash.slideUp @_getOptionOverFlash('slideTime', jFlash), =>
+        jFlash.remove()  if @_getOptionOverFlash('removeOnHide', jFlash)
+
+  show: (type, text, timeout = null, perFlashOptions = null) ->
+    text = @_prepareText(text, perFlashOptions)
+    return false  if not _.isString(text) or _.string.isBlank(text)
+    jFlash = $("<div class=\"#{@flashClass} #{type}\" style=\"display: none;\">#{text}</div>")
+    jFlash.appendTo(@$el).slideDown @_getOptionOverFlash('slideTime', perFlashOptions)
+    if perFlashOptions
+      jFlash.data(key, value)  for key, value of perFlashOptions
     @_setTimeout jFlash, timeout
     jFlash
 
-  notice: (text, timeout = null) -> @show "notice", text, timeout
+  notice: (text, timeout = null, perFlashOptions = null) -> @show 'notice', arguments...
 
-  alert:  (text, timeout = null) -> @show "alert",  text, timeout
+  alert:  (text, timeout = null, perFlashOptions = null) -> @show 'alert',  arguments...
 
   auto: (obj) ->
     if _.isArray(obj)
       @show(pair[0], pair[1])  for pair in obj
-    else if _.isObject(obj)
+    else if $.isPlainObject(obj)
       @show(key, text)  for key, text of obj
     else false
 
-  ###*
-   * @param  {Arguments} successArgs=[]   аргументы колбэка jQuery.success()
-   * @return {data: data, jqXHR: jqXHR}
-  ###
-  _ajaxSuccessParseArguments: (successArgs) ->
+  _ajaxParseArguments: (args) ->
     # detect event as first element
-    if successArgs[0] instanceof jQuery.Event
+    if args[0] instanceof jQuery.Event
       # convert arguments to Array
-      successArgs = _.toArray(successArgs)
+      args = _.toArray(args)
       # remove event
-      successArgs.shift()
+      args.shift()
     # arrange arguments
-    if _.isString(successArgs[0])
+    if _.isString(args[0])
       # from jQuery.ajax().success()
-      [data, _textStatus, jqXHR] = successArgs
+      [data, _textStatus, jqXHR] = args
     else
       # from jQuery.ajaxSuccess() or jQuery.ajaxError()
-      [jqXHR, _ajaxSettings, data] = successArgs
+      [jqXHR, _ajaxSettings, data] = args
     data: data
     jqXHR: jqXHR
 
@@ -169,15 +176,15 @@ class Ultimate.Plugins.Flash extends Ultimate.Plugin
     # detect notice
     if _.isString(data)
       # catch plain text message
-      data = _.trim(data)
+      data = _.string.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"]
+      return @auto(data['flash'])  if data['flash']
     false
 
   ###*
-   * @param  {String}    [text="Ошибка"]   вступительный (либо полный) текст формируемой ошибки
+   * @param  {String}    [text='Ошибка']   вступительный (либо полный) текст формируемой ошибки
    * @param  {String}     thrownError      some error from ajax response
    * @param  {jqXHR}      jqXHR            jQuery XHR
    * @return {Boolean}                     статус выполнения показа сообщения
@@ -186,9 +193,9 @@ class Ultimate.Plugins.Flash extends Ultimate.Plugin
     unless _.isObject(jqXHR)
       jqXHR = thrownError
       thrownError = text
-      text = @translations.defaultErrorText
+      text = @t('defaultErrorText')
     # prevent undefined responses
-    return false  if jqXHR.status < 100
+    #return false  if jqXHR.status < 100
     # prevent recall
     return false  if jqXHR.breakFlash
     jqXHR.breakFlash = true
@@ -196,14 +203,14 @@ class Ultimate.Plugins.Flash extends Ultimate.Plugin
       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"]
+          # 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)
+            return @alert(@t('formFieldsError'))
           else if _.isFunction(@detectFormErrors)
             # using showFormError as callback
             return @detectFormErrors.apply(@, [parsedJSON])
@@ -212,24 +219,23 @@ class Ultimate.Plugins.Flash extends Ultimate.Plugin
             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.debug("replace thrownError = \"#{thrownError}\" with raiseMatches[1] = \"#{raiseMatches[1]}\"")  if _.isFunction(Ultimate.debug)
-        thrownError = raiseMatches[1]
-      else
-        # try detect short text message as error
-        if jqXHR.responseText.length <= @detectPlainTextMaxLength
-          Ultimate.debug("replace thrownError = \"#{thrownError}\" with jqXHR.responseText = \"#{jqXHR.responseText}\"")  if _.isFunction(Ultimate.debug)
-          thrownError = jqXHR.responseText
+    if @productionMode
+      thrownError = @t('defaultThrownError')
     else
-      if _.isString(thrownError) and not _.isBlank(thrownError)
-        Ultimate.debug("replace thrownError = \"#{thrownError}\" with @translations.defaultThrownError = \"#{@translations.defaultThrownError}\"")  if _.isFunction(Ultimate.debug)
-        thrownError = @translations.defaultThrownError
-    text += ": "  if text
+      if jqXHR.status >= 400 and jqXHR.responseText
+        # try detect Rails raise message
+        if raiseMatches = jqXHR.responseText.match(/<\/h1>\n<pre>(.+?)<\/pre>/)
+          thrownError = raiseMatches[1]
+        else
+          # try detect short text message as error
+          if not _.string.isBlank(jqXHR.responseText) and jqXHR.responseText.length <= @detectPlainTextMaxLength
+            thrownError = jqXHR.responseText
+      else if _.string.isBlank(thrownError)
+        thrownError = @t('defaultThrownError')
+    text += ': '  if text
     text += "#{thrownError} [#{jqXHR.status}]"
-    return @alert(text)
+    @alert(text)
 
 
 
-Ultimate.createJQueryPlugin "ultimateFlash", Ultimate.Plugins.Flash
+Ultimate.createJQueryPlugin 'ultimateFlash', Ultimate.Plugins.Flash

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

@@ -40,6 +40,7 @@
     font-size:     24px;
     line-height:   30px;
     color:         $text-color;
+    @include box-sizing;
     @include pie-bg($default-background);
     border-bottom: 2px solid $default-border-color;
     @if $opacity < 1 {

data/lib/ultimate-flash/version.rb

@@ -1,5 +1,5 @@
 module Ultimate
   module Flash
-    VERSION = "0.6.1.1"
+    VERSION = "0.7.1"
   end
 end

data/ultimate-flash.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "ultimate-flash"
 
-  s.add_dependency "ultimate-base", "~> 0.3.1"
+  s.add_dependency "ultimate-base", "~> 0.3.3"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultimate-flash
 version: !ruby/object:Gem::Version
-  version: 0.6.1.1
+  version: 0.7.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-28 00:00:00.000000000 Z
+date: 2012-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ultimate-base
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.3.1
+        version: 0.3.3
 description: Ruby on Rails oriented jQuery plugin for smart notifications
 email:
 - koderfunk@gmail.com