ivey-merb_has_flash 0.9.2

data/LICENSE

@@ -0,0 +1,24 @@
+Original code Copyright (c) 2007 Michael D. Ivey
+
+Most of this code is based on the Flash code in Rails/ActionPack:
+Copyright (c) 2004-2006 David Heinemeier Hansson
+
+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

@@ -0,0 +1,15 @@
+merb_has_flash
+=================
+
+A plugin for the Merb framework that provides Rails-style flash.
+
+Most of the code is taken directly from Rails, which is
+Copyright (c) 2004-2006 David Heinemeier Hansson.
+This plugin is released under the same terms as Rails itself.
+
+Hacked together by Michael Ivey <ivey@gweezlebur.com> ... send bug
+reports and patches to him.
+
+Contributors:
+Tim Kofol
+Shay Arnett

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{NAME}-#{VERSION}}
+end
+
+task :release => :package do
+  sh %{rubyforge add_release merb-plugins merb_has_flash #{VERSION} pkg/#{NAME}-#{VERSION}.gem}
+end

data/TODO

@@ -0,0 +1,5 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/merb_has_flash.rb
+Add your Merb rake tasks to lib/merb_has_flash/merbtasks.rb

data/lib/merb_has_flash/controller_extension.rb

@@ -0,0 +1,38 @@
+module MerbHasFlash
+  module ControllerExtension
+    def self.included(base)
+      base.send :include, InstanceMethods
+      
+      base.class_eval {
+        after :sweep_flash
+      }
+    end
+    
+    module InstanceMethods
+      # Access the contents of the flash. Use <tt>flash["notice"]</tt> to read a notice you put there or 
+      # <tt>flash["notice"] = "hello"</tt> to put a new one.
+      # Note that if sessions are disabled only flash.now will work.
+      def flash(refresh = false) #:doc:
+        if !defined?(@_flash) || refresh
+          @_flash =
+            if session.is_a?(Hash)
+              # don't put flash in session if disabled
+              FlashHash.new
+            else
+              # otherwise, session is a CGI::Session or a TestSession
+              # so make sure it gets retrieved from/saved to session storage after request processing
+              session["flash"] ||= FlashHash.new
+            end
+        end
+
+        @_flash
+      end
+      
+      protected
+      def sweep_flash
+        flash.sweep if request.session
+        session["flash"] = flash
+      end
+    end
+  end
+end

data/lib/merb_has_flash/flash_hash.rb

@@ -0,0 +1,101 @@
+module MerbHasFlash
+  class FlashNow #:nodoc:
+    def initialize(flash)
+      @flash = flash
+    end
+    
+    def []=(k, v)
+      @flash[k] = v
+      @flash.discard(k)
+      v
+    end
+    
+    def [](k)
+      @flash[k]
+    end
+  end
+  
+  class FlashHash < Hash
+    def initialize #:nodoc:
+      super
+      @used = {}
+    end
+    
+    def []=(k, v) #:nodoc:
+      keep(k)
+      super
+    end
+    
+    def update(h) #:nodoc:
+      h.keys.each{ |k| discard(k) }
+      super
+    end
+    
+    alias :merge! :update
+    
+    def replace(h) #:nodoc:
+      @used = {}
+      super
+    end
+  
+    # Sets a flash that will not be available to the next action, only to the current.
+    #
+    #     flash.now[:message] = "Hello current action"
+    # 
+    # This method enables you to use the flash as a central messaging system in your app.
+    # When you need to pass an object to the next action, you use the standard flash assign (<tt>[]=</tt>).
+    # When you need to pass an object to the current action, you use <tt>now</tt>, and your object will
+    # vanish when the current action is done.
+    #
+    # Entries set via <tt>now</tt> are accessed the same way as standard entries: <tt>flash['my-key']</tt>.
+    def now
+      FlashNow.new self
+    end
+  
+    # Keeps either the entire current flash or a specific flash entry available for the next action:
+    #
+    #    flash.keep            # keeps the entire flash
+    #    flash.keep(:notice)   # keeps only the "notice" entry, the rest of the flash is discarded
+    def keep(k = nil)
+      use(k, false)
+    end
+  
+    # Marks the entire flash or a single flash entry to be discarded by the end of the current action
+    #
+    #     flash.keep                 # keep entire flash available for the next action
+    #     flash.discard(:warning)    # discard the "warning" entry (it'll still be available for the current action)
+    def discard(k = nil)
+      use(k)
+    end
+  
+    # Mark for removal entries that were kept, and delete unkept ones.
+    #
+    # This method is called automatically by filters, so you generally don't need to care about it.
+    def sweep #:nodoc:
+      keys.each do |k| 
+        unless @used[k]
+          use(k)
+        else
+          delete(k)
+          @used.delete(k)
+        end
+      end
+
+      (@used.keys - keys).each{|k| @used.delete k } # clean up after keys that could have been left over by calling reject! or shift on the flash
+    end
+  
+    private
+      # Used internally by the <tt>keep</tt> and <tt>discard</tt> methods
+      #     use()               # marks the entire flash as used
+      #     use('msg')          # marks the "msg" entry as used
+      #     use(nil, false)     # marks the entire flash as unused (keeps it around for one more action)
+      #     use('msg', false)   # marks the "msg" entry as unused (keeps it around for one more action)
+      def use(k=nil, v=true)
+        unless k.nil?
+          @used[k] = v
+        else
+          keys.each{|key| use key, v }
+        end
+      end
+  end
+end

data/lib/merb_has_flash/helper.rb

@@ -0,0 +1,7 @@
+module MerbHasFlash
+  module FlashHelperMixin
+    def flash
+      @web_controller.flash
+    end
+  end
+end

data/lib/merb_has_flash.rb

@@ -0,0 +1,39 @@
+unless defined?(Merb::Plugins)
+  raise %q{merb_has_flash says, "Something's not right, bub.  You should run me inside Merb, or at least cheat and define a Merb::Plugins constant."}
+end
+
+require 'merb_has_flash/flash_hash'
+
+require 'merb_has_flash/controller_extension'
+Merb::Controller.send :include, MerbHasFlash::ControllerExtension
+
+require 'merb_has_flash/helper'
+Merb::RenderMixin.send :include, MerbHasFlash::FlashHelperMixin
+
+module MerbHasFlash
+  # The flash provides a way to pass temporary objects between actions. Anything you place in the flash will be exposed
+  # to the very next action and then cleared out. This is a great way of doing notices and alerts, such as a create action
+  # that sets <tt>flash[:notice] = "Successfully created"</tt> before redirecting to a display action that can then expose 
+  # the flash to its template. Actually, that exposure is automatically done. Example:
+  #
+  #   class WeblogController < Merb::Controller
+  #     def create
+  #       # save post
+  #       flash[:notice] = "Successfully created post"
+  #       redirect_to :action => "display", :params => { :id => post.id }
+  #     end
+  #
+  #     def display
+  #       # doesn't need to assign the flash notice to the template, that's done automatically
+  #       render
+  #     end
+  #   end
+  #
+  #   display.html.erb
+  #     <% if flash[:notice] %><div class="notice"><%= flash[:notice] %></div><% end %>
+  #
+  # This example just places a string in the flash, but you can put any object in there. And of course, you can put as many
+  # as you like at a time too. Just remember: They'll be gone by the time the next action has been performed.
+  #
+  # See docs on the FlashHash class for more details about the flash.
+end

data/spec/merb_has_flash/controller_extension_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "merb_has_flash Controller Extension" do
+  it "should copy-and-paste from rails" do
+    
+  end
+end

data/spec/merb_has_flash/flash_hash_spec.rb

@@ -0,0 +1,24 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'merb_has_flash/flash_hash'
+
+describe "merb_has_flash FlashHash" do
+  before(:each) do
+    @hash = MerbHasFlash::FlashHash.new
+  end
+  
+  it "should be a kind of Hash" do
+    @hash.should be_a_kind_of(Hash)
+  end
+  
+  it "should initialize an empty @used hash" do
+    @hash.instance_variable_get(:@used).should == {}
+  end
+  
+  it "should have more specs" do
+    
+  end
+  
+  it "should copy-and-paste most of this from Rails" do
+    
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: ivey-merb_has_flash
+version: !ruby/object:Gem::Version 
+  version: 0.9.2
+platform: ruby
+authors: 
+- Michael D. Ivey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-05-06 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.9.0
+    version: 
+description: Rails' 'flash' session notification system ported to Merb
+email: ivey@gweezlebur.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- Rakefile
+- README
+- TODO
+- lib/merb_has_flash.rb
+- lib/merb_has_flash/controller_extension.rb
+- lib/merb_has_flash/flash_hash.rb
+- lib/merb_has_flash/helper.rb
+- spec/merb_has_flash/controller_extension_spec.rb
+- spec/merb_has_flash/flash_hash_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/ivey/merb_has_flash
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Rails' 'flash' session notification system ported to Merb
+test_files: 
+- spec/merb_has_flash/controller_extension_spec.rb
+- spec/merb_has_flash/flash_hash_spec.rb
+- spec/spec_helper.rb