14802019493

Committed 02 May 2025 07:30PM UTC coverage: 84.48% (-0.04%) from 84.517%

Build # 14802019493

Build Type

Pull #37

github

Committed by

gregschmit

Commit Message

Try out rubocop omakase.

Pull Request Pull Request #37: Use Omakase Rubocop

Run Details

115 of 148 new or added lines in 18 files covered. (77.7%)

9 existing lines in 2 files now uncovered.

1056 of 1250 relevant lines covered (84.48%)

98.91 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

95.08

/lib/rest_framework.rb

# frozen_string_literal: true

module RESTFramework
  BUILTIN_ACTIONS = {
    index: :get,
    new: :get,
    create: :post,
  }.freeze
  BUILTIN_MEMBER_ACTIONS = {
    show: :get,
    edit: :get,
    update: [ :put, :patch ].freeze,
    destroy: :delete,
  }.freeze
  RRF_BUILTIN_ACTIONS = {
    options: :options,
  }.freeze
  RRF_BUILTIN_BULK_ACTIONS = {
    update_all: [ :put, :patch ].freeze,
    destroy_all: :delete,
  }.freeze

  # Storage for extra routes and associated metadata.
  EXTRA_ACTION_ROUTES = Set.new
  ROUTE_METADATA = {}

  # We put most vendored external assets into these files to make precompilation and serving faster.
  EXTERNAL_CSS_NAME = "rest_framework/external.min.css"
  EXTERNAL_JS_NAME = "rest_framework/external.min.js"

  # We should always add the `.min` extension prefix even if the assets are not minified, to avoid
  # sprockets minifying the assets. We target propshaft, so we want these assets to just be passed
  # through.
  # rubocop:disable Layout/LineLength
  EXTERNAL_ASSETS = {
    # Bootstrap
    "bootstrap.min.css" => {
      url: "https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css",
      sri: "sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH",
    },
    "bootstrap.min.js" => {
      url: "https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js",
      sri: "sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz",
    },

    # Bootstrap Icons
    "bootstrap-icons.min.css" => {
      url: "https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css",
      inline_fonts: true,
    },

    # Highlight.js
    "highlight.min.js" => {
      url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.0/highlight.min.js",
      sri: "sha512-6QBAC6Sxc4IF04SvIg0k78l5rP5YgVjmHX2NeArelbxM3JGj4imMqfNzEta3n+mi7iG3nupdLnl3QrbfjdXyTg==",
    },
    "highlight-json.min.js" => {
      url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.0/languages/json.min.js",
      sri: "sha512-8JO7/pRnd1Ce8OBXWQg85e5wNPJdBaQdN8w4oDa+HelMXaLwCxTdbzdWHmJtWR9AmcI6dOln4FS5/KrzpxqqfQ==",
    },
    "highlight-xml.min.js" => {
      url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.0/languages/xml.min.js",
      sri: "sha512-/vq6wbS2Qkv8Hj4mP3Jd/m6MbnIrquzZiUt9tIluQfe332IQeFDrSIK7j2cjAyn6/9Ntb2WMPbo1CAxu26NViA==",
    },
    "highlight-a11y-dark.min.css" => {
      url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.0/styles/a11y-dark.min.css",
      sri: "sha512-Vj6gPCk8EZlqnoveEyuGyYaWZ1+jyjMPg8g4shwyyNlRQl6d3L9At02ZHQr5K6s5duZl/+YKMnM3/8pDhoUphg==",
      extra_tag_attrs: { class: "rrf-dark-mode" },
    },
    "highlight-a11y-light.min.css" => {
      url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.0/styles/a11y-light.min.css",
      sri: "sha512-WDk6RzwygsN9KecRHAfm9HTN87LQjqdygDmkHSJxVkVI7ErCZ8ZWxP6T8RvBujY1n2/E4Ac+bn2ChXnp5rnnHA==",
      extra_tag_attrs: { class: "rrf-light-mode" },
    },

    # NeatJSON
    "neatjson.min.js" => {
      url: "https://cdn.jsdelivr.net/npm/neatjson@0.10.6/javascript/neatjson.min.js",
      exclude_from_docs: true,
    },

    # Trix
    "trix.min.css" => {
      url: "https://unpkg.com/trix@2.0.8/dist/trix.css",
      exclude_from_docs: true,
    },
    "trix.min.js" => {
      url: "https://unpkg.com/trix@2.0.8/dist/trix.umd.min.js",
      exclude_from_docs: true,
    },
  }.map { |name, cfg|
    ext = File.extname(name)
    if ext == ".js"
      cfg[:place] = "javascripts"
      cfg[:extra_tag_attrs] ||= {}
      cfg[:tag_attrs] = {
        src: cfg[:url],
        integrity: cfg[:sri],
        crossorigin: "anonymous",
        referrerpolicy: "no-referrer",
        defer: true,
        **cfg[:extra_tag_attrs],
      }
      cfg[:tag] = ActionController::Base.helpers.tag.script(**cfg[:tag_attrs])
    elsif ext == ".css"
      cfg[:place] = "stylesheets"
      cfg[:extra_tag_attrs] ||= {}
      cfg[:tag_attrs] = {
        rel: "stylesheet",
        href: cfg[:url],
        integrity: cfg[:sri],
        crossorigin: "anonymous",
        **cfg[:extra_tag_attrs],
      }
      cfg[:tag] = ActionController::Base.helpers.tag.link(**cfg[:tag_attrs])
    else
      raise "Unknown asset extension: #{ext}."
    end

    [ name, cfg ]
  }.to_h.freeze
  # rubocop:enable Layout/LineLength

  EXTERNAL_UNSUMMARIZED_ASSETS = EXTERNAL_ASSETS.select { |_, cfg| cfg[:extra_tag_attrs].present? }

  # Global configuration should be kept minimal, as controller-level configurations allows multiple
  # APIs to be defined to behave differently.
  class Config
    DEFAULT_LABEL_FIELDS = %w[name label login title email username url].freeze
    DEFAULT_SEARCH_COLUMNS = DEFAULT_LABEL_FIELDS + %w[description note].freeze
    DEFAULT_EXCLUDE_BODY_FIELDS = %w[
      created_at
      created_by
      created_by_id
      updated_at
      updated_by
      updated_by_id
      _method
      utf8
      authenticity_token
    ].freeze

    # Permits use of `render(api: obj)` syntax over `render_api(obj)`; `true` by default.
    attr_accessor :register_api_renderer

    # Run `rrf_finalize` on controllers automatically using a `TracePoint` hook. This is `true` by
    # default, and can be disabled for performance, and must be global because we have to determine
    # this before any controller-specific configuration is set. If this is set to `false`, then you
    # must manually call `rrf_finalize` after any configuration on each controller that needs to
    # participate in:
    #  - Model delegation, for the helper methods to be defined dynamically.
    #  - Websockets, for `::Channel` class to be defined dynamically.
    #  - Controller configuration freezing.
    attr_accessor :auto_finalize

    # Freeze configuration attributes during finalization to prevent accidental mutation.
    attr_accessor :freeze_config

    # Specify reverse association tables that are typically very large, and therefore should not be
    # added to fields by default.
    attr_accessor :large_reverse_association_tables

    # Whether the backtrace should be shown in rescued errors.
    attr_accessor :show_backtrace

    # Disable `rescue_from` on the controller mixins.
    attr_accessor :disable_rescue_from

    # The default label fields to use when generating labels for `has_many` associations.
    attr_accessor :label_fields

    # The default search columns to use when generating search filters.
    attr_accessor :search_columns

    # The default list of fields to exclude from the body of the request.
    attr_accessor :exclude_body_fields

    # Option to use vendored assets (requires sprockets or propshaft) rather than linking to
    # external assets (the default).
    attr_accessor :use_vendored_assets

    def initialize
      self.register_api_renderer = true
      self.auto_finalize = true

      self.show_backtrace = Rails.env.development?

      self.label_fields = DEFAULT_LABEL_FIELDS
      self.search_columns = DEFAULT_SEARCH_COLUMNS
      self.exclude_body_fields = DEFAULT_EXCLUDE_BODY_FIELDS
    end
  end

  def self.config
    @config ||= Config.new
  end

  def self.configure
    yield(self.config)
  end

  def self.features
    @features ||= {}
  end
