gritter_notices 0.1.1 → 0.2.0

data/Gemfile

@@ -4,16 +4,17 @@ source "http://rubygems.org"
 #   gem "activesupport", ">= 2.3.5"
 
 gem 'gritter'
-gem 'activerecord'
-gem 'actionpack'
+gem 'activerecord', "~> 3.0"
+gem 'actionpack', "~> 3.0"
 
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem 'activerecord-nulldb-adapter'
+group :development, :test do
+  gem 'sqlite3'
   gem 'factory_girl'
   gem 'shoulda'
-  gem "rspec", "~> 2.3.0"
+  gem "rspec", "~> 2.5.0"
+  gem 'rspec-rails'
   gem "bundler", "~> 1.0.0"
   gem "jeweler", "~> 1.5.2"
   gem "rcov", ">= 0"

data/README.rdoc

@@ -6,6 +6,8 @@
 
 Визуально выглядит так: http://boedesign.com/demos/gritter/
 
+Модуль родился и активно используется в проекте http://planposter.com/
+
 == Установка
 
 Включаем модуль в Gemfile, незабываем затем сделать bundle install:
@@ -28,7 +30,7 @@
        = include_gritter
     %body
        = gflash // session сообщения добавляемые через gritter-овский gflash :success=>траляля
-       = gritter_flash_messages // Все остальные сообщения добавляемые через flash[:success] или notice
+       = gritter_flash_messages // Все остальные сообщения добавляемые через вызовы типа flash[:success] или user.notice_*
 
 == Использование
 
@@ -79,7 +81,7 @@
 
 == TODO
 
-Удалять gritter_notice только после того как они закроются или их закроют
+1. Удалять gritter_notice только после того как они закроются или их закроют
 
 Контроллер gritter_notices с одной акцией delivered. Ставить ее запуск на onclose. Сделать настраиваемым текущее поведение:
 
@@ -87,6 +89,8 @@
    2. notices помечаются удаленными когда закрываются (сами или принудительно) onclose
    3. обычные notices по методу 1, sticky notices по методу 2.
 
+2. Показывать push-сообщения
+
 
 == Credits
 * Robin Brouwer https://github.com/RobinBrouwer/gritter

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/app/models/gritter_notice.rb

@@ -19,6 +19,7 @@ class GritterNotice < ActiveRecord::Base
 
   serialize :options, Hash
 
+  before_validation :set_options
   validates_presence_of :owner, :message
 
   def fresh?
@@ -40,4 +41,10 @@ class GritterNotice < ActiveRecord::Base
       update_attribute :delivered_at, Time.now
     end
   end
+
+  private
+
+  def set_options
+    self.options={} unless self.options
+  end
 end

data/gritter_notices.gemspec

