git_fonky 1.1.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eccc8024d2a7647279b20745e3391b414b457c855d7c15aac9b266e477728129
-  data.tar.gz: c3070a7b5cf6cf91383f128d0005d672b3abd3c4e485a6b2b3d610d9435d1df6
+  metadata.gz: 3dc42a2c9f6a3f9c09b5e882e292535f541c4b90eec5475757a362a2826d874f
+  data.tar.gz: 67dd28ee616f0e3cd735b44c5d61b0ed6b20b89604a76d6204f704a3944e3868
 SHA512:
-  metadata.gz: 2b6970b50cf13f82a013a68ea477e44d0f482f8fa051297f6d6ea36b5eea5d78dad480d4ce924c1b006de643b7f7e10ecb30425e8e828a271c69690260496365
-  data.tar.gz: 31a75d1eff266a71b12923338d34316f15876526e70055f8ca997426c9fa79badb11c758ef15157bb6244223009f15da0020c7eca6ad5615ec636bc8476bc2f6
+  metadata.gz: 692d2868f54038afd4357ee2120e2da2bdf2956dc0ec8ceb9b80a0a669032d74df398222aeb8f33b959c371a2fe73a11a9200d6807476e28732b7faac75f204c
+  data.tar.gz: 0de8717d683e42418a763aa8192ea878c527db43ca7bb888829337cadbaecaa51fa25c074ace37610fd0a1ef10e6ba423225be118678c3842fc83d6ac980b74b

data/README.md

@@ -27,14 +27,16 @@ only by commas (NO SPACES!):
 export GFONK_REPOS="repo1,repo2,repo3"
 ```
 
-You can also specify a branch to use with a given repository. To specify the branch add a colon after the repository
-name followed by the name of the branch.
+You can also specify a branch, origin remote and fork remote to use with a given repository. To specify these add a colon after the repository
+name followed by the name of the branch, origin remote and fork remote.
 ```bash
-export GFONK_REPOS="repo1,repo2:main,repo3:staging"
+export GFONK_REPOS="repo1,repo2:main,repo3:staging:origin_remote:fork_remote"
 ```
 
-If you do not specify a branch for a repository then whatever the current branch is that you are on in a given
-repository directory is the branch that will be used to attempt to sync the repository between the remotes.
+If you do not specify a branch, origin remote or fork remote the following defaults will be used:
+default branch: `main`
+default origin remote: `origin`
+default fork remote: `fork`
 
 
 ### Running the fonk

data/lib/git_fonky/parser.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module GitFonky
+  class Parser
+    def self.parse_env
+      new.parse_gfonk_repos_env_var
+    rescue NoMethodError
+      warn "The $GFONK_REPOS environment variable is not properly set."
+      warn "Please set the variable to point to a string list of repository names separated only by commas (NO SPACES)."
+      warn "You can optionally specify the branch, origin remote and fork remote to use for a given repository by separating each with a colon."
+      warn "EXAMPLE:"
+      warn "export GFONK_REPOS='repo1,repo2:branch,repo3:branch_name:origin_remote_name:fork_remote_name'"
+      exit 1
+    end
+
+    def parse_gfonk_repos_env_var
+      keys = [:repo, :branch, :origin_remote, :fork_remote]
+
+      split_repo_details.each_with_index.to_h do |values, index|
+        [index, keys.zip(values).to_h]
+      end
+    end
+
+    private
+
+    def split_repo_details
+      ENV["GFONK_REPOS"].split(",").map do |repo|
+        repo.split(":")
+      end
+    end
+  end
+end

data/lib/git_fonky/reporter.rb

@@ -1,41 +1,42 @@
-require_relative "message_formatter"
+# frozen_string_literal: true
+
+require "colorize"
 
 module GitFonky
   class Reporter
-    def initialize(repo_name, branch_name, formatter = MessageFormatter)
-      @repo_name = repo_name
-      @branch_name = branch_name
-      @formatter = formatter.new
+    def initialize(repo, branch)
+      @repo = repo
+      @branch = branch
     end
 
     def announce_sync_attempt
-      msg = "Attempting to sync -> #{@repo_name} | #{@branch_name} branch"
-      @formatter.output_message(msg, heading: true, warning: false)
+      report("Attempting to sync -> #{@repo} | #{@branch} branch", heading: true)
     end
 
-    def announce(action, direction = "from", remote = "upstream")
-      msg = "-----> #{action.capitalize} #{direction} #{remote} #{@branch_name}"
-      @formatter.output_message(msg, warning: false)
+    def announce(action, direction, remote)
+      report("-----> #{action.capitalize} #{direction} #{remote} #{@branch}")
     end
 
     def announce_sync_success
-      msg = "-----> Successfully synced #{@repo_name} | #{@branch_name} branch"
-      @formatter.output_message(msg, warning: false)
+      report("-----> Successfully synced #{@repo} | #{@branch} branch")
     end
 
     def invalid_branch_msg
-      msg = "Failed to validate upstream #{@branch_name}."
-      @formatter.output_message(msg)
+      report("Failed to validate upstream #{@branch}.")
     end
 
     def failed_pull_msg
-      msg = "Failed to pull from upstream #{@branch_name}."
-      @formatter.output_message(msg)
+      "#{"WARNING".blink}: Failed to pull from upstream #{@branch}. Moving on to next repo.".yellow
     end
 
     def failed_push_msg
-      msg = "Failed to push to origin #{@branch_name}."
-      @formatter.output_message(msg)
+      "#{"WARNING".blink}: Failed to push to origin #{@branch}. Moving on to next repo.".yellow
+    end
+
+    private
+
+    def report(msg, heading: false)
+      puts heading ? msg.underline : msg.green
     end
   end
 end

data/lib/git_fonky/repository.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "open3"
+require_relative "reporter"
+
+module GitFonky
+  class Repository
+    def initialize(repo:, branch: "main", origin_remote: "origin", fork_remote: "fork", reporter: Reporter)
+      @repo = repo
+      @branch = branch
+      @origin_remote = origin_remote
+      @fork_remote = fork_remote
+      @reporter = reporter.new(@repo, @branch)
+    end
+
+    def sync
+      Dir.chdir(@repo.to_s) do
+        @reporter.announce_sync_attempt
+        attempt_pull
+        attempt_push
+        @reporter.announce_sync_success
+        true
+      rescue PullError, PushError => exception
+        warn exception.message
+        false
+      end
+    end
+
+    private
+
+    def attempt_pull
+      _stdout, stderr, status = Open3.capture3("git", "pull", @origin_remote, @branch)
+
+      if status.success?
+        @reporter.announce("pulled", "from", @origin_remote.to_s)
+      else
+        raise PullError, "#{@reporter.failed_pull_msg}\n#{stderr}".yellow
+      end
+    end
+
+    def attempt_push
+      _stdout, stderr, status = Open3.capture3("git", "push", @fork_remote, @branch)
+
+      if status.success?
+        @reporter.announce("pushed", "to", @fork_remote.to_s)
+      else
+        raise PushError, "#{@reporter.failed_push_msg}\n#{stderr}".yellow
+      end
+    end
+  end
+end

data/lib/git_fonky/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitFonky
-  VERSION = "1.1.1"
+  VERSION = "2.0.0"
 end

data/lib/git_fonky.rb

@@ -1,19 +1,22 @@
 # frozen_string_literal: true
 
-require "colorize"
 require_relative "git_fonky/version"
-require_relative "git_fonky/repo_dir"
-require_relative "git_fonky/repositories"
+require_relative "git_fonky/repository"
+require_relative "git_fonky/parser"
 
 module GitFonky
   class Error < StandardError; end
 
+  class PullError < Error; end
+
+  class PushError < Error; end
+
   GFONK_DIR = ENV["GFONK_DIR"] || "#{Dir.home}/code"
 
   def self.sync_repos
     Dir.chdir(GFONK_DIR) do
-      Repositories.parse_env.each do |repo_name, branch_name|
-        RepoDir.sync(repo_name, branch_name)
+      Parser.parse_env.values.each do |repo_config|
+        Repository.new(**repo_config.compact!).sync
         puts "\n" * 3
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git_fonky
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Collin Jilbert
@@ -33,20 +33,16 @@ extra_rdoc_files: []
 files:
 - ".standard.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/gfonk
 - git_fonky.gemspec
 - lib/git_fonky.rb
-- lib/git_fonky/command.rb
-- lib/git_fonky/message_formatter.rb
-- lib/git_fonky/repo_dir.rb
+- lib/git_fonky/parser.rb
 - lib/git_fonky/reporter.rb
-- lib/git_fonky/repositories.rb
+- lib/git_fonky/repository.rb
 - lib/git_fonky/version.rb
-- sig/git_fonky.rbs
 homepage: https://github.com/cjilbert504/git_fonky
 licenses:
 - MIT

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at cjilbert504@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/lib/git_fonky/command.rb

@@ -1,25 +0,0 @@
-module GitFonky
-  class Command
-    attr_writer :branch_name
-
-    def initialize(branch_name = nil)
-      @branch_name = branch_name
-    end
-
-    def current_branch
-      `git branch --show-current`.strip
-    end
-
-    def fetch_upstream
-      `git fetch upstream #{@branch_name} 2>&1`
-    end
-
-    def pull_upstream
-      `git pull upstream #{@branch_name} 2>&1`
-    end
-
-    def push_to_origin
-      `git push origin #{@branch_name} 2>&1`
-    end
-  end
-end

data/lib/git_fonky/message_formatter.rb

@@ -1,27 +0,0 @@
-module GitFonky
-  class MessageFormatter
-    def output_message(msg, heading: false, warning: true)
-      warn build_message(msg, heading: heading, warning: warning)
-    end
-
-    private
-
-    def warning_header
-      "WARNING: ".blink
-    end
-
-    def warning_footer
-      " Moving on to next repo."
-    end
-
-    def build_message(msg, heading:, warning:)
-      if warning
-        (warning_header + msg + warning_footer).yellow
-      elsif heading
-        msg.underline
-      else
-        msg.green
-      end
-    end
-  end
-end

data/lib/git_fonky/repo_dir.rb

@@ -1,57 +0,0 @@
-require_relative "command"
-require_relative "reporter"
-
-module GitFonky
-  class RepoDir
-    def initialize(repo_name = nil, branch = nil, command: Command, reporter: Reporter)
-      @repo_name = repo_name
-      @command = command.new
-      @branch = branch || get_current_branch
-      @command.branch_name = @branch
-      @reporter = reporter.new(@repo_name, @branch)
-    end
-
-    def self.sync(repo_name, branch_name)
-      Dir.chdir(repo_name.to_s) do
-        new(repo_name, branch_name).sync
-      end
-    end
-
-    def sync
-      catch(:skip_repo) do
-        announce_sync_attempt
-        pull
-        push
-        announce_sync_success
-      end
-    end
-
-    private
-
-    def get_current_branch
-      @command.current_branch
-    end
-
-    def announce_sync_attempt
-      @reporter.announce_sync_attempt
-    end
-
-    def pull
-      @command.pull_upstream
-      process_successful? ? @reporter.announce("pulled") : throw(:skip_repo, @reporter.failed_pull_msg)
-    end
-
-    def push
-      @command.push_to_origin
-      process_successful? ? @reporter.announce("pushed", "to", "origin") : throw(:skip_repo, @reporter.failed_push_msg)
-    end
-
-    def announce_sync_success
-      @reporter.announce_sync_success
-    end
-
-    def process_successful?
-      $?.success?
-    end
-  end
-end

data/lib/git_fonky/repositories.rb

@@ -1,24 +0,0 @@
-module GitFonky
-  class Repositories
-    def self.parse_env
-      new.parse_gfonk_repos_env_var
-    rescue NoMethodError
-      warn "The $GFONK_REPOS environment variable is not properly set."
-      warn "Please set the variable to point to a string list of repository names separated only by commas (NO SPACES)."
-      warn "You can optionally specify the branch name to use for a given repository by separating the repository and branch names with a colon."
-      warn "EXAMPLE:"
-      warn "export GFONK_REPOS='repo1,repo2,repo3:branch_name'"
-      exit 1
-    end
-
-    def parse_gfonk_repos_env_var
-      ENV["GFONK_REPOS"].split(",").map { |repo_config| repo_config.split(":") }.map do |repo_name, branch_name|
-        if branch_name.nil?
-          [repo_name.to_sym, nil]
-        else
-          [repo_name.to_sym, branch_name]
-        end
-      end.to_h
-    end
-  end
-end

data/sig/git_fonky.rbs

@@ -1,4 +0,0 @@
-module GitFonky
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end