git-commander 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e4e61ccf3751b8e511981eb8335aa65c73e3b4b0932af02bb2a2bbd0046bc08
+  data.tar.gz: 0be52ddaf9c2816e931f6af9e63de9f118717de7d2d7db08ec4d9a1d57ffb788
+SHA512:
+  metadata.gz: 6f8d75298b07446ec8282f7506a6a93d04a6cd421835bc4eea68295a2cf13fd505a0a3b7b6de1ace831b1e3f031853d82022843770531684f8c2eb791d1132fb
+  data.tar.gz: 3d1936108a6079ec03c9c6c8b672dd64e108f5d781479f58bd9766ac68d2fd06291b80f99eb08a958451f1ece847df621a3acbb040f92218faf167647a6f1906

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,38 @@
+Layout/DotPosition:
+  EnforcedStyle: trailing
+
+Metrics/LineLength:
+  Max: 120
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
+  Enabled: true
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/LambdaCall:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - ./**/*_spec*.rb
+    - ./spec/*_helper*.rb
+    - ./spec/support/*
+    - ./spec/support/**/*
+    - Gemfile
+
+Metrics/ModuleLength:
+  Exclude:
+    - ./**/*_spec*.rb
+    - ./spec/support/**/*
+
+Metrics/MethodLength:
+  Exclude:
+    - ./**/*_spec*.rb
+    - ./spec/support/**/*
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - ./**/*_spec.rb

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.2

data/.yardopts

@@ -0,0 +1 @@
+--no-private --protected exe/* lib/**/*.rb - CODE_OF_CONDUCT.md README.md LICENSE.txt

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at v@codenamev.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in git-commander.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    git-commander (0.1.0)
+      bundler (~> 2.1, >= 1.10.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.1)
+    diff-lcs (1.3)
+    rake (12.3.3)
+    rdoc (6.2.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      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.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 11)
+  git-commander!
+  rake (~> 12.3)
+  rdoc (~> 6.2)
+  rspec (< 4.0)
+
+BUNDLED WITH
+   2.1.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Valentino Stoll
+
+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,196 @@
+# git-commander
+
+Make your own git commands.
+
+Installation
+============
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'git-commander'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install git-commander
+
+Usage
+=====
+
+All commands you register can be run using `git cmd ...`.
+
+Registering a new command is as easy as creating a new `Workflow` file in your git-root's directory (or organize them in a `.git-commands` directory).
+Example:
+
+```ruby
+# ~/git-root/.git-commands/current.rb
+
+plugin :system
+
+command :current do |cmd|
+  cmd.summary "Outputs all commits not on the base branch"
+  cmd.argument :base_branch, default: "master"
+
+  cmd.on_run do |options|
+    current_branch = system.run "git rev-parse --abbrev-ref HEAD"
+    system.run "git log #{options[:base_branch]}..#{current_branch} --format=\"%C(auto)%h %s %C(#999999)%ar\" --color"
+  end
+end
+```
+
+In the above example, we:
+
+1. Use the native `system` plugin.  This gives us access to an instance of [System](/docs/GitCommander/System) inside of our `on_run` block.
+2. Creates a new `git cmd current :base_branch` command and runs everything in the `on_run` block when we execute it (passing the `:base_branch` in the `options`)
+
+`cmd` can configure multiple `argument`, `flag`, `switch` options, and a `default: 'some value'` can be set for any.
+A long-form `description` can also be set for your commands for use in the command's help text: `git cmd help current`.
+
+You can define multiple commands in a single file if you wish, but it is recommended to keep commands contained to their own file.
+
+Gem usage
+=========
+
+Command declaration files can include their own inline gems:
+
+```ruby
+gemfile do
+  source "https://rubygems.org"
+  gem "octokit"
+end
+```
+
+Plugins
+=======
+
+Git-commander is built with the intention of being extended.  To make things
+flexible, there is a plugin architecture that allows you to define new top-level
+methods that can be available inside of your command's `on_run` blocks.
+
+As a simple example, if you wanted access to a `github` method to perform API calls, you can use the [octokit gem](https://github.com/octokit/octokit.rb) to do this:
+
+```ruby
+# .git-commands/plugins/github.rb
+gemfile do
+  source "https://rubygems.org"
+  gem "octokit"
+end
+
+Octokit::Client.new
+```
+
+Then in a new command, use the new `github` plugin:
+
+```ruby
+plugin :github
+
+command :prs do |cmd|
+  cmd.summary "Lists all open GitHub PullRequests for the git-commander repo"
+
+  cmd.on_run do |cmd|
+    github.pull_requests("codenamev/git-commander", state: "open").each do |pr|
+      say "@#{pr.user.login} #{pr.title} – #{pr.html_url}"
+    end
+  end
+end
+```
+
+### Anatomy of a plugin
+
+1. [Name of the plugin](#name-of-the-plugin)
+2. [Gem dependencies](#gem-dependencies) (via `gemfile` block)
+3. [Plugin dependencies](#plugin-dependencies)
+4. [Plugin-specific commands](#plugin-specific-commands)
+5. [The plugin instance](#the-plugin-instance)
+
+Name of the plugin
+------------------
+
+As mentioned in the simple example above, the filename of the plugin defines the keyword that will be available within the `on_run` blocks of your commands. Plugins must be added to your `.git-commands/plugins` directory, and the file extension must be `.rb`. Whatever you name the file becomes the name used internally to reference it.  So if you name your plugin `some-awesome-plugin.rb`, you will have to reference it as `plugin 'some-awesome-plugin'`.
+
+Gem dependencies
+----------------
+
+Just like commands, you can include third-party gems using [Bundler's inline helpers](https://github.com/rubygems/bundler/blob/master/lib/bundler/inline.rb).
+
+Plugin dependencies
+-------------------
+
+Also the same as with commands, plugins can also define other plugins as dependencies. We include the following plugins natively:
+
+- [git](https://github.com/codenamev/git-commander/blob/master/lib/git_commander/plugins/git.rb)
+- [github](https://github.com/codenamev/git-commander/blob/master/lib/git_commander/plugins/github.rb)
+- [prompt](https://github.com/codenamev/git-commander/blob/master/lib/git_commander/plugins/prompt.rb)
+- [system](https://github.com/codenamev/git-commander/blob/master/lib/git_commander/plugins/system.rb)
+
+Plugin-specific commands
+------------------------
+
+Plugins can also define their own commands.  These commands will be namespaced to the name of the plugin.  So the following plugin would allow you to run `git cmd github:setup`.
+
+```ruby
+gemfile do
+  source "https://rubygems.org"
+  gem "octokit"
+end
+
+plugin :prompt
+
+command :setup do |cmd|
+  cmd.summary "Connects to GitHub, creates an access token, and stores it in the git-cmd section of your git config"
+
+  cmd.on_run do
+    gh_user = prompt.ask("Please enter your GitHub username", required: true)
+    gh_password = promt.mask("Please enter your GitHub password (this is NOT stored): ", required: true)
+
+    github.login = gh_user
+    github.password = gh_password
+
+    # Check for 2-factor requirements
+    begin
+      client.user
+    rescue Octokit::Unauthorized
+      github.user(
+        gh_user,
+        headers: { "X-GitHub-OTP" => prompt.ask("Please enter your two-factor authentication code") }
+      )
+    end
+
+    say "GitHub account successfully setup!"
+  end
+end
+
+Octokit::Client.new
+```
+
+The plugin instance
+-------------------
+
+When plugins are loaded, their content is evaluated in the context of the Plugin::Loader class.  Whatever the file returns (the last line evaluated) is stored as the plugin's instance.  In this way, whenever you reference the plugin from within a command's `on_run`, you are referencing the same instance that was returned from evaluating the plugin's file.
+
+Development
+===========
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` 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](https://github.com/codenamev/git-commander/issues/new) and [pull requests](https://github.com/codenamev/git-commander/pulls) are welcome on GitHub. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+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 GitCommander project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/codenamev/git-commander/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,7 @@
+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_commander"
+
+# 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-cmd

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift "#{__dir__}/../lib"
+
+require "rubygems"
+require "git_commander"
+require "git_commander/cli"
+
+runner = GitCommander::CLI.new
+
+plugin_files = Dir[
+  File.join(Dir.pwd, ".git-commands", "plugins", "*.rb")
+]
+command_files = Dir[
+  File.join(Dir.pwd, "Workflow"),
+  File.join(Dir.pwd, ".git-commands", "*.rb")
+]
+
+command_files.each do |filename|
+  loader = runner.registry.load GitCommander::Command::Loaders::FileLoader, filename if File.exist?(filename)
+  unless loader.success?
+    GitCommander.logger.warn "Unable to load command from: #{filename}\n\tErrors: #{loader.errors.inspect}"
+  end
+end
+
+plugin_files.each do |filename|
+  loader = runner.registry.load GitCommander::Plugin::Loader, filename if File.exist?(filename)
+  unless loader.success?
+    GitCommander.logger.warn "Unable to load plugin from: #{filename}\n\tErrors: #{loader.errors.inspect}"
+    GitCommander.logger.debug "\n\tBacktrace: #{loader.errors.map(&:backtrace)}"
+  end
+end
+
+runner.run