dirfy 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8e6bf9d28ac3108a8de6bc541c8c0e2b63fdd101bcf973bcbad6369d87b6dc5
-  data.tar.gz: 0e925d19a257eeb53d9ab97f826056cd0c063bd7ec44ef44242aea30dec3b24f
+  metadata.gz: eff3a8ed004db0f78ce8f4e0660648cf18f4983bb064a1e41e0d74fd3db8fdcb
+  data.tar.gz: a378b3fdfbdd8c34170920a769307938fe4495bc9222996140e39d5a68fddc6b
 SHA512:
-  metadata.gz: 7d51b837da07c76434ff5d81ecc91e497cbd1360bcc3de28eff299c95489d43d8a6d1fd95331f4b7d892ddb5e3ba861b2c553373d38c08a9ee174fccdbb4bff7
-  data.tar.gz: e6d08d7060cd432e3dd73b3b1c1a6a649406820c66b2149f50ac97d5c7bfe9e524e4e9f9aa256b95f7ff5ed034d9f9a1ac683510f4b3adc41bd3de3d57233200
+  metadata.gz: 24b201dbd606f722eab03643b190b5edc1cbf97960f5ee1dd1b476a4502a0a11934f381a7d0f80857ec1ece4e5f7d247bb4c7f0d2ad50d96bbe56190fe0b04f3
+  data.tar.gz: d34793f417f3310bbe515f1b0c3fe03c137f2c6263ea6cc017dec09fb1949e8c624699ad9d7658561b3c49c656b398d2ee47d274a685f058bb4e8b087c79540b

data/README.md

@@ -6,7 +6,18 @@
 [![Ruby ≥2.7](https://img.shields.io/badge/ruby-%3E%3D2.7-blue.svg)](https://www.ruby-lang.org/)  
 [![Issues](https://img.shields.io/github/issues/ahmedmelhady7/dirfy.svg)](https://github.com/ahmedmelhady7/dirfy/issues)  
 
-> **Instantly scaffold directory & file structures from any ASCII/Unicode “tree” diagram** 🚀
+> **Instantly scaffold directory & file structures from any ASCII/Unicode "tree" diagram** 🚀
+
+## 📚 Table of Contents
+
+- [📋 Problem Statement](#-problem-statement)
+- [✨ Features](#-features)
+- [🚀 Installation](#-installation)
+- [💡 Usage](#-usage)
+- [🛠️ Examples](#️-examples)
+- [🤝 Contributing](#-contributing)
+- [🚀 Release Process](#-release-process)
+- [📝 License](#-license)
 
 ---
 
@@ -108,6 +119,19 @@ DRY-RUN File:  my_app/README.md
 
 Remove `-d` to actually scaffold.
 
+### 📁 Sample Files
+
+To test Dirfy quickly without creating your own tree files, check out the [examples/](./examples/) directory. It contains several sample tree files you can use:
+
+- `examples/simple.tree` — A basic Ruby project structure
+- `examples/web_project.tree` — A front-end web project layout
+- `examples/complex.tree` — Deeply nested directories with mixed file types
+- `examples/unicode.tree` — Non-ASCII filenames and Unicode handling tests
+
+```bash
+dirfy -d examples/web_project.tree
+```
+
 ---
 
 ## 🤝 Contributing
@@ -129,10 +153,94 @@ Happy scaffolding! 🚀
 
 ---
 
+## 🚀 Release Process
+
+This project uses a **semi-automated release process** that balances automation with security. GitHub Actions handles building and testing, while gem publishing is done manually to support 2FA authentication.
+
+### Prerequisites
+
+- Push access to the repository
+- RubyGems account with push access to the `dirfy` gem
+- 2FA enabled on RubyGems account (recommended for security)
+
+### Semi-Automated Release Process
+
+**What's automated:**
+- ✅ Gem building when you push tags
+- ✅ Running tests before release
+- ✅ GitHub release creation (optional)
+
+**What requires manual action:**
+- 🔐 Gem publishing to RubyGems (due to 2FA requirements)
+
+### Release Steps
+
+1. **Update version and run tests**
+   ```bash
+   # Edit lib/dirfy/version.rb to bump version
+   vim lib/dirfy/version.rb
+   bundle install  # updates Gemfile.lock
+   bundle exec rake  # run tests
+   ```
+
+2. **Commit and tag**
+   ```bash
+   git add lib/dirfy/version.rb Gemfile.lock
+   git commit -m "chore: bump version to vX.Y.Z"
+   git tag vX.Y.Z
+   git push origin main --follow-tags
+   ```
+
+3. **Manual gem publishing (with 2FA)**
+   ```bash
+   rake build
+   gem push pkg/dirfy-X.Y.Z.gem
+   # Complete 2FA authentication in browser
+   ```
+
+4. **Optional: Create GitHub release**
+   ```bash
+   gh release create vX.Y.Z pkg/dirfy-X.Y.Z.gem \
+     --title "vX.Y.Z" \
+     --notes "Release notes here"
+   ```
+
+### Using the Release Helper Script
+
+For even easier releases, use the provided script:
+
+```bash
+./scripts/release.sh X.Y.Z
+```
+
+This script will:
+- Update the version in `lib/dirfy/version.rb`
+- Run tests to ensure everything works
+- Build the gem locally
+- Commit changes and create/push the tag
+- Prompt you to manually publish with `gem push` (for 2FA)
+
+### Why Semi-Automated?
+
+- **Security**: Maintains 2FA protection on your RubyGems account
+- **Reliability**: Manual gem push ensures you can handle 2FA interactively
+- **Automation**: CI still handles building, testing, and GitHub releases
+- **Simplicity**: No need to manage CI-specific RubyGems accounts or tokens
+
+### Troubleshooting
+
+- **2FA Authentication**: Follow the WebAuthn flow in your browser or use `--otp` flag
+- **Build failures**: CI will automatically build when you push tags - check Actions tab for issues
+- **Permission denied**: Ensure you have push access to both the repository and RubyGems gem
+
+---
+
 ## 📝 License
 
 MIT © [Ahmed Elhady](https://github.com/ahmedmelhady7)
 
 ---
 
-> Built with ❤️ to make AI-generated project scaffolding a breeze.
+> Built with ❤️ to make AI-generated project scaffolding a breeze.
+
+

data/lib/dirfy/cli.rb

@@ -12,7 +12,8 @@ module Dirfy
         dry_run: false,
         verbose: false,
         indent: 4,
-        prefix: ""
+        prefix: "",
+        validate: false
       }
 
       parser = OptionParser.new do |opts|
@@ -26,6 +27,10 @@ module Dirfy
           options[:verbose] = true
         end
 
+        opts.on("--validate", "Check tree syntax without creating files") do
+          options[:validate] = true
+        end
+
         opts.on("-iN", "--indent=N", Integer, "Spaces per level (default 4)") do |n|
           options[:indent] = n
         end
@@ -60,6 +65,12 @@ module Dirfy
       items = Parser.new(indent: options[:indent]).parse(lines)
       items.map! { |p| options[:prefix] + p }
 
+      # Validation mode: just check syntax and exit
+      if options[:validate]
+        puts "✅ Tree syntax is valid (#{items.size} items detected)"
+        exit(0)
+      end
+
       puts "🔍 Detected #{items.size} items to create."
       unless options[:dry_run]
         print "Proceed? (y/N) "

data/lib/dirfy/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Dirfy
-  VERSION = "0.3.0"
-end
+  VERSION = "0.3.2"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dirfy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Your Name