appenv 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aef3777b394fe61bdbb200d3cbd929ca376545f5cbbf00974addc76fce4837ea
+  data.tar.gz: 2cc83fdca529d448a6082d908453fb636b0b4a5e0f8c5159a17e5cce3d571932
+SHA512:
+  metadata.gz: 2e934242f875a5cd60263420648df862f6bf372e35300193869ce6a1c47e0ffa88bc9ea1408a9aa72799a636d4338e5636d2cf8569f7e5fad1334fa499cef278
+  data.tar.gz: eb853acb47eadc57301dd987692a534da7ba1fcd4d2e67942decbc442a283dab947e6595174a9bd979c4b0064dcc0476e9ac04a3669160de0c68dd5f8f129bf2

data/lib/appenv/environment.rb

@@ -21,8 +21,8 @@ class AppEnv::Environment < ActiveSupport::OrderedOptions
   #    }
   #
   def expand(&blk)
-    source = _compile_source_env
-    blk.call(self, source)
+    @source = _compile_source_env
+    blk.call(self, @source)
   end
 
 
@@ -32,7 +32,7 @@ class AppEnv::Environment < ActiveSupport::OrderedOptions
   #    # Simple variable assignment:
   #    env.var1 = src.var_one
   #
-  #    # Variable assignment with `set`:
+  #    # Variable assignment with a block:
   #    env.set(:var2) {
   #      if abcd?
   #        'xyz'
@@ -41,8 +41,65 @@ class AppEnv::Environment < ActiveSupport::OrderedOptions
   #      end
   #    }
   #
-  def set(property, &blk)
-    self.send("#{property}=", blk.call)
+  def set(property, value = nil)
+    self[property] = block_given? ? yield : value
+  end
+
+
+  # Creates a property in the env, taking the value from the source hash.
+  # If you want to modify the value from the source before setting it in
+  # the env, supply a block that takes the src value and returns the env value.
+  #
+  # Options:
+  # * :from -- if the source property name differs, supply it
+  # * :required -- raise an error if the property is not assigned a value
+  #
+  def apply(property, options = {})
+    if options.kind_of?(String) || options.kind_of?(Symbol)
+      options = { :from => options }
+    end
+    val = @source[options[:from] || property]
+    self[property] = block_given? ? yield(val) : val
+    assert(property)  if options[:required]
+    self[property]
+  end
+
+
+  # Collect all the source properties that match the pattern as a hash.
+  # If a block is given, yield the hash to the block, which can modify values.
+  # Then merge the hash into the env.
+  #
+  def splat(pattern)
+    hash = ActiveSupport::OrderedOptions.new
+    @source.each_pair { |k, v| hash[k] ||= v  if k.to_s.match(pattern) }
+    yield(hash)  if block_given?
+    self.update(hash)
+  end
+
+
+  # After setting all the environment properties, assert which
+  # properties should exist. The Configurator will raise an
+  # exception listing the missing properties, if any.
+  #
+  def assert(*properties)
+    missing = properties.collect { |prop|
+      prop.to_s.upcase  unless self[prop]
+    }.compact
+    raise("AppEnv requires #{missing.join(', ')}")  if missing.any?
+  end
+
+
+  # Collect a line-by-line list of strings in the form: 'property = value'.
+  #
+  def to_a
+    collect { |k, v| "#{k} = #{v.inspect}" }
+  end
+
+
+  # Print a line-by-line list of env values to STDOUT.
+  #
+  def print(pad = '')
+    puts pad+to_a.join("\n"+pad)
   end
 
 
@@ -58,7 +115,7 @@ class AppEnv::Environment < ActiveSupport::OrderedOptions
 
     def _source_env_from_file
       src = {}
