alert-messages-for-hanami 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c50c33b86ec3df0b36f2a60835784691de6da57
+  data.tar.gz: 3a4e380f849c618b4d43f1e1be62c2a7d736145f
+SHA512:
+  metadata.gz: a602b5a5a623209507c96d36b0bd9604b10e883e0fc3cd8f93303302af98a5c91fb74c8dfcb3c5cd0bbc54e31f52031fb2bac69979f5cc78cf7b3c1d04895c8f
+  data.tar.gz: 2b78be45a3624e4b6ff5ef36ae6cd318a2bb5b980ff08c2dbd963e4dee89fcde05537273f217dd1b92eb791364d7f864afbc8546e71a75d1d0595f33eb57376d

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--require spec-helper
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+
+rvm:
+   - "2.2"
+
+before_install: gem install bundler
+
+script: bundle exec rspec
+
+git:
+   submodules: false

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in alert-messages.gemspec
+gemspec
+
+gem 'rspec', require: false
+gem 'simplecov', require: false
+gem 'coveralls', require: false
+gem 'hanami-controller', require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 mrubi
+
+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,101 @@
+# AlertMessages for Hanami
+
+A helper to add alert messages (including flash ... aah! messages) to an [Hanami](http://hanamirb.org/) application.
+
+## Status
+
+[![Gem Version](https://badge.fury.io/rb/alert-messages-for-hanami.svg)](https://badge.fury.io/rb/alert-messages-for-hanami)
+[![Build Status](https://travis-ci.org/cabeza-de-termo/alert-messages-for-hanami.svg?branch=master)](https://travis-ci.org/cabeza-de-termo/alert-messages-for-hanami)
+[![Coverage Status](https://coveralls.io/repos/github/cabeza-de-termo/alert-messages-for-hanami/badge.svg?branch=master)](https://coveralls.io/github/cabeza-de-termo/alert-messages-for-hanami?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'alert-messages-for-hanami', '~> 0.1'
+```
+
+## Usage
+
+### Configuration
+
+In your application.rb include
+
+```ruby
+require 'alert-messages-for-hanami'
+```
+
+and then
+
+```ruby
+# Configure the code that will yield each time Admin::Action is included
+# This is useful for sharing common functionality
+#
+# See: http://www.rubydoc.info/gems/hanami-controller#Configuration
+controller.prepare do
+	# include MyAuthentication # included in all the actions
+	# before :authenticate!    # run an authentication before callback
+
+	include CabezaDeTermo::AlertMessages::Behaviour
+end
+```
+
+### Adding messages in your actions
+
+To add a message to show in the current page, do
+
+```ruby
+module Web::Controllers::Login
+	class Create
+		include Web::Action
+
+		def call(params)
+			alert_messages[:info] << 'You know nothing, John Snow'
+		end
+	end
+end
+```
+
+To add a message to show in next request or redirect, first enable sessions in your application and then you can do
+
+```ruby
+module Web::Controllers::Login
+	class Create
+		def call(params)
+			alert_messages.flash_at(:info) << 'Flash! aah ... king of the immmmpossible'
+		end
+	end
+end
+```
+
+### Showing messages
+
+In your template do something like
+
+```ruby
+- alert_messages[:success].each do |success_message|
+	.alert.alert-success role="alert"
+		= success_message
+
+- alert_messages[:info].each do |info_message|
+	.alert.alert-info role="alert"
+		= info_message
+
+- alert_messages[:warnings].each do |warning_message|
+	.alert.alert-warning role="alert"
+		= warning_message
+
+- alert_messages[:errors].each do |error_message|
+	.alert.alert-danger role="alert"
+		= error_message
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/cabeza-de-termo/alert-messages.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/alert-messages.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'alert-messages/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alert-messages-for-hanami"
+  spec.version       = CabezaDeTermo::AlertMessages::VERSION
+  spec.authors       = ["Martin Rubi"]
+  spec.email         = ["martinrubi@gmail.com"]
+
+  spec.summary       = %q{Helper to add alert messages (including flash .. aah! messages) to an Hanami application.}
+  spec.homepage      = "https://github.com/cabeza-de-termo/alert-messages-for-hanami"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/alert-messages-for-hanami.rb

@@ -0,0 +1,3 @@
+require 'alert-messages/version'
+require 'alert-messages/alert-messages'
+require 'alert-messages/alert-messages-behaviour'

data/lib/alert-messages/alert-messages-behaviour.rb

@@ -0,0 +1,13 @@
+module CabezaDeTermo::AlertMessages
+	module Behaviour
+		def self.included(action)
+			action.class_eval do |action_class|
+				expose :alert_messages
+			end
+        end
+
+		def alert_messages()
+			@alert_messages ||= Messages.new(flash: flash)
+		end
+	end
+end

data/lib/alert-messages/alert-messages.rb

@@ -0,0 +1,59 @@
+module CabezaDeTermo::AlertMessages
+	class Messages
+		ALERT_MESSAGES = :alert_messages
+
+		# Instance methods
+
+		def initialize(flash:)
+			@messages = Hash.new { |hash, key| hash[key] = [] }
+			@flash = flash
+			transfer_flash_messages_for_this_request
+		end
+
+		def [](message_type)
+			messages[message_type]
+		end
+
+		def flash_at(message_type)
+			ensure_flash_message_type_exists message_type
+			flash_messages[message_type]
+		end
+
+		protected
+
+		# Accessing flash oh oh
+
+		def flash_messages()
+			@flash[ALERT_MESSAGES]
+		end
+
+		def transfer_flash_messages_for_this_request()
+			return if flash_messages.nil?
+
+			flash_messages.each_pair do |type, messages|
+				self[type].concat messages
+			end
+
+			drop_flash_messages
+		end
+
+		def drop_flash_messages()
+			@flash[ALERT_MESSAGES] = nil
+		end
+
+		def reset_flash_messages()
+			@flash[ALERT_MESSAGES] = Hash[]
+		end
+
+		def ensure_flash_message_type_exists(message_type)
+			reset_flash_messages if @flash[ALERT_MESSAGES].nil?
+			flash_messages[message_type] = [] unless flash_messages.key? message_type
+		end
+
+		# Accessing regular messages
+
+		def messages()
+			@messages
+		end
+	end
+end

data/lib/alert-messages/version.rb

@@ -0,0 +1,5 @@
+module CabezaDeTermo
+	module AlertMessages
+		VERSION = "0.1.0"
+ 	end
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: alert-messages-for-hanami
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Martin Rubi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+description: 
+email:
+- martinrubi@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- alert-messages.gemspec
+- lib/alert-messages-for-hanami.rb
+- lib/alert-messages/alert-messages-behaviour.rb
+- lib/alert-messages/alert-messages.rb
+- lib/alert-messages/version.rb
+homepage: https://github.com/cabeza-de-termo/alert-messages-for-hanami
+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.6.3
+signing_key: 
+specification_version: 4
+summary: Helper to add alert messages (including flash .. aah! messages) to an Hanami
+  application.
+test_files: []