git_context 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d02e280efb82c55f30a2e33d5505c3dd4fdd5480547bf2aa82242f25bb7614d8
+  data.tar.gz: 8f826f42e65c9f25cc281ae4a7cd478b87eb4035000fac0b14bc0f6c6ee0447a
+SHA512:
+  metadata.gz: aa4a8d99893336ec6930cecb733452e105b9d23a039596cfb79117e76ab9a02ee11d8240e1a4916dd666e57ee360cb4a95baf23a72d07ef036019c7a652c7b4b
+  data.tar.gz: 4ff48917170d7cd43ef5129b9f10461c3b425b79b1829dc7886be19e03e87f52facd19bc15bbac885fb1c63929410c429803bb7cd7909a8a8f72feeeafd38833

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/.idea/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.6.6

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in git_context.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    git_context (0.1.0)
+      tty-prompt (~> 0.22)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    tty-color (0.5.2)
+    tty-cursor (0.7.1)
+    tty-prompt (0.22.0)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.8.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    wisper (2.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  git_context!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Albert Salim
+
+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,85 @@
+# git-context
+
+`git-context` provides a tool to manage conditional git config.
+
+No more committing with the wrong email in a new repository. With `git-context` you can set up a context per directory. Any git repositories within the directory would use the git config specified for that directory.
+
+Currently, the supported config values are:
+- `user.name`
+- `user.email`
+
+`git-context` uses git config [conditional includes](https://git-scm.com/docs/git-config#_conditional_includes) under the hood.
+
+## Installation
+
+Install the `git-context` CLI via `gem install`.
+
+```shell
+    $ gem install git_context
+```
+## Usage
+
+First, set up `git-context` to hook into the user's `~/.git/config`.
+
+```shell
+    $ git-context setup
+```
+
+Next, create one or more user profile to contain the user name and email address.
+
+```shell
+    $ git-context create_profile
+    Please enter profile name: work
+    Please enter the name to be used in git config: John Doe
+    Please enter the email address to be used in git config: johndoe@company.com
+
+    $ git-context create_profile
+    Please enter profile name: fun
+    Please enter the name to be used in git config: Johnny
+    Please enter the email address to be used in git config: johnny@wut.lol
+```
+
+Finally, create contexts to use a specified profile in a directory.
+
+```shell
+    $ git-context create_context
+    Please enter working directory: /Users/john/work
+    Please select from existing profiles: work
+    
+    $ git-context create_context
+    Please enter working directory: /Users/john/fun
+    Please select from existing profiles: fun
+```
+
+Now you can commit as different users easily.
+
+```shell
+    $ cd /Users/john/work/project/unicorn
+    $ git config user.name
+    John Doe
+    $ git config user.email
+    johndoe@company.com
+    
+    $ cd /Users/john/fun/lol/wut
+    $ git config user.name
+    Johnny
+    $ git config user.email
+    johnny@wut.lol
+```
+
+**Tip:** You could also use `git context`. `git` recognizes `git-context` as a custom command. 
+
+## 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 tags, 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/caalberts/git_context.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "git_context"
+
+# 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/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/exe/git-context

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'git_context'
+
+configuration = GitContext::Configuration.new(Dir.home)
+command = ARGV.shift
+GitContext::CLI.new(configuration).exec(command)

data/git_context.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/git_context/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "git_context"
+  spec.version       = GitContext::VERSION
+  spec.authors       = ["Albert Salim"]
+  spec.email         = ["albertlimca@gmail.com"]
+
+  spec.summary       = %q{`git-context` provides a tool to manage conditional git config.}
+  spec.description   = %q{`git-context` provides a tool to manage conditional git config.}
+  spec.homepage      = "https://github.com/caalberts/git_context"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/caalberts/git_context"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'tty-prompt', '~> 0.22'
+end

data/lib/git_context.rb

@@ -0,0 +1,13 @@
+require 'git_context/cli'
+require 'git_context/commands'
+require 'git_context/configuration'
+require 'git_context/interaction'
+require 'git_context/version'
+
+module GitContext
+  class Error < StandardError; end
+
+  Context = Struct.new(:work_dir, :profile_name)
+  Profile = Struct.new(:profile_name, :user)
+  User = Struct.new(:name, :email)
+end

data/lib/git_context/cli.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+module GitContext
+  class CLI
+    COMMAND_CLASSES = {
+      setup: 'Setup',
+      create_profile: 'CreateProfile',
+      create_context: 'CreateContext'
+    }.freeze
+
+    def initialize(configuration)
+      @configuration = configuration
+      @interaction = Interaction.new
+    end
+
+    def exec(command_name)
+      command_class = command_for(command_name)
+      command = command_class.new(interaction: @interaction, configuration: @configuration)
+      command.call
+    rescue KeyError
+      warn "Unknown command #{command_name}. Supported commands are #{COMMAND_CLASSES.keys.map(&:to_s)}"
+    end
+
+    private
+
+    def command_for(command)
+      klass = COMMAND_CLASSES.fetch(command.to_sym)
+      Commands.const_get(klass)
+    end
+  end
+end

data/lib/git_context/commands.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'git_context/commands/base'
+require 'git_context/commands/create_context'
+require 'git_context/commands/create_profile'
+require 'git_context/commands/setup'
+
+module GitContext
+  module Commands
+  end
+end

data/lib/git_context/commands/base.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module GitContext
+  module Commands
+    class Base
+      def initialize(configuration:, interaction:)
+        @configuration = configuration
+        @interaction = interaction
+      end
+
+      def call
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/git_context/commands/create_context.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+module GitContext
+  module Commands
+    class CreateContext < Base
+      def call
+        profile_names = @configuration.list_profile_names
+        work_dir = @interaction.prompt_work_dir
+        profile_name = @interaction.prompt_profile(profile_names)
+
+        context = Context.new(work_dir, profile_name)
+
+        @configuration.add_context(context)
+      end
+    end
+  end
+end

data/lib/git_context/commands/create_profile.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+module GitContext
+  module Commands
+    class CreateProfile < Base
+      def call
+        profile_name = @interaction.prompt_profile_name
+        user_name = @interaction.prompt_user_name
+        user_email = @interaction.prompt_user_email
+
+        user = User.new(user_name, user_email)
+        profile = Profile.new(profile_name, user)
+        @configuration.add_profile(profile)
+      end
+    end
+  end
+end
+

data/lib/git_context/commands/setup.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module GitContext
+  module Commands
+    class Setup < Base
+      def call
+        @configuration.setup
+      end
+    end
+  end
+end

data/lib/git_context/configuration.rb

@@ -0,0 +1,105 @@
+require 'fileutils'
+require 'pathname'
+
+module GitContext
+  class Configuration
+    BASE_STORAGE_DIR = '.gitcontext'
+    PROFILES_DIR = 'profiles'
+    CONTEXTS_FILENAME = 'contexts'
+
+    def initialize(home_dir)
+      @home_dir = home_dir
+    end
+
+    def setup
+      create_base_dir unless exists?(git_context_dir)
+      create_contexts_file
+      create_profiles_dir unless exists?(profiles_dir)
+      include_in_gitconfig
+    end
+
+    def add_profile(profile)
+      profile_file = profile_filepath(profile.profile_name)
+      touch_file(profile_file)
+
+      `git config -f "#{profile_file}" --add user.name "#{profile.user.name}"`
+      `git config -f "#{profile_file}" --add user.email "#{profile.user.email}"`
+    end
+
+    def list_profile_names
+      Dir.entries(profiles_dir) - %w[. ..]
+    end
+
+    def delete_profile(profile)
+      profile_file = profile_filepath(profile.profile_name)
+      delete_file(profile_file)
+    end
+
+    def add_context(context)
+      profile_file = profile_filepath(context.profile_name)
+
+      `git config -f "#{contexts_filepath}" --add "includeIf.gitdir:#{context.work_dir}/.path" "#{profile_file}"`
+    end
+
+    private
+
+    def profile_filepath(profile_name)
+      profiles_dir.join(profile_name)
+    end
+
+    def create_base_dir
+      FileUtils.mkdir(git_context_dir)
+    end
+
+    def create_profiles_dir
+      FileUtils.mkdir(profiles_dir)
+    end
+
+    def profiles_dir
+      git_context_dir.join(PROFILES_DIR)
+    end
+
+    def create_contexts_file
+      touch_file(contexts_filepath)
+    end
+
+    def contexts_filepath
+      git_context_dir.join(CONTEXTS_FILENAME)
+    end
+
+    def git_context_dir
+      home.join(BASE_STORAGE_DIR)
+    end
+
+    def global_gitconfig_path
+      home.join('.gitconfig')
+    end
+
+    def include_in_gitconfig
+      return if include_path_exists?
+
+      `git config -f "#{global_gitconfig_path}" --add "include.path" "#{contexts_filepath}"`
+    end
+
+    def include_path_exists?
+      include_path = `git config -f "#{global_gitconfig_path}" include.path`
+      include_path.include?(contexts_filepath.to_s)
+    end
+
+    def home
+      Pathname.new(@home_dir)
+    end
+
+    def touch_file(config_file_path)
+      FileUtils.touch(config_file_path)
+    end
+
+    def delete_file(config_file_path)
+      FileUtils.rm(config_file_path)
+    end
+
+    def exists?(dir_or_file)
+      FileTest.exists?(dir_or_file)
+    end
+  end
+end

data/lib/git_context/interaction.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+require 'tty-prompt'
+
+module GitContext
+  class Interaction
+    def initialize(prompt = TTY::Prompt.new)
+      @prompt = prompt
+    end
+
+    def prompt_work_dir
+      @prompt.ask('Please enter working directory:')
+    end
+
+    def prompt_profile(saved_profiles)
+      @prompt.select('Please select from existing profiles:', saved_profiles)
+    end
+
+    def prompt_profile_name
+      @prompt.ask('Please enter profile name:')
+    end
+
+    def prompt_user_name
+      @prompt.ask('Please enter the name to be used in git config:')
+    end
+
+    def prompt_user_email
+      @prompt.ask('Please enter the email address to be used in git config:')
+    end
+  end
+end

data/lib/git_context/version.rb

@@ -0,0 +1,3 @@
+module GitContext
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: git_context
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Albert Salim
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tty-prompt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: "`git-context` provides a tool to manage conditional git config."
+email:
+- albertlimca@gmail.com
+executables:
+- git-context
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".tool-versions"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/git-context
+- git_context.gemspec
+- lib/git_context.rb
+- lib/git_context/cli.rb
+- lib/git_context/commands.rb
+- lib/git_context/commands/base.rb
+- lib/git_context/commands/create_context.rb
+- lib/git_context/commands/create_profile.rb
+- lib/git_context/commands/setup.rb
+- lib/git_context/configuration.rb
+- lib/git_context/interaction.rb
+- lib/git_context/version.rb
+homepage: https://github.com/caalberts/git_context
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/caalberts/git_context
+  source_code_uri: https://github.com/caalberts/git_context
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: "`git-context` provides a tool to manage conditional git config."
+test_files: []