standard_path 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5ec8d3c8fcc063e727341c00c0528cff401c6f8f0c8c1b200b295a5e8144d70e
+  data.tar.gz: ef58cf85453846ee77ad014ec77ef2e06c4329f4557592081ab692cf1faddfc3
+SHA512:
+  metadata.gz: c6799c4d00cc68f4cb3256cf7800b90b088051867ab1b3a41ee62ca10329f7be20cc9bf3a7292868918b9e950d62eedf0343df0d168856c2f24da1c6c7bd46ea
+  data.tar.gz: 2e66f7fdcf3f8abb3e66af9a46648a35489072ed075d1e9fc4d74842fe9d40ff187ed3e5359ef7b68d2980ebdb76c970cec15061c743d8617c3740aa97754acd

data/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023-present Aoran Zeng. All rights reserved.
+
+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/README.md

@@ -0,0 +1,31 @@
+# StandardPath
+
+## Install
+
+```bash
+$ gem install standard_path
+```
+
+## Usage
+
+```ruby
+require 'standard_path'
+
+StandardPath.downloads
+StandardPath.music
+StandardPath.app_local_data(my_app)
+```
+
+## APIs
+
+- `.desktop`
+- `.documents`
+- `.downloads`
+- `.pictures`
+- `.music`
+- `.videos` / `.movies`
+
+- `.app_data(name)`
+- `.app_local_data(name)`
+- `.app_config(name)`
+- `.app_cache(name)`

data/lib/standard_path.rb

@@ -0,0 +1,171 @@
+# ---------------------------------------------------------------
+# File          : standard_path.rb
+# Authors       : Aoran Zeng <ccmywish@qq.com>
+# Created on    : <2023-05-19>
+# Last modified : <2023-05-19>
+#
+# stardard_path:
+#
+#   Standard Path for corss-platform gems
+# ---------------------------------------------------------------
+
+module StandardPath
+
+  VERSION = "0.1.0"
+
+  OSes = ['Windows', 'macOS', 'Linux']
+
+end
+
+
+class << StandardPath
+
+  class UnknownOS < StandardError ; end
+  class NotSupportedOS < StandardError; end
+
+  def os
+    host_os = RbConfig::CONFIG['host_os']
+    if Gem.win_platform?
+      'Windows'
+    elsif host_os =~ /darwin/
+      'macOS'
+    elsif host_os =~ /mac/
+      # This condition is just for possible future compatibility only
+      'macOS'
+    elsif host_os =~ /linux/
+      'Linux'
+    elsif host_os =~ /freebsd/
+      'FreeBSD'
+      raise NotSupportedOS, "Currently #{name} doesn't support FreeBSD."
+    else
+      'Unknown'
+      raise UnknownOS, "#{name} doesn't know about your OS type."
+    end
+  end
+
+
+  def desktop(os = self.os)
+    case os
+    when 'Windows', 'macOS', 'Linux'
+      File.expand_path "~/Desktop"
+    else
+      raise NotSupportedOS, "#{name} doesn't know about #{__method__} path of '#{os}' you specify"
+    end
+  end
+
+
+  def documents(os = self.os)
+    case os
+    when 'Windows', 'macOS', 'Linux'
+      File.expand_path "~/Documents"
+    else
+      raise NotSupportedOS, "#{name} doesn't know about #{__method__} path of '#{os}' you specify"
+    end
+  end
+
+
+  def downloads(os = self.os)
+    case os
+    when 'Windows', 'macOS', 'Linux'
+      File.expand_path "~/Downloads"
+    else
+      raise NotSupportedOS, "#{name} doesn't know about #{__method__} path of '#{os}' you specify"
+    end
+  end
+
+
+  def pictures(os = self.os)
+    case os
+    when 'Windows', 'macOS', 'Linux'
+      File.join Dir.home, 'Pictures'
+    else
+      raise NotSupportedOS, "#{name} doesn't know about #{__method__} path of '#{os}' you specify"
+    end
+  end
+
+
+  def music(os = self.os)
+    case os
+    when 'Windows', 'macOS', 'Linux'
+      File.expand_path '~/Music'
+    else
+      raise NotSupportedOS, "#{name} doesn't know about #{__method__} path of '#{os}' you specify"
+    end
+  end
+
+
+  def movies(os = self.os)
+    case os
+    when 'Windows', 'Linux'
+      File.expand_path '~/Videos'
+    when 'macOS'
+      File.expand_path '~/Movies'
+    else
+      raise NotSupportedOS, "#{name} doesn't know about #{__method__} path of '#{os}' you specify"
+    end
+  end
+
+
+  alias videos movies
+
+
+  def app_data(app, os = self.os)
+    base = case os
+    when 'Windows'
+      File.join "~/AppData/Roaming", app
+    when 'macOS'
+      File.join "~/Library/Application Support", app
+    when 'Linux'
+      File.join "~/.local/share", app
+    else
+      raise NotSupportedOS, "#{self.name} doesn't know about #{__method__} path of '#{os}' you specify"
+    end
+    File.expand_path base
+  end
+
+
+  def app_local_data(app, os = self.os)
+    base = case os
+    when 'Windows'
+      File.join "~/AppData/Local", app
+    when 'macOS'
+      File.join "~/Library/Application Support", app
+    when 'Linux'
+      File.join "~/.local/share", app
+    else
+      raise NotSupportedOS, "#{self.name} doesn't know about #{__method__} path of '#{os}' you specify"
+    end
+    File.expand_path base
+  end
+
+
+  def app_config(app, os = self.os)
+    base = case os
+    when 'Windows'
+      File.join "~/AppData/Local", app
+    when 'macOS'
+      File.join "~/Library/Preferences", app
+    when 'Linux'
+      File.join '~/.config', app
+    else
+      raise NotSupportedOS, "#{self.name} doesn't know about #{__method__} path of '#{os}' you specify"
+    end
+    File.expand_path base
+  end
+
+
+  def app_cache(app, os = self.os)
+    base = case os
+    when 'Windows'
+      File.join "~/AppData/Local", app, 'cache'
+    when 'macOS'
+      File.join "~/Library/Caches", app
+    when 'Linux'
+      File.join '~/.cache', app
+    else
+      raise NotSupportedOS, "#{self.name} doesn't know about #{__method__} path of '#{os}' you specify"
+    end
+    File.expand_path base
+  end
+
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: standard_path
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aoran Zeng
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-05-19 00:00:00.000000000 Z
+dependencies: []
+description: 'Standard Path for corss-platform gems.
+
+  '
+email: ccmywish@qq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/standard_path.rb
+homepage: https://github.com/ccmywish/standard_path
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/ccmywish/standard_path/issues
+  source_code_uri: https://github.com/ccmywish/standard_path
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.8
+signing_key:
+specification_version: 4
+summary: Standard Path for corss-platform gems
+test_files: []