xregistry 1.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5fb2c7081e707996d70925d8263e6c21931de47b
+  data.tar.gz: ae667713a9342fefa9edd27d59c756746c8ad515
+SHA512:
+  metadata.gz: 98c75548ee27d5ec9c138226de3317bc5c13138a4ac6900eb7479815143ffeb2b15a6e8b38d53671416499d21039dbc777f53e2be55107bfb3cf7a3c97bbe159
+  data.tar.gz: e9752864707a4ee539ba9445cdc58f851dc73ed28a858507a521830283c98286c83c3a893b38596c8080eddc5f22c6230d5930cf4b89ac4fedfbffad3b3fc6c9

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2016 William Parsons
+
+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/Rakefile

@@ -0,0 +1,37 @@
+# Rakefile for xregistry gem.
+# Last modified:  28-Apr-2017  Wm. Parsons
+
+require 'rake/testtask'
+
+name    = 'xregistry'
+version = IO.read('VERSION').chomp
+package = "#{name}-#{version}"
+
+task :default => [:build]
+
+desc "Build #{name} gem"
+task :build do
+  system "gem build #{name}.gemspec"
+end
+
+desc "Clean up generated files"
+task :clean do
+  Dir.glob('*.gem').each { |x| FileUtils.rm_f x }
+end
+
+desc "Install #{name} gem"
+task :install do
+  system "gem install #{package}.gem --document rdoc,ri"
+end
+
+desc "Install #{name} gem as user"
+task :userinstall do
+  system "gem install --user-install #{package}.gem --document rdoc,ri"
+end
+
+desc "Uninstall #{name} gem"
+task :uninstall do
+  system "gem uninstall #{name} -v #{version}"
+end
+
+Rake::TestTask.new :test

data/VERSION

@@ -0,0 +1 @@
+1.6.0

data/lib/xregistry.rb

