Feat/show ref (#53)

* Implement show-ref and closes #19

Author: C-likethis123

.clang-format

@@ -0,0 +1 @@
+InsertNewlineAtEOF: true

CMakeLists.txt

@@ -1,51 +1,56 @@
 cmake_minimum_required(VERSION 3.8.2)
 
-# Set a name and a version number for your project:
-project(
-  cpp-project-template
-  VERSION 0.0.1
-  LANGUAGES CXX)
-
-set(CMAKE_AR /usr/bin/ar)
-
-# Enable C language
-enable_language(C)
-
-# this needs to be in the top level CMakeLists.txt to enable tests
-include(CTest)
-
-set(BOOST_ENABLE_CMAKE ON)
-set(Boost_CMAKE_CXX_STANDARD 17)
-set(CMAKE_CXX_STANDARD 17)
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
-
-set(BOOST_INCLUDE_LIBRARIES iostreams uuid algorithm)
-
-include(FetchContent)
-FetchContent_Declare(
-  Boost
-  GIT_REPOSITORY https://github.com/boostorg/boost.git
-  GIT_TAG boost-1.83.0
-  GIT_SHALLOW TRUE)
-FetchContent_MakeAvailable(Boost)
-
-# compile the library
-add_subdirectory(src)
-
-# compile the application
-add_subdirectory(app)
-
-# optionally add doxygen target to generate documentation
-option(BUILD_DOCS "Enable building of documentation (requires Doxygen)" OFF)
-if(BUILD_DOCS)
-  find_package(Doxygen REQUIRED)
-  set(DOXYGEN_EXCLUDE_PATTERNS "${CMAKE_SOURCE_DIR}/ext/*")
-  doxygen_add_docs(doxygen ${CMAKE_SOURCE_DIR}
-                   WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})
-endif()
-
-# compile the tests
-option(BUILD_TESTS "Enable building of documentation (requires Doxygen)" OFF)
-if(BUILD_TESTS)
-  add_subdirectory(tests)
-endif()
+#Set a name and a version number for your project:
+    project(cpp - project - template VERSION 0.0.1 LANGUAGES CXX)
+
+        set(CMAKE_AR / usr / bin / ar)
+
+#Enable C language
+            enable_language(C)
+
+#this needs to be in the top level CMakeLists.txt to enable tests
+                include(CTest)
+
+                    set(BOOST_ENABLE_CMAKE ON) set(Boost_CMAKE_CXX_STANDARD 17) set(
+                        CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD_REQUIRED
+                                                       ON)
+
+                        set(BOOST_INCLUDE_LIBRARIES iostreams uuid algorithm)
+
+                            include(FetchContent) FetchContent_Declare(
+                                Boost GIT_REPOSITORY
+                                    https : // github.com/boostorg/boost.git
+                                GIT_TAG boost -
+                                1.83.0 GIT_SHALLOW
+                                    TRUE) FetchContent_MakeAvailable(Boost)
+
+#compile the library
+                                add_subdirectory(src)
+
+#compile the application
+                                    add_subdirectory(app)
+
+#optionally add doxygen target to generate documentation
+                                        option(BUILD_DOCS
+                                               "Enable building of "
+                                               "documentation (requires "
+                                               "Doxygen)" OFF) if (BUILD_DOCS)
+                                            find_package(Doxygen REQUIRED) set(
+                                                DOXYGEN_EXCLUDE_PATTERNS
+                                                "${CMAKE_SOURCE_DIR}/ext/*")
+                                                doxygen_add_docs(
+                                                    doxygen ${
+                                                        CMAKE_SOURCE_DIR} WORKING_DIRECTORY
+                                                        ${CMAKE_CURRENT_BINARY_DIR})
+                                                    endif()
+
+#compile the tests
+                                                        option(BUILD_TESTS
+                                                               "Enable "
+                                                               "building of "
+                                                               "documentation "
+                                                               "(requires "
+                                                               "Doxygen"
+                                                               ")" OFF) if (BUILD_TESTS)
+                                                            add_subdirectory(
+                                                                tests) endif()

LICENSE

@@ -1,21 +1,29 @@
 MIT License
 
-Copyright (c) 2020 SSC
+Copyright(c) 2020 SSC
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+    Permission is hereby granted,
+    free of charge,
+    to any person obtaining a copy of this software and associated documentation
+    files(the "Software"),
+    to deal in the Software without restriction,
+    including without limitation the rights to use, copy, modify, merge, publish
+    ,
+    distribute, sublicense, and / or sell copies of the Software,
+    and to permit persons to whom the Software is furnished to do so,
+    subject to the following conditions :
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+    The above copyright notice and this permission notice shall be included in
+    all copies
+    or
+    substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+    THE SOFTWARE IS PROVIDED "AS IS",
+    WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+    INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+    DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+    TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN
+    CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,4 +1,4 @@
-# Git C++lient
+#Git C++ lient
 
 ## Contents
 
@@ -45,4 +45,4 @@ cmake .. -DCMAKE_BUILD_TYPE=Release -DBUILD_DOCS=ON
 make doxygen
 ```
 
-This will generate the documentation in the `html` folder.
+This will generate the documentation in the `html` folder.

app/gyt.cpp

@@ -4,6 +4,7 @@
 #include "commands/init.h"
 #include "commands/log.h"
 #include "commands/ls-tree.h"
+#include "commands/show-ref.h"
 #include <iostream>
 #include <string>
 #include <vector>
@@ -30,6 +31,8 @@ int main(int argc, char **argv) {
     commands::lstree(args);
   } else if (command == "checkout") {
     commands::checkout(args);
+  } else if (command == "show-ref") {
+    commands::showref(args);
   } else {
     std::cerr << "Unknown command: " << command << "\n";
     return -1;

doc/commands/show-ref.md

@@ -0,0 +1,7 @@
+# Refs
+
+A ref lives in .git/refs and contains the SHA-1 hash of an object's hash.
+
+## `show-ref`
+
+`gyt show-ref`: shows all refs

include/commands/show-ref.h

@@ -0,0 +1,10 @@
+#ifndef SHOWREF_H
+#define SHOWREF_H
+
+#include <string>
+#include <vector>
+namespace commands {
+void showref(std::vector<std::string> &args);
+} // namespace commands
+
+#endif // SHOWREF_H

include/util.h

@@ -1,6 +1,7 @@
 #ifndef UTIL_H
 #define UTIL_H
 
+#include "repository.h"
 #include <filesystem>
 #include <string>
 namespace fs = std::filesystem;
@@ -12,4 +13,7 @@ std::string binaryToHex(const std::string &binary);
 std::string hexToBinary(const std::string &hexString);
 std::string get_file_type(int mode);
 fs::perms get_unix_permissions(int mode);
-#endif // UTIL_H
+std::string remove_file_prefix(const fs::path &path,
+                               const fs::path &repo_prefix);
+std::string resolve_ref(const fs::path &ref_path, GitRepository &repo);
+#endif // UTIL_H

run.sh

@@ -1,29 +1,33 @@
-#!/bin/bash
-set -e
+#!/ bin / bash
+set - e
 
-# Set the default build type to Debug if no environment is specified
-BUILD_TYPE=${BUILD_TYPE:-Debug}
+#Set the default build type to Debug if no environment is specified
+          BUILD_TYPE = ${BUILD_TYPE : -Debug}
 
-# If the environment is specified as "prod", set the build type to Release
-if [ "$1" == "-p" ]; then
-    BUILD_TYPE=Release
-fi
+#If the environment is specified as "prod", set the build type to Release
+if["$1" == "-p"];
+then BUILD_TYPE = Release fi
 
-# remove old build if any
-if [ -f "app/gyt" ]; then
-    rm -rf app/gyt
-fi
+#remove old build if any
+    if[-f "app/gyt"];
+then rm -
+    rf app / gyt fi
 
-# Print the selected build type
-echo "Selected build type: $BUILD_TYPE"
-echo "Building the project... This will take a while to install dependencies for the first time."
+#Print the selected build type
+             echo "Selected build type: $BUILD_TYPE" echo
+                  "Building the project... This will take a while to install "
+                  "dependencies for the first time."
 
-# Run CMake with the selected build type
-cmake .. -DCMAKE_BUILD_TYPE=$BUILD_TYPE -DCMAKE_EXPORT_COMPILE_COMMANDS=1 -G Ninja
+#Run CMake with the selected build type
+             cmake..-
+    DCMAKE_BUILD_TYPE = $BUILD_TYPE - DCMAKE_EXPORT_COMPILE_COMMANDS =
+                            1 -
+                            G Ninja
 
-# Build the project
-ninja
+#Build the project
+                                    ninja
 
-# symlink - so I can run it like gyt [arguments....]
-sudo rm /usr/local/bin/gyt
-sudo ln -s "$(pwd)/app/gyt" /usr/local/bin/gyt
+#symlink - so I can run it like gyt[arguments....]
+                                        sudo rm /
+                                usr / local / bin / gyt sudo ln -
+                            s "$(pwd)/app/gyt" / usr / local / bin / gyt

src/CMakeLists.txt

@@ -24,8 +24,8 @@ target_link_libraries(object PRIVATE repository boost_libraries)
 target_include_directories(object PUBLIC ../include)
 target_compile_features(object PUBLIC cxx_std_17)
 
-add_library(commands init.cpp cat-file.cpp hash-object.cpp log.cpp ls-tree.cpp
-                     checkout.cpp)
+file(GLOB COMMANDS_SOURCES "${CMAKE_CURRENT_SOURCE_DIR}/commands/*.cpp")
+add_library(commands ${COMMANDS_SOURCES})
 target_link_libraries(commands PRIVATE repository object boost_libraries)
 target_include_directories(commands PUBLIC ../include)
 target_compile_features(commands PUBLIC cxx_std_17)

src/cat-file.cpp renamed to src/commands/cat-file.cpp

@@ -0,0 +1,40 @@
+#include "commands/show-ref.h"
+#include <iostream>
+
+#include "repository.h"
+#include "tclap/CmdLine.h"
+#include "util.h"
+
+namespace commands {
+void showref(std::vector<std::string> &args) {
+  TCLAP::CmdLine cmd("show-ref", ' ', "0.1");
+
+  // TODO defines arguments
+  cmd.parse(args);
+
+  // process args
+  try {
+    std::optional<GitRepository> repo = GitRepository::find();
+    if (repo) {
+      // TODO filter refs by pattern
+
+      // recursively traverse these directories: refs/heads, refs/remotes,
+      // stash, tags. basically everything in .git/refs
+      // don't care about filtering first?
+
+      // if it's a file, print the ref
+      fs::path refs_path = repo->repo_path("refs");
+      fs::path gitdir = repo->repo_path("");
+      for (const auto &entry : fs::recursive_directory_iterator(refs_path)) {
+        fs::path path = entry.path();
+        if (fs::is_regular_file(path)) {
+          std::string sha = resolve_ref(path, *repo);
+          std::cout << sha << " " << remove_file_prefix(path, gitdir) << "\n";
+        }
+      }
+    }
+  } catch (std::runtime_error &err) {
+    std::cerr << err.what() << "\n";
+  }
+}
+} // namespace commands