class RuboCop::Cop::Gemspec::DependencyVersion
Enforce that gem dependency version specifications or a commit reference (branch, ref, or tag) are either required or forbidden.
@example EnforcedStyle: required (default)
# bad Gem::Specification.new do |spec| spec.add_dependency 'parser' end # bad Gem::Specification.new do |spec| spec.add_development_dependency 'parser' end # good Gem::Specification.new do |spec| spec.add_dependency 'parser', '>= 2.3.3.1', '< 3.0' end # good Gem::Specification.new do |spec| spec.add_development_dependency 'parser', '>= 2.3.3.1', '< 3.0' end
@example EnforcedStyle: forbidden
# bad Gem::Specification.new do |spec| spec.add_dependency 'parser', '>= 2.3.3.1', '< 3.0' end # bad Gem::Specification.new do |spec| spec.add_development_dependency 'parser', '>= 2.3.3.1', '< 3.0' end # good Gem::Specification.new do |spec| spec.add_dependency 'parser' end # good Gem::Specification.new do |spec| spec.add_development_dependency 'parser' end
Constants
- ADD_DEPENDENCY_METHODS
- FORBIDDEN_MSG
- REQUIRED_MSG
- RESTRICT_ON_SEND
- VERSION_SPECIFICATION_REGEX
Public Instance Methods
Source
# File lib/rubocop/cop/gemspec/dependency_version.rb, line 82 def on_send(node) return unless add_dependency_method_declaration?(node) return if allowed_gem?(node) if offense?(node) add_offense(node) opposite_style_detected else correct_style_detected end end
Private Instance Methods
Source
# File lib/rubocop/cop/gemspec/dependency_version.rb, line 118 def add_dependency_method?(method_name) ADD_DEPENDENCY_METHODS.include?(method_name) end
Source
# File lib/rubocop/cop/gemspec/dependency_version.rb, line 96 def allowed_gem?(node) allowed_gems.include?(node.first_argument.str_content) end
Source
# File lib/rubocop/cop/gemspec/dependency_version.rb, line 100 def allowed_gems Array(cop_config['AllowedGems']) end
Source
# File lib/rubocop/cop/gemspec/dependency_version.rb, line 132 def forbidden_offense?(node) return false unless forbidden_style? includes_version_specification?(node) || includes_commit_reference?(node) end
Source
# File lib/rubocop/cop/gemspec/dependency_version.rb, line 138 def forbidden_style? style == :forbidden end
Source
# File lib/rubocop/cop/gemspec/dependency_version.rb, line 112 def match_block_variable_name?(receiver_name) gem_specification(processed_source.ast) do |block_variable_name| return block_variable_name == receiver_name end end
Source
# File lib/rubocop/cop/gemspec/dependency_version.rb, line 104 def message(_range) if required_style? REQUIRED_MSG elsif forbidden_style? FORBIDDEN_MSG end end
Source
# File lib/rubocop/cop/gemspec/dependency_version.rb, line 122 def offense?(node) required_offense?(node) || forbidden_offense?(node) end
Source
# File lib/rubocop/cop/gemspec/dependency_version.rb, line 126 def required_offense?(node) return false unless required_style? !includes_version_specification?(node) && !includes_commit_reference?(node) end
Source
# File lib/rubocop/cop/gemspec/dependency_version.rb, line 142 def required_style? style == :required end
Source
# File lib/rubocop/cop/gemspec/dependency_version.rb, line 146 def version_specification?(expression) expression.match?(VERSION_SPECIFICATION_REGEX) end