env 0.1.0

data/.document

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

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,17 @@
+### 0.1.0 / 2011-01-22
+
+* Initial release:
+  * Provides access to:
+    * `HOME` (or `HOMEPATH` on Windows)
+    * `PATH`
+    * `LD_LIBRARY_PATH`
+    * `SHELL`
+    * `TERM` and `COLORTERM`
+    * `COLOMNS`
+    * `LINES`
+    * `EDITOR`
+    * `BROWSER`
+    * `LANG`
+  * Added {Env}.
+  * Added {Env::Variables}.
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 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,82 @@
+# Env
+
+* [Homepage](http://github.com/postmodern/env)
+* [Issues](http://github.com/postmodern/env/issues)
+* [Documentation](http://rubydoc.info/gems/env)
+* Postmodern (postmodern.mod3 at gmail.com)
+
+## Description
+
+{Env} provides a Ruby interface to common environment variables, used on
+Linux, BSD, OSX and Windows.
+
+## Features
+
+* Provides access to:
+  * `HOME` (or `HOMEPATH` on Windows)
+  * `PATH`
+  * `LD_LIBRARY_PATH`
+  * `SHELL`
+  * `TERM` and `COLORTERM`
+  * `COLOMNS`
+  * `LINES`
+  * `EDITOR`
+  * `BROWSER`
+  * `LANG`
+
+## Examples
+
+    require 'env'
+
+Transparently access environment variables as a Hash:
+
+    Env['DESKTOP_SESSION']
+    # => "gnome"
+
+Transparently access environment variables as Constants:
+
+    Env::DESKTOP_SESSION
+    # => "gnome"
+
+Transparently access environment variables with methods:
+
+    Env.desktop_session
+    # => "gnome"
+
+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"
+
+Only access the common variables from your Class:
+
+    class Project
+
+      include Env::Variables
+
+    end
+
+## Install
+
+    $ gem install env
+
+## Copyright
+
+Copyright (c) 2011 Hal Brodigan
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'ore-tasks', '~> 0.3.0'
+  require 'ore/tasks'
+
+  Ore::Tasks.new
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
+end
+
+begin
+  gem 'rspec', '~> 2.4.0'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.6.0'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end

data/env.gemspec

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  begin
+    require 'ore/specification'
+    retry
+  rescue LoadError
+    STDERR.puts "The 'env.gemspec' file requires Ore."
+    STDERR.puts "Run `gem install ore-core` to install Ore."
+  end
+end

data/gemspec.yml

@@ -0,0 +1,16 @@
+name: env
+summary: Provides a Ruby interface to common environment variables
+description:
+  Provides a Ruby interface to common environment variables, used on
+  Windows, Linux, BSD and OSX.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/env
+has_yard: true
+
+development_dependencies:
+  ore-tasks: ~> 0.3.0
+  rspec: ~> 2.4.0
+  yard: ~> 0.6.0

data/lib/env.rb

@@ -0,0 +1,2 @@
+require 'env/env'
+require 'env/version'

data/lib/env/env.rb

@@ -0,0 +1,91 @@
+require 'env/variables'
+
+module Env
+  extend Variables
+
+  #
+  # Provides direct access to the environment variables.
+  #
+  # @param [String, Symbol] name
+  #   The name of the environment variable.
+  #
+  # @return [String, nil]
+  #   The value of the environment variable.
+  #
+  # @example
+  #   Env['SHELL']
+  #   # => "/bin/bash"
+  #
+  def Env.[](name)
+    env_hash[name.to_s]
+  end
+
+  #
+  # Sets an environment variable.
+  #
+  # @param [String, Symbol] name
+  #   The name of the environment variable.
+  #
+  # @param [Object] value
+  #   The value of the environment variable.
+  #
+  # @return [String]
+  #   The String value of the environment variable.
+  #
+  def Env.[]=(name,value)
+    env_hash[name.to_s] = value.to_s
+  end
+
+  protected
+
+  #
+  # Provides transparent access to the environment variables.
+  #
+  # @param [Symbol] name
+  #   The name of the environment variable.
+  #
+  # @return [String, nil]
+  #   The value of the environment variable.
+  #
+  # @example
+  #   Env::SHELL
+  #   # => "/bin/bash"
+  #
+  def Env.const_missing(name)
+    Env[name.to_s]
+  end
+
+  #
+  # Provides transparent access to the environment variables.
+  #
+  # @param [Symbol] name
+  #   The name of the environment variable.
+  #
+  # @return [String, nil]
+  #   The value of the environment variable.
+  #
+  # @example
+  #   Env.shell
+  #   # => "/bin/bash"
+  #
+  # @example
+  #   Env.shell = '/bin/zsh'
+  #   # => "/bin/zsh"
+  #
+  def Env.method_missing(name,*arguments,&block)
+    name = name.to_s
+
+    if (arguments.length == 1 && name[-1..-1] == '=')
+      name.chop!
+      name.upcase!
+
+      return Env[name] = arguments.first
+    elsif arguments.empty?
+      name.upcase!
+
+      return Env[name]
+    end
+
+    super(name,*arguments,&block)
+  end
+end

data/lib/env/variables.rb

@@ -0,0 +1,145 @@
+require 'pathname'
+
+module Env
+  module Variables
+    #
+    # The environment variables.
+    #
+    # @return [Hash{String => String}]
+    #   The Hash of environment variable names and values.
+    #
+    def env_hash
+      ENV
+    end
+
+    #
+    # The directories to search within for executables.
+    #
+    # @return [Array<Pathname>]
+    #   The paths of the directories.
+    #
+    def paths
+      parse_paths(env_hash['PATH'])
+    end
+
+    #
+    # The directories to search within for libraries.
+    #
+    # @return [Array<Pathname>]
+    #   The paths of the directories.
+    #
+    def ld_library_paths
+      parse_paths(env_hash['LD_LIBRARY_PATH'])
+    end
+
+    #
+    # The home directory.
+    #
+    # @return [Pathname, nil]
+    #   The path of the home directory.
+    #
+    def home
+      if (home = (env_hash['HOME'] || env_hash['HOMEPATH']))
+        Pathname.new(home)
+      end
+    end
+
+    #
+    # The default language.
+    #
+    # @return [Array<String, String>]
+    #   The language name and encoding.
+    #
+    def lang
+      env_hash['LANG'].split('.',2)
+    end
+
+    #
+    # The number of columns in the terminal.
+    #
+    # @return [Integer]
+    #   The number of columns.
+    #
+    def columns
+      env_hash['COLUMNS'].to_i if env_hash['COLUMNS']
+    end
+
+    #
+    # The number of lines in the terminal.
+    #
+    # @return [Integer]
+    #   The number of lines.
+    #
+    def lines
+      env_hash['LINES'].to_i if env_hash['LINES']
+    end
+
+    #
+    # The path of the default shell.
+    #
+    # @return [String, nil]
+    #   The path to the default shell.
+    #
+    def shell
+      env_hash['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 terminal
+      env_hash['COLORTERM'] || env_hash['TERM']
+    end
+
+    #
+    # The default editor to use.
+    #
+    # @return [String, nil]
+    #   The name of the editor program.
+    #
+    def editor
+      env_hash['EDITOR']
+    end
+
+    #
+    # The default browser to use.
+    #
+    # @return [String, nil]
+    #   The name of the browser program.
+    #
+    def browser
+      env_hash['BROWSER']
+    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/version.rb

@@ -0,0 +1,4 @@
+module Env
+  # env version
+  VERSION = "0.1.0"
+end

data/spec/env_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'env'
+
+describe Env do
+  let(:var_name) { 'PATH' }
+  let(:var_value) { ENV[var_name] }
+
+  it "should have a VERSION constant" do
+    subject.const_get('VERSION').should_not be_empty
+  end
+
+  it "should provide direct Hash access to env variables" do
+    subject[var_name].should == var_value
+  end
+
+  it "should allow directly setting env variables" do
+    subject['FOO'] = 'bar'
+
+    subject['FOO'].should == 'bar'
+  end
+
+  it "should provide transparent CONSTANT access to env variables" do
+    subject.const_get(var_name).should == var_value
+  end
+
+  it "should provide transparent method access to env variables" do
+    method_name = var_name.downcase
+
+    subject.send(method_name).should == var_value
+  end
+
+  it "should allow setting of environment variables via methods" do
+    subject.shell = '/bin/zsh'
+
+    subject['SHELL'].should == '/bin/zsh'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+gem 'rspec', '~> 2.4.0'
+require 'rspec'
+require 'env/version'
+
+include Env

data/spec/variables_spec.rb

@@ -0,0 +1,76 @@
+require 'spec_helper'
+require 'env/variables'
+
+describe Variables do
+  subject { Object.new.extend(Variables) }
+
+  let(:home) { '/home/alice' }
+  let(:term) { 'xterm' }
+  let(:shell) { '/bin/bash' }
+
+  before(:each) do
+    subject.stub!(:env_hash).and_return(
+      'PATH' => '/usr/local/bin:/usr/bin:/bin',
+      'HOME' => home,
+      'TERM' => term,
+      'LANG' => 'en_US.UTF8',
+      'COLUMNS' => '80',
+      'LINES' => '10',
+      'SHELL' => '/bin/bash'
+    )
+  end
+
+  it "should parse the contents of the PATH variable" do
+    subject.paths.should == [
+      Pathname.new('/usr/local/bin'),
+      Pathname.new('/usr/bin'),
+      Pathname.new('/bin')
+    ]
+  end
+
+  it "should provide access to the HOME variable" do
+    subject.home.should == Pathname.new(home)
+  end
+
+  it "should check HOMEPATH if HOME is not set" do
+    subject.stub!(:env_hash).and_return('HOMEPATH' => home)
+
+    subject.home.should == Pathname.new(home)
+  end
+
+  it "should parse the LANG variable" do
+    name, encoding = subject.lang
+
+    name.should == 'en_US'
+    encoding.should == 'UTF8'
+  end
+
+  it "should parse the COLUMNS variable" do
+    subject.columns.should == 80
+  end
+
+  it "should parse the LINES variable" do
+    subject.lines.should == 10
+  end
+
+  it "should provide access to the SHELL variable" do
+    subject.shell.should == shell
+  end
+
+  it "should determine the program name of the current Shell" do
+    subject.shell_name.should == 'bash'
+  end
+
+  it "should determine the current Terminal" do
+    subject.terminal.should == term
+  end
+
+  it "should check COLORTERM before the TERM variable" do
+    subject.stub!(:env_hash).and_return(
+      'COLORTERM' => 'gnome-terminal',
+      'TERM' => term
+    )
+
+    subject.terminal.should == 'gnome-terminal'
+  end
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification 
+name: env
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ore-tasks
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 4
+        - 0
+        version: 2.4.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :development
+  version_requirements: *id003
+description: Provides a Ruby interface to common environment variables, used on Windows, Linux, BSD and OSX.
+email: postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- ChangeLog.md
+- LICENSE.txt
+files: 
+- .document
+- .rspec
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- env.gemspec
+- gemspec.yml
+- lib/env.rb
+- lib/env/env.rb
+- lib/env/variables.rb
+- lib/env/version.rb
+- spec/env_spec.rb
+- spec/spec_helper.rb
+- spec/variables_spec.rb
+has_rdoc: yard
+homepage: http://github.com/postmodern/env
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: env
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provides a Ruby interface to common environment variables
+test_files: 
+- spec/variables_spec.rb
+- spec/env_spec.rb