-      return src  unless File.exists?(@file)
+      return src  unless File.exist?(@file)
       File.open(@file, 'r').each_line { |ln|
         cln = ln.strip.sub(/^export\s+/, '')
         next  if cln.match(/^#/)

data/lib/appenv/version.rb

@@ -1,5 +1,5 @@
 module AppEnv
 
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 
 end

metadata

@@ -1,85 +1,60 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: appenv
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.1.0
 platform: ruby
-authors: 
+authors:
 - Joseph Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-06-05 00:00:00 +10:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2024-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activesupport
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
     - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Environment-variable compatible application configuration.
-email: 
-- joseph@booki.sh
+email: joseph@users.noreply.github.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- .gitignore
-- README.md
-- Rakefile
-- appenv.gemspec
+files:
 - lib/appenv.rb
 - lib/appenv/environment.rb
 - lib/appenv/version.rb
-- test/data/env
-- test/test_helper.rb
-- test/unit/test_environment.rb
-has_rdoc: true
-homepage: ""
-licenses: []
-
+homepage: https://github.com/joseph/appenv
+licenses:
+- MIT
+metadata:
+  github_repo: ssh://github.com/bksh/appenv
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 3.0.3.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Application environment configuration
-test_files: 
-- test/data/env
-- test/test_helper.rb
-- test/unit/test_environment.rb
+test_files: []

data/.gitignore

@@ -1 +0,0 @@
-.screenrc

data/README.md

@@ -1,35 +0,0 @@
-# APPENV
-
-A simple gem that gives you an application environment configuration object.
-Values are loaded from ENV or from an environment file such as `.env`.
-
-Similar to the `.env` feature in Foreman, but these values will be available
-to your application no matter how you launch it (script/rails, Passenger,
-Unicorn, rake, etc).
-
-For convenience, there is also compatibility with Bash-style environment
-declarations in your `.env` file; ie: `export ENV_VAR_NAME="foo"`.
-
-## Example
-
-You'd typically create your configuration object in `config/application.rb`.
-
-```ruby
-module ExampleProjectName
-
-  Env = AppEnv::Environment.new { |env, src|
-    env.domain = src.my_domain_variable || 'example.com'
-    env.set(:access_codes) {
-      src.access_codes ? src.access_codes.split : nil
-    }
-  }
-
-  # class Application < Rails::Application
-  # ... etc ...
-  #
-  # Your config is available globally in ExampleProjectName::Env.
-  #
-
-end
-
-```

data/Rakefile

@@ -1,10 +0,0 @@
-require 'rake/testtask'
-
-Rake::TestTask.new { |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/unit/test*.rb']
-  t.verbose = true
-}
-
-desc("Run tests")
-task(:default => :test)

data/appenv.gemspec

@@ -1,18 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/appenv/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.authors = ['Joseph Pearson']
-  gem.email = ['joseph@booki.sh']
-  gem.description = 'Environment-variable compatible application configuration.'
-  gem.summary = 'Application environment configuration'
-  gem.homepage = ''
-
-  gem.files = `git ls-files`.split($\)
-  gem.executables = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name = 'appenv'
-  gem.require_paths = ['lib']
-  gem.version = AppEnv::VERSION
-  gem.add_dependency('activesupport')
-end

data/test/data/env

@@ -1,3 +0,0 @@
-VAR_ONE="foo"
-export VAR_TWO="bar"
-# VAR_THREE="garply"

data/test/test_helper.rb

@@ -1,2 +0,0 @@
-require 'appenv'
-require 'test/unit'

data/test/unit/test_environment.rb

@@ -1,30 +0,0 @@
-require 'test_helper'
-
-class AppEnv::TestEnvironment < Test::Unit::TestCase
-
-  def test_sanity
-    assert_nothing_raised {
-      @env = AppEnv::Environment.new('test/data/env') { |env, src|
-        env.var1 = src.var_one
-        env.set(:var2) { src.var_two }
-        env.var3 = src.var_three || 'grault'
-      }
-    }
-    assert_equal('foo', @env.var1)
-    assert_equal('bar', @env.var2)
-    assert_equal('grault', @env.var3)
-  end
-
-
-  def test_expand
-    @env = AppEnv::Environment.new('test/data/env') { |env, src|
-      env.var1 = src.var_one
-    }
-    assert_equal('foo', @env.var1)
-    @env.expand { |env, src|
-      env.var2 = src.var_two
-    }
-    assert_equal('bar', @env.var2)
-  end
-
-end