gitflash 0.1.2.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3e2ab919eb4408a42c7bbd519e063a8f749e5c76802f078a410934bd6bf0faec
+  data.tar.gz: e821bb291632e98b292a0b6df49ede8836566904342026e9aa6693c8a0367ca6
+SHA512:
+  metadata.gz: 5f855639bd9cee9d4761198e37e86a5b76e3ce6641a35be10602aaeb2698524aedf6c0fb4df761f3fcb3e306629ced9816586c8f5c0adea7e9acdcacca3636f5
+  data.tar.gz: 8a90c367cea30c5bbc242bb73eced1907e773a6e6cbad0d3673f4cf07a27bbcc1c972256d60eafde834cdc1134de2fcc3142ee2c4c8d7aad1faaa7e2c1dfa48d

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Kleanthismits
+
+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,48 @@
+# GitFlash
+
+[![Gem Version](https://badge.fury.io/rb/gitflash.svg)](https://badge.fury.io/rb/gitflash)
+
+⚠️ **This project is stil under development**: Use at your own risk!
+
+This gem allows you to use some of the most common git commands in a more user intuitive way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gitflash'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install gitflash
+
+## Requirements
+
+This gem requires Ruby 2.7+.
+## Usage
+
+Run `gitflash` to get a list with the available commands and their description.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/git_flash. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/git_flash/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the GitFlash project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/git_flash/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'gitflash'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/gitflash

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby -wU
+
+require 'gitflash'
+require 'gitflash/cli'
+
+Gitflash::Cli.start(ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/gitflash/cli.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+require 'thor'
+
+module Gitflash
+  class Cli < Thor
+    def self.exit_on_failure?
+      true
+    end
+
+    desc 'checkout', 'Checkout the selected branch'
+    long_desc <<-TEXT
+
+    Presents a list with all the available local branches.
+
+    You can use the arrow keys to navigate through the branches.
+    Type for quick searching a specific branch.
+    Press `enter` to choose and checkout the branch.
+    Press `ctrl+c` to cancel the operation.
+    TEXT
+
+    def checkout
+      branches? ? checkout_branch : prompt.ok('You only have one branch!')
+    end
+
+    desc 'delete', 'Delete the selected branches'
+    long_desc <<-TEXT
+
+    Presents a list with all the available local branches(without current or main/master).
+
+    You can use the arrow keys to navigate through the branches.
+    Type for quick searching a specific branch.
+    Press `space` to choose multiple branches.
+    Press `enter` to confirm selection and delete branches.
+    Press `ctrl+c` to cancel the operation.
+
+    WARNING: The branches will be deleted even if they have unmerged changes!!
+    TEXT
+
+    def delete
+      branches? ? delete_branch : prompt.ok('You only have one branch!')
+    end
+
+    private
+
+    def checkout_branch
+      selection = prompt.select(
+        'Select a branch to checkout',
+        branches,
+        **checkout_options
+      )
+
+      git.checkout(selection)
+    end
+
+    def delete_branch
+      selection = prompt.multi_select(
+        'Select branches to delete',
+        branches(options: { master: false, current: false })
+      )
+
+      prompt.warn(<<~TEXT
+        You are about to permanently delete the following branches even if they have unmerged changes:
+
+        #{selection.map { |br| "* #{br}" }.join("\n")}
+      TEXT
+                 )
+      answer = prompt.yes?('Do you want to proceed?')
+      puts answer ? git.delete(selection) : 'Exited'
+    end
+
+    def branches?
+      all_branches && all_branches.size > 1
+    end
+
+    def prompt
+      @prompt ||= Prompt.create
+    end
+
+    def checkout_options
+      {}.tap do |opt|
+        opt[:default] = current unless current.nil?
+      end
+    end
+
+    def branches(options: {})
+      git.local_branches(**options)
+    end
+
+    def all_branches
+      @all_branches ||= git.all_local_branches
+    end
+
+    def current
+      @current ||= git.current_branch
+    end
+
+    def git
+      Gitflash::Git::Wrapper
+    end
+  end
+end

data/lib/gitflash/git/bash_command.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Gitflash
+  module Git
+    class BashCommand
+      class << self
+        def exec(command)
+          `#{command}`
+        end
+
+        def system_exec(*args)
+          system(*args)
+        end
+      end
+    end
+  end
+end

data/lib/gitflash/git/wrapper.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+module Gitflash
+  module Git
+    class Wrapper
+      HIDDEN_BRANCHES = %w[–show-current].freeze
+
+      class << self
+        def local_branches(current: true, master: true)
+          formatted_branches.tap do |branches|
+            hidden_branches(current, master).each { |br| branches.delete(br) }
+          end
+        end
+
+        def all_local_branches
+          formatted_branches
+        end
+
+        def current_branch
+          bash.exec('git branch --show-current').strip
+        end
+
+        def checkout(branch)
+          bash.system_exec('git', 'checkout', branch)
+        end
+
+        def delete(selection)
+          bash.system_exec('git', 'branch', '-D', *selection)
+        end
+
+        private
+
+        def hidden_branches(current, master)
+          [].tap { |hb|
+            hb.push('master') unless master
+            hb.push('main') unless master
+            hb.push(current_branch) unless current
+          } + HIDDEN_BRANCHES
+        end
+
+        def formatted_branches
+          raw_branches.map do |str|
+            next str unless str.start_with?('* ')
+
+            str.gsub('* ', '')
+          end
+        end
+
+        def raw_branches
+          bash.exec('git branch').strip.split("\n").map(&:strip)
+        end
+
+        def bash
+          BashCommand
+        end
+      end
+    end
+  end
+end

data/lib/gitflash/prompt.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require 'tty-prompt'
+
+module Gitflash
+  # A wrapper class for TTY::Prompt gem
+  class Prompt < TTY::Prompt
+    class << self
+      def create(options: {})
+        new(options)
+      end
+    end
+
+    def initialize(options)
+      super(**default_create_options(options))
+    end
+
+    def select(message, collection, options = {})
+      super(message, collection, default_select_options(options))
+    end
+
+    def multi_select(message, collection, options = {})
+      super(message, collection, default_select_options(options))
+    end
+
+    private
+
+    attr_reader :prompt
+
+    def default_create_options(options)
+      {
+        interrupt: :exit,
+        quiet: true
+      }.merge(options)
+    end
+
+    def default_select_options(options)
+      {
+        cycle: true,
+        per_page: 50,
+        filter: true,
+        symbols: { marker: '>' }
+      }.merge(options)
+    end
+  end
+end

data/lib/gitflash/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Gitflash
+  VERSION = '0.1.2.alpha'
+end

data/lib/gitflash.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+# Suppress the zeitwerk warning for overriding :require method temporarily
+original_verbose = $VERBOSE
+$VERBOSE = nil
+
+require 'zeitwerk'
+require 'pry'
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+
+# Restore the original warning level
+$VERBOSE = original_verbose
+
+module Gitflash
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: gitflash
+version: !ruby/object:Gem::Version
+  version: 0.1.2.alpha
+platform: ruby
+authors:
+- Kleanthis Mitsioulis
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-11-04 00:00:00.000000000 Z
+dependencies: []
+description: This gem allows you to perform a number of git commands using interactive
+  cli prompts
+email:
+- kleanthismits@hotmail.gr
+executables:
+- gitflash
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- LICENSE
+- README.md
+- bin/console
+- bin/gitflash
+- bin/setup
+- lib/gitflash.rb
+- lib/gitflash/cli.rb
+- lib/gitflash/git/bash_command.rb
+- lib/gitflash/git/wrapper.rb
+- lib/gitflash/prompt.rb
+- lib/gitflash/version.rb
+homepage: https://github.com/Kleanthismits/git_flash
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Kleanthismits/git_flash
+  source_code_uri: https://github.com/Kleanthismits/git_flash
+  changelog_uri: https://github.com/Kleanthismits/git_flash/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Simplified usage of some git cli commands
+test_files: []