documinty 0.3.1 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de1f0a6fded0793fb156e8111a074c44dda251836475980441b0c47576660147
-  data.tar.gz: 4fbb5cd7db1b97866eed50050754af3ac09998e7ff4486b5330adfd822fc1537
+  metadata.gz: 9cdaaaa7ee632437dcc089dff1519f0ed89d221455ec410e5774d4b5f065e33d
+  data.tar.gz: 2b59162f6da06d1ab50a2065096a96588343c13481e2cf0f8ea14ed0666145e8
 SHA512:
-  metadata.gz: f883d81566c6ab6013c5d6edbc77faf7b2661bb95ada107c1816787099ebc13e3dc92a246b36dbf1489620eed465e8da1c3e68896cd8d6a50224e93f6f9d4e7f
-  data.tar.gz: da024a6231ee1b7bbe131cf4393f5a20351ec7d8ae9e48655cd6ddfd9b8c89d3b0cf749af341970b666ff471704292ba79e904f974dbf4d5cceb67da54f00c98
+  metadata.gz: 6b88c14ac88e558f2e70d345a48a0c2870052857def3e9de9ba18c44f1b0d58c03bf56add9761fd02d6d81fbd7e59e1a3684fc499cb30976f65d362aee374c40
+  data.tar.gz: a9999e6a85bba70df3388e5d4f37e522ab7d67f24113f5ba33cda215bea161941940d54c3c922db4470346251b4c93dfdc863c02eedf5275c7fc9c8a2bac0deb

data/README.md

@@ -22,7 +22,7 @@ Everything you record lives under a `.documinty/` folder in your project. You ca
 
 ### From RubyGems
 
-```bash
+```
 gem install documinty
 # or, if you prefer the short alias:
 # gem install dty
@@ -74,23 +74,55 @@ dty doc app/controllers/sessions_controller.rb -f user-auth -n controller
 ```
 dty show app/controllers/sessions_controller.rb
 ```
+
+Show documentation under a specific feature
+```
+dty show app/controllers/sessions_controller.rb -f user-auth
+```
 ### 6. List all defined features
 ```
 dty features
 ```
 ### 7. Show all files under "user-auth"
 ```
-dty list_f user-auth
+dty show_feature user-auth
 ```
 ### 8. Show file structure under "user-auth"
 ```
-dty involved_f user-auth
+dty involved user-auth
 ```
 ### 9. Search for features that contain "user"
 ```
 dty search_f user
 ```
+### 10. Add or remove methods for a documented file
+To add:
+```
+dty methods path/to/file -f user-auth -a add
+```
+
+To add:
+```
+dty methods path/to/file -f user-auth -a remove
+```
+you will be prompted to add the comma separated methods that you want to add or remove
+### 11. Display description of a documented file
+```
+dty describe path/to/file
+```
+This will display all the descriptions that a file has undear each of the features
+
+Optionally, the feature flag can be passed to specify the description for  a feature
+```
+dty describe path/to/file -f user-auth
+```
+### 12. Update the description for a file 
+```
+dty update_description path/to/file -f user-auth
+```
+NOTE: you must pass the feature when updating the description
 
+You will be prompted to enter the new description for the file under the feature
 ### Project layout
 ```
 .

data/lib/documinty/cli.rb

@@ -221,10 +221,15 @@ module Documinty
       end
     end
 
-    desc "add_methods FILE", "Prompt for and add methods to an existing documented file"
-    option :feature, aliases: '-f', required: true, desc: "Feature name"
-    def add_methods(path)
-      # Ask interactively for comma-separated methods
+    desc "methods FILE", "Prompt for removing or adding methods to a tagged file pass add or remove as the action"
+    option :feature, aliases: '-f', required: true, desc: 'Feature name to group under'
+    option :action,    aliases: '-a', required: true, desc: 'Node/type label'
+    def methods(path)
+      if options[:action] != 'add' && options[:action] != 'remove'
+        say "❌ Action not supported must be 'add' OR 'remove'", :red
+        exit(1)
+      end
+
       methods_input = ask("Enter comma-separated methods to add to this node🛠️:")
       method_syms = methods_input
                       .split(",")
@@ -233,10 +238,11 @@ module Documinty
                       .map(&:to_sym)
 
       begin
-        entry = store.add_methods(
+        entry = store.methods(
           path:        path,
           feature:     options[:feature],
-          new_methods: method_syms
+          new_methods: method_syms,
+          action: options[:action].to_sym
         )
         say "✅ Updated methods for #{entry['path']} under '#{entry['feature']}': #{Array(entry['methods']).join(', ')}", :green
       rescue Error => e
@@ -265,18 +271,46 @@ module Documinty
       end
 
       entries.each do |e|
-        desc = e['description'].to_s.strip
-        if desc.empty?
+        desc_text = e['description'].to_s.strip
+
+        if desc_text.empty?
           say "ℹ️  No description provided for '#{path}' under '#{e['feature']}'", :yellow
         else
-          say "📋 #{path}", :cyan
-          say "--→ #{desc}", :green
+          if options[:feature]
+            # Only one feature context
+            say "📋 #{path}", :cyan
+          else
+            # Show which feature this description belongs to
+            say(
+              set_color("📋 #{path} ️", :cyan) +
+                ": " +
+                set_color("(FEATURE: #{e['feature']})", :magenta)
+            )
+          end
+          say "--→ #{desc_text}", :green
         end
       end
     end
 
-    private
+    desc "update-description FILE", "Prompt for and update description for FILE under a feature"
+    option :feature, aliases: '-f', required: true, desc: 'Feature name'
+    def update_description(path)
+      begin
+        new_desc = ask("Enter a new description for '#{path}' under '#{options[:feature]}':")
+        entry = store.update_description(
+          path:            path,
+          feature:         options[:feature],
+          new_description: new_desc
+        )
+        say "✅ Description updated for #{entry['path']} under '#{entry['feature']}':", :green
+        say "   #{entry['description']}", :green
+      rescue Error => e
+        say "❌ #{e.message}", :red
+        exit(1)
+      end
+    end
 
+    private
 
     def truncate(text)
       return "" unless text

data/lib/documinty/store.rb

@@ -108,7 +108,7 @@ module Documinty
     # @param feature [String]    feature name (must already exist on that entry)
     # @param new_methods [Array<Symbol>]  list of symbols to add
     # @return [Hash] the updated entry
-    def add_methods(path:, feature:, new_methods:)
+    def methods(path:, feature:, new_methods:, action:)
       file = feature_file(feature)
       raise Error, "Feature '#{feature}' does not exist" unless File.exist?(file)
 
@@ -123,13 +123,42 @@ module Documinty
 
       # Merge existing methods (strings) with new ones, avoid duplicates
       existing = Array(entry['methods']).map(&:to_s)
-      merged  = (existing + new_methods.map(&:to_s)).uniq
+      if action == :add
+        merged  = (existing + new_methods.map(&:to_s)).uniq
+      else
+        merged  = (existing - new_methods.map(&:to_s)).uniq
+      end
       entry['methods'] = merged
 
       File.write(file, data.to_yaml)
       entry
     end
 
+    # Update the description for a documented file under a given feature
+    # @param path [String]          relative file path
+    # @param feature [String]       feature name
+    # @param new_description [String]
+    # @return [Hash] the updated entry
+    def update_description(path:, feature:, new_description:)
+      file = feature_file(feature)
+      unless File.exist?(file)
+        raise Error, "Feature '#{feature}' does not exist"
+      end
+
+      data     = YAML.load_file(file) || {}
+      entries  = data['entries'] ||= []
+
+      entry = entries.find { |e| e['path'] == path && e['feature'] == feature }
+      unless entry
+        raise Error, "No documentation found for '#{path}' under feature '#{feature}'"
+      end
+
+      entry['description'] = new_description.to_s.strip
+      File.write(file, data.to_yaml)
+
+      entry
+    end
+
     private
 
     # Build the path to a feature’s YAML file

data/lib/documinty/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Documinty
-  VERSION = "0.3.1"
+  VERSION = "0.3.3"
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: documinty
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.3
 platform: ruby
 authors:
 - Marcel Carrero Pedre
 bindir: exe
 cert_chain: []
-date: 2025-06-06 00:00:00.000000000 Z
+date: 2025-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor