flash-messenger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f151f635a1072befe5078584b3277fe78b99925
+  data.tar.gz: cf2bcef1886493130b6953aa7d3300db5dfabfbe
+SHA512:
+  metadata.gz: 1b206d177a2242d519b798eeeb13bc3c02393a79c09961acac791732e2d738137a8ac657aa376319113337be1120002a4c1edf06be2fccc7b4833d57d35b3efb
+  data.tar.gz: 6a197f1a085aa6023f97a4a3c1940868638a68073ae8ea2ad404e68ddcac0ab3e6a91070b4b73d04128fb64ca32041552e30c9b11261537d75d971e0d13646f8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6
+branches:
+  only:
+    - master
+env:
+  - COVERALLS=1

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# v0.1.0 / 2016-04-14
+
+Create project

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flash-messenger-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Chen, Yi-Cyuan
+
+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,87 @@
+# flash-messenger-rails
+
+[![Build Status](https://api.travis-ci.org/emn178/flash-messenger-rails.png)](https://travis-ci.org/emn178/flash-messenger-rails)
+[![Coverage Status](https://coveralls.io/repos/emn178/flash-messenger-rails/badge.svg?branch=master)](https://coveralls.io/r/emn178/flash-messenger-rails?branch=master)
+
+Integrate with [flash-messenger](https://github.com/emn178/flash-messenger) to provide a simple flash messages. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flash-messenger'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flash-messenger
+
+## Usage
+
+### Require Javascript
+Add the following to /app/assets/javascripts/application.js:
+```JavaScript
+//= require flash-messenger
+```
+
+### Require CSS
+Add the following to /app/assets/stylesheets/application.css:
+```
+ *= require flash-messenger
+```
+
+### Render
+Add the following to view:
+```
+<%= show_flash %>
+```
+It will render flash messages if you assign some thing to `flash`.
+```ruby
+redirect_to root_path, :flash => {:error => 'Error!'}
+# or
+flash[:error] = 'Error!'
+redirect_to root_path
+```
+
+### Helpers
+In controller, you can use helper methods to output flash messages:
+```ruby
+flash_message('Successful!')
+flash_message('Error!', :type => :error)
+flash_notice('Notice!')
+flash_alert('Alert!', :sticky => true)
+flash_error('Error!')
+```
+You can also use it to show model errors:
+```ruby
+flash_model_error(@model)
+```
+
+### Bootstrap
+If you want to use bootstrap style, add the following to js file:
+```JavaScript
+//= require flash-messenger-bootstrap
+```
+Add the following to css file:
+```
+ *= require flash-messenger-bootstrap
+```
+
+### Turboboost
+If you want turboboost to show errors, add the following to js file:
+```JavaScript
+//= require flash-messenger-turboboost
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Contact
+The project's website is located at https://github.com/emn178/flash-messenger-rails  
+Author: Chen, Yi-Cyuan (emn178@gmail.com)

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/javascripts/flash-messenger-bootstrap.js

@@ -0,0 +1,15 @@
+//= require flash-messenger/flash-messenger
+(function ($) {
+  'use strict';
+
+  var typeMap = {
+    error: 'danger',
+    notice: 'info',
+    alert: 'warning'
+  };
+  flash.setting.message = '<div class="alert alert-{type}">{message}<i class="glyphicon glyphicon-remove"></i></div>';
+  flash.setting.closeHandler = '.glyphicon-remove';
+  flash.setting.convert = function (options) {
+    options.type = typeMap[options.type] || options.type;
+  };
+})(jQuery);

data/app/assets/javascripts/flash-messenger-turboboost.js

@@ -0,0 +1,18 @@
+//= require flash-messenger/flash-messenger
+(function ($) {
+  'use strict';
+
+  $(document).on('turboboost:error', function (e, errors) {
+    try {
+      errors = JSON.parse(errors);
+      if ($.isArray(errors)) {
+        errors.forEach(function (error) {
+          flash.error(error);
+        });
+      } else if (typeof errors == 'object') {
+        flash.modelError(errors);
+      }
+    } catch (e) {
+    }
+  });
+})(jQuery);

data/app/assets/javascripts/flash-messenger.js

@@ -0,0 +1,29 @@
+//= require flash-messenger/flash-messenger
+(function ($) {
+  'use strict';
+
+  window.flash.show = function (jobs) {
+    var show = function () {
+      jobs.forEach(function (job) {
+        var message = job[0];
+        var options = job[1];
+        var method = job[2];
+        method = method && flash[method] ? flash[method] : flash;
+        method(message, options);
+      });
+      $(document).off('ready page:load', show);
+    };
+    $(document).on('ready page:load', show);
+  };
+
+  window.flash.modelError = function (errors, options) {
+    options = options || {};
+    options.type = 'error';
+    for (var key in errors) {
+      var messages = errors[key];
+      messages.forEach(function (message) {
+        flash(key + ' ' + message, options);
+      });
+    }
+  };
+})(jQuery);

data/app/assets/javascripts/flash-messenger/flash-messenger.js

@@ -0,0 +1,98 @@
+/*!
+ * [flash-messenger]{@link https://github.com/emn178/flash-messenger}
+ *
+ * @version 0.1.0
+ * @author Chen, Yi-Cyuan [emn178@gmail.com]
+ * @copyright Chen, Yi-Cyuan 2016
+ * @license MIT
+ */
+(function ($) {
+  'use strict';
+
+  var OPTIONS = ['type', 'time', 'sticky', 'fadeOut', 'closable'];
+  var TYPES = ['error', 'danger', 'info', 'notice', 'success', 'warning', 'alert'];
+
+  var setting = {
+    appendTo: 'body',
+    container: '<div class="flash-messages"></div>',
+    message: '<div class="flash-message {type}">{message}<span class="flash-message-close">&#10006</span></div>',
+    closeHandler: '.flash-message-close',
+    default: {
+      type: 'success',
+      time: 3000,
+      sticky: false,
+      fadeOut: 1000,
+      closable: true
+    },
+    typesDefault: {
+      error: {
+        sticky: true
+      },
+      danger: {
+        sticky: true
+      }
+    }
+  };
+
+  var container, encorder = $('<div/>');
+  function htmlEncode (message) {
+    return encorder.text(message).html();
+  }
+
+  function formatOptions(options) {
+    var typesDefault = setting.typesDefault[options.type];
+    if (typesDefault) {
+      $.extend(options, $.extend({}, typesDefault, options));
+    }
+    OPTIONS.forEach(function (key) {
+      var value = options[key];
+      options[key] = value === undefined ? setting.default[key] : value;
+    });
+    if (setting.convert) {
+      setting.convert(options);
+    }
+  }
+
+  function show(message, options) {
+    options = options || {};
+    formatOptions(options);
+    var div = $(setting.message.replace('{message}', htmlEncode(message)).replace('{type}', options.type)).appendTo(container);
+    var close = function () {
+      div.remove();
+    };
+    if (!options.sticky) {
+      div.delay(options.time).fadeOut(options.fadeOut, close);
+    }
+    if (options.closable) {
+      div.find(setting.closeHandler).addBack(setting.closeHandler).bind('click', close);
+    } else {
+      div.addClass('nonclosable');
+    }
+  } 
+
+  var flash = function () {
+    setting.method.apply(this, arguments);
+  };
+  flash.setting = setting;
+  flash.formatOptions = formatOptions;
+  setting.method = flash.defaultMethod = show;
+  window.flash = flash;
+
+  TYPES.forEach(function (type) {
+    flash[type] = function (message, options) {
+      options = options || {};
+      options.type = type;
+      flash(message, options);
+    }
+  });
+
+  $(document).on('ready page:load', function () {
+    if (!container) {
+      container = $(setting.container);
+    }
+    $(setting.appendTo).append(container);
+    if (setting.window) {
+      window.flash = setting.window.flash;
+    }
+  });
+})(jQuery);

data/app/assets/stylesheets/flash-messenger-bootstrap.css

@@ -0,0 +1,8 @@
+.glyphicon-remove {
+  float: right;
+  cursor: pointer;
+}
+
+.nonclosable .glyphicon-remove {
+  display: none;
+}

data/app/assets/stylesheets/flash-messenger.css

@@ -0,0 +1,48 @@
+/*!
+ * [flash-messenger]{@link https://github.com/emn178/flash-messenger}
+ *
+ * @version 0.1.0
+ * @author Chen, Yi-Cyuan [emn178@gmail.com]
+ * @copyright Chen, Yi-Cyuan 2016
+ * @license MIT
+ */
+.flash-messages {
+  position: absolute;
+  z-index: 10000;
+  left: 20px;
+  right: 20px;
+  top: 70px;
+}
+
+.flash-message {
+  position: relative;
+  padding: 15px 20px;
+  margin-top: 10px;
+  color: #fff;
+  border-radius: 5px;
+}
+
+.flash-message.nonclosable .flash-message-close {
+  display: none;
+}
+
+.flash-message-close {
+  float: right;
+  cursor: pointer;
+}
+
+.flash-message.success {
+  background-color: #8cc040;
+}
+
+.flash-message.notice, .flash-message.info {
+  background-color: #77C3E8;
+}
+
+.flash-message.error, .flash-message.danger {
+  background-color: #dd5749;
+}
+
+.flash-message.warning, .flash-message.alert {
+  background-color: #FF9800;
+}

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flash/messenger/rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flash-messenger.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flash-messenger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flash-messenger"
+  spec.version       = FlashMessenger::VERSION
+  spec.authors       = ["Chen, Yi-Cyuan"]
+  spec.email         = ["emn178@gmail.com"]
+
+  spec.summary       = %q{Integrate with flash-messenger to provide a simple flash messages.}
+  spec.description   = %q{Integrate with flash-messenger to provide a simple flash messages.}
+  spec.homepage      = "https://github.com/emn178/flash-messenger-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "request_store"
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "actionview"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+end

data/lib/flash-messenger.rb

@@ -0,0 +1,9 @@
+require "request_store"
+require "flash-messenger/version"
+require "flash-messenger/helper"
+require "flash-messenger/view_helper"
+require "flash-messenger/controller_helper"
+require "flash-messenger/engine"
+
+module FlashMessenger
+end

data/lib/flash-messenger/controller_helper.rb

@@ -0,0 +1,26 @@
+module FlashMessenger
+  module ControllerHelper
+    include FlashMessenger::Helper
+
+    def flash_message(message, options = nil)
+      push_flash(message, options)
+    end
+
+    def flash_notice(message, options = nil)
+      push_flash(message, options, 'notice')
+    end
+
+    def flash_alert(message, options = nil)
+      push_flash(message, options, 'alert')
+    end
+
+    def flash_error(message, options = nil)
+      push_flash(message, options, 'error')
+    end
+
+    def flash_model_error(errors, options = nil)
+      errors = errors.errors if errors.is_a? ActiveRecord::Base
+      push_flash(errors.to_h, options, 'modelError')
+    end
+  end
+end

data/lib/flash-messenger/engine.rb

@@ -0,0 +1,14 @@
+if defined?(::Rails::Engine)
+  module FlashMessenger
+    class Engine < ::Rails::Engine
+      initializer "flash-messenger-rails" do
+        ActiveSupport.on_load(:action_view) do
+          include FlashMessenger::ViewHelper
+        end
+        ActiveSupport.on_load(:action_controller) do
+          include FlashMessenger::ControllerHelper
+        end
+      end
+    end
+  end
+end

data/lib/flash-messenger/helper.rb

@@ -0,0 +1,21 @@
+module FlashMessenger
+  module Helper
+    def flash_messenger
+      RequestStore.store[:flash_messenger] ||= []
+    end
+
+    def push_flash(message, options, method = nil)
+      options = options.nil? ? options : options.clone
+      if method.nil?
+        if options.nil?
+          job = [message]
+        else
+          job = [message, options]
+        end
+      else
+        job = [message, options, method]
+      end
+      flash_messenger << job
+    end
+  end
+end

data/lib/flash-messenger/version.rb

@@ -0,0 +1,3 @@
+module FlashMessenger
+  VERSION = "0.1.0"
+end

data/lib/flash-messenger/view_helper.rb

@@ -0,0 +1,12 @@
+module FlashMessenger
+  module ViewHelper
+    include FlashMessenger::Helper
+
+    def show_flash
+      flash.map do |type, message|
+        push_flash(message, :type => type)
+      end
+      javascript_tag "flash.show(#{flash_messenger.to_json});" unless flash_messenger.empty?
+    end
+  end
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: flash-messenger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chen, Yi-Cyuan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  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: activerecord
+  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: sqlite3
+  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: rspec
+  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: rspec-its
+  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: simplecov
+  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: coveralls
+  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'
+description: Integrate with flash-messenger to provide a simple flash messages.
+email:
+- emn178@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/flash-messenger-bootstrap.js
+- app/assets/javascripts/flash-messenger-turboboost.js
+- app/assets/javascripts/flash-messenger.js
+- app/assets/javascripts/flash-messenger/flash-messenger.js
+- app/assets/stylesheets/flash-messenger-bootstrap.css
+- app/assets/stylesheets/flash-messenger.css
+- bin/console
+- bin/setup
+- flash-messenger.gemspec
+- lib/flash-messenger.rb
+- lib/flash-messenger/controller_helper.rb
+- lib/flash-messenger/engine.rb
+- lib/flash-messenger/helper.rb
+- lib/flash-messenger/version.rb
+- lib/flash-messenger/view_helper.rb
+homepage: https://github.com/emn178/flash-messenger-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Integrate with flash-messenger to provide a simple flash messages.
+test_files: []