win-path-utils 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02c116e701ee6f656b4bf6ffb6d080af3f6f63a5
-  data.tar.gz: 0742e5b289decafb9997a7d96b2cdab3ae24b2d7
+  metadata.gz: 6469652ca4cb953ba2594393916bd16e1667a7db
+  data.tar.gz: 7c733a564ce1291c96e827fc2e01c3d4204db71a
 SHA512:
-  metadata.gz: de0d7916cc04a6d42ae72f5a537cc085d4eb141a6416922ca3afa7330ae2df5bf8b58f110dd1f68a5324b770e8ce4a73b3d50b9eedc045bbcf19682c802f6a3d
-  data.tar.gz: 6200874b47c1a1d0f422cb8d233959677a0b49ddad736eb3dab8e36bfba12ca803b35faaa12c4ddb16f28bcfd1e55632c9cd862862c2bca1c6d4789793c9d6d1
+  metadata.gz: c9175bc148fbc6e17f48b8d873953a162ba45e1fbea9f7be4ec5b0d26dec8d85943860793a9a31ac9e601b708489d18f2a3244920e8486d94659eb90ef822c45
+  data.tar.gz: ebc3a7663aec3c46c7fe564a0f7426cc9bf5204ea6d9d28d51a72ba27fe3db8da4cd7f858a6e6086820e2bdfcc5a3be29a41fc6afc457d53a70709bbb0bf8484

data/.gitignore

@@ -1,17 +1,17 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in win-path-utils.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in win-path-utils.gemspec
+gemspec

data/LICENSE.txt

@@ -1,22 +1,22 @@
-Copyright (c) 2013 MOZGIII
-
-MIT License
-
-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.
+Copyright (c) 2013 MOZGIII
+
+MIT License
+
+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,51 +1,51 @@
-# WinPathUtils
-
-This gem allows you to manupulate Windows' system `PATH` variable via registry.
-It provides convenient methods to add and remove items to `PATH`.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'win-path-utils'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install win-path-utils
-
-## Usage
-
-```ruby
-require 'win-path-utils'
-
-path = WinPathUtils::Path.new
-
-# Get the PATH
-path_value = path.get      # => "C:\Ruby\bin;C:\..."
-
-# Append something
-path.append('C:\test\at\the\end')
-
-# Prepend something
-path.prepend('C:\test\at\the\beginning')
-
-# Get the PATH now - it's updated
-new_path_value = path.get  # => "C:\test\at\the\beginning;C:\Ruby\bin;C:\..."
-
-# Remove something
-path.remove('C:\test')
-```
-
-Just read the code, it's pretty straightforward.
-
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+# WinPathUtils
+
+This gem allows you to manupulate Windows' system `PATH` variable via registry.
+It provides convenient methods to add and remove items to `PATH`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'win-path-utils'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install win-path-utils
+
+## Usage
+
+```ruby
+require 'win-path-utils'
+
+path = WinPathUtils::Path.new
+
+# Get the PATH
+path_value = path.get      # => "C:\Ruby\bin;C:\..."
+
+# Append something
+path.append('C:\test\at\the\end')
+
+# Prepend something
+path.prepend('C:\test\at\the\beginning')
+
+# Get the PATH now - it's updated
+new_path_value = path.get  # => "C:\test\at\the\beginning;C:\Ruby\bin;C:\..."
+
+# Remove something
+path.remove('C:\test')
+```
+
+Just read the code, it's pretty straightforward.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -1 +1 @@
-require "bundler/gem_tasks"
+require "bundler/gem_tasks"

data/lib/win-path-utils.rb

