colorls 1.0.9 → 1.1.0

data/lib/colorls/fileinfo.rb

@@ -0,0 +1,69 @@
+module ColorLS
+  class FileInfo
+    @@users  = {}              # rubocop:disable Style/ClassVars
+    @@groups = {}              # rubocop:disable Style/ClassVars
+
+    attr_reader :stats
+    attr_reader :name
+
+    def initialize(path, link_info=true)
+      @name = File.basename(path)
+      @stats = File.lstat(path)
+
+      return unless link_info && @stats.symlink?
+      @dead = !File.exist?(path)
+      @target = File.readlink(path)
+    end
+
+    def self.info(path)
+      FileInfo.new(path)
+    end
+
+    def dead?
+      @dead
+    end
+
+    def owner
+      return @@users[@stats.uid] if @@users.key? @stats.uid
+      @@users[@stats.uid] = Etc.getpwuid(@stats.uid).name
+    rescue ArgumentError
+      @stats.uid.to_s
+    end
+
+    def owned?
+      @stats.owned?
+    end
+
+    def group
+      return @@groups[@stats.gid] if @@groups.key? @stats.gid
+      @@groups[@stats.gid] = Etc.getgrgid(@stats.gid).name
+    rescue ArgumentError
+      @stats.gid.to_s
+    end
+
+    def mtime
+      @stats.mtime
+    end
+
+    def size
+      @stats.size
+    end
+
+    def directory?
+      @stats.directory?
+    end
+
+    def symlink?
+      @stats.symlink?
+    end
+
+    # target of a symlink (only available for symlinks)
+    def link_target
+      @target
+    end
+
+    def to_s
+      name
+    end
+  end
+end

data/lib/colorls/flags.rb

@@ -1,16 +1,19 @@
 require 'optparse'
 require 'colorls/version'
+require 'ostruct'
 
 module ColorLS
   class Flags
     def initialize(*args)
       @args = args
       @light_colors = false
-      @mode = :one_per_line unless STDOUT.tty?
 
       @opts = {
         show: false,
-        sort: false,
+        sort: true,
+        reverse: false,
+        group: nil,
+        mode: STDOUT.tty? || :one_per_line,
         all: false,
         almost_all: false,
         report: false,
@@ -20,12 +23,7 @@ module ColorLS
 
       parse_options
 
-      # handle mutual exclusive options
-      %i[tree long one_per_line].each do |value|
-        @opts[value] = @mode == value
-      end
-
-      return unless @mode == :tree
+      return unless @opts[:mode] == :tree
 
       # FIXME: `--all` and `--tree` do not work together, use `--almost-all` instead
       @opts[:almost_all] = true if @opts[:all]
@@ -36,11 +34,35 @@ module ColorLS
     end
 
     def process
-      return Core.new(@opts).ls if @args.empty?
-      @args.each do |path|
-        next STDERR.puts "\n   Specified path '#{path}' doesn't exist.".colorize(:red) unless File.exist?(path)
-        Core.new(path, @opts).ls
+      # initialize locale from environment
+      CLocale.setlocale(CLocale::LC_COLLATE, '')
+
+      @args = [Dir.pwd] if @args.empty?
+      @args.sort!.each_with_index do |path, i|
+        begin
+          next STDERR.puts "\n   Specified path '#{path}' doesn't exist.".colorize(:red) unless File.exist?(path)
+          puts '' if i > 0
+          puts "\n#{path}:" if Dir.exist?(path) && @args.size > 1
+          Core.new(path, @opts).ls
+        rescue SystemCallError => e
+          STDERR.puts "#{path}: #{e}".colorize(:red)
+        end
+      end
+    end
+
+    def options
+      list = @parser.top.list + @parser.base.list
+
+      result = list.collect do |o|
+        next unless o.respond_to? 'desc'
+
+        flags = o.short + o.long
+        next if flags.empty?
+
+        OpenStruct.new(flags: flags, desc: o.desc)
       end
+
+      result.compact
     end
 
     private
@@ -49,17 +71,33 @@ module ColorLS
       options.separator ''
       options.separator 'sorting options:'
       options.separator ''
-      options.on('--sd', '--sort-dirs', '--group-directories-first', 'sort directories first') { @opts[:sort] = :dirs }
-      options.on('--sf', '--sort-files', 'sort files first')                                   { @opts[:sort] = :files }
+      options.on('--sd', '--sort-dirs', '--group-directories-first', 'sort directories first') { @opts[:group] = :dirs }
+      options.on('--sf', '--sort-files', 'sort files first')                                  { @opts[:group] = :files }
+      options.on('-t', 'sort by modification time, newest first')                             { @opts[:sort] = :time }
+      options.on('-U', 'do not sort; list entries in directory order')                        { @opts[:sort] = false }
+      options.on('-S', 'sort by file size, largest first')                                    { @opts[:sort] = :size }
+      options.on(
+        '--sort=WORD',
+        %w[none time size],
+        'sort by WORD instead of name: none, size (-S), time (-t)'
+      ) do |word|
+        @opts[:sort] = case word
+                       when 'none' then false
+                       when 'time' then :time
+                       when 'size' then :size
+                       end
+      end
+
+      options.on('-r', '--reverse', 'reverse order while sorting') { @opts[:reverse] = true }
     end
 
     def add_common_options(options)
       options.on('-a', '--all', 'do not ignore entries starting with .')  { @opts[:all] = true }
       options.on('-A', '--almost-all', 'do not list . and ..')            { @opts[:almost_all] = true }
-      options.on('-l', '--long', 'use a long listing format')             { @mode = :long }
-      options.on('-t', '--tree', 'shows tree view of the directory')      { @mode = :tree }
-      options.on('-r', '--report', 'show brief report')                   { @opts[:report] = true }
-      options.on('-1', 'list one file per line')                          { @mode = :one_per_line }
+      options.on('-l', '--long', 'use a long listing format')             { @opts[:mode] = :long }
+      options.on('--tree', 'shows tree view of the directory')            { @opts[:mode] = :tree }
+      options.on('--report', 'show brief report')                         { @opts[:report] = true }
+      options.on('-1', 'list one file per line')                          { @opts[:mode] = :one_per_line }
       options.on('-d', '--dirs', 'show only directories')                 { @opts[:show] = :dirs }
       options.on('-f', '--files', 'show only files')                      { @opts[:show] = :files }
       options.on('--gs', '--git-status', 'show git status for each file') { @opts[:git_status] = true }
@@ -100,7 +138,7 @@ EXAMPLES
     end
 
     def parse_options
-      parser = OptionParser.new do |opts|
+      @parser = OptionParser.new do |opts|
         opts.banner = 'Usage:  colorls [OPTION]... [FILE]...'
         opts.separator ''
 
@@ -110,7 +148,7 @@ EXAMPLES
 
         opts.separator ''
         opts.on_tail('-h', '--help', 'prints this help') do
-          puts parser
+          puts @parser
           show_examples
           exit
         end
@@ -120,14 +158,14 @@ EXAMPLES
         end
       end
 
-      parser.parse!(@args)
+      @parser.parse!(@args)
 
       set_color_opts
     end
 
     def set_color_opts
       color_scheme_file = @light_colors ? 'light_colors.yaml' : 'dark_colors.yaml'
-      @opts[:colors] = ColorLS.load_from_yaml(color_scheme_file, true)
+      @opts[:colors] = ColorLS::Yaml.new(color_scheme_file).load(aliase: true)
     end
   end
 end

data/lib/colorls/git.rb

@@ -1,16 +1,15 @@
 module ColorLS
   class Git < Core
     def self.status(repo_path)
-      actual = Dir.pwd
-      Dir.chdir(repo_path)
-
       @git_status = {}
 
-      `git status --short`.split("\n").map { |x| x.split(' ') }.each do |mode, file|
-        @git_status[file] = mode
+      IO.popen(['git', '-C', repo_path, 'status', '--porcelain', '-z', '-uall', '--ignored']) do |output|
+        output.read.split("\x0").map { |x| x.split(' ', 2) }.each do |mode, file|
+          @git_status[file] = mode
+        end
       end
+      warn "git status failed in #{repo_path}" unless $CHILD_STATUS.success?
 
-      Dir.chdir(actual)
       @git_status
     end
 
@@ -28,6 +27,7 @@ module ColorLS
         .gsub('A', 'A'.colorize(colors[:addition]))
         .gsub('M', 'M'.colorize(colors[:modification]))
         .gsub('D', 'D'.colorize(colors[:deletion]))
+        .tr('!', ' ')
     end
   end
 end

data/lib/colorls/version.rb

@@ -1,3 +1,3 @@
 module ColorLS
-  VERSION = '1.0.9'.freeze
+  VERSION = '1.1.0'.freeze
 end

data/lib/colorls/yaml.rb

@@ -0,0 +1,23 @@
+module ColorLS
+  class Yaml
+    def initialize(filename)
+      @filepath = File.join(File.dirname(__FILE__),"../yaml/#{filename}")
+      @user_config_filepath = File.join(Dir.home, ".config/colorls/#{filename}")
+    end
+
+    def load(aliase: false)
+      yaml = read_file(@filepath)
+      if File.exist?(@user_config_filepath)
+        user_config_yaml = read_file(@user_config_filepath)
+        yaml = yaml.merge(user_config_yaml)
+      end
+
+      return yaml unless aliase
+      yaml.to_a.map! { |k, v| [k, v.to_sym] }.to_h
+    end
+
+    def read_file(filepath)
+      ::YAML.safe_load(File.read(filepath)).symbolize_keys
+    end
+  end
+end

data/lib/tab_complete.sh

@@ -1,4 +1,9 @@
-function _colorls_complete() {
-    COMPREPLY=( $( colorls --'*'-completion-bash="$2" ) )
-}
-complete -o default -F _colorls_complete colorls
+
+if [ -z "${ZSH_VERSION+x}" ]; then
+    function _colorls_complete() {
+        COMPREPLY=( $( colorls --'*'-completion-bash="$2" ) )
+    }
+    complete -o default -F _colorls_complete colorls
+else
+    fpath=("${0:A:h:h}/zsh" $fpath)
+fi

data/man/colorls.1

@@ -0,0 +1,135 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "COLORLS" "1" "November 2017" "colorls 1.1.0" "colorls Manual"
+.
+.SH "NAME"
+\fBcolorls\fR \- list directory contents with colors and icons
+.
+.SH "SYNOPSIS"
+\fBcolorls\fR [OPTION]\.\.\. [FILE]\.\.\.
+.
+.br
+.
+.SH "DESCRIPTION"
+List information about the given FILEs\. Uses different colors and icons for known file types\.
+.
+.P
+By default, the output is sorted alphabetically\.
+.
+.P
+Mandatory arguments to long options are mandatory for short options too\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-a\fR, \fB\-\-all\fR
+do not ignore entries starting with \.
+.
+.TP
+\fB\-A\fR, \fB\-\-almost\-all\fR
+do not list \. and \.\.
+.
+.TP
+\fB\-l\fR, \fB\-\-long\fR
+use a long listing format
+.
+.TP
+\fB\-\-tree\fR
+shows tree view of the directory
+.
+.TP
+\fB\-\-report\fR
+show brief report
+.
+.TP
+\fB\-1\fR
+list one file per line
+.
+.TP
+\fB\-d\fR, \fB\-\-dirs\fR
+show only directories
+.
+.TP
+\fB\-f\fR, \fB\-\-files\fR
+show only files
+.
+.TP
+\fB\-\-gs\fR, \fB\-\-git\-status\fR
+show git status for each file
+.
+.TP
+\fB\-\-sd\fR, \fB\-\-sort\-dirs\fR, \fB\-\-group\-directories\-first\fR
+sort directories first
+.
+.TP
+\fB\-\-sf\fR, \fB\-\-sort\-files\fR
+sort files first
+.
+.TP
+\fB\-t\fR
+sort by modification time, newest first
+.
+.TP
+\fB\-U\fR
+do not sort; list entries in directory order
+.
+.TP
+\fB\-S\fR
+sort by file size, largest first
+.
+.TP
+\fB\-\-sort\fR
+sort by WORD instead of name: none, size (\-S), time (\-t)
+.
+.TP
+\fB\-r\fR, \fB\-\-reverse\fR
+reverse order while sorting
+.
+.TP
+\fB\-\-light\fR
+use light color scheme
+.
+.TP
+\fB\-\-dark\fR
+use dark color scheme
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+prints this help
+.
+.TP
+\fB\-\-version\fR
+show version
+.
+.SH "EXAMPLES"
+.
+.TP
+show the given file:
+.
+.IP
+\fBcolorls README\.md\fR
+.
+.TP
+show matching files and list matching directories:
+.
+.IP
+\fBcolorls *\fR
+.
+.TP
+filter output by a regular expression:
+.
+.IP
+\fBcolorls | grep PATTERN\fR
+.
+.TP
+several short options can be combined:
+.
+.IP
+\fBcolorls \-d \-l \-a\fR
+.
+.br
+\fBcolorls \-dla\fR
+.
+.SH "AUTHOR"
+Written by Athitya Kumar\.

data/man/colorls.1.ronn

@@ -0,0 +1,41 @@
+colorls(1) -- list directory contents with colors and icons 
+===========================================================
+
+## SYNOPSIS
+
+`colorls` [OPTION]... [FILE]...<br>
+
+## DESCRIPTION
+
+List information about the given FILEs. Uses different colors and icons for known file types.
+
+By default, the output is sorted alphabetically.
+
+Mandatory arguments to long options are mandatory for short options too.
+
+## OPTIONS
+
+{{ OPTIONS }}
+
+## EXAMPLES
+
+  * show the given file:
+
+    `colorls README.md`
+
+  * show matching files and list matching directories:
+
+    `colorls *`
+
+  * filter output by a regular expression:
+
+    `colorls | grep PATTERN`
+
+  * several short options can be combined:
+
+    `colorls -d -l -a`<br>
+    `colorls -dla`
+
+## AUTHOR
+
+Written by Athitya Kumar.