shoulda-matchers 4.0.0.rc1 → 4.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (209) hide show
  1. checksums.yaml +4 -4
  2. data/MIT-LICENSE +1 -1
  3. data/README.md +72 -40
  4. data/lib/shoulda/matchers/action_controller.rb +2 -0
  5. data/lib/shoulda/matchers/active_model.rb +2 -3
  6. data/lib/shoulda/matchers/active_model/validate_inclusion_of_matcher.rb +1 -0
  7. data/lib/shoulda/matchers/active_record.rb +2 -0
  8. data/lib/shoulda/matchers/active_record/association_matcher.rb +34 -0
  9. data/lib/shoulda/matchers/active_record/association_matchers/optional_matcher.rb +27 -4
  10. data/lib/shoulda/matchers/active_record/association_matchers/required_matcher.rb +27 -4
  11. data/lib/shoulda/matchers/active_record/validate_uniqueness_of_matcher.rb +1 -1
  12. data/lib/shoulda/matchers/independent.rb +2 -1
  13. data/lib/shoulda/matchers/rails_shim.rb +5 -9
  14. data/lib/shoulda/matchers/version.rb +1 -1
  15. data/lib/shoulda/matchers/warn.rb +1 -0
  16. data/shoulda-matchers.gemspec +11 -3
  17. metadata +13 -340
  18. data/.gitignore +0 -12
  19. data/.hound.yml +0 -3
  20. data/.hound/ruby.yml +0 -1062
  21. data/.python-version +0 -1
  22. data/.rubocop.yml +0 -15
  23. data/.travis.yml +0 -21
  24. data/.yardopts +0 -10
  25. data/Appraisals +0 -105
  26. data/CONTRIBUTING.md +0 -172
  27. data/Gemfile +0 -15
  28. data/Gemfile.lock +0 -59
  29. data/MAINTAINING.md +0 -250
  30. data/NEWS.md +0 -1235
  31. data/Rakefile +0 -46
  32. data/bin/setup +0 -190
  33. data/custom_plan.rb +0 -104
  34. data/doc_config/gh-pages/index.html.erb +0 -9
  35. data/doc_config/yard/setup.rb +0 -22
  36. data/doc_config/yard/templates/default/fulldoc/html/css/bootstrap.css +0 -5967
  37. data/doc_config/yard/templates/default/fulldoc/html/css/full_list.css +0 -12
  38. data/doc_config/yard/templates/default/fulldoc/html/css/global.css +0 -66
  39. data/doc_config/yard/templates/default/fulldoc/html/css/solarized.css +0 -69
  40. data/doc_config/yard/templates/default/fulldoc/html/css/style.css +0 -312
  41. data/doc_config/yard/templates/default/fulldoc/html/full_list.erb +0 -26
  42. data/doc_config/yard/templates/default/fulldoc/html/full_list_class.erb +0 -1
  43. data/doc_config/yard/templates/default/fulldoc/html/full_list_method.erb +0 -8
  44. data/doc_config/yard/templates/default/fulldoc/html/js/app.js +0 -281
  45. data/doc_config/yard/templates/default/fulldoc/html/js/full_list.js +0 -1
  46. data/doc_config/yard/templates/default/fulldoc/html/js/jquery.stickyheaders.js +0 -289
  47. data/doc_config/yard/templates/default/fulldoc/html/js/underscore.min.js +0 -6
  48. data/doc_config/yard/templates/default/fulldoc/html/setup.rb +0 -35
  49. data/doc_config/yard/templates/default/layout/html/breadcrumb.erb +0 -14
  50. data/doc_config/yard/templates/default/layout/html/fonts.erb +0 -1
  51. data/doc_config/yard/templates/default/layout/html/footer.erb +0 -6
  52. data/doc_config/yard/templates/default/layout/html/layout.erb +0 -23
  53. data/doc_config/yard/templates/default/layout/html/search.erb +0 -13
  54. data/doc_config/yard/templates/default/layout/html/setup.rb +0 -40
  55. data/doc_config/yard/templates/default/method_details/html/source.erb +0 -10
  56. data/doc_config/yard/templates/default/module/html/box_info.erb +0 -31
  57. data/gemfiles/4.2.gemfile +0 -39
  58. data/gemfiles/4.2.gemfile.lock +0 -246
  59. data/gemfiles/5.0.gemfile +0 -37
  60. data/gemfiles/5.0.gemfile.lock +0 -238
  61. data/gemfiles/5.1.gemfile +0 -38
  62. data/gemfiles/5.1.gemfile.lock +0 -254
  63. data/gemfiles/5.2.gemfile +0 -40
  64. data/gemfiles/5.2.gemfile.lock +0 -273
  65. data/script/install_gems_in_all_appraisals +0 -16
  66. data/script/run_all_tests +0 -16
  67. data/script/supported_ruby_versions +0 -7
  68. data/script/update_gem_in_all_appraisals +0 -17
  69. data/script/update_gems_in_all_appraisals +0 -16
  70. data/spec/acceptance/active_model_integration_spec.rb +0 -23
  71. data/spec/acceptance/independent_matchers_spec.rb +0 -125
  72. data/spec/acceptance/multiple_libraries_integration_spec.rb +0 -55
  73. data/spec/acceptance/rails_integration_spec.rb +0 -156
  74. data/spec/acceptance_spec_helper.rb +0 -23
  75. data/spec/doublespeak_spec_helper.rb +0 -2
  76. data/spec/report_warnings.rb +0 -7
  77. data/spec/spec_helper.rb +0 -20
  78. data/spec/support/acceptance/adds_shoulda_matchers_to_project.rb +0 -133
  79. data/spec/support/acceptance/helpers.rb +0 -33
  80. data/spec/support/acceptance/helpers/active_model_helpers.rb +0 -11
  81. data/spec/support/acceptance/helpers/array_helpers.rb +0 -13
  82. data/spec/support/acceptance/helpers/base_helpers.rb +0 -19
  83. data/spec/support/acceptance/helpers/command_helpers.rb +0 -68
  84. data/spec/support/acceptance/helpers/file_helpers.rb +0 -19
  85. data/spec/support/acceptance/helpers/gem_helpers.rb +0 -31
  86. data/spec/support/acceptance/helpers/minitest_helpers.rb +0 -11
  87. data/spec/support/acceptance/helpers/n_unit_helpers.rb +0 -25
  88. data/spec/support/acceptance/helpers/pluralization_helpers.rb +0 -13
  89. data/spec/support/acceptance/helpers/rails_migration_helpers.rb +0 -21
  90. data/spec/support/acceptance/helpers/rails_version_helpers.rb +0 -11
  91. data/spec/support/acceptance/helpers/rspec_helpers.rb +0 -24
  92. data/spec/support/acceptance/helpers/ruby_version_helpers.rb +0 -9
  93. data/spec/support/acceptance/helpers/step_helpers.rb +0 -127
  94. data/spec/support/acceptance/matchers/have_output.rb +0 -31
  95. data/spec/support/acceptance/matchers/indicate_number_of_tests_was_run_matcher.rb +0 -55
  96. data/spec/support/acceptance/matchers/indicate_that_tests_were_run_matcher.rb +0 -103
  97. data/spec/support/tests/bundle.rb +0 -94
  98. data/spec/support/tests/command_runner.rb +0 -230
  99. data/spec/support/tests/current_bundle.rb +0 -55
  100. data/spec/support/tests/database.rb +0 -28
  101. data/spec/support/tests/database_adapters/postgresql.rb +0 -25
  102. data/spec/support/tests/database_adapters/sqlite3.rb +0 -26
  103. data/spec/support/tests/database_configuration.rb +0 -33
  104. data/spec/support/tests/database_configuration_registry.rb +0 -28
  105. data/spec/support/tests/filesystem.rb +0 -100
  106. data/spec/support/tests/version.rb +0 -45
  107. data/spec/support/unit/active_record/create_table.rb +0 -54
  108. data/spec/support/unit/attribute.rb +0 -45
  109. data/spec/support/unit/capture.rb +0 -46
  110. data/spec/support/unit/change_value.rb +0 -111
  111. data/spec/support/unit/create_model_arguments/basic.rb +0 -135
  112. data/spec/support/unit/create_model_arguments/has_many.rb +0 -15
  113. data/spec/support/unit/create_model_arguments/uniqueness_matcher.rb +0 -74
  114. data/spec/support/unit/helpers/action_pack_versions.rb +0 -22
  115. data/spec/support/unit/helpers/active_model_helpers.rb +0 -27
  116. data/spec/support/unit/helpers/active_model_versions.rb +0 -32
  117. data/spec/support/unit/helpers/active_record_versions.rb +0 -44
  118. data/spec/support/unit/helpers/active_resource_builder.rb +0 -27
  119. data/spec/support/unit/helpers/allow_value_matcher_helpers.rb +0 -15
  120. data/spec/support/unit/helpers/class_builder.rb +0 -90
  121. data/spec/support/unit/helpers/column_type_helpers.rb +0 -26
  122. data/spec/support/unit/helpers/confirmation_matcher_helpers.rb +0 -17
  123. data/spec/support/unit/helpers/controller_builder.rb +0 -63
  124. data/spec/support/unit/helpers/database_helpers.rb +0 -20
  125. data/spec/support/unit/helpers/i18n_faker.rb +0 -15
  126. data/spec/support/unit/helpers/mailer_builder.rb +0 -12
  127. data/spec/support/unit/helpers/message_helpers.rb +0 -19
  128. data/spec/support/unit/helpers/model_builder.rb +0 -114
  129. data/spec/support/unit/helpers/rails_versions.rb +0 -42
  130. data/spec/support/unit/helpers/validation_matcher_scenario_helpers.rb +0 -44
  131. data/spec/support/unit/i18n.rb +0 -7
  132. data/spec/support/unit/load_environment.rb +0 -12
  133. data/spec/support/unit/matchers/deprecate.rb +0 -60
  134. data/spec/support/unit/matchers/fail_with_message_including_matcher.rb +0 -51
  135. data/spec/support/unit/matchers/fail_with_message_matcher.rb +0 -64
  136. data/spec/support/unit/matchers/print_warning_including.rb +0 -67
  137. data/spec/support/unit/model_creation_strategies/active_model.rb +0 -111
  138. data/spec/support/unit/model_creation_strategies/active_record.rb +0 -77
  139. data/spec/support/unit/model_creators.rb +0 -19
  140. data/spec/support/unit/model_creators/active_model.rb +0 -39
  141. data/spec/support/unit/model_creators/active_record.rb +0 -42
  142. data/spec/support/unit/model_creators/active_record/has_and_belongs_to_many.rb +0 -95
  143. data/spec/support/unit/model_creators/active_record/has_many.rb +0 -67
  144. data/spec/support/unit/model_creators/active_record/uniqueness_matcher.rb +0 -42
  145. data/spec/support/unit/model_creators/basic.rb +0 -102
  146. data/spec/support/unit/rails_application.rb +0 -151
  147. data/spec/support/unit/record_builder_with_i18n_validation_message.rb +0 -69
  148. data/spec/support/unit/record_validating_confirmation_builder.rb +0 -54
  149. data/spec/support/unit/record_with_different_error_attribute_builder.rb +0 -92
  150. data/spec/support/unit/shared_examples/ignoring_interference_by_writer.rb +0 -79
  151. data/spec/support/unit/shared_examples/numerical_submatcher.rb +0 -17
  152. data/spec/support/unit/shared_examples/set_session_or_flash.rb +0 -360
  153. data/spec/support/unit/validation_matcher_scenario.rb +0 -60
  154. data/spec/unit/shoulda/matchers/action_controller/callback_matcher_spec.rb +0 -82
  155. data/spec/unit/shoulda/matchers/action_controller/filter_param_matcher_spec.rb +0 -28
  156. data/spec/unit/shoulda/matchers/action_controller/permit_matcher_spec.rb +0 -629
  157. data/spec/unit/shoulda/matchers/action_controller/redirect_to_matcher_spec.rb +0 -42
  158. data/spec/unit/shoulda/matchers/action_controller/render_template_matcher_spec.rb +0 -76
  159. data/spec/unit/shoulda/matchers/action_controller/render_with_layout_matcher_spec.rb +0 -62
  160. data/spec/unit/shoulda/matchers/action_controller/rescue_from_matcher_spec.rb +0 -90
  161. data/spec/unit/shoulda/matchers/action_controller/respond_with_matcher_spec.rb +0 -31
  162. data/spec/unit/shoulda/matchers/action_controller/route_matcher_spec.rb +0 -330
  163. data/spec/unit/shoulda/matchers/action_controller/route_params_spec.rb +0 -30
  164. data/spec/unit/shoulda/matchers/action_controller/set_flash_matcher_spec.rb +0 -67
  165. data/spec/unit/shoulda/matchers/action_controller/set_session_matcher_spec.rb +0 -17
  166. data/spec/unit/shoulda/matchers/action_controller/set_session_or_flash_matcher_spec.rb +0 -562
  167. data/spec/unit/shoulda/matchers/active_model/allow_mass_assignment_of_matcher_spec.rb +0 -117
  168. data/spec/unit/shoulda/matchers/active_model/allow_value_matcher_spec.rb +0 -829
  169. data/spec/unit/shoulda/matchers/active_model/disallow_value_matcher_spec.rb +0 -86
  170. data/spec/unit/shoulda/matchers/active_model/have_secure_password_matcher_spec.rb +0 -20
  171. data/spec/unit/shoulda/matchers/active_model/helpers_spec.rb +0 -162
  172. data/spec/unit/shoulda/matchers/active_model/validate_absence_of_matcher_spec.rb +0 -290
  173. data/spec/unit/shoulda/matchers/active_model/validate_acceptance_of_matcher_spec.rb +0 -109
  174. data/spec/unit/shoulda/matchers/active_model/validate_confirmation_of_matcher_spec.rb +0 -172
  175. data/spec/unit/shoulda/matchers/active_model/validate_exclusion_of_matcher_spec.rb +0 -264
  176. data/spec/unit/shoulda/matchers/active_model/validate_inclusion_of_matcher_spec.rb +0 -1049
  177. data/spec/unit/shoulda/matchers/active_model/validate_length_of_matcher_spec.rb +0 -335
  178. data/spec/unit/shoulda/matchers/active_model/validate_numericality_of_matcher_spec.rb +0 -1865
  179. data/spec/unit/shoulda/matchers/active_model/validate_presence_of_matcher_spec.rb +0 -406
  180. data/spec/unit/shoulda/matchers/active_record/accept_nested_attributes_for_matcher_spec.rb +0 -107
  181. data/spec/unit/shoulda/matchers/active_record/association_matcher_spec.rb +0 -1672
  182. data/spec/unit/shoulda/matchers/active_record/association_matchers/model_reflection_spec.rb +0 -251
  183. data/spec/unit/shoulda/matchers/active_record/define_enum_for_matcher_spec.rb +0 -690
  184. data/spec/unit/shoulda/matchers/active_record/have_db_column_matcher_spec.rb +0 -111
  185. data/spec/unit/shoulda/matchers/active_record/have_db_index_matcher_spec.rb +0 -85
  186. data/spec/unit/shoulda/matchers/active_record/have_readonly_attributes_matcher_spec.rb +0 -41
  187. data/spec/unit/shoulda/matchers/active_record/have_secure_token_matcher_spec.rb +0 -169
  188. data/spec/unit/shoulda/matchers/active_record/serialize_matcher_spec.rb +0 -86
  189. data/spec/unit/shoulda/matchers/active_record/validate_uniqueness_of_matcher_spec.rb +0 -1682
  190. data/spec/unit/shoulda/matchers/doublespeak/double_collection_spec.rb +0 -190
  191. data/spec/unit/shoulda/matchers/doublespeak/double_implementation_registry_spec.rb +0 -21
  192. data/spec/unit/shoulda/matchers/doublespeak/double_spec.rb +0 -271
  193. data/spec/unit/shoulda/matchers/doublespeak/object_double_spec.rb +0 -77
  194. data/spec/unit/shoulda/matchers/doublespeak/proxy_implementation_spec.rb +0 -72
  195. data/spec/unit/shoulda/matchers/doublespeak/stub_implementation_spec.rb +0 -101
  196. data/spec/unit/shoulda/matchers/doublespeak/world_spec.rb +0 -78
  197. data/spec/unit/shoulda/matchers/doublespeak_spec.rb +0 -27
  198. data/spec/unit/shoulda/matchers/independent/delegate_method_matcher/stubbed_target_spec.rb +0 -43
  199. data/spec/unit/shoulda/matchers/independent/delegate_method_matcher_spec.rb +0 -650
  200. data/spec/unit/shoulda/matchers/routing/route_matcher_spec.rb +0 -406
  201. data/spec/unit/shoulda/matchers/util/word_wrap_spec.rb +0 -252
  202. data/spec/unit_spec_helper.rb +0 -54
  203. data/spec/warnings_spy.rb +0 -64
  204. data/spec/warnings_spy/filesystem.rb +0 -45
  205. data/spec/warnings_spy/partitioner.rb +0 -36
  206. data/spec/warnings_spy/reader.rb +0 -53
  207. data/spec/warnings_spy/reporter.rb +0 -88
  208. data/tasks/documentation.rb +0 -199
  209. data/zeus.json +0 -11
@@ -1,54 +0,0 @@
1
- require_relative 'support/unit/load_environment'
2
-
3
- require 'rspec/rails'
4
- require 'rspec/matchers/fail_matchers'
5
- require 'shoulda-matchers'
6
-
7
- require 'spec_helper'
8
-
9
- Dir[ File.join(File.expand_path('../support/unit/**/*.rb', __FILE__)) ].sort.each do |file|
10
- require file
11
- end
12
-
13
- RSpec.configure do |config|
14
- config.include RSpec::Matchers::FailMatchers
15
-
16
- UnitTests::ActionPackVersions.configure_example_group(config)
17
- UnitTests::ActiveModelHelpers.configure_example_group(config)
18
- UnitTests::ActiveModelVersions.configure_example_group(config)
19
- UnitTests::ClassBuilder.configure_example_group(config)
20
- UnitTests::ControllerBuilder.configure_example_group(config)
21
- UnitTests::I18nFaker.configure_example_group(config)
22
- UnitTests::MailerBuilder.configure_example_group(config)
23
- UnitTests::ModelBuilder.configure_example_group(config)
24
- UnitTests::RailsVersions.configure_example_group(config)
25
- UnitTests::ActiveRecordVersions.configure_example_group(config)
26
- UnitTests::ActiveModelVersions.configure_example_group(config)
27
- UnitTests::DatabaseHelpers.configure_example_group(config)
28
- UnitTests::ColumnTypeHelpers.configure_example_group(config)
29
- UnitTests::ValidationMatcherScenarioHelpers.configure_example_group(config)
30
- UnitTests::MessageHelpers.configure_example_group(config)
31
-
32
- if UnitTests::RailsVersions.rails_lte_4?
33
- UnitTests::ActiveResourceBuilder.configure_example_group(config)
34
- end
35
-
36
- config.include UnitTests::Matchers
37
-
38
- config.infer_spec_type_from_file_location!
39
- config.example_status_persistence_file_path = "spec/examples.txt"
40
- config.alias_it_behaves_like_to(:it_supports, "it supports")
41
-
42
- config.before(:all, type: :controller) do
43
- self.class.controller(ApplicationController) { }
44
- end
45
- end
46
-
47
- ActiveSupport::Deprecation.behavior = :stderr
48
-
49
- Shoulda::Matchers.configure do |config|
50
- config.integrate do |with|
51
- with.test_framework :rspec
52
- with.library :rails
53
- end
54
- end
@@ -1,64 +0,0 @@
1
- require 'forwardable'
2
-
3
- require File.expand_path('../warnings_spy/filesystem', __FILE__)
4
- require File.expand_path('../warnings_spy/reader', __FILE__)
5
- require File.expand_path('../warnings_spy/partitioner', __FILE__)
6
- require File.expand_path('../warnings_spy/reporter', __FILE__)
7
-
8
- class WarningsSpy
9
- extend Forwardable
10
-
11
- def initialize(project_name)
12
- filesystem = Filesystem.new
13
- @warnings_file = filesystem.warnings_file
14
- @reader = Reader.new(filesystem)
15
- @partitioner = Partitioner.new(reader, filesystem)
16
- @reporter = Reporter.new(partitioner, filesystem, project_name)
17
- end
18
-
19
- def capture_warnings
20
- $stderr.reopen(warnings_file.path)
21
- end
22
-
23
- def report_warnings_at_exit
24
- at_exit do
25
- printing_exceptions do
26
- report_and_exit
27
- end
28
- end
29
- end
30
-
31
- protected
32
-
33
- attr_reader :warnings_file, :reader, :partitioner, :reporter
34
-
35
- private
36
-
37
- def_delegators :partitioner, :relevant_warning_groups,
38
- :irrelevant_warning_groups
39
-
40
- def report_and_exit
41
- reader.read
42
- partitioner.partition
43
- reporter.report
44
- fail_build_if_there_are_any_warnings
45
- end
46
-
47
- def fail_build_if_there_are_any_warnings
48
- if relevant_warning_groups.any?
49
- exit(1)
50
- end
51
- end
52
-
53
- def printing_exceptions
54
- begin
55
- yield
56
- rescue => error
57
- puts "\n--- ERROR IN AT_EXIT --------------------------------"
58
- puts "#{error.class}: #{error.message}"
59
- puts error.backtrace.join("\n")
60
- puts "-----------------------------------------------------"
61
- raise error
62
- end
63
- end
64
- end
@@ -1,45 +0,0 @@
1
- require 'fileutils'
2
-
3
- class WarningsSpy
4
- class Filesystem
5
- PROJECT_DIR = File.expand_path('../../..', __FILE__)
6
- TEMP_DIR = File.join(PROJECT_DIR, 'tmp')
7
-
8
- def initialize
9
- @files_by_name = Hash.new do |hash, name|
10
- FileUtils.mkdir_p(TEMP_DIR)
11
- hash[name] = file_for(name)
12
- end
13
- end
14
-
15
- def warnings_file
16
- files_by_name['all_warnings']
17
- end
18
-
19
- def irrelevant_warnings_file
20
- files_by_name['irrelevant_warnings']
21
- end
22
-
23
- def relevant_warnings_file
24
- files_by_name['relevant_warnings']
25
- end
26
-
27
- def project_dir
28
- PROJECT_DIR
29
- end
30
-
31
- protected
32
-
33
- attr_reader :files_by_name
34
-
35
- private
36
-
37
- def path_for(name)
38
- File.join(TEMP_DIR, "#{name}.txt")
39
- end
40
-
41
- def file_for(name)
42
- File.open(path_for(name), 'w+')
43
- end
44
- end
45
- end
@@ -1,36 +0,0 @@
1
- require 'forwardable'
2
-
3
- class WarningsSpy
4
- class Partitioner
5
- extend Forwardable
6
-
7
- attr_reader :relevant_warning_groups, :irrelevant_warning_groups
8
-
9
- def initialize(reader, filesystem)
10
- @reader = reader
11
- @search_text = filesystem.project_dir
12
- end
13
-
14
- def partition
15
- @relevant_warning_groups, @irrelevant_warning_groups =
16
- warning_groups.partition { |group| relevant_warnings?(group) }
17
- end
18
-
19
- protected
20
-
21
- attr_reader :reader, :search_text
22
-
23
- private
24
-
25
- def_delegators :reader, :warning_groups
26
-
27
- def relevant_warnings?(group)
28
- first_line = group[0]
29
- first_line.start_with?("#{project_root}/lib")
30
- end
31
-
32
- def project_root
33
- File.expand_path('../../..')
34
- end
35
- end
36
- end
@@ -1,53 +0,0 @@
1
- class WarningsSpy
2
- class Reader
3
- attr_reader :warning_groups
4
-
5
- def initialize(filesystem)
6
- @warnings_file = filesystem.warnings_file
7
-
8
- @current_group = []
9
- @warning_groups = []
10
- end
11
-
12
- def read
13
- warnings_file.rewind
14
-
15
- warnings_file.each_line do |line|
16
- process_line(line)
17
- end
18
-
19
- add_group(current_group)
20
- end
21
-
22
- protected
23
-
24
- attr_reader :warnings_file, :current_group
25
-
26
- private
27
-
28
- def process_line(line)
29
- if start_of_group?(line)
30
- add_group(current_group)
31
- @current_group = []
32
- end
33
-
34
- current_group << line
35
- end
36
-
37
- def start_of_group?(line)
38
- line =~ /^\S/
39
- end
40
-
41
- def add_group(group)
42
- unless group.empty? || group_already_added?(group)
43
- warning_groups << group
44
- end
45
- end
46
-
47
- def group_already_added?(group_to_be_added)
48
- warning_groups.any? do |group|
49
- group == group_to_be_added
50
- end
51
- end
52
- end
53
- end
@@ -1,88 +0,0 @@
1
- require 'forwardable'
2
-
3
- class WarningsSpy
4
- class Reporter
5
- extend Forwardable
6
-
7
- def initialize(partitioner, filesystem, project_name)
8
- @partitioner = partitioner
9
- @warnings_file = filesystem.warnings_file
10
- @relevant_warnings_file = filesystem.relevant_warnings_file
11
- @irrelevant_warnings_file = filesystem.irrelevant_warnings_file
12
- @project_name = project_name
13
- end
14
-
15
- def report
16
- reporting_all_groups do
17
- report_relevant_warning_groups
18
- report_irrelevant_warning_groups
19
- end
20
- end
21
-
22
- protected
23
-
24
- attr_reader :partitioner, :warnings_file, :relevant_warnings_file,
25
- :irrelevant_warnings_file, :project_name
26
-
27
- private
28
-
29
- def_delegators :partitioner, :relevant_warning_groups,
30
- :irrelevant_warning_groups
31
-
32
- def report_relevant_warning_groups
33
- if relevant_warning_groups.any?
34
- print_divider('-', 75, header: " #{project_name} warnings:")
35
- relevant_warning_groups.each do |group|
36
- group.each do |line|
37
- relevant_warnings_file.puts(line)
38
- puts line
39
- end
40
- end
41
- print_divider('-', 75)
42
- puts "#{project_name} warnings written to #{relevant_warnings_file.path}."
43
- end
44
- end
45
-
46
- def report_irrelevant_warning_groups
47
- if irrelevant_warning_groups.any?
48
- irrelevant_warning_groups.each do |group|
49
- group.each do |line|
50
- irrelevant_warnings_file.puts(line)
51
- end
52
- end
53
- puts "Non #{project_name} warnings were raised during the test run. These have been written to #{irrelevant_warnings_file.path}."
54
- end
55
- end
56
-
57
- def reporting_all_groups
58
- if relevant_warning_groups.any? || irrelevant_warning_groups.any?
59
- puts
60
- yield
61
- puts "All warnings were written to #{warnings_file.path}."
62
- puts
63
- end
64
- end
65
-
66
- def print_divider(character, count, options = {})
67
- puts
68
-
69
- if options[:header]
70
- first_count = 10
71
- second_count = options[:header].length - first_count
72
- string =
73
- horizontal_rule(character, first_count) +
74
- options[:header] +
75
- horizontal_rule(character, second_count)
76
- puts string
77
- else
78
- puts horizontal_rule(character, count)
79
- end
80
-
81
- puts
82
- end
83
-
84
- def horizontal_rule(character, count)
85
- character * count
86
- end
87
- end
88
- end
@@ -1,199 +0,0 @@
1
- require_relative '../lib/shoulda/matchers/version'
2
- require 'erb'
3
-
4
- module Shoulda
5
- module Matchers
6
- module DocumentationTasks
7
- extend Rake::DSL
8
-
9
- def self.create
10
- publisher = DocumentationPublisher.new
11
-
12
- namespace :docs do
13
- file DocumentationPublisher.gh_pages_dir do
14
- publisher.create_reference_to_gh_pages_branch
15
- end
16
-
17
- file DocumentationPublisher.docs_dir => DocumentationPublisher.gh_pages_dir
18
-
19
- task :setup => DocumentationPublisher.docs_dir do
20
- publisher.reset_repo_directory
21
- end
22
-
23
- desc 'Generate docs for a particular version'
24
- task :generate, [:version, :latest_version] => :setup do |t, args|
25
- unless args.version
26
- raise ArgumentError, "Missing version"
27
- end
28
-
29
- unless args.latest_version
30
- raise ArgumentError, "Missing latest_version"
31
- end
32
-
33
- publisher.generate_docs_for(args.version, latest_version: args.latest_version)
34
- end
35
-
36
- desc 'Watch source files for this project for changes and autogenerate docs accordingly'
37
- task :autogenerate do
38
- require 'fssm'
39
-
40
- project_directory = File.expand_path(File.dirname(__FILE__) + "/..")
41
-
42
- regenerate_docs = proc do
43
- print 'Regenerating docs... '
44
- if system('bundle exec yard doc &>/dev/null')
45
- puts 'done!'
46
- else
47
- print "\nCould not regenerate docs!!"
48
- end
49
- end
50
-
51
- regenerate_docs.call
52
-
53
- puts 'Waiting for documentation files to change...'
54
-
55
- FSSM.monitor do
56
- path project_directory do
57
- glob '{README.md,NEWS.md,.yardopts,docs/**/*.md,doc_config/yard/**/*.{rb,js,css,erb},lib/**/*.rb}'
58
- create(&regenerate_docs)
59
- update(&regenerate_docs)
60
- end
61
- end
62
- end
63
-
64
- desc 'Generate docs for a particular version and push them to GitHub'
65
- task :publish, [:version, :latest_version] => :setup do |t, args|
66
- unless args.version
67
- raise ArgumentError, "Missing version"
68
- end
69
-
70
- unless args.latest_version
71
- raise ArgumentError, "Missing latest_version"
72
- end
73
-
74
- publisher.generate_docs_for(args.version, latest_version: args.latest_version)
75
- publisher.publish_docs_for(args.version, latest_version: args.latest_version)
76
- end
77
-
78
- desc "Generate docs for version #{DocumentationPublisher.current_version} and push them to GitHub"
79
- task :publish_latest => :setup do
80
- publisher.publish_latest_version
81
- end
82
- end
83
- end
84
- end
85
-
86
- class DocumentationPublisher
87
- CURRENT_VERSION = Shoulda::Matchers::VERSION
88
- GITHUB_USERNAME = 'thoughtbot'
89
- # GITHUB_USERNAME = 'mcmire'
90
- GH_PAGES_DIR = ".#{GITHUB_USERNAME}-gh-pages"
91
- DOCS_DIR = "#{GH_PAGES_DIR}/docs"
92
-
93
- def self.current_version
94
- CURRENT_VERSION
95
- end
96
-
97
- def self.gh_pages_dir
98
- GH_PAGES_DIR
99
- end
100
-
101
- def self.docs_dir
102
- DOCS_DIR
103
- end
104
-
105
- def create_reference_to_gh_pages_branch
106
- system "git clone git@github.com:#{GITHUB_USERNAME}/shoulda-matchers.git #{GH_PAGES_DIR} --branch gh-pages"
107
- end
108
-
109
- def reset_repo_directory
110
- within_gh_pages_dir do
111
- system 'git fetch origin'
112
- system 'git reset --hard origin/gh-pages'
113
- end
114
- end
115
-
116
- def generate_docs_for(version, options = {})
117
- ref = determine_ref_from(version)
118
-
119
- system "rm -rf #{DOCS_DIR}/#{ref}"
120
- system "bundle exec yard -o #{DOCS_DIR}/#{ref}"
121
-
122
- add_version_to_index_page_for(ref, version)
123
-
124
- within_docs_dir do
125
- system "git add #{ref}"
126
- end
127
-
128
- if options[:latest_version]
129
- generate_file_that_redirects_to_latest_version(options[:latest_version])
130
- end
131
- end
132
-
133
- def publish_docs_for(version, options = {})
134
- message = build_commit_message(version)
135
-
136
- within_gh_pages_dir do
137
- system 'git clean -f'
138
- system "git commit -m '#{message}'"
139
- system 'git push origin gh-pages'
140
- end
141
- end
142
-
143
- def publish_latest_version
144
- version = Gem::Version.new(CURRENT_VERSION)
145
- options = {}
146
-
147
- unless version.prerelease?
148
- options[:latest_version] = version.to_s
149
- end
150
-
151
- generate_docs_for(CURRENT_VERSION, options)
152
- publish_docs_for(CURRENT_VERSION, options)
153
- end
154
-
155
- private
156
-
157
- def add_version_to_index_page_for(ref, version)
158
- within_docs_dir do
159
- filename = "#{ref}/index.html"
160
- content = File.read(filename)
161
- content.sub!(%r{<h1>shoulda-matchers.+</h1>}, "<h1>shoulda-matchers (#{version})</h1>")
162
- File.open(filename, 'w') {|f| f.write(content) }
163
- end
164
- end
165
-
166
- def generate_file_that_redirects_to_latest_version(version)
167
- ref = determine_ref_from(version)
168
- locals = { ref: ref, github_username: GITHUB_USERNAME }
169
-
170
- erb = ERB.new(File.read('doc_config/gh-pages/index.html.erb'))
171
-
172
- within_docs_dir do
173
- File.open('index.html', 'w') { |f| f.write(erb.result(binding)) }
174
- system 'git add index.html'
175
- end
176
- end
177
-
178
- def determine_ref_from(version)
179
- if version =~ /^\d+\.\d+\.\d+/
180
- 'v' + version
181
- else
182
- version
183
- end
184
- end
185
-
186
- def build_commit_message(version)
187
- "Regenerated docs for version #{version}"
188
- end
189
-
190
- def within_gh_pages_dir(&block)
191
- Dir.chdir(GH_PAGES_DIR, &block)
192
- end
193
-
194
- def within_docs_dir(&block)
195
- Dir.chdir(DOCS_DIR, &block)
196
- end
197
- end
198
- end
199
- end