notifly 0.0.3 → 0.0.4

data/spec/dummy/spec/features/notifly/counter_spec.rb

@@ -0,0 +1,38 @@
+require 'rails_helper'
+
+describe 'Notifly counter', :type => :feature, js: true do
+  before(:each) do
+    receiver = DummyObject.create! name: 'User'
+    Notifly::Notification.create! receiver: receiver, seen: true, read: false
+    Notifly::Notification.create! receiver: receiver, seen: false, read: false
+    Notifly::Notification.create! receiver: receiver, seen: false, read: false
+    Notifly::Notification.create! receiver: receiver, seen: false, read: false
+    Notifly::Notification.create! receiver: DummyObject.create!, seen: false, read: false
+    Notifly::Notification.create! receiver: DummyObject.create!, seen: false, read: false
+    Notifly.per_page = 2
+
+    visit root_path
+  end
+
+  after(:each) do
+    Notifly.per_page = 10
+  end
+
+  scenario 'seeing notifications' do
+    within("#notifly-counter") do
+      expect(page).to have_content '3'
+    end
+
+    wait_for_ajax { find('#notifly-icon').click }
+
+    within("#notifly-counter") do
+      expect(page).to have_content '1'
+    end
+
+    click_ajax_link 'More'
+
+    within("#notifly-counter") do
+      expect(page).to_not have_content '1'
+    end
+  end
+end

data/spec/dummy/spec/features/notifly/loading_notifications_spec.rb

@@ -0,0 +1,38 @@
+require 'rails_helper'
+
+describe 'Loading notifications', :type => :feature, js: true do
+  before(:each) do
+    @receiver = DummyObject.create! name: 'User'
+    13.times { Notifly::Notification.create! receiver: @receiver, template: :default, read: false }
+    Notifly::Notification.create! receiver: DummyObject.create!, template: :default
+    Notifly::Notification.create! receiver: DummyObject.create!, template: :default
+    visit root_path
+  end
+
+  scenario 'loading notifications in background when user hover notifly' do
+    within("#notifly") do
+      expect(page).to_not have_css('div.notifly-notification', visible: false)
+    end
+
+    wait_for_ajax { find('#notifly-icon').click }
+
+    within('#notifly') do
+      expect(page).to have_css('div.notifly-notification', count: 10, visible: false)
+    end
+  end
+
+  scenario 'loading next page link' do
+    href_with_page = notifly.notifications_path(page: 2)
+    wait_for_ajax { find('#notifly-icon').click }
+    within('#notifly-notifications-footer') do
+      expect(page).to have_xpath("//a[@href=\"#{href_with_page}\"]")
+    end
+
+
+    click_ajax_link 'More'
+
+    within('#notifly-notifications-footer') do
+      expect(page).to_not have_xpath("//a[@href=\"#{href_with_page}\"]")
+    end
+  end
+end

data/spec/dummy/spec/features/notifly/read_notifications_spec.rb

@@ -0,0 +1,70 @@
+require 'rails_helper'
+
+describe 'Read notification', :type => :feature, js: true do
+  before do
+    @receiver = DummyObject.create! name: 'User'
+    @n_1 = Notifly::Notification.create! receiver: @receiver, read: false
+    @n_2 = Notifly::Notification.create! receiver: @receiver, read: false
+    @n_3 = Notifly::Notification.create! receiver: @receiver, read: false
+    Notifly.per_page = 2
+  end
+
+  after(:each) do
+    Notifly.per_page = 10
+  end
+
+  let(:open_notifly) do
+    visit root_path
+    wait_for_ajax { find('#notifly-icon').click }
+  end
+
+  context 'when read a specific notification' do
+    scenario 'read a notification' do
+      open_notifly
+
+      notification_id = "#notifly-notification-#{@n_2.id}"
+      expect(page).to have_selector ("#{notification_id}.notifly-notification-not-read")
+
+      within(notification_id) do
+        click_ajax_link 'read'
+      end
+
+      expect(page).to     have_selector (notification_id)
+      expect(page).to_not have_selector ("#{notification_id}.notifly-notification-not-read")
+    end
+
+    scenario 'unread a notification' do
+      notification = Notifly::Notification.create! receiver: @receiver, read: true
+      notification_id = "#notifly-notification-#{notification.id}"
+      open_notifly
+      expect(page).to have_selector (notification_id)
+      expect(page).to_not have_selector ("#{notification_id}.notifly-notification-not-read")
+
+      within(notification_id) do
+        click_ajax_link 'unread'
+      end
+
+      expect(page).to have_selector ("#{notification_id}.notifly-notification-not-read")
+    end
+  end
+
+  scenario 'mark all read' do
+    open_notifly
+
+    expect(page).to     have_selector ("#notifly-notification-#{@n_3.id}.notifly-notification-not-read")
+    expect(page).to     have_selector ("#notifly-notification-#{@n_2.id}.notifly-notification-not-read")
+    expect(page).to_not have_selector ("#notifly-notification-#{@n_1.id}")
+
+    within('#notifly') do
+      click_ajax_link 'Mark as read'
+      click_ajax_link 'More'
+    end
+
+    expect(page).to     have_selector ("#notifly-notification-#{@n_3.id}")
+    expect(page).to     have_selector ("#notifly-notification-#{@n_2.id}")
+    expect(page).to     have_selector ("#notifly-notification-#{@n_1.id}.notifly-notification-not-read")
+
+    expect(page).to_not have_selector ("#notifly-notification-#{@n_3.id}.notifly-notification-not-read")
+    expect(page).to_not have_selector ("#notifly-notification-#{@n_2.id}.notifly-notification-not-read")
+  end
+end

data/spec/dummy/spec/models/dummy_object_spec.rb

@@ -0,0 +1,58 @@
+require 'rails_helper'
+
+RSpec.describe DummyObject, :type => :model do
+  it { is_expected.to have_many(:posts) }
+
+  describe 'Notifly' do
+    let(:smart)              { DummyObject.create name: 'smart' }
+    let(:dummy)              { DummyObject.create name: nil }
+    let(:notifications)      { Notifly::Notification }
+
+    it 'should return the method return' do
+      expect(smart.buzz).to eql('buzz')
+      expect(dummy.buzz).to eql('buzz')
+
+      expect(smart.update(name: 'smart')).to be_truthy
+      expect(dummy.update(name: 'dummy')).to be_truthy
+    end
+
+    context 'when using ActiveRecord methods' do
+      describe 'class methods' do
+        describe '.create' do
+          it { expect { DummyObject.create name: 'dummy' }.
+            to_not change(notifications.where(template: :create), :count) }
+          it { expect { DummyObject.create name: 'smart' }.
+            to change(notifications.where(template: :create), :count).from(0).to(1) }
+        end
+      end
+
+      describe 'instance methods' do
+        before(:each) do
+          smart
+          dummy
+          notifications.delete_all
+        end
+
+        describe '#save' do
+          it { expect { smart.save! }.to change(notifications.
+            where(template: :save), :count).from(0).to(1) }
+          it { expect { dummy.save! }.to_not change(notifications.
+            where(template: :save), :count) }
+        end
+
+        describe '#update' do
+          it { expect { dummy.update!(name: 'smart') }.to change(notifications.
+            where(template: :update), :count).from(0).to(1) }
+          it { expect { smart.update!(name: 'dummy') }.to_not change(notifications.
+            where(template: :update), :count) }
+        end
+
+        describe '#destroy' do
+          it { expect { smart.destroy! }.to change(notifications, :count).
+            from(0).to(1) }
+          it { expect { dummy.destroy! }.to_not change(notifications, :count) }
+        end
+      end
+    end
+  end
+end

data/spec/dummy/spec/models/post_spec.rb

@@ -0,0 +1,89 @@
+require 'rails_helper'
+
+RSpec.describe Post, :type => :model do
+  it { is_expected.to belong_to(:dummy_object) }
+
+  describe 'Notifly' do
+    let(:dummy)        { DummyObject.create! }
+    let(:post)         { Post.create! dummy_object: dummy, published: false }
+    let(:notification) { Notifly::Notification.take }
+
+    describe 'initialization' do
+      it { expect(Post).to respond_to :notifly }
+    end
+
+    describe 'usage' do
+      it 'should create a notification when is published' do
+        expect(Notifly::Notification.count).to eql 0
+
+        expect { post.publish! }.to change(Notifly::Notification, :count).from(0).to(1)
+        expect(notification.receiver).to eql dummy
+        expect(notification.target).to eql post
+        expect(notification.template).to eql 'publish'
+      end
+
+      describe 'Notification fallback (data)' do
+        it 'should use Notifly::Notification#data for missing informations' do
+          post_attributes = post.attributes
+          expect { post.destroy }.to change(Notifly::Notification, :count).from(0).to(1)
+
+          expect(notification.receiver).to eql dummy
+          expect(notification.template).to eql 'destroy'
+          expect(notification.reload.data).to eql post_attributes
+        end
+      end
+
+      context 'when run notifly by order' do
+        context 'when post title starts with nil' do
+          it 'should send two notifications' do
+            expect { post.change_title }.to change(Notifly::Notification, :count).
+              from(0).to(2)
+
+            expect(Notifly::Notification.first.data['title']).to be_nil
+            expect(Notifly::Notification.last.data['title']).to eql 'NewTitle'
+          end
+        end
+
+        context 'when post title starts with TitleFoo' do
+          it 'should send two notifications' do
+            expect_any_instance_of(Post).to receive(:change_title) { nil }
+            post = Post.create! dummy_object: dummy, title: 'TitleFoo'
+
+            expect { post.change_title }.to_not change(Notifly::Notification, :count)
+          end
+        end
+      end
+    end
+
+    describe '#notifly_notifications' do
+      it 'should show its notifications' do
+        dummy_notification = Notifly::Notification.create! receiver: dummy,
+          sender: post
+        post_notifications = (1..3).map do
+          Notifly::Notification.create! receiver: post, sender: dummy
+        end
+
+        expect(post.notifly_notifications).to     include(*post_notifications)
+        expect(post.notifly_notifications).to_not include(dummy_notification)
+      end
+
+      it 'should query its notifications' do
+        dummy_2 = DummyObject.create
+        notification_1 = Notifly::Notification.create! receiver: post,
+          sender: dummy, template: 'destroy'
+        notification_2 = Notifly::Notification.create! receiver: post,
+          sender: dummy, target: dummy_2
+        notification_3 = Notifly::Notification.create! receiver: post,
+          sender: dummy, target: dummy_2
+
+        destroy_notifications = post.notifly_notifications.where(template: 'destroy')
+        dummy_2_notifications = post.notifly_notifications.where(target: dummy_2)
+
+        expect(destroy_notifications).to     include(notification_1)
+        expect(destroy_notifications).to_not include(notification_2, notification_3)
+        expect(dummy_2_notifications).to     include(notification_2, notification_3)
+        expect(dummy_2_notifications).to_not include(notification_1)
+      end
+    end
+  end
+end

data/spec/models/notifly/notification_spec.rb

@@ -0,0 +1,18 @@
+require 'rails_helper'
+
+module Notifly
+  RSpec.describe Notification, :type => :model do
+    it { is_expected.to validate_presence_of(:receiver) }
+
+    describe '#data' do
+      it 'should save and repond with a hash' do
+        hash = { 'post' => Post.create!.attributes }
+
+        notification = Notifly::Notification.create! receiver: DummyObject.create,
+          template: :foo, data: hash
+
+        expect(notification.reload.data).to eql hash
+      end
+    end
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,21 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require 'spec_helper'
+require File.expand_path("../dummy/config/environment", __FILE__)
+require 'rspec/rails'
+require 'shoulda/matchers'
+require 'capybara/rails'
+require 'capybara/rspec'
+require 'capybara/poltergeist'
+Capybara.javascript_driver = :poltergeist
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each { |f| require f }
+
+# Checks for pending migrations before tests are run.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  config.use_transactional_fixtures = true
+  config.infer_spec_type_from_file_location!
+end

data/spec/spec_helper.rb

@@ -0,0 +1,62 @@
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+RSpec.configure do |config|
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

data/spec/support/shared_connection.rb

@@ -0,0 +1,14 @@
+# http://helabs.com.br/blog/2013/02/06/testes-mais-rapidos-no-rspec
+
+class ActiveRecord::Base
+  mattr_accessor :shared_connection
+  @@shared_connection = nil
+
+  def self.connection
+    @@shared_connection || retrieve_connection
+  end
+end
+
+# Forces all threads to share the same connection. This works on
+# Capybara because it starts the web server in a thread.
+ActiveRecord::Base.shared_connection = ActiveRecord::Base.connection

data/spec/support/suppress_log.rb

@@ -0,0 +1,3 @@
+# http://helabs.com.br/blog/2013/02/06/testes-mais-rapidos-no-rspec
+
+Rails.logger.level = 4 unless ENV['WITH_LOG']

data/spec/support/wait_ajax.rb

@@ -0,0 +1,53 @@
+# Ajax testing with ruby and capybara
+#
+# Add this to spec/support
+#
+# When a link or button starts an ajax request, instead  of use Capybara
+# click_link, click_button and click_link_or_button methods use click_ajax_link,
+# click_ajax_button and click_ajax_link_or_button methods. You can still use
+# capybara methods and right after it, call wait_for_ajax method.
+#
+# This methods will wait until Capybara.default_wait_time for the ajax request
+# to finish before continue the normal tests flow.
+#
+
+require 'timeout'
+
+module WaitForAjax
+  def click_ajax_link(locator, options = {})
+    click_link(locator, options)
+
+    wait_for_ajax
+  end
+
+  def click_ajax_button(locator, options = {})
+    click_button(locator, options)
+
+    wait_for_ajax
+  end
+
+  def click_ajax_link_or_button(locator, options = {})
+    click_link_or_button(locator, options)
+
+    wait_for_ajax
+  end
+
+  def wait_for_ajax(&block)
+    block.call if block
+
+    Timeout.timeout(Capybara.default_wait_time) do
+      loop do
+        sleep 0.1
+        break if finished_all_ajax_requests?
+      end
+    end
+  end
+
+  def finished_all_ajax_requests?
+    page.evaluate_script('jQuery.active').zero?
+  end
+end
+
+RSpec.configure do |config|
+  config.include WaitForAjax
+end