stg 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ebc70931cee2053b5b4f7ff6e9db88f8b588dfd456c46c6841c9f1099a4bb4e
-  data.tar.gz: 70e8f54fddcfdbedf1f79d2ce0f66bd8df39702acae2ee0529377dc81db5a36c
+  metadata.gz: a24fa114435be573b5b125dc7631052ba02e9b87c071d900aef8be5dd3c771e3
+  data.tar.gz: ae2e3189797eb7f737bf2e6f44502458dbf0567d69c8659a1adf18c5a7619a0b
 SHA512:
-  metadata.gz: 8ba04037ec33573dcfaf4b96459b8f108e04fff35b868b9388a200d566d64a54511312fb09f0521e2ac1cbcf42bfbdd7fa22357c8a6f2490204607cd8fd8b233
-  data.tar.gz: fe189c3594e4b19af00263cce356db8cb72a13a7739f5c4ebdf877e1c9d0551c6c71d59aa9629fe3e2cd8d7f8bc5a466cd18b3492acddf97fb089f505b6d6bf8
+  metadata.gz: e9b91105669be9f1b50129e3c347af9c7b9dc6adfd1d476d7c015005db0990927848956587961f16f6e3cd8a134edfc4cf4707ea720bd78423110d807e197e7e
+  data.tar.gz: c19cea532598c24f46e8743f6f5af524d087780730b19e1081cc0318dea0ec2a68757effdd440429384e17107abf714161f302f4d9daf90f861a7e0206029fd8

data/README.md

@@ -10,18 +10,85 @@
 
 Stolen git is well... you get it. I'm building a mini git clone to learn version control and get comfortable with ruby.
 
-## Commands
+## Usage
 
-| Command  | description                                                       | Flags                                                                                              |
-| -------- | ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
-| init     | Initialize the project                                            | N/A                                                                                                |
-| stage    | add a file or directory to be tracked                             | N/A                                                                                                |
-| commit   | Save the current tracked state                                    | `-n [--name]` <br> `-d [--description]`                                                            |
-| diff     | get the difference between working directory and the last commit  | N/A                                                                                                |
-| log      | print out commit history (limit print by a number `log <number>`) | N/A                                                                                                |
-| checkout | check a commit or a branch without loss in data                   | `-c [--commit] <commit_id>` to check out a commit instaed of a branch wihout changing HEAD pointer |
-| branch   | List all branches. (or creating a branch by `branch <name>`)      | N/A                                                                                                |
+| Command | description                                                       | Flags                                   |
+| ------- | ----------------------------------------------------------------- | --------------------------------------- |
+| init    | Initialize the project                                            | N/A                                     |
+| stage   | add a file or directory to be tracked                             | N/A                                     |
+| commit  | Save the current tracked state                                    | `-n [--name]` <br> `-d [--description]` |
+| diff    | get the difference between working directory and the last commit  | N/A                                     |
+| log     | print out commit history (limit print by a number `log <number>`) | N/A                                     |
 
-## Tech stack
+| reset | Reset to the last commit | N/A |
+| checkout | check a commit or a branch without loss in data | `-c [--commit] <commit_id>` to check out a commit instaed of a branch wihout changing HEAD pointer |
+| branch | List all branches. (or creating a branch by `branch <name>`) | N/A |
 
-Just ruby... (for now at least)
+## Installation
+
+1. Make sure you have Ruby installed on your system. You can check by running:
+
+   ```
+   ruby -v
+   ```
+
+   (If you don't have Ruby, visit [ruby-lang installation](https://www.ruby-lang.org/en/documentation/installation/) to get set up.)
+
+2. Install the Gem  
+   Run the following command in your terminal:
+
+   ```
+   gem install stg
+   ```
+
+Run `stg` to verify your installation
+
+## Examples
+
+> [!NOTE]
+> You have to initialize with `stg init` for any of the other commands to work
+
+- Initialization
+
+  ```
+  stg init
+  ```
+
+- Staging
+
+  ```
+  stg stage src/page.ts
+  ```
+
+- Committing
+
+  ```
+  stg commit -n "Adding main page"
+  ```
+
+- Logging all commits
+
+  ```
+  stg log
+  ```
+
+  Logging last 5 commits
+
+  ```
+  stg log 5
+  ```
+
+- Help
+
+  ```
+  stg
+  or
+  stg help
+  ```
+
+- Hard reset
+
+```
+
+stg
+```

data/lib/actions.rb

@@ -54,14 +54,16 @@ module Actions
   end
 
   def stage
-    files = ARGV
-    if files.empty?
-      puts 'Usage: stolen-git stage <files..>'
+    inp = ARGV
+
+    if inp.empty?
+      puts 'Usage: stg stage <directory/> <file.xy>'
       return
     end
 
     index = JSON.parse(File.read('.stolen-git/index.json'))
-    files.each do |file_path|
+
+    stage_file = lambda do |file_path|
       file_hash = get_file_hash(file_path)
       file_content = File.read(file_path)
 
@@ -75,6 +77,32 @@ module Actions
       index[file_path] ||= default_index_obj
       index[file_path]['hash'] = file_hash
     end
+
+    stage_directory = lambda do |dir_path|
+      Dir.children(dir_path).each do |entry|
+        path = File.join(dir_path, entry)
+        if File.file?(path)
+          stage_file.call(path)
+        else
+          stage_directory.call(path)
+        end
+      end
+    end
+
+    inp.each do |inp_path|
+      unless File.exist? inp_path
+        puts "#{inp_path} doesn't exist"
+        next
+      end
+
+      if File.file?(inp_path)
+        stage_file.call(inp_path)
+      elsif File.directory? inp_path
+        stage_directory.call(inp_path)
+      else
+        puts "Error logging #{inp_path}. It's neither a file or a directory"
+      end
+    end
     index = index.sort.to_h
     File.write('.stolen-git/index.json', JSON.pretty_generate(index))
   end
@@ -84,7 +112,7 @@ module Actions
 
     # Getting commit name & description
     OptionParser.new do |opts|
-      opts.banner = 'Usage: stolen-git commit [options]'
+      opts.banner = 'Usage: stg commit [options]'
 
       opts.on('-n', '--name NAME', 'Add a commit name') do |name|
         options[:name] = name
@@ -221,18 +249,22 @@ module Actions
     branch_id = pointer['point_to']
     branch_content = read_json(".stolen-git/branches/#{branch_id}.json")
     current_commit_hash = branch_content['commit_pointer']
-    parent_commit_hash = if !commit_id || commit_id.empty?
-                           read_json(".stolen-git/commits/#{current_commit_hash}.json")['parent_commit']
-                         else
-                           commit_history['commits'].find { |x| x['id'] == commit_id }['hash']
-                         end
-
-    if parent_commit_hash.empty?
-      puts "The current commit is the earliest in the project. Can't reset behind that."
+
+    new_commit = if !commit_id || commit_id.empty?
+                   current_commit_hash
+                 else
+                   commit_history['commits'].find do |x|
+                     x['id'] == commit_id
+                   end['hash']
+                 end
+
+    if new_commit.empty?
+      puts "This commit doesn't exit"
       return
     end
-    revert_to_commit(parent_commit_hash)
-    branch_content['commit_pointer'] = parent_commit_hash
+
+    revert_to_commit(new_commit)
+    branch_content['commit_pointer'] = new_commit
     File.write(".stolen-git/branches/#{branch_id}.json", JSON.pretty_generate(branch_content))
   end
 
@@ -241,7 +273,7 @@ module Actions
 
     # Getting commit name & description
     OptionParser.new do |opts|
-      opts.banner = 'Usage: stolen-git checkout [options]'
+      opts.banner = 'Usage: stg checkout [options]'
 
       opts.on('-c', '--commit', 'Add a commit id instead') do
         options[:commit] = true

data/lib/stg.rb

@@ -1,47 +1,44 @@
 require_relative 'help'
 require_relative 'actions'
 
-command = ARGV.shift
-NAME = 'stolen-git'
-include Actions
-include Help
-case command
-when 'init'
-  p_initialize
-
-when 'commit'
-  commit
-
-when 'diff'
-  diff
-when 'test'
-  test
-
-when 'stage'
-  stage
-
-when 'check_router'
-  check_router
-when 'reset'
-  reset
-when 'log'
-  log
-
-when 'checkout'
-  checkout
-
-when 'branch'
-  branch
-
-when 'help'
-  puts print_usage
-  exit 1
-
-when nil
-  puts print_usage
-  exit 1
-
-else
-  puts "Unknown command: #{command}"
-  exit 1
+module Stg
+  class CLI
+    extend Actions
+    extend Help
+
+    def self.start
+      command = ARGV.shift
+      case command
+      when 'init'
+        p_initialize
+      when 'commit'
+        commit
+      when 'diff'
+        diff
+      when 'test'
+        test
+      when 'stage'
+        stage
+      when 'check_router'
+        check_router
+      when 'reset'
+        reset
+      when 'log'
+        log
+      when 'checkout'
+        checkout
+      when 'branch'
+        branch
+      when 'help'
+        puts print_usage
+        exit 1
+      when nil
+        puts print_usage
+        exit 1
+      else
+        puts "Unknown command: #{command}"
+        exit 1
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stg
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Amr ElTaweel
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-30 00:00:00.000000000 Z
+date: 2026-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize