rails_location_header 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 696b01eca7e43eed0195a37b7b4e5e5ba72ab9ac1e725241b8f267cfd8220d8b
-  data.tar.gz: 674590529d3ec6e6001a76956453d63294e8d0da5009dffb9c1add4303585e82
+  metadata.gz: 3998d156e632dbba5a1bdc4b5d418ff51dab1d93d4f29e72c244d8d0f76e9a46
+  data.tar.gz: 732d121b2e044c68595f505e6056977250fda8f16ca6dfc681b72aafe5d9e2c0
 SHA512:
-  metadata.gz: 60333c451604134cab7190adf7a7f2e35923db147768b476a4cb4e32207fa6b36fd70c80d2b14cd0da90e80222c9d50536af10da39e6931c6e5aae9fb076f905
-  data.tar.gz: c905acb2cf8d99fa27d86c44a532dad223c52e85a92fdf012dd75f370bdf5faa51f2e7f1216a7d560bccf5d0aa0f643e0c795d83a912043263b309f88b19d651
+  metadata.gz: 80bfbc95b3893e7125faaf292c11d0d61f390f66b615c2dea30278c8ebb91a16493ad51889cb22b8f8660e461534346ab45601f40f9add1210d0bf79178b0f43
+  data.tar.gz: 1586bd510a084e6c00caef89ce24fce0d05e0199408428f407da953afb8d297c18db05ed1aee9780c062dabde1308643d659ba7ea37ae09aa1ea03f2fb7283bc

data/.rubocop.yml

@@ -1,8 +1,313 @@
+plugins:
+  - rubocop-performance
+
+inherit_mode:
+  merge:
+    - Exclude
+
 AllCops:
-  TargetRubyVersion: 3.0
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - "data/**/*"
+    - "db/**/*"
+
+# All cops except your using extensions are disabled by default.
+Bundler:
+  Enabled: false
+Gemspec:
+  Enabled: false
+Layout:
+  Enabled: false
+Lint:
+  Enabled: false
+Metrics:
+  Enabled: false
+Naming:
+  Enabled: false
+Performance:
+  Enabled: false
+  Exclude:
+    - "test/**/*"
+    - "spec/**/*"
+Security:
+  Enabled: false
+Style:
+  Enabled: false
+
+# Align `when` with `end`.
+Layout/CaseIndentation:
+  Enabled: true
+  EnforcedStyle: end
+
+# Align comments with method definitions.
+Layout/CommentIndentation:
+  Enabled: true
+
+Layout/ElseAlignment:
+  Enabled: true
+
+Layout/EmptyLineAfterMagicComment:
+  Enabled: true
+
+Layout/EmptyLinesAroundBlockBody:
+  Enabled: true
+
+# In a regular class definition, no empty lines around the body.
+Layout/EmptyLinesAroundClassBody:
+  Enabled: true
+
+# In a regular method definition, no empty lines around the body.
+Layout/EmptyLinesAroundMethodBody:
+  Enabled: true
+
+# In a regular module definition, no empty lines around the body.
+Layout/EmptyLinesAroundModuleBody:
+  Enabled: true
+
+# Align `end` with the matching keyword or starting expression except for
+# assignments, where it should be aligned with the LHS.
+Layout/EndAlignment:
+  Enabled: true
+  EnforcedStyleAlignWith: variable
+
+# Method definitions after `private` or `protected` isolated calls need one
+# extra level of indentation.
+#
+# We break this rule in context, though, e.g. for private-only concerns,
+# so we leave it disabled.
+Layout/IndentationConsistency:
+  Enabled: false
+  EnforcedStyle: indented_internal_methods
+
+# Detect hard tabs, no hard tabs.
+Layout/IndentationStyle:
+  Enabled: true
+
+# Two spaces, no tabs (for indentation).
+#
+# Doesn't behave properly with private-only concerns, so it's disabled.
+Layout/IndentationWidth:
+  Enabled: false
+
+Layout/LeadingCommentSpace:
+  Enabled: true
+
+Layout/SpaceAfterColon:
+  Enabled: true
+
+Layout/SpaceAfterComma:
+  Enabled: true
+
+Layout/SpaceAroundEqualsInParameterDefault:
+  Enabled: true
+
+Layout/SpaceAroundKeyword:
+  Enabled: true
+
+# Use `foo {}` not `foo{}`.
+Layout/SpaceBeforeBlockBraces:
+  Enabled: true
+
+Layout/SpaceBeforeComma:
+  Enabled: true
+
+Layout/SpaceBeforeFirstArg:
+  Enabled: true
+
+# Use `[ a, [ b, c ] ]` not `[a, [b, c]]`
+# Use `[]` not `[ ]`
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: true
+  EnforcedStyle: no_space
+  EnforcedStyleForEmptyBrackets: no_space
+
+# Use `%w[ a b ]` not `%w[ a   b ]`.
+Layout/SpaceInsideArrayPercentLiteral:
+  Enabled: true
+
+# Use `foo { bar }` not `foo {bar}`.
+# Use `foo { }` not `foo {}`.
+Layout/SpaceInsideBlockBraces:
+  Enabled: true
+  EnforcedStyleForEmptyBraces: space
+
+# Use `{ a: 1 }` not `{a:1}`.
+# Use `{}` not `{  }`.
+Layout/SpaceInsideHashLiteralBraces:
+  Enabled: true
+  EnforcedStyle: space
+  EnforcedStyleForEmptyBraces: no_space
+
+# Use `foo(bar)` not `foo( bar )`
+Layout/SpaceInsideParens:
+  Enabled: true
+
+# Requiring a space is not yet supported as of 0.59.2
+# Use `%w[ foo ]` not `%w[foo]`
+Layout/SpaceInsidePercentLiteralDelimiters:
+  Enabled: false
+  #EnforcedStyle: space
+
+# Use `hash[:key]` not `hash[ :key ]`
+Layout/SpaceInsideReferenceBrackets:
+  Enabled: true
+
+# Blank lines should not have any spaces.
+Layout/TrailingEmptyLines:
+  Enabled: true
 
+# No trailing whitespace.
+Layout/TrailingWhitespace:
+  Enabled: true
+
+Lint/RedundantStringCoercion:
+  Enabled: true
+
+# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
+Lint/RequireParentheses:
+  Enabled: true
+
+Lint/UriEscapeUnescape:
+  Enabled: true
+
+Performance/FlatMap:
+  Enabled: true
+
+# We generally prefer &&/|| but like low-precedence and/or in context
+Style/AndOr:
+  Enabled: false
+
+# Prefer Foo.method over Foo::method
+Style/ColonMethodCall:
+  Enabled: true
+
+Style/DefWithParentheses:
+  Enabled: true
+
+# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
+Style/HashSyntax:
+  Enabled: true
+  EnforcedShorthandSyntax: either
+
+# Defining a method with parameters needs parentheses.
+Style/MethodDefParentheses:
+  Enabled: true
+
+Style/ParenthesesAroundCondition:
+  Enabled: true
+
+Style/PercentLiteralDelimiters:
+  Enabled: true
+  PreferredDelimiters:
+    default: "()"
+    "%i": "[]"
+    "%I": "[]"
+    "%r": "{}"
+    "%w": "[]"
+    "%W": "[]"
+
+# Use quotes for string literals when they are enough.
+Style/RedundantPercentQ:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: true
+  AllowMultipleReturnValues: false
+
+Style/Semicolon:
+  Enabled: true
+  AllowAsExpressionSeparator: true
+
+Style/StabbyLambdaParentheses:
+  Enabled: true
+
+# Use `"foo"` not `'foo'` unless escaping is required
 Style/StringLiterals:
