Explicit documentation that "Flash" word is a reserved key for Action layer

[rafaels88]

This is just a request to put this information in documentation.

I was trying to create a simple system for flash message using session + shared code, and no errors occured, but exposed :flash attribute always had {} as value.

Steps to reproduce

# apps/web/controllers/flash.rb
module Web
  module Flash
    after :flash!
    expose :flash

   private

   def flash!
     @flash = {}

     if session[:flash_message]
        @flash[:success] = session[:flash_message]
        session[:flash_message] = nil
    end
  end
end

# index.html.erb
<%= flash[:success] %>

Actual behavior

Rendering result will always be {}.

Expected behavior

Should be == session[:flash_message].

I figured that Flash is a kind of internal module for Hanami Controller, so this issue is just a request for this to be documented.

[cllns]

Thanks! Good find. Indeed flash is used in Hanami::Action::Session.

Personally, I'd rather see an error telling the developer that flash is reserved (and links to docs about flash) rather than just document it.

What do others think about that? If that's desired, this should be filed in in hanami/controller.

[b264]

👍 for raise telling developer flash is reserved

[rafaels88]

👍 for raise.

[jodosha]

Yes, this should go in hanami-controller.

[cllns]

We can close this, in favor of this Issue in hanami-controller: hanami/controller#158

[jodosha]

@cllns Thank you 👍