exception_handler 0.7.5 → 0.8.0.1

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 (109) hide show
  1. checksums.yaml +5 -5
  2. data/.coveralls.yml +1 -0
  3. data/.gitignore +51 -33
  4. data/.rspec +3 -4
  5. data/.slugignore +7 -0
  6. data/.travis.yml +13 -5
  7. data/Gemfile +16 -13
  8. data/README.md +643 -443
  9. data/Rakefile +7 -7
  10. data/app/assets/stylesheets/exception_handler.css.erb +23 -18
  11. data/app/assets/stylesheets/styles/_base.css.erb +28 -35
  12. data/app/assets/stylesheets/styles/_exception.css.erb +106 -105
  13. data/app/assets/stylesheets/styles/_footer.css.erb +24 -24
  14. data/app/assets/stylesheets/styles/_responsive.css +5 -5
  15. data/app/controllers/exception_handler/exceptions_controller.rb +66 -55
  16. data/app/mailers/exception_handler/exception_mailer.rb +17 -17
  17. data/app/models/exception_handler/exception.rb +200 -191
  18. data/app/views/exception_handler/exceptions/show.html.erb +3 -3
  19. data/app/views/exception_handler/mailers/layout.haml +8 -8
  20. data/app/views/exception_handler/mailers/layout.text.erb +1 -1
  21. data/app/views/exception_handler/mailers/new_exception.erb +4 -4
  22. data/app/views/layouts/exception.html.erb +32 -27
  23. data/app/views/layouts/mailer.html.erb +5 -0
  24. data/app/views/layouts/mailer.text.erb +1 -0
  25. data/config/locales/exception_handler.en.yml +28 -29
  26. data/config/routes.rb +42 -0
  27. data/db/migrate/000000_create_errors.rb +34 -34
  28. data/exception_handler.gemspec +64 -80
  29. data/lib/exception_handler.rb +56 -45
  30. data/lib/exception_handler/config.rb +185 -103
  31. data/lib/exception_handler/engine.rb +78 -60
  32. data/lib/exception_handler/version.rb +25 -0
  33. data/lib/generators/exception_handler/views_generator.rb +33 -33
  34. data/spec/controllers/controller_spec.rb +107 -0
  35. data/spec/dummy/.rspec +1 -0
  36. data/spec/dummy/.ruby-version +1 -0
  37. data/spec/dummy/Rakefile +6 -6
  38. data/spec/dummy/app/assets/config/manifest.js +3 -4
  39. data/spec/dummy/app/assets/javascripts/application.js +15 -13
  40. data/spec/dummy/app/assets/javascripts/cable.js +13 -0
  41. data/spec/dummy/app/assets/stylesheets/application.css +15 -15
  42. data/spec/dummy/app/channels/application_cable/channel.rb +4 -5
  43. data/spec/dummy/app/channels/application_cable/connection.rb +4 -5
  44. data/spec/dummy/app/controllers/application_controller.rb +2 -5
  45. data/spec/dummy/app/helpers/application_helper.rb +2 -2
  46. data/spec/dummy/app/jobs/application_job.rb +2 -2
  47. data/spec/dummy/app/mailers/application_mailer.rb +4 -4
  48. data/spec/dummy/app/models/application_record.rb +3 -3
  49. data/spec/dummy/app/views/layouts/application.html.erb +15 -15
  50. data/spec/dummy/app/views/layouts/mailer.html.erb +13 -13
  51. data/spec/dummy/app/views/layouts/mailer.text.erb +1 -1
  52. data/spec/dummy/bin/bundle +3 -3
  53. data/spec/dummy/bin/rails +4 -4
  54. data/spec/dummy/bin/rake +4 -4
  55. data/spec/dummy/bin/setup +36 -34
  56. data/spec/dummy/bin/update +31 -29
  57. data/spec/dummy/bin/yarn +11 -0
  58. data/spec/dummy/config.ru +5 -8
  59. data/spec/dummy/config/application.rb +18 -21
  60. data/spec/dummy/config/boot.rb +5 -5
  61. data/spec/dummy/config/cable.yml +10 -10
  62. data/spec/dummy/config/database.yml +25 -25
  63. data/spec/dummy/config/environment.rb +5 -5
  64. data/spec/dummy/config/environments/development.rb +61 -62
  65. data/spec/dummy/config/environments/production.rb +94 -87
  66. data/spec/dummy/config/environments/test.rb +46 -42
  67. data/spec/dummy/config/initializers/application_controller_renderer.rb +8 -6
  68. data/spec/dummy/config/initializers/assets.rb +14 -11
  69. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -7
  70. data/spec/dummy/config/initializers/content_security_policy.rb +25 -0
  71. data/spec/dummy/config/initializers/cookies_serializer.rb +5 -5
  72. data/spec/dummy/config/initializers/filter_parameter_logging.rb +4 -4
  73. data/spec/dummy/config/initializers/inflections.rb +16 -16
  74. data/spec/dummy/config/initializers/mime_types.rb +4 -4
  75. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -14
  76. data/spec/dummy/config/locales/en.yml +33 -23
  77. data/spec/dummy/config/puma.rb +34 -47
  78. data/spec/dummy/config/routes.rb +3 -6
  79. data/spec/dummy/config/storage.yml +34 -0
  80. data/spec/dummy/package.json +5 -0
  81. data/spec/dummy/public/404.html +67 -67
  82. data/spec/dummy/public/422.html +67 -67
  83. data/spec/dummy/public/500.html +66 -66
  84. data/spec/dummy/spec/rails_helper.rb +57 -0
  85. data/spec/dummy/spec/spec_helper.rb +100 -0
  86. data/spec/dummy/storage/.keep +0 -0
  87. data/spec/features/asset_spec.rb +61 -0
  88. data/spec/features/config_spec.rb +51 -0
  89. data/spec/features/engine_spec.rb +180 -0
  90. data/spec/mailers/mailer_spec.rb +26 -0
  91. data/spec/models/model_spec.rb +26 -0
  92. data/spec/routing/routing_spec.rb +85 -0
  93. data/spec/spec_helper.rb +101 -55
  94. data/spec/views/views_spec.rb +29 -0
  95. metadata +54 -28
  96. data/.gitattributes +0 -1
  97. data/LICENSE.txt +0 -22
  98. data/app/assets/images/exception_handler/bg.jpg +0 -0
  99. data/app/assets/images/exception_handler/bg_overlay.png +0 -0
  100. data/spec/database.yml +0 -3
  101. data/spec/dummy/app/assets/javascripts/cable.coffee +0 -11
  102. data/spec/dummy/config/initializers/active_record_belongs_to_required_by_default.rb +0 -6
  103. data/spec/dummy/config/initializers/callback_terminator.rb +0 -6
  104. data/spec/dummy/config/initializers/per_form_csrf_tokens.rb +0 -4
  105. data/spec/dummy/config/initializers/request_forgery_protection.rb +0 -4
  106. data/spec/dummy/config/initializers/session_store.rb +0 -3
  107. data/spec/dummy/config/secrets.yml +0 -22
  108. data/spec/exception_handler.rb +0 -22
  109. data/spec/exception_handler/exception_controller_spec.rb +0 -18
