multi_dir 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce861e1b857ef81a8a7b636fefca4baefe2a05bc
+  data.tar.gz: e382dcb44de085b9ebcffedc2a4916aaf4949782
+SHA512:
+  metadata.gz: 8a82b06f595a738d2a4bd493536f76b1260fc72251ef8e8690b1f52dc8aec26553ac0856a02e62989f8382cad47fc7e3de54c94149edcbc1dc99c71a7a68578c
+  data.tar.gz: 79eecdaa711d5edfeb68a15941e52f82719749c56c4777ebd159fcd2040057485f590d127c1a5186f37815a73b2c7107d55adc1736083627829589b5a2ecf4be

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+*.iml
+.idea
+.rbx
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.8.7
+  - jruby
+  - rbx-19mode
+  - rbx-18mode
+

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jan Graichen
+
+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,116 @@
+# MultiDir
+
+[![Build Status](https://travis-ci.org/jgraichen/multi_dir.png?branch=master)](https://travis-ci.org/jgraichen/multi_dir)
+
+**MultiDir** allow libraries and frameworks to request paths in a semantic
+way. This allows administrators to define real paths in one global
+standardized way.
+
+No more `Rails.root.join *%w(tmp uploaded)` anymore. Give administrators the
+freedom to link the temp directory to `/tmp/myapp` or any other system
+specific place by just using `MultiDir.tmp.join 'uploaded'`.
+
+*Note: MultiDir as a library is still under development but the concept sounds nice.*
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'multi_dir'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multi_dir
+
+## Usage
+
+### For All
+
+MultiDir allows to define any semantic path your app, library or framework may
+need. By default the following paths are specified:
+
+```
+MultiDir.bin    # => 'bin'
+MultiDir.lib    # => 'lib'
+MultiDir.tmp    # => 'tmp'
+MultiDir.cache  # => 'tmp/cache'
+MultiDir.files  # => 'files'
+MultiDir.config # => 'config
+```
+
+### For Administrators
+
+**MultiDir** provides everything you need to integrate some hipster app into
+your well known and proven operating system structure. It allows you to
+specify which content should live where without manual patching every piece of
+code.
+
+Create or edit `dirs.yml` in the application root directory (or whereever
+you're running the app) or specific the path using `MULTI_DIR_CONFIG` env
+variable with the following content:
+
+```yaml
+paths:
+  tmp: /tmp/myapp-srv2
+  files: /mnt/nfs2/storage
+  cache: /var/cache/apps/myapp
+  log: /var/log/myapp
+```
+
+This file allows you to specify the base paths for the application.
+
+### For Developers
+
+**MultiDir** makes you a developer loved by administrators as you given them
+the freedom to adjust you app or library according there needs. It also makes
+you happy reaching another stage of more semantic programming.
+
+You can just use **MultiDir** like you've used `Rails.root.join` in the past.
+
+See the following examples:
+
+```ruby
+# Request a specific file
+MultiDir.cache.join *%(pdfgen page5.pdf) # => "cache/pdfgen/page5.pdf"
+
+# Request a file with a temporary name
+MultiDir.tmp.temp_file ['basename', '.jpg'] # => "tmp/basename74hf4727f834.jpg"
+
+# Get list of files in a additional configurable directory
+MultiDir.cache[:uploads].glob '**/*.zip' # This allows admins to configure a special path for :uploads
+                                         # that if not given will be placed in 'cache'.
+                                         # => ["/media/uploads/a/virus.zip", "/media/uploads/attachments/ppt.zip"]
+```
+
+You can even define your own new top level *semantic path*:
+
+```ruby
+MultiDir::Paths.define :uploads, in: :tmp
+```
+
+This allows you to use `uploads` as a top level path that will be placed in `tmp` if not configured otherwise:
+
+```ruby
+MultiDir.uploads.join 'abrng.pdf' # => "/tmp/uploads/abrng.pdf"
+```
+
+*More features will follow.*
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add specs for your feature
+4. Implement your feature
+5. Check that all specs are passing
+6. Commit your changes (`git commit -am 'Add some feature'`)
+7. Push to the branch (`git push origin my-new-feature`)
+8. Create new Pull Request
+
+## License
+
+Copyright (c) 2013 Jan Graichen - MIT License

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/multi_dir.rb

@@ -0,0 +1,26 @@
+require 'active_support/core_ext/kernel/singleton_class'
+require 'active_support/core_ext/hash/keys'
+
+require 'multi_dir/version'
+require 'multi_dir/paths'
+require 'multi_dir/pathname_patch'
+
+module MultiDir
+  class << self
+    def define_path_method(name)
+      name = name.to_sym
+      singleton_class.instance_eval do
+        define_method(name) { self.resolve name }
+      end
+    end
+
+    def [](symbol)
+      Pathname.new MultiDir::Paths.instance.resolve symbol
+    end
+    alias_method :resolve, :[]
+  end
+
+  [ :root, :bin, :lib, :tmp, :config, :cache, :files ].each do |path|
+    define_path_method path
+  end
+end

data/lib/multi_dir/pathname_patch.rb

@@ -0,0 +1,22 @@
+module MultiDir
+
+  # Provide additional function to operate
+  # on directories.
+  #
+  module PathnamePatch
+
+    def glob(pattern)
+      Dir.glob File.join(to_s, pattern)
+    end
+
+    def [](path)
+      if MultiDir::Paths.instance.paths.include? path.to_sym
+        return MultiDir::Paths.instance.resolve(path)
+      end
+
+      join path.to_s
+    end
+  end
+
+  ::Pathname.send :include, PathnamePatch
+end

data/lib/multi_dir/paths.rb

@@ -0,0 +1,124 @@
+require 'yaml'
+
+module MultiDir
+
+  # Can resolve paths using symbols.
+  #
+  class Paths
+
+    def initialize(paths = {})
+      self.paths.merge! paths.symbolize_keys unless paths.nil? or paths.empty?
+    end
+
+    # Resolve symbolic path to real path.
+    #
+    def resolve(symbol)
+      case symbol
+        when :root
+          resolve_root
+        else
+          raise ArgumentError.new "Path symbol `#{symbol.inspect}` does not exist." unless paths.has_key? symbol
+
+          path = paths[symbol]
+          if path.is_a? Array
+            File.join resolve(path[0]), path[1].to_s
+          else
+            path.to_s
+          end
+      end
+    end
+
+    # Resolve root path.
+    #
+    def resolve_root
+      return paths[:root] if paths.has_key? :root
+      return ::Rails.root.to_s if Object.const_defined?(:Rails) && ::Rails.respond_to?(:root)
+      Pathname.pwd.to_s
+    end
+
+    def paths
+      @paths ||= load_paths
+    end
+
+    def load_paths
+      paths = default_paths
+
+      [ 'multi_dir.yml', ENV['MULTI_DIR_CONFIG'] ].reject(&:nil?).each do |file|
+        next unless File.exists? file
+        paths.merge! load_yaml file
+      end
+
+      paths
+    end
+
+    def default_paths
+      {
+          :bin    => [:root, 'bin'],
+          :lib    => [:root, 'lib'],
+          :tmp    => [:root, 'tmp'],
+          :cache  => [:tmp, 'cache'],
+          :config => [:root, 'config'],
+          :files  => [:root, 'files']
+      }
+    end
+
+    def load_yaml(file)
+      raise ArgumentError.new "File `#{file}` does not exists." unless File.exists? file
+      raise ArgumentError.new "File `#{file}` is not readable." unless File.readable? file
+      data = YAML.load_file(file).symbolize_keys
+
+      unless data.is_a? Hash and data.has_key? :paths
+        raise ArgumentError.new "File `#{file}` does not contain a valid MultiDir YAML definition."
+      end
+
+      data[:paths].inject({}) do |memo, row|
+        key, path = row[0].to_sym, row[1].to_s
+        memo[key] = if %w(/ .).include? path[0].chr
+          File.expand_path path.to_s
+        else
+          [ :root, path.to_s ]
+        end
+
+        memo
+      end
+    end
+
+    def load_yaml!(file)
+      paths.merge! load_yaml file
+    end
+
+    def define(name, options = {})
+      name = name.to_s
+
+      if MultiDir.methods.include?(name)
+        raise ArgumentError.new "Path name `#{name}` would override already defined method on MultiDir."
+      end
+
+      parent = options[:id] || options[:parent]
+      paths[name] = [ parent, name.to_s ]
+
+      MultiDir.define_path_method name
+    end
+
+    class << self
+
+      def instance
+        @instance ||= new
+      end
+
+      def reset_instance
+        @instance = nil
+      end
+
+      def load_yaml(file)
+        instance.load_yaml! file
+      end
+
+      # Define a new semantic path.
+      #
+      def define(name, options = {})
+        instance.define name, options
+      end
+    end
+  end
+end

data/lib/multi_dir/version.rb

@@ -0,0 +1,11 @@
+module MultiDir
+  module VERSION
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    STAGE = nil
+    STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.')
+
+    def self.to_s; STRING end
+  end
+end

data/multi_dir.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multi_dir/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'multi_dir'
+  spec.version       = MultiDir::VERSION
+  spec.authors       = ['Jan Graichen']
+  spec.email         = %w(jg@altimos.de)
+  spec.description   = %q{Library for semantic path configuration to make developers and operators happy.}
+  spec.summary       = %q{Library for semantic path configuration to make developers and operators happy.}
+  spec.homepage      = 'https://github.com/jgraichen/multi_dir'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = %w(lib)
+
+  spec.add_runtime_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'coveralls'
+end

data/spec/multi_dir/paths_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe MultiDir::Paths do
+  let(:config) { nil }
+  let(:paths)  { MultiDir::Paths.new config }
+
+  describe '#load_paths' do
+    context 'with local file' do
+      it 'should load local configuration' do
+        Dir.chdir 'spec/support' do
+          expect(paths.resolve :root).to be == '/usr/lib/myapp'
+        end
+      end
+    end
+  end
+
+  describe '#load_yaml' do
+    let(:cfg) { paths.load_yaml 'spec/support/multi_dir.yml' }
+
+    it 'should load configuration from YAML file' do
+      expect(cfg).to include(:root, :bin, :cache, :config, :tmp, :files, :uploads)
+    end
+
+    it 'should detect absolute paths' do
+      expect(cfg[:bin]).to be == '/usr/bin'
+    end
+
+    it 'should detect relative paths' do
+      expect(cfg[:spec_support]).to be == [ :root, 'spec/support' ]
+    end
+
+    it 'should detect working dir relative path' do
+      expect(cfg[:spec_support2]).to be == Pathname.pwd.join('spec/support').to_s
+    end
+  end
+
+  describe '#resolve' do
+    let(:config) { { :root => '/root', :tmp => [:root, 'tmp'] } }
+
+    it 'should resolve direct path symbol' do
+      expect(paths.resolve :root).to be == '/root'
+    end
+
+    it 'should resolve indirect path symbol' do
+      expect(paths.resolve :tmp).to be == '/root/tmp'
+    end
+
+    it 'should raise error on not existing path symbols' do
+      expect {
+        paths.resolve :not_existing_symbol
+      }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '#resovle_root' do
+    context 'with configure root path' do
+      let(:config) { { :root => '/var/app/root' } }
+
+      it 'should resolve to configured root path' do
+        expect(paths.resolve_root).to be == '/var/app/root'
+      end
+    end
+
+    context 'with not configured path but loaded Rails app' do
+      before { module ::Rails; def self.root; Pathname.new 'app'; end end }
+      after  { Object.send :remove_const, :Rails }
+
+      it 'should resolve to Rails root' do
+        expect(paths.resolve_root).to be == 'app'
+      end
+    end
+
+    context 'without configured path and rails root' do
+      it 'should resolve to current working dir' do
+        expect(paths.resolve_root).to be == Pathname.pwd.to_s
+      end
+    end
+  end
+end

data/spec/multi_dir_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe MultiDir do
+  before { MultiDir::Paths.reset_instance }
+  before { MultiDir::Paths.load_yaml 'spec/support/multi_dir.yml' }
+
+  it 'should resolve root path' do
+    expect(MultiDir.root.to_s).to be == '/usr/lib/myapp'
+  end
+
+  it 'should resolve bin path' do
+    expect(MultiDir.bin.to_s).to be == '/usr/bin'
+  end
+
+  it 'should resolve config path' do
+    expect(MultiDir.config.to_s).to be == '/etc/myapp'
+  end
+
+  it 'should resolve files path' do
+    expect(MultiDir.files.to_s).to be == '/var/files/myapp'
+  end
+
+  it 'should resolve tmp path' do
+    expect(MultiDir.tmp.to_s).to be == '/tmp/myapp'
+  end
+
+  it 'should resolve cache path' do
+    expect(MultiDir.cache.to_s).to be == '/var/cache/myapp'
+  end
+
+  it 'should resolve custom path' do
+    MultiDir::Paths.define :uploads, :in => :files
+    expect(MultiDir.uploads.to_s).to be == '/mnt/nfs/storage0/files'
+  end
+
+  it 'should resolve quick path' do
+    expect(MultiDir.files[:uploads].to_s).to be == '/mnt/nfs/storage0/files'
+  end
+
+  it 'should resolve not configured quick path' do
+    expect(MultiDir.files[:attachments].to_s).to be == '/var/files/myapp/attachments'
+  end
+
+  it 'should allow to glob path' do
+    expect(MultiDir[:spec_support2].glob('*.yml').sort).to be == [
+        File.expand_path('spec/support/multi_dir.yml'),
+        File.expand_path('spec/support/multi_dir_2.yml')
+    ]
+  end
+
+  it 'should allow to join path' do
+    expect(MultiDir.root.join('app', 'controllers').to_s).to be == '/usr/lib/myapp/app/controllers'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require 'multi_dir'
+require 'coveralls'
+Coveralls.wear! do
+  add_filter 'spec'
+end
+
+Dir[File.expand_path('spec/support/**/*.rb')].each {|f| require f}
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.expect_with :rspec do |c|
+    # Only allow expect syntax
+    c.syntax = :expect
+  end
+end

data/spec/support/multi_dir.yml

@@ -0,0 +1,10 @@
+paths:
+  root: /usr/lib/myapp
+  bin: /usr/bin
+  tmp: /tmp/myapp
+  cache: /var/cache/myapp
+  config: /etc/myapp
+  files: /var/files/myapp
+  uploads: /mnt/nfs/storage0/files
+  spec_support: spec/support
+  spec_support2: ./spec/support

data/spec/support/multi_dir_2.yml

@@ -0,0 +1,2 @@
+paths:
+  root: /var/lib/myapp2

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: multi_dir
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Graichen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Library for semantic path configuration to make developers and operators
+  happy.
+email:
+- jg@altimos.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/multi_dir.rb
+- lib/multi_dir/pathname_patch.rb
+- lib/multi_dir/paths.rb
+- lib/multi_dir/version.rb
+- multi_dir.gemspec
+- spec/multi_dir/paths_spec.rb
+- spec/multi_dir_spec.rb
+- spec/spec_helper.rb
+- spec/support/multi_dir.yml
+- spec/support/multi_dir_2.yml
+homepage: https://github.com/jgraichen/multi_dir
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Library for semantic path configuration to make developers and operators
+  happy.
+test_files:
+- spec/multi_dir/paths_spec.rb
+- spec/multi_dir_spec.rb
+- spec/spec_helper.rb
+- spec/support/multi_dir.yml
+- spec/support/multi_dir_2.yml
+has_rdoc: