hertz 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (82) hide show
  1. checksums.yaml +7 -0
  2. data/MIT-LICENSE +20 -0
  3. data/README.md +188 -0
  4. data/Rakefile +30 -0
  5. data/app/assets/javascripts/hertz/application.js +13 -0
  6. data/app/assets/stylesheets/hertz/application.css +15 -0
  7. data/app/controllers/hertz/application_controller.rb +6 -0
  8. data/app/helpers/hertz/application_helper.rb +5 -0
  9. data/app/mailers/hertz/notification_mailer.rb +24 -0
  10. data/app/models/hertz/notification.rb +46 -0
  11. data/app/views/layouts/hertz/application.html.erb +14 -0
  12. data/config/routes.rb +2 -0
  13. data/db/migrate/20160415174901_create_hertz_notifications.rb +14 -0
  14. data/lib/generators/hertz/install_generator.rb +11 -0
  15. data/lib/generators/hertz/templates/initializer.rb +5 -0
  16. data/lib/hertz.rb +19 -0
  17. data/lib/hertz/courier/base.rb +10 -0
  18. data/lib/hertz/courier/email.rb +10 -0
  19. data/lib/hertz/engine.rb +6 -0
  20. data/lib/hertz/notifiable.rb +18 -0
  21. data/lib/hertz/notification_deliverer.rb +18 -0
  22. data/lib/hertz/version.rb +4 -0
  23. data/lib/tasks/hertz_tasks.rake +4 -0
  24. data/spec/dummy/README.rdoc +28 -0
  25. data/spec/dummy/Rakefile +6 -0
  26. data/spec/dummy/app/assets/javascripts/application.js +13 -0
  27. data/spec/dummy/app/assets/stylesheets/application.css +15 -0
  28. data/spec/dummy/app/controllers/application_controller.rb +5 -0
  29. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  30. data/spec/dummy/app/mailers/application_mailer.rb +2 -0
  31. data/spec/dummy/app/models/test_notification.rb +7 -0
  32. data/spec/dummy/app/models/user.rb +7 -0
  33. data/spec/dummy/app/views/hertz/notification_mailer/test_notification.html.erb +1 -0
  34. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  35. data/spec/dummy/bin/bundle +3 -0
  36. data/spec/dummy/bin/rails +4 -0
  37. data/spec/dummy/bin/rake +4 -0
  38. data/spec/dummy/bin/setup +29 -0
  39. data/spec/dummy/config.ru +4 -0
  40. data/spec/dummy/config/application.rb +26 -0
  41. data/spec/dummy/config/boot.rb +5 -0
  42. data/spec/dummy/config/database.example.yml +19 -0
  43. data/spec/dummy/config/database.yml +28 -0
  44. data/spec/dummy/config/environment.rb +5 -0
  45. data/spec/dummy/config/environments/development.rb +41 -0
  46. data/spec/dummy/config/environments/production.rb +79 -0
  47. data/spec/dummy/config/environments/test.rb +42 -0
  48. data/spec/dummy/config/initializers/assets.rb +11 -0
  49. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  50. data/spec/dummy/config/initializers/cookies_serializer.rb +3 -0
  51. data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -0
  52. data/spec/dummy/config/initializers/hertz.rb +4 -0
  53. data/spec/dummy/config/initializers/inflections.rb +16 -0
  54. data/spec/dummy/config/initializers/mime_types.rb +4 -0
  55. data/spec/dummy/config/initializers/session_store.rb +3 -0
  56. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  57. data/spec/dummy/config/locales/en.yml +23 -0
  58. data/spec/dummy/config/routes.rb +4 -0
  59. data/spec/dummy/config/secrets.yml +22 -0
  60. data/spec/dummy/db/migrate/20160415175358_create_hertz_notifications.hertz.rb +15 -0
  61. data/spec/dummy/db/migrate/20160415175837_create_users.rb +8 -0
  62. data/spec/dummy/db/migrate/20160418122437_add_email_to_users.rb +5 -0
  63. data/spec/dummy/db/schema.rb +35 -0
  64. data/spec/dummy/log/development.log +136 -0
  65. data/spec/dummy/log/test.log +2618 -0
  66. data/spec/dummy/public/404.html +67 -0
  67. data/spec/dummy/public/422.html +67 -0
  68. data/spec/dummy/public/500.html +66 -0
  69. data/spec/dummy/public/favicon.ico +0 -0
  70. data/spec/examples.txt +13 -0
  71. data/spec/factories/hertz/notifications.rb +14 -0
  72. data/spec/factories/users.rb +6 -0
  73. data/spec/lib/hertz/courier/email_spec.rb +26 -0
  74. data/spec/lib/hertz/notifiable_spec.rb +22 -0
  75. data/spec/lib/hertz/notification_deliverer_spec.rb +31 -0
  76. data/spec/mailers/notification_mailer_spec.rb +13 -0
  77. data/spec/models/hertz/notification_spec.rb +61 -0
  78. data/spec/rails_helper.rb +24 -0
  79. data/spec/spec_helper.rb +73 -0
  80. data/spec/support/database_cleaner.rb +19 -0
  81. data/spec/support/factory_girl.rb +5 -0
  82. metadata +308 -0
