dirfy 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2280485e374e77646217758bb7ff581745d1027c716de33bbf180532c37099d5
-  data.tar.gz: 9ce1d4d53bb3bc4f1c6d4b39bbf0d9dca6a73f0c50ecd2a28a089af2301076fd
+  metadata.gz: eff3a8ed004db0f78ce8f4e0660648cf18f4983bb064a1e41e0d74fd3db8fdcb
+  data.tar.gz: a378b3fdfbdd8c34170920a769307938fe4495bc9222996140e39d5a68fddc6b
 SHA512:
-  metadata.gz: 57c73e9a491dd9ad6ca56cceb0e7d16bdcfc65524b93e331f4008eebea5d77a5d27e9775553cf354adeaa809e75c1a174133a5a4542ccc18a15a139b8af53af5
-  data.tar.gz: ef290b90b405d6151738c97bede4e2778c437394865ed42830849e3fb0d5b4ebbff7f287bcbeaf7ce198b0b05a95c9ec03e94a0b3dcac015a792d5629530c8c4
+  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,76 +153,89 @@ Happy scaffolding! 🚀
 
 ---
 
-## � Release Process
+## 🚀 Release Process
 
-This section documents the release process for maintainers.
+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
+- 2FA enabled on RubyGems account (recommended for security)
 
-### Release Steps
+### Semi-Automated Release Process
 
-1. **Run tests and ensure clean state**
-   ```bash
-   bundle exec rake
-   git status  # should be clean
-   ```
+**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)
 
-2. **Update version**
+### Release Steps
+
+1. **Update version and run tests**
    ```bash
-   # Edit lib/dirfy/version.rb
+   # Edit lib/dirfy/version.rb to bump version
    vim lib/dirfy/version.rb
+   bundle install  # updates Gemfile.lock
+   bundle exec rake  # run tests
    ```
 
-3. **Commit version bump**
+2. **Commit and tag**
    ```bash
    git add lib/dirfy/version.rb Gemfile.lock
    git commit -m "chore: bump version to vX.Y.Z"
-   ```
-
-4. **Create and push tag**
-   ```bash
    git tag vX.Y.Z
-   git push origin main
-   git push origin vX.Y.Z
+   git push origin main --follow-tags
    ```
 
-5. **Build and publish gem**
+3. **Manual gem publishing (with 2FA)**
    ```bash
    rake build
    gem push pkg/dirfy-X.Y.Z.gem
-   # Follow 2FA authentication flow
+   # Complete 2FA authentication in browser
    ```
 
-6. **Create GitHub release**
+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"
    ```
 
-### Automated Release (Helper Script)
+### Using the Release Helper Script
 
-Use the provided release script for semi-automated releases:
+For even easier releases, use the provided script:
 
 ```bash
-./scripts/release.sh patch  # for patch version (0.0.X)
-./scripts/release.sh minor  # for minor version (0.X.0)  
-./scripts/release.sh major  # for major version (X.0.0)
+./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**: RubyGems requires 2FA. Use WebAuthn or `--otp` flag
-- **Workflow scope**: GitHub token needs `workflow` scope to modify Actions
-- **Permission denied**: Ensure you have push access to both repo and RubyGems
+- **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
+## 📝 License
 
 MIT © [Ahmed Elhady](https://github.com/ahmedmelhady7)
 
@@ -206,45 +243,4 @@ MIT © [Ahmed Elhady](https://github.com/ahmedmelhady7)
 
 > Built with ❤️ to make AI-generated project scaffolding a breeze.
 
----
-
-## Release steps
-
-This project supports both local and GitHub Actions-based releases. The workflow `/.github/workflows/release.yml` will publish a built gem when a `vX.Y.Z` tag is pushed, but the runner needs a valid `RUBYGEMS_API_KEY` secret and the repository maintainer must ensure the CI token can run workflow jobs that modify releases.
-
-Local release (recommended when you need to provide 2FA interactively):
-
-1. Bump the version in `lib/dirfy/version.rb` (e.g. `0.3.0`).
-2. Build the gem locally:
-
-```bash
-bundle install
-bundle exec rake build
-```
-
-3. Create a git tag and push it (this will trigger CI if configured):
-
-```bash
-git add -A
-git commit -m "Release vX.Y.Z"
-git tag vX.Y.Z
-git push origin main --follow-tags
-```
-
-4. Publish the gem to RubyGems interactively (you may need to complete 2FA):
-
-```bash
-gem push pkg/dirfy-X.Y.Z.gem
-```
-
-CI-based release (recommended for automated releases):
-
-1. Ensure the repository has the secret `RUBYGEMS_API_KEY` configured in GitHub Settings → Secrets.
-2. Ensure the repository's token has appropriate permissions to run workflow jobs that create or update releases (the token needs `workflow` scope to update workflows).
-3. Push a tag `vX.Y.Z` to the repo. The `release.yml` workflow will build and push the gem.
-
-Notes and troubleshooting
 
-- If you see an error like `Invalid credentials (401)` during `gem push` in CI, double-check that `RUBYGEMS_API_KEY` is correctly set and that the CI runner writes it to `~/.gem/credentials` before pushing.
-- If GitHub rejects pushes that modify workflow files, ensure the token used has `workflow` scope or make the workflow change via the GitHub web UI.
-- For local gem publishing, if 2FA is enabled you will be prompted to authenticate in your browser or provide an OTP.

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.1"
-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.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Your Name