@@ -0,0 +1,246 @@
+################################################################################
+#  xregistry.rb
+#
+#  This file defines a cross-platform Registry class for storing application
+#  configuration parameters.
+#
+#  The application programming interface (API) is based on the FOX registry
+#  class, which is part of the FOX GUI toolkit (http://www.fox-toolkit.org/).
+#  This file defines a class that can be used in the same way as the FOX
+#  registry, but without needing the FOX toolkit.
+#
+#  The original FOX registry uses the Windows registry if running under Windows,
+#  and an .INI type file if running under Unix-type systems.  This class also
+#  uses the Windows registry if running under Windows, but uses an SQLite3
+#  database if running under a Unix-type system.
+#
+#  Last revised:  03-Aug-2016  Wm. Parsons
+################################################################################
+
+
+class Registry
+  # Construct registry object; app_key and vendor_key must be string constants.
+  # Regular applications SHOULD set a vendor key!
+  def initialize(app_key = '', vendor_key = '')
+    @app_key    = app_key
+    @vendor_key = vendor_key
+    @on_windows = RUBY_PLATFORM =~ /w(in)?32/
+
+    if @on_windows
+      require 'win32/registry'
+      @root_key = ['SOFTWARE', vendor_key, app_key].join('\\')
+    else
+      require 'sqlite3'
+
+      # create registry directory if necessary
+      regdir = ENV['HOME'] + '/.registry'
+      File.directory?(regdir) || Dir.mkdir(regdir)
+      regdir += '/' + vendor_key
+      File.directory?(regdir) || Dir.mkdir(regdir)
+
+      @db = SQLite3::Database.new("#{regdir}/#{app_key}.db3")
+    end
+  end
+
+  # Return application key
+  def appKey
+    @app_key
+  end
+  alias app_key appKey
+
+  # Return vendor key
+  def vendorKey
+    @vendor_key
+  end
+  alias vendor_key vendorKey
+
+  # Delete the registry entry for the specified section and key.
+  def deleteEntry(section, key)
+    if @on_windows
+      begin
+        pkey = [@root_key, section].join('\\')
+        access = Win32::Registry::KEY_ALL_ACCESS
+        Win32::Registry::HKEY_CURRENT_USER.open(pkey, access) do |reg|
+          reg.delete_value(key)
+        end
+      rescue Win32::Registry::Error
+      end
+    else
+      begin
+        @db.execute %Q[delete from "#{section}" where key=?], key
+      rescue SQLite3::SQLException
+      end
+    end
+  end
+  alias delete_entry deleteEntry
+
+  # Delete a specified section from the registry.
+  def deleteSection(section)
+    if @on_windows
+      begin
+        access = Win32::Registry::KEY_ALL_ACCESS
+        Win32::Registry::HKEY_CURRENT_USER.open(@root_key, access) do |reg|
+          reg.delete_key(section, true)
+        end
+      rescue Win32::Registry::Error
+      end
+    else
+      @db.execute "drop table if exists \"#{section}\""
+    end
+  end
+  alias delete_section deleteSection
+
+  # Iterate over the section keys of the registry.
+  def each_key
+    if @on_windows
+      Win32::Registry::HKEY_CURRENT_USER.open(@root_key) do |reg|
+        reg.each_key { |subkey, wtime| yield subkey }
+      end
+    else
+      @db.execute <<-EOS do |name|
+          select name from sqlite_master where type='table' order by name
+          EOS
+        yield name[0]
+      end
+    end
+  end
+
+  # Find a section in the registry.
+  # The properties of the value returned are undefined except that it must
+  # support an "each_key" to iterate thru the keys and a "find" method to
+  # locate the value associated with a key.
+  def find(section)
+    hash = {}
+    if @on_windows
+      pkey = [@root_key, section].join('\\')
+      Win32::Registry::HKEY_CURRENT_USER.open(pkey) do |reg|
+        reg.each do |subkey, type, value|
+          hash[subkey] = value
+        end
+      end
+    else
+      @db.execute %Q[select key, value from "#{section}" order by key] do |row|
+        hash[row[0]] = row[1]
+      end
+    end
+    class << hash
+      def find(key)
+        self[key]
+      end
+    end
+    hash
+  end
+
+  # Read a boolean registry entry from the specified section and key.  If no
+  # value is found, the default value is returned.  A type error is
+  # raised if the retrieved value is real or a string.
+  def readBoolEntry(section, key, default = false)
+    value = readEntry(section, key, default)
+    raise TypeError if value.class == Float || value.class == String
+    value && value != 0
+  end
+  alias read_bool_entry readBoolEntry
+
+  # Read an integer registry entry from the specified section and key.  If no
+  # value is found, the default value is returned.
+  def readIntEntry(section, key, default = 0)
+    readEntry(section, key, default).to_i
+  end
+  alias read_int_entry readIntEntry
+
+  # Read a double-precision floating point registry entry from the specified
+  # section and key.  If no value is found, the default value is returned.
+  def readRealEntry(section, key, default = 0.0)
+    readEntry(section, key, default).to_f
+  end
+  alias read_real_entry readRealEntry
+
+  # Read a string registry entry from the specified section and key.  If no
+  # value is found, the default value is returned.
+  def readStringEntry(section, key, default = '')
+    readEntry(section, key, default).to_s
+  end
+  alias read_string_entry readStringEntry
+
+  # Write a boolean registry value to the specified section and key.
+  def writeBoolEntry(section, key, value)
+    writeEntry(section, key, value ? 1 : 0)
+  end
+  alias write_bool_entry writeBoolEntry
+
+  # Write an integer registry value to the specified section and key.
+  def writeIntEntry(section, key, value)
+    writeEntry(section, key, value.to_i)
+  end
+  alias write_int_entry writeIntEntry
+
+  # Write a double-precision floating point registry value to the specified
+  # section and key.
+  def writeRealEntry(section, key, value)
+    writeEntry(section, key, value.to_f)
+  end
+  alias write_real_entry writeRealEntry
+
+  # Write a string registry value to the specified section and key.
+  def writeStringEntry(section, key, value)
+    writeEntry(section, key, value.to_s)
+  end
+  alias write_string_entry writeStringEntry
+
+  #######
+  private
+  #######
+
+  # Read a registry entry from the specified section and key.  If no
+  # value is found, the default value is returned.
+  def readEntry(section, key, default)
+    if @on_windows
+      pkey = [@root_key, section].join('\\')
+      reg  = Win32::Registry::HKEY_CURRENT_USER.open(pkey)
+      reg.read(key)[1]
+    else
+      @db.get_first_value("select value from \"#{section}\" where key=?",
+                          key) || default
+    end
+  rescue
+    default
+  end
+
+  # Write a registry value to the specified section and key.
+  def writeEntry(section, key, value)
+    if @on_windows
+      # store real values as strings under Windows
+      value = value.to_s if value.class == Float
+      begin
+        pkey = [@root_key, section].join('\\')
+        access = Win32::Registry::KEY_WRITE
+        Win32::Registry::HKEY_CURRENT_USER.open(pkey, access) do |reg|
+          reg[key] = value
+        end
+      rescue
+        Win32::Registry::HKEY_CURRENT_USER.create(pkey, access) do |reg|
+          reg[key] = value
+        end
+      end
+    else
+      begin
+        @db.execute("update \"#{section}\" set value=? where key=?",
+                    [value, key])
+        if @db.changes == 0
+          # no row was updated so insert a new row
+          @db.execute("insert into \"#{section}\"(key, value) values(?,?)",
+                      [key, value])
+        end
+      rescue SQLite3::Exception => e
+        if e.to_s =~ /no such table/
+          @db.execute "create table \"#{section}\"(key text unique, value)"
+
+          @db.execute("insert into \"#{section}\"(key, value) values(?,?)",
+                      [key, value])
+        else
+          raise e.to_s
+        end
+      end
+    end
+  end
+end

