notify_on 1.0.1

data/spec/mailers/previews/notify_on/notification_mailer_preview.rb

@@ -0,0 +1,6 @@
+module NotifyOn
+  # Preview all emails at http://localhost:3000/rails/mailers/notification_mailer
+  class NotificationMailerPreview < ActionMailer::Preview
+
+  end
+end

data/spec/models/notify_on/notification_spec.rb

@@ -0,0 +1,335 @@
+require 'rails_helper'
+
+module NotifyOn
+  RSpec.describe Notification, :type => :model do
+
+    before(:each) do
+      @message = create(:message)
+      @n = first_notification
+    end
+
+    describe 'self#mark_read_for, self#unread' do
+      it 'will mark read by a single recipient and trigger' do
+        NotifyOn::Notification.mark_read_for(@message.user, @message)
+        expect(@n.reload.unread?).to eq(false)
+      end
+      it 'will mark read those matching an array of recipients and triggers' do
+        Message.destroy_all
+        messages = create_list(:message, 10)
+        read_msgs = messages.first(5)
+        unread_msgs = messages - read_msgs
+        recipients = read_msgs.collect(&:user)
+        NotifyOn::Notification.mark_read_for(recipients, read_msgs)
+        read_msgs.each { |m| expect(m.notifications[0].unread?).to eq(false) }
+        unread_msgs.each { |m| expect(m.notifications[0].unread?).to eq(true) }
+        unread = unread_msgs.collect(&:notifications).flatten
+        expect(NotifyOn::Notification.unread.to_a).to match_array(unread)
+      end
+    end
+
+    describe '#read?, #read!' do
+      it 'sets unread to false' do
+        expect(@n.unread?).to eq(true)
+        expect(@n.read?).to eq(false)
+        @n.read!
+        expect(@n.reload.unread?).to eq(false)
+        expect(@n.read?).to eq(true)
+      end
+    end
+
+    describe '#link' do
+      it 'caches an interpolated link and returns it' do
+        expect(@n.link_cached).to eq("/messages/#{@message.id}")
+        expect(@n.link).to eq(@n.link_cached)
+      end
+      it 'falls back to converting the raw link when not cached' do
+        @n.update_columns(:link_cached => nil)
+        expect(@n.reload.link_cached).to eq(nil)
+        expect(@n.link).to eq("/messages/#{@message.id}")
+      end
+      it 'returns nil when both raw and cached are missing' do
+        @n.update_columns(:link_cached => nil, :link_raw => nil)
+        expect(@n.reload.link).to eq(nil)
+      end
+    end
+
+    describe '#description' do
+      before(:each) { @desc = "#{@message.author.email} sent you a message." }
+      it 'caches an interpolated description and returns it' do
+        expect(@n.description_cached).to eq(@desc)
+        expect(@n.description).to eq(@n.description_cached)
+      end
+      it 'falls back to converting the raw description when not cached' do
+        @n.update_columns(:description_cached => nil)
+        expect(@n.reload.description_cached).to eq(nil)
+        expect(@n.description).to eq(@desc)
+      end
+      it 'returns nil when both raw and cached are missing' do
+        @n.update_columns(:description_cached => nil, :description_raw => nil)
+        expect(@n.reload.description).to eq(nil)
+      end
+    end
+
+    describe '#opts' do
+      it 'uses method_missing to convert "options" to Hashie::Mash' do
+        expect(@n.opts).to eq(Hashie::Mash.new(@n.options))
+      end
+      it 'returns a blank Mash when options is nil' do
+        @n.update_columns(:options => nil)
+        expect(@n.opts).to eq(Hashie::Mash.new)
+      end
+    end
+
+    # ---------------------------------------- String Interpolation
+
+    describe 'StringInterpolation' do
+      let(:n) { build(:notification) }
+      describe '#convert_string' do
+        it 'returns nil when given nil' do
+          expect(n.send(:convert_string, nil)).to eq(nil)
+        end
+        it 'returns the string if given as plain text' do
+          str = Faker::Lorem.sentence
+          expect(n.send(:convert_string, str)).to eq(str)
+        end
+        it 'interpolates the environment' do
+          str = Faker::Lorem.sentence
+          expect(n.send(:convert_string, "#{str} {:env}")).to eq("#{str} test")
+        end
+        it "interpolates the recipient's id" do
+          input = "#{str = Faker::Lorem.sentence} {:recipient_id}"
+          output = "#{str} #{n.recipient.id}"
+          expect(n.send(:convert_string, input)).to eq(output)
+        end
+        it 'interpolates methods on the trigger' do
+          input = 'Message #{id}: {content}'
+          output = "Message ##{n.trigger.id}: #{n.trigger.content}"
+          expect(n.send(:convert_string, input)).to eq(output)
+        end
+        it 'falls back to notification methods when undefined on trigger' do
+          input = 'Message #{id}: {description}'
+          output = "Message ##{n.trigger.id}: #{n.description}"
+          expect(n.send(:convert_string, input)).to eq(output)
+        end
+        it 'throws an error when method does not exist on trigger or self' do
+          input = '{blah_blah}'
+          expect { n.send(:convert_string, input) }.to raise_error(NoMethodError)
+        end
+        it 'supports daisy-chaining methods' do
+          input = 'Message From: {author.email}'
+          output = "Message From: #{n.trigger.author.email}"
+          expect(n.send(:convert_string, input)).to eq(output)
+        end
+      end
+      describe '#convert_link' do
+        it 'returns nil when given nil' do
+          expect(n.send(:convert_link, nil)).to eq(nil)
+        end
+        it 'resolves multiple arguments' do
+          input = 'user_message_path(:author, :self)'
+          output = "/users/#{n.trigger.author.id}/messages/#{n.trigger.id}"
+          expect(n.send(:convert_link, input)).to eq(output)
+        end
+        it 'leaves argument strings alone' do
+          input = 'user_message_path(author, :self)'
+          output = "/users/author/messages/#{n.trigger.id}"
+          expect(n.send(:convert_link, input)).to eq(output)
+        end
+      end
+    end
+
+    # ---------------------------------------- Pusher Support
+
+    describe 'PusherSupport' do
+      let(:n) { create(:notification) }
+
+      context 'can not push' do
+        describe '#can_push?' do
+          it 'returns false' do
+            NotifyOn.configure { |config| config.use_pusher_by_default = false }
+            expect(n.send(:can_push?)).to eq(false)
+          end
+          it 'would return true if we change the default config' do
+            NotifyOn.configure { |config| config.use_pusher_by_default = true }
+            expect(n.send(:can_push?)).to eq(true)
+            NotifyOn.configure { |config| config.use_pusher_by_default = false }
+          end
+        end
+        describe '#pusher_channel_name' do
+          it 'returns nil' do
+            expect(n.pusher_channel_name).to eq(nil)
+          end
+        end
+        describe '#pusher_event_name' do
+          it 'returns nil' do
+            expect(n.pusher_event_name).to eq(nil)
+          end
+        end
+        describe '#pusher_attrs' do
+          it 'returns nil' do
+            expect(n.pusher_attrs).to eq(nil)
+          end
+        end
+      end
+
+      context 'can push' do
+        before(:each) do
+          opts = n.options
+          opts[:pusher] = {
+            :channel => 'presence-{:env}-message-{id}',
+            :event => :new_message
+          }
+          n.options = opts
+          n.save!
+        end
+        describe '#pusher_channel_name' do
+          it 'uses string interpolation to build channel name' do
+            exp_channel_name = "presence-test-message-#{n.trigger.id}"
+            expect(n.pusher_channel_name).to eq(exp_channel_name)
+          end
+        end
+        describe '#pusher_event_name' do
+          it 'uses the specified option' do
+            expect(n.pusher_event_name).to eq('new_message')
+          end
+        end
+        describe '#pusher_attrs' do
+          it 'sets up default attributes' do
+            attrs = {
+              :notification => n.to_json,
+              :trigger => n.trigger.to_json,
+              :data => nil
+            }
+            expect(n.pusher_attrs).to eq(attrs)
+          end
+          it 'will define custom variables' do
+            n.options[:pusher][:data] = { :is_chat => true }
+            n.save!
+            attrs = {
+              :notification => n.to_json,
+              :trigger => n.trigger.to_json,
+              :data => { :is_chat => true }
+            }
+            expect(n.pusher_attrs).to eq(attrs)
+          end
+        end
+      end
+
+    end
+
+    # ---------------------------------------- Email Support
+
+    describe 'EmailSupport' do
+      let(:n) { build(:notification) }
+
+      def update_email_config(config)
+        n.options[:email] = config
+        n.save!
+      end
+
+      describe '#email_config, #email_enabled?, #email_disabled?, #email_config?' do
+        it 'is disabled if no config' do
+          update_email_config(nil)
+          expect(n.send(:email_config)).to eq(nil)
+          expect(n.send(:email_config?)).to eq(false)
+          expect(n.send(:email_enabled?)).to eq(false)
+          expect(n.send(:email_disabled?)).to eq(true)
+        end
+        it 'is enabled if only set to "true"' do
+          update_email_config(true)
+          expect(n.send(:email_config)).to eq(Hashie::Mash.new)
+          expect(n.send(:email_config?)).to eq(true)
+          expect(n.send(:email_enabled?)).to eq(true)
+          expect(n.send(:email_disabled?)).to eq(false)
+        end
+        it 'is enabled if given arguments' do
+          update_email_config(:template => 'new_message')
+          expect(n.send(:email_config))
+            .to eq(Hashie::Mash.new(:template => 'new_message'))
+          expect(n.send(:email_config?)).to eq(true)
+          expect(n.send(:email_enabled?)).to eq(true)
+          expect(n.send(:email_disabled?)).to eq(false)
+        end
+      end
+
+      describe '#can_send_email?' do
+        it 'returns false if email is disabled' do
+          update_email_config(false)
+          expect(n.send(:can_send_email?)).to eq(false)
+        end
+        it 'returns true if email enabled and "unless" not specified' do
+          update_email_config(true)
+          expect(n.send(:can_send_email?)).to eq(true)
+        end
+        it 'returns false if "unless" resolves to true' do
+          n.define_singleton_method(:unless_method?) do
+            true
+          end
+          update_email_config(:unless => :unless_method?)
+          expect(n.send(:can_send_email?)).to eq(false)
+        end
+        it 'returns true if "unless" resolves to false' do
+          n.define_singleton_method(:unless_method?) do
+            false
+          end
+          update_email_config(:unless => :unless_method?)
+          expect(n.send(:can_send_email?)).to eq(true)
+        end
+      end
+
+      describe '#email_template' do
+        it 'returns nil if there is no config' do
+          update_email_config(nil)
+          expect(n.email_template).to eq(nil)
+        end
+        it 'returns "notify" if email config exists, but template is missing' do
+          update_email_config(true)
+          expect(n.email_template).to eq('notify')
+        end
+        it 'returns the template if specified' do
+          update_email_config({ :template => 'new_message' })
+          expect(n.email_template).to eq('new_message')
+        end
+      end
+
+      describe '#email_from, #email_from_raw' do
+        it 'returns the default address if email is disabled' do
+          update_email_config(nil)
+          expect(n.email_from).to eq('NotifyOn <noreply@example.com>')
+        end
+        it 'returns the address if specified' do
+          update_email_config(:from => 'Paul McCartney <paul@thebeatles.com>')
+          expect(n.email_from).to eq('Paul McCartney <paul@thebeatles.com>')
+        end
+      end
+
+      describe '#email_subject' do
+        it 'falls back to the description' do
+          update_email_config(nil)
+          expect(n.email_subject).to eq(n.description)
+        end
+        it 'returns the subject if specified' do
+          update_email_config(:subject => (subj = Faker::Lorem.sentence))
+          expect(n.email_subject).to eq(subj)
+        end
+      end
+
+      describe '#email_attachments' do
+        it 'resolves the calls to methods on the trigger' do
+          update_email_config(:attachments => { :pdf_filename => :pdf_file })
+          attachment = { :name => 'myfile.pdf', :file => n.trigger.pdf_file }
+          expect(n.email_attachments).to match_array([attachment])
+        end
+        it 'throws an error when the file method does not exist' do
+          update_email_config(:attachments => { :pdf_filename => :wrong! })
+          expect { n.email_attachments }.to raise_error(RuntimeError)
+        end
+        it 'falls back to a string when the filename method does not exist' do
+          update_email_config(:attachments => { :wrong => :pdf_file })
+          expect(n.email_attachments[0][:name]).to eq('wrong')
+        end
+      end
+    end
+
+  end
+end

