flasherella 0.2.alpha → 0.3.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cd7d44727aa4675c2721f0c237e4f501496301e
-  data.tar.gz: eccad46199451f156d4dc16e425a69fe86990b29
+  metadata.gz: 38e36dfddb4a9f6b3e073300b0628ccfd1b24f28
+  data.tar.gz: d12250d49d356295a033ac28e9e48c3dabb018fc
 SHA512:
-  metadata.gz: 5dba0d1a5cef0ccbbe1ea80d84edec35282731cbe866f76d08906d5c18fd460ab0cf4f98580670e66be90ec4638df92fd5560cb251e284e1c113734faaaefdd8
-  data.tar.gz: 007734e23aa9e402ac8dc7c43ed8882b586801e6f24c68780f108280df59e3ee5d2b5695afe9dfd04f5611229caf237f24d08f10a9ceffc8c1be3b25c127437a
+  metadata.gz: 2695edf4e2637397b3f7a122a6c2d4b4d018935888642954be163241c78e6c90bc4f9fb964c2fc4eefa7ccc0ca1071fb69f822e7d29ffe77ac3670c34344b2ed
+  data.tar.gz: 235f1a3f6323b3f575cf14411239ebe11543d8032f8c564e9e48b700c57e0964028780afeb8727918c509c08b3994c5d7af34983c72ea786befc37287ed492ff

data/.gitignore

@@ -4,7 +4,7 @@
 /_yardoc/
 /coverage/
 /doc/
-/pkg/
+/pkg/*
 /spec/reports/
 /tmp/
 *.bundle
@@ -12,3 +12,4 @@
 *.o
 *.a
 mkmf.log
+.DS_Store

data/README.md

@@ -2,6 +2,8 @@
 
 Automatically display flash messages when an XHR request is made. No more having to manually insert them into the DOM.
 
+This has been extracted from numerous projects.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,4 +22,29 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In your application.js file, 
+
+```
+//= require flasherella
+```
+
+And somewhere in your application.html.erb layout,
+
+```
+<div id="flashes"></div>
+```
+
+## Options 
+
+```
+Flasherella.config do |config|
+    config.flash_container_element = '#flashes' # or where your flashes are contained.
+    config.flash_keys = [:success, :notice, :error, :warning] # valid keys for flashing - this can also be a 
+                                                                hash of valid flash keys, and their CSS class names.
+    config.flash_key_prefix = 'alert-' # prefixes the names of the CSS classes for each flash key. 
+    config.flash_html = '<div class="flash alert {{klass}} ">{{msg}}<button type="button" class="close" 
+                         data-dismiss="alert"><span aria-hidden="true">&times;</span>
+                         <span class="sr-only">Close</span></button></div>' 
+                         # can be anything. just make sure you have {{klass}} and {{msg}} somewhere for everything to render properly.
+end
+```

data/app/assets/javascripts/flasherella.js.erb

@@ -0,0 +1,14 @@
+$(document).ajaxComplete(function(event, request) {
+    var alert_class, klass, msg;
+    msg = request.getResponseHeader("X-Flash-Message");
+    alert_class = request.getResponseHeader("X-Flash-Type");
+    flash_classes = <%=Flasherella.flash_classes.to_json%>;
+    klass = flash_classes[alert_class];
+    if (msg) {
+        var flashes_el = $("<%=Flasherella.config.flash_container_element%>");
+        var flash_html = '<%= Flasherella.config.flash_html%>';
+        var html = flash_html.replace("{{klass}}", klass).replace("{{msg}}", msg);
+        flashes_el.html(html);
+    }
+});
+

data/lib/flasherella.rb

@@ -1,3 +1,4 @@
+require "flasherella/config"
 require "flasherella/version"
 require 'flasherella/engine'
 require "flasherella/application_controller"

data/lib/flasherella/application_controller.rb

@@ -1,4 +1,22 @@
 module Flasherella
+  
+  def self.config
+    @@config ||= Flasherella::Config.instance
+    yield @@config if block_given?
+    @@config
+  end
+
+  def self.flash_classes 
+    keys = Flasherella.config.flash_keys
+    if keys.is_a?(Hash)
+      return keys 
+    end 
+
+    classes = []; keys.each { |key| classes << "#{Flasherella.config.flash_key_prefix}#{key}"}
+    hash = keys.zip(classes)
+    Hash[hash]
+  end 
+
   module ApplicationController
 
     def self.included(base)
@@ -14,20 +32,19 @@ module Flasherella
     end
 
     def flash_message
-      [:error, :warning, :notice, :success].each do |type|
+      Flasherella.config.flash_keys.each do |type|
         return flash[type] unless flash[type].blank?
       end
       ''
     end
 
     def flash_type
-      [:error, :warning, :notice, :success].each do |type|
+      Flasherella.config.flash_keys.each do |type|
         return type unless flash[type].blank?
       end
       :empty
     end
 
-  end
-
-
-end
+  end 
+  
+end

data/lib/flasherella/config.rb

@@ -0,0 +1,15 @@
+require 'singleton'
+
+module Flasherella
+  class Config
+    include Singleton
+    attr_accessor :flash_container_element, :flash_keys, :flash_html, :flash_key_prefix
+
+    def initialize(&block)
+      @flash_container_element         = '#flashes'
+      @flash_keys                      = [:success, :notice, :error, :warning]
+      @flash_key_prefix                = 'alert-'
+      @flash_html                      = '<div class="flash alert {{klass}} ">{{msg}}<button type="button" class="close" data-dismiss="alert"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button></div>';
+    end
+  end
+end

data/lib/flasherella/version.rb

@@ -1,3 +1,3 @@
 module Flasherella
-  VERSION = "0.2.alpha"
+  VERSION = "0.3.alpha"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flasherella
 version: !ruby/object:Gem::Version
-  version: 0.2.alpha
+  version: 0.3.alpha
 platform: ruby
 authors:
 - Josh Brody
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-25 00:00:00.000000000 Z
+date: 2015-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,14 +50,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/assets/javascripts/flasherella.coffee
-- flasherella-0.1.alpha.gem
+- app/assets/javascripts/flasherella.js.erb
 - flasherella.gemspec
 - gem-public_cert.pem
-- lib/.DS_Store
 - lib/flasherella.rb
-- lib/flasherella/.DS_Store
 - lib/flasherella/application_controller.rb
+- lib/flasherella/config.rb
 - lib/flasherella/engine.rb
 - lib/flasherella/version.rb
 homepage: ''

data/app/assets/javascripts/flasherella.coffee

@@ -1,5 +0,0 @@
-$(document).ajaxComplete (event, request) ->
-  msg = request.getResponseHeader("X-Flash-Message")
-  alert_class = request.getResponseHeader("X-Flash-Type")
-  klass = { success: "alert-success", error: "alert-danger", alert: "alert-warning", notice: "alert-info" }[alert_class]
-  $("#flashes").html('<div class="flash alert ' + klass + ' ">' + msg + '<button type="button" class="close" data-dismiss="alert"><span aria-hidden="true">&times;</span><span class="sr-only">Close</span></button></div>') if msg