lsd-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: db20983b3ee9507cf1db9a2c19d0bbfb639b556d42d006f1617f45072bac6d1b
+  data.tar.gz: 4c64aa7c2d32343d0893229f8d9f5db6cfb455c199da820636d1aef92cd88728
+SHA512:
+  metadata.gz: 3c6f4d86f2e406afc083bfea5c34898e76f6e633cc619ad888f7a323cdaf652dadae4938bdb7d295e4ecf683f65fcd41ebf87699721d8a0a911932afdca43996
+  data.tar.gz: 2801208c3964bc84feed96b04402c14158206a9866e10e0e17868df7e22af6e36ad96a36be516407f681d4af8b53ee1eff3a48e3cb2277a57876e08dffecc5c7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Aristóteles
+
+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 @@
+# LSD
+
+A modern alternative to the `ls` command inspired by Nushell's output, written in Ruby.
+
+<p align="center">
+  <img src="./lsd.png" alt="LSD" width="600">
+</p>
+
+## Features
+
+- Tabular output with colors
+- Column filtering via command line
+- High performance through lazy loading
+- Mac and Linux support
+
+## Installation
+
+1. Install gem (recommended)
+
+```bash
+gem install lsd
+```
+
+2. Use the installation script
+
+```bash
+git clone https://github.com/your-username/lsd
+cd lsd
+./install.sh
+```
+
+3. Manual installation
+
+The installation script will:
+
+1. Check if Ruby is installed (>= 3.0)
+2. Install necessary dependencies
+   ```bash
+   $ bundle install
+   ```
+3. Compile the program if needed
+   ```bash
+   $ chmod +x bin/lsd
+   ```
+4. Move the binary to `/usr/local/bin`
+
+## Usage
+
+```bash
+# List current directory
+lsd
+
+# List a specific directory
+lsd ~/Downloads
+
+# Filter by name and type only
+lsd --filter-by "name,type"
+
+# Show help
+lsd --help
+```
+
+## Available Columns
+
+- name: File/directory name
+- size: Size in human format (KB, MB, etc)
+- type: File type (file, directory, symlink)
+- perms: Unix permissions format
+- owner: Owner
+- modified: Modification date
+
+The index column (#) is always shown.
+
+## Project Structure
+
+```
+.
+├── bin/
+│   └── lsd         # Main executable
+├── lib/
+│   ├── lsd.rb      # Main code
+│   ├── entry.rb    # Directory entry class
+│   └── formatter.rb # Table formatting
+├── install.sh      # Installation script
+└── README.md       # This documentation
+```
+
+## Contributing
+
+1. Fork the project
+2. Create your feature branch (`git checkout -b feature/new-feature`)
+3. Commit your changes (`git commit -am 'Add new feature'`)
+4. Push to the branch (`git push origin feature/new-feature`)
+5. Create a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/lsd. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/lsd/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Lsd project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/lsd/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "lsd"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/lsd

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "lsd"
+require "optparse"
+
+options = {columns: Lsd::TableFormatter::DEFAULT_COLUMNS}
+
+parser =
+  OptionParser.new do |opts|
+    opts.banner = "Usage: lsd [options] [directory]"
+
+    opts.on("--filter-by COLUMNS", Array, "Show only specific columns") do |columns|
+      options[:columns] = columns.map(&:strip)
+    end
+
+    opts.on("-h", "--help", "Show this help message") do
+      puts opts
+      available_columns = Lsd::TableFormatter::AVAILABLE_COLUMNS.keys - Lsd::TableFormatter::REQUIRED_COLUMNS
+      puts "\nAvailable columns for filtering: #{available_columns.join(", ")}"
+      puts "Note: The index (#) column is always shown"
+      puts "\nExamples:"
+      puts "  lsd --filter-by name,size"
+      puts "  lsd --filter-by 'name, size'"
+      exit
+    end
+  end
+
+parser.parse!
+
+begin
+  path = ARGV[0] || "."
+  entries = Dir.children(path)
+    .reject { |e| e.start_with?(".") }
+    .sort
+    .map { |name| Lsd::Entry.new(File.join(path, name)) }
+
+  puts Lsd::TableFormatter.format(entries, options[:columns])
+rescue Errno::ENOENT
+  puts "Error: Directory '#{path}' not found".red
+  exit 1
+rescue Interrupt
+  puts "\nOperation cancelled".yellow
+  exit 0
+rescue => e
+  puts "Error: #{e.message}".red
+  exit 1
+end

data/lib/lsd/directory_lister.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "terminal-table"
+require "colorize"
+
+require_relative "entry"
+require_relative "table_formatter"
+
+module Lsd
+  module DirectoryLister
+    class Error < StandardError; end
+
+    def self.list(path = ".")
+      entries = Dir.entries(path)
+        .reject { |e| e.start_with?(".") }
+        .sort_by { |name| [File.directory?(name) ? 0 : 1, name.downcase] }
+        .map { |name| Entry.new(name) }
+
+      puts TableFormatter.format(entries)
+    rescue Errno::EACCES => e
+      raise Error, "Permission denied: #{path}"
+    end
+  end
+end

data/lib/lsd/entry.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Lsd
+  class Entry
+    attr_reader :stat
+
+    def initialize(name)
+      @full_path = name
+      @stat = File.stat(name)
+    end
+
+    def name
+      @name ||= File.basename(@full_path)
+    end
+
+    def type
+      @type ||= directory? ? "dir".light_blue : "file".light_black
+    end
+
+    def size
+      @size ||= format_size(raw_size)
+    end
+
+    def raw_size
+      @raw_size ||= calculate_size
+    end
+
+    def modified
+      @modified ||= format_time_ago(stat.mtime)
+    end
+
+    private
+
+    def directory?
+      @is_directory ||= File.directory?(@full_path)
+    end
+
+    def calculate_size
+      if directory?
+        dir_size = 0
+        begin
+          Dir.glob("#{@full_path}/**/*", File::FNM_DOTMATCH).each do |f|
+            next if File.directory?(f)
+            next if f.end_with?("/.", "/..")
+
+            dir_size += File.size(f)
+          rescue Errno::ENOENT, Errno::EACCES
+            next
+          end
+        rescue Errno::EACCES
+          return 0
+        end
+        dir_size
+      else
+        stat.size
+      end
+    end
+
+    def format_size(bytes)
+      return "0 B" if bytes == 0
+
+      {
+        1024**3 => "GiB",
+        1024**2 => "MiB",
+        1024 => "KiB"
+      }.each do |threshold, unit|
+        if bytes >= threshold
+          value = bytes.to_f / threshold
+          return (value < 10) ? format("%.1f %s", value, unit) : format("%d %s", value.round, unit)
+        end
+      end
+      "#{bytes} B"
+    end
+
+    TIME_INTERVALS = {
+      86_400 => ->(diff) { "#{(diff / 86_400).round} days ago" },
+      3600 => ->(diff) { "#{(diff / 3600).round} hours ago" },
+      60 => ->(diff) { "#{(diff / 60).round} minutes ago" },
+      0 => ->(diff) { "#{diff.round} seconds ago" }
+    }.freeze
+
+    def format_time_ago(time)
+      diff = Time.now - time
+      TIME_INTERVALS.each do |threshold, formatter|
+        return formatter.call(diff) if diff >= threshold
+      end
+    end
+  end
+end

data/lib/lsd/table_formatter.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Lsd
+  class TableFormatter
+    MAX_NAME_LENGTH = 30
+    AVAILABLE_COLUMNS = {
+      "index" => {header: "#", value: ->(entry, idx) { idx.to_s.light_green }},
+      "name" => {header: "name", value: ->(entry, _) { entry.name.light_cyan }},
+      "type" => {header: "type", value: ->(entry, _) { entry.type }},
+      "size" => {header: "size", value: ->(entry, _) { entry.size.light_green }},
+      "modified" => {header: "modified", value: ->(entry, _) { entry.modified.light_magenta }}
+    }.freeze
+
+    DEFAULT_COLUMNS = %w[index name type size modified]
+    REQUIRED_COLUMNS = %w[index]
+
+    def self.format(entries, columns = DEFAULT_COLUMNS)
+      new(entries, columns).format
+    end
+
+    def initialize(entries, columns = DEFAULT_COLUMNS)
+      @entries = entries
+      @columns = process_columns(columns)
+    end
+
+    def format
+      table = Terminal::Table.new(headings: headers, rows: formatted_rows, style: {border: :unicode})
+
+      table.to_s.gsub(/[┌┐└┘]/, {"┌" => "╭", "┐" => "╮", "└" => "╰", "┘" => "╯"})
+    end
+
+    private
+
+    def process_columns(columns)
+      filtered_columns = columns.reject { |col| REQUIRED_COLUMNS.include?(col) }
+
+      valid_columns =
+        filtered_columns.select do |col|
+          if AVAILABLE_COLUMNS.key?(col)
+            true
+          else
+            warn "Warning: Unknown column '#{col}'. Available columns: #{(AVAILABLE_COLUMNS.keys - REQUIRED_COLUMNS).join(", ")}".yellow
+            false
+          end
+        end
+
+      REQUIRED_COLUMNS + valid_columns
+    end
+
+    def headers
+      @columns.map { |col| AVAILABLE_COLUMNS[col][:header].light_green }
+    end
+
+    def formatted_rows
+      @entries.map.with_index do |entry, index|
+        @columns.map { |col| AVAILABLE_COLUMNS[col][:value].call(entry, index) }
+      end
+    end
+  end
+end

data/lib/lsd/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Lsd
+  VERSION = "0.1.0"
+end

data/lib/lsd.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "lsd/version"
+require_relative "lsd/directory_lister"
+require_relative "lsd/entry"
+require_relative "lsd/table_formatter"
+
+module Lsd
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: lsd-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aristóteles Coutinho
+bindir: exe
+cert_chain: []
+date: 2025-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: optparse
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  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: List directory contents with a modern, colorful interface
+email:
+- contato@aristoteles.dev
+executables:
+- lsd
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- exe/lsd
+- lib/lsd.rb
+- lib/lsd/directory_lister.rb
+- lib/lsd/entry.rb
+- lib/lsd/table_formatter.rb
+- lib/lsd/version.rb
+homepage: https://github.com/aristotelesbr/lsd
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/aristotelesbr/lsd
+  source_code_uri: https://github.com/aristotelesbr/lsd
+  changelog_uri: https://github.com/aristotelesbr/lsd/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A modern replacement for ls command
+test_files: []