env_paths 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2cc22755ba9902f3b8f54858a6dd275f1fe700a
+  data.tar.gz: 3509ff818d39a36d394bc9bde666fa2c467fb3b7
+SHA512:
+  metadata.gz: 6c55f3fbd5708d5a0595d872a3d00ebdd4259376c8aa51a69af00396023dc4abf46aaad9915b922325c0387230ecce83e04bbcb6e4ca15cb6ef13d22e8814e85
+  data.tar.gz: de871e6a93e54322e279e76772e112213ebd6a903ca2212dc85abbbabea7b140437c4cc835b81781d8d9358733df6b16a0f2362853a5fefff198f80346580b2a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Documentation:
+  Enabled: false
+Metrics/LineLength:
+    Enabled: false

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install:
+  - gem update bundler
+notifications:
+  email:
+    on_success: never
+    on_failure: always

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in env_paths.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Nick Tomlin
+
+MIT License
+
+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,65 @@
+EnvPaths
+===
+
+Provides OS specific paths for your gem/application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'env_paths'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install env_paths
+
+## Usage
+
+```ruby
+paths = EnvPaths.get('my_app')
+
+paths.temp
+# => /var/folders/82/6j4l32lj4_g09w60_vjxh09h392d05/T/my_app-ruby
+
+paths.config
+# => /Users/your_user/Library/Preferences/my_app-ruby
+```
+
+### Options
+
+`suffix`
+
+If there is a conflict with a native application and the default suffix (`ruby`), you can pass a `suffix` key in the options hash:
+
+```ruby
+paths = EnvPaths.get('my_app', suffix: 'my_suffix')
+
+paths.temp
+# => /var/folders/82/6j4l32lj4_g09w60_vjxh09h392d05/T/my_app-my_suffix
+
+```
+
+Or disable it entirely by passing `false`:
+
+```ruby
+paths = EnvPaths.get('my_app', suffix: false)
+
+paths.temp
+# => /var/folders/82/6j4l32lj4_g09w60_vjxh09h392d05/T/my_app
+
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/nicktomlin/env_paths/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Run the tests `rake`
+4. Commit your changes (`git commit -am 'Add some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+
+spec = eval(File.read('env_paths.gemspec')) # rubocop:disable Lint/Eval
+
+Gem::PackageTask.new(spec)
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %w(rubocop spec)

data/env_paths.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'env_paths/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'env_paths'
+  spec.version       = EnvPaths::VERSION
+  spec.authors       = ['Nick Tomlin']
+  spec.email         = ['nick.tomlin@gmail.com']
+  spec.summary       = 'Environment specific paths. A port of npm\'s env-paths'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.45.0'
+end

data/lib/env_paths.rb

@@ -0,0 +1,66 @@
+require 'env_paths/version'
+require 'tmpdir'
+require 'etc'
+
+module EnvPaths
+  OSData = Struct.new(:data, :config, :cache, :log, :temp)
+  HOMEDIR = Dir.home
+
+  module Linux
+    def self.config(app_name)
+      OSData.new(
+        ENV.fetch('XDG_DATA_HOME', File.join(HOMEDIR, '.local', 'share', app_name)),
+        ENV.fetch('XDG_CONFIG_HOME', File.join(HOMEDIR, '.config', app_name)),
+        ENV.FETCH('XDG_CACHE_HOME', File.join(HOMEDIR, '.cache', app_name)),
+        # https://wiki.debian.org/XDGBaseDirectorySpecification#state
+        ENV.FETCH('XDG_STATE_HOME', File.join(HOMEDIR, '.local', 'state', app_name)),
+        File.join(Dir.tmpdir, ENV['user'], app_name)
+      )
+    end
+  end
+
+  module Windows
+    def self.config(app_name)
+      app_data = ENV.fetch('LOCALAPPDATA', File.join(HOMEDIR, 'AppData', 'Local'))
+
+      OSData.new(
+        File.join(app_data, app_name, 'Data'),
+        File.join(app_data, app_name, 'Config'),
+        File.join(app_data, app_name, 'Cache'),
+        File.join(app_data, app_name, 'Log'),
+        File.join(Dir.tmpdir, app_name)
+      )
+    end
+  end
+
+  module MacOs
+    def self.config(app_name)
+      library = File.join(Dir.home, 'Library')
+
+      OSData.new(
+        File.join(library, 'Application Support', app_name),
+        File.join(library, 'Preferences', app_name),
+        File.join(library, 'Caches', app_name),
+        File.join(library, 'Logs', app_name),
+        File.join(Dir.tmpdir, app_name)
+      )
+    end
+  end
+
+  def self._platform
+    RUBY_PLATFORM
+  end
+
+  def self.get(app_name, opts = {})
+    suffix = opts.fetch(:suffix, 'ruby')
+    app_name += "-#{suffix}" unless opts[:suffix] == false
+    case _platform.downcase
+    when /win32/
+      Windows.config(app_name)
+    when /darwin/
+      MacOs.config(app_name)
+    else
+      Linux.config(app_name)
+    end
+  end
+end

data/lib/env_paths/version.rb

@@ -0,0 +1,3 @@
+module EnvPaths
+  VERSION = '0.0.1'.freeze
+end

data/spec/env_paths_spec.rb

@@ -0,0 +1,34 @@
+describe EnvPaths do
+  it 'accepts and uses a suffix to avoid conflicting with other applications' do
+    env_paths = EnvPaths.get('my_app', suffix: 'my_suffix')
+
+    expect(env_paths.data).to match(/my_app-my_suffix$/)
+  end
+
+  it 'allows overriding suffix by passing "false"' do
+    env_paths = EnvPaths.get('my_app', suffix: false)
+
+    expect(env_paths.data).to match(/my_app$/)
+  end
+
+  context 'MacOs' do
+    it 'returs osx specific data' do
+      allow(EnvPaths).to receive(:_platform).and_return('x86_64-darwin13.0')
+      env_paths = EnvPaths.get('my_app')
+
+      expect(env_paths.data).to match(%r{/Users/.*/Library/Application Support/my_app-ruby})
+      expect(env_paths.config).to match(%r{/Users/.*/Library/Preferences/my_app-ruby})
+      expect(env_paths.cache).to match(%r{/Users/.*/Library/Caches/my_app-ruby})
+      expect(env_paths.log).to match(%r{/Users/.*/Library/Logs/my_app-ruby})
+      expect(env_paths.temp).to match(%r{/var/folders/.*/my_app-ruby})
+    end
+  end
+
+  context 'Linux' do
+    it 'returs linux specific data'
+  end
+
+  context 'Windows' do
+    it 'returs windows specific data'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'env_paths'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.order = :random
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: env_paths
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nick Tomlin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.45.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.45.0
+description: 
+email:
+- nick.tomlin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- env_paths.gemspec
+- lib/env_paths.rb
+- lib/env_paths/version.rb
+- spec/env_paths_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Environment specific paths. A port of npm's env-paths
+test_files:
+- spec/env_paths_spec.rb
+- spec/spec_helper.rb