activerecord-hashlike_access 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25fc3d615fa4c5dec3f58db1b116a2f1affc0d6ceb896b19a4c14c21fea7d485
-  data.tar.gz: 78545089eba9bb3a807f6cadaebe8f4c39f7c80c3f887f1f79042db5383feca2
+  metadata.gz: de5302f3fccb412e6b30307a7bbcdc52b0da026d5ad3f52e081704220c89460a
+  data.tar.gz: 8935894c2b82672909f976ddfed9552a0fd74aec52dcb9383b93d7d8f15020fa
 SHA512:
-  metadata.gz: 0e0f4b79e1bfd1f1ba58c153e5d7181ef399cf5866087d30b15283ff013f3f12a90897238eecab8f74fbdec7785ec5aef19f37f673315063a4b0f581ca821e20
-  data.tar.gz: 3c8d30c4917cde11adcc4b81041c764ce3967f0a6a7b8f1e366a60e77b6808f4883b098a95deef89709b220be86910e88842af0fb5d751f0f90dcb5ffad31ae4
+  metadata.gz: fa22e231e8b3cf1e7448efc34d603ca9d65268d2f4189a0949367cbec95bd025ac0e443e164064dcd13f2d7fbd4fe0aff29f20d9a5eb82664230a6b145e1bae9
+  data.tar.gz: a9e954fb464a8a9bcda75d684e5bb6242a4218b94ea2a63e2d49077171d30bf7f70bcfbce5647421ddb4fe27cf4ebbef547f6b579e13dcb236848eba7d586695

data/.rubocop.yml

@@ -35,16 +35,9 @@ Metrics/MethodLength:
 
 Naming/VariableNumber:
   # Use the configured style when numbering symbols, methods and variables.
-  Enabled: false
-
+  Exclude:
+    - spec/**/*
 
-Style/AsciiComments:
-  # Use only ASCII symbols in comments.
-  #
-  # NLC: We're allowing non-breaking spaces (' '), as they're needed to prevent
-  #      browsers from collapsing multiple spaces in documentation code blocks.
-  AllowedChars:
-    - ' '
 
 Style/FormatString:
   # Enforce the use of Kernel#sprintf, Kernel#format or String#%.

data/.yardopts

@@ -1,4 +1,5 @@
---format=html
---markup=markdown
---output-dir=./docs
+--format='html'
+--markup='markdown'
+--output-dir='./docs'
 --private
+--query='!@api || (@api.text != "entrypoint")'

data/CHANGELOG.md

@@ -1,5 +1,20 @@
-## [Unreleased]
+# Changelog
 
-## [0.0.0] - 2026-08-06
+## v0.2.1 (2026-09-29)
+- **Documentation**:
+  - Removed `ActiveRecord::Base` from the class list.
+  - Added gem version badge to README.
+  - Added full documentation link to README.
+- **Chores**:
+  - Corrected typos in Gemspec URIs.
 
-- Initial release.
+## v0.2.0 (2026-08-18)
+- **Features**: Added a `require` entrypoint that provides hash-like access to all models.
+
+## v0.1.1 (2026-08-18)
+- **Chores**: Patch-bump to correct release version.
+
+## v0.1.0 (2026-08-18)
+(Note this was incorrectly released as version `0.0.0`.)
+- **Features**: Initial "hash-like access" implementation.
+- **Testing**: Proper testing of all expected behaviors.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    activerecord-hashlike_access (0.1.0)
+    activerecord-hashlike_access (0.2.0)
       activerecord (>= 6)
 
 GEM
@@ -145,7 +145,7 @@ DEPENDENCIES
 CHECKSUMS
   activemodel (8.1.3.1) sha256=99cc02ce2faec371d14440949d85787ebd23a907c9baef0a9d4bcd4d21888f88
   activerecord (8.1.3.1) sha256=0a2fb6c28f4938f6b013a3a549bec0a7e37d535f3dc8990e804bcc3258c0403b
-  activerecord-hashlike_access (0.1.0)
+  activerecord-hashlike_access (0.2.0)
   activesupport (8.1.3.1) sha256=85458765f25ea48b9019c46b6bb3fa5683197bf4280d9f06710a6e8d7a831376
   ast (2.4.3) sha256=954615157c1d6a382bc27d690d973195e79db7f55e9765ac7c481c60bdb4d383
   base64 (0.3.0) sha256=27337aeabad6ffae05c265c450490628ef3ebd4b67be58257393227588f5a97b

