gitXplorer 1.0.0

data/lib/git_xplorer.rb

@@ -0,0 +1,219 @@
+require "hilighter"
+require "scoobydoo"
+
+class GitXplorer
+    def absolute_path(path = nil)
+        path ||= ""
+        return "#{@cwd.join("/")}#{"/" if (!@cwd.empty?)}#{path}"
+    end
+    private :absolute_path
+
+    def cd(path = nil)
+        path ||= ""
+
+        # No path means go to top-level
+        @cwd.clear if (path.empty?)
+
+        target = @tree.get(absolute_path(path))
+        if (target.nil?)
+            raise GitXplorer::Error::NoFileOrDirectory.new(path)
+        elsif (!target.is_a?(GitXplorer::GitObject::Directory))
+            raise GitXplorer::Error::NotDirectory.new(path)
+        end
+
+        path.split("/"). each do |dir|
+            case dir
+            when "."
+                # Do nothing
+            when ".."
+                @cwd.delete_at(-1)
+            else
+                @cwd.push(dir)
+            end
+        end
+
+        # Return the target
+        return target
+    end
+
+    def exist?(path)
+        return @tree.exist?(absolute_path(path))
+    end
+
+    def get_completions(input)
+        return @tree.get_completions(absolute_path(input))
+    end
+
+    def get_filenames(dir = "", pattern = ".")
+        dir ||= ""
+        pattern ||= "."
+
+        found = %x(
+            git log --diff-filter=ACR --name-only --pretty=tformat: \
+            -- #{dir}
+        ).split("\n").map do |file|
+            file.gsub(/^#{dir}/, "")
+        end.select do |file|
+            file.match(/#{pattern}/)
+        end
+
+        return found
+    end
+
+    def git(args, refresh = true)
+        if (args.match(/.*;.*/))
+            raise GitXplorer::Error::NoSemicolonsAllowed.new
+        end
+
+        if (args.match(/(\$|<)\(.+\)/))
+            raise GitXplorer::Error::NoSubshellsAllowed.new
+        end
+
+        if (args.match(/\&\&|\|\|/))
+            raise GitXplorer::Error::NoChainingAllowed.new
+        end
+
+        out = %x(git #{args})
+        refresh = true if (refresh.nil?)
+        @tree = refresh_tree if (refresh)
+        return out
+    end
+
+    def initialize
+        @cwd = Array.new
+        @repo = %x(git rev-parse --show-toplevel).split("/")[-1].strip
+        @tree = refresh_tree
+    end
+
+    def ls(path = nil)
+        path = absolute_path(path)
+
+        # Get target directory if it exists
+        target = @tree.get(path)
+        if (target.nil?)
+            raise GitXplorer::Error::NoFileOrDirectory.new(path)
+        end
+
+        return target.children
+    end
+
+    def pwd
+        # Return repo name if at top-level
+        return @repo if (@cwd.empty?)
+
+        # Return repo name followed by CWD
+        return "#{@repo}/#{@cwd.join("/")}#{"/" if (!@cwd.empty?)}"
+    end
+
+    def pwd_short
+        # Return repo name if at top-level
+        return @repo if (@cwd.empty?)
+
+        # Return only the last 3 directories if more than 3 deep
+        return @cwd[-3..-1].join("/") if (@cwd.length >= 3)
+
+        # Return repo name followed by CWD
+        return "#{@repo}/#{@cwd.join("/")}#{"/" if (!@cwd.empty?)}"
+    end
+
+    def refresh_tree
+        # Create tree root
+        tree = GitXplorer::GitObject::Directory.new("/", nil)
+
+        # Add files to tree
+        get_filenames.sort do |a, b|
+            a.downcase <=> b.downcase
+        end.each do |path|
+            tree.add(path)
+        end
+
+        # Return the tree
+        return tree
+    end
+    private :refresh_tree
+
+    def search(dir = "", pattern = ".")
+        dir ||= ""
+        pattern ||= "."
+
+        found = %x(
+            git grep -HIinP "#{pattern}" $(git rev-list --all) -- \
+            #{dir}
+        ).split("\n").map do |line|
+            line.gsub(
+                /^([^:]+):([^:]+):(\d+):(.*)$/,
+                "\\2:\\1:\\3:\\4"
+            )
+        end
+
+        return found
+    end
+
+    def show(file)
+        # Check if file exists
+        if (!exist?(file))
+            raise GitXplorer::Error::NoFileOrDirectory.new(file)
+        end
+
+        file, _, rev = absolute_path(file).partition(":")
+
+        # Get target and ensure it's a file
+        target = @tree.get(file)
+        if (!target.is_a?(GitXplorer::GitObject::File))
+            raise GitXplorer::Error::NotFile.new(file)
+        end
+
+        # If revision was specified, ensure it exists
+        if (!rev.empty? && !target.has_child?(rev))
+            raise GitXplorer::Error::InvalidRevision.new(rev)
+        end
+
+        # Default to newest revision
+        rev = target.newest.name if (rev.empty?)
+
+        system("git --no-pager show #{rev}:#{file}")
+    end
+
+    def vim(file, readonly = false)
+        # Check if file exists
+        if (!exist?(file))
+            raise GitXplorer::Error::NoFileOrDirectory.new(file)
+        end
+
+        file, _, rev = absolute_path(file).partition(":")
+
+        # Get target and ensure it's a file
+        target = @tree.get(file)
+        if (!target.is_a?(GitXplorer::GitObject::File))
+            raise GitXplorer::Error::NotFile.new(file)
+        end
+
+        # If revision was specified, ensure it exists
+        if (!rev.empty? && !target.has_child?(rev))
+            raise GitXplorer::Error::InvalidRevision.new(rev)
+        end
+
+        # Default to newest revision
+        rev = target.newest.name if (rev.empty?)
+
+        op = nil
+        op = "vi" if (ScoobyDoo.where_are_you("vi"))
+        op = "vim" if (ScoobyDoo.where_are_you("vim"))
+
+        readonly ||= false
+        if (readonly && op.nil?)
+            system("git show #{rev}:#{file}")
+        else
+            name = "/tmp/gitXplorer_"
+            name += File.read("/dev/urandom", 4).unpack("H*").join
+            File.open(name, "w") do |f|
+                f.write(%x(git show #{rev}:#{file}))
+            end
+            system("#{op}#{" -R" if (readonly)} #{name}")
+            FileUtils.rm_f(name)
+        end
+    end
+end
+
+require "git_xplorer/error"
+require "git_xplorer/git_object"

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: gitXplorer
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Miles Whittaker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.2
+- !ruby/object:Gem::Dependency
+  name: djinni
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.4
+- !ruby/object:Gem::Dependency
+  name: hilighter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+- !ruby/object:Gem::Dependency
+  name: scoobydoo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+description: GitXplorer will start a shell-like session that simulates a filesystem.
+  Easily navigate through directories and browse all files across all revisions.
+email: mjwhitta@gmail.com
+executables:
+- gitX
+- gitx
+- gitXplorer
+- gitxplorer
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/gitX
+- bin/gitXplorer
+- bin/gitx
+- bin/gitxplorer
+- lib/git_xplorer.rb
+- lib/git_xplorer/error.rb
+- lib/git_xplorer/error/invalid_revision.rb
+- lib/git_xplorer/error/no_chaining_allowed.rb
+- lib/git_xplorer/error/no_file_or_directory.rb
+- lib/git_xplorer/error/no_semicolons_allowed.rb
+- lib/git_xplorer/error/no_subshells_allowed.rb
+- lib/git_xplorer/error/not_directory.rb
+- lib/git_xplorer/error/not_file.rb
+- lib/git_xplorer/git_object.rb
+- lib/git_xplorer/git_object/directory.rb
+- lib/git_xplorer/git_object/file.rb
+- lib/git_xplorer/git_object/revision.rb
+- lib/git_xplorer/wish/cat_wish.rb
+- lib/git_xplorer/wish/change_directory_wish.rb
+- lib/git_xplorer/wish/find_wish.rb
+- lib/git_xplorer/wish/git_wish.rb
+- lib/git_xplorer/wish/grep_wish.rb
+- lib/git_xplorer/wish/list_directory_wish.rb
+- lib/git_xplorer/wish/pwd_wish.rb
+- lib/git_xplorer/wish/vi_wish.rb
+homepage: https://gitlab.com/mjwhitta/gitXplorer
+licenses:
+- GPL-3.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Simulate a Linux shell to browse a git tree.
+test_files: []