user_space 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 532cc3386ae1ec0bdec441e5d25d5279f82e8547
-  data.tar.gz: 0a7e250d95306c27bfdc8d11781ec949eed1cb86
+  metadata.gz: ad4946e7879c8d5182a601dca296fec845c37785
+  data.tar.gz: b7844d0201b7a83e4e9987bdcf94e714a7c7139b
 SHA512:
-  metadata.gz: c1a002a63985694c84a738c3028fd39fd33e0caeb19d135dbc7f2fd08c8c77bd75fdef6cc83d0263190d053b7d52dded3406883df5eba35b0127d4897bbc189e
-  data.tar.gz: 03b8b6d9a28934c68ca6f820a8b1d2026d7eb4bf5b1e1168ae68d763671dd2de63d0192ec5781894b95570c28923529553e7f7e4ec638fd7091783d9230929d4
+  metadata.gz: ab588bdaff70c0fa820c9ab243867a0c28fdc84a96cf9bbac240fbf1b3e50ca9d3daead487548c21939950161dce225cddef928882a7213f423605bc70225596
+  data.tar.gz: b113e412b3c652622502535402c64092f11ee2e5ecb72819820d18f1cea6c53a103763323f8e567a3340f4da71164c448509835ee82f3321d0fc0c61a95932b7

data/README.rdoc

@@ -14,7 +14,7 @@ Automates certain XDG features.
    # Perhaps like...
    APP::CONFIG = {:tts=>'espeak', }
    # By default, UserSpace works with the JSON parser.
-   USERSPACE = USER_SPACE::UserSpace.new
+   USERSPACE = UserSpace.new
    # Unless this version has been installed,
    # we copy over our data and cache directories.
    USERSPACE.install unless USERSPACE.version == APP::VERSION

data/lib/user_space/user_space.rb

@@ -1,132 +1,144 @@
-module USER_SPACE
-  class UserSpace
-
-    OPTIONS    = {:config  => 'config',
-                  :parser  =>  JSON,
-                  :ext     =>  nil,
-                  :version => 'VERSION'}
-
-    PARAMETERS = {:appname  => File.basename($PROGRAM_NAME),
-                  :appdir   => nil, # Can't guess at this point yet?
-                  :xdgbases => ['CACHE', 'CONFIG', 'DATA']}
-
-    attr_accessor :trace, :verbose
-    attr_reader :appname, :appdir, :xdgbases, :options
-    def initialize(parameters=PARAMETERS)
-
-      @appname  = parameters[:appname]  || PARAMETERS[:appname]
-      @appdir   = parameters[:appdir]   || PARAMETERS[:appdir]
-      @xdgbases = parameters[:xdgbases] || PARAMETERS[:xdgbases]
-      @options  = OPTIONS
-
-      unless @appdir
-        appdir = File.dirname File.dirname caller_locations(1,1)[0].path
-        appdir = File.dirname appdir if File.basename(appdir)=='lib'
-        @appdir = File.expand_path appdir
-        verbose.puts "Warning: UserSpace#appdir heuristics used" if verbose
-      end
+class UserSpace
+  OPTIONS = {
+    config:  'config',
+    version: 'VERSION',
+    ext:     nil,
+    parser:  nil,
+  }
+  ['JSON','YAML','Marshal'].each do |parser|
+    begin
+      OPTIONS[:parser] = Object.const_get parser
+      $stderr.puts "USER_SPACE will use #{parser} by default." if $VERBOSE
+      break
+    rescue NameError
+      $stderr.puts "#{parser} was not available for USER_SPACE." if $DEBUG
+    end
+  end
 
-      # install with no overwrite
-      install(false)
+  PARAMETERS = {
+    appname:  File.basename($0),
+    appdir:   nil, # Can't guess at this point yet?
+    xdgbases: ['CACHE', 'CONFIG', 'DATA'],
+  }
+
+  attr_reader :appname, :appdir, :xdgbases, :options
+  def initialize(parameters=PARAMETERS)
+
+    @appname  = parameters[:appname]  || PARAMETERS[:appname]
+    @appdir   = parameters[:appdir]   || PARAMETERS[:appdir]
+    @xdgbases = parameters[:xdgbases] || PARAMETERS[:xdgbases]
+    @options  = OPTIONS.dup
+
+    unless @appdir
+      appdir = File.dirname File.dirname caller_locations(1,1)[0].path
+      appdir = File.dirname appdir if File.basename(appdir)=='lib'
+      @appdir = File.expand_path appdir
+      $stderr.puts "UserSpace#appdir=\"#{@appdir}\" # heuristics used" if $VERBOSE
     end
 
-    def xdg_pairs
-      @xdgbases.each do |base|
-        xdg = XDG[base].to_s
-        userdir = File.join(xdg, @appname)
-        basedir = File.join @appdir, base.downcase
-        yield basedir, userdir
-      end
+    # install with no overwrite
+    install(false)
+  end
+
+  def xdg_pairs
+    @xdgbases.each do |base|
+      xdg = XDG[base].to_s
+      userdir = File.join(xdg, @appname)
+      basedir = File.join @appdir, base.downcase
+      yield basedir, userdir
     end
+  end
 