@@ -1,128 +1,148 @@
-require "win-path-utils/version"
-
-require "win32/registry"
-
-module WinPathUtils
-  class Path
-    class WrongOptionError < StandardError; end
-
-    def initialize(options = {})
-      @separator = options[:separator] || ';'
-
-      options[:type] ||= :system
-      
-      @hkey, @reg_path, @key_name = case options[:type]
-      when :system
-        [Win32::Registry::HKEY_LOCAL_MACHINE, 'SYSTEM\CurrentControlSet\Control\Session Manager\Environment', 'Path']
-      when :local, :user
-        [Win32::Registry::HKEY_CURRENT_USER, 'Environment', 'PATH']
-      else
-        raise WrongOptionError, "Unknown type!"
-      end
-
-      @hkey     = options[:hkey]     if options.key?(:hkey)
-      @reg_path = options[:reg_path] if options.key?(:reg_path)
-      @key_name = options[:key_name] if options.key?(:key_name)
-    end
-
-    # Sets the entire PATH variable to provided string
-    def set(value)
-      with_reg do |reg|
-        reg[@key_name] = value
-      end
-    end
-
-    # Returns the entire PATH variable as string
-    def get
-      with_reg do |reg|
-        begin
-          reg.read(@key_name)[1]
-        rescue Win32::Registry::Error
-          nil
-        end
-      end
-    end
-
-    # Sets the entire PATH variable to provided array
-    # Joins with @separator
-    def set_array(value)
-      set(value.join(@separator))
-    end
-
-    # Returns the entire PATH variable as array
-    # Splits with @separator
-    def get_array
-      get.split(@separator)
-    end
-
-    # Adds value to the path
-    def add(value, options = {})
-      # Set defaults
-      options[:duplication_filter] = :do_not_add unless options.key?(:duplication_filter)
-
-      # Get path
-      path = get_array
-
-      # Check duplicates
-      if path.member?(value)
-        case options[:duplication_filter]
-        when :do_not_add, :deny
-          # do nothing, we already have one in the list
-          return
-        when :remove_existing
-          path.delete!(value)
-        when :none
-          # just pass through
-        else
-          raise WrongOptionError, "Unknown :duplication_filter!"
-        end
-      end
-
-      # Change path array
-      case options[:where]
-      when :start, :left
-        path.unshift value
-      when :end, :right
-        path.push value
-      else
-        raise WrongOptionError, "Unknown :where!"
-      end
-
-      # Save new array
-      set_array(path)
-    end
-
-    # Adds element to the end of the path if not exists
-    def push(value, options = {})
-      add(value, options.merge(where: :end))
-    end
-    alias_method :append, :push
-
-    # Adds element to the start of the path if not exists
-    def unshift(value, options = {})
-      add(value, options.merge(where: :start))
-    end
-    alias_method :prepend, :unshift
-
-    # Removes the item from the path
-    def remove(value)
-      path = get_array
-      path.delete(value)
-      set_array(path)
-    end
-    alias_method :delete, :remove
-
-    # Checks the inclusion of value in path
-    def include?(value)
-      get_array.include?(value)
-    end
-    alias_method :member?, :include?
-
-    private
-
-    # Execute block with the current reg settings
-    def with_reg(access_mask = Win32::Registry::Constants::KEY_ALL_ACCESS, &block)
-      @hkey.open(@reg_path, access_mask, &block)
-    end
-  end
-end
+require "win-path-utils/version"
+
+require "win32/registry"
+
+module WinPathUtils
+  class Path
+    class WrongOptionError < StandardError; end
+    class SetxError < StandardError; end
+
+    def initialize(options = {})
+      @separator = options[:separator] || ';'
+
+      options[:type] ||= :system
+      
+      @hkey, @reg_path, @key_name = case options[:type]
+      when :system
+        [Win32::Registry::HKEY_LOCAL_MACHINE, 'SYSTEM\CurrentControlSet\Control\Session Manager\Environment', 'Path']
+      when :local, :user
+        [Win32::Registry::HKEY_CURRENT_USER, 'Environment', 'PATH']
+      else
+        raise WrongOptionError, "Unknown type!"
+      end
+
+      @hkey     = options[:hkey]     if options.key?(:hkey)
+      @reg_path = options[:reg_path] if options.key?(:reg_path)
+      @key_name = options[:key_name] if options.key?(:key_name)
+    end
+
+    # Sets the entire PATH variable to provided string
+    def set(value)
+      with_reg do |reg|
+        reg[@key_name] = value
+      end
+    end
+
+    # Returns the entire PATH variable as string
+    def get
+      with_reg do |reg|
+        begin
+          reg.read(@key_name)[1]
+        rescue Win32::Registry::Error
+          nil
+        end
+      end
+    end
+
+    # Sets the entire PATH variable to provided array
+    # Joins with @separator
+    def set_array(value)
+      set(value.join(@separator))
+    end
+
+    # Returns the entire PATH variable as array
+    # Splits with @separator
+    def get_array
+      get.split(@separator)
+    end
+
+    # Adds value to the path
+    def add(value, options = {})
+      # Set defaults
+      options[:duplication_filter] = :do_not_add unless options.key?(:duplication_filter)
+
+      # Get path
+      path = get_array
+
+      # Check duplicates
+      if path.member?(value)
+        case options[:duplication_filter]
+        when :do_not_add, :deny
+          # do nothing, we already have one in the list
+          return
+        when :remove_existing
+          path.delete!(value)
+        when :none
+          # just pass through
+        else
+          raise WrongOptionError, "Unknown :duplication_filter!"
+        end
+      end
+
+      # Change path array
+      case options[:where]
+      when :start, :left
+        path.unshift value
+      when :end, :right
+        path.push value
+      else
+        raise WrongOptionError, "Unknown :where!"
+      end
+
+      # Save new array
+      set_array(path)
+    end
+
+    # Adds element to the end of the path if not exists
+    def push(value, options = {})
+      add(value, options.merge(where: :end))
+    end
+    alias_method :append, :push
+
+    # Adds element to the start of the path if not exists
+    def unshift(value, options = {})
+      add(value, options.merge(where: :start))
+    end
+    alias_method :prepend, :unshift
+
+    # Removes the item from the path
+    def remove(value)
+      path = get_array
+      path.delete(value)
+      set_array(path)
+    end
+    alias_method :delete, :remove
+
+    # Checks the inclusion of value in path
+    def include?(value)
+      get_array.include?(value)
+    end
+    alias_method :member?, :include?
+
+    # Cause Windows to reload environment from registry
+    def self.commit!
+      var = "WIN_PATH_UTILS_TMPVAR"
+
+      fd_r, fd_w = IO.pipe
+      result = system("setx", var, "", [:out, :err] => fd_w)
+      fd_w.close
+      output = fd_r.read
+
+      raise SetxError.new("SETX error: #{output}") if result == false
+
+      result
+    end
+
+    # Alias
+    def commit!
+      self.class.commit!
+    end
+
+    private
+
+    # Execute block with the current reg settings
+    def with_reg(access_mask = Win32::Registry::Constants::KEY_ALL_ACCESS, &block)
+      @hkey.open(@reg_path, access_mask, &block)
+    end
+  end
+end

