From b9941def7e6f7044387b60b845837bc9a4e39005 Mon Sep 17 00:00:00 2001 From: Joel Drapper Date: Tue, 6 May 2025 17:12:42 +0100 Subject: [PATCH] Prefer inline access modifiers --- .rubocop-https---www-goodcop-style-base-yml | 4 + ...ocop-https---www-goodcop-style-rubocop-yml | 188 ------------------ lib/phlex/csv.rb | 20 +- lib/phlex/fifo_cache_store.rb | 4 +- lib/phlex/helpers.rb | 6 +- lib/phlex/sgml.rb | 38 ++-- 6 files changed, 34 insertions(+), 226 deletions(-) delete mode 100644 .rubocop-https---www-goodcop-style-rubocop-yml diff --git a/.rubocop-https---www-goodcop-style-base-yml b/.rubocop-https---www-goodcop-style-base-yml index d144bebb..ab88a2f4 100644 --- a/.rubocop-https---www-goodcop-style-base-yml +++ b/.rubocop-https---www-goodcop-style-base-yml @@ -688,6 +688,10 @@ Security/YAMLLoad: Style/ArgumentsForwarding: Enabled: true +Style/AccessModifierDeclarations: + Enabled: true + EnforcedStyle: inline + Style/ComparableClamp: Enabled: true diff --git a/.rubocop-https---www-goodcop-style-rubocop-yml b/.rubocop-https---www-goodcop-style-rubocop-yml deleted file mode 100644 index db16b1fd..00000000 --- a/.rubocop-https---www-goodcop-style-rubocop-yml +++ /dev/null @@ -1,188 +0,0 @@ -AllCops: - NewCops: enable - -Bundler/OrderedGems: - Enabled: false - -Layout/ArgumentAlignment: - Enabled: false - -Layout/ArrayAlignment: - Enabled: false - -Layout/CaseIndentation: - Enabled: false - -Layout/CommentIndentation: - AllowForAlignment: true - -Layout/EndAlignment: - EnforcedStyleAlignWith: start_of_line - -Layout/HashAlignment: - Enabled: false - -Layout/LineLength: - Enabled: false - -Layout/MultilineMethodCallBraceLayout: - Enabled: false - -Layout/MultilineOperationIndentation: - Enabled: false - -Layout/SingleLineBlockChain: - Enabled: false - -Layout/SpaceInLambdaLiteral: - EnforcedStyle: require_space - -Lint/AmbiguousBlockAssociation: - Enabled: false - -Lint/EmptyClass: - AllowComments: true - -Lint/MissingSuper: - Enabled: false - -Lint/UnderscorePrefixedVariableName: - Enabled: false - -Lint/UnusedMethodArgument: - Enabled: false - -Metrics: - Enabled: false - -Naming/AccessorMethodName: - Enabled: false - -Naming/ConstantName: - Enabled: false - -Naming/MemoizedInstanceVariableName: - EnforcedStyleForLeadingUnderscores: optional - -Naming/MethodParameterName: - MinNameLength: 1 - -Style/AccessModifierDeclarations: - Enabled: false - -Style/AccessorGrouping: - Enabled: false - -Style/Alias: - EnforcedStyle: prefer_alias_method - -Style/BeginBlock: - Enabled: false - -Style/BlockDelimiters: - Enabled: false - -Style/CaseEquality: - Enabled: false - -Style/ClassAndModuleChildren: - Enabled: false - -Style/ClassCheck: - Enabled: false - -Style/ClassMethodsDefinitions: - Enabled: false - -Style/ConditionalAssignment: - Enabled: false - -Style/Documentation: - Enabled: false - -Style/DocumentDynamicEvalDefinition: - Enabled: false - -Style/DoubleNegation: - Enabled: false - -Style/EmptyCaseCondition: - Enabled: false - -Style/EmptyMethod: - Enabled: false - -Style/EndBlock: - Enabled: false - -Style/FetchEnvVar: - Enabled: false - -Style/GuardClause: - Enabled: false - -Style/IfUnlessModifier: - Enabled: false - -Style/IfUnlessModifierOfIfUnless: - Enabled: false - -Style/KeywordParametersOrder: - Enabled: false - -Style/MixinGrouping: - Enabled: false - -Style/ModuleFunction: - Enabled: false - -Style/MultilineMemoization: - Enabled: false - -Style/MultipleComparison: - Enabled: false - -Style/MutableConstant: - Enabled: false - -Style/NumberedParametersLimit: - Enabled: false - -Style/NumericLiterals: - Enabled: false - -Style/NumericPredicate: - Enabled: false - -Style/ParallelAssignment: - Enabled: false - -Style/PercentLiteralDelimiters: - Enabled: false - -Style/RedundantAssignment: - Enabled: false - -Style/Semicolon: - AllowAsExpressionSeparator: true - -Style/Send: - Enabled: false - -Style/StringConcatenation: - Enabled: false - -Style/StringLiterals: - EnforcedStyle: double_quotes - -Style/SymbolArray: - Enabled: false - -Style/TrailingCommaInHashLiteral: - Enabled: false - -Style/WordArray: - Enabled: false - -Style/ZeroLengthPredicate: - Enabled: false diff --git a/lib/phlex/csv.rb b/lib/phlex/csv.rb index 9fe2a358..777f6dda 100644 --- a/lib/phlex/csv.rb +++ b/lib/phlex/csv.rb @@ -139,32 +139,30 @@ def delimiter "," end - private - - def column(header = nil, value) + private def column(header = nil, value) @_row_buffer << [header, value] end - def each_item(&) + private def each_item(&) collection.each(&) end # Override and set to `false` to disable rendering headers. - def render_headers? + private def render_headers? true end # Override and set to `true` to strip leading and trailing whitespace from values. - def trim_whitespace? + private def trim_whitespace? false end # Override and set to `false` to disable CSV injection escapes or `true` to enable. - def escape_csv_injection? + private def escape_csv_injection? UNDEFINED end - def __escape__(buffer, value, escape_csv_injection:, strip_whitespace:, escape_regex:) + private def __escape__(buffer, value, escape_csv_injection:, strip_whitespace:, escape_regex:) value = case value when String value @@ -218,12 +216,12 @@ def __escape__(buffer, value, escape_csv_injection:, strip_whitespace:, escape_r end # Handle legacy `view_template` method - def respond_to_missing?(method_name, include_private) + private def respond_to_missing?(method_name, include_private) (method_name == :row_template && respond_to?(:view_template)) || super end # Handle legacy `view_template` method - def method_missing(method_name, ...) + private def method_missing(method_name, ...) if method_name == :row_template && respond_to?(:view_template) warn "Deprecated: Use `row_template` instead of `view_template` in Phlex CSVs." self.class.alias_method :row_template, :view_template @@ -233,7 +231,7 @@ def method_missing(method_name, ...) end end - def ensure_escape_csv_injection_configured! + private def ensure_escape_csv_injection_configured! if escape_csv_injection? == UNDEFINED raise <<~MESSAGE You need to define `escape_csv_injection?` in #{self.class.name}. diff --git a/lib/phlex/fifo_cache_store.rb b/lib/phlex/fifo_cache_store.rb index e7cdc075..9a375c56 100644 --- a/lib/phlex/fifo_cache_store.rb +++ b/lib/phlex/fifo_cache_store.rb @@ -28,9 +28,7 @@ def clear @fifo.clear end - private - - def map_key(value) + private def map_key(value) case value when Array value.map { |it| map_key(it) } diff --git a/lib/phlex/helpers.rb b/lib/phlex/helpers.rb index e0e882d4..e3a3672c 100644 --- a/lib/phlex/helpers.rb +++ b/lib/phlex/helpers.rb @@ -2,9 +2,7 @@ # @api private module Phlex::Helpers - private - - def mix(*args) + private def mix(*args) args.each_with_object({}) do |object, result| result.merge!(object) do |_key, old, new| case [old, new].freeze @@ -43,7 +41,7 @@ def mix(*args) end end - def grab(**bindings) + private def grab(**bindings) if bindings.size > 1 bindings.values else diff --git a/lib/phlex/sgml.rb b/lib/phlex/sgml.rb index 44eae4f7..655ddd99 100644 --- a/lib/phlex/sgml.rb +++ b/lib/phlex/sgml.rb @@ -336,52 +336,50 @@ def json_escape(string) ERB::Util.json_escape(string) end - private - # Override this method to use a different deployment key. - def app_version_key + private def app_version_key Phlex::DEPLOYED_AT end # Override this method to use a different cache store. - def cache_store + private def cache_store raise "Cache store not implemented." end - def enable_cache_reloading? + private def enable_cache_reloading? false end - def vanish(...) + private def vanish(...) capture(...) nil end - def render? + private def render? true end - def format_object(object) + private def format_object(object) case object when Float, Integer object.to_s end end - def around_template + private def around_template yield nil end - def before_template + private def before_template nil end - def after_template + private def after_template nil end - def __yield_content__ + private def __yield_content__ return unless block_given? buffer = @_state.buffer @@ -393,7 +391,7 @@ def __yield_content__ nil end - def __yield_content_with_no_yield_args__ + private def __yield_content_with_no_yield_args__ return unless block_given? buffer = @_state.buffer @@ -405,7 +403,7 @@ def __yield_content_with_no_yield_args__ nil end - def __yield_content_with_args__(*a) + private def __yield_content_with_args__(*a) return unless block_given? buffer = @_state.buffer @@ -417,7 +415,7 @@ def __yield_content_with_args__(*a) nil end - def __implicit_output__(content) + private def __implicit_output__(content) state = @_state return true unless state.should_render? @@ -442,7 +440,7 @@ def __implicit_output__(content) end # same as __implicit_output__ but escapes even `safe` objects - def __text__(content) + private def __text__(content) state = @_state return true unless state.should_render? @@ -464,7 +462,7 @@ def __text__(content) true end - def __attributes__(attributes, buffer = +"") + private def __attributes__(attributes, buffer = +"") attributes.each do |k, v| next unless v @@ -557,7 +555,7 @@ def __attributes__(attributes, buffer = +"") # Provides the nested-attributes case for serializing out attributes. # This allows us to skip many of the checks the `__attributes__` method must perform. - def __nested_attributes__(attributes, base_name, buffer = +"") + private def __nested_attributes__(attributes, base_name, buffer = +"") attributes.each do |k, v| next unless v @@ -606,7 +604,7 @@ def __nested_attributes__(attributes, base_name, buffer = +"") end end - def __nested_tokens__(tokens) + private def __nested_tokens__(tokens) buffer = +"" i, length = 0, tokens.length @@ -654,7 +652,7 @@ def __nested_tokens__(tokens) end # Result is **unsafe**, so it should be escaped! - def __styles__(styles) + private def __styles__(styles) case styles when Array, Set styles.filter_map do |s|