data/test/test_xregistry.rb

@@ -0,0 +1,216 @@
+# test program for wregistry gem
+# Last modified:  02-Aug-2016
+
+require 'xregistry'
+require 'test/unit'
+
+class TestXregistry < Test::Unit::TestCase
+  @@app_key    = 'testxreg'
+  @@vendor_key = 'Wikareia'
+
+  def setup
+    @@reg ||= Registry.new(@@app_key, @@vendor_key)
+  end
+
+  def test_new
+    assert_equal(Registry, @@reg.class)
+  rescue
+    flunk "error encountered opening database: #{$!}"
+  end
+
+  # test of each_key
+  def test_each_key
+    keys = []
+    @@reg.each_key { |k| keys << k }
+    keys.each { |k| @@reg.deleteSection(k) }
+    @@reg.writeIntEntry('Section1', 'key', 1)
+    @@reg.writeIntEntry('Section2', 'key', 2)
+    @@reg.writeIntEntry('Section3', 'key', 3)
+    value = []
+    @@reg.each_key { |k| value << k }
+    assert_equal(%w[Section1 Section2 Section3], value)
+  end
+
+  # test of find
+  def test_find
+    @@reg.writeIntEntry('Section', 'key1', 1)
+    @@reg.writeIntEntry('Section', 'key2', 2)
+    @@reg.writeIntEntry('Section', 'key3', 3)
+    value = []
+    section = @@reg.find('Section')
+    section.each_key { |k| value << [k, section.find(k)] }
+    assert_equal([['key1', 1], ['key2', 2], ['key3', 3]], value)
+  end
+
+  # test of readBoolEntry
+  def test_read_bool_entry
+    value = @@reg.readBoolEntry('Settings', 'bool_key1')
+    assert_equal(false, value)
+
+    value = @@reg.readBoolEntry('Settings', 'bool_key1', true)
+    assert_equal(true, value)
+
+    value = @@reg.readBoolEntry('Settings', 'bool_key1', false)
+    assert_equal(false, value)
+
+    @@reg.writeIntEntry('Settings', 'bool_key1', 2)
+    value = @@reg.readBoolEntry('Settings', 'bool_key1')
+    assert_equal(true, value)
+
+    @@reg.writeRealEntry('Settings', 'bool_key1', 2.5)
+    assert_raise(TypeError) { @@reg.readBoolEntry('Settings', 'bool_key1') }
+
+    @@reg.writeStringEntry('Settings', 'bool_key1', '2')
+    assert_raise(TypeError) { @@reg.readBoolEntry('Settings', 'bool_key1') }
+  end
+
+  # test of readIntEntry
+  def test_read_int_entry
+    value = @@reg.readIntEntry('Settings', 'int_key1')
+    assert_equal(0, value)
+
+    value = @@reg.readIntEntry('Settings', 'int_key1', 123)
+    assert_equal(123, value)
+
+    @@reg.writeBoolEntry('Settings', 'int_key1', true)
+    value = @@reg.readIntEntry('Settings', 'int_key1')
+    assert_equal(1, value)
+
+    @@reg.writeRealEntry('Settings', 'int_key1', 2.5)
+    value = @@reg.readIntEntry('Settings', 'int_key1')
+    assert_equal(2, value)
+
+    @@reg.writeStringEntry('Settings', 'int_key1', '2')
+    value = @@reg.readIntEntry('Settings', 'int_key1')
+    assert_equal(2, value)
+
+    @@reg.writeStringEntry('Settings', 'int_key1', 'abc')
+    value = @@reg.readIntEntry('Settings', 'int_key1')
+    assert_equal(0, value)
+  end
+
+  # test of readRealEntry
+  def test_read_real_entry
+    value = @@reg.readRealEntry('Settings', 'real_key1')
+    assert_equal(0.0, value)
+
+    value = @@reg.readRealEntry('Settings', 'real_key1', 12.5)
+    assert_equal(12.5, value)
+
+    @@reg.writeBoolEntry('Settings', 'real_key1', true)
+    value = @@reg.readRealEntry('Settings', 'real_key1')
+    assert_equal(1.0, value)
+
+    @@reg.writeIntEntry('Settings', 'real_key1', 2)
+    value = @@reg.readRealEntry('Settings', 'real_key1')
+    assert_equal(2.0, value)
+
+    @@reg.writeStringEntry('Settings', 'real_key1', '2.5')
+    value = @@reg.readRealEntry('Settings', 'real_key1')
+    assert_equal(2.5, value)
+
+    @@reg.writeStringEntry('Settings', 'real_key1', 'abc')
+    value = @@reg.readRealEntry('Settings', 'real_key1')
+    assert_equal(0, value)
+  end
+
+  # test of readStringEntry
+  def test_read_string_entry
+    string = @@reg.readStringEntry('Settings', 'string_key1')
+    assert_equal('', string)
+
+    string = @@reg.readStringEntry('Settings', 'string_key1', 'default value')
+    assert_match(/ value/, string)
+
+    @@reg.writeBoolEntry('Settings', 'string_key1', true)
+    value = @@reg.readStringEntry('Settings', 'string_key1')
+    assert_equal('1', value)
+
+    @@reg.writeIntEntry('Settings', 'string_key1', 2)
+    value = @@reg.readStringEntry('Settings', 'string_key1')
+    assert_equal('2', value)
+
+    @@reg.writeRealEntry('Settings', 'string_key1', 2.5)
+    value = @@reg.readStringEntry('Settings', 'string_key1')
+    assert_equal('2.5', value)
+  end
+
+  # test of writeBoolEntry
+  def test_write_bool_entry
+    @@reg.writeBoolEntry('Settings', 'bool_key2', true)
+    value = @@reg.readBoolEntry('Settings', 'bool_key2')
+    assert_equal(true, value)
+
+    @@reg.writeBoolEntry('Settings', 'bool_key2', false)
+    value = @@reg.readBoolEntry('Settings', 'bool_key2')
+    assert_equal(false, value)
+  end
+
+  # test of writeIntEntry
+  def test_write_int_entry
+    @@reg.writeIntEntry('Settings', 'int_key2', 456)
+    value = @@reg.readIntEntry('Settings', 'int_key2')
+    assert_equal(456, value)
+  end
+
+  # test of writeRealEntry
+  def test_write_real_entry
+    @@reg.writeRealEntry('Settings', 'real_key2', 25.5)
+    value = @@reg.readRealEntry('Settings', 'real_key2')
+    assert_equal(25.5, value)
+  end
+
+  # test of writeStringEntry
+  def test_write_string_entry
+    @@reg.writeStringEntry('Settings', 'string_key2', 'test value')
+    string = @@reg.readStringEntry('Settings', 'string_key2')
+    assert_equal('test value', string)
+  end
+
+  # test of deleteEntry
+  def test_delete_entry
+    @@reg.writeStringEntry('Settings', 'key1', 'dummy value')
+    string = @@reg.readStringEntry('Settings', 'key1')
+    assert_equal('dummy value', string)
+    @@reg.writeStringEntry('Settings', 'key2', 'dummy value')
+    string = @@reg.readStringEntry('Settings', 'key2')
+    assert_equal('dummy value', string)
+    @@reg.deleteEntry('Settings', 'key1')
+    string = @@reg.readStringEntry('Settings', 'key1', 'no value')
+    assert_equal('no value', string)
+
+    # test of deleteEntry when key doesn't exist
+    @@reg.deleteEntry('Settings', 'key1')
+    string = @@reg.readStringEntry('Settings', 'key1', 'no value')
+    assert_equal('no value', string)
+
+    # test of deleteEntry when section doesn't exist
+    @@reg.deleteSection('Settings')
+    @@reg.deleteEntry('Settings', 'key2')
+    string = @@reg.readStringEntry('Settings', 'key2', 'no value')
+    assert_equal('no value', string)
+  end
+
+  # test of deleteSection
+  def test_delete_section
+    @@reg.writeStringEntry('Settings', 'key', 'dummy value')
+    @@reg.deleteSection('Settings')
+    string = @@reg.readStringEntry('Settings', 'key', 'no value')
+    assert_equal('no value', string)
+
+    # test of deleteSection when section doesn't exist
+    @@reg.deleteSection('Settings')
+    string = @@reg.readStringEntry('Settings', 'key', 'no value')
+    assert_equal('no value', string)
+  end
+
+  # test of appKey
+  def test_app_key
+    assert_equal(@@app_key, @@reg.appKey)
+  end
+
+  # test of vendorKey
+  def test_vendor_key
+    assert_equal(@@vendor_key, @@reg.vendorKey)
+  end
+end

