files_in_my_diff 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f67804ba5d277fa3cfcf033a7b3be597e4ca42c8622f6ddd86524791d4093d67
+  data.tar.gz: 91e13197b9b629379d1dc371cab25da159070f014610a0f07e7e9ce740fef679
+SHA512:
+  metadata.gz: 65db1f926f08f2e6c6513b27429988d8a6c8c55092c20b5e357e34e67db451db0eb92eeeba751cdd1ebc4ab2c2d9438785ddab6946565d138e9ca6cef545ebac
+  data.tar.gz: b35919945391ba62a8857e7ca20140861f81847f6f626245468570c7094d388bb5398027d60de2ebbe722ddb5c6f56bfe7f5561eea4201bd7c29e39099396f24

data/.rubocop.yml

@@ -0,0 +1,30 @@
+
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.2
+  NewCops: enable
+  
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/ModuleFunction:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArguments:
+  Enabled: true
+  EnforcedStyleForMultiline: consistent_comma

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [1.0.0] - 2024-11-09
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Erik T. Madsen
+
+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 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.

data/README.md

@@ -0,0 +1,45 @@
+# FilesInMyDiff
+
+A command line tool that takes a git repository path and revision as input. It creates a temporary worktree, checks out the specified revision, and returns a JSON object containing the worktree path, commit SHA, and list of changed files. The tool helps you inspect changes in any git revision without affecting your current working directory.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+CLI usage as described by the help message:
+```
+Usage: files_in_my_diff <folder> <revision>
+
+folder   - Path to git repository
+revision - Git revision (branch, tag, or commit SHA)
+```
+
+If you wish to invoke the logic programmatically, you can use the method `FilesInMyDiff.checkout(folder: <repository path>, revision: <git revision>)`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/beatmadsen/files_in_my_diff.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'minitest/test_task'
+
+Minitest::TestTask.create
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+# auto-correct rubocop offenses
+task default: %i[test rubocop:autocorrect]

data/bin/files_in_my_diff

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+folder = ARGV[0]
+revision = ARGV[1]
+
+if folder.nil? || folder == '--help' || revision.nil?
+  puts 'Usage: files_in_my_diff <folder> <revision>'
+  puts
+  puts 'folder   - Path to git repository'
+  puts 'revision - Git revision (branch, tag, or commit SHA)'
+  exit 1
+end
+
+require 'bundler/setup'
+require 'setup_git'
+require 'files_in_my_diff'
+require 'json'
+
+begin
+  decorated = FilesInMyDiff.checkout(folder:, revision:)
+  puts decorated.to_json
+rescue FilesInMyDiff::Error => e
+  puts e.message
+  exit 1
+end

data/lib/files_in_my_diff/git/adapter.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module FilesInMyDiff
+  module Git
+    class Adapter
+      def initialize(folder:, repo: ::Git.open(folder))
+        @repo = repo
+      end
+
+      def diff(revision)
+        Diff.new(object: object(revision), revision:)
+      end
+
+      def checkout_worktree(path, revision)
+        @repo.add_worktree(path, revision)
+      rescue ::Git::FailedError => e
+        unless e.result.stderr.include? 'already exists'
+          raise CheckoutError,
+                "Could not checkout #{revision} to #{path}: #{e.message}"
+        end
+      end
+
+      private
+
+      def object(revision)
+        if revision.is_a?(::Git::Object::AbstractObject)
+          @repo.object(revision.sha)
+        else
+          @repo.object(revision)
+        end
+      rescue ::Git::FailedError
+        nil
+      end
+    end
+  end
+end

data/lib/files_in_my_diff/git/diff.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module FilesInMyDiff
+  module Git
+    class Diff
+      def initialize(object:, revision:)
+        @object = object
+        @revision = revision
+      end
+
+      def validate!
+        raise ValidationError, "Revision #{@revision} does not exist" if @object.nil?
+      end
+
+      def sha
+        @object.sha
+      end
+
+      def changes
+        parent = @object.parents.first
+        return [] if parent.nil?
+
+        parent.diff(@object).map do |change|
+          { path: change.path, type: change.type }
+        end
+      end
+    end
+  end
+end

data/lib/files_in_my_diff/git.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'git/adapter'
+require_relative 'git/diff'
+
+module FilesInMyDiff
+  module Git
+    class DiffError < Error; end
+    class CheckoutError < Error; end
+  end
+end

data/lib/files_in_my_diff/resolver.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module FilesInMyDiff
+  class Resolver
+    def initialize(folder:, revision:, file_strategy: TmpDir::FileStrategy, git_strategy: nil)
+      @folder = folder
+      @revision = revision
+      @file_strategy = file_strategy
+      @git_strategy = git_strategy
+    end
+
+    def call
+      validate_folder!
+      diff = git_strategy.diff(@revision)
+      diff.validate!
+      rd = @file_strategy.revision_dir(diff.sha)
+      rd.create!
+      git_strategy.checkout_worktree(rd.dir, diff.sha)
+      rd.decorate(diff.changes)
+    end
+
+    private
+
+    def validate_folder!
+      raise ValidationError, 'Folder is required' if @folder.nil?
+      raise ValidationError, "Folder '#{@folder}' does not exist" unless @file_strategy.dir_exists?(@folder)
+    end
+
+    def git_strategy
+      @git_strategy ||= Git::Adapter.new(folder: @folder)
+    end
+  end
+end

data/lib/files_in_my_diff/tmp_dir/file_strategy.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module FilesInMyDiff
+  module TmpDir
+    module FileStrategy
+      def self.dir_exists?(folder)
+        Dir.exist?(folder)
+      end
+
+      def self.tmpdir
+        Dir.tmpdir
+      rescue StandardError => e
+        raise DirectoryError, "Failed to locate tmpdir: #{e.message}"
+      end
+
+      def self.mkdir_p(path)
+        FileUtils.mkdir_p(path)
+      rescue SystemCallError => e
+        raise DirectoryError, "Failed to create tmp dir for #{path}: #{e.message}"
+      end
+
+      def self.revision_dir(sha)
+        RevisionDir.new(sha:)
+      end
+    end
+  end
+end

data/lib/files_in_my_diff/tmp_dir/revision_dir.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module FilesInMyDiff
+  module TmpDir
+    class RevisionDir
+      attr_reader :dir
+
+      def initialize(sha:, file_strategy: FileStrategy)
+        @sha = sha
+        @file_strategy = file_strategy
+      end
+
+      def create!
+        tmpdir = @file_strategy.tmpdir
+        @dir = File.join(tmpdir, 'files_in_my_diff', @sha)
+        @file_strategy.mkdir_p(@dir)
+      end
+
+      def decorate(changes)
+        raise DirectoryError, "Directory for #{@sha} not yet created" if @dir.nil?
+
+        d_changes = changes.map do |change|
+          change => { path:, type: }
+          { full_path: full_path(path), relative_path: path, type: }
+        end
+        { dir: @dir, sha: @sha, changes: d_changes }
+      end
+
+      private
+
+      def full_path(relative_path)
+        File.join(@dir, relative_path)
+      rescue StandardError => e
+        raise FileError, "Failed to create full path for #{relative_path}: #{e.message}"
+      end
+    end
+  end
+end

data/lib/files_in_my_diff/tmp_dir.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'tmp_dir/revision_dir'
+require_relative 'tmp_dir/file_strategy'
+
+module FilesInMyDiff
+  module TmpDir
+    class DirectoryError < FilesInMyDiff::Error; end
+    class FileError < FilesInMyDiff::Error; end
+  end
+end

data/lib/files_in_my_diff/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module FilesInMyDiff
+  VERSION = '1.0.0'
+end

data/lib/files_in_my_diff.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module FilesInMyDiff
+  class Error < StandardError; end
+  class ValidationError < Error; end
+end
+
+require_relative 'files_in_my_diff/version'
+require_relative 'files_in_my_diff/tmp_dir'
+require_relative 'files_in_my_diff/git'
+require_relative 'files_in_my_diff/resolver'
+
+module FilesInMyDiff
+  def self.root
+    File.expand_path('..', __dir__)
+  end
+
+  def self.checkout(folder:, revision:)
+    Resolver.new(folder:, revision:).call
+  end
+end

data/lib/setup_git.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'git'
+
+module Git
+  class Base
+    def add_worktree(path, revision)
+      lib.send(:command, 'worktree', 'add', path, revision)
+    end
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: files_in_my_diff
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Erik T. Madsen
+bindir: bin
+cert_chain: []
+date: 2024-11-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: A command line tool that takes a git repository path and revision as
+  input. It creates a temporary worktree, checks out the specified revision, and returns
+  a JSON object containing the worktree path, commit SHA, and list of changed files.
+  The tool helps you inspect changes in any git revision without affecting your current
+  working directory.
+email:
+- beatmadsen@gmail.com
+executables:
+- files_in_my_diff
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO
+- bin/files_in_my_diff
+- lib/files_in_my_diff.rb
+- lib/files_in_my_diff/git.rb
+- lib/files_in_my_diff/git/adapter.rb
+- lib/files_in_my_diff/git/diff.rb
+- lib/files_in_my_diff/resolver.rb
+- lib/files_in_my_diff/tmp_dir.rb
+- lib/files_in_my_diff/tmp_dir/file_strategy.rb
+- lib/files_in_my_diff/tmp_dir/revision_dir.rb
+- lib/files_in_my_diff/version.rb
+- lib/setup_git.rb
+homepage: https://github.com/beatmadsen/files-in-my-diff
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/beatmadsen/files-in-my-diff
+  source_code_uri: https://github.com/beatmadsen/files-in-my-diff
+  changelog_uri: https://github.com/beatmadsen/files-in-my-diff/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.0.dev
+specification_version: 4
+summary: Checks out a git revision in a new worktree and provides you the changed
+  files
+test_files: []