data/README.md

@@ -1,3 +1,4 @@
+[![Gem Version](https://img.shields.io/github/v/release/nestor-custodio/activerecord-hashlike_access?color=green&label=gem%20version)](https://rubygems.org/gems/activerecord-hashlike_access)
 [![MIT License](https://img.shields.io/github/license/nestor-custodio/activerecord-hashlike_access)](https://tldrlegal.com/license/mit-license)
 
 
@@ -42,13 +43,23 @@ Role[name] = new_display_text
 
 Importantly, note that **this gem works on the model, not its relations**. ActiveRecord's existing bracket constructs for referencing _relations_ (i.e. resultsets) in an `Array`-like fashion will continue to work as they always have.
 
+[Full documentation is available here](https://nestor-custodio.github.io/activerecord-hashlike_access/ActiveRecord/HashlikeAccess.html), but do read below for a crash course on availble featues!
+
 
 ## Installation
 
 - If your project uses [Bundler](https://github.com/bundler/bundler):
-  - Add the following to your application's Gemfile:
+  - Add one of the following to your application's Gemfile:
     ```ruby
+    # For on-demand usage:
+
     gem 'activerecord-hashlike_access'
+
+
+    # To automatically `extend ActiveRecord::HashlikeAccess`
+    # into all your (`ActiveRecord::Base`-descended) models:
+
+    gem 'activerecord-hashlike_access', require: 'active_record/hashlike_access/auto_extend'
     ```
   - And then run a:
     ```shell
@@ -220,7 +231,7 @@ Every instance of a hash-like lookup (`[some_key]`) is backed by a `find_by`/`fi
 
 ## Potential Gotchas
 
-As with anything ActiveRecord-related, there are always several ways to shoot yourself in the foot if you're not careful. Here are a few items to keep in mind and hopefully prevent this:
+As with anything ActiveRecord-related, there are ways to shoot yourself in the foot if you're not careful. Here are a few items to keep in mind and hopefully prevent this:
 
 - The hash-like access construct is essentially syntax sugar around ActiveRecord's `find_by` mechanism. For many (most?) database engines, selecting (or _including_, in the case of a multi-field key) an unindexed field for your lookups will likely result in a full-table scan with every hash-like access. Be mindful of what field(s) you're using as your key(s).
 

data/activerecord-hashlike_access.gemspec

@@ -1,33 +1,39 @@
 require_relative 'lib/active_record/hashlike_access/version'
 
 Gem::Specification.new do |spec|
-  spec.name = 'activerecord-hashlike_access'
-  spec.version = ActiveRecord::HashlikeAccess::VERSION
-  spec.authors = ['Nestor Custodio']
-  spec.email = ['nestor@custodio.org']
-
-  spec.summary = 'Provides Hash-like access to ActiveRecord models.'
-  spec.homepage = 'https://github.com/nestor-custodio/activerecord-hashlike_acces'
-  spec.license = 'MIT'
   spec.required_ruby_version = '>= 3.4'
 
-  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
-
-  spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG.md"
-  spec.metadata['rubygems_mfa_required'] = 'true'
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
-    end
-  end
-  spec.bindir = 'exe'
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.name          = 'activerecord-hashlike_access'
+  spec.version       = ActiveRecord::HashlikeAccess::VERSION
+  spec.authors       = ['Nestor Custodio']
+  spec.email         = ['nestor@custodio.org']
+
+  spec.summary       = 'Provides Hash-like access to ActiveRecord models.'
+  spec.homepage      = 'https://github.com/nestor-custodio/activerecord-hashlike_access'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0") - Dir['.[!.]*/**/*', 'bin/**/*', 'spec/**/*', '.git*']
+  spec.executables   = []
   spec.require_paths = ['lib']
 
+  # ---
+
+  spec.metadata = {
+    # See: https://guides.rubygems.org/specification-reference/#metadata
+
+    # RubyGems.org Security
+    #
+    'allowed_push_host'     => 'https://rubygems.org',
+    'rubygems_mfa_required' => 'true',
+
+    # Metadata-Provided URIs
+    #
+    'homepage_uri'          => spec.homepage,
+    'changelog_uri'         => "#{spec.homepage}/CHANGELOG.md"
+  }
+
+  # ---
+
   # This of course requires ActiveRecord.
   #
   spec.add_dependency 'activerecord', '>= 6'