-  EnforcedStyle: double_quotes
+  Enabled: true
+  EnforcedStyle: single_quotes
+  Include:
+    - "app/**/*"
+    - "config/**/*"
+    - "lib/**/*"
+    - "test/**/*"
+    - "spec/**/*"
+    - "Gemfile"
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+
+Layout/EmptyLineBetweenDefs:
+  Enabled: true
+
+Layout/LineLength:
+  Enabled: true
+  Exclude:
+    - "db/**/*"
+    - "config/routes.rb"
+    - "bin/**/*"
+
+Metrics/AbcSize:
+  Enabled: true
+  Max: 17
+  Exclude:
+    - "db/**/*"
+    - "config/routes.rb"
+    - "bin/**/*"
+
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - "db/**/*"
+    - "spec/**/*"
+    - "config/routes.rb"
+    - "bin/**/*"
+
+Metrics/BlockNesting:
+  Enabled: true
+  Max: 1
+  Exclude:
+    - "db/**/*"
+    - "config/routes.rb"
+    - "bin/**/*"
+
+Metrics/CyclomaticComplexity:
+  Enabled: true
+  Exclude:
+    - "db/**/*"
+    - "config/routes.rb"
+    - "bin/**/*"
+
+Metrics/MethodLength:
+  Enabled: true
+  Max: 8
+  Exclude:
+    - "db/**/*"
+    - "config/routes.rb"
+    - "bin/**/*"
+
+Metrics/PerceivedComplexity:
+  Enabled: true
+  Exclude:
+    - "db/**/*"
+    - "config/routes.rb"
+    - "bin/**/*"
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  EnforcedStyle: omit_parentheses
 
-Style/StringLiteralsInInterpolation:
-  EnforcedStyle: double_quotes
+Layout/EmptyLineAfterGuardClause:
+  Enabled: true

data/CHANGELOG.md

@@ -1,4 +1,44 @@
-## [Unreleased]
+## [1.0.1] - 2025-03-24
+
+### Added
+
+- Introduced `rubocop-performance` gem for enhanced linting capabilities.
+- Enabled additional RuboCop cops for improved code quality and consistency.
+
+### Changed
+
+- Updated `.rubocop.yml` to include detailed configuration for various cops.
+- Updated `Gemfile` to use single quotes for consistency.
+- Updated `Gemfile.lock` to reflect the addition of `rubocop-performance`.
+- Updated `rails_location_header.gemspec` to improve formatting and readability.
+- Updated `lib/rails_location_header.rb` and other files to align with RuboCop's style guidelines:
+  - Replaced double quotes with single quotes where applicable.
+  - Adjusted method calls to remove unnecessary parentheses.
+  - Improved formatting for multi-line method calls.
+
+### Fixed
+
+- Fixed minor inconsistencies in the `ControllerExtension` and `Railtie` modules.
+- Fixed version mismatch in `lib/rails_location_header/version.rb` (updated to `1.0.1`).
+
+### Removed
+
+- Removed unnecessary comments and redundant code from `rails_location_header.gemspec`.
+
+## [1.0.0] - 2025-03-24
+
+### Added
+
+- Added `X-Entity-ID` and `Location` headers to `create` actions via `ControllerExtension`.
+- Introduced `Middleware` class for potential future enhancements.
+- Integrated `Railtie` to automatically include `ControllerExtension` in Rails controllers.
+- Updated gemspec with metadata, dependencies, and author information.
+- Enhanced README with installation, usage, and contribution guidelines.
+
+### Changed
+
+- Updated version to `1.0.0` in `version.rb`.
+- Improved gemspec description and summary.
 
 ## [0.1.0] - 2025-03-24
 

data/README.md

@@ -18,12 +18,22 @@ gem install rails_location_header
 
 ## Usage
 
-To use this gem, include it in your Rails application. The gem automatically integrates with Rails controllers via a Railtie. When a `create` action successfully creates a resource (with a `201 Created` status), the following headers are added to the response:
+To use this gem, include it in your Rails application. The gem automatically integrates with Rails controllers via a Railtie and works out of the box.
+
+### How It Works
+
+1. **`create` action with a 201 status**: The `create` action must return an HTTP `201 Created` status.
+2. **Instance variable**: Declare an instance variable in the `create` action that matches the entity name (e.g., `@post` in `PostsController`).
+3. **`show` action and route**: Ensure the controller has a `show` action and a corresponding route to construct the resource's URL.
+
+### Headers Added
+
+When the above requirements are met, the gem automatically adds the following headers to the response:
 
 - `X-Entity-ID`: The ID of the created resource.
 - `Location`: The URL of the created resource.
 
-No additional configuration is required. Simply include the gem in your project, and it will work out of the box.
+No additional configuration is needed.
 
 ## Development
 

data/lib/rails_location_header/controller_extension.rb

@@ -11,22 +11,22 @@ module CreatedEntityHeader
     def add_location_header
       return unless response.status == 201
 
-      created_resource = instance_variable_get("@#{controller_name.singularize}")
-      return unless created_resource.respond_to?(:id)
+      created_resource = instance_variable_get "@#{controller_name.singularize}"
+      return unless created_resource.respond_to? :id
 
-      response.headers["X-Entity-ID"] = created_resource.id.to_s
+      response.headers['X-Entity-ID'] = created_resource.id.to_s
 
-      response.headers["Location"] = url_for(created_resource)
+      response.headers['Location'] = url_for created_resource
     end
 
     def url_for(created_resource)
       url_helpers = Rails.application.routes.url_helpers
-      url_helpers.url_for(
+      url_helpers.url_for \
         controller: controller_name, action: :show,
         id: created_resource.id,
         only_path: false,
         host: request.host, port: request.port
-      )
+
     rescue StandardError => e
       Rails.logger.warn "[RailsLocationHeader] Could not set Location Header: #{e.message}"
     end

data/lib/rails_location_header/railtie.rb

@@ -1,6 +1,6 @@
 module CreatedEntityHeader
   class Railtie < Rails::Railtie
-    initializer "created_entity_header.configure_controller" do
+    initializer 'created_entity_header.configure_controller' do
       ActiveSupport.on_load :action_controller do
         include CreatedEntityHeader::ControllerExtension
       end

data/lib/rails_location_header/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RailsLocationHeader
-  VERSION = "1.0.0"
+  VERSION = '1.0.2'
 end

data/lib/rails_location_header.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "rails_location_header/version"
-require "rails_location_header/railtie" if defined?(Rails)
-require "rails_location_header/controller_extension"
+require_relative 'rails_location_header/version'
+require 'rails_location_header/railtie' if defined?(Rails)
+require 'rails_location_header/controller_extension'
 
 module RailsLocationHeader
   class Middleware
@@ -11,7 +11,7 @@ module RailsLocationHeader
     end
 
     def call(env)
-      status, headers, response = @app.call(env)
+      status, headers, response = @app.call env
       [status, headers, response]
     end
   end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rails_location_header
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Eli Sebastian Herrera Aguilar
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-24 00:00:00.000000000 Z
+date: 2025-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,8 +23,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-description: A Rails gem that automatically adds X-Entity-ID and Location headers
-  when a new record is created successfully.
+description: |-
+  A Rails gem that automatically adds X-Entity-ID and Location headers when a new record is created
+                        successfully.
 email:
 - esrbastianherrera@gmail.com
 executables: []
@@ -51,7 +51,6 @@ metadata:
   homepage_uri: https://github.com/EliSebastian/rails_location_header
   source_code_uri: https://github.com/EliSebastian/rails_location_header
   changelog_uri: https://github.com/EliSebastian/rails_location_header/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -66,8 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Adds X-Entity-ID and Location headers in create actions.
 test_files: []