stg 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f993bbd2bd4575637beb24485c54a88a2679551000551df0f1b1a552249922f
-  data.tar.gz: cca41c04c1ab146a16055debbf6364081993d4afb647222865a219d88d9a40bb
+  metadata.gz: 1eb93a1f37a9ec874a195189c9047b322ef7eb823f2c4af4219dad4aba1bdcb0
+  data.tar.gz: 7795502739c3503dcc0fa241cecc65093c711eed608d633ef32813c96c0f4d80
 SHA512:
-  metadata.gz: 745cc975c54fc9e1449a514c711ca2a3ab98df951deb554b6e37de8f5e01ddbacf4e2001a20d0cd512d4ed5411291b4a213e0293928878b805ee5395acbd02c7
-  data.tar.gz: 9afe52e540571bd3330743229d8e267150d243a9e28a815a503841199979c1a156434ad07b4a4d828a3f5db042710a3a5756999c8bf525a10aafa17f3dd0ff26
+  metadata.gz: 60c435caaec0c696b269a1cd014a96539fa646eb6c204a9b53d67cb55dda4f2de16813202e3e1c6e5a3a12d774acf1c43cb26eb418c1817b03cca7d242b2aded
+  data.tar.gz: e1b69a714e519862c46d4264648504f3699b94fc7046f9900dbe780e36f3db8fa255cc9dfe40323b201bcb6f18ea7a8a0f01409b23724eedda67d7fa665e8d5e

data/README.md

@@ -12,17 +12,22 @@ Stolen git is well... you get it. I'm building a mini git clone to learn version
 
 ## 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                                     |
-
-| 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 |
+Run `stg init` once in a project before using the other commands. Stolen Git stores its data in `.stolen-git/` and tracks files through its own index.
+
+| Command                   | Description                                                                                                            | Options                                                |
+| ------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
+| `init`                    | Initialize `.stolen-git/` in the current directory.                                                                    | N/A                                                    |
+| `stage <file...>`         | Add files or directories to the Stolen Git index. Directories are staged recursively.                                  | N/A                                                    |
+| `commit`                  | Save the current indexed state as a commit.                                                                            | `-n, --name NAME` <br> `-d, --description DESCRIPTION` |
+| `diff`                    | Show differences between the working directory and the last commit.                                                    | N/A                                                    |
+| `log [limit]`             | Print commit history. Pass a limit to show only the latest entries.                                                    | N/A                                                    |
+| `reset [commit_id]`       | With no id, restore working files from the index. With an id, restore that commit and move the current branch pointer. | N/A                                                    |
+| `checkout <name>`         | Check out a branch by name.                                                                                            | N/A                                                    |
+| `checkout -c <commit_id>` | Check out a commit without moving the current branch pointer.                                                          | `-c, --commit`                                         |
+| `branch [name]`           | List all branches, or create a branch when a name is provided.                                                         | N/A                                                    |
+| `help`                    | Print the command list.                                                                                                | N/A                                                    |
+
+For more detail on staging, committing, and reset behavior, see [COMMANDS.md](COMMANDS.md).
 
 ## Installation
 
@@ -39,6 +44,9 @@ Stolen git is well... you get it. I'm building a mini git clone to learn version
 
    ```
    gem install stg
+
+   # you may need administrative permission, in this case
+   sudo gem install stg
    ```
 
 Run `stg` to verify your installation
@@ -48,47 +56,51 @@ Run `stg` to verify your installation
 > [!NOTE]
 > You have to initialize with `stg init` for any of the other commands to work
 
-- Initialization
-
-  ```
-  stg init
-  ```
+### Start a new project
 
-- Staging
-
-  ```
-  stg stage src/page.ts
-  ```
+```sh
+stg init
+stg stage .
+stg commit -n "Initial commit"
+```
 
-- Committing
+### Save a file change
 
-  ```
-  stg commit -n "Adding main page"
-  ```
+```sh
+stg stage lib/stg/actions.rb
+stg commit -n "Improve reset validation"
+```
 
-- Logging all commits
+### Inspect history
 
-  ```
-  stg log
-  ```
+```sh
+stg log # Show 5 logs and waits for user confirmation to continue
+stg log 3 # Shows last 3 commits in the branch and closes
+```
 
-  Logging last 5 commits
+### Discard unstaged working changes
 
-  ```
-  stg log 5
-  ```
+```sh
+stg stage README.md
+# edit README.md again
+stg reset
+```
 
-- Help
+`README.md` is restored to the version stored in the index (a.k.a last version of the file you staged).
 
-  ```
-  stg
-  or
-  stg help
-  ```
+### Reset to a previous commit
 
-- Hard reset
+> [!WARNING]
+> `stg reset <commit_id>` is destructive. It moves the branch pointer back and can make later Stolen Git commits unreachable. Use `stg checkout -c <commit_id>` if you only want to inspect an older commit.
 
+```sh
+stg log # shows all commits with commit_id next to the word commit in green
+stg reset <commit_id>
 ```
 
+### Help
+
+```sh
 stg
+stg help
 ```

data/lib/stg/actions.rb

@@ -96,11 +96,27 @@ module Actions
 
     index = read_json('.stolen-git/index.json')
     ignore = read_json('.stg-ignore')
-    stage_file = lambda do |file_path|
-      ignore&.each do |ignore_pattern|
-        return if File.fnmatch(ignore_pattern, file_path)
+    index.reject! { |key, _value| ignored_path?(key, ignore) }
+
+    path_in_directory = lambda do |path, dir_path|
+      dir_path == '.' || path == dir_path || path.start_with?("#{dir_path}/")
+    end
+
+    stage_deleted = lambda do |path|
+      path = clean_path(path)
+
+      index.keys.each do |indexed_path|
+        next unless indexed_path == path || path_in_directory.call(indexed_path, path)
+        next if File.exist?(indexed_path)
+
+        index.delete(indexed_path)
       end
+    end
+
+    stage_file = lambda do |file_path|
       file_path = clean_path(file_path)
+      return if ignored_path?(file_path, ignore)
+
       file_hash = get_file_hash(file_path)
       file_content = File.read(file_path)
 
@@ -117,6 +133,10 @@ module Actions
 
     stage_directory = lambda do |dir_path|
       dir_path = clean_path(dir_path)
+      return if ignored_path?(dir_path, ignore)
+
+      stage_deleted.call(dir_path)
+
       Dir.children(dir_path).each do |entry|
         next if entry == '.stolen-git'
 
@@ -132,7 +152,11 @@ module Actions
     inp.each do |inp_path|
       inp_path = clean_path(inp_path)
       unless File.exist? inp_path
-        puts "#{inp_path} doesn't exist"
+        if index.key?(inp_path) || index.keys.any? { |key| path_in_directory.call(key, inp_path) }
+          stage_deleted.call(inp_path)
+        else
+          puts "#{inp_path} doesn't exist"
+        end
         next
       end
 
@@ -182,6 +206,11 @@ module Actions
 
     # Get the index
     index = JSON.parse(File.read('.stolen-git/index.json'))
+    ignore = read_json('.stg-ignore')
+    original_index_size = index.length
+    index.reject! { |key, _value| ignored_path?(key, ignore) }
+    File.write('.stolen-git/index.json', JSON.pretty_generate(index)) if index.length != original_index_size
+
     tree_content = {
       entries: []
     }
@@ -213,7 +242,9 @@ module Actions
           commit_diff[key] = diff
         end
       else
-        parent_map = entries.to_h { |e| [e['path'], e['hash']] }
+        parent_map = entries
+                     .reject { |entry| ignored_path?(entry['path'], ignore) }
+                     .to_h { |e| [e['path'], e['hash']] }
 
         index.each do |key, value|
           key = clean_path(key)
@@ -321,9 +352,14 @@ module Actions
   end
 
   def reset
+    reset_usage = lambda do
+      puts 'Usage: stg reset <commit_id>'
+      puts "You can find commit_id by running 'stg log'"
+    end
+
     begin
       OptionParser.new do |opts|
-        opts.banner = 'Usage: stg reset [commit_id]'
+        opts.banner = 'Usage: stg reset <commit_id>'
 
         opts.on_tail('-h', '--help', 'Show this help') do
           puts opts
@@ -332,28 +368,30 @@ module Actions
       end.parse!
     rescue OptionParser::ParseError => e
       puts e.message
-      puts 'Usage: stg reset [commit_id]'
+      reset_usage.call
       puts '  -h, --help    Show this help'
       exit 1
     end
 
+    if ARGV.length > 1
+      reset_usage.call
+      return
+    end
+
     commit_id = ARGV.first
     commit_history = read_json('.stolen-git/commits.json')
     pointer = read_json('.stolen-git/pointer.json')
     branch_id = pointer['point_to']
     branch_content = read_json(".stolen-git/branches/#{branch_id}.json")
-    current_commit_hash = branch_content['commit_pointer']
-
-    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"
+    if commit_id.nil? || commit_id.empty?
+      revert_to_index
+      return
+    end
+
+    commit = commit_history['commits'].find { |x| x['id'] == commit_id }
+    new_commit = commit && commit['hash']
+    if new_commit.nil? || new_commit.empty?
+      reset_usage.call
       return
     end
 

data/lib/stg/differencing.rb

@@ -83,7 +83,8 @@ module DiffCalc
         deletion_seq[i2].push({ old_index: i1, ma_type: 'bs' })
         i1 += 1
       when :insert
-        insertion_seq[i2] = { value: @new_s[i2].encode('UTF-8', invalid: :replace, undef: :replace, replace: ''), old_index: i1 }
+        insertion_seq[i2] =
+          { value: @new_s[i2].encode('UTF-8', invalid: :replace, undef: :replace, replace: ''), old_index: i1 }
         i2 += 1
       end
     end

data/lib/stg/help.rb

@@ -5,14 +5,14 @@ module Help
   Commands:\n"
     commands_docs = {
       init: 'Initialize the project',
-      stage: 'add a file or directory to be tracked ',
-      commit: 'Save the current tracked state ',
-      diff: 'get the difference between working directory and the last commit ',
-      log: 'print out commit history',
-      reset: 'Revert to commit',
-      checkout: 'check a commit or a branch without loss in data',
-      branch: 'List all branches.',
-      help: 'show this list'
+      stage: 'Add files or directories to the index',
+      commit: 'Save the current indexed state',
+      diff: 'Show differences between the working directory and the last commit',
+      log: 'Print commit history',
+      reset: 'Restore from the index, or restore a commit when an id is provided',
+      checkout: 'Check out a branch, or a commit with -c',
+      branch: 'List branches, or create a branch when a name is provided',
+      help: 'Show this list'
     }
     max_len = 0
     commands_docs.each_key do |command|

data/lib/stg/utils.rb

@@ -50,22 +50,52 @@ module Utils
   def revert_to_commit(commit_hash)
     commit_content = read_json(".stolen-git/commits/#{commit_hash}.json")
     commit_tree = read_json(".stolen-git/storage/trees/#{commit_content['tree_hash']}.json")
+    current_index = read_json('.stolen-git/index.json') || {}
     index = {}
+
     commit_tree['entries'].each do |entry|
       blob = File.read(".stolen-git/storage/blobs/#{entry['hash']}")
       # TODO: Figure out what to do when path changes
+      dir = File.dirname(entry['path'])
+      FileUtils.mkdir_p(dir) unless dir == '.'
       File.write(entry['path'], blob)
       index[entry['path']] ||= {}
       index[entry['path']]['hash'] = entry['hash']
     end
 
+    (current_index.keys - index.keys).each do |path|
+      FileUtils.rm_f(path)
+    end
+
     File.write('.stolen-git/index.json', JSON.pretty_generate(index))
   end
 
+  def revert_to_index
+    index = read_json('.stolen-git/index.json') || {}
+
+    index.each do |path, entry|
+      blob = File.read(".stolen-git/storage/blobs/#{entry['hash']}")
+      File.write(path, blob)
+    end
+  end
+
   def clean_path(path)
     Pathname.new(path).cleanpath.to_s
   end
 
+  def ignored_path?(path, ignore_patterns)
+    path = clean_path(path)
+    return false if path == '.'
+
+    path_as_dir = path.end_with?('/') ? path : "#{path}/"
+
+    ignore_patterns&.any? do |pattern|
+      File.fnmatch(pattern, path) ||
+        File.fnmatch(pattern, path_as_dir) ||
+        (pattern.end_with?('/') && File.fnmatch("#{pattern}**", path))
+    end
+  end
+
   def check_program_exists
     return true if File.exist? '.stolen-git'
 

data/lib/stg/version.rb

@@ -1,3 +1,3 @@
 module Stg
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stg
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Amr ElTaweel