data/spec/rails_helper.rb

@@ -0,0 +1,95 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV['RAILS_ENV'] ||= 'test'
+require File.expand_path("../dummy/config/environment", __FILE__)
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require 'faker'
+require 'database_cleaner'
+require 'spec_helper'
+require 'rspec/rails'
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+Dir[File.expand_path('../support/**/*.rb', __FILE__)].each { |f| require f }
+
+# Checks for pending migration and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove this line.
+ActiveRecord::Migration.maintain_test_schema!
+
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, :type => :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+
+  config.before(:suite) do
+    FactoryGirl.definition_file_paths << File
+      .expand_path("../dummy/spec/factories", __FILE__)
+    # puts FactoryGirl.definition_file_paths.class.to_s
+    FactoryGirl.find_definitions
+  end
+
+  config.before(:suite) do
+    Warden.test_mode!
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.before(:each) do
+    # DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each, :js => true) do
+    DatabaseCleaner.strategy = :truncation
+    page.driver.resize(1600, 1200)
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+    ActionMailer::Base.deliveries = []
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+    Warden.test_reset!
+  end
+
+  config.include Devise::Test::ControllerHelpers, :type => :controller
+  config.include Warden::Test::Helpers, :type => :feature
+  config.include FeatureHelpers, :type => :feature
+  config.include GeneralHelpers
+end

data/spec/spec_helper.rb

@@ -0,0 +1,103 @@
+require 'factory_girl'
+
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # This allows 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. RSpec also provides
+  # aliases for `it`, `describe`, and `context` that include `:focus`
+  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  config.filter_run_when_matching :focus
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  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
+
+  config.include FactoryGirl::Syntax::Methods
+end