the_notifications 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1333942861d042c9a0fcac2df8025c254c2183d7
+  data.tar.gz: 2b6f1c3b708b030cf93a2f16e84ecf68318bd552
+SHA512:
+  metadata.gz: 4435039f259ff3189c06e7165b1687220ac687aec98efcf91ee4ef21761545e4d13752ff5d1c75982860c2e61e14790e6b9f2f737ea5cecd5ea353f8a0a1c0d9
+  data.tar.gz: 03255f1f2a509b295ee28a249cb08a62bc1cece92519f6f24b31bd3900224d80a1b6863e2c8a5db66d4b9753c22065c8a9365fa1f2c87fef8fc3e3560ba65eba

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in notifications.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,9 @@
+### MIT License
+
+Copyright (c) 2013-[Current Year] Ilya N. Zykin
+
+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,134 @@
+```ruby
+This gem is a part of TheOpenCMS project. https://github.com/TheOpenCMS
+```
+
+## Notifications
+
+Just add JSON on HTML notifications in your Rails app
+
+```ruby
+gem 'notifications'
+```
+
+## How it works
+
+This gem helps you to get rid of this bunch of a code
+
+```ruby
+<%= form_for(@resource) do |f| %>
+  <% if @resource.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@resource.errors.count, "error") %> prohibited this resource from being saved:</h2>
+
+      <ul>
+      <% @resource.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  # ....
+
+<% end %>
+```
+
+and replace it with the following code:
+
+```slim
+  - form_for(@post) do |f|
+    = render partial: 'notifications/form', locals: { object: @post }
+```
+
+and this code to render Flash messages:
+
+```slim
+body
+  = render partial: 'notifications/flash'
+  = yield
+```
+
+## How to use
+
+*Note:* `toastr` is an external dependency for `format: :json` case. Download and and install it yourself. `vendors/toastr` is just a demo path to assets
+
+*application.css*
+
+```css
+//= require vendors/toastr
+```
+
+*application.js*
+
+```js
+//= require vendors/toastr
+//= require notifications
+
+$ ->
+  Notifications.init()
+  Notifications.show_notifications()
+```
+
+### Format `html` or `json`
+
+You can select a way how to render notifications. There are 2 options: `format: :html` and `format: :json`
+
+```slim
+= render partial: 'notifications/flash', locals: { format: :html }
+= render partial: 'notifications/form', locals: { object: @post, format: :json }
+```
+
+### Default notifications format
+
+*initializers/notifications.rb*
+
+```ruby
+Notifications.configure do |config|
+  config.default_type = :json # :html
+end
+```
+
+### Errors' localization
+
+To avoid this case
+
+```
+Title: не может быть пустым
+```
+
+Do the following steps:
+
+*models/user.rb*
+
+```ruby
+class Post < ActiveRecord::Base
+  include Notifications::LocalizedErrors
+end
+```
+
+*config/locales/ru.yml*
+
+```
+activerecord:
+  models:
+    post: Публикация
+  attributes:
+    post:
+      title: "Загловок"
+```
+
+Now errors messages will look so:
+
+```
+Загловок: не может быть пустым
+```
+
+### MIT License
+
+Copyright (c) 2013-[Current Year] Ilya N. Zykin
+
+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/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/app/assets/javascripts/notifications/base.js.coffee