@@ -0,0 +1,98 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{gritter_notices}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Danil Pismenny"]
+  s.date = %q{2011-03-29}
+  s.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.}
+  s.email = %q{danil@orionet.ru}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "app/models/gritter_notice.rb",
+    "gritter_notices.gemspec",
+    "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/owner_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/factories.rb",
+    "spec/support/migration.rb",
+    "spec/support/user.rb",
+    "spec/view_helpers_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/dapi/gritter_notices}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.0}
+  s.summary = %q{Show flashes and saved user's notices with Gritter (growl-like jQuery plugin)}
+  s.test_files = [
+    "spec/gritter_notice_spec.rb",
+    "spec/owner_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/factories.rb",
+    "spec/support/migration.rb",
+    "spec/support/user.rb",
+    "spec/view_helpers_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<gritter>, [">= 0"])
+      s.add_runtime_dependency(%q<activerecord>, ["~> 3.0"])
+      s.add_runtime_dependency(%q<actionpack>, ["~> 3.0"])
+      s.add_development_dependency(%q<sqlite3>, [">= 0"])
+      s.add_development_dependency(%q<factory_girl>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<gritter>, [">= 0"])
+      s.add_dependency(%q<activerecord>, ["~> 3.0"])
+      s.add_dependency(%q<actionpack>, ["~> 3.0"])
+      s.add_dependency(%q<sqlite3>, [">= 0"])
+      s.add_dependency(%q<factory_girl>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+      s.add_dependency(%q<rspec-rails>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<gritter>, [">= 0"])
+    s.add_dependency(%q<activerecord>, ["~> 3.0"])
+    s.add_dependency(%q<actionpack>, ["~> 3.0"])
+    s.add_dependency(%q<sqlite3>, [">= 0"])
+    s.add_dependency(%q<factory_girl>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.5.0"])
+    s.add_dependency(%q<rspec-rails>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/lib/gritter_notices/active_record.rb

@@ -20,11 +20,13 @@ module GritterNotices::ActiveRecord
     def notice *args
       options = args.extract_options!
       message = args.first || options[:message]
-      options = {:scope=>:gritter_notices, :level=>:notice}.merge options
+      options = {:scope=>:gritter_notices}.merge options
       if message.is_a? Symbol
         options[:gritter_message_key] = message
+        options[:level] = message unless options[:level]
         message = I18n::translate(message, options)
       end
+      options[:level]=:notice unless options[:level]
       gritter_notices.create! :message=>message, :options=>options
     end
 

data/lib/gritter_notices/view_helpers.rb

@@ -1,7 +1,9 @@
 # -*- coding: utf-8 -*-
-
+require 'gritter'
 module GritterNotices::ViewHelpers
 
+  include Gritter::Helpers
+
   GRITTER_CONVERT_KEYS = { :info=>:notice, :alert=>:warning, :failure=>:error, :other=>:notice }.
     merge Hash[*GritterNotices::KEYS.map {|k| [k,k]}.flatten]
 
@@ -16,31 +18,40 @@ module GritterNotices::ViewHelpers
   def gritter_flash_messages *args
     options = args.extract_options!
     titles = gflash_titles(options)
-    flashes = []
+    gritters = []
 
     # Собираем flash-сообщения
-    flash.each_pair do |key, message_array|
+    add_flashes_to_gritters( gritters, flash, titles )
+    add_notices_to_gitters( gritters,
+      current_user.gritter_notices.fresh, titles) if defined?(current_user) and current_user.respond_to?(:gritter_notices)
+
+    js(gritters).html_safe unless gritters.empty?
+  end
+
+  def add_notices_to_gitters(gritters, list, titles)
+    list.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]
+      gritters << add_gritter(notice.message, options)
+      notice.mark_as_delivered
+    end
+  end
+
+  def add_flashes_to_gritters(gritters, list, titles)
+    list.each_pair do |key, message_array|
+      next unless 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)
+        gritters << 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

data/spec/gritter_notice_spec.rb

@@ -2,11 +2,24 @@
 require 'spec_helper'
 
 describe GritterNotice do
-  it { should belong_to(:user) }
-  it { should validate_presence_of(:user) }
+  it { should belong_to(:owner) }
+  it { should validate_presence_of(:owner) }
   it { should validate_presence_of(:message) }
-  context "помечается как доставленная" do
+  it { should be_fresh }
+  it { should_not be_delivered }
+
+  describe '#mark_as_delivered' do
     subject { Factory :notice }
-    it { should_not be_delivered }
+    it 'destroys after delivering' do
+      subject.should_receive(:destroy_after_deliver?) { true }
+      subject.mark_as_delivered
+      subject.should be_destroyed
+    end
+
+    it 'marks as delivered after delivering' do
+      subject.should_receive(:destroy_after_deliver?) { false }
+      subject.mark_as_delivered
+      subject.should be_delivered
+    end
   end
 end

data/spec/owner_spec.rb

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe User do
+  specify { User.should respond_to(:has_gritter_notices) }
+  it { should have_many(:gritter_notices) }
+
+  describe '#notice' do
+    subject { Factory :user }
+
+    it 'gets message with string' do
+      subject.notice 'some text'
+      subject.should have_gritter_notice('some text')
+      subject.gritter_notices.last.options[:level].should == :notice
+      subject.gritter_notices.last.options[:gritter_message_key].should == nil
+    end
+
+    it 'gets message with attribute' do
+      subject.notice :message=>'some text2', :level=>:success
+      subject.should have_gritter_notice('some text2')
+      subject.gritter_notices.last.options[:gritter_message_key].should be_nil
+      subject.gritter_notices.last.options[:level].should == :success
+    end
+
+    it 'gets message with symbol' do
+      subject.notice :warning
+      last = subject.gritter_notices.last
+      last.message.should == 'translation missing: en.gritter_notices.warning'
+      last.options[:gritter_message_key].should == :warning
+      last.options[:level].should == :warning
+    end
+
+    it 'catches messages as missed method' do
+      subject.notice_error 'big problem'
+      subject.should have_gritter_notice('big problem')
+      subject.gritter_notices.last.options[:level].should == :error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,28 +1,47 @@
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'bundler'
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
+
+ENV["RAILS_ENV"] ||= 'test'
+
 require 'active_record'
 require 'action_view'
-# require 'nulldb_rspec'
-# include NullDB::RSpec::NullifiedDatabase
+require 'action_controller'
 
+require 'rspec'
+require 'rspec/rails'
+require 'shoulda'
 
 require 'gritter_notices'
 
-require 'app/models/gritter_notice'
+# require 'nulldb_rspec'
+# include NullDB::RSpec::NullifiedDatabase
 
-require 'factory_girl'
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3',
+  # :database=>'/tmp/gritter_notices.sqlite3'
+  :database => ":memory:"
+)
+#ActiveRecord::Base.logger = Logger.new(File.open('log/database.log', 'a'))
+
+require 'lib/generators/templates/migration'
+CreateGritterNoticesTable.migrate :up
 
+require 'spec/support/migration'
+CreateUsersTable.migrate :up
 
-#   Factory.definition_file_paths = [
-#   File.join(Rails.root, 'spec', 'factories')
-# ]
+require 'spec/support/user'
 
+require 'app/models/gritter_notice'
+
+require 'factory_girl'
+require 'spec/support/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}
+# Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
 RSpec.configure do |config|
-
+  config.include GritterNotices::RSpecMatcher
 end

data/spec/support/factories.rb

@@ -3,6 +3,6 @@ Factory.define :user do |u|
 end
 
 Factory.define :notice, :class=>'GritterNotice' do |f|
-  f.association :user
+  f.association :owner, :factory=>:user
   f.message "MyText"
 end

data/spec/support/migration.rb

@@ -0,0 +1,7 @@
+class CreateUsersTable < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string :name
+    end
+  end
+end

data/spec/view_helpers_spec.rb

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+
+describe GritterNotices::ViewHelpers, :type => :helper  do
+  before do
+    @user = Factory :user
+    helper.stub!(:current_user) { @user }
+  end
+
+  let(:current_user) { @user }
+  # let(:flash) { {:success=>'Success',:error=>['Error1','Error2']} }
+
+  describe '#gritter_flash_messages' do
+    it 'safe run with not current_user defined' do
+      helper.unstub :current_user
+      expect { helper.gritter_flash_messages }.should_not raise_error
+    end
+
+    it 'does not run js() if there it no gritters' do
+      helper.should_not_receive(:js)
+      helper.gritter_flash_messages
+    end
+
+    it 'collects flashes and users notices and run js()' do
+
+      flash[:error]='Error'
+      flash[:success]=['Success1','Success2']
+      flash[:info]=nil
+      current_user.notice :progress
+      current_user.notice_warning 'Warning'
+
+      compiled_gritters = [
+        "$.gritter.add({image:'/images/gritter/error.png',title:'translation missing: en.gflash.titles.error',text:'Error'});",
+        "$.gritter.add({image:'/images/gritter/success.png',title:'translation missing: en.gflash.titles.success',text:'Success1'});",
+        "$.gritter.add({image:'/images/gritter/success.png',title:'translation missing: en.gflash.titles.success',text:'Success2'});",
+        "$.gritter.add({image:'/images/gritter/progress.png',title:'translation missing: en.gflash.titles.progress',text:'translation missing: en.gritter_notices.progress'});",
+        "$.gritter.add({image:'/images/gritter/warning.png',title:'translation missing: en.gflash.titles.warning',text:'Warning'});"]
+      helper.should_receive(:js).with(compiled_gritters) { mock :html_safe=>true }
+      helper.gritter_flash_messages
+    end
+  end
+
+  describe '#move_gritter_notices_to_flashes' do
+    specify do
+      notice = mock :level=>:level, :message=>:message
+      notice.should_receive(:mark_as_delivered).twice
+      current_user.stub_chain('gritter_notices.fresh') {[notice,notice]}
+      helper.should_receive(:append_flash_message).twice
+      helper.move_gritter_notices_to_flashes
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: gritter_notices
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Danil Pismenny
@@ -37,12 +37,13 @@ dependencies:
   version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 7
         segments: 
+        - 3
         - 0
-        version: "0"
+        version: "3.0"
   prerelease: false
   type: :runtime
   requirement: *id002
@@ -51,17 +52,18 @@ dependencies:
   version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 7
         segments: 
+        - 3
         - 0
-        version: "0"
+        version: "3.0"
   prerelease: false
   type: :runtime
   requirement: *id003
 - !ruby/object:Gem::Dependency 
-  name: activerecord-nulldb-adapter
+  name: sqlite3
   version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -109,18 +111,32 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 27
         segments: 
         - 2
-        - 3
+        - 5
         - 0
-        version: 2.3.0
+        version: 2.5.0
   prerelease: false
   type: :development
   requirement: *id007
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: rspec-rails
   version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -133,10 +149,10 @@ dependencies:
         version: 1.0.0
   prerelease: false
   type: :development
-  requirement: *id008
+  requirement: *id009
 - !ruby/object:Gem::Dependency 
   name: jeweler
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  version_requirements: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -149,10 +165,10 @@ dependencies:
         version: 1.5.2
   prerelease: false
   type: :development
-  requirement: *id009
+  requirement: *id010
 - !ruby/object:Gem::Dependency 
   name: rcov
-  version_requirements: &id010 !ruby/object:Gem::Requirement 
+  version_requirements: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -163,7 +179,7 @@ dependencies:
         version: "0"
   prerelease: false
   type: :development
-  requirement: *id010
+  requirement: *id011
 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: []
@@ -180,6 +196,7 @@ files:
 - Rakefile
 - VERSION
 - app/models/gritter_notice.rb
+- gritter_notices.gemspec
 - lib/generators/gritter_notices_generator.rb
 - lib/generators/templates/migration.rb
 - lib/gritter_notices.rb
@@ -187,10 +204,12 @@ files:
 - lib/gritter_notices/rspec_matcher.rb
 - lib/gritter_notices/view_helpers.rb
 - spec/gritter_notice_spec.rb
-- spec/notice_spec.rb
+- spec/owner_spec.rb
 - spec/spec_helper.rb
 - spec/support/factories.rb
+- spec/support/migration.rb
 - spec/support/user.rb
+- spec/view_helpers_spec.rb
 has_rdoc: true
 homepage: http://github.com/dapi/gritter_notices
 licenses: 
@@ -227,7 +246,9 @@ 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/owner_spec.rb
 - spec/spec_helper.rb
 - spec/support/factories.rb
+- spec/support/migration.rb
 - spec/support/user.rb
+- spec/view_helpers_spec.rb

data/spec/notice_spec.rb

@@ -1,12 +0,0 @@
-# -*- 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