git_fonky 1.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e688a3ce844aecf4af83b0850e10e82d3f50aa127f66f0b73bfcd969887f9c67
-  data.tar.gz: bf65a0369992d28e5fe62c05f72a1ab0f086e93af7eab5219ab55f3e9dd69aa5
+  metadata.gz: 0deef2f35a250276eb51333666b35228b724a4e521165688d615348b08940add
+  data.tar.gz: d63a6a52ae1b19d21b7db78aace3c800a8cfb943b63b0edbf882afec9aa63084
 SHA512:
-  metadata.gz: f51ff47b202cfafa08de450730d7e5e9d97bba9d81a64ab363da2ab7ac14d694620576be7c0ac3889d700ce937604e36667e7a1211a979c73f675c2e64016c66
-  data.tar.gz: ae6856b4ef69e6936752c1667810de703e5ef2b3a814db3de370e951ac446b1ba77048b1500b6cc9d61794cca2cfbb78ba3f4c2e40fa326d8cf36ead24e79e8c
+  metadata.gz: 1a6f0aee6c476ae13227af2f4157794511a1bc9ff18a0071f73176eb19f0c04bbbcb7a7a3cf4c5495bc49844bd64abc9a6913fbd1185248a30704fcf68105d7f
+  data.tar.gz: 54711e1932255d1eb6db2cf1c8c25cf96ed217ea6f49a09a7fca046cb37c12a24d31cd91b3a356fb6941fd257ae571f5fe5aa7ade9cf4a7354cdc84994b0f806

data/README.md

@@ -27,6 +27,15 @@ 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.
+```bash
+export GFONK_REPOS="repo1,repo2:main,repo3:staging"
+```
+
+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.
+
 ## 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.

data/bin/gfonk

@@ -2,4 +2,4 @@
 
 require "git_fonky"
 
-GitFonky.sync_repos
+GitFonky.sync_repos

data/git_fonky.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "colorize", "~> 1.1"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/git_fonky/command.rb

@@ -1,6 +1,6 @@
 module GitFonky
   class Command
-    attr_accessor :branch_name
+    attr_writer :branch_name
 
     def initialize(branch_name = nil)
       @branch_name = branch_name
@@ -11,15 +11,15 @@ module GitFonky
     end
 
     def fetch_upstream
-      `git fetch upstream #{branch_name} 2>&1`
+      `git fetch upstream #{@branch_name} 2>&1`
     end
 
     def pull_upstream
-      `git pull upstream #{branch_name} 2>&1`
+      `git pull upstream #{@branch_name} 2>&1`
     end
 
     def push_to_origin
-      `git push origin #{branch_name} 2>&1`
+      `git push origin #{@branch_name} 2>&1`
     end
   end
 end

data/lib/git_fonky/message_formatter.rb

@@ -1,26 +1,27 @@
 module GitFonky
   class MessageFormatter
-    def message_with_border(**params)
-      border = calculate_border_for(params[:msg], params.delete(:border_char) { "*" })
-      output_border_and_msg(border: border, **params)
+    def output_message(msg, heading: false, warning: true)
+      warn build_message(msg, heading: heading, warning: warning)
     end
 
     private
 
-    def calculate_border_for(msg, border_char)
-      border_char * (msg.length + 20)
+    def warning_header
+      "WARNING: ".blink
     end
 
-    def output_border_and_msg(border:, msg:, sub_msg: nil, io_stream: STDERR, warn: true)
-      io_stream.puts border
-      io_stream.puts warning_header.center(border.length) if warn
-      io_stream.puts msg.center(border.length)
-      io_stream.puts sub_msg.center(border.length) if sub_msg
-      io_stream.puts border
+    def warning_footer
+      " Moving on to next repo."
     end
 
-    def warning_header
-      "WARNING"
+    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,29 +1,25 @@
-require_relative "branch"
 require_relative "command"
 require_relative "reporter"
 
 module GitFonky
   class RepoDir
-    attr_reader :branch, :command, :dirname, :reporter
-
-    def initialize(dirname, command = Command, branch = Branch, reporter = Reporter)
-      @dirname = dirname
+    def initialize(repo_name: nil, branch: nil, command: Command, reporter: Reporter)
+      @repo_name = repo_name
       @command = command.new
-      @branch = branch.new(@command.current_branch)
-      @command.branch_name = @branch.name
-      @reporter = reporter.new(@dirname, @branch.name)
+      @branch = branch || get_current_branch
+      @command.branch_name = @branch
+      @reporter = reporter.new(@repo_name, @branch)
     end
 
-    def self.sync(dirname)
-      Dir.chdir(dirname) do
-        new(dirname).sync
+    def self.sync(repo_name:, branch_name:)
+      Dir.chdir(repo_name.to_s) do
+        new(repo_name: repo_name, branch: branch_name).sync
       end
     end
 
     def sync
       catch(:skip_repo) do
         announce_sync_attempt
-        fetch
         pull
         push
         announce_sync_success
@@ -32,27 +28,26 @@ module GitFonky
 
     private
 
-    def announce_sync_attempt
-      branch.valid? ? reporter.announce_sync_attempt : throw(:skip_repo, reporter.invalid_branch_msg)
+    def get_current_branch
+      @command.current_branch
     end
 
-    def fetch
-      command.fetch_upstream
-      process_successful? ? reporter.announce("fetched") : throw(:skip_repo, reporter.failed_fetch_msg)
+    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)
+      @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)
+      @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
+      @reporter.announce_sync_success
     end
 
     def process_successful?

data/lib/git_fonky/reporter.rb

@@ -1,51 +1,41 @@
 require_relative "message_formatter"
+
 module GitFonky
   class Reporter
-    attr_reader :formatter, :repo_name, :repo_branch
-
-    def initialize(repo_name, repo_branch, formatter = MessageFormatter)
+    def initialize(repo_name, branch_name, formatter = MessageFormatter)
       @repo_name = repo_name
-      @repo_branch = repo_branch
+      @branch_name = branch_name
       @formatter = formatter.new
     end
 
-    def announce(action, direction = "from", remote = "upstream")
-      STDERR.puts "-----> #{action} #{direction} #{remote} #{repo_branch}"
+    def announce_sync_attempt
+      msg = "Attempting to sync -> #{@repo_name} | #{@branch_name} branch"
+      @formatter.output_message(msg, heading: true, warning: false)
     end
 
-    def announce_sync_success
-      puts "-----> Successfully synced #{repo_name} | #{repo_branch} branch"
+    def announce(action, direction = "from", remote = "upstream")
+      msg = "-----> #{action.capitalize} #{direction} #{remote} #{@branch_name}"
+      @formatter.output_message(msg, warning: false)
     end
 
-    def announce_sync_attempt
-      msg = "Attempting to sync -> #{repo_name} | #{repo_branch} branch "
-      formatter.message_with_border(msg: msg, border_char: "=", warn: false)
+    def announce_sync_success
+      msg = "-----> Successfully synced #{@repo_name} | #{@branch_name} branch"
+      @formatter.output_message(msg, warning: false)
     end
 
     def invalid_branch_msg
-      msg = "You are not on the main/master branch. Please checkout the main/master branch and try again."
-      sub_msg = "-----> skipping #{repo_name} | #{repo_branch} branch <-----"
-      formatter.message_with_border(msg: msg, sub_msg: sub_msg)
-    end
-
-    def failed_fetch_msg
-      msg = "-----> Failed to fetch from upstream #{repo_branch}. Moving on to next repo. <-----"
-      formatter.message_with_border(msg: msg)
+      msg = "Failed to validate upstream #{@branch_name}."
+      @formatter.output_message(msg)
     end
 
     def failed_pull_msg
-      msg = "-----> Failed to pull from upstream #{repo_branch}. Moving on to next repo. <-----"
-      formatter.message_with_border(msg: msg)
+      msg = "Failed to pull from upstream #{@branch_name}."
+      @formatter.output_message(msg)
     end
 
     def failed_push_msg
-      msg = "-----> Failed to push to origin #{repo_branch}. Moving on to next repo. <-----"
-      formatter.message_with_border(msg: msg)
-    end
-
-    def failed_sync_msg
-      msg = "-----> Failed to sync #{repo_name} | #{repo_branch}. Moving on to next repo. <-----"
-      formatter.message_with_border(msg: msg)
+      msg = "Failed to push to origin #{@branch_name}."
+      @formatter.output_message(msg)
     end
   end
 end

data/lib/git_fonky/repositories.rb

@@ -0,0 +1,24 @@
+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/lib/git_fonky/version.rb

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

data/lib/git_fonky.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
+require "colorize"
 require_relative "git_fonky/version"
 require_relative "git_fonky/repo_dir"
-require_relative "git_fonky/repo_names"
+require_relative "git_fonky/repositories"
 
 module GitFonky
   class Error < StandardError; end
@@ -10,11 +11,14 @@ module GitFonky
   GFONK_DIR = ENV["GFONK_DIR"] || "#{Dir.home}/code"
 
   def self.sync_repos
-    Dir.chdir(GFONK_DIR)do
-      REPO_NAMES.each do |dir|
-        RepoDir.sync(dir)
+    Dir.chdir(GFONK_DIR) do
+      Repositories.parse_env.each do |repo, branch|
+        RepoDir.sync(repo_name: repo, branch_name: branch)
         puts "\n" * 3
       end
     end
+
+    puts "Process complete. See output for any errors or warnings."
+    puts "DON'T FAKE THE FONK!"
   end
 end

metadata

@@ -1,14 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: git_fonky
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.1.0
 platform: ruby
 authors:
 - Collin Jilbert
 bindir: bin
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 description: Do 'em all at once.
 email:
 - cjilbert504@gmail.com
@@ -26,12 +40,11 @@ files:
 - bin/gfonk
 - git_fonky.gemspec
 - lib/git_fonky.rb
-- lib/git_fonky/branch.rb
 - lib/git_fonky/command.rb
 - lib/git_fonky/message_formatter.rb
 - lib/git_fonky/repo_dir.rb
-- lib/git_fonky/repo_names.rb
 - lib/git_fonky/reporter.rb
+- lib/git_fonky/repositories.rb
 - lib/git_fonky/version.rb
 - sig/git_fonky.rbs
 homepage: https://github.com/cjilbert504/git_fonky

data/lib/git_fonky/branch.rb

@@ -1,13 +0,0 @@
-module GitFonky
-  class Branch
-    attr_reader :name
-
-    def initialize(name)
-      @name = name
-    end
-
-    def valid?(pattern = /(main|master)/)
-      name.match?(pattern)
-    end
-  end
-end

data/lib/git_fonky/repo_names.rb

@@ -1,11 +0,0 @@
-module GitFonky
-
-  begin
-    REPO_NAMES = ENV["GFONK_REPOS"].split(",")
-  rescue NoMethodError
-    puts "The $GFONK_REPOS environment variable is not set."
-    puts "Please set the variable to point to a string list of repository names separated only by commas (NO SPACES):"
-    puts "export GFONK_REPOS='repo1,repo2,repo3'"
-    exit 1
-  end
-end