-    # Note that initialize will not overwrite anything.
-    # This overwrites the user's data directory with a fresh install.
-    # App should consider being nice about this,
-    # like warn the user or something.
-    def install(overwrite=true)
-      xdg_pairs do |basedir, userdir|
-        if File.exist?(userdir)
-          # Sanity check
-          raise "Not a directory: #{userdir}" unless File.directory?(userdir)
-          # Pre-existing directory.
-          # Return unless user wants to overwrite.
-          next unless overwrite
-        else
-          Dir.mkdir(userdir, 0700)
-        end
-        FileUtils.cp_r(Dir.glob("#{basedir}/*"), userdir) if File.directory? basedir
-        FileUtils.chmod_R 'og-rwx', userdir
-        FileUtils.chmod_R 'u+rwX',  userdir
+  # Note that initialize will not overwrite anything.
+  # This overwrites the user's data directory with a fresh install.
+  # App should consider being nice about this,
+  # like warn the user or something.
+  def install(overwrite=true)
+    xdg_pairs do |basedir, userdir|
+      if File.exist?(userdir)
+        # Sanity check
+        raise "Not a directory: #{userdir}" unless File.directory?(userdir)
+        # Pre-existing directory.
+        # Return unless user wants to overwrite.
+        next unless overwrite
+      else
+        Dir.mkdir(userdir, 0700)
       end
+      FileUtils.cp_r(Dir.glob("#{basedir}/*"), userdir) if File.directory? basedir
+      FileUtils.chmod_R 'og-rwx', userdir
+      FileUtils.chmod_R 'u+rwX',  userdir
     end
+  end
 
-    def cachedir
-      File.join XDG['CACHE'].to_s, @appname
-    end
+  def cachedir
+    File.join XDG['CACHE'].to_s, @appname
+  end
 
-    def configdir
-      File.join XDG['CONFIG'].to_s, @appname
-    end
+  def configdir
+    File.join XDG['CONFIG'].to_s, @appname
+  end
 
-    def datadir
-      File.join XDG['DATA'].to_s, @appname
-    end
+  def datadir
+    File.join XDG['DATA'].to_s, @appname
+  end
 
-    # Not really for public use.
-    def config_file_name(options=@options)
-      parser   = options[:parser]
-      ext      = options[:ext] || parser.to_s.downcase
-      basename = "#{options[:config]}.#{ext}"
-      File.join XDG['CONFIG'].to_s, @appname, basename
-    end
+  # Not really for public use.
+  def config_file_name
+    parser   = @options[:parser]
+    ext      = @options[:ext] || parser.to_s.downcase
+    basename = "#{@options[:config]}.#{ext}"
+    File.join XDG['CONFIG'].to_s, @appname, basename
+  end
 
-    # Not really for public use.
-    def version_file_name
-      File.join XDG['DATA'].to_s, @appname, @options[:version]
-    end
+  # Not really for public use.
+  def version_file_name
+    File.join XDG['DATA'].to_s, @appname, @options[:version]
+  end
 
-    def config?(options=@options)
-      File.exist?(config_file_name(options))
-    end
+  def config?
+    File.exist?(config_file_name)
+  end
 
-    # Reads config
-    def config(options=@options)
-      options[:parser].parse File.read(config_file_name(options))
-    rescue
-      trace.puts $!.message    if trace
-      verbose.puts $!.backtrace if verbose
-      nil
-    end
+  # Reads config
+  def config
+    p, d = @options[:parser], File.read(config_file_name)
+    p.load(d)
+  rescue
+    $stderr.puts $!.message   if $VERBOSE
+    $stderr.puts $!.backtrace if $DEBUG
+    nil
+  end
 
-    # Saves config
-    def config=(obj, options=@options)
-      File.open(config_file_name, 'w', 0600){|fh| fh.puts options[:parser].pretty_generate obj}
-    end
+  # Saves config
+  def config=(obj)
+    p = @options[:parser]
+    d = (p.respond_to?(:pretty_generate))? p.pretty_generate(obj) : p.dump(obj)
+    File.open(config_file_name, 'w', 0600){|fh| fh.puts d}
+  end
 
-    def configures(hash)
-      if self.config? # file exists
-        self.config.each{|opt, value| hash[opt.to_sym] = value}
-      else
-        trace.puts config_file_name if trace
-        self.config = hash
-      end
+  def configures(hash)
+    if self.config? # file exists
+      self.config.each{|opt, value| hash[opt.to_sym] = value}
+    else
+      $stderr.puts config_file_name if $VERBOSE
+      self.config = hash
     end
+  end
 
-    def version?
-      File.exist?(version_file_name)
-    end
+  def version?
+    File.exist?(version_file_name)
+  end
 
-    # This reads the data directory's version file
-    def version
-      File.read(version_file_name).strip
-    rescue
-      trace.puts $!.message    if trace
-      verbose.puts $!.backtrace if verbose
-      nil
-    end
+  # This reads the data directory's version file
+  def version
+    File.read(version_file_name).strip
+  rescue
+    $stderr.puts $!.message   if $VERBOSE
+    $stderr.puts $!.backtrace if $DEBUG
+    nil
+  end
 
-    def version=(v)
-      File.open(version_file_name, 'w', 0600){|fh| fh.puts v}
-    end
+  def version=(v)
+    File.open(version_file_name, 'w', 0600){|fh| fh.puts v}
   end
 end

data/lib/user_space/version.rb

@@ -1,3 +1,3 @@
-module USER_SPACE
-  VERSION = '1.0.0'
+class UserSpace
+  VERSION = '2.0.1'
 end

data/lib/user_space.rb

@@ -1,4 +1,3 @@
-require 'English'
 require 'fileutils'
 require 'json' # default parser
 require 'xdg'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: user_space
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - carlosjhr64
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2014-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xdg