envv 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 953e78210eb08257ab2065174ec9c946870786ad81e57326a90c2251c94109b1
-  data.tar.gz: fff4477832bba43454a33260009c54db61a28f2e1c69f896f587cba43f18c516
+  metadata.gz: 39d9bec08e12fbe078eafec545a6ff71a646808abd537c8a8550a9add89d7464
+  data.tar.gz: c6e9d7c02b5460379ae1a19858d715ba77052d7f6f4772efac2d8733ff36782a
 SHA512:
-  metadata.gz: 88bad0d1f5902143100ca1ede91645dd2d1772f13553bc4861966a7c766e81cb55327551a4aaf7b88aa21252e47144940e2227562b49bbcc532767727ce81b43
-  data.tar.gz: 9b616de18bf3e179068dbc3104fad5b34252ab08ef2e938c2149c043c64f53759ba1e791a496dd219ca2437535751279859a9870b3bc18d08f6ac868239f617e
+  metadata.gz: e1dfd29c1e66010630ac4cc6ce9d8024271075a1af5c7f37991e07c678dd1360da0fa6f5606eaed3ceed0045a226257d2726b98423d4c323348018c4e3bd9c3d
+  data.tar.gz: fe14b778db78cd69ebdc353a1fd691c70d92419d772f0aea00450a1b66466f7b9960dd68590b4d394aa43602a16b4b9522b54adac99ec402d490d47e9afba0fd

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 ## [Unreleased]
 
