show_message 1.1.6 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e5862ff3c181739c267887d1bab6d5b52a07a877b48c29184f2b9e6a0d6a635
-  data.tar.gz: 9670ee92fcaf45089d57a694b704e6992ae3eab0d4b8184310d0e5d88ca1375e
+  metadata.gz: 3bde680317f76e6b572431af8bc42180fb248c330c3201d48863373d9ef7f8a4
+  data.tar.gz: 5d530062072d13f3715b48fe087703068528c20ac8b0b639fd2a1490b03b9e9a
 SHA512:
-  metadata.gz: b9433e9e330847597eed9680a4df047ca6374b88ecd84956ce9dd5d13372e338f5eca531fda897b059e7ec7cb462414c592158e45dc28f69846b39b59bbdb2fc
-  data.tar.gz: 347b76452c70a412da24a08f69f92418fc158401ebc33643676ff368748f4163eef36011b6f1b0496bcd14018611b6fd9438d78288963bc91cb686d982d4bd88
+  metadata.gz: b67ece0552015d2f38d9620650fe9e8def7d4b1c4914961e7970a2a204ea87f92ece5bca21924d951693c317296315bdaa8a6b1c7b43e805b24d8b775bad8204
+  data.tar.gz: 210c6ffe6828604f4fc51c5ea4a8e53f5cc920ea83f613760b63c65ab5040c3b36f51f7d2b66af45cec8cfbd3733315dae5832cc634286988adbeec86e5a4eb0

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [Unreleased]
+
+## [2.0.0] - 2020-03-05
+
+This is major rewrite of the way the gem works. This version introduces many
+breaking changes. Please review the README.

data/README.md

@@ -26,16 +26,20 @@ See further down for the HTML this outputs so you know how to style it.
 <%= show_message %>
 ```
 
-Now, set a message in your controller. You can use :error, :success, :myCoolMessage or :whatever. You get the point.
-The only thing you should not use is and "_". Read on to see why.
+Now, set a message in your controller. You can use :success, :error, :warning,
+:info, :notice or :alert.
 
-Also, it you can set a single message as a String or multiple as an Array
+Also, you can set a single message as a String or multiple as an Array
 
 ```ruby
 class MyController
 
   def test_function
-    flash[:success] = "Some Success Message"
+    # short versions
+    show_success('Some Success Message')
+    show_error('Some Error Message')
+
+    show_message :success, 'Some Success Message'
   end
 
 end
@@ -45,7 +49,7 @@ Now, when using remote forms I came across the issue where I would have multiple
 This led to some issues so I added the ability to set an id on show_message
 
 ```erb
-<%= show_message(id: :create_object) %>
+<%= show_message(:create) %>
 ```
 
 There is a slight twist to setting the flash now. I use an "_" to find what I call "scoped" messages.
@@ -54,26 +58,34 @@ There is a slight twist to setting the flash now. I use an "_" to find what I ca
 class MyController
 
   def test_function
-    flash[:error_create_object] = "Some Error Message"
+    # short version
+    show_success_for(:create, 'Some Success Message')
+    show_error_for(:create, 'Some Error Message')
+
+    show_message :success, 'Some Success Message', id: :create
   end
 
 end
 ```
 
-Lastly, I found the need to insert a margin below the message sometimes.
+## Additional Options
+
+Currently supported options only include `class` which allows you to specify
+additional classes to be appended to the outermost div's classlist.
 
 ```erb
-<%= show_message(space: 10) %>
-<!-- will insert a 10px margin below -->
+<%= show_message(class: 'my-special-class my-second-special-class') %>
+<%= show_message(:create, class: 'my-special-class my-second-special-class') %>
 ```
 
 ## show_message - HTML Output
 
-Below is HTML that show_message will output. You will need to create a few styles to make yours look nice.
-I left it free of styles since I was using Zurb Foundation. I also figured most people would want to style their own anyway.
+Below is HTML that show_message will output. You will need to create a few
+styles to make yours look nice. The type of message (success, error, etc) will
+be appended to the outermost div's classlist.
 
 ```html
-<div class="alert-box [the flash symbol will be here to]">
+<div class="alert-box [success, info, error...]">
     <div class="message">
       Message gets outputed here.
     </div>

data/app/views/show_message/_show_message.html.erb

@@ -1,10 +1,7 @@
 <% data.each do |m| %>
-  <div class="alert-box <%= m[:class] %> <%= options[:classes] %>">
+  <div class="alert-box <%= m[:class] %> <%= options[:class] %>">
     <div class="message">
       <%= raw m[:message] %>
     </div>
   </div>
 <% end %>