end

require_relative "rest_framework/engine"
require_relative "rest_framework/errors"
require_relative "rest_framework/filters"
require_relative "rest_framework/generators"
require_relative "rest_framework/mixins"
require_relative "rest_framework/paginators"
require_relative "rest_framework/routers"
require_relative "rest_framework/serializers"
require_relative "rest_framework/utils"
require_relative "rest_framework/version"

1	# frozen_string_literal: true
2
3	module RESTFramework	2✔
4	BUILTIN_ACTIONS = {	2✔
5	index: :get,
6	new: :get,
7	create: :post,
8	}.freeze
9	BUILTIN_MEMBER_ACTIONS = {
10	show: :get,	2✔
11	edit: :get,
12	update: [ :put, :patch ].freeze,
13	destroy: :delete,
14	}.freeze
15	RRF_BUILTIN_ACTIONS = {	2✔
16	options: :options,
17	}.freeze
18	RRF_BUILTIN_BULK_ACTIONS = {
19	update_all: [ :put, :patch ].freeze,	2✔
20	destroy_all: :delete,
21	}.freeze
22
23	# Storage for extra routes and associated metadata.
24	EXTRA_ACTION_ROUTES = Set.new	2✔
25	ROUTE_METADATA = {}	2✔
26
27	# We put most vendored external assets into these files to make precompilation and serving faster.
28	EXTERNAL_CSS_NAME = "rest_framework/external.min.css"	2✔
29	EXTERNAL_JS_NAME = "rest_framework/external.min.js"	2✔
30
31	# We should always add the `.min` extension prefix even if the assets are not minified, to avoid
32	# sprockets minifying the assets. We target propshaft, so we want these assets to just be passed
33	# through.
34	# rubocop:disable Layout/LineLength
35	EXTERNAL_ASSETS = {
36	# Bootstrap
37	"bootstrap.min.css" => {	2✔
38	url: "https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css",
39	sri: "sha384-QWTKZyjpPEjISv5WaRU9OFeRpok6YctnYmDr5pNlyT2bRjXh0JMhjY6hW+ALEwIH",
40	},
41	"bootstrap.min.js" => {
42	url: "https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js",
43	sri: "sha384-YvpcrYf0tY3lHB60NNkmXc5s9fDVZLESaAA55NDzOxhy9GkcIdslK1eN7N6jIeHz",
44	},
45
46	# Bootstrap Icons
47	"bootstrap-icons.min.css" => {
48	url: "https://cdn.jsdelivr.net/npm/bootstrap-icons@1.11.3/font/bootstrap-icons.min.css",
49	inline_fonts: true,
50	},
51
52	# Highlight.js
53	"highlight.min.js" => {
54	url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.0/highlight.min.js",
55	sri: "sha512-6QBAC6Sxc4IF04SvIg0k78l5rP5YgVjmHX2NeArelbxM3JGj4imMqfNzEta3n+mi7iG3nupdLnl3QrbfjdXyTg==",
56	},
57	"highlight-json.min.js" => {
58	url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.0/languages/json.min.js",
59	sri: "sha512-8JO7/pRnd1Ce8OBXWQg85e5wNPJdBaQdN8w4oDa+HelMXaLwCxTdbzdWHmJtWR9AmcI6dOln4FS5/KrzpxqqfQ==",
60	},
61	"highlight-xml.min.js" => {
62	url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.0/languages/xml.min.js",
63	sri: "sha512-/vq6wbS2Qkv8Hj4mP3Jd/m6MbnIrquzZiUt9tIluQfe332IQeFDrSIK7j2cjAyn6/9Ntb2WMPbo1CAxu26NViA==",
64	},
65	"highlight-a11y-dark.min.css" => {
66	url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.0/styles/a11y-dark.min.css",
67	sri: "sha512-Vj6gPCk8EZlqnoveEyuGyYaWZ1+jyjMPg8g4shwyyNlRQl6d3L9At02ZHQr5K6s5duZl/+YKMnM3/8pDhoUphg==",
68	extra_tag_attrs: { class: "rrf-dark-mode" },
69	},
70	"highlight-a11y-light.min.css" => {
71	url: "https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.11.0/styles/a11y-light.min.css",
72	sri: "sha512-WDk6RzwygsN9KecRHAfm9HTN87LQjqdygDmkHSJxVkVI7ErCZ8ZWxP6T8RvBujY1n2/E4Ac+bn2ChXnp5rnnHA==",
73	extra_tag_attrs: { class: "rrf-light-mode" },
74	},
75
76	# NeatJSON
77	"neatjson.min.js" => {
78	url: "https://cdn.jsdelivr.net/npm/neatjson@0.10.6/javascript/neatjson.min.js",
79	exclude_from_docs: true,
80	},
81
82	# Trix
83	"trix.min.css" => {
84	url: "https://unpkg.com/trix@2.0.8/dist/trix.css",
85	exclude_from_docs: true,
86	},
87	"trix.min.js" => {
88	url: "https://unpkg.com/trix@2.0.8/dist/trix.umd.min.js",
89	exclude_from_docs: true,
90	},
91	}.map { \|name, cfg\|
92	ext = File.extname(name)	22✔
93	if ext == ".js"	22✔
94	cfg[:place] = "javascripts"	12✔
95	cfg[:extra_tag_attrs] \|\|= {}	12✔
96	cfg[:tag_attrs] = {	12✔
97	src: cfg[:url],
98	integrity: cfg[:sri],
99	crossorigin: "anonymous",
100	referrerpolicy: "no-referrer",
101	defer: true,
102	**cfg[:extra_tag_attrs],
103	}
104	cfg[:tag] = ActionController::Base.helpers.tag.script(**cfg[:tag_attrs])	12✔
105	elsif ext == ".css"	10✔
106	cfg[:place] = "stylesheets"	10✔
107	cfg[:extra_tag_attrs] \|\|= {}	10✔
108	cfg[:tag_attrs] = {	10✔
109	rel: "stylesheet",
110	href: cfg[:url],
111	integrity: cfg[:sri],
112	crossorigin: "anonymous",
113	**cfg[:extra_tag_attrs],
114	}
115	cfg[:tag] = ActionController::Base.helpers.tag.link(**cfg[:tag_attrs])	10✔
116	else
117	raise "Unknown asset extension: #{ext}."	×
118	end
119
120	[ name, cfg ]	22✔
121	}.to_h.freeze
122	# rubocop:enable Layout/LineLength
123
124	EXTERNAL_UNSUMMARIZED_ASSETS = EXTERNAL_ASSETS.select { \|_, cfg\| cfg[:extra_tag_attrs].present? }	24✔
125
126	# Global configuration should be kept minimal, as controller-level configurations allows multiple
127	# APIs to be defined to behave differently.
128	class Config	2✔
129	DEFAULT_LABEL_FIELDS = %w[name label login title email username url].freeze	2✔
130	DEFAULT_SEARCH_COLUMNS = DEFAULT_LABEL_FIELDS + %w[description note].freeze	2✔
131	DEFAULT_EXCLUDE_BODY_FIELDS = %w[	2✔
132	created_at
133	created_by
134	created_by_id
135	updated_at
136	updated_by
137	updated_by_id
138	_method
139	utf8
140	authenticity_token
141	].freeze
142
143	# Permits use of `render(api: obj)` syntax over `render_api(obj)`; `true` by default.
144	attr_accessor :register_api_renderer	2✔
145
146	# Run `rrf_finalize` on controllers automatically using a `TracePoint` hook. This is `true` by
147	# default, and can be disabled for performance, and must be global because we have to determine
148	# this before any controller-specific configuration is set. If this is set to `false`, then you
149	# must manually call `rrf_finalize` after any configuration on each controller that needs to
150	# participate in:
151	# - Model delegation, for the helper methods to be defined dynamically.
152	# - Websockets, for `::Channel` class to be defined dynamically.
153	# - Controller configuration freezing.
154	attr_accessor :auto_finalize	2✔
155
156	# Freeze configuration attributes during finalization to prevent accidental mutation.
157	attr_accessor :freeze_config	2✔
158
159	# Specify reverse association tables that are typically very large, and therefore should not be
160	# added to fields by default.
161	attr_accessor :large_reverse_association_tables	2✔
162
163	# Whether the backtrace should be shown in rescued errors.
164	attr_accessor :show_backtrace	2✔
165
166	# Disable `rescue_from` on the controller mixins.
167	attr_accessor :disable_rescue_from	2✔
168
169	# The default label fields to use when generating labels for `has_many` associations.
170	attr_accessor :label_fields	2✔
171
172	# The default search columns to use when generating search filters.
173	attr_accessor :search_columns	2✔
174
175	# The default list of fields to exclude from the body of the request.
176	attr_accessor :exclude_body_fields	2✔
177
178	# Option to use vendored assets (requires sprockets or propshaft) rather than linking to
179	# external assets (the default).
180	attr_accessor :use_vendored_assets	2✔
181
182	def initialize	2✔
183	self.register_api_renderer = true	2✔
184	self.auto_finalize = true	2✔
185
186	self.show_backtrace = Rails.env.development?	2✔
187
188	self.label_fields = DEFAULT_LABEL_FIELDS	2✔
189	self.search_columns = DEFAULT_SEARCH_COLUMNS	2✔
190	self.exclude_body_fields = DEFAULT_EXCLUDE_BODY_FIELDS	2✔
191	end
192	end
193
194	def self.config	2✔
195	@config \|\|= Config.new	1,306✔
196	end
197
198	def self.configure	2✔
199	yield(self.config)	×
200	end
201
202	def self.features	2✔
NEW 203	@features \|\|= {}	×
204	end
205	end
206
207	require_relative "rest_framework/engine"	2✔
208	require_relative "rest_framework/errors"	2✔
209	require_relative "rest_framework/filters"	2✔
210	require_relative "rest_framework/generators"	2✔
211	require_relative "rest_framework/mixins"	2✔
212	require_relative "rest_framework/paginators"	2✔
213	require_relative "rest_framework/routers"	2✔
214	require_relative "rest_framework/serializers"	2✔
215	require_relative "rest_framework/utils"	2✔
216	require_relative "rest_framework/version"	2✔

gregschmit / rails-rest-framework / 14802019493

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous