env_ext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf181a7ab8b681f2a72c90c2f2dc411bfa278ada9215ccc771529f39f4d6a5b2
+  data.tar.gz: 510e63c45a83b17ac02bbb616e4eda7f81ea4d9263939d5e157637fd5ba4e493
+SHA512:
+  metadata.gz: adc29127cb0ee3af12b3baf76d43839612d7a8088a678736546aa1e78187dc2b6100dce065607523c358bdd823215660c70b9f968046035e37dcfa30a0938784
+  data.tar.gz: fa51e166f74a0cad5a6d5c23aef3415e17e6196b2744cc5257fa3bbf2da3115dfc17a4ec785f025051b7c17a510321fcd3df3eeca0111549d73c6217833bab0b

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,3 @@
+/Gemfile.lock
+/doc/
+/pkg/

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "env Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,19 @@
+### 0.1.0 / 2020-12-27
+
+* Initial release:
+  * {EnvExt::Methods#paths ENV.paths} -`PATH`
+  * {EnvExt::Methods#ld_library_paths ENV.ld_library_paths} - `LD_LIBRARY_PATH`
+  * {EnvExt::Methods#host_name ENV.host_name} -`HOMENAME`
+  * {EnvExt::Methods#user ENV.user} -`USER` or `LOGNAME`
+  * {EnvExt::Methods#home ENV.home}` - `HOME`, `USERPROFILE`, or `HOMEPATH` and `HOMEDRIVE` on Windows.
+  * {EnvExt::Methods#lang ENV.lang} - `LANG`
+  * {EnvExt::Methods#timezone ENV.timezone} - `TZ`
+  * {EnvExt::Methods#shell ENV.shell} - `SHELL`
+  * {EnvExt::Methods#shell ENV.shell_name} - `SHELL`
+  * {EnvExt::Methods#columns ENV.columns} - `COLOMNS`
+  * {EnvExt::Methods#lines ENV.lines} - `LINES`
+  * {EnvExt::Methods#terminal ENV.terminal} - `TERM` or `COLORTERM`
+  * {EnvExt::Methods#editor ENV.editor} - `EDITOR`
+  * {EnvExt::Methods#browser ENV.browser} - `BROWSER`
+  * {EnvExt::Methods#debug? ENV.debug?} - `DEBUG`
+

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rubygems-tasks', '~> 0.2'
+  gem 'rspec',          '~> 3.0'
+  gem 'kramdown'
+  gem 'yard',           '~> 0.9'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011-2020 Hal Brodigan
+
+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

@@ -0,0 +1,67 @@
+# env_ext
+
+* [Homepage](https://github.com/postmodern/env_ext)
+* [Issues](https://github.com/postmodern/env_ext/issues)
+* [Documentation](http://rubydoc.info/gems/env_ext/frames)
+* [Email](mailto:postmodern.mod3 at gmail.com)
+
+## Description
+
+env_ext adds additional methods to `ENV` for common environment variables,
+used on Linux, BSD, OSX and Windows.
+
+## Methods
+
+* {EnvExt::Methods#paths ENV.paths} -`PATH`
+* {EnvExt::Methods#ld_library_paths ENV.ld_library_paths} - `LD_LIBRARY_PATH`
+* {EnvExt::Methods#host_name ENV.host_name} -`HOMENAME`
+* {EnvExt::Methods#user ENV.user} -`USER` or `LOGNAME`
+* {EnvExt::Methods#home ENV.home}` - `HOME`, `USERPROFILE`, or `HOMEPATH` and `HOMEDRIVE` on Windows.
+* {EnvExt::Methods#lang ENV.lang} - `LANG`
+* {EnvExt::Methods#timezone ENV.timezone} - `TZ`
+* {EnvExt::Methods#shell ENV.shell} - `SHELL`
+* {EnvExt::Methods#shell ENV.shell_name} - `SHELL`
+* {EnvExt::Methods#columns ENV.columns} - `COLOMNS`
+* {EnvExt::Methods#lines ENV.lines} - `LINES`
+* {EnvExt::Methods#terminal ENV.terminal} - `TERM` or `COLORTERM`
+* {EnvExt::Methods#editor ENV.editor} - `EDITOR`
+* {EnvExt::Methods#browser ENV.browser} - `BROWSER`
+* {EnvExt::Methods#debug? ENV.debug?} - `DEBUG`
+
+## Examples
+
+    require 'env_ext'
+
+Parse complex variables:
+
+    ENV.home
+    # => #<Pathname:/home/alice>
+    
+    ENV.paths
+    # => [#<Pathname:/usr/local/bin>, #<Pathname:/usr/bin>, #<Pathname:/bin>, #<Pathname:/usr/local/sbin>, #<Pathname:/usr/sbin>, #<Pathname:/sbin>]
+    
+    ENV.lang
+    # => ["en_US", "utf8"]
+    
+    ENV.terminal
+    # => "gnome-terminal"
+    
+    ENV.shell
+    # => "/bin/bash"
+    
+    ENV.editor
+    # => "vim"
+
+Extend your own `ENV` hash:
+
+    MyENV.extend EnvExt::Methods
+
+## Install
+
+    $ gem install env_ext
+
+## Copyright
+
+Copyright (c) 2011-2020 Hal Brodigan
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :test => :spec
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/env_ext.gemspec

@@ -0,0 +1,61 @@
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gem|
+  gemspec = YAML.load_file('gemspec.yml')
+
+  gem.name    = gemspec.fetch('name')
+  gem.version = gemspec.fetch('version') do
+                  lib_dir = File.join(File.dirname(__FILE__),'lib')
+                  $LOAD_PATH << lib_dir unless $LOAD_PATH.include?(lib_dir)
+
+                  require 'env_ext/version'
+                  EnvExt::VERSION
+                end
+
+  gem.summary     = gemspec['summary']
+  gem.description = gemspec['description']
+  gem.licenses    = Array(gemspec['license'])
+  gem.authors     = Array(gemspec['authors'])
+  gem.email       = gemspec['email']
+  gem.homepage    = gemspec['homepage']
+  gem.metadata    = gemspec['metadata'] if gemspec['metadata']
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files = `git ls-files`.split($/)
+  gem.files = glob[gemspec['files']] if gemspec['files']
+
+  gem.executables = gemspec.fetch('executables') do
+    glob['bin/*'].map { |path| File.basename(path) }
+  end
+  gem.default_executable = gem.executables.first if Gem::VERSION < '1.7.'
+
+  gem.extensions       = glob[gemspec['extensions'] || 'ext/**/extconf.rb']
+  gem.test_files       = glob[gemspec['test_files'] || '{test/{**/}*_test.rb']
+  gem.extra_rdoc_files = glob[gemspec['extra_doc_files'] || '*.{txt,md}']
+
+  gem.require_paths = Array(gemspec.fetch('require_paths') {
+    %w[ext lib].select { |dir| File.directory?(dir) }
+  })
+
+  gem.requirements              = gemspec['requirements']
+  gem.required_ruby_version     = gemspec['required_ruby_version']
+  gem.required_rubygems_version = gemspec['required_rubygems_version']
+  gem.post_install_message      = gemspec['post_install_message']
+
+  split = lambda { |string| string.split(/,\s*/) }
+
+  if gemspec['dependencies']
+    gemspec['dependencies'].each do |name,versions|
+      gem.add_dependency(name,split[versions])
+    end
+  end
+
+  if gemspec['development_dependencies']
+    gemspec['development_dependencies'].each do |name,versions|
+      gem.add_development_dependency(name,split[versions])
+    end
+  end
+end

data/gemspec.yml

@@ -0,0 +1,21 @@
+name: env_ext
+summary: Adds additional methods to ENV
+description:
+  env_ext adds additional methods to ENV for common environment variables,
+  used on Linux, BSD, OSX and Windows.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: https://github.com/postmodern/env_ext#readme
+
+metadata:
+  documentation_uri: https://rubydoc.info/gems/env_ext
+  source_code_uri: https://github.com/postmodern/env_ext
+  bug_tracker_uri: https://github.com/postmodern/env_ext/issues
+  changelog_uri: https://github.com/postmodern/env_ext/blob/master/ChangeLog.md
+
+has_yard: true
+
+development_dependencies:
+  bundler: ~> 2.0

data/lib/env_ext.rb

@@ -0,0 +1,2 @@
+require 'env_ext/core_ext'
+require 'env_ext/version'

data/lib/env_ext/core_ext.rb

@@ -0,0 +1,3 @@
+require 'env_ext/methods'
+
+ENV.send(:extend, EnvExt::Methods)

data/lib/env_ext/methods.rb

@@ -0,0 +1,198 @@
+require 'pathname'
+
+module EnvExt
+  module Methods
+    #
+    # The directories to search within for executables.
+    #
+    # @return [Array<Pathname>]
+    #   The paths of the directories.
+    #
+    def paths
+      parse_paths(self['PATH'])
+    end
+
+    #
+    # The directories to search within for libraries.
+    #
+    # @return [Array<Pathname>]
+    #   The paths of the directories.
+    #
+    def ld_library_paths
+      parse_paths(self['LD_LIBRARY_PATH'])
+    end
+
+    #
+    # The host-name of the system.
+    #
+    # @return [String]
+    #   The host-name.
+    #
+    def host_name
+      self['HOSTNAME']
+    end
+
+    #
+    # The name of the current user.
+    #
+    # @return [String]
+    #   The name of the user.
+    #
+    def user
+      # USER is used on GNU/Linux and Windows
+      # LOGNAME is the POSIX user-name ENV variable
+      self['USER'] || self['LOGNAME']
+    end
+
+    #
+    # The home directory.
+    #
+    # @return [Pathname]
+    #   The path of the home directory.
+    #
+    def home
+      # logic adapted from Gem.find_home.
+      path = if (self['HOME'] || self['USERPROFILE'])
+               self['HOME'] || self['USERPROFILE']
+             elsif (self['HOMEDRIVE'] && self['HOMEPATH'])
+               "#{self['HOMEDRIVE']}#{self['HOMEPATH']}"
+             else
+               begin
+                 File.expand_path('~')
+               rescue
+                 if File::ALT_SEPARATOR
+                   'C:/'
+                 else
+                   '/'
+                 end
+               end
+             end
+
+      return Pathname.new(path)
+    end
+
+    #
+    # The default language.
+    #
+    # @return [Array<String, String>]
+    #   The language name and encoding.
+    #
+    def lang
+      if (lang = self['LANG'])
+        lang.split('.',2)
+      else
+        []
+      end
+    end
+
+    #
+    # The default timezone.
+    #
+    # @return [String, nil]
+    #   The timezone name.
+    #
+    def timezone
+      self['TZ']
+    end
+
+    #
+    # The number of columns in the terminal.
+    #
+    # @return [Integer]
+    #   The number of columns.
+    #
+    def columns
+      self['COLUMNS'].to_i if self['COLUMNS']
+    end
+
+    #
+    # The number of lines in the terminal.
+    #
+    # @return [Integer]
+    #   The number of lines.
+    #
+    def lines
+      self['LINES'].to_i if self['LINES']
+    end
+
+    #
+    # The path of the default shell.
+    #
+    # @return [String, nil]
+    #   The path to the default shell.
+    #
+    def shell
+      self['SHELL']
+    end
+
+    #
+    # The name of the default shell.
+    #
+    # @return [String, nil]
+    #   The program name of the shell.
+    #
+    def shell_name
+      File.basename(shell) if shell
+    end
+
+    #
+    # The default terminal to use.
+    #
+    # @return [String, nil]
+    #   The name of the terminal program.
+    #
+    def term
+      self['COLORTERM'] || self['TERM']
+    end
+
+    alias terminal term
+
+    #
+    # The default editor to use.
+    #
+    # @return [String, nil]
+    #   The name of the editor program.
+    #
+    def editor
+      self['EDITOR']
+    end
+
+    #
+    # The default browser to use.
+    #
+    # @return [String, nil]
+    #   The name of the browser program.
+    #
+    def browser
+      self['BROWSER']
+    end
+
+    #
+    # Determines whether optional Debugging was enabled.
+    #
+    # @return [Boolean]
+    #   Specifies whether the `DEBUG` variable was specified.
+    #
+    def debug?
+      true if self['DEBUG']
+    end
+
+    protected
+
+    #
+    # Parses a String containing multiple paths.
+    #
+    # @return [Array<Pathname>]
+    #   The multiple paths.
+    #
+    def parse_paths(paths)
+      if paths
+        paths.split(File::PATH_SEPARATOR).map do |path|
+          Pathname.new(path)
+        end
+      else
+        []
+      end
+    end
+  end
+end

data/lib/env_ext/version.rb

@@ -0,0 +1,4 @@
+module EnvExt
+  # env_ext version
+  VERSION = "0.1.0"
+end

data/spec/core_ext_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+require 'env_ext/core_ext'
+
+describe "core_ext" do
+  describe "ENV" do
+    subject { ENV }
+
+    it { expect(subject).to be_kind_of(EnvExt::Methods) }
+  end
+end

data/spec/methods_spec.rb

@@ -0,0 +1,149 @@
+require 'spec_helper'
+require 'env_ext/methods'
+
+describe EnvExt::Methods do
+  subject { Object.new.extend(Methods) }
+
+  let(:home) { '/home/alice' }
+  let(:term) { 'xterm' }
+  let(:shell) { '/bin/bash' }
+
+  let(:env) do
+    {
+      'PATH' => '/usr/local/bin:/usr/bin:/bin',
+      'HOME' => home,
+      'TERM' => term,
+      'LANG' => 'en_US.UTF8',
+      'COLUMNS' => '80',
+      'LINES' => '10',
+      'SHELL' => '/bin/bash',
+      'DEBUG' => '1'
+    }
+  end
+
+  subject do
+    env.tap { |hash| hash.extend described_class }
+  end
+
+  describe "#path" do
+    it "should parse the contents of the PATH variable" do
+      expect(subject.paths).to eq([
+        Pathname.new('/usr/local/bin'),
+        Pathname.new('/usr/bin'),
+        Pathname.new('/bin')
+      ])
+    end
+  end
+
+  describe "#home" do
+    it "should provide access to the HOME variable" do
+      expect(subject.home).to eq(Pathname.new(home))
+    end
+
+    context "whne USERPROFILE is set, but HOME is not set" do
+      let(:env) do
+        {
+          'USERPROFILE' => home
+        }
+      end
+
+      it "should use the USERPROFILE variable if HOME is not set" do
+        expect(subject.home).to be == Pathname.new(home)
+      end
+    end
+
+    context "when HOMEDRIVE and HOMEPATH are set, but HOME is not" do
+      let(:drive) { 'C:' }
+      let(:env) do
+        {
+          'HOMEDRIVE' => drive,
+          'HOMEPATH' => home
+        }
+      end
+
+      it "should use HOMEDRIVE and HOMEPATH if HOME is not set" do
+        expect(subject.home).to be == Pathname.new(drive + home)
+      end
+    end
+
+    context "when HOME isn't set" do
+      let(:env) { {} }
+
+      it "should attempt to expand '~' if none of the HOME variables are set" do
+        expect(subject.home).to be_directory
+      end
+    end
+  end
+
+  describe "#lang" do
+    it "should parse the LANG variable" do
+      name, encoding = subject.lang
+
+      expect(name).to eq('en_US')
+      expect(encoding).to eq('UTF8')
+    end
+
+    context "when LANG is not set" do
+      let(:env) { {} }
+
+      it "should return an empty Array if LANG is not set" do
+        expect(subject.lang).to be_empty
+      end
+    end
+  end
+
+  describe "#columns" do
+    it "should parse the COLUMNS variable" do
+      expect(subject.columns).to eq(80)
+    end
+  end
+
+  describe "#lines" do
+    it "should parse the LINES variable" do
+      expect(subject.lines).to eq(10)
+    end
+  end
+
+  describe "#shell" do
+    it "should provide access to the SHELL variable" do
+      expect(subject.shell).to eq(shell)
+    end
+  end
+
+  describe "#shell_name" do
+    it "should determine the program name of the current Shell" do
+      expect(subject.shell_name).to eq('bash')
+    end
+  end
+
+  describe "#term" do
+    it "should determine the current TERM" do
+      expect(subject.term).to eq(term)
+    end
+
+    context "when COLORTERM and TERM are set" do
+      let(:env) do
+        {
+          'COLORTERM' => 'gnome-terminal',
+          'TERM' => term
+        }
+      end
+
+      it "should check COLORTERM before the TERM variable" do
+        expect(subject.term).to eq('gnome-terminal')
+      end
+    end
+  end
+
+  describe "#terminal" do
+    it "should be an alias to #term" do
+      expect(subject.terminal).to be == subject.term
+    end
+  end
+
+  describe "#debug" do
+    it "should check if DEBUG was set" do
+      expect(subject).to be_debug
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rspec'

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: env_ext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: env_ext adds additional methods to ENV for common environment variables,
+  used on Linux, BSD, OSX and Windows.
+email: postmodern.mod3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".gemtest"
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- env_ext.gemspec
+- gemspec.yml
+- lib/env_ext.rb
+- lib/env_ext/core_ext.rb
+- lib/env_ext/methods.rb
+- lib/env_ext/version.rb
+- spec/core_ext_spec.rb
+- spec/methods_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/postmodern/env_ext#readme
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://rubydoc.info/gems/env_ext
+  source_code_uri: https://github.com/postmodern/env_ext
+  bug_tracker_uri: https://github.com/postmodern/env_ext/issues
+  changelog_uri: https://github.com/postmodern/env_ext/blob/master/ChangeLog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key: 
+specification_version: 4
+summary: Adds additional methods to ENV
+test_files: []