@@ -0,0 +1,51 @@
+NotificationTool = toastr
+
+@Notifications = do ->
+  clear: -> @clean()
+  clean: -> NotificationTool.clear()
+
+  show_error: (error) ->
+    NotificationTool.error(error) if error
+
+  show_errors: (errors) ->
+    for field, errs of errors
+      for err in errs
+        NotificationTool.error "<b>#{ field }:</b> #{ err }"
+
+  show_flash: (flash) ->
+    fu =
+      info:    'info'
+      notice:  'info'
+      errors:  'error'
+      error:   'error'
+      warning: 'warning'
+      alert:   'warning'
+
+    for level, msg of flash
+      method = fu[level] || 'info'
+
+      if msg instanceof Array
+        for _msg in msg
+          NotificationTool[method] _msg
+      else
+        NotificationTool[method] msg
+
+  show_notifications: ->
+    data = window.notifications
+    return false unless data
+
+    @show_errors errors if errors = data?.errors
+    @show_flash  flash  if flash  = data?.flash
+
+  click_for_close_init: ->
+    $(document).on 'click', '.flash_msgs, .error_explanation', (e) ->
+      $(e.currentTarget).slideUp(500)
+
+  turbolinks_init: ->
+    $(document).on 'page:before-unload', (e) ->
+      window.notifications = undefined
+
+  init: ->
+    @inited ||= do =>
+      @click_for_close_init()
+      @turbolinks_init() if Turbolinks?

data/app/assets/stylesheets/notifications/notifications.sass

@@ -0,0 +1,43 @@
+.toast-message
+  font-size: 15px
+
+.flash_msgs
+  padding: 10px 10px 0px 10px
+  margin-bottom: 15px
+  border-radius: 5px
+  cursor: pointer
+
+  &.alert-info, &.alert-warning
+    color: #3A87AD
+    border: 3px solid gray
+
+    p
+      font-size: 14px
+      line-height: 150%
+      margin: 10px 0 15px 0
+
+  &.alert-info border-color: #3A87AD
+  &.alert-warning border-color: orange
+
+.error_explanation.alert-danger
+  border: 3px solid #B94A48
+  color: #B94A48
+
+  padding: 10px
+  margin-bottom: 15px
+  border-radius: 5px
+  cursor: pointer
+
+  h4
+    margin: 10px 0 20px 0
+
+
+  ul
+    margin-left: 15px
+    padding-bottom: 0.1px
+    list-style: disc inside none
+
+  li
+    font-size: 14px
+    line-height: 130%
+    margin-bottom: 15px

data/app/helpers/notifications_helper.rb

@@ -0,0 +1,11 @@
+module NotificationsHelper
+  def flash_class(level)
+    case level.to_sym
+      when :notice then "alert-info"
+      when :errors then "alert-danger"
+      when :error  then "alert-danger"
+      when :alert  then "alert-warning"
+      else "alert-success"
+    end
+  end
+end

data/app/models/concerns/localized_errors.rb

@@ -0,0 +1,41 @@
+# include ::Notifications::LocalizedErrors
+module Notifications
+  module LocalizedErrors
+    extend ActiveSupport::Concern
+
+    # @post.localized_errors(except: [:'comment.title'])
+    def localized_errors opts = {}
+      opts.symbolize_keys!
+      excepts = opts.delete(:except) || []
+
+      errors.inject({}) do |hash, (k, v)|
+        unless excepts.include?(k.to_sym)
+          k = self.class.human_attribute_name k
+          hash[k].blank? ? hash[k] = [v] : hash[k].push(v)
+          hash[k].uniq!
+        end
+
+        hash
+      end
+    end
+
+    # @post.inline_localized_errors(except: [:'comment.title'])
+    def inline_localized_errors opts = {}
+      opts.symbolize_keys!
+      excepts = opts.delete(:except) || []
+
+      errors.inject({}) do |hash, (k, v)|
+        unless excepts.include?(k.to_sym)
+          name = self.class.human_attribute_name k
+          key  = "#{ self.class }/#{ k }".parameterize.underscore.camelcase
+
+          hash[key]       = {} if hash[key].blank?
+          hash[key][name] = [] if hash[key][name].blank?
+          hash[key][name].push(v)
+        end
+
+        hash
+      end
+    end
+  end
+end

data/app/views/notifications/_flash.html.slim

