ficha 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 496e19f7e52e61e225538dea7b4c30c8381d8687b226355ba5912847c08b7a12
-  data.tar.gz: af98dadc7f8a44cb987cda56a07f07d28fa9082d486dd3092eead7715112cbc3
+  metadata.gz: e0ab263b57722fe59e5b216c33254355114fed0ade17c25b3b8864d5bbc75ea0
+  data.tar.gz: 829c0cf34924b04facbcb3c7b72bb352d321f5444ecb5b995adb121189186e33
 SHA512:
-  metadata.gz: 959e3c3e460f16cc0f507c23c23ab5817320e3524066bb7fb87d9ba1113bc26ba4c0bfb484f43e6cfaae4794eb32167096b1e4c991a94ad10cb67d2f24d915a0
-  data.tar.gz: e717d46c80e33f9990c7fad060764a05adaed236e3996d294dcde16dbba1c3f7ef71c35269920ffa5342ffa15cbeb88eafc076a75c5e93c0951c36b9b7bdb083
+  metadata.gz: dabc9d504f43b6b8e7e1ff95764640dec5b3963dd44b78538a9599bb59f5f035731c65fac1bdffee0d8b62523e15a87ecaf8c7bd5e7d6956b4799570ff5cae60
+  data.tar.gz: d2fe651ad51b0e2d1db39318894836ca4a0d6a91f8df2c09e7827dfaac6757a9ca1d386867fd9a9dd740ebe0989f209a9ef335199c8ba9fe59a85b2488dab4f0

data/CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to `ficha` will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),  
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# 0.3.0 - 2025-12-11
+
+### Added: Non-dry-run mode: print file contents by default
+
 ## [0.2.0] - 2025-12-09
 
 ### Added

data/README.md

@@ -3,8 +3,10 @@
 > **Feature-aware file dumper for Ruby projects**  
 > Extract only the files you need — by model, endpoint, feature, or safe subset — without manual grepping.
 
-![License: AGPL-3.0](https://img.shields.io/badge/license-AGPL--3.0-blue)
-![Ruby](https://img.shields.io/badge/ruby-3.0%2B-red)
+[![License: AGPL-3.0](https://img.shields.io/badge/license-AGPL--3.0-blue)](https://www.gnu.org/licenses/agpl-3.0.html)
+[![Ruby](https://img.shields.io/badge/ruby-3.0%2B-red)](https://www.ruby-lang.org/)
+[![CI](https://github.com/it1ro/ficha/actions/workflows/main.yml/badge.svg)](https://github.com/it1ro/ficha/actions)
+[![Gem Version](https://badge.fury.io/rb/ficha.svg)](https://rubygems.org/gems/ficha)
 
 `ficha` helps you **dump relevant files** from large Ruby/Rails codebases based on **semantic strategies**, not just file extensions.  
 Think of it as `grep` + `find` + domain knowledge — for developers who know *what* they need, but not *where* it is.
@@ -25,7 +27,7 @@ Perfect for:
 # Dump all files related to the `User` model
 ficha by-model:User
 
-# Dump a "safe" subset (models, serializers, controllers, specs)
+# Dump a "safe" subset (models, controllers, specs, domain logic)
 ficha full-safe
 
 # Preview without writing
@@ -37,11 +39,14 @@ Output (dry-run):
 ```
 app/models/user.rb
 app/controllers/users_controller.rb
-app/serializers/user_serializer.rb
+app/domain/user.rb
 spec/models/user_spec.rb
+spec/domain/user_spec.rb
 ...
 ```
 
+> ✅ Automatically **excludes sensitive files** like `master.key`, `.env*`, `credentials.yml.enc`.
+
 ---
 
 ## 🧩 Core Concepts
@@ -49,20 +54,22 @@ spec/models/user_spec.rb
 `ficha` works by combining:
 
 1. **Strategies** — rules that define *what to include* (e.g. `by-model`, `full-safe`)
-2. **Config** — your project-specific paths, conventions, and overrides (`ficha.yml`)
-3. **Engine** — the resolver that applies strategies to your codebase
-4. **CLI** — your interface to run queries
+2. **Config** — your project-specific paths, conventions, and overrides (`ficha.yml` or `.ficha.yml`)
+3. **Template engine** — with filters like `underscore`, `pluralize` (via ActiveSupport)
+4. **Engine** — resolves paths, applies filters, excludes sensitive/ignored files
+5. **CLI** — your interface to run queries
 
 ```mermaid
 graph LR
   A[CLI: ficha by-model:User] --> B(Engine)
   B --> C{Strategy: by-model}
   B --> D[Config: ficha.yml]
-  C --> E[Match model, controller, serializer...]
+  C --> E[Apply template filters:<br>underscore, pluralize]
   D --> F[Custom paths, excludes]
-  E --> G[File list]
+  E --> G[Glob & match files]
   F --> G
-  G --> H[Output or copy]
+  G --> H[Apply global filters]
+  H --> I[Output file list]
 ```
 
 ---
@@ -83,65 +90,57 @@ Then run:
 bundle install
 ```
 
-> 💡 `ficha` is designed as a **dev-only CLI tool** — it doesn’t affect your runtime.
+> 💡 `ficha` is a **dev-only CLI tool** — zero runtime impact.
 
 ---
 
 ## ⚙️ Configuration
 
-By default, `ficha` looks for `config/ficha.yml` (in Rails) or `.ficha.yml` (in any project).
+`ficha` looks for config in this order:
+
+1. `./.ficha.yml`
+2. `./ficha.yml`
+3. `~/.ficha.yml` (global fallback)
 
-### Example `config/ficha.yml`
+### Example `ficha.yml`
 
 ```yaml
-# ficha.yml — declarative, extensible, no Ruby code!
+version: "1"
+
+defaults:
+  sensitive_names: ["*.env*", "master.key", "credentials.yml.enc"]
+  ignored_extensions: [".lock", ".jpg", ".png", ".gif", ".pdf"]
 
 strategies:
   by-model:
-    include:
-      - "app/models/{{name}}.rb"
-      - "app/controllers/{{name.pluralize}}_controller.rb"
-      - "app/serializers/{{name}}_serializer.rb"
-      - "spec/models/{{name}}_spec.rb"
-      - "spec/requests/{{name.pluralize}}_spec.rb"
-    exclude:
-      - "app/models/concerns/*"
+    params: [name]
+    include_paths:
+      - "app/models/{{name | underscore}}.rb"
+      - "app/controllers/{{name | pluralize | underscore}}_controller.rb"
+      - "app/domain/{{name | underscore}}.rb"
+      - "spec/models/{{name | underscore}}_spec.rb"
+      - "spec/domain/{{name | underscore}}_spec.rb"
 
   full-safe:
-    include:
+    include_paths:
       - "app/models/**/*.rb"
       - "app/controllers/**/*.rb"
-      - "app/serializers/**/*.rb"
-      - "spec/{models,controllers,serializers}/**/*.rb"
+      - "app/domain/**/*.rb"
+      - "app/operations/**/*.rb"
+      - "app/services/**/*.rb"
+      - "spec/{models,controllers,domain,operations,services}/**/*.rb"
     exclude:
       - "spec/support/**/*"
-
-paths:
-  root: "."                 # project root
-  output: "/tmp/ficha-out"  # (future: where to copy files)
-
-excludes:
-  - "tmp/**/*"
-  - "log/**/*"
-  - "vendor/**/*"
 ```
 
 > ✅ **Philosophy**: Keep logic in config, not code.  
-> 🔒 Config supports ERB if you *really* need dynamic values (but avoid it for reproducibility).
+> 🔒 Supports ERB if *really* needed (but discouraged for reproducibility).
 
 ---
 
-## Global Configuration
-
-If you don’t want to add `.ficha.yml` to every project, you can create a **global config** at `~/.ficha.yml`.
-
-`ficha` will use it **only when no local `.ficha.yml` or `ficha.yml` is found**.
+## 🌐 Global Configuration
 
-This is useful for defining your personal strategies (e.g. `by-model`, `by-job`) once and reusing them everywhere.
-
-> 🔒 Sensitive or project-specific paths (like `output`, `excludes`) should still go into local config.
-
-Example `~/.ficha.yml`:
+Create `~/.ficha.yml` to define **personal strategies** usable in any Ruby project:
 
 ```yaml
 version: "1"
@@ -157,19 +156,41 @@ strategies:
       - "app/jobs/{{name | underscore}}.rb"
 ```
 
-Now you can run ficha by-model:User in any Ruby project — even without a local config!
+Now `ficha by-model:User` works **even in projects without local config**.
+
+> 🔒 Project-specific paths (output, excludes) should stay in local config.
 
 ---
 
 ## 🎯 Built-in Strategies
 
-| Strategy      | Purpose |
-|---------------|--------|
-| `full-safe`   | Dumps core app code: models, controllers, serializers, related specs |
-| `by-model:X`  | Dumps everything related to model `X` (convention-based) |
+| Strategy       | Purpose |
+|----------------|--------|
+| `full-safe`    | Dumps core app logic: models, controllers, domain, operations, services, specs |
+| `by-model:X`   | Dumps everything related to model `X` (with inflection support) |
 | *(more coming)* | — |
 
-You can **extend strategies** in your `ficha.yml` — no need to fork the gem.
+You can **extend or override** strategies in your config — no gem forking needed.
+
+---
+
+## 🧩 Composition Support
+
+Combine strategies using `compose`:
+
+```yaml
+strategies:
+  user-plus-session:
+    compose:
+      - by-model:User
+      - by-model:Session
+```
+
+Then run:
+
+```sh
+ficha user-plus-session --dry-run
+```
 
 ---
 
@@ -182,15 +203,23 @@ Examples:
   ficha                     # runs 'full-safe'
   ficha by-model:User       # model-aware dump
   ficha full-safe --dry-run # preview only
+  ficha by-model:User --exclude spec  # exclude specs
 
 Options:
   --help          Show help
   --dry-run       Print matched files (default)
-  --exclude GLOB  Exclude additional paths (can be used multiple times)
+  --exclude GLOB  Exclude paths (repeatable)
 ```
 
-> ⚠️ **Non-dry-run mode** (actual file copying) is **not implemented yet** — coming soon!  
-> You’ll be able to dump to a directory, zip, or tar.
+> ⚠️ **File copying (non-dry-run)** is coming soon — you’ll be able to dump to dir/zip/tar!
+
+---
+
+## 🛡️ Security & Privacy
+
+- **Never includes** sensitive files (`master.key`, `.env`, etc.)
+- **Declarative config** reduces risk of accidental data exposure
+- **AGPL-3.0 licensed** — ensures freedom and transparency
 
 ---
 
@@ -207,9 +236,9 @@ Tests use real fixtures in `test/fixtures/rails_app/` — easy to extend.
 
 ## 📜 License
 
-AGPL-3.0 — because **privacy, self-hosting, and user freedom matter**.
+[AGPL-3.0](./LICENSE) — because **privacy, self-hosting, and user freedom matter**.
 
-You’re free to use `ficha` in any project, but if you modify and redistribute it (e.g. as a hosted service), you must share the source.
+> You’re free to use `ficha` in any project. If you modify and redistribute it (e.g. as a hosted service), you must share the source.
 
 ---
 
@@ -217,16 +246,19 @@ You’re free to use `ficha` in any project, but if you modify and redistribute
 
 PRs welcome! Especially:
 
-- New strategies
-- Non-dry-run output formats (dir, zip, tar)
-- Better Rails/7+ support
-- Performance optimizations
+- 🧠 New strategies (`by-service`, `by-endpoint`, etc.)
+- 💾 Non-dry-run output (dir, zip, tar)
+- 🚀 Performance & memory optimizations
+- 🧪 Better Rails 7+/Ruby 3.4+ support
 
 Please:
 
-- Write tests
-- Keep config declarative
-- Respect the AGPL spirit
+- ✅ Write tests
+- 📜 Keep config declarative
+- 🔐 Respect the AGPL spirit
+
+> 🐞 Found a bug? Use the [issue template](./.github/issue_template.md).  
+> 💡 Have an idea? Open a [feature request](./.github/issue_template.md).
 
 ---
 

data/lib/ficha/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ficha
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/ficha.rb

@@ -6,6 +6,8 @@ require_relative "ficha/template"
 require_relative "ficha/engine"
 require "optparse"
 
+require "pry"
+
 module Ficha
   class CLI
     def self.start(argv)
@@ -31,6 +33,15 @@ module Ficha
       exit 1
     end
 
+    def print_files(files, show_line_numbers: true)
+      files.each do |path|
+        next unless File.file?(path) && readable_text_file?(path)
+
+        puts "\n=== #{path} ==="
+        print_file_content(path, show_line_numbers: show_line_numbers)
+      end
+    end
+
     private
 
     def handle_help!
@@ -46,11 +57,31 @@ module Ficha
       if @options[:dry_run]
         files.each { |f| puts f }
       else
-        warn "Non-dry-run mode not implemented yet"
-        exit 1
+        print_files(files, show_line_numbers: false)
       end
     end
 
+    def print_file_content(path, show_line_numbers:)
+      if show_line_numbers
+        File.readlines(path).each_with_index(1) do |line, lineno|
+          printf "%<lineno>4d | %<content>s\n", lineno: lineno, content: line.chomp
+        end
+      else
+        puts File.read(path)
+      end
+    end
+
+    def readable_text_file?(path)
+      return false if File.size(path) > 1_000_000
+
+      File.open(path, "rb") do |f|
+        chunk = f.read(1024)
+        !chunk&.include?("\x00")
+      end
+    rescue StandardError
+      false
+    end
+
     def execute_engine
       config = Config.load
       engine = Engine.new(
@@ -86,10 +117,13 @@ module Ficha
         Usage:
           ficha [STRATEGY:PARAMS...] [options]
 
+        By default, prints contents of matched files.
+        Use --dry-run to list paths only.
+
         Examples:
-          ficha                     # full-safe dump
-          ficha by-model:User       # dump User-related files
-          ficha full-safe --dry-run
+          ficha                     # print full-safe files
+          ficha by-model:User       # print User-related files
+          ficha full-safe --dry-run # only list paths
 
         Options:
       HELP

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ficha
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ilmir Karimov