data/xregistry.gemspec

@@ -0,0 +1,17 @@
+# xregistry.gemspec
+# Last modified:  22-Feb-2016
+
+spec = Gem::Specification.new do |s|
+  s.name        = 'xregistry'
+  s.version     = IO.read('VERSION')
+  s.summary     = 'A cross-platform registry class for Ruby.'
+  s.description = <<-EOS
+This provides a cross-platform registry class for Ruby.
+  EOS
+  s.author      = 'William Parsons'
+  s.email       = 'wbparsons@alum.mit.edu'
+  s.license     = 'MIT'
+  s.homepage    = 'http://chiselapp.com/user/varro/repository/Xregistry'
+  s.files       = Dir['{lib,test}/*.rb'] +
+                  %w[LICENSE Rakefile VERSION xregistry.gemspec]
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: xregistry
+version: !ruby/object:Gem::Version
+  version: 1.6.0
+platform: ruby
+authors:
+- William Parsons
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-20 00:00:00.000000000 Z
+dependencies: []
+description: 'This provides a cross-platform registry class for Ruby.
+
+'
+email: wbparsons@alum.mit.edu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- Rakefile
+- VERSION
+- lib/xregistry.rb
+- test/test_xregistry.rb
+- xregistry.gemspec
+homepage: http://chiselapp.com/user/varro/repository/Xregistry
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: A cross-platform registry class for Ruby.
+test_files: []