cre 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d91d919864b358dde52a257c05173cbad5fa6c6cac3e86b8d4cd1a385e4cd3a
-  data.tar.gz: 82534e175f6143a208468c4099f39d604c794bd0a38c6572bad3eafddb3899a1
+  metadata.gz: bb52087e9fb45f42d863d667afc789134168639efb231eae6a15f8a3572ea437
+  data.tar.gz: 10338d5b5b3dc14f795c465c878738e0291138814b11250938c177505c73abe4
 SHA512:
-  metadata.gz: b486fad7bdd65a0ee6775cada2d5fb5e388b8fd16838d7282df2e47007a0538236386996c2b7098091930ae0c4e07d3329414b8f486f931d1a39692f133eeb00
-  data.tar.gz: 86e71dda670c771c227cd090e4c97bfa3a38ac82785532718fa02766c3cd4e78caf73f81fd32b9fc159942e4b26f9816c0910d89eab2e5d4d20db04f57580e42
+  metadata.gz: 9e533e147486fe87264e81e7973fc5aa8fbe17d3a406e5c4a3704b209614e370ecdaa8b34814112cbc016288574b08e1753fa4ffd15d656834fd358f359d4539
+  data.tar.gz: 49e692e14c9d35fa5c9d70a4f4b1f23fc157f2d3aefb79dcc80782a7fe87097651a11d3f5f981d97a25490a3f76663192448488bd4488ebe85116e7d6cb49694

data/CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+## 2.2.0 (2026-08-02)
+
+No API changes. `Cre.dig` behaves exactly as before.
+
+### Changed
+
+- **Removed the `rails` runtime dependency.** Cre only ever touches
+  `Rails.application` at call time, inside your Rails app, where Rails is
+  already loaded. The gem now declares no runtime dependencies at all, so it
+  no longer constrains the Rails version in your bundle. Cre continues to
+  work on Rails 5.2 through 8.x (CI covers 6.1 through 8.1).
+- `Cre::Railtie` (an empty class) is no longer loaded by default. The
+  constant is still defined when Rails is present, for backward
+  compatibility, and will be removed in 3.0.
+- `Cre.defined_environments` is now memoized and uses `Dir.glob`, so it no
+  longer re-reads the directory on every call and no longer raises if
+  `config/environments` is missing.
+
+### Added
+
+- `Cre::Error` is raised with a clear message when `Cre.dig` is called
+  outside a booted Rails application (previously a bare `NameError`).
+- `Cre.dig` with no arguments now returns `nil` (previously raised
+  `NoMethodError`).
+- CI on GitHub Actions across Ruby 2.7-3.4 and Rails 6.1-8.1 (replaces
+  Travis).
+
+### Housekeeping
+
+- `Gemfile.lock`, `coverage/` and `.rspec_status` are no longer committed;
+  this also retires the long queue of automated lockfile security PRs,
+  which only ever flagged the development dependencies of the test app.
+- The spec dummy app boots on railties alone (no more ActiveRecord/sqlite3
+  in the development dependencies).
+- Gemspec metadata added (`changelog_uri`, `source_code_uri`,
+  `required_ruby_version >= 2.7`, `rubygems_mfa_required`).

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Khalil Gharbaoui
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,5 +1,7 @@
-[![Build Status](https://travis-ci.org/khalilgharbaoui/cre.svg?branch=master)](https://travis-ci.org/khalilgharbaoui/cre) [![Gem Version](https://badge.fury.io/rb/cre.svg)](https://badge.fury.io/rb/cre)
+[![CI](https://github.com/khalilgharbaoui/cre/actions/workflows/ci.yml/badge.svg)](https://github.com/khalilgharbaoui/cre/actions/workflows/ci.yml) [![Gem Version](https://badge.fury.io/rb/cre.svg)](https://badge.fury.io/rb/cre)
+
 # Cre
+
 This gem basically lets you dig out the rails encrypted credentials by simply doing:
 
 `Cre.dig(:password)` ✅
@@ -8,15 +10,17 @@ Instead of going the long way:
 
 `Rails.application.credentials.dig(Rails.env.to_sym, :password)` ❌
 
+Cre has **no runtime dependencies** and works on Rails 5.2 through 8.x.
+
 ## Usage
-By default it uses the currently active rails environment.
-Specify the environment specifically by adding it as the first argument.
-But do remember that it only considers `defined environments` in `config/environments`
+
+By default it uses the currently active rails environment. Specify the environment specifically by adding it as the first argument. But do remember that it only considers `defined environments` in `config/environments`
 
 `Cre.dig(:production, :password)`
 
 ⚠️ This assumes your credentials are setup like:
-```
+
+```yaml
 production:
   aws_key: 'somekeyproduction'
   password: 'fakepass'
@@ -26,37 +30,53 @@ development:
 test:
   aws_key: 'somekeytest'
   password: 'fakepass'
-```  
-It also supports deeper nested credentials for example:
 ```
-Cre.dig(:production, :aws, :client, secret, :key)
-```
-Or:  
+
+It also supports deeper nested credentials for example:
+
+```ruby
+Cre.dig(:production, :aws, :client, :secret, :key)
 ```
+
+Or:
+
+```ruby
 Cre.dig(:something, :nested, :multiple, :layers, :deep)
 ```
+
+### Good to know
+
+- Calling `Cre.dig` outside a booted Rails application raises `Cre::Error`
+  with a clear message.
+- If a top-level credential key has the same name as one of your defined
+  environments (e.g. a credential literally called `production`), the first
+  argument is interpreted as the environment selector. Give such keys a
+  different name.
+
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'cre', '~> 2.1.1'
+gem 'cre', '~> 2.2'
 ```
 
 And then execute:
-```bash
-$ bundle
-```
+
+    $ bundle
 
 Or install it yourself as:
-```bash
-$ gem install cre
-```
 
-##Todo:
-- Exeption handeling
+    $ gem install cre
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md).
 
 ## Contributing
+
 Contribution directions go here.
 
 ## License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/cre/railtie.rb

@@ -1,4 +1,9 @@
-module Cre
-  class Railtie < ::Rails::Railtie
+# Deprecated: this Railtie has always been empty and cre no longer loads it
+# by default. The constant is kept so existing references keep working.
+# It will be removed in cre 3.0.
+if defined?(::Rails::Railtie)
+  module Cre
+    class Railtie < ::Rails::Railtie
+    end
   end
 end

data/lib/cre/version.rb

@@ -1,3 +1,3 @@
 module Cre
-  VERSION = '2.1.1'
+  VERSION = '2.2.0'
 end

data/lib/cre.rb

@@ -1,7 +1,10 @@
-require "cre/railtie"
 require "cre/version"
+require "cre/railtie" if defined?(::Rails::Railtie)
 
 module Cre
+  # Raised when Cre is used outside a booted Rails application.
+  Error = Class.new(StandardError)
+
   # Fetching Rails encrypted credentials with:
   #   `Rails.application.credentials.dig(:environment, :credential)`
   # Is too long for my taste.
@@ -11,9 +14,11 @@ module Cre
   # specified and it is called with the credential only:
   #   `Cre.dig(:password)`
   # The dig method here is just an aesthetic thing to keep us in context.
-  # TODO: Add support for deeply nested credentials.
 
   def self.dig(*credentials)
+    ensure_rails_application!
+    return nil if credentials.empty?
+
     env, credentials = if defined_environments.include? credentials[0].to_sym
       [credentials[0].to_sym, credentials[1..-1].flatten.map(&:to_sym)]
     else
@@ -22,9 +27,20 @@ module Cre
     Rails.application.credentials.dig(env, *credentials)
   end
 
-  private
+  def self.ensure_rails_application!
+    return if defined?(::Rails) && ::Rails.respond_to?(:application) && ::Rails.application
+
+    raise Error, "Cre requires a booted Rails application " \
+                 "(Rails.application is not available)."
+  end
+  private_class_method :ensure_rails_application!
 
+  # NOTE: kept public for backward compatibility - the historic `private`
+  # keyword never applied to `def self.` methods, so this was always
+  # callable.
   def self.defined_environments
-    Dir.entries(Rails.root.join('config','environments').to_s).grep(/\.rb$/).map{ |filename| File.basename(filename, '.rb').to_sym }
+    @defined_environments ||=
+      Dir.glob(Rails.root.join("config", "environments", "*.rb"))
+         .map { |filename| File.basename(filename, ".rb").to_sym }
   end
 end

metadata

@@ -1,105 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cre
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Khalil Gharbaoui
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-17 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.11'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.11'
-- !ruby/object:Gem::Dependency
-  name: awesome_print
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.8'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.10'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.10'
-- !ruby/object:Gem::Dependency
-  name: sqlite3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.4.2
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
 description: "Cre reduces the amount of code you have to write when                      fetching
   rails credentials.                      If your encrypted credentials look like
   this:\n\n                      production:\n                        password: 'foobar'\n
@@ -116,19 +25,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- MIT-LICENSE
+- CHANGELOG.md
+- LICENSE.txt
 - README.md
-- Rakefile
 - lib/cre.rb
 - lib/cre/railtie.rb
 - lib/cre/version.rb
-- lib/tasks/cre_tasks.rake
 homepage: https://github.com/khalilgharbaoui/cre
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+  homepage_uri: https://github.com/khalilgharbaoui/cre
+  source_code_uri: https://github.com/khalilgharbaoui/cre
+  changelog_uri: https://github.com/khalilgharbaoui/cre/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/khalilgharbaoui/cre/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -136,15 +48,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key:
+rubygems_version: 4.0.12
 specification_version: 4
 summary: Fetch rails credentials the easy way!
 test_files: []

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright 2018 Khalil Gharbaoui
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,27 +0,0 @@
-begin
-  require 'bundler/setup'
-rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
-end
-
-require 'rdoc/task'
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Cre'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-require 'bundler/gem_tasks'
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-task default: :test

data/lib/tasks/cre_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :cre do
-#   # Task goes here
-# end