rubypath 0.1.0

data/spec/rubypath/path_operations_spec.rb

@@ -0,0 +1,383 @@
+require 'spec_helper'
+
+describe Path do
+  describe 'Path Operations' do
+    let(:str)  { '/root/path' }
+    let(:args) { [str] }
+    let(:path) { Path(*args) }
+    subject { path }
+
+    describe_method :join do
+      subject { path.send described_method, *join_args}
+
+      context 'with single string' do
+        let(:join_args) { ['to/file.txt'] }
+        it { should eq '/root/path/to/file.txt' }
+      end
+
+      context 'with multiple strings' do
+        let(:join_args) { ['to/', 'file.txt'] }
+        it { should eq '/root/path/to/file.txt' }
+      end
+
+      context 'with multiple args' do
+        let(:join_args) { ['to/', Path('dir'), Pathname.new('sub/file.txt')] }
+        it { should eq '/root/path/to/dir/sub/file.txt' }
+      end
+
+      context 'with absolute path' do
+        let(:join_args) { ['/path/to/file.txt'] }
+        it { should eq '/path/to/file.txt' }
+      end
+
+      context 'with mixed paths' do
+        let(:join_args) { ['rel/file', '/path/to/file.txt', 'sub'] }
+        it { should eq '/path/to/file.txt/sub' }
+      end
+    end
+
+    describe_method :each_component do
+      let(:block) { nil }
+      let(:opts) { Hash.new }
+      let(:str) { '/path/to/templates/dir/' }
+      subject { path.send described_method, opts, &block }
+
+      it { should be_a Enumerator }
+
+      it 'should return all components' do
+        expect(subject.to_a).to eq %w(path to templates dir)
+      end
+
+      context 'with empty option' do
+        let(:opts) { {empty: true} }
+
+        it 'should also return empty path components' do
+          expect(subject.to_a).to eq ([''] + %w(path to templates dir) + [''])
+        end
+      end
+
+      context 'with block' do
+        let(:block) { proc{|fn| fn} }
+
+        it 'should yield components' do
+          expect {|b|
+            path.send described_method, &b
+          }.to yield_successive_args(*%w(path to templates dir))
+        end
+
+        it { should eq path }
+      end
+    end
+
+    describe_method :components do
+      let(:str) { '/path/to/templates/index.html' }
+      subject { path.send described_method }
+
+      it { should be_a Array }
+      it { should eq %w(path to templates index.html) }
+    end
+
+    describe_method :dirname, aliases: [:parent] do
+      shared_examples 'dirname' do
+        it 'should return parent directory' do
+          expect(Path(base, 'path/to/file').send(described_method)).to eq "#{base}path/to"
+        end
+
+        context 'when hitting root' do
+          it 'should return root' do
+            expect(Path(base, 'path').send(described_method)).to eq base[0]
+          end
+        end
+
+        context 'when being root' do
+          it 'should return nil' do
+            expect(Path(base[0]).send(described_method)).to eq nil
+          end
+        end
+      end
+
+      context 'with absolute path' do
+        let(:base) { '/' }
+        it_behaves_like 'dirname'
+      end
+
+      context 'with relative path' do
+        let(:base) { './' }
+        it_behaves_like 'dirname'
+      end
+    end
+
+    with_backends :mock, :sys do
+      describe_method :expand, aliases: [:expand_path, :absolute, :absolute_path] do
+        let(:cwd) { '/working/dir' }
+        let(:base) { cwd }
+        let(:args) { Array.new }
+        before do
+          Path.mock do |root, back|
+            back.cwd = cwd
+            back.current_user = 'test'
+            back.homes = {'test' => '/home/test', 'otto' => '/srv/home/otto'}
+          end
+        end
+
+        around{|example| Path::Backend.mock &example }
+
+        shared_examples '#expand' do
+          subject { Path(path).send(described_method, *args) }
+
+          it 'should expand path' do
+            expect(subject).to eq expanded_path
+          end
+
+          it { should be_a Path }
+        end
+
+        context '~' do
+          let(:path) { '~' }
+          let(:expanded_path) { '/home/test' }
+          it_behaves_like '#expand'
+        end
+
+        context '~/path' do
+          let(:path) { '~/path/to/file.txt' }
+          let(:expanded_path) { '/home/test/path/to/file.txt' }
+          it_behaves_like '#expand'
+        end
+
+        context '~user' do
+          let(:path) { '~otto' }
+          let(:expanded_path) { '/srv/home/otto' }
+          it_behaves_like '#expand'
+        end
+
+        context '~user/path' do
+          let(:path) { '~otto/path/to/file.txt' }
+          let(:expanded_path) { '/srv/home/otto/path/to/file.txt' }
+          it_behaves_like '#expand'
+        end
+
+        context '/abs/path' do
+          let(:path) { '/abs/path/to/file.txt' }
+          let(:expanded_path) { '/abs/path/to/file.txt' }
+          it_behaves_like '#expand'
+        end
+
+        context 'rel/path' do
+          let(:path) { 'rel/path/to/file.txt' }
+          let(:expanded_path) { '/working/dir/rel/path/to/file.txt' }
+          it_behaves_like '#expand'
+        end
+
+        context './path' do
+          let(:path) { './path/to/file.txt' }
+          let(:expanded_path) { '/working/dir/path/to/file.txt' }
+          it_behaves_like '#expand'
+        end
+
+        context 'with base option' do
+          let(:base) { '/base/./' }
+          let(:args) { [base: '/base/./'] }
+
+          context '~' do
+            let(:path) { '~' }
+            let(:expanded_path) { '/home/test' }
+            it_behaves_like '#expand'
+          end
+
+          context '~/path' do
+            let(:path) { '~/path/to/file.txt' }
+            let(:expanded_path) { '/home/test/path/to/file.txt' }
+            it_behaves_like '#expand'
+          end
+
+          context '~user' do
+            let(:path) { '~otto' }
+            let(:expanded_path) { '/srv/home/otto' }
+            it_behaves_like '#expand'
+          end
+
+          context '~user/path' do
+            let(:path) { '~otto/path/to/file.txt' }
+            let(:expanded_path) { '/srv/home/otto/path/to/file.txt' }
+            it_behaves_like '#expand'
+          end
+
+          context '/abs/path' do
+            let(:path) { '/abs/path/to/file.txt' }
+            let(:expanded_path) { '/abs/path/to/file.txt' }
+            it_behaves_like '#expand'
+          end
+
+          context 'rel/path' do
+            let(:path) { 'rel/path/to/file.txt' }
+            let(:expanded_path) { '/base/rel/path/to/file.txt' }
+            it_behaves_like '#expand'
+          end
+
+          context './path' do
+            let(:path) { './path/to/file.txt' }
+            let(:expanded_path) { '/base/path/to/file.txt' }
+            it_behaves_like '#expand'
+          end
+        end
+
+        context 'with path args' do
+          let(:args) { ['..', 'fuu', 'net.txt'] }
+
+          context '~' do
+            let(:path) { '~' }
+            let(:expanded_path) { '/home/fuu/net.txt' }
+            it_behaves_like '#expand'
+          end
+
+          context '~/path' do
+            let(:path) { '~/path/to/file.txt' }
+            let(:expanded_path) { '/home/test/path/to/fuu/net.txt' }
+            it_behaves_like '#expand'
+          end
+
+          context '~user' do
+            let(:path) { '~otto' }
+            let(:expanded_path) { '/srv/home/fuu/net.txt' }
+            it_behaves_like '#expand'
+          end
+
+          context '~user/path' do
+            let(:path) { '~otto/path/to/file.txt' }
+            let(:expanded_path) { '/srv/home/otto/path/to/fuu/net.txt' }
+            it_behaves_like '#expand'
+          end
+
+          context '/abs/path' do
+            let(:path) { '/abs/path/to/file.txt' }
+            let(:expanded_path) { '/abs/path/to/fuu/net.txt' }
+            it_behaves_like '#expand'
+          end
+
+          context 'rel/path' do
+            let(:path) { 'rel/path/to/file.txt' }
+            let(:expanded_path) { '/working/dir/rel/path/to/fuu/net.txt' }
+            it_behaves_like '#expand'
+          end
+
+          context './path' do
+            let(:path) { './path/to/file.txt' }
+            let(:expanded_path) { '/working/dir/path/to/fuu/net.txt' }
+            it_behaves_like '#expand'
+          end
+        end
+      end
+    end
+
+    describe_method :ascend, aliases: [:each_ancestors] do
+      shared_examples 'ascend' do
+        context 'with block' do
+          let(:block) { proc{} }
+          subject { path.send described_method, &block }
+
+          it { should eq path }
+
+          it 'should yield part paths' do
+            expect{|b| path.send described_method, &b }.to yield_successive_args *expected_paths
+          end
+
+          it 'should yield Path objects' do
+            expect{|b| path.send described_method, &b }.to yield_successive_args *expected_paths.map{ Path }
+          end
+        end
+
+        context 'w/o block' do
+          subject { path.send described_method }
+
+          it { should be_a Enumerator }
+
+          it 'should yield part paths' do
+            expect{|b| subject.each &b }.to yield_successive_args *expected_paths
+          end
+
+          it 'should yield path objects' do
+            expect{|b| subject.each &b }.to yield_successive_args *expected_paths.map{ Path }
+          end
+        end
+      end
+
+      context 'with absolute path' do
+        let(:path) { Path '/path/to/file.txt' }
+        let(:expected_paths) { %w(/path/to/file.txt /path/to /path /)}
+        it_behaves_like 'ascend'
+      end
+
+      context 'with relative path' do
+        let(:path) { Path 'path/to/file.txt' }
+        let(:expected_paths) { %w(path/to/file.txt path/to path .)}
+        it_behaves_like 'ascend'
+      end
+    end
+
+    describe '#as_relative' do
+      subject { Path(path).as_relative }
+
+      context 'with absolute path' do
+        let(:path) { '/path/to/file.txt' }
+        it { should eq 'path/to/file.txt' }
+      end
+
+      context 'with relative path' do
+        let(:path) { 'path/to/file.txt' }
+        it { should eq 'path/to/file.txt' }
+      end
+
+      context 'with filename only' do
+        let(:path) { 'file.txt' }
+        it { should eq 'file.txt' }
+      end
+    end
+
+    describe '#as_absolute' do
+      subject { Path(path).as_absolute }
+
+      context 'with absolute path' do
+        let(:path) { '/path/to/file.txt' }
+        it { should eq '/path/to/file.txt' }
+      end
+
+      context 'with relative path' do
+        let(:path) { 'path/to/file.txt' }
+        it { should eq '/path/to/file.txt' }
+      end
+
+      context 'with filename only' do
+        let(:path) { 'file.txt' }
+        it { should eq '/file.txt' }
+      end
+    end
+
+    describe_method :ancestors do
+      shared_examples 'ancestors' do
+        subject { path.send described_method }
+
+        it { should be_a Array }
+
+        it 'should contain part paths' do
+          expect{|b| subject.each &b }.to yield_successive_args *expected_paths
+        end
+
+        it 'should contain path objects' do
+          expect{|b| subject.each &b }.to yield_successive_args *expected_paths.map{ Path }
+        end
+      end
+
+      context 'with absolute path' do
+        let(:path) { Path '/path/to/file.txt' }
+        let(:expected_paths) { %w(/path/to/file.txt /path/to /path /)}
+        it_behaves_like 'ancestors'
+      end
+
+      context 'with relative path' do
+        let(:path) { Path 'path/to/file.txt' }
+        let(:expected_paths) { %w(path/to/file.txt path/to path .)}
+        it_behaves_like 'ancestors'
+      end
+    end
+  end
+end

