Skip to content

Label Rspec as @private for docs, update other modules visibility #1479

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 25, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/generators/rspec.rb
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
require 'rails/generators/named_base'
require 'rspec/rails/feature_check'

# @private
# Weirdly named generators namespace (should be `RSpec`) for compatability with
# rails loading.
module Rspec
Expand Down
1 change: 1 addition & 0 deletions lib/rspec/rails/example/controller_example_group.rb
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ module Rails
ActionDispatch::Assertions::RoutingAssertions
)

# @api public
# Container module for controller spec functionality.
module ControllerExampleGroup
extend ActiveSupport::Concern
Expand Down
1 change: 1 addition & 0 deletions lib/rspec/rails/example/feature_example_group.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
module RSpec
module Rails
# @api public
# Container module for routing spec functionality.
module FeatureExampleGroup
extend ActiveSupport::Concern
Expand Down
1 change: 1 addition & 0 deletions lib/rspec/rails/example/helper_example_group.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

module RSpec
module Rails
# @api public
# Container module for helper specs.
module HelperExampleGroup
extend ActiveSupport::Concern
Expand Down
1 change: 1 addition & 0 deletions lib/rspec/rails/example/job_example_group.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
module RSpec
module Rails
# @api public
# Container module for job spec functionality. It is only available if
# ActiveJob has been loaded before it.
module JobExampleGroup
Expand Down
1 change: 1 addition & 0 deletions lib/rspec/rails/example/mailer_example_group.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
module RSpec
module Rails
# @api public
# Container module for mailer spec functionality. It is only available if
# ActionMailer has been loaded before it.
module MailerExampleGroup
Expand Down
1 change: 1 addition & 0 deletions lib/rspec/rails/example/model_example_group.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
module RSpec
module Rails
# @api public
# Container class for model spec functionality. Does not provide anything
# special over the common RailsExampleGroup currently.
module ModelExampleGroup
Expand Down
1 change: 1 addition & 0 deletions lib/rspec/rails/example/rails_example_group.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

module RSpec
module Rails
# @api public
# Common rails example functionality.
module RailsExampleGroup
extend ActiveSupport::Concern
Expand Down
1 change: 1 addition & 0 deletions lib/rspec/rails/example/request_example_group.rb
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
module RSpec
module Rails
# @api public
# Container class for request spec functionality.
module RequestExampleGroup
extend ActiveSupport::Concern
Expand Down
1 change: 1 addition & 0 deletions lib/rspec/rails/example/routing_example_group.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ module Rails
ActionDispatch::Assertions::RoutingAssertions
)

# @api public
# Container module for routing spec functionality.
module RoutingExampleGroup
extend ActiveSupport::Concern
Expand Down
1 change: 1 addition & 0 deletions lib/rspec/rails/example/view_example_group.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

module RSpec
module Rails
# @api public
# Container class for view spec functionality.
module ViewExampleGroup
extend ActiveSupport::Concern
Expand Down
1 change: 0 additions & 1 deletion lib/rspec/rails/feature_check.rb
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# @api private
module RSpec
module Rails
# @private
Expand Down
1 change: 1 addition & 0 deletions lib/rspec/rails/matchers.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

module RSpec
module Rails
# @api public
# Container module for Rails specific matchers.
module Matchers
end
Expand Down
1 change: 1 addition & 0 deletions lib/rspec/rails/matchers/be_valid.rb
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ def failure_message_when_negated
end
end

# @api public
# Passes if the given model instance's `valid?` method is true, meaning
# all of the `ActiveModel::Validations` passed and no errors exist. If a
# message is not given, a default message is shown listing each error.
Expand Down
1 change: 1 addition & 0 deletions lib/rspec/rails/view_rendering.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

module RSpec
module Rails
# @api public
# Helpers for optionally rendering views in controller specs.
module ViewRendering
extend ActiveSupport::Concern
Expand Down