xdg 2.2.5 → 3.0.0

data/lib/xdg.rb

@@ -1,45 +1,11 @@
-# XDG Base Directory Standard
-#
-# This provides a conveient library for conforming to the
-# XDG Base Directory Standard.
-#
-#   http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html
-#
-# Some important clarifications, not made clear by the above specification. 
-#
-# The data directories are for "read-only" files. In other words once
-# something is put there, it should only be read, and never written to
-# by a program. (Generally speaking only users or package managers should
-# be adding, changing or removing files from the data locations.)
-#
-# The config locations are where you store files that may change,
-# and effect your applications depending on their content. This is like
-# etc/ in the FHS, but alterable by end users and end user programs,
-# not just root and sudo admin scripts.
-#
-# The cache locations stores files that could just as well be deleted
-# and everything would still work fine. This is for variable and
-# temporary files. Much like var/ and tmp/ in FHS.
-#
-# The module returns all paths as String.
-#
-module XDG
-  if RUBY_VERSION > '1.9'
-    require_relative 'xdg/version'
-    require_relative 'xdg/base_dir'
-    require_relative 'xdg/base_dir/extended'
-    require_relative 'xdg/base_dir/mixin'
-  else
-    require 'xdg/version'
-    require 'xdg/base_dir'
-    require 'xdg/base_dir/extended'
-    require 'xdg/base_dir/mixin'
-  end
+# frozen_string_literal: true
 
-  #
-  def self.[](*env_path)
-    BaseDir.new(*env_path)
-  end
-end
-
-# Copyright (c) 2008 Rubyworks
+require "xdg/identity"
+require "xdg/pair"
+require "xdg/paths/standard"
+require "xdg/paths/directory"
+require "xdg/paths/combined"
+require "xdg/config"
+require "xdg/data"
+require "xdg/cache"
+require "xdg/environment"

data/lib/xdg/cache.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module XDG
+  class Cache
+    extend Forwardable
+
+    HOME_PAIR = Pair.new("XDG_CACHE_HOME", ".cache").freeze
+
+    delegate %i[home directories all] => :combined
+
+    def initialize home: Paths::Standard, directories: Paths::Directory, environment: ENV
+      @combined = Paths::Combined.new home.new(HOME_PAIR, environment),
+                                      directories.new(Pair.new, environment)
+    end
+
+    private
+
+    attr_reader :combined
+  end
+end

data/lib/xdg/config.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module XDG
+  class Config
+    extend Forwardable
+
+    HOME_PAIR = Pair.new("XDG_CONFIG_HOME", ".config").freeze
+    DIRS_PAIR = Pair.new("XDG_CONFIG_DIRS", "/etc/xdg").freeze
+
+    delegate %i[home directories all] => :combined
+
+    def initialize home: Paths::Standard, directories: Paths::Directory, environment: ENV
+      @combined = Paths::Combined.new home.new(HOME_PAIR, environment),
+                                      directories.new(DIRS_PAIR, environment)
+    end
+
+    private
+
+    attr_reader :combined
+  end
+end

data/lib/xdg/data.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module XDG
+  class Data
+    extend Forwardable
+
+    HOME_PAIR = Pair.new("XDG_DATA_HOME", ".local/share").freeze
+    DIRS_PAIR = Pair.new("XDG_DATA_DIRS", "/usr/local/share:/usr/share").freeze
+
+    delegate %i[home directories all] => :combined
+
+    def initialize home: Paths::Standard, directories: Paths::Directory, environment: ENV
+      @combined = Paths::Combined.new home.new(HOME_PAIR, environment),
+                                      directories.new(DIRS_PAIR, environment)
+    end
+
+    private
+
+    attr_reader :combined
+  end
+end

data/lib/xdg/environment.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module XDG
+  class Environment
+    def initialize home: Paths::Standard, directories: Paths::Directory, environment: ENV
+      @cache = Cache.new home: home, directories: directories, environment: environment
+      @config = Config.new home: home, directories: directories, environment: environment
+      @data = Data.new home: home, directories: directories, environment: environment
+    end
+
+    def cache_home
+      cache.home
+    end
+
+    def config_home
+      config.home
+    end
+
+    def config_dirs
+      config.directories
+    end
+
+    def data_home
+      data.home
+    end
+
+    def data_dirs
+      data.directories
+    end
+
+    private
+
+    attr_reader :cache, :config, :data
+  end
+end

data/lib/xdg/identity.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module XDG
+  # Gem identity information.
+  module Identity
+    def self.name
+      "xdg"
+    end
+
+    def self.label
+      "XDG"
+    end
+
+    def self.version
+      "3.0.0"
+    end
+
+    def self.version_label
+      "#{label} #{version}"
+    end
+  end
+end

data/lib/xdg/pair.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module XDG
+  # A generic key-value pair (KVP).
+  Pair = Struct.new :key, :value do
+    def to_env
+      Hash[*values]
+    end
+  end
+end

