gritter_notices 0.1.1

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'gritter'
+gem 'activerecord'
+gem 'actionpack'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'activerecord-nulldb-adapter'
+  gem 'factory_girl'
+  gem 'shoulda'
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Danil Pismenny
+
+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.rdoc

@@ -0,0 +1,109 @@
+= gritter_notices
+
+Использует модуль gritter для отображения flash сообщеий, а также вводит механизм сохраняемых пользовательских сообщений (notice).
+
+Удобно применять для отправки пользователю flash-сообщений из фоновых задач.
+
+Визуально выглядит так: http://boedesign.com/demos/gritter/
+
+== Установка
+
+Включаем модуль в Gemfile, незабываем затем сделать bundle install:
+
+    gem 'gritter' # неабываем его далее установить согласно документации
+    gem 'gritter_notices'
+
+Создаем таблицу `gritter_notices`
+
+    rails g gritter_notices
+    rake db:migrate
+
+Подключаем в notices в модель user:
+
+    has_gritter_notices
+
+Где-то в layout делаем так (haml-пример):
+
+    %head
+       = include_gritter
+    %body
+       = gflash // session сообщения добавляемые через gritter-овский gflash :success=>траляля
+       = gritter_flash_messages // Все остальные сообщения добавляемые через flash[:success] или notice
+
+== Использование
+
+В расширяемую модель добавляются метод `notice`. Агрументы:
+
+* Текстовое сообщение (String) или ключ к строке локали (Symbol)
+* Хеш опций прозрачно сохраняемых в модели и используемые при подстановке в `I18n::translate`.
+** В хеше опций пожно указать :scope для трансляции локали (по умолчанию `:gritter_notices`) и
+** `:level` из поддерживаемых gritter-ом - [:success, :warning, :notice, :error, :progress], по умолчанию :notice
+** :title
+** :sticky
+** другие опции понимаемые gritter-ом
+
+Примеры использования:
+
+    user.notice 'Просто текстовое сообщение'
+    user.notice 'Текстовое сообщение', :level=>:notice
+
+если в локали указать
+
+    ru:
+      gritter_notices:
+        import_contacts: Импортиорваны контакты (%{count})
+
+то можно будет использовать ключ, вместо текстового сообщения:
+
+    user.notice :import_contacts, :count=>123
+
+Для краткости можно :level указывать через подчеркивание после названия метода `notice`:
+
+    notice_success
+    notice_error
+    notice_warning
+    notice_progress
+    notice_notice    # синоним просто `notice`
+
+Далее во вьюхе вызываем:
+
+   = gritter_flash_messages
+
+который отображает и flash сообщения и накопвшиеся `notices`.
+
+== Дополнительно
+
+Поддерживается  `universal_flash_messages` и `flash-message-conductor`, тоесть сохранение во flash массивов сообщений, типа:
+
+   flash[:notice] = ['Сообщение1', 'Сообщение2']
+
+== TODO
+
+Удалять gritter_notice только после того как они закроются или их закроют
+
+Контроллер gritter_notices с одной акцией delivered. Ставить ее запуск на onclose. Сделать настраиваемым текущее поведение:
+
+   1. notices помечаются доставленными когда показываются во view (контроллер не используется)
+   2. notices помечаются удаленными когда закрываются (сами или принудительно) onclose
+   3. обычные notices по методу 1, sticky notices по методу 2.
+
+
+== Credits
+* Robin Brouwer https://github.com/RobinBrouwer/gritter
+* Jordan Boesch http://boedesign.com/blog/2009/07/11/growl-for-jquery-gritter/
+
+== Contributing to gritter_notices
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Danil Pismenny. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "gritter_notices"
+  gem.homepage = "http://github.com/dapi/gritter_notices"
+  gem.license = "MIT"
+  gem.summary = "Show flashes and saved user's notices with Gritter (growl-like jQuery plugin)"
+  gem.description = %Q{Provide `notice` method to user model to save notices and to shows them later in views with Gritter (growl-like jQuery plugin). Fully support of Rails flash messages also. Helpful to send flash messages from background jobs.}
+  gem.email = "danil@orionet.ru"
+  gem.authors = ["Danil Pismenny"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "gritter_notices #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/app/models/gritter_notice.rb

@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+#
+# Сообщения от системы пользователю для отображения их через flash. Например:
+#
+#   :import_contacts - импортированы контакты
+#   :import_events - импортированы мероприятия
+#
+# Сообщения посылаются так:
+#
+#   user.notice :import_contacts, :provider=>:facebook
+#
+# Тексты сообщений описываются в локали
+
+class GritterNotice < ActiveRecord::Base
+  belongs_to :owner, :polymorphic=>true
+
+  scope :delivered, where("delivered_at is not nul").order('delivered_at')
+  scope :fresh, where("delivered_at is null").order('created_at').limit(5)
+
+  serialize :options, Hash
+
+  validates_presence_of :owner, :message
+
+  def fresh?
+    delivered_at.blank?
+  end
+
+  def delivered?
+    not fresh?
+  end
+
+  def destroy_after_deliver?
+    true
+  end
+
+  def mark_as_delivered
+    if destroy_after_deliver?
+      destroy
+    else
+      update_attribute :delivered_at, Time.now
+    end
+  end
+end

data/lib/generators/gritter_notices_generator.rb

@@ -0,0 +1,23 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class GritterNoticesGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_gritter_notices_table.rb'
+  end
+
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,23 @@
+class CreateGritterNoticesTable < ActiveRecord::Migration
+  def self.up
+    create_table :gritter_notices, :force => true do |t|
+      t.integer  :owner_id,                           :null => false
+      t.string  :owner_type,                          :null => false
+      t.text     :message,                            :null => false
+      # t.string   :level,        :default => "notice", :null => false
+      # t.string   :title
+      # t.string   :image
+      # t.boolean  :sticky, :default=>false, :null=>false
+      t.text     :options, :null=>false
+      t.datetime :delivered_at
+      t.datetime :created_at
+      t.datetime :updated_at
+    end
+
+    add_index :gritter_notices, [:owner_id, :delivered_at]
+  end
+
+  def self.down
+    drop_table :gritter_notices
+  end
+end

data/lib/gritter_notices/active_record.rb

@@ -0,0 +1,48 @@
+module GritterNotices::ActiveRecord
+
+  ValidMethods = Hash[*GritterNotices::KEYS.map { |key| ["notice_#{key}".to_sym, key] }.flatten]
+
+  # :level => [:success, :warning, :notice, :error, :progress]
+  def has_gritter_notices
+    has_many :gritter_notices, :as => :owner, :dependent => :delete_all
+    include InstanceMethods
+  end
+
+  module InstanceMethods
+
+    #
+    # Examples:
+    #
+    # notice :message=>'asdsad', :image=>:notice
+    # notice 'message', :level=>:success
+    #
+
+    def notice *args
+      options = args.extract_options!
+      message = args.first || options[:message]
+      options = {:scope=>:gritter_notices, :level=>:notice}.merge options
+      if message.is_a? Symbol
+        options[:gritter_message_key] = message
+        message = I18n::translate(message, options)
+      end
+      gritter_notices.create! :message=>message, :options=>options
+    end
+
+    # notice_success
+    # notice_error
+    # notice_warning
+    # notice_progress
+    # notice_notice    - default. An alias for `notice`
+
+    def method_missing(method_name, *args, &block)
+      if level = ValidMethods[method_name]
+        options = args.extract_options!
+        options[:level] = level
+        args << options
+        notice *args
+      else
+        super(method_name, *args, &block)
+      end
+    end
+  end
+end

data/lib/gritter_notices/rspec_matcher.rb

@@ -0,0 +1,40 @@
+module GritterNotices
+  module RSpecMatcher
+    def have_gritter_notice(message=nil)
+      HaveGritterNotice.new(message)
+    end
+
+    class HaveGritterNotice
+      def initialize(message)
+        @message = message
+      end
+
+      def description
+        "send gritter notice '#{@message}' to '#{@model}"
+      end
+
+      def failure_message_for_should
+        "#{@model.class} should have gritter_notice with message '#{@message}'"
+      end
+
+      def failure_message_for_should_not
+        "#{@model.class} should not have an gritter_notice with message '#{@message}'"
+      end
+
+      # def from(value)
+      #   @from = value
+      #   self
+      # end
+
+      # def to(value)
+      #   @to = value
+      #   self
+      # end
+
+      def matches?(model)
+        @model = model
+        not model.gritter_notices.select { |g| !@message or g.message == @message or g.options[:gritter_message_key] == @message }.empty?
+      end
+    end
+  end
+end

data/lib/gritter_notices/view_helpers.rb

@@ -0,0 +1,61 @@
+# -*- coding: utf-8 -*-
+
+module GritterNotices::ViewHelpers
+
+  GRITTER_CONVERT_KEYS = { :info=>:notice, :alert=>:warning, :failure=>:error, :other=>:notice }.
+    merge Hash[*GritterNotices::KEYS.map {|k| [k,k]}.flatten]
+
+
+  #
+  # Ключи понимаемые гриттером:
+  # :success, :warning, :notice, :error, :progress
+  #
+  # Все возможные (системные):
+  # :success, :warning, :notice, :error, :alert, :info, :failure
+
+  def gritter_flash_messages *args
+    options = args.extract_options!
+    titles = gflash_titles(options)
+    flashes = []
+
+    # Собираем flash-сообщения
+    flash.each_pair do |key, message_array|
+      message_array = [message_array] unless message_array.is_a? Array
+      message_array.flatten.each { |message|
+        key = key.to_sym
+        # Превращаем системные флешки в гритеровские
+        gritter_key = GRITTER_CONVERT_KEYS[key] || GRITTER_CONVERT_KEYS[:other] || key
+        title = titles[gritter_key] || key.to_s
+        flashes << add_gritter(message, :image => gritter_key, :title => title)
+      }
+    end
+
+    # Собираем gritter_notices
+    current_user.gritter_notices.fresh.each do |notice|
+      options = notice.options
+      gritter_key = GRITTER_CONVERT_KEYS[options[:level]] || GRITTER_CONVERT_KEYS[:other] || options[:level]
+      options[:title] = titles[gritter_key] || options[:level].to_s  unless options[:title]
+      options[:image] = gritter_key unless options[:image]
+      flashes << add_gritter(notice.message, options)
+      notice.mark_as_delivered
+    end if current_user and current_user.respond_to? :gritter_notices
+
+    js(flashes).html_safe
+  end
+
+  def move_gritter_notices_to_flashes
+    return unless current_user
+    current_user.gritter_notices.fresh.each do |notice|
+      append_flash_message notice.level, notice.message
+      notice.mark_as_delivered
+    end
+  end
+
+  private
+
+  def append_flash_message(type, msg, now=false)
+    f = now ? flash.now : flash
+    f[type] ||= []
+    f[type] << msg
+  end
+end

data/lib/gritter_notices.rb

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+module GritterNotices
+  # Keys supported by gritter
+  KEYS = [ :success, :warning, :notice, :error, :progress ]
+end
+
+require 'gritter_notices/active_record'
+ActiveRecord::Base.send( :extend, GritterNotices::ActiveRecord )
+
+require 'gritter_notices/view_helpers'
+ActionView::Base.send( :include, GritterNotices::ViewHelpers )
+
+require 'gritter_notices/rspec_matcher'

data/spec/gritter_notice_spec.rb

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe GritterNotice do
+  it { should belong_to(:user) }
+  it { should validate_presence_of(:user) }
+  it { should validate_presence_of(:message) }
+  context "помечается как доставленная" do
+    subject { Factory :notice }
+    it { should_not be_delivered }
+  end
+end

data/spec/notice_spec.rb

@@ -0,0 +1,12 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe GritterNotice do
+  it { should belong_to(:user) }
+  it { should validate_presence_of(:user) }
+  it { should validate_presence_of(:message) }
+  context "mark as delivered" do
+    subject { Factory :notice }
+    it { should_not be_delivered }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'active_record'
+require 'action_view'
+# require 'nulldb_rspec'
+# include NullDB::RSpec::NullifiedDatabase
+
+
+require 'gritter_notices'
+
+require 'app/models/gritter_notice'
+
+require 'factory_girl'
+
+
+#   Factory.definition_file_paths = [
+#   File.join(Rails.root, 'spec', 'factories')
+# ]
+
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

data/spec/support/factories.rb

@@ -0,0 +1,8 @@
+Factory.define :user do |u|
+  u.name 'Bob'
+end
+
+Factory.define :notice, :class=>'GritterNotice' do |f|
+  f.association :user
+  f.message "MyText"
+end

data/spec/support/user.rb

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+class User < ActiveRecord::Base
+  has_gritter_notices
+end

metadata

@@ -0,0 +1,233 @@
+--- !ruby/object:Gem::Specification 
+name: gritter_notices
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Danil Pismenny
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-29 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: gritter
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: activerecord-nulldb-adapter
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  name: factory_girl
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  prerelease: false
+  type: :development
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :development
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  prerelease: false
+  type: :development
+  requirement: *id009
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id010
+description: Provide `notice` method to user model to save notices and to shows them later in views with Gritter (growl-like jQuery plugin). Fully support of Rails flash messages also. Helpful to send flash messages from background jobs.
+email: danil@orionet.ru
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- app/models/gritter_notice.rb
+- lib/generators/gritter_notices_generator.rb
+- lib/generators/templates/migration.rb
+- lib/gritter_notices.rb
+- lib/gritter_notices/active_record.rb
+- lib/gritter_notices/rspec_matcher.rb
+- lib/gritter_notices/view_helpers.rb
+- spec/gritter_notice_spec.rb
+- spec/notice_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+- spec/support/user.rb
+has_rdoc: true
+homepage: http://github.com/dapi/gritter_notices
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Show flashes and saved user's notices with Gritter (growl-like jQuery plugin)
+test_files: 
+- spec/gritter_notice_spec.rb
+- spec/notice_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+- spec/support/user.rb