@@ -0,0 +1,100 @@
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
+ # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
16
+ RSpec.configure do |config|
17
+ # rspec-expectations config goes here. You can use an alternate
18
+ # assertion/expectation library such as wrong or the stdlib/minitest
19
+ # assertions if you prefer.
20
+ config.expect_with :rspec do |expectations|
21
+ # This option will default to `true` in RSpec 4. It makes the `description`
22
+ # and `failure_message` of custom matchers include text for helper methods
23
+ # defined using `chain`, e.g.:
24
+ # be_bigger_than(2).and_smaller_than(4).description
25
+ # # => "be bigger than 2 and smaller than 4"
26
+ # ...rather than:
27
+ # # => "be bigger than 2"
28
+ expectations.include_chain_clauses_in_custom_matcher_descriptions = true
29
+ end
30
+
31
+ # rspec-mocks config goes here. You can use an alternate test double
32
+ # library (such as bogus or mocha) by changing the `mock_with` option here.
33
+ config.mock_with :rspec do |mocks|
34
+ # Prevents you from mocking or stubbing a method that does not exist on
35
+ # a real object. This is generally recommended, and will default to
36
+ # `true` in RSpec 4.
37
+ mocks.verify_partial_doubles = true
38
+ end
39
+
40
+ # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
41
+ # have no way to turn it off -- the option exists only for backwards
42
+ # compatibility in RSpec 3). It causes shared context metadata to be
43
+ # inherited by the metadata hash of host groups and examples, rather than
44
+ # triggering implicit auto-inclusion in groups with matching metadata.
45
+ config.shared_context_metadata_behavior = :apply_to_host_groups
46
+
47
+ # The settings below are suggested to provide a good initial experience
48
+ # with RSpec, but feel free to customize to your heart's content.
49
+ =begin
50
+ # This allows you to limit a spec run to individual examples or groups
51
+ # you care about by tagging them with `:focus` metadata. When nothing
52
+ # is tagged with `:focus`, all examples get run. RSpec also provides
53
+ # aliases for `it`, `describe`, and `context` that include `:focus`
54
+ # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
55
+ config.filter_run_when_matching :focus
56
+
57
+ # Allows RSpec to persist some state between runs in order to support
58
+ # the `--only-failures` and `--next-failure` CLI options. We recommend
59
+ # you configure your source control system to ignore this file.
60
+ config.example_status_persistence_file_path = "spec/examples.txt"
61
+
62
+ # Limits the available syntax to the non-monkey patched syntax that is
63
+ # recommended. For more details, see:
64
+ # - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
65
+ # - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
66
+ # - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
67
+ config.disable_monkey_patching!
68
+
69
+ # This setting enables warnings. It's recommended, but in some cases may
70
+ # be too noisy due to issues in dependencies.
71
+ config.warnings = true
72
+
73
+ # Many RSpec users commonly either run the entire suite or an individual
74
+ # file, and it's useful to allow more verbose output when running an
75
+ # individual spec file.
76
+ if config.files_to_run.one?
77
+ # Use the documentation formatter for detailed output,
78
+ # unless a formatter has already been configured
79
+ # (e.g. via a command-line flag).
80
+ config.default_formatter = "doc"
81
+ end
82
+
83
+ # Print the 10 slowest examples and example groups at the
84
+ # end of the spec run, to help surface which specs are running
85
+ # particularly slow.
86
+ config.profile_examples = 10
87
+
88
+ # Run specs in random order to surface order dependencies. If you find an
89
+ # order dependency and want to debug it, you can fix the order by providing
90
+ # the seed, which is printed after each run.
91
+ # --seed 1234
92
+ config.order = :random
93
+
94
+ # Seed global randomization in this process using the `--seed` CLI option.
95
+ # Setting this allows you to use `--seed` to deterministically reproduce
96
+ # test failures related to randomization by passing the same `--seed` value
97
+ # as the one that triggered the failure.
98
+ Kernel.srand config.seed
99
+ =end
100
+ end
File without changes
@@ -0,0 +1,61 @@
1
+ ###############################################
2
+ ###############################################
3
+ ## ___ _ ##
4
+ ## / _ \ | | ##
5
+ ## / /_\ \___ ___ ___| |_ ___ ##
6
+ ## | _ / __/ __|/ _ \ __/ __| ##
7
+ ## | | | \__ \__ \ __/ |_\__ \ ##
8
+ ## \_| |_/___/___/\___|\__|___/ ##
9
+ ## ##
10
+ ###############################################
11
+ ###############################################
12
+
13
+ require 'spec_helper'
14
+
15
+ ###############################################
16
+ ###############################################
17
+
18
+ # => ExceptionHandler (Assets)
19
+ # => Needs to test if exception_handler.css added to precompile queue
20
+ # => Needs to test if exception_handler.css adds /images folder
21
+ # => Needsd to check if all files are precompiled
22
+ RSpec.describe "ExceptionHandler Assets" do
23
+
24
+ # => Defs
25
+ let(:assets) { Rails.configuration.assets }
26
+ let(:sprockets) { Rails.application.assets }
27
+
28
+ # => Precompilation
29
+ # => Expects exception_handler.css
30
+ # => Expects contents of /images to be included by file
31
+ describe "precompile" do
32
+ subject { assets.precompile }
33
+ it { should include('exception_handler.css') }
34
+ end
35
+
36
+ # => Images
37
+ # => Should be present in Rails.application.assets
38
+ # => ref: https://stackoverflow.com/a/11005361/1143732
39
+ describe "images" do
40
+ it "includes exception_handler/images/*" do
41
+ #Dir.foreach('../../../app/assets/images') do |item|
42
+ # next if item == '.' or item == '..'
43
+ # puts item
44
+ # expect(sprockets.each_file).to include(item)
45
+ #end
46
+ end
47
+ end
48
+
49
+ # => Assets
50
+ # => Expects exception_handler.css
51
+ # => Expects /images
52
+ # => Expects /images/[specific]
53
+ describe "assets" do
54
+ #it { expect(Rails.application.assets.find_asset(path)).to include('exception_handler.css') }
55
+ end
56
+
57
+
58
+ end
59
+
60
+ ###############################################
61
+ ###############################################
@@ -0,0 +1,51 @@
1
+ ###############################################
2
+ ###############################################
3
+ ## _____ __ _ ##
4
+ ## / __ \ / _(_) ##
5
+ ## | / \/ ___ _ __ | |_ _ __ _ ##
6
+ ## | | / _ \| '_ \| _| |/ _` | ##
7
+ ## | \__/\ (_) | | | | | | | (_| | ##
8
+ ## \____/\___/|_| |_|_| |_|\__, | ##
9
+ ## __/ | ##
10
+ ## |___/ ##
11
+ ###############################################
12
+ ###############################################
13
+
14
+ require 'spec_helper'
15
+
16
+ ###############################################
17
+ ###############################################
18
+
19
+ # => ExceptionHandler (Config)
20
+ # => Should explore config has been created/initialized
21
+ # => Needs to identify available options (dev/db/email/social/layouts/exceptions/custom_exceptions)
22
+ # => Needs to return specific results per option (dev = true/false, email = string etc)
23
+ RSpec.describe ExceptionHandler.config do
24
+
25
+ # => Config
26
+ let(:config) { ExceptionHandler.config }
27
+
28
+ # => Class
29
+ # => Initialized?
30
+ # => Responds to methods?
31
+ describe "class" do
32
+ subject { config }
33
+ it { should be_a ExceptionHandler::Config }
34
+ %i(dev db email social layouts exceptions custom_exceptions).each do |method|
35
+ it { should respond_to(method) }
36
+ end
37
+ end
38
+
39
+ # => Dev
40
+ # => true/false
41
+ describe "dev" do
42
+ subject { ExceptionHandler.config.dev }
43
+ #it { should be_boolean }
44
+ end
45
+
46
+ # => DB
47
+
48
+ end
49
+
50
+ ###############################################
51
+ ###############################################
@@ -0,0 +1,180 @@
1
+ ###############################################
2
+ ###############################################
3
+ ## _____ _____ ##
4
+ ## | ___ \/ ___| ##
5
+ ## | |_/ /\ `--. _ __ ___ ___ ##
6
+ ## | / `--. \ '_ \ / _ \/ __| ##
7
+ ## | |\ \ /\__/ / |_) | __/ (__ ##
8
+ ## \_| \_|\____/| .__/ \___|\___| ##
9
+ ## | | ##
10
+ ## |_| ##
11
+ ###############################################
12
+ ###############################################
13
+
14
+ require 'spec_helper'
15
+
16
+ ###############################################
17
+ ###############################################
18
+
19
+ # => ExceptionHandler (base)
20
+ # => Test underlying engine (loading, initializers, etc)
21
+ # => Ensure that all elements are correctly integrated into Rails core
22
+ RSpec.describe ExceptionHandler::Engine do
23
+
24
+ #############################################
25
+ #############################################
26
+
27
+ # => Ensure Gem has value, loaded etc
28
+ describe "Gem" do
29
+
30
+ # => Options
31
+ let(:version) { ExceptionHandler::VERSION::STRING }
32
+ let(:engine) { ExceptionHandler::Engine }
33
+
34
+ # => Version needs to exist
35
+ # => Present Version
36
+ describe "version" do
37
+ subject { version }
38
+ it { is_expected.not_to be_empty }
39
+ it { is_expected.to eq('0.8.0.0') }
40
+ end
41
+
42
+ # => Loaded?
43
+ # => Accessible by Rails?
44
+ describe "class" do
45
+ subject { engine }
46
+ it { should be_const_defined('ExceptionHandler') }
47
+ it { }
48
+ end
49
+
50
+ end
51
+
52
+ #############################################
53
+ #############################################
54
+
55
+ # => Ensure Gem's features are loaded into Rails
56
+ describe "Setup" do
57
+
58
+ #########################
59
+ #########################
60
+
61
+ # => Options
62
+ let(:config) { ExceptionHandler.config }
63
+ let(:rails) { Rails.configuration }
64
+
65
+ # => Before
66
+ before(:context) { ExceptionHandler.config.dev = false }
67
+
68
+ #########################
69
+ #########################
70
+
71
+ # => Config
72
+ # => Exists? Accessible? Right Values?
73
+ describe "config" do
74
+ subject { config }
75
+
76
+ # => Initialized
77
+ it "has an initializer" do
78
+ expect(Rails.application.initializers.map(&:name)).to include(:exception_handler_config)
79
+ end
80
+
81
+ # => Initialization Queue
82
+ it "is initialized before better_errors" do
83
+ end
84
+
85
+ # => Accessible?
86
+ # => Can we access the instance of the class and see which items are available?
87
+ it { should be_a ExceptionHandler::Config }
88
+ it "is accessible" do
89
+
90
+ end
91
+
92
+ # => Values
93
+ # => The returned values need to be tested in the config class
94
+ it "responds to methods" do
95
+ %i(dev db email social layouts exceptions custom_exceptions).each do |method|
96
+ expect(config).to respond_to(method)
97
+ end
98
+ end
99
+
100
+ # => Basic values
101
+ it "has basic values" do
102
+ expect(config.dev).to be_boolean
103
+ end
104
+ end
105
+
106
+ #########################
107
+ #########################
108
+
109
+ # => Middleware
110
+ # => Check if it's correctly overwritten @exceptions_app
111
+ # => http://guides.rubyonrails.org/configuring.html#rails-general-configuration
112
+ describe "middleware" do
113
+ subject { rails.exceptions_app }
114
+ #it { should eq(ExceptionHandler) }
115
+ # => accessible?
116
+ end
117
+
118
+ #########################
119
+ #########################
120
+
121
+ # => Dev Mode
122
+ # => Changes "consider_all_requests_local" to opposite of config
123
+ describe "dev" do
124
+
125
+ # => Access dev mode
126
+ # => Ensure the config is present & accessible
127
+ context "config" do
128
+ subject { config.dev }
129
+ it { should_not be true }
130
+ end
131
+
132
+ # => Local Requests
133
+ # => Should be the opposite of the dev option
134
+ context "local requests" do
135
+ subject { rails.consider_all_requests_local }
136
+ it { should_not be ExceptionHandler.config.dev }
137
+ end
138
+
139
+ end
140
+
141
+ #########################
142
+ #########################
143
+
144
+ # => Custom Exceptions
145
+ # => Ensure custom exceptions added to Rails
146
+ describe "custom exceptions" do
147
+
148
+ # => Rescue Response
149
+ subject { rails.action_dispatch.rescue_responses }
150
+
151
+ # => Let
152
+ let(:config) { ExceptionHandler.config }
153
+
154
+ # => Removes
155
+ it "has an initializer" do
156
+ expect(Rails.application.initializers.map(&:name)).to include(:exception_handler_custom_exceptions)
157
+ end
158
+
159
+ # => Check if present
160
+ context "present" do
161
+ end
162
+
163
+ # => Check if can be accessed
164
+ context "accessiblity" do
165
+ before { config.custom_exceptions.merge! 'ActionController::RoutingError' => :not_found }
166
+
167
+ #it { should include config.custom_exceptions }
168
+ end
169
+
170
+ end
171
+
172
+ end
173
+
174
+ #############################################
175
+ #############################################
176
+
177
+ end
178
+
179
+ ###############################################
180
+ ###############################################
@@ -0,0 +1,26 @@
1
+ #####################################################
2
+ #####################################################
3
+ ## __ __ _ _ ##
4
+ ## | \/ | (_) | ##
5
+ ## | . . | __ _ _| | ___ _ __ ##
6
+ ## | |\/| |/ _` | | |/ _ \ '__| ##
7
+ ## | | | | (_| | | | __/ | ##
8
+ ## \_| |_/\__,_|_|_|\___|_| ##
9
+ ## ##
10
+ #####################################################
11
+ #####################################################
12
+
13
+ require 'spec_helper'
14
+
15
+ ###############################################
16
+ ###############################################
17
+
18
+ # => ExceptionHandler (Mailer)
19
+ # => Check veracity of methods / returned results
20
+ # =>
21
+ RSpec.describe ExceptionHandler::ExceptionMailer do
22
+
23
+ end
24
+
25
+ ###############################################
26
+ ###############################################
@@ -0,0 +1,26 @@
1
+ #####################################################
2
+ #####################################################
3
+ ## __ __ _ _ ##
4
+ ## | \/ | | | | | ##
5
+ ## | . . | ___ __| | ___| | ##
6
+ ## | |\/| |/ _ \ / _` |/ _ \ | ##
7
+ ## | | | | (_) | (_| | __/ | ##
8
+ ## \_| |_/\___/ \__,_|\___|_| ##
9
+ ## ##
10
+ #####################################################
11
+ #####################################################
12
+
13
+ require 'spec_helper'
14
+
15
+ ###############################################
16
+ ###############################################
17
+
18
+ # => ExceptionHandler (Model)
19
+ # => Check veracity of methods / returned results
20
+ # =>
21
+ RSpec.describe ExceptionHandler::Exception do
22
+
23
+ end
24
+
25
+ ###############################################
26
+ ###############################################