data/lib/xdg/paths/combined.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module XDG
+  module Paths
+    # The combined home and directory paths.
+    class Combined
+      def initialize initial_home, initial_directories
+        @initial_home = initial_home
+        @initial_directories = initial_directories
+      end
+
+      def home
+        initial_home.dynamic
+      end
+
+      def directories
+        initial_directories.dynamic
+      end
+
+      def all
+        directories.prepend home
+      end
+
+      private
+
+      attr_reader :initial_home, :initial_directories
+    end
+  end
+end

data/lib/xdg/paths/directory.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "pathname"
+
+module XDG
+  module Paths
+    # A collection of XDG directories.
+    class Directory
+      DELIMITER = ":"
+
+      def initialize pair, environment = ENV
+        @pair = pair
+        @environment = environment
+      end
+
+      def default
+        paths.split(DELIMITER).map(&method(:expand))
+      end
+
+      def dynamic
+        environment.fetch(pair.key, paths).split(DELIMITER).uniq.map(&method(:expand))
+      end
+
+      private
+
+      attr_reader :pair, :environment
+
+      def paths
+        String pair.value
+      end
+
+      def expand path
+        Pathname(path).expand_path
+      end
+    end
+  end
+end

data/lib/xdg/paths/standard.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "pathname"
+
+module XDG
+  module Paths
+    # A XDG home path.
+    class Standard
+      extend Forwardable
+
+      HOME_KEY = "HOME"
+
+      delegate %i[key value] => :pair
+
+      def initialize pair, environment = ENV
+        @pair = pair
+        @environment = environment
+      end
+
+      def default
+        expand_home_for String(value)
+      end
+
+      def dynamic
+        String(environment[key]).then { |path| path.empty? ? default : expand_home_for(path) }
+      end
+
+      private
+
+      attr_reader :pair, :environment
+
+      def home
+        Pathname environment.fetch(HOME_KEY)
+      end
+
+      def expand_home_for path
+        home.join(path).expand_path
+      end
+    end
+  end
+end

metadata

@@ -1,10 +1,9 @@
 --- !ruby/object:Gem::Specification
 name: xdg
 version: !ruby/object:Gem::Version
-  version: 2.2.5
+  version: 3.0.0
 platform: ruby
 authors:
-- Trans
 - Brooke Kuhlmann
 autorequire: 
 bindir: bin
@@ -29,60 +28,227 @@ cert_chain:
   dKvURM+1PwDCzC5tvRwjhUJIizau6+MtkFCvJHmaAj1aZL3odcPejHj5Hxt/0CUW
   y84=
   -----END CERTIFICATE-----
-date: 2019-05-22 00:00:00.000000000 Z
-dependencies: []
+date: 2019-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: gemsmith
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.4'
+- !ruby/object:Gem::Dependency
+  name: git-cop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.69'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.69'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.33'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.33'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
 description: 
 email:
-- transfire@gmail.com
 - brooke@alchemists.io
 executables: []
 extensions: []
 extra_rdoc_files:
 - README.md
-- LICENSE.txt
-- DEMO.md
-- HISTORY.md
+- LICENSE.md
 files:
-- ".index"
-- ".yardopts"
-- DEMO.md
-- HISTORY.md
-- LICENSE.txt
+- LICENSE.md
 - README.md
-- demo/01_base_dir.md
-- demo/02_base_dir_extended.md
-- demo/03_base_dir_mixin.md
-- demo/applique/ae.rb
-- demo/applique/fakeroot.rb
-- demo/applique/xdg.rb
-- demo/fixtures/fakeroot/etc/xdg/bar.config
-- demo/fixtures/fakeroot/home/joe/foo.txt
-- demo/fixtures/fakeroot/usr/share/bar.dat
 - lib/xdg.rb
-- lib/xdg/base_dir.rb
-- lib/xdg/base_dir/extended.rb
-- lib/xdg/base_dir/global_variables.rb
-- lib/xdg/base_dir/legacy.rb
-- lib/xdg/base_dir/mixin.rb
-- lib/xdg/version.rb
-- test/fakeroot/etc/xdg/bar.config
-- test/fakeroot/usr/share/bar.dat
-- test/test_xdg_legacy.rb
+- lib/xdg/cache.rb
+- lib/xdg/config.rb
+- lib/xdg/data.rb
+- lib/xdg/environment.rb
+- lib/xdg/identity.rb
+- lib/xdg/pair.rb
+- lib/xdg/paths/combined.rb
+- lib/xdg/paths/directory.rb
+- lib/xdg/paths/standard.rb
 homepage: https://github.com/bkuhlmann/xdg
 licenses:
-- BSD-2-Clause
-metadata: {}
-post_install_message: 'Development of this project has been transfered here: https://github.com/bkuhlmann/xdg.
-  This will be the last version supported within the 2.2.x series. Be aware major
-  breaking changes will be introduced in the upcoming 3.0.0 release (2019-06-01).'
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/bkuhlmann/xdg
+  changelog_uri: https://github.com/bkuhlmann/xdg/blob/master/CHANGES.md
+  bug_tracker_uri: https://github.com/bkuhlmann/xdg/issues
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -92,5 +258,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: XDG provides an interface for using XDG directory standard.
+summary: Provides an implementation of the XDG Base Directory Specification.
 test_files: []