data/lib/win-path-utils/version.rb

@@ -1,3 +1,3 @@
-module WinPathUtils
-  VERSION = "0.1.0"
-end
+module WinPathUtils
+  VERSION = "0.2.0"
+end

data/win-path-utils.gemspec

@@ -1,23 +1,23 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'win-path-utils/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "win-path-utils"
-  spec.version       = WinPathUtils::VERSION
-  spec.authors       = ["MOZGIII"]
-  spec.email         = ["mike-n@narod.ru"]
-  spec.description   = %q{Provides an API to add and remove values from Windows' system PATH variable}
-  spec.summary       = %q{Provides an API to add and remove values from Windows' system PATH variable}
-  spec.homepage      = "https://github.com/MOZGIII/win-path-utils"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'win-path-utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "win-path-utils"
+  spec.version       = WinPathUtils::VERSION
+  spec.authors       = ["MOZGIII"]
+  spec.email         = ["mike-n@narod.ru"]
+  spec.description   = %q{Provides an API to add and remove values from Windows' system PATH variable}
+  spec.summary       = %q{Provides an API to add and remove values from Windows' system PATH variable}
+  spec.homepage      = "https://github.com/MOZGIII/win-path-utils"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: win-path-utils
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - MOZGIII
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-23 00:00:00.000000000 Z
+date: 2014-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Provides an API to add and remove values from Windows' system PATH variable