windirs 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ede397df9f93b22c6abf35efad482d3e8de646b
+  data.tar.gz: 548078b8a4861930c60b3706dbd620ca19b8a3ae
+SHA512:
+  metadata.gz: 0505406cf265dcec147cf39f1fced36ada1521faf799f507d091c197592476aafa67f6c6ddfd83c2d96a5ce35c71e271cb05e404a5e7566740884dc8a2db5263
+  data.tar.gz: 258965dfa43e982f8411bbe927033e1444c02e22c2d5651029f40819c09c8cc1ecc69e7b4d45381b16d94b488192200b1b055665e8dc7e036b3628619267de21

data/README.md

@@ -0,0 +1,35 @@
+windirs
+---------
+A ruby gem to convert between Unix, Windows, and Cygwin paths.
+
+Installation
+---------
+`gem install windirs`
+
+or, if you want the latest and the greatest, 
+
+    git clone https://github.com/windirs
+    cd windirs
+    rake install
+
+(use `sudo` as necessary)
+
+Runtime Requirements
+---------
+ruby 
+
+Build Requirements
+---------
+rake
+
+Inspiration and History
+---------
+
+
+License
+---------
+© 2014 Noah Birnel
+MIT license
+
+[![Build Status](https://travis-ci.org/nbirnel/windirs.png?branch=master)](https://travis-ci.org/nbirnel/windirs)
+[![Code Climate](https://codeclimate.com/github/nbirnel/windirs.png)](https://codeclimate.com/github/nbirnel/windirs)

data/lib/windirs.rb

@@ -0,0 +1,126 @@
+##
+# Classes for representing directory paths in various formats. 
+
+module Windirs
+
+  ##
+  # Represents a directory path, either absolute or relative.
+  #
+  # This Class is meant to be used when you are uncertain where your 
+  # program will be running.
+  #
+  # For instance, 
+  # if you want to make windows shortcuts with win32-shortcut
+  # http://rubygems.org/gems/win32-shortcut
+  # you will need a windows style path. 
+  # But if you don't know the location until run-time,
+  # and you are uncertain if you are running in Cygwin or native Ruby,
+  # you could use:
+  #     s.path = Windirs::Path.new(Dir.pwd).windows
+  #
+  # BUGS
+  # ----------------
+  # Does not dereference Cygwin mount points to Windows drives.
+  # This is arguably not a bug,
+  # but a feature not yet implemented.
+  #
+  # Ditto for dereferencing Windows network mounts to UNC paths.
+  #
+
+
+  class Path
+
+    ##
+    # Create a new Path from +path+.
+    #
+    #     > winpath = Windirs::Path.new 'C:\Users\noah\Desktop'
+    #     > nixpath = Windirs::Path.new '/bin/ls'
+    #     > cygpath = Windirs::Path.new '/cygdrive/c/Users/noah/Desktop'
+    #
+    # You probably don't need to know the rest of this:
+    # +cygdrive_prefix+ defaults to '/cygdrive/',
+    # and is used to extract drive letters from Cygwin-ish looking paths.
+    # If you know will not be using Cygwin paths, 
+    # you may wish to assign this to ''.
+    # If your cygdrive path prefix is something else, 
+    # you should assign this appropriately.
+    # See 
+    # http://cygwin.com/cygwin-ug-net/using.html#cygdrive
+    # for details.
+    # Note that we are using a trailing slash,
+    # unlike the Cygwin documentation.
+    #
+
+    def initialize path, cygdrive_prefix = '/cygdrive/'
+      dirs     = '(?<dirs>.*)$'
+      windrive = '((?<drive>[A-Z]):)'
+      cygdrive = "(#{cygdrive_prefix}(?<drive>[a-z]))"
+      drive    = "(#{windrive}|#{cygdrive})?"
+      path_re  = Regexp.new('^' + drive + dirs)
+
+      if path_re =~ path
+        m = Regexp.last_match
+        @drive = m[:drive]
+        @dirs  = m[:dirs]
+      end
+    end
+
+    ##
+    # Return a Cygwin style path String. 
+    # See Windirs.Path.initialize documentation 
+    # for more info on +cygdrive_prefix+.
+    #
+    #    > winpath.cygwin
+    #    => "/cygdrive/c/Users/noah/Desktop"
+
+    def cygwin  cygdrive_prefix = '/cygdrive/'
+      fpath('/', cygdrive_prefix){|drive| "#{@drive.downcase}"}
+    end
+
+    ##
+    # Return a *nix (Linux, Mac OS X, *BSD) style path String.
+    # +prefix+ will be used if a drive was detected in Path,
+    # but this is unlikely to be useful. 
+    # You may want to assign it for certain Samba situations,
+    # but I have little opinion or knowledge on that.
+    #
+    #    > winpath.nix
+    #    => "/c/Users/noah/Desktop"
+
+    def nix     prefix = '/'
+      fpath('/', prefix){|drive| "#{@drive.downcase}"}
+    end
+
+    ##
+    # Return a Ruby on Windows style path String.
+    #
+    #    > winpath.rubywin
+    #    => "C:/Users/noah/Desktop"
+
+    def rubywin 
+      fpath('/'){        |drive| "#{@drive.upcase}:"}
+    end
+
+    ##
+    # Return a Windows style path String.
+    #
+    #    > cygpath.windows
+    #    => "C:\\Users\\noah\\Desktop"
+    #    > puts cygpath.windows
+    #    "C:\Users\noah\Desktop"
+    #    => nil
+
+    def windows
+      fpath('\\'){       |drive| "#{@drive.upcase}:"}
+    end
+
+    private
+
+    def fpath del='/', prefix=''
+      drive = @drive ? "#{prefix}#{yield(@drive)}" : nil
+      "#{drive}#{@dirs}".gsub(/[\/\\\\]/, del)
+    end
+
+  end
+
+end

data/spec/windirs_spec.rb

@@ -0,0 +1,66 @@
+require  "#{File.dirname(__FILE__)}/../lib/windirs"
+
+describe Windirs do
+
+  before do
+    @relatives = {
+      :windows => '.\\somedir\\file',
+      :cygwin  => './somedir/file',
+      :rubywin => './somedir/file',
+      :nix     => './somedir/file',
+    }
+    @rpaths = Hash.new
+    @relatives.map{|k, v| @rpaths[k] = Windirs::Path.new(v)}
+
+    @drives = {
+      :cygwin  => '/cygdrive/c/Users/joe/Desktop',
+      :windows => 'C:\Users\joe\Desktop',
+      :rubywin => 'C:/Users/joe/Desktop',
+    }
+    @dpaths = Hash.new
+    @drives.map{|k, v| @dpaths[k] = Windirs::Path.new(v)}
+
+    @uncs = {
+      :windows => '\\\\windomain\\somedir\\file',
+      :cygwin  => '//windomain/somedir/file',
+      :rubywin => '//windomain/somedir/file',
+      :nix     => '//windomain/somedir/file',
+    }
+    @upaths = Hash.new
+    @uncs.map{|k, v| @upaths[k] = Windirs::Path.new(v)}
+
+  end
+
+  describe Windirs::Path do
+
+    it 'converts any drive to any drive' do 
+      @drives.keys.repeated_permutation(2).each do |from, to|
+        puts "converts from #{from} to #{to}"
+        @dpaths[from].method(to).call.should eq @drives[to]
+      end
+    end
+
+    it 'fakes a drive letter to *nix' do
+      @drives.keys.each do |from|
+        puts "fake drive letter from #{from} to *nix"
+        @dpaths[from].nix.should eq '/c/Users/joe/Desktop'
+      end
+    end
+
+    it 'converts any unc to any unc' do 
+      @uncs.keys.repeated_permutation(2).each do |from, to|
+        puts "converts from #{from} to #{to}"
+        @upaths[from].method(to).call.should eq @uncs[to]
+      end
+    end
+
+    it 'converts relative paths' do
+      @relatives.keys.repeated_permutation(2).each do |from, to|
+        puts "converts from #{from} to #{to}"
+        @rpaths[from].method(to).call.should eq @relatives[to]
+      end
+    end
+
+  end
+
+end

data/windirs.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name        = 'windirs'
+  s.version     = '0.0.0'
+  s.date        = '2014-03-21'
+  s.summary     = "translate between Cygwin, Windows, and Unix file paths"
+  s.description = "#{s.summary}"
+  s.authors     = ['Noah Birnel']
+  s.email       = 'nbirnel@gmail.com'
+  s.homepage    = 'http://github.com/nbirnel/windirs'
+  s.files       = ['README.md', 'windirs.gemspec', 'lib/windirs.rb', 'spec/windirs_spec.rb']
+  s.has_rdoc    = true
+  s.license     = 'MIT'
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: windirs
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Noah Birnel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-21 00:00:00.000000000 Z
+dependencies: []
+description: translate between Cygwin, Windows, and Unix file paths
+email: nbirnel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- windirs.gemspec
+- lib/windirs.rb
+- spec/windirs_spec.rb
+homepage: http://github.com/nbirnel/windirs
+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.7
+signing_key: 
+specification_version: 4
+summary: translate between Cygwin, Windows, and Unix file paths
+test_files: []