glow 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Zweitag GmbH
+
+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,70 @@
+# Glow
+
+Glowing flashes! Okay... not really. This simply adds handling of the
+Fash Hash in Javascript. Depends on jQuery.
+
+## Usage
+
+Any flash messages set in ajax responses fire a `glow:flash`
+event on `document`.
+
+    flash[:notice] = 'Ajax man!'
+    respond_to do |format|
+      format.js { head :ok }
+    end
+
+Handle it any way you want:
+
+    $(document).bind('glow:flash', function(evt, flash) {
+      alert(flash.type);
+      alert(flash.message);
+    }
+
+Also adds a `Flash` object that enables you to fire `glow:flash`.
+
+    Flash.success('Yeah this worked!');
+    Flash.error('Something went wrong!');
+    Flash.notice('This is a flash message');
+
+    Flash.fire('type', 'message');
+
+This can be used to unify your Flash message handling (also in non-xhr
+responses).
+
+    <% flash.each |type, message| %>
+      <%= javascript_tag "Flash.fire('#{type}', '#{message}')" %>
+    <% end %>
+
+## Installation
+
+In your gemfile add
+
+    gem "glow"
+
+.
+
+### Rails 3.0
+
+Run
+
+    rails generate glow:install
+
+Then add
+
+    javascipt_include_tag 'glow'
+
+to your layout.
+
+### Rails 3.1
+
+TODO
+
+## License
+
+See MIT-LICENSE.
+
+## TODO
+
+- Test in 3.1
+- Automatically add //= require glow to application.js in 3.1 (via
+  generator)

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Glow'
+  rdoc.options << '--line-numbers'
+  #rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks

data/lib/generators/glow/install/install_generator.rb

@@ -0,0 +1,19 @@
+require 'rails'
+
+module Glow
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+
+      desc "This generator installs glow.js. You must inclu"
+      class_option :ui, :type => :boolean, :default => false, :desc => "Include jQueryUI"
+      source_root File.expand_path('../../../../../vendor/assets/javascripts', __FILE__)
+
+      def copy_glow
+        say_status("copying", "glow", :green)
+        copy_file "glow.js", "public/javascripts/glow.js"
+        say("Please include glow.js in your layout")
+      end
+
+    end
+  end
+end if ::Rails.version < "3.1"

data/lib/glow.rb

@@ -0,0 +1,8 @@
+module Glow
+  if ::Rails.version < "3.1"
+    require 'glow/railtie'
+  else
+    require 'glow/engine'
+  end
+  require 'glow/version'
+end

data/lib/glow/engine.rb

@@ -0,0 +1,10 @@
+require 'glow/filter'
+require 'action_controller/base'
+
+module Glow
+  class Railtie < Rails::Engine
+    config.to_prepare do
+      ::ActionController::Base.send :include, Glow::Filter
+    end
+  end
+end

data/lib/glow/filter.rb

@@ -0,0 +1,19 @@
+require 'active_support/concern'
+
+module Glow
+  module Filter
+    extend ActiveSupport::Concern
+    included do
+      after_filter :flash_to_headers
+    end
+    module InstanceMethods
+      def flash_to_headers
+        return unless flash.any? && request.xhr?
+        type, message = flash.first
+        response.headers['X-Message'] = message.unpack('U*').map{ |i| "&##{i};" }.join
+        response.headers['X-Message-Type'] = type
+        flash.discard  # don't want the flash to appear when you reload page
+      end
+    end
+  end
+end

data/lib/glow/railtie.rb

@@ -0,0 +1,10 @@
+require 'glow/filter'
+require 'action_controller/base'
+
+module Glow
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      ::ActionController::Base.send :include, Glow::Filter
+    end
+  end
+end

data/lib/glow/version.rb

@@ -0,0 +1,3 @@
+module Glow
+  VERSION = "0.0.1"
+end

data/lib/tasks/glow_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :glow do
+#   # Task goes here
+# end

data/test/dummy/Gemfile

@@ -0,0 +1,9 @@
+source :rubygems
+gem 'rails', "~> 3.0.0"
+gem 'jquery-rails'
+gem 'glow', path: '../..'
+#group :test, :development do
+  gem 'rspec-rails'
+  gem 'capybara'
+  gem 'htmlentities'
+#end

data/test/dummy/Gemfile.lock

@@ -0,0 +1,124 @@
+PATH
+  remote: ../..
+  specs:
+    glow (0.0.1)
+      jquery-rails
+      rails (~> 3.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.10)
+      actionpack (= 3.0.10)
+      mail (~> 2.2.19)
+    actionpack (3.0.10)
+      activemodel (= 3.0.10)
+      activesupport (= 3.0.10)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.10)
+      activesupport (= 3.0.10)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.10)
+      activemodel (= 3.0.10)
+      activesupport (= 3.0.10)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.10)
+      activemodel (= 3.0.10)
+      activesupport (= 3.0.10)
+    activesupport (3.0.10)
+    arel (2.0.10)
+    builder (2.1.2)
+    capybara (1.0.1)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.2.1)
+      ffi (~> 1.0.6)
+    diff-lcs (1.1.3)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    ffi (1.0.9)
+    htmlentities (4.3.0)
+    i18n (0.5.0)
+    jquery-rails (1.0.13)
+      railties (~> 3.0)
+      thor (~> 0.14)
+    json_pure (1.5.3)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    nokogiri (1.5.0)
+    polyglot (0.3.2)
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.10)
+      actionmailer (= 3.0.10)
+      actionpack (= 3.0.10)
+      activerecord (= 3.0.10)
+      activeresource (= 3.0.10)
+      activesupport (= 3.0.10)
+      bundler (~> 1.0)
+      railties (= 3.0.10)
+    railties (3.0.10)
+      actionpack (= 3.0.10)
+      activesupport (= 3.0.10)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.2)
+    rdoc (3.9.3)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    rspec-rails (2.6.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.6.0)
+    rubyzip (0.9.4)
+    selenium-webdriver (2.4.0)
+      childprocess (>= 0.2.1)
+      ffi (>= 1.0.7)
+      json_pure
+      rubyzip
+    thor (0.14.6)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  glow!
+  htmlentities
+  jquery-rails
+  rails (~> 3.0.0)
+  rspec-rails

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,9 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,7 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require_tree . 
+*/

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/controllers/flash_controller.rb

@@ -0,0 +1,18 @@
+class FlashController < ApplicationController
+  def show
+    # show.html.erb
+  end
+
+  def redirect
+    flash[params[:type]] = params[:message]
+    redirect_to action: 'show'
+  end
+
+  def ajax
+    respond_to do |wants|
+      wants.js {
+        flash[params[:type]] = params[:message]
+      }
+    end
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/flash/ajax.js.erb

@@ -0,0 +1 @@
+console.log('ajax response');

data/test/dummy/app/views/flash/show.html.erb

@@ -0,0 +1,13 @@
+<script type="application/javascript">
+  // Flash handling
+  $(document).bind('glow:flash', function(evt, flash) { console.log('glow flash'); $('#flash').html(flash.message); });
+</script>
+
+<p id="flash"><%= flash.map { |type, message| message }.join %></p>
+<p><%= link_to 'redirect', action: :redirect, type: :notice, message: 'utf8: ✓ ' %></p>
+<p><%= link_to 'rails ajax', {action: :ajax, type: :notice, message: 'rails ajax: ✓ '}, remote: true %></p>
+<p><%= link_to 'jquery ajax', '#', id: 'ajax' %></p>
+
+<script type="application/javascript">
+  $('#ajax').click(function(){$.get('<%= url_for action: :ajax, type: :notice, message: 'jquery utf8: ✓', format: :js %>'); return false;});
+</script>

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,18 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%=
+    #stylesheet_link_tag    "application"
+  %>
+  <%= javascript_include_tag :defaults, 'glow' %>
+  <%=
+    #csrf_meta_tags
+  %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,43 @@
+require File.expand_path('../boot', __FILE__)
+
+require "action_controller/railtie"
+require "active_resource/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable the asset pipeline
+    # config.assets.enabled = true
+  end
+end
+