user_space 3.0.0 → 5.1.210201

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d3ae8aaabb7afea9d1a3196eaf03f8966452af23
-  data.tar.gz: ad86d87a76f09b750b816bd0ed2fa6b50a4b4fc2
+SHA256:
+  metadata.gz: c868edf8d004a22ff97fc912b5562df08524a5b7a0369531758e302ae9b323bf
+  data.tar.gz: f1cd273b38bcb8209128ce601a9165404a287cecf9852678e9a20541c4d949e4
 SHA512:
-  metadata.gz: 2f32473a4e15619c124c18afbf4076934148e2d5bc1e28da76dcd46948ee6ad58e98bfa28bcf209d7c2d64ececf9302663ef1a5f12c65ce9684db7e3b68b68ca
-  data.tar.gz: ffa7851b59e727ac38aedb942fcfd32685eef4317152048912382732853a144eb41c26517a1d8ccf0dd593ede3edb7f9dcf8488795e7ec8037db3333bd2118aa
+  metadata.gz: dbd37a67613e70b2f8490d6c70962cf6e364f5e866b65b576109392c40b820cd84857a2edde91ba5d79e4bedab2ee12a12ba037e717b55e7dde9bc0dd71347f7
+  data.tar.gz: b810e6a240efa6c022045e4b49b9b7de2a6e64fa8c0c9a60cdaf5e767383591441da1aae90781864ef0ad1ba85ff52d350dd6deb9aa701a34e9aa88c48132244

data/README.md

@@ -0,0 +1,74 @@
+# UserSpace
+
+* [VERSION 5.1.210201](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 user's cache, config, and data directories
+with the gem-apps cache, config, and data files.
+
+## SYNOPSIS:
+
+```ruby
+require 'rbon' # Using RBON(is not 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:RBON, appname:'myapp') #~> ^#<UserSpace:
+# Will maintain these directories:
+['~/.cache/myapp',
+ '~/.config/myapp',
+ '~/.local/share/myapp'
+].all?{File.directory? File.expand_path _1} #=> true
+
+if USERSPACE.config?
+  # Update APP::CONFIG with user's preferences.
+  App::CONFIG.merge! USERSPACE.config
+else
+  # Write initial configuration with 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.rbon' #=> true
+```
+
+## INSTALL:
+
+```shell
+$ gem install user_space
+```
+
+## LICENSE:
+
+(The MIT License)
+
+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
+'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/lib/user_space.rb

@@ -1,89 +1,81 @@
 require 'fileutils'
-require 'xdg'
 # Requires:
 #`ruby`
 
-module FileUtils
-  class << self
-    def user_space_cpr(src, dest)
-      fu_each_src_dest(src, dest) do |s, d|
-        copy_entry(s, d)
-        chmod('u+rwX,go-rwx', d)
-      end
-    end
-  end
-end
-
 class UserSpace
-  VERSION = '3.0.0'
+  VERSION = '5.1.210201'
+  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'),
+  }
 
-  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
+  def self.appdir(lib='/lib')
+    (_ = caller(1..2)[-1]&.split(':',2)&.fetch(0)) and File.dirname(File.dirname(File.expand_path(_)))&.chomp(lib)
   end
 
-  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'
-  )
-    @parser,@ext,@appname,@xdgbases,@appdir,@config = parser,ext,appname,xdgbases,appdir,config
-    install(false) # install with no overwrite
+  attr_reader :parser,:ext,:appname,:xdgbases,:appdir,:cfg
+  def initialize( parser:,
+                  appdir:   UserSpace.appdir,
+                  ext:      parser.to_s.downcase,
+                  appname:  File.basename($0),
+                  xdgbases: ['cache', 'config', 'data'],
+                  config:   'config')
+    @parser,@ext,@appname,@xdgbases,@appdir,@cfg = parser,ext,appname,xdgbases,appdir,config
+    install
   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
 
-  # 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)
+  # Will not overwrite anything.
+  # Only copies over missing directories and files.
+  # Verifies directory expectations.
+  def install
     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
+        assert_directory(userdir)
       else
         Dir.mkdir(userdir, 0700)
       end
-      FileUtils.user_space_cpr(Dir.glob("#{basedir}/*"), userdir) if File.directory? basedir
+      if File.directory? basedir
+        Dir.glob("#{basedir}/**/*").each do |src|
+          dest = src.sub(basedir, userdir)
+          if File.exist? dest
+            # Sanity checks
+            assert_directory(dest) if File.directory? src
+          else
+            if File.directory? src
+              Dir.mkdir dest
+            else
+              FileUtils.cp src, dest
+            end
+            FileUtils.chmod('u+rwX,go-rwx', dest)
+          end
+        end
+      end
     end
   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}"
-  end
-
-  # Not really for public use.
-  def version_file_name
-    File.join XDG['DATA'].to_s, @appname, 'VERSION'
+    File.join XDG['config'], @appname, "#{@cfg}.#{@ext}"
   end
 
   def config?
@@ -106,28 +98,17 @@ 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
+      hash.merge! config
     else
       $stderr.puts config_file_name if $VERBOSE
       self.config = hash
     end
   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
-    $stderr.puts $!.message   if $VERBOSE
-    $stderr.puts $!.backtrace if $DEBUG
-    nil
-  end
+  private
 
-  def version=(v)
-    File.open(version_file_name, 'w', 0600){|fh| fh.puts v}
+  def assert_directory(dir)
+    raise "Not a directory: #{dir}" unless File.directory?(dir)
   end
 end

metadata

@@ -1,48 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: user_space
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 5.1.210201
 platform: ruby
 authors:
 - carlosjhr64
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-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-02-01 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: []
-extra_rdoc_files:
-- README.rdoc
+extra_rdoc_files: []
 files:
-- README.rdoc
+- README.md
 - lib/user_space.rb
 homepage: https://github.com/carlosjhr64/user_space
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
-rdoc_options:
-- "--main"
-- README.rdoc
+post_install_message:
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
@@ -56,10 +39,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- 'ruby: ruby 2.4.2p198 (2017-09-14 revision 59899) [x86_64-linux]'
-rubyforge_project: 
-rubygems_version: 2.6.13
-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: []

data/README.rdoc

@@ -1,60 +0,0 @@
-= user_space
-
-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.
-
-== 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)
-
-== INSTALL:
-
-   sudo gem install user_space
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2017 CarlosJHR64
-
-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.