@@ -0,0 +1,21 @@
+- flash  = self.flash
+- format = (format || Notifications.config.default_type).to_s
+- flash_types = %w[ notice alert error errors ]
+
+- if format == 'html'
+  - flash_types.each do |level|
+    - msg = flash.try(:[], level) || flash.try(:[], level.to_sym)
+    - if msg.present?
+      .alert.flash_msgs class=flash_class(level)
+        = content_tag :p, msg
+- else
+  - if flash.present?
+    = javascript_tag defer: :defer, type: "text/javascript" do
+      | window.notifications = window.notifications || {};
+      | window.notifications['flash'] = window.notifications['flash'] || {};
+
+  - flash_types.each do |level|
+    - msg = flash.try(:[], level) || flash.try(:[], level.to_sym)
+    - if msg.present?
+      = javascript_tag defer: :defer, type: "text/javascript" do
+        | window.notifications['flash']['#{ level }'] = '#{ j msg }';

data/app/views/notifications/_form.html.slim

@@ -0,0 +1,28 @@
+-# Error mesages
+-# Post.model_name.human              => activerecord.models.post
+-# Post.human_attribute_name('title') => activerecord.attributes.post.title
+- format = (format || Notifications.config.default_type).to_s
+
+- if object.try(:errors).try(:any?)
+  - _errors = object.respond_to?(:localized_errors) ? object.localized_errors : object.errors
+  - if format == 'html'
+    .error_explanation.alert.alert-danger
+      h4= t "notifications.form_errors"
+      ul
+        - _errors.map do |name, msgs|
+          - if msgs.is_a? Array
+            - msgs.each do |msg|
+              li
+                strong= name
+                '
+                = msg
+          - else
+            li
+              strong= name
+              '
+              = msgs
+
+  - else
+    = javascript_tag defer: :defer, type: "text/javascript" do
+      | window.notifications = window.notifications || {};
+      | window.notifications['errors'] = JSON.parse('#{ raw j _errors.to_json }');

data/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  notifications:
+    form_errors: "Some errors here:"

data/config/locales/ru.yml

@@ -0,0 +1,3 @@
+ru:
+  notifications:
+    form_errors: "При сохранении возникли ошибки:"

data/lib/notifications.rb

@@ -0,0 +1,12 @@
+require 'slim'
+require_relative 'notifications_config'
+_root_ = File.expand_path('../../', __FILE__)
+
+module Notifications
+  class Engine < Rails::Engine; end
+end
+
+# TODO: Rework it with `autoload`
+%w[ localized_errors ].each do |concern|
+  require "#{ _root_ }/app/models/concerns/#{ concern }.rb"
+end

data/lib/notifications_config.rb

@@ -0,0 +1,20 @@
+module Notifications
+  def self.configure(&block)
+    yield @config ||= Notifications::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  # Configuration class
+  class Configuration
+    include ActiveSupport::Configurable
+
+    config_accessor :default_type
+  end
+
+  configure do |config|
+    config.default_type = :html # :json
+  end
+end

data/notifications.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+module Notifications
+  VERSION = "0.6.0"
+end
+
+Gem::Specification.new do |spec|
+  spec.name          = "the_notifications"
+  spec.version       = Notifications::VERSION
+  spec.authors       = ["Ilya N. Zykin"]
+  spec.email         = ["zykin-ilya@ya.ru"]
+  spec.description   = %q{Notifications and Alerts for a Rails app}
+  spec.summary       = %q{This gem helps to render flash messages in a Rails app}
+  spec.homepage      = "https://github.com/TheOpenCMS"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_dependency "slim"
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: the_notifications
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- Ilya N. Zykin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Notifications and Alerts for a Rails app
+email:
+- zykin-ilya@ya.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".keep"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/notifications/base.js.coffee
+- app/assets/stylesheets/notifications/notifications.sass
+- app/helpers/notifications_helper.rb
+- app/models/concerns/localized_errors.rb
+- app/views/notifications/_flash.html.slim
+- app/views/notifications/_form.html.slim
+- config/locales/en.yml
+- config/locales/ru.yml
+- lib/notifications.rb
+- lib/notifications_config.rb
+- notifications.gemspec
+homepage: https://github.com/TheOpenCMS
+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.5.2
+signing_key: 
+specification_version: 4
+summary: This gem helps to render flash messages in a Rails app
+test_files: []