-<% if options[:space].present? %>
-  <div style="margin-top:<%= options[:space] %>px;"></div>
-<% end %>

data/lib/show_message.rb

@@ -1,4 +1,5 @@
 require 'show_message/view_helpers'
+
 if defined? Rails
   require 'show_message/railtie'
   require 'show_message/engine'
@@ -6,14 +7,26 @@ end
 
 module ShowMessage
 
-  def show_message(type, message, id: true)
-    flash_sym =
-      if type.to_s.include?('_')
-        type
-      else
-        id ? "#{type}_#{controller_name}" : type.to_s
-      end
-    flash[flash_sym] = message
+  def show_message(type, message, id: nil)
+    id ||= 'all'
+    flash[type] ||= {}
+    flash[type][id.to_s] = message
+  end
+
+  def show_success(message)
+    show_message(:success, message)
+  end
+
+  def show_success_for(id, message)
+    show_message(:success, message, id: id)
+  end
+
+  def show_error(message)
+    show_message(:error, message)
+  end
+
+  def show_error_for(id, message)
+    show_message(:error, message, id: id)
   end
 
 end

data/lib/show_message/railtie.rb

@@ -2,8 +2,18 @@ require 'show_message/view_helpers'
 
 module ShowMessage
   class Railtie < Rails::Railtie
-    ActiveSupport.on_load(:action_view) do
-      ::ActionView::Base.send :include, ShowMessage::ViewHelpers
+
+    initializer 'show_message.setup_action_view' do
+      ActiveSupport.on_load :action_view do
+        include ShowMessage::ViewHelpers
+      end
+    end
+
+    initializer 'show_message.setup_action_controller' do
+      ActiveSupport.on_load :action_controller do
+        include ShowMessage
+      end
     end
-  end 
-end
+
+  end
+end

data/lib/show_message/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ShowMessage
-  VERSION = '1.1.6'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/lib/show_message/view_helpers.rb

@@ -1,35 +1,42 @@
 module ShowMessage
   module ViewHelpers
 
-    def show_message(options = {})
-      scope =
-        if options[:id].nil?
-          controller_name
-        elsif options[:id] == false
-          false
-        else
-          options[:id].to_s
-        end
-      if scope.present? && flash.keys.none? { |k| k.to_s.include?(scope) }
-        return
+    # render the applicable messages
+    #
+    # @param options_or_ids options or the ids to target
+    # @param options options for the view
+    def show_message(options_or_ids = nil, options = nil)
+      if options_or_ids.is_a?(Hash)
+        display_ids = []
+        options = options_or_ids
+      else
+        display_ids = options_or_ids
+        options ||= {}
       end
 
-      data = []
+      display_ids = display_ids.is_a?(Array) ? display_ids : [display_ids]
+      display_ids = display_ids.compact.map(&:to_s)
+      # target all messages if no target is specified
+      display_ids.push('all') if display_ids.empty?
 
-      flash.each do |key, value|
-        next if scope.present? && !key.to_s.include?(scope)
-        next unless value
+      data = []
+      message_keys = %w(success error warning info notice alert)
 
-        flash_type = key.to_s.split('_').first
-        next unless flash_type.in? %w(success error warning info notice)
+      flash.to_h.slice(*message_keys).each do |key, message_hash|
+        # support basic usage of flash[:success] or flash[:error] which
+        # would normally just return a string
+        if message_hash.is_a?(Hash)
+          message_hash.each do |id, messages|
+            next unless display_ids.include?('all') || display_ids.include?(id)
 
-        if key.is_a?(Array)
-          value.each do |message|
-            data.push(message: message, class: flash_type)
+            build_data(data, messages, key)
           end
         else
-          data.push(message: value, class: flash_type)
+          next unless display_ids.include?('all')
+
+          build_data(data, message_hash, key)
         end
+
         flash.discard(key)
       end
 
@@ -38,5 +45,15 @@ module ShowMessage
       }
     end
 
+    private
+
+    # support for messages to be an array. this will add multiple items to the
+    # data array to be rendered.
+    def build_data(data, messages, key)
+      messages = messages.is_a?(Array) ? messages : [messages]
+      messages.each do |message|
+        data.push(message: message, class: key)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: show_message
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 2.0.0
 platform: ruby
 authors:
 - Jarrett Lusso
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-28 00:00:00.000000000 Z
+date: 2020-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -48,6 +48,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -78,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: show_message makes it easy to output your flash[:success], flash[:error]