user_space 3.0.3 → 4.0.210114

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1dfcc971479291e90e318bd01ba58aa13ebfd8879b8cea95e308b37530933393
-  data.tar.gz: c0bccd867a3a6aa2ab2a6af9280391e6e6c0393b1f9df9664dd9f0ac7f0ccdc0
+  metadata.gz: e2c25f25272f9f0af6d080d708bc07b09b580c273943d654ff51562c54e78073
+  data.tar.gz: 6d33316656f0d3536fb76bde0d0c1f2980c1c6f122ad084ab254b081a64964d4
 SHA512:
-  metadata.gz: a22b5d23502cb1216d444510f1fe0474125a9d5b9ce3bfd87908516071f1efc59290ce367eda718bfb259bc5f1306796cb4e41f075f7b9b6b7623eee7a457fab
-  data.tar.gz: 210fad38ba6a7c41852176660b59ee0301eec0ad193cf04b9cc7273c8de0601942a6b2a9415990379ed59515e933c4cc576c4072a7a9aa52f28e290fa0180403
+  metadata.gz: e3db74fdfba700b3bab9139a7b728dc20edf901d47ee5498cc4a7d546eaa21f31f197ff1b82ec487b584118e4746952ffea0160e770e962ae14093bc8e68ccc1
+  data.tar.gz: 76728fce0b2081d921ba4258607464f228f2279a055e9c1b13db4665ce4eabea35cfccb58251461ab90d0fa49059a53ea021fd92aa377346dba2d4cec6ff93db

data/README.md

@@ -1,45 +1,65 @@
 # UserSpace
 
-* [VERSION 3.0.3](https://github.com/carlosjhr64/user_space/releases)
+* [VERSION 4.0.210114](https://github.com/carlosjhr64/user_space/releases)
 * [github](https://www.github.com/carlosjhr64/user_space)
 * [rubygems](https://rubygems.org/gems/user_space)
 
 ## DESCRIPTION:
 
-Maintains the app's XDG features: app's cache, config, and data directories.
+Maintains the user's cache, config, and data directories
+with the gem-apps cache, config, and data files.
 
 ## SYNOPSIS:
 
-    require 'json' # Using JSON parser for the config file.
-    require 'user_space'
-    # APP::CONFIG is your app's configuration.
-    # Perhaps like...
-    APP::CONFIG = {:tts=>'espeak', }
-    USERSPACE = UserSpace.new(JSON)
-    # Unless this version has been installed,
-    # we copy over our data and cache directories.
-    USERSPACE.install unless USERSPACE.version == APP::VERSION
-    if USERSPACE.config?
-      # Because JSON hashes by String, converting to Symbol.
-      # We pad up APP::CONFIG with user's preferences:
-      USERSPACE.config.each{|opt, value| APP::CONFIG[opt.to_sym] = value}
-    else
-      # We initialize user preferences with our initial APP::CONFIG
-      STDERR.puts "Writting '#{USERSPACE.config_file_name}'"
-      USERSPACE.config = APP::CONFIG
-    end
-    # To do the same thing, you can also say:
-    # USERSPACE.configures(APP::CONFIG)
+```ruby
+require 'json' # Using JSON parser for the config file.
+require 'user_space'
+
+module App
+  # ::App::CONFIG is your app's configuration.
+  CONFIG  = {:tts=>'espeak', }
+  VERSION = '1.2.3'
+end
+
+USERSPACE = UserSpace.new(parser:JSON, appname:'myapp') #~> ^#<UserSpace:
+# Will maintain these directories:
+['~/.cache/myapp',
+ '~/.config/myapp',
+ '~/.local/share/myapp'
+].all?{File.directory? File.expand_path _1} #=> true
+
+# Unless this version has been installed,
+# we copy over our data and cache directories.
+USERSPACE.install unless USERSPACE.version == App::VERSION
+# We have a version file:
+File.exist? File.expand_path '~/.local/share/myapp/VERSION' #=> true
+
+if USERSPACE.config?
+  # Because JSON hashes by String, converting to Symbol.
+  # We pad up App::CONFIG with user's preferences:
+  USERSPACE.config.each{|opt, value| App::CONFIG[opt.to_sym] = value}
+else
+  # We initialize user preferences with our initial App::CONFIG
+  STDERR.puts "Writting '#{USERSPACE.config_file_name}'"
+  USERSPACE.config = App::CONFIG
+end
+# To do the same thing, you can also say:
+# USERSPACE.configures(App::CONFIG)
+# We have a config file:
+File.exist? File.expand_path '~/.config/myapp/config.json' #=> true
+```
 
 ## INSTALL:
 
-    sudo gem install user_space
+```shell
+$ gem install user_space
+```
 
 ## LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2020 CarlosJHR64
+Copyright (c) 2021 CarlosJHR64
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/user_space.rb

@@ -1,36 +1,30 @@
 require 'fileutils'
-require 'xdg'
 # Requires:
 #`ruby`
 
 class UserSpace
-  VERSION = '3.0.3'
-
-  def self.appdir
-    appdir = File.dirname File.dirname caller_locations(1,1)[0].path
-    appdir = File.dirname appdir if File.basename(appdir)=='lib'
-    File.expand_path appdir
-  end
+  VERSION = '4.0.210114'
+  XDG = {
+    'cache'  => ENV['XDG_CACHE_HOME']  || File.expand_path('~/.cache'),
+    'config' => ENV['XDG_CONFIG_HOME'] || File.expand_path('~/.config'),
+    'data'   => ENV['XDG_DATA_HOME']   || File.expand_path('~/.local/share'),
+  }
 
   attr_reader :parser,:ext,:appname,:xdgbases,:appdir,:config
-  def initialize(
-    parser,
-    ext: parser.to_s.downcase,
-    appname: File.basename($0),
-    xdgbases: ['CACHE', 'CONFIG', 'DATA'],
-    appdir: UserSpace.appdir,
-    config: 'config'
-  )
+  def initialize( parser:,
+                  ext:      parser.to_s.downcase,
+                  appname:  File.basename($0),
+                  xdgbases: ['cache', 'config', 'data'],
+                  appdir:   File.dirname(__dir__),
+                  config:   'config')
     @parser,@ext,@appname,@xdgbases,@appdir,@config = parser,ext,appname,xdgbases,appdir,config
     install(false) # install with no overwrite
   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
+      # yield basedir, userdir
+      yield File.join(@appdir, base), File.join(XDG[base], @appname)
     end
   end
 
@@ -64,25 +58,25 @@ class UserSpace
   end
 
   def cachedir
-    File.join XDG['CACHE'].to_s, @appname
+    File.join XDG['cache'], @appname
   end
 
   def configdir
-    File.join XDG['CONFIG'].to_s, @appname
+    File.join XDG['config'], @appname
   end
 
   def datadir
-    File.join XDG['DATA'].to_s, @appname
+    File.join XDG['data'], @appname
   end
 
   # Not really for public use.
   def config_file_name
-    File.join XDG['CONFIG'].to_s, @appname, "#{@config}.#{@ext}"
+    File.join XDG['config'], @appname, "#{@config}.#{@ext}"
   end
 
   # Not really for public use.
   def version_file_name
-    File.join XDG['DATA'].to_s, @appname, 'VERSION'
+    File.join XDG['data'], @appname, 'VERSION'
   end
 
   def config?
@@ -105,8 +99,8 @@ class UserSpace
   end
 
   def configures(hash)
-    if self.config? # file exists
-      self.config.each{|opt, value| hash[opt.to_sym] = value}
+    if config? # file exists
+      config.each{|opt, value| hash[opt.to_sym] = value}
     else
       $stderr.puts config_file_name if $VERBOSE
       self.config = hash

metadata

@@ -1,32 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: user_space
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 4.0.210114
 platform: ruby
 authors:
 - carlosjhr64
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-27 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
-  name: xdg
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.2.3
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.2.3
-description: 'Maintains the app''s XDG features: app''s cache, config, and data directories.
-
-  '
+date: 2021-01-14 00:00:00.000000000 Z
+dependencies: []
+description: |
+  Maintains the user's cache, config, and data directories
+  with the gem-apps cache, config, and data files.
 email: carlosjhr64@gmail.com
 executables: []
 extensions: []
@@ -38,7 +24,7 @@ homepage: https://github.com/carlosjhr64/user_space
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -53,9 +39,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- 'ruby: ruby 2.7.1p83 (2020-03-31 revision a0c7c23c9c) [x86_64-linux]'
-rubygems_version: 3.1.2
-signing_key: 
+- 'ruby: ruby 3.0.0p0 (2020-12-25 revision 95aff21468) [x86_64-linux]'
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
-summary: 'Maintains the app''s XDG features: app''s cache, config, and data directories.'
+summary: Maintains the user's cache, config, and data directories with the gem-apps
+  cache, config, and data files.
 test_files: []