+## [0.2.1] - 2024-11-05
+
+- Security fixes: Bumps [rexml](https://github.com/ruby/rexml) from 3.2.6 to 3.3.9.
+
+## [0.2.0] - 2023-09-25
+
+- Refactoring with a ENVV::Base module to allow writing custom wrappers  
+
+## [0.1.2] - 2023-09-19
+
+- Fix (again…) changelog_uri in gemspec
+
 ## [0.1.1] - 2023-09-19
 
 - Fix changelog_uri in gemspec

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/envv.svg)](https://badge.fury.io/rb/envv)
+
 ![ENVV banner](doc/banner.svg)
 
 # ENVV
@@ -37,7 +39,7 @@ end
 ```
 
 If requirements are not satisfied, it will **raise an exception**. So be sure this validation occurs as soon as possible in the boot process of your application.
-In a Ruby On Rails application, you can place it in an initializer and ensure it will be executed first by naming it `app/initializers/01-envv.rb` for example, since initializers are run in alphabetical order.
+In a Ruby On Rails application, you can place it in an initializer and ensure it will be executed first by naming it `config/initializers/01-envv.rb` for example, since initializers are run in alphabetical order.
 
 If environment variables are validated, you can now access their coerced value with `ENVV#fetch` method:
 
@@ -53,6 +55,49 @@ ENVV.fetch("MY_INT_VAR") # ⇒ 4000
 ENVV.fetch("MY_BOOLEAN_VAR") # ⇒ true
 ```
 
+### Adding extra features with your own ENVV wrapper
+
+You can include [ENVV::Base](lib/envv/base.rb) in your own class or module and thus provide extra features.
+
+With a module
+
+```ruby
+module MyAppEnv
+  extend ENVV::Base
+
+  def is_dark?
+    fetch("IS_DARK")
+  end
+end
+
+MyAppEnv.build! do
+  required(:IS_DARK).filled(:bool)
+end
+
+# IS_DARK=True
+
+MyAppEnv.is_dark? # => true
+```
+
+With a class
+
+```ruby
+class MyAppEnv
+  include ENVV::Base
+
+  def [](key)
+    fetch(key)
+  end
+end
+
+e = MyAppEnv.new.build! do
+  required(:IS_DARK).filled(:bool)
+end
+e["IS_DARK"] # => true
+```
+
+Be creative !
+
 
 ## Development
 

data/envv.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/envv/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "envv"
+  spec.version = ENVV::VERSION
+  spec.authors = ["Fabrice Luraine"]
+  spec.email = ["16@asciiland.net"]
+
+  spec.summary = "Validates environment variables requirements with a schema and gives access to their coerced values."
+  spec.description = ""
+  spec.homepage = "https://github.com/16/envv"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/16/envv"
+  spec.metadata["changelog_uri"] = "https://github.com/16/envv/blob/main/CHANGELOG.md"
+
+  # 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 Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dry-schema", "~> 1.13"
+  spec.add_dependency "dry-initializer", "~> 3.1"
+
+  spec.add_development_dependency "bundler", "~> 2.4"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.19"
+  spec.add_development_dependency "standard", "~> 1.31"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/envv/base.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module ENVV
+  module Base
+    # Validates ENV vars with schema rules and store coerced values in ENVV registry
+    # @param [Proc] A block with Dry::Schema.Params rules
+    # @raise [ENVV::InvalidSchemaError] if env vars requirements are not validated
+    # @return [ENVV]
+    def build!(&rules)
+      rules or raise ArgumentError, <<~MESSAGE
+        A block of schema rules is required to build ENVV.
+            Example:
+
+              ENVV.build! do
+                required(:MY_STRING_VAR).filled(:string)
+                required(:MY_INT_VAR).filled(:integer, gt?: 3000)
+                required(:MY_BOOLEAN_VAR).filled(:bool)
+              end
+
+            More info:
+
+            - https://dry-rb.org/gems/dry-schema
+            - https://github.com/16/envv
+
+      MESSAGE
+
+      @schema = ::Dry::Schema.Params(&rules)
+      @registry = Builder.call(ENV, @schema)
+      freeze
+    end
+
+    # @raise [ENVV::NotBuilt] error if called before ENVV built (see #build!)
+    # @return [Dry::Schema.Params] used to validate environment variables
+    def schema
+      @schema
+    end
+
+    # @raise [ENVV::NotBuilt] error if called before ENVV built (see #build!)
+    # @return [ENVV::Registry] Hash-like instance created at build
+    def registry
+      @registry or raise(NotBuilt)
+    end
+
+    # Fetch a coerced environment variable.
+    #   This method use the same signature as Hash#fetch.
+    # @raise [KeyError] if `key` is not found and neither `default_value` nor a block was given.
+    # @overload fetch(key)
+    #   @param key [String, Symbol]
+    #   @return the value of the given `key` if found.
+    # @overload fetch(key, default_value)
+    #   @param key [String, Symbol]
+    #   @param default_value
+    #   @return `default_value` if `key` is not found and no block was given
+    # @overload fetch(key, &block)
+    #   @yields `key` to the block if `key` is not found and a block was given
+    #   @return the block's return value.
+    def fetch(key, default_value = nil, &block)
+      registry.fetch(key.to_s, default_value, &block)
+    end
+  end
+end

data/lib/envv/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ENVV
-  VERSION = "0.1.2"
+  VERSION = "0.2.1"
 end

data/lib/envv.rb

@@ -1,70 +1,12 @@
 # frozen_string_literal: true
 
-require "singleton"
 require "dry/schema"
 require_relative "envv/version"
 require_relative "envv/errors"
 require_relative "envv/registry"
 require_relative "envv/builder"
+require_relative "envv/base"
 
 module ENVV
-  module_function
-
-  # Validates ENV vars with schema rules and store coerced values in ENVV registry
-  # @param [Proc] A block with Dry::Schema.Params rules
-  # @raise [ENVV::InvalidSchemaError] if env vars requirements are not validated
-  # @return [ENVV]
-  def build!(&rules)
-    rules or raise ArgumentError, <<~MESSAGE
-      A block of schema rules is required to build ENVV.
-          Example:
-
-            ENVV.build! do
-              required(:MY_STRING_VAR).filled(:string)
-              required(:MY_INT_VAR).filled(:integer, gt?: 3000)
-              required(:MY_BOOLEAN_VAR).filled(:bool)
-            end
-
-          More info:
-
-          - https://dry-rb.org/gems/dry-schema
-          - https://github.com/16/envv
-
-    MESSAGE
-
-    @schema = ::Dry::Schema.Params(&rules)
-    @registry = Builder.call(ENV, @schema)
-    freeze
-  end
-
-  # @raise [ENVV::NotBuilt] error if called before ENVV built (see #build!)
-  # @return [Dry::Schema.Params] used to validate environment variables
-  def schema
-    @schema
-  end
-
-  # @raise [ENVV::NotBuilt] error if called before ENVV built (see #build!)
-  # @return [ENVV::Registry] Hash-like instance created at build
-  def registry
-    @registry or raise(NotBuilt)
-  end
-
-  # Fetch a coerced environment variable.
-  #   This method use the same signature as Hash#fetch.
-  # @raise [KeyError] if `key` is not found and neither `default_value` nor a block was given.
-  # @overload fetch(key)
-  #   @param key [String, Symbol]
-  #   @return the value of the given `key` if found.
-  # @overload fetch(key, default_value)
-  #   @param key [String, Symbol]
-  #   @param default_value
-  #   @return `default_value` if `key` is not found and no block was given
-  # @overload fetch(key, &block)
-  #   @yields `key` to the block if `key` is not found and a block was given
-  #   @return the block's return value.
-  def fetch(key, default_value = nil, &block)
-    registry.fetch(key.to_s, default_value, &block)
-  end
-
-  public :build!, :schema, :registry, :fetch
+  extend Base
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: envv
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Fabrice Luraine
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-19 00:00:00.000000000 Z
+date: 2024-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-schema
@@ -109,7 +109,9 @@ files:
 - Rakefile
 - doc/banner.inkscape.svg
 - doc/banner.svg
+- envv.gemspec
 - lib/envv.rb
+- lib/envv/base.rb
 - lib/envv/builder.rb
 - lib/envv/errors.rb
 - lib/envv/registry.rb