@@ -0,0 +1,67 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The page you were looking for doesn't exist (404)</title>
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <style>
7
+ body {
8
+ background-color: #EFEFEF;
9
+ color: #2E2F30;
10
+ text-align: center;
11
+ font-family: arial, sans-serif;
12
+ margin: 0;
13
+ }
14
+
15
+ div.dialog {
16
+ width: 95%;
17
+ max-width: 33em;
18
+ margin: 4em auto 0;
19
+ }
20
+
21
+ div.dialog > div {
22
+ border: 1px solid #CCC;
23
+ border-right-color: #999;
24
+ border-left-color: #999;
25
+ border-bottom-color: #BBB;
26
+ border-top: #B00100 solid 4px;
27
+ border-top-left-radius: 9px;
28
+ border-top-right-radius: 9px;
29
+ background-color: white;
30
+ padding: 7px 12% 0;
31
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
32
+ }
33
+
34
+ h1 {
35
+ font-size: 100%;
36
+ color: #730E15;
37
+ line-height: 1.5em;
38
+ }
39
+
40
+ div.dialog > p {
41
+ margin: 0 0 1em;
42
+ padding: 1em;
43
+ background-color: #F7F7F7;
44
+ border: 1px solid #CCC;
45
+ border-right-color: #999;
46
+ border-left-color: #999;
47
+ border-bottom-color: #999;
48
+ border-bottom-left-radius: 4px;
49
+ border-bottom-right-radius: 4px;
50
+ border-top-color: #DADADA;
51
+ color: #666;
52
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
53
+ }
54
+ </style>
55
+ </head>
56
+
57
+ <body>
58
+ <!-- This file lives in public/404.html -->
59
+ <div class="dialog">
60
+ <div>
61
+ <h1>The page you were looking for doesn't exist.</h1>
62
+ <p>You may have mistyped the address or the page may have moved.</p>
63
+ </div>
64
+ <p>If you are the application owner check the logs for more information.</p>
65
+ </div>
66
+ </body>
67
+ </html>
@@ -0,0 +1,67 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>The change you wanted was rejected (422)</title>
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <style>
7
+ body {
8
+ background-color: #EFEFEF;
9
+ color: #2E2F30;
10
+ text-align: center;
11
+ font-family: arial, sans-serif;
12
+ margin: 0;
13
+ }
14
+
15
+ div.dialog {
16
+ width: 95%;
17
+ max-width: 33em;
18
+ margin: 4em auto 0;
19
+ }
20
+
21
+ div.dialog > div {
22
+ border: 1px solid #CCC;
23
+ border-right-color: #999;
24
+ border-left-color: #999;
25
+ border-bottom-color: #BBB;
26
+ border-top: #B00100 solid 4px;
27
+ border-top-left-radius: 9px;
28
+ border-top-right-radius: 9px;
29
+ background-color: white;
30
+ padding: 7px 12% 0;
31
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
32
+ }
33
+
34
+ h1 {
35
+ font-size: 100%;
36
+ color: #730E15;
37
+ line-height: 1.5em;
38
+ }
39
+
40
+ div.dialog > p {
41
+ margin: 0 0 1em;
42
+ padding: 1em;
43
+ background-color: #F7F7F7;
44
+ border: 1px solid #CCC;
45
+ border-right-color: #999;
46
+ border-left-color: #999;
47
+ border-bottom-color: #999;
48
+ border-bottom-left-radius: 4px;
49
+ border-bottom-right-radius: 4px;
50
+ border-top-color: #DADADA;
51
+ color: #666;
52
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
53
+ }
54
+ </style>
55
+ </head>
56
+
57
+ <body>
58
+ <!-- This file lives in public/422.html -->
59
+ <div class="dialog">
60
+ <div>
61
+ <h1>The change you wanted was rejected.</h1>
62
+ <p>Maybe you tried to change something you didn't have access to.</p>
63
+ </div>
64
+ <p>If you are the application owner check the logs for more information.</p>
65
+ </div>
66
+ </body>
67
+ </html>
@@ -0,0 +1,66 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <title>We're sorry, but something went wrong (500)</title>
5
+ <meta name="viewport" content="width=device-width,initial-scale=1">
6
+ <style>
7
+ body {
8
+ background-color: #EFEFEF;
9
+ color: #2E2F30;
10
+ text-align: center;
11
+ font-family: arial, sans-serif;
12
+ margin: 0;
13
+ }
14
+
15
+ div.dialog {
16
+ width: 95%;
17
+ max-width: 33em;
18
+ margin: 4em auto 0;
19
+ }
20
+
21
+ div.dialog > div {
22
+ border: 1px solid #CCC;
23
+ border-right-color: #999;
24
+ border-left-color: #999;
25
+ border-bottom-color: #BBB;
26
+ border-top: #B00100 solid 4px;
27
+ border-top-left-radius: 9px;
28
+ border-top-right-radius: 9px;
29
+ background-color: white;
30
+ padding: 7px 12% 0;
31
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
32
+ }
33
+
34
+ h1 {
35
+ font-size: 100%;
36
+ color: #730E15;
37
+ line-height: 1.5em;
38
+ }
39
+
40
+ div.dialog > p {
41
+ margin: 0 0 1em;
42
+ padding: 1em;
43
+ background-color: #F7F7F7;
44
+ border: 1px solid #CCC;
45
+ border-right-color: #999;
46
+ border-left-color: #999;
47
+ border-bottom-color: #999;
48
+ border-bottom-left-radius: 4px;
49
+ border-bottom-right-radius: 4px;
50
+ border-top-color: #DADADA;
51
+ color: #666;
52
+ box-shadow: 0 3px 8px rgba(50, 50, 50, 0.17);
53
+ }
54
+ </style>
55
+ </head>
56
+
57
+ <body>
58
+ <!-- This file lives in public/500.html -->
59
+ <div class="dialog">
60
+ <div>
61
+ <h1>We're sorry, but something went wrong.</h1>
62
+ </div>
63
+ <p>If you are the application owner check the logs for more information.</p>
64
+ </div>
65
+ </body>
66
+ </html>
File without changes
@@ -0,0 +1,13 @@
1
+ example_id | status | run_time |
2
+ ------------------------------------------------------ | ------ | --------------- |
3
+ ./spec/lib/hertz/courier/email_spec.rb[1:1:1] | passed | 0.00982 seconds |
4
+ ./spec/lib/hertz/notifiable_spec.rb[1:1:1] | passed | 0.01297 seconds |
5
+ ./spec/lib/hertz/notifiable_spec.rb[1:2:1] | passed | 0.45917 seconds |
6
+ ./spec/lib/hertz/notification_deliverer_spec.rb[1:1:1] | passed | 0.02232 seconds |
7
+ ./spec/mailers/notification_mailer_spec.rb[1:1:1] | passed | 0.1902 seconds |
8
+ ./spec/models/hertz/notification_spec.rb[1:1:1] | passed | 0.00287 seconds |
9
+ ./spec/models/hertz/notification_spec.rb[1:2:1] | passed | 0.00289 seconds |
10
+ ./spec/models/hertz/notification_spec.rb[1:3:1] | passed | 0.01559 seconds |
11
+ ./spec/models/hertz/notification_spec.rb[1:4:1] | passed | 0.00931 seconds |
12
+ ./spec/models/hertz/notification_spec.rb[1:5:1] | passed | 0.02096 seconds |
13
+ ./spec/models/hertz/notification_spec.rb[1:6] | passed | 0.00727 seconds |
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+ FactoryGirl.define do
3
+ factory :notification, class: 'Hertz::Notification' do
4
+ type 'Hertz::Notification'
5
+ association :receiver, factory: :user, strategy: :build
6
+
7
+ trait :read do
8
+ read_at { Time.zone.now }
9
+ end
10
+
11
+ factory :test_notification, class: 'TestNotification' do
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,6 @@
1
+ # frozen_string_literal: true
2
+ FactoryGirl.define do
3
+ factory :user do
4
+ email { Faker::Internet.email }
5
+ end
6
+ end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+ module Hertz
3
+ module Courier
4
+ RSpec.describe Email do
5
+ subject { described_class }
6
+
7
+ describe '.deliver_notification' do
8
+ let(:notification) { instance_double('Hertz::Notification') }
9
+ let(:email) { instance_spy('ActionMailer::MessageDelivery') }
10
+
11
+ before(:each) do
12
+ allow(Hertz::NotificationMailer).to receive(:notification_email)
13
+ .with(notification)
14
+ .and_return(email)
15
+ end
16
+
17
+ it 'sends an email' do
18
+ subject.deliver_notification(notification)
19
+
20
+ expect(email).to have_received(:deliver_later)
21
+ .once
22
+ end
23
+ end
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,22 @@
1
+ # frozen_string_literal: true
2
+ module Hertz
3
+ RSpec.describe Notifiable do
4
+ let(:user) { create(:user) }
5
+
6
+ describe '.notifications' do
7
+ let!(:notification) { create(:notification, receiver: user) }
8
+
9
+ it "returns the receiver's notifications" do
10
+ expect(user.notifications).to eq([notification])
11
+ end
12
+ end
13
+
14
+ describe '#notify' do
15
+ it 'notifies the receiver' do
16
+ expect {
17
+ user.notify(Hertz::Notification.new(type: 'Hertz::Notification'))
18
+ }.to change(user.notifications, :count).by(1)
19
+ end
20
+ end
21
+ end
22
+ end
@@ -0,0 +1,31 @@
1
+ # frozen_string_literal: true
2
+ module Hertz
3
+ RSpec.describe NotificationDeliverer do
4
+ subject { described_class }
5
+
6
+ before(:each) do
7
+ module Courier
8
+ class Test < Base
9
+ def self.deliver_notification(_notification)
10
+ end
11
+ end
12
+ end
13
+
14
+ class TestNotification < Notification
15
+ deliver_by :test
16
+ end
17
+ end
18
+
19
+ describe '#deliver' do
20
+ let(:notification) { TestNotification.new }
21
+
22
+ it 'delivers the notification through the couriers' do
23
+ expect(Hertz::Courier::Test).to receive(:deliver_notification)
24
+ .with(notification)
25
+ .once
26
+
27
+ subject.deliver(notification)
28
+ end
29
+ end
30
+ end
31
+ end
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+ module Hertz
3
+ RSpec.describe NotificationMailer do
4
+ describe '.notification_email' do
5
+ let(:notification) { build_stubbed(:test_notification) }
6
+ subject { described_class.notification_email(notification) }
7
+
8
+ it 'sends the email to the receiver' do
9
+ expect(subject.to).to eq([notification.receiver.email])
10
+ end
11
+ end
12
+ end
13
+ end
@@ -0,0 +1,61 @@
1
+ # frozen_string_literal: true
2
+ module Hertz
3
+ RSpec.describe Notification do
4
+ subject { build(:notification) }
5
+
6
+ describe '#read?' do
7
+ it 'returns whether read_at is present' do
8
+ expect {
9
+ subject.read_at = Time.zone.now
10
+ }.to change(subject, :read?).from(false).to(true)
11
+ end
12
+ end
13
+
14
+ describe '#unread?' do
15
+ it 'returns whether read_at is nil' do
16
+ expect {
17
+ subject.read_at = Time.zone.now
18
+ }.to change(subject, :unread?).from(true).to(false)
19
+ end
20
+ end
21
+
22
+ describe '#mark_as_read' do
23
+ subject { create(:notification) }
24
+
25
+ it 'touches read_at' do
26
+ expect {
27
+ subject.mark_as_read
28
+ }.to change(subject, :read_at).to(
29
+ an_instance_of(ActiveSupport::TimeWithZone)
30
+ )
31
+ end
32
+ end
33
+
34
+ describe '#mark_as_unread' do
35
+ subject { create(:notification, :read) }
36
+
37
+ it 'nullifies read_at' do
38
+ expect {
39
+ subject.mark_as_unread
40
+ }.to change(subject, :read_at).to(nil)
41
+ end
42
+ end
43
+
44
+ describe '.unread' do
45
+ let!(:unread_notification) { create(:notification) }
46
+ let!(:read_notification) { create(:notification, :read) }
47
+
48
+ it 'returns the unread notifications' do
49
+ expect(described_class.unread).to eq([unread_notification])
50
+ end
51
+ end
52
+
53
+ it 'delivers itself upon creation' do
54
+ expect(Hertz::NotificationDeliverer).to receive(:deliver)
55
+ .with(subject)
56
+ .once
57
+
58
+ subject.save!
59
+ end
60
+ end
61
+ end
@@ -0,0 +1,24 @@
1
+ ENV['RAILS_ENV'] ||= 'test'
2
+
3
+ ENGINE_ROOT = File.join(File.dirname(__FILE__), '../')
4
+
5
+ # Load environment.rb from the dummy app.
6
+ require File.expand_path('../dummy/config/environment', __FILE__)
7
+
8
+ abort("The Rails environment is running in production mode!") if Rails.env.production?
9
+ require 'spec_helper'
10
+ require 'rspec/rails'
11
+
12
+ # Load RSpec helpers.
13
+ Dir[File.join(ENGINE_ROOT, 'spec/support/**/*.rb')].each { |f| require f }
14
+
15
+ # Load testing libraries.
16
+ require 'faker'
17
+
18
+ # Load migrations from the dummy app.
19
+ ActiveRecord::Migrator.migrations_paths = File.join(ENGINE_ROOT, 'spec/dummy/db/migrate')
20
+ ActiveRecord::Migration.maintain_test_schema!
21
+
22
+ RSpec.configure do |config|
23
+ config.infer_spec_type_from_file_location!
24
+ end
@@ -0,0 +1,73 @@
1
+ # This file was generated by the `rails generate rspec:install` command. Conventionally, all
2
+ # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
3
+ # The generated `.rspec` file contains `--require spec_helper` which will cause
4
+ # this file to always be loaded, without a need to explicitly require it in any
5
+ # files.
6
+ #
7
+ # Given that it is always loaded, you are encouraged to keep this file as
8
+ # light-weight as possible. Requiring heavyweight dependencies from this file
9
+ # will add to the boot time of your test suite on EVERY test run, even for an
10
+ # individual file that may not need all of that loaded. Instead, consider making
11
+ # a separate helper file that requires the additional dependencies and performs
12
+ # the additional setup, and require it from the spec files that actually need
13
+ # it.
14
+ #
15
+ # The `.rspec` file also contains a few flags that are not defaults but that
16
+ # users commonly want.
17
+ #
18
+ # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
19
+ RSpec.configure do |config|
20
+ # rspec-expectations config goes here. You can use an alternate
21
+ # assertion/expectation library such as wrong or the stdlib/minitest
22
+ # assertions if you prefer.
23
+ config.expect_with :rspec do |expectations|
24
+ # This option will default to `true` in RSpec 4. It makes the `description`
25
+ # and `failure_message` of custom matchers include text for helper methods
26
+ # defined using `chain`, e.g.:
27
+ # be_bigger_than(2).and_smaller_than(4).description
28
+ # # => "be bigger than 2 and smaller than 4"
29
+ # ...rather than:
30
+ # # => "be bigger than 2"
31
+ expectations.include_chain_clauses_in_custom_matcher_descriptions = true
32
+ end
33
+
34
+ # rspec-mocks config goes here. You can use an alternate test double
35
+ # library (such as bogus or mocha) by changing the `mock_with` option here.
36
+ config.mock_with :rspec do |mocks|
37
+ # Prevents you from mocking or stubbing a method that does not exist on
38
+ # a real object. This is generally recommended, and will default to
39
+ # `true` in RSpec 4.
40
+ mocks.verify_partial_doubles = true
41
+ end
42
+
43
+ # These two settings work together to allow you to limit a spec run
44
+ # to individual examples or groups you care about by tagging them with
45
+ # `:focus` metadata. When nothing is tagged with `:focus`, all examples
46
+ # get run.
47
+ config.filter_run :focus
48
+ config.run_all_when_everything_filtered = true
49
+
50
+ # Allows RSpec to persist some state between runs in order to support
51
+ # the `--only-failures` and `--next-failure` CLI options. We recommend
52
+ # you configure your source control system to ignore this file.
53
+ config.example_status_persistence_file_path = 'spec/examples.txt'
54
+
55
+ # Limits the available syntax to the non-monkey patched syntax that is
56
+ # recommended. For more details, see:
57
+ # - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
58
+ # - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
59
+ # - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
60
+ config.disable_monkey_patching!
61
+
62
+ # Run specs in random order to surface order dependencies. If you find an
63
+ # order dependency and want to debug it, you can fix the order by providing
64
+ # the seed, which is printed after each run.
65
+ # --seed 1234
66
+ config.order = :random
67
+
68
+ # Seed global randomization in this process using the `--seed` CLI option.
69
+ # Setting this allows you to use `--seed` to deterministically reproduce
70
+ # test failures related to randomization by passing the same `--seed` value
71
+ # as the one that triggered the failure.
72
+ Kernel.srand config.seed
73
+ end