added list

Not a perfect implementation, this might change in the future

Author: Jomy10

src/parser-short-old.rb

@@ -1,6 +1,8 @@
 require 'json'
 require_relative './reference.rb'
 
+# TODO: warn when two references have the same citation and potentially add (year[a-z]) and/or expand the reference.
+
 # # Short references
 # [#5!] = Ward and Ramachandran (2010, December)
 # [#5] = (Ward & Ramachandran 2010, December)

src/parser-short.rb

@@ -42,6 +42,13 @@ The second time it appears in the same text:
 Belleflamme et al. (2014) states that crowdfunding involves a general request for money ...
 ```
 
+### Listing references
+```bash
+refst list path/to/file
+```
+
+This will list all references in a text.
+
 ## A note from the author
 The citation style is based on the recommendations of Ghent University.
 This is because this tool was created for my own master thesis. Feel free to fork the project if your project requires a different style.

template-engine/README.md

@@ -5,7 +5,7 @@
 # © Jonas Everaert 2022
 #
 # USAGE:
-#   refst <input>
+#   refst [subcommand] <input>
 # 
 # ARGS:
 #   <input>         is either a file path, or a string
@@ -14,12 +14,17 @@
 #   -h              Prints this help information
 #   -v, --version   Prints the version of the cli
 #   -p              Sets a custom path for the refs cli
+#
+# SUBCOMMANDS:
+# list <input>      List the references from the input
 # 
-# ENVIRONMENT VARIABLES
+# ENVIRONMENT VARIABLES:
 #   STREAM=true     Can be set to false to output the file in one go
 #                   instead of as a stream
+#
 
 require_relative '../../src/parser-short.rb'
+require 'set'
 
 VERSION = "0.0.1"
 
@@ -179,7 +184,7 @@ def replace_matches_multiple(line, match)
         numbers = numbers.split('&')
         short_refs = ""
         numbers.each_with_index do |number, idx|
-            short_ref = @parser.parsePar(number, !@refs_used.key?(number))
+            short_ref = @parser.parse(number, !@refs_used.key?(number))
             if not @refs_used.key?(number)
                 @refs_used[number] = true
             end
@@ -228,6 +233,20 @@ def replace_matches_multiple_par(line, match)
     end
 end
 
+def listReferences(input)
+    re = /\[#(?<id>\d+)\!?\]/
+    match = input.scan re
+    list = Set.new
+    match.each do |id_arr|
+        id = id_arr[0]
+        list << id
+    end
+        
+    list.each do |id|
+        puts `refs -i #{id}`
+    end
+end
+
 # Reference match
 # type
 # string
@@ -239,10 +258,21 @@ def replace_matches_multiple_par(line, match)
     else
         true
     end
-
-    if stream
-        CLI.new(ARGV).execute(stream)
+    
+    if ARGV[0] == "list"
+        input = begin
+            File.read(ARGV[1])
+        rescue Errno::ENOENT
+            ARGV[1]
+        end
+        
+        listReferences(input)
     else
-        puts CLI.new(ARGV).execute(stream)
+
+        if stream
+            CLI.new(ARGV).execute(stream)
+        else
+            puts CLI.new(ARGV).execute(stream)
+        end
     end
 end