Commit initial repo

Author: havenwood

.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby-version: ['3.2', '3.3', '3.4']
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v5
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run all checks
+        run: bundle exec rake check

.gitignore

@@ -0,0 +1,18 @@
+.bundle/
+vendor/
+Gemfile.lock
+pkg/
+*.gem
+*.bundle
+*.so
+*.dll
+*.dylib
+*.dSYM/
+lib/fdr/fdr_native.bundle
+lib/fdr/fdr_native.so
+ext/fdr_native/target/
+ext/fdr_native/Cargo.lock
+ext/fdr_native/Makefile
+ext/fdr_native/mkmf.log
+ext/fdr_native/tmp/
+ext/fdr_native/.rb-sys/

.rubocop.yml

@@ -0,0 +1,28 @@
+plugins:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.2
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*.rb"
+    - "*.gemspec"
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/ParameterLists:
+  Max: 20
+
+Layout/LineLength:
+  Exclude:
+    - "*.gemspec"
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Style/Alias:
+  EnforcedStyle: prefer_alias

Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'benchmark', '~> 0.4'
+  gem 'benchmark-ips', '~> 2'
+  gem 'minitest', '~> 5'
+  gem 'minitest-proveit', '~> 1'
+
+  gem 'rake', '~> 13', require: false
+  gem 'rubocop', '~> 1.69', require: false
+  gem 'rubocop-minitest', '~> 0.36', require: false
+  gem 'rubocop-rake', '~> 0.6', require: false
+end

LICENSE

@@ -0,0 +1,26 @@
+Fdr is a clone of fd, using the same core libraries and sharing some
+implementation details and code. Both are MIT license.
+
+Copyright (c) Shannon Skipper
+Copyright (c) 2017-present The fd developers
+
+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.

README.md

@@ -0,0 +1,62 @@
+# Fdr
+
+`Fdr` is a fast file search gem for Ruby, implemented with a Rust native extension inspired directly by [fd](https://github.com/sharkdp/fd). `Fdr` uses the same core dependencies as `fd` and `ripgrep`, including [ignore](https://github.com/BurntSushi/ripgrep/tree/master/crates/ignore), [regex](https://github.com/rust-lang/regex), [globset](https://github.com/BurntSushi/ripgrep/tree/master/crates/globset) and [crossbeam-channel](https://github.com/crossbeam-rs/crossbeam).
+
+`Fdr` intentionally lacks an `fdr` executable, since `fd` is perfect for that job. If you need a fast file searching in a CLI tool use, use `fd`. If you need fast file searching from your Ruby code, use `Fdr`.
+
+## Installation
+
+```bash
+gem install fdr
+```
+
+### Requirements
+- Ruby 3.2+
+- Rust
+
+## Usage
+
+```ruby
+require 'fdr'
+
+Fdr.search(extension: 'rb')
+
+Fdr.search(
+  pattern: 'test',
+  paths: %w[lib spec],
+  type: 'f'
+)
+
+Fdr.search(
+  pattern: 'config',
+  paths: %w[app config],
+  extension: 'yml',
+  type: 'f',
+  max_depth: 3,
+  hidden: true
+)
+
+Fdr.search(
+  pattern: '\.test\.js$',
+  paths: %w[src test],
+  exclude: %w[node_modules vendor],
+  case_sensitive: true
+)
+
+Fdr.search(pattern: '**/*.{rb,rake}', glob: true)
+
+Fdr.search(
+  extension: 'log',
+  min_size: 1024 * 1024,
+  changed_within: 86400,
+  paths: %w[logs]
+)
+
+# Aliases for `Fdr.search`, if you prefer:
+Fdr.entries(extension: 'rb')
+Fdr.scan(extension: 'rb')
+```
+
+### Gaps
+
+Some non-CLI features that `fd` implements that are lacking `Fdr` including owner filters, support for nonfile types, smart case switching with patterns and `.fdignore` support.

Rakefile

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'fileutils'
+
+task default: :check
+
+desc 'Compile native extension'
+task :compile do
+  Dir.chdir('ext/fdr_native') do
+    ruby 'extconf.rb'
+    sh 'make'
+
+    FileUtils.mkdir_p '../../lib/fdr'
+    ext = RUBY_PLATFORM.include?('darwin') ? 'bundle' : 'so'
+    FileUtils.cp "fdr_native.#{ext}", "../../lib/fdr/fdr_native.#{ext}"
+  end
+end
+
+desc 'Run Ruby tests'
+task test: :compile do
+  Dir.glob('spec/**/*_spec.rb').each do |file|
+    ruby '-Ilib:spec', file
+  end
+end
+
+desc 'Clean build artifacts'
+task :clean do
+  FileUtils.rm_f Dir['lib/fdr/*.{bundle,so}']
+  Dir.chdir('ext/fdr_native') do
+    sh 'make clean' if File.exist?('Makefile')
+  end
+end
+
+desc 'Deep clean including Cargo artifacts'
+task clobber: :clean do
+  Dir.chdir('ext/fdr_native') do
+    sh 'cargo clean'
+  end
+end
+
+RuboCop::RakeTask.new
+
+namespace :rust do
+  desc 'Run Rust tests'
+  task :test do
+    Dir.chdir('ext/fdr_native') do
+      sh 'cargo test --all-targets --all-features'
+    end
+  end
+
+  desc 'Lint Rust code with clippy'
+  task :lint do
+    Dir.chdir('ext/fdr_native') do
+      sh 'cargo clippy --all-targets --all-features -- -D warnings'
+    end
+  end
+
+  desc 'Check Rust code formatting'
+  task :format do
+    Dir.chdir('ext/fdr_native') do
+      sh 'cargo fmt --all --check'
+    end
+  end
+
+  desc 'Run all Rust checks'
+  task check: %i[format lint test]
+end
+
+desc 'Run all checks (Rust + Ruby)'
+task check: %i[rust:format rust:lint rust:test test rubocop]
+
+desc 'Build gem after compiling extension'
+task build: :compile

ext/fdr_native/Cargo.toml

@@ -0,0 +1,68 @@
+[workspace]
+members = ["core", "ffi"]
+resolver = "2"
+
+[workspace.dependencies]
+fdr-core = { path = "./core" }
+
+[workspace.lints.clippy]
+# Clippy lint groups
+cargo = { level = "deny", priority = -1 }
+correctness = { level = "deny", priority = -1 }
+nursery = { level = "deny", priority = -1 }
+pedantic = { level = "deny", priority = -1 }
+perf = { level = "deny", priority = -1 }
+style = { level = "deny", priority = -1 }
+suspicious = { level = "deny", priority = -1 }
+
+# Clippy nursery group allows
+redundant_pub_crate = "allow"
+missing_const_for_fn = "allow"
+
+# Clippy cargo group allows
+cargo_common_metadata = "allow"
+multiple_crate_versions = "allow"
+
+# Clippy pedantic group allows (common patterns in this codebase)
+missing_errors_doc = "allow"
+missing_panics_doc = "allow"
+must_use_candidate = "allow"
+module_name_repetitions = "allow"
+cast_possible_truncation = "allow"
+cast_sign_loss = "allow"
+cast_precision_loss = "allow"
+
+# Clippy restriction lints (cherry-picked for security & correctness)
+boxed_local = "deny"
+clone_on_copy = "deny"
+cognitive_complexity = "deny"
+panic = "deny"
+print_stdout = "deny"
+print_stderr = "deny"
+unwrap_used = "deny"
+todo = "deny"
+unimplemented = "deny"
+undocumented_unsafe_blocks = "deny"
+multiple_unsafe_ops_per_block = "deny"
+indexing_slicing = "deny"
+allow_attributes_without_reason = "deny"
+
+[workspace.lints.rust]
+# Rust lint groups
+future_incompatible = "deny"
+let_underscore = "deny"
+nonstandard_style = "deny"
+rust_2018_compatibility = "deny"
+rust_2018_idioms = "deny"
+rust_2021_compatibility = "deny"
+rust_2024_compatibility = "deny"
+unused = "deny"
+
+# Rust lints (not covered by groups above)
+single_use_lifetimes = "deny"
+trivial_casts = "deny"
+trivial_numeric_casts = "deny"
+unreachable_pub = "deny"
+
+# Safety: deny unsafe code (works with clippy's undocumented_unsafe_blocks above)
+unsafe_code = "deny"

ext/fdr_native/core/Cargo.toml

@@ -0,0 +1,35 @@
+[package]
+name = "fdr-core"
+version = "0.1.0"
+edition = "2024"
+description = "Core library for fdr - fast directory recursion for Ruby using the ignore crate"
+license = "MIT"
+repository = "https://github.com/havenwood/fdr"
+publish = false
+
+[lints]
+workspace = true
+
+[dependencies]
+# For walking directories in parallel (same as fd uses)
+ignore = "0.4"
+
+# For regex support
+regex = "1.12"
+
+# For glob pattern support
+globset = "0.4"
+
+# For parallel result collection
+crossbeam-channel = "0.5"
+
+# For error handling
+anyhow = "1.0"
+
+# jemalloc for better performance (23% improvement, same as fd uses)
+# Note: Disabled on macOS due to jemalloc bug, see https://github.com/sharkdp/fd/issues/498
+[target.'cfg(all(not(windows), not(target_os = "android"), not(target_os = "macos"), not(target_os = "freebsd"), not(target_os = "openbsd"), not(target_os = "illumos"), not(all(target_env = "musl", target_pointer_width = "32")), not(target_arch = "riscv64")))'.dependencies]
+tikv-jemallocator = "0.6"
+
+[dev-dependencies]
+tempfile = "3.14"