documinty 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f47f710104e3d97dbf8afa35333f6c5559acfae0b9920b88a371d8e4ac2e17f
-  data.tar.gz: 3ac6cf1da6b1582176be4b7b1120c415dd859b1acf602942462c0f49f8980a66
+  metadata.gz: e847137dcc7a46903f7339d096678c5a07c32413e8877830ba496c6e1325e9e7
+  data.tar.gz: 5672e3ce3188e413bbc292bfe457deb90af10ba22a3ec8b8a9dbeb28635b2aba
 SHA512:
-  metadata.gz: 5181bcec104b0441f59681e3e4dc792dcca156581bbb7b2da7b66d0a1a88d470de55faa22f223cbbbae1bd117dbce39f129af7373429874e96832867469897b6
-  data.tar.gz: 460d9755b0baf1155a66f2e30d7d50c73063b01cb1cfbf47c0090cadbcb2c126bd9dcf24770c2c5e1d314bed381dbd2b67e0e77095ac218dc7cb853f67e5924e
+  metadata.gz: '0859bd3be39d71225c6a04577062a93b5d3411fb237a6c1de93467e78dc74b8b27fefba48908914a52d92385efbc11086479580ed9c2de51a7e23e1579264c83'
+  data.tar.gz: 4f55d997b8b3a5a1261985830c169b7fb0bf8bdf9c42346c3f5482c492bde72ac0ccc3c7ad6f6deff1b5ea5a0a6cf819b61776db2ed0a68a8aa7f31b21f4623f

data/lib/documinty/cli.rb

@@ -4,6 +4,7 @@ require 'documinty/store'
 
 module Documinty
   class CLI < Thor
+    MAX_DESC_LENGTH = 80
     def self.exit_on_failure?
       true
     end
@@ -112,7 +113,7 @@ module Documinty
           say(
             set_color("Description📝", label_color) +
               ": " +
-              set_color(e['description'], value_color)
+              set_color(truncate(e['description']), value_color)
           )
         end
 
@@ -150,8 +151,8 @@ module Documinty
       end
     end
 
-    desc "show-feature FEATURE", "List all files documented under FEATURE"
-    def list_f(feature)
+    desc "show_feature FEATURE", "List all files documented under FEATURE"
+    def show_feature(feature)
       begin
         entries = store.entries_for_feature(feature)
       rescue Error => e
@@ -163,13 +164,21 @@ module Documinty
         say "No entries under '#{feature}'.", :red
       else
         say "Entries for '#{feature}':"
+        label_color   = :cyan
+        value_color   = :magenta
         entries.each do |e|
-          say "• #{e['path']} (#{e['node']}) – #{e['description']}", :green
+
+
+          # File
+          say(
+            set_color("📄#{e['path']} | ", label_color) +
+              set_color("(#{e['node']}) – #{e['description']}", value_color)
+          )
         end
       end
     end
 
-    desc "show_feature_involved FEATURE", "Display files under FEATURE grouped by directory"
+    desc "involved_f FEATURE", "Display files under FEATURE grouped by directory"
     def involved_f(feature)
       begin
         entries = store.entries_for_feature(feature)
@@ -212,8 +221,103 @@ module Documinty
       end
     end
 
+    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(",")
+                      .map(&:strip)
+                      .reject(&:empty?)
+                      .map(&:to_sym)
+
+      begin
+        entry = store.methods(
+          path:        path,
+          feature:     options[:feature],
+          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
+        say "❌ #{e.message}", :red
+        exit(1)
+      end
+    end
+
+    desc "describe FILE", "Display only the description for FILE"
+    option :feature, aliases: '-f', desc: "If provided, only show description under that feature"
+    def describe(path)
+      entries = store.entries_for(path)
+
+      # If a specific feature is requested, filter to those entries
+      if options[:feature]
+        entries = entries.select { |e| Array(e['features'] || e['feature']).include?(options[:feature]) }
+      end
+
+      if entries.empty?
+        if options[:feature]
+          say "❌ No description found for '#{path}' under feature '#{options[:feature]}'", :red
+        else
+          say "❌ No description found for '#{path}'", :red
+        end
+        exit(1)
+      end
+
+      entries.each do |e|
+        desc_text = e['description'].to_s.strip
+
+        if desc_text.empty?
+          say "ℹ️  No description provided for '#{path}' under '#{e['feature']}'", :yellow
+        else
+          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
+
+    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
+      return text if text.length <= MAX_DESC_LENGTH
+      text[0, MAX_DESC_LENGTH] + "(…)"
+    end
+
     def store
       @store ||= Store.new(Dir.pwd)
     end

data/lib/documinty/store.rb

@@ -103,6 +103,62 @@ module Documinty
       data['entries'] || []
     end
 
+    # Add one or more methods to a documented file under a given feature
+    # @param path [String]       relative file path
+    # @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 methods(path:, feature:, new_methods:, action:)
+      file = feature_file(feature)
+      raise Error, "Feature '#{feature}' does not exist" unless File.exist?(file)
+
+      data = YAML.load_file(file) || {}
+      entries = data['entries'] || []
+
+      # Find the exact entry by path + feature
+      entry = entries.find { |e| e['path'] == path && e['feature'] == feature }
+      unless entry
+        raise Error, "No documentation found for '#{path}' under feature '#{feature}'"
+      end
+
+      # Merge existing methods (strings) with new ones, avoid duplicates
+      existing = Array(entry['methods']).map(&:to_s)
+      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.0"
+  VERSION = "0.3.2"
 end

metadata

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