data/spec/rubypath/path_predicates_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Path do
+  describe 'Path Predicates' do
+    describe '#absolute?' do
+      subject { Path(path).absolute? }
+
+      context 'with absolute path' do
+        let(:path) { '/abs/path/to/file' }
+        it { should be true }
+      end
+
+      context 'with relative path' do
+        let(:path) { 'path/to/file' }
+        it { should be false }
+      end
+    end
+
+    describe '#relative?' do
+      subject { Path(path).relative? }
+
+      context 'with absolute path' do
+        let(:path) { '/abs/path/to/file' }
+        it { should be false }
+      end
+
+      context 'with relative path' do
+        let(:path) { 'path/to/file' }
+        it { should be true }
+      end
+    end
+
+    describe '#mountpoint?' do
+      let(:path) { Path('/tmp') }
+
+      context 'without args' do
+        it 'should invoke backend with current path' do
+          expect(Path::Backend.instance).to receive(:mountpoint?).with('/tmp').and_return(false)
+          path.mountpoint?
+        end
+      end
+
+      context 'with args' do
+        it 'should invoke backend with joined path' do
+          expect(Path::Backend.instance).to receive(:mountpoint?).with('/tmp/fuu').and_return(false)
+          path.mountpoint?('fuu')
+        end
+      end
+    end
+
+    describe_method :dotfile? do
+      subject { path.dotfile? }
+
+      context 'with dotfile' do
+        let(:path) { Path '.abc' }
+        it { should be true }
+      end
+
+      context 'with path to dotfile' do
+        let(:path) { Path '/apth/to/.abc' }
+        it { should be true }
+      end
+
+      context 'with normal file' do
+        let(:path) { Path '/path/to/file' }
+        it { should be false }
+      end
+
+      context 'with path to file within a dotdir' do
+        let(:path) { Path '/home/user/.local/file' }
+        it { should be false }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require 'rspec'
+
+if ENV['CI'] || (defined?(:RUBY_ENGINE) && RUBY_ENGINE != 'rbx')
+  require 'coveralls'
+  Coveralls.wear! do
+    add_filter 'spec'
+  end
+end
+
+require 'bundler'
+Bundler.require :default, :test
+
+require 'rubypath'
+
+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'
+
+  # Raise error when using old :should expectation syntax.
+  config.raise_errors_for_deprecations!
+
+  config.around(:each) do |example|
+    Path::Backend.mock root: :tmp, &example
+  end
+
+  config.after do
+    Timecop.return
+  end
+end

data/spec/support/describe_method.rb

@@ -0,0 +1,18 @@
+module DescribeMethod
+  def describe_aliases(*args, &block)
+    args.each do |mth|
+      name = (mth == args.first ? "##{mth}" : "##{mth} (alias of #{args.first})")
+
+      describe(name) do
+        let(:described_method) { mth }
+        module_eval &block
+      end
+    end
+  end
+
+  def describe_method(mth, opts = {}, &block)
+    describe_aliases *([mth] + (opts[:aliases] || []).to_ary), &block
+  end
+
+  RSpec.configure{|c| c.extend DescribeMethod }
+end

data/spec/support/with_backend.rb

@@ -0,0 +1,31 @@
+module WithBackend
+
+  def with_backends(*args, &block)
+    args.each do |backend|
+      be = case backend
+      when :mock
+        lambda { |ex| Path::Backend.mock &ex }
+      when :sys
+        lambda { |ex| Path::Backend.mock(root: :tmp, &ex) }
+      else
+        raise ArgumentError.new 'Unknown backend.'
+      end
+
+      describe "with #{backend.upcase} FS" do
+        let(:backend_type) { backend }
+        around do |example|
+          be.call(example)
+        end
+
+        module_eval &block
+      end
+    end
+  end
+  alias_method :with_backend, :with_backends
+
+  def pending_backend(*args)
+    before { pending "Pending on #{backend_type} backend." if args.include? backend_type }
+  end
+
+  RSpec.configure{|c| c.extend WithBackend }
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: rubypath
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan Graichen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-05 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Path library incorporating File, Dir, Pathname, IO methods as well as
+  a virtual mock filesystem.
+email:
+- jg@altimos.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- doc/file.README.html
+- lib/rubypath.rb
+- lib/rubypath/backend.rb
+- lib/rubypath/backend/mock.rb
+- lib/rubypath/backend/sys.rb
+- lib/rubypath/comparison.rb
+- lib/rubypath/construction.rb
+- lib/rubypath/dir_operations.rb
+- lib/rubypath/extensions.rb
+- lib/rubypath/file_operations.rb
+- lib/rubypath/file_predicates.rb
+- lib/rubypath/identity.rb
+- lib/rubypath/io_operations.rb
+- lib/rubypath/mock.rb
+- lib/rubypath/path_operations.rb
+- lib/rubypath/path_predicates.rb
+- lib/rubypath/version.rb
+- rubypath.gemspec
+- spec/rubypath/comparison_spec.rb
+- spec/rubypath/construction_spec.rb
+- spec/rubypath/dir_operations_spec.rb
+- spec/rubypath/extensions_spec.rb
+- spec/rubypath/file_operations_spec.rb
+- spec/rubypath/file_predicates_spec.rb
+- spec/rubypath/identity_spec.rb
+- spec/rubypath/io_operations_spec.rb
+- spec/rubypath/path_operations_spec.rb
+- spec/rubypath/path_predicates_spec.rb
+- spec/spec_helper.rb
+- spec/support/describe_method.rb
+- spec/support/with_backend.rb
+homepage: https://github.com/jgraichen/rubypath
+licenses:
+- LGPLv3
+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: Path library incorporating File, Dir, Pathname, IO methods as well as a virtual
+  mock filesystem.
+test_files:
+- spec/rubypath/comparison_spec.rb
+- spec/rubypath/construction_spec.rb
+- spec/rubypath/dir_operations_spec.rb
+- spec/rubypath/extensions_spec.rb
+- spec/rubypath/file_operations_spec.rb
+- spec/rubypath/file_predicates_spec.rb
+- spec/rubypath/identity_spec.rb
+- spec/rubypath/io_operations_spec.rb
+- spec/rubypath/path_operations_spec.rb
+- spec/rubypath/path_predicates_spec.rb
+- spec/spec_helper.rb
+- spec/support/describe_method.rb
+- spec/support/with_backend.rb
+has_rdoc: