git_snip 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 971bfdab966edf6e8d0f147bd19f85eb0f72c8ac
-  data.tar.gz: c8c3db3af432f657a11ff0e4bde9d292b26a10b3
+  metadata.gz: a20a58119f68056d5761981e0440ba321231416d
+  data.tar.gz: 8c095dc7ee582d109391f0ab07dab8fe0c48fc13
 SHA512:
-  metadata.gz: b5d5cff6b4b5e2ba9b495925283b30d16e042a8c7b81e94ccc0f81b96acb71035fdf030927871593d69744ca2f2719c5edc08c569e0f454d72bdd57e0da511a0
-  data.tar.gz: c55e1e8fbe97572c4b8b858c65f4509170d87ac4d5f6e59c6c8899756cbca9650d05fc1679d900e5a9c9d349359c8ed152e99ea1e515398ee52c90dae6a3dfff
+  metadata.gz: bb771326cd8b86b479b7ce7c9ae1a7f23758327445370b65cc682e7537bf10a07ca08df7b0bf7bb2cbcd0be2feaa9e88ec7c5e106b0220d50d79c80d7b7b5b38
+  data.tar.gz: ce9d2f055e48b91d10422ffefcc7cf3983774a72b0c979a014773fb933a831ea1177ae13c61c00ea2dec62e7afe9f84d7b75eaf4d3203faff0409acaf26ab874

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## master (unreleased)
 
+## 0.0.4
+
+* Add config file.
+
+* Add `--full` option to show most branch information without cropping.
+
+  Thanks to @bgreg for the idea and suggestions. Thanks to
+  [Ruby Workshop](http://www.meetup.com/Silicone-Valley-Ruby-Workshop/) too.
+
 ## 0.0.3
 
 * Fix missing new line after each branch line.

data/README.md

@@ -38,6 +38,11 @@ Delete branches already merged to master:
 
     $ git snip -f
 
+Delete branches already merged to master and show more detailed listing of
+deleted branches:
+
+    $ git snip -f --full
+
 Delete branches already merged to master, except staging and production:
 
     $ git snip -f --ignore=staging production
@@ -50,6 +55,26 @@ Delete branches already merged to `branch_a`:
 
     $ git snip -f --target=branch_a
 
+You can also list the available options from command line:
+
+    $ git snip help
+
+## Config file
+
+If you want some arguments to always be set, add a file to the root of the
+repository with name `.git_snip.yml`. Specify the default arguments as YAML in
+the file like this:
+
+```yaml
+full: true
+ignore:
+  - staging
+  - production
+```
+
+The config arguments are overridden when the same arguments are set from command
+line.
+
 ## Contributing
 
 1. Fork it ( https://github.com/htanata/git_snip/fork )

data/lib/git_snip/branch.rb

@@ -1,15 +1,24 @@
 module GitSnip
   module Branch
-    class Column < Struct.new(:sha, :name, :date, :author, :message)
+    Row = Struct.new(:sha, :name, :date, :author, :message)
+
+    def self.row(branch)
+      Row.new.tap do |row|
+        row.sha = column(branch.gcommit.sha, 7)
+        row.name = column(branch.name, 12)
+        row.date = column(branch.gcommit.date.strftime('%F'), 10)
+        row.author = column(branch.gcommit.author.email.sub(/@.*/, ''), 8)
+        row.message = column(first_line(branch.gcommit.message), 39)
+      end
     end
 
-    def self.columnize(branch)
-      Column.new.tap do |column|
-        column.sha = column(branch.gcommit.sha, 7)
-        column.name = column(branch.name, 12)
-        column.date = column(branch.gcommit.date.strftime('%F'), 10)
-        column.author = column(branch.gcommit.author.email.sub(/@.*/, ''), 8)
-        column.message = column(first_line(branch.gcommit.message), 39)
+    def self.full_row(branch)
+      Row.new.tap do |row|
+        row.sha = branch.gcommit.sha
+        row.name = branch.name
+        row.date = branch.gcommit.date.iso8601
+        row.author = branch.gcommit.author.email
+        row.message = first_line(branch.gcommit.message)
       end
     end
 

data/lib/git_snip/cli.rb

@@ -1,11 +1,18 @@
 require 'thor'
 require 'git_snip/cleaner'
 require 'git_snip/branch'
+require 'git_snip/config'
 
 module GitSnip
   class CLI < Thor
     include Thor::Actions
 
+    class << self
+      def help(shell, subcommand = 'snip')
+        command_help(shell, subcommand)
+      end
+    end
+
     option :force, type: :boolean, aliases: '-f',
       desc: 'Will refuse to run unless given -f or -n.'
 
@@ -21,13 +28,16 @@ module GitSnip
     option :ignore, type: :array, default: [],
       desc: 'List of branches to ignore.'
 
+    option :full, type: :boolean,
+      desc: 'Show most branch information without cropping.'
+
     desc '', 'Delete branches which have been merged to target.'
     def snip
-      if options[:dry_run]
+      if opts[:dry_run]
         return dry_run
       end
 
-      if !options[:force]
+      if !opts[:force]
         say '-f option is needed to delete branches.', :red
         exit 64
       end
@@ -69,18 +79,39 @@ module GitSnip
       end
     end
 
-    def say_branch_info(branch)
-      Branch.columnize(branch).tap do |column|
-        say column.sha + ' ', :yellow
-        say column.name + ' ', :magenta
-        say column.date + ' ', :green
-        say column.author + ' ', [:blue, :bold]
-        say column.message.strip + "\n"
-      end
+    def say_branch_info(branch, full = false)
+      row = opts[:full] ? Branch.full_row(branch) : Branch.row(branch)
+
+      say row.sha + ' ', :yellow
+      say row.name + ' ', :magenta
+      say row.date + ' ', :green
+      say row.author + ' ', [:blue, :bold]
+      say row.message.strip + "\n"
     end
 
     def cleaner_args
-      options.values_at(:repo, :target, :ignore)
+      opts.values_at(:repo, :target, :ignore)
+    end
+
+    def opts
+      @opts ||= begin
+        config = Config.new(options[:repo])
+
+        options_dup = options.dup
+
+        options_dup.each_pair do |k, v|
+          if v.is_a?(Array) && v.empty?
+            config_value = config.options[k]
+
+            if config_value.is_a?(Array) && config_value.any?
+              options_dup[k] = config_value
+            end
+          end
+        end
+
+        Thor::CoreExt::HashWithIndifferentAccess.new(
+          config.options.merge(options_dup)).freeze
+      end
     end
   end
 end

data/lib/git_snip/config.rb

@@ -0,0 +1,23 @@
+require 'yaml'
+
+module GitSnip
+  class Config
+    def initialize(repo_path = '.')
+      @repo_path = repo_path
+    end
+
+    def options
+      @options ||= read_file || {}
+    end
+
+    private
+
+    def read_file
+      YAML.load_file(config_path) if File.exist?(config_path)
+    end
+
+    def config_path
+      "#{@repo_path.chomp('/')}/.git_snip.yml"
+    end
+  end
+end

data/lib/git_snip/version.rb

@@ -1,3 +1,3 @@
 module GitSnip
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/lib/git_snip/branch_spec.rb

@@ -1,42 +1,61 @@
 require 'git_snip/branch'
 
 RSpec.describe GitSnip::Branch do
-  it 'should return values with number of characters within 80' do
-    result = described_class.columnize(build_branch(build_column))
+  describe '.row' do
+    it 'should return values with number of characters within 80' do
+      result = described_class.row(build_branch(build_row))
 
-    expect([
-      result.sha, result.name, result.author, result.date, result.message
-    ].join(' ').size).to eq(80)
+      expect([
+        result.sha, result.name, result.author, result.date, result.message
+      ].join(' ').size).to eq(80)
+    end
+
+    it 'should remove message starting from the first new line' do
+      row = build_row(message: "First line\n\nThird line")
+      result = described_class.row(build_branch(row))
+
+      expect(result.message).to eq('First line' + (' ' * 29))
+    end
   end
 
-  it 'should remove message starting from the first new line' do
-    column = build_column(message: "First line\n\nThird line")
-    result = described_class.columnize(build_branch(column))
+  describe '.full_row' do
+    it 'should return values while keeping most of the words' do
+      row = build_row(
+        message: ('A' * 100) + "\n\n" + ('B' * 85),
+        author: 'would_you_kindly@example.com'
+      )
+
+      result = described_class.full_row(build_branch(row))
 
-    expect(result.message).to eq('First line' + (' ' * 29))
+      expect(result.sha).to eq(row.sha)
+      expect(result.name).to eq(row.name)
+      expect(result.author).to eq(row.author)
+      expect(result.date).to eq(row.date.iso8601)
+      expect(result.message).to eq('A' * 100)
+    end
   end
 
-  def build_branch(column)
-    author = instance_double('Git::Author', email: column.author)
+  def build_branch(row)
+    author = instance_double('Git::Author', email: row.author)
 
     gcommit = instance_double(
       'Git::Gcommit',
-      sha: column.sha,
-      date: column.date,
-      message: column.message,
+      sha: row.sha,
+      date: row.date,
+      message: row.message,
       author: author
     )
 
-    instance_double('Git::Branch', name: column.name, gcommit: gcommit)
+    instance_double('Git::Branch', name: row.name, gcommit: gcommit)
   end
 
-  def build_column(attrs = {})
-    described_class::Column.new.tap do |column|
-      column.sha = attrs[:sha] || '28720606978a7257f735ce67df50bc55ccf1c138'
-      column.name = attrs[:name] || 'a_pretty_long_branch_name'
-      column.author = attrs[:author] || 'inigo_montoya@example.com'
-      column.date = attrs[:date] || Time.now
-      column.message = attrs[:message] || 'Hello, my name is Inigo Montoya.'
+  def build_row(attrs = {})
+    described_class::Row.new.tap do |row|
+      row.sha = attrs[:sha] || '28720606978a7257f735ce67df50bc55ccf1c138'
+      row.name = attrs[:name] || 'a_pretty_long_branch_name'
+      row.author = attrs[:author] || 'inigo_montoya@example.com'
+      row.date = attrs[:date] || Time.now
+      row.message = attrs[:message] || 'Hello, my name is Inigo Montoya.'
     end
   end
 

data/spec/lib/git_snip/cli_help_spec.rb

@@ -0,0 +1,11 @@
+require 'git_snip/cli'
+
+RSpec.describe GitSnip::CLI, 'help' do
+  include CliHelper
+
+  it 'should display help for snip subcommand' do
+    stdout, _, _ = git_snip('help', :blank_slate)
+    expect(stdout).to match('--force')
+    expect(stdout).to match('--dry-run')
+  end
+end

data/spec/lib/git_snip/cli_spec.rb

@@ -139,4 +139,72 @@ RSpec.describe GitSnip::CLI do
       expect(stdout).to match(/merged.+Version 2\n/)
     end
   end
+
+  describe 'with --full' do
+    it 'should not wrap the branch listing' do
+      setup_basic_repo
+
+      repo.commit_on_branch(
+        'branch_with_really_long_name', "#{'A' * 100}\n\n#{'B' * 100}")
+
+      repo.merge_to_master('branch_with_really_long_name')
+
+      stdout, _, _ = git_snip('-n --full')
+
+      expect(stdout).to match("#{'A' * 100}\n")
+      expect(stdout).to match('branch_with_really_long_name')
+    end
+  end
+
+  context 'with config file' do
+    include_context 'config'
+
+    let(:config_dir) { repo.path }
+
+    before do
+      remove_config(config_dir)
+    end
+
+    it 'should handle boolean config options' do
+      setup_basic_repo
+
+      create_config(config_dir, 'dry_run' => true)
+
+      stdout, _, exitstatus = git_snip
+
+      expect(exitstatus).to eq(0)
+      expect(stdout).to match("Would delete the following branches...\n\n")
+      expect(stdout).to match("merged")
+      expect(stdout).to match("\n\nDone.")
+      expect(exitstatus).to eq(0)
+
+      expect(repo.branch_exists?('merged')).to be_truthy
+    end
+
+    it 'should set handle list config options' do
+      setup_basic_repo
+
+      create_config(config_dir, 'ignore' => ['merged'])
+
+      stdout, _, exitstatus = git_snip('--dry-run')
+
+      expect(stdout).to eq(
+        "Would delete the following branches...\n\n" \
+        "No branches would be deleted.\n"
+      )
+
+      expect(exitstatus).to eq(0)
+    end
+
+    specify 'command line arguments should override config' do
+      setup_basic_repo
+
+      create_config(config_dir, 'dry_run' => true)
+
+      stdout, _, exitstatus = git_snip('--no-dry-run')
+
+      expect(stdout).to eq("-f option is needed to delete branches.\n")
+      expect(exitstatus).to eq(64)
+    end
+  end
 end

data/spec/lib/git_snip/config_spec.rb

@@ -0,0 +1,24 @@
+require 'git_snip/config'
+
+RSpec.describe GitSnip::Config do
+  include_context 'config'
+
+  let(:config_dir) { 'tmp' }
+
+  before do
+    remove_config(config_dir)
+  end
+
+  describe '#options' do
+    it "should be an empty hash when config file doesn't exist" do
+      expect(described_class.new(config_dir).options).to eq({})
+    end
+
+    it 'should read content of config file and convert keys to symbol' do
+      options = { 'foo' => 'bar' }
+      create_config(config_dir, options)
+
+      expect(described_class.new(config_dir).options).to eq('foo' => 'bar')
+    end
+  end
+end

data/spec/support/cli_helper.rb

@@ -14,11 +14,14 @@ module CliHelper
     end
   end
 
-  def git_snip(args = '')
+  def git_snip(args = '', blank_slate = false)
     stdin, stdout, stderr = Array.new(3) { StringIO.new }
 
+    arguments = args.dup
+    arguments << " --repo=#{repo.path}" unless blank_slate
+
     runner =
-      GitSnip::CLIRunner.new("#{args} --repo=#{repo.path}".split(' '),
+      GitSnip::CLIRunner.new(arguments.split(' '),
         stdin, stdout, stderr, FakeKernel.new)
 
     exitstatus = runner.execute!

data/spec/support/config_shared_context.rb

@@ -0,0 +1,18 @@
+require 'yaml'
+
+shared_context 'config' do
+  def create_config(config_dir, options)
+    FileUtils.mkdir_p(config_dir)
+    File.open(config_path(config_dir), 'w') { |f| f.write(options.to_yaml) }
+  end
+
+  def remove_config(config_dir)
+    path = config_path(config_dir)
+
+    FileUtils.rm_f(path)
+  end
+
+  def config_path(config_dir)
+    "#{config_dir}/.git_snip.yml"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_snip
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Hendy Tanata
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-12 00:00:00.000000000 Z
+date: 2015-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -102,13 +102,17 @@ files:
 - lib/git_snip/branch.rb
 - lib/git_snip/cleaner.rb
 - lib/git_snip/cli.rb
+- lib/git_snip/config.rb
 - lib/git_snip/version.rb
 - spec/lib/git_snip/branch_spec.rb
 - spec/lib/git_snip/cleaner_spec.rb
+- spec/lib/git_snip/cli_help_spec.rb
 - spec/lib/git_snip/cli_spec.rb
+- spec/lib/git_snip/config_spec.rb
 - spec/spec_helper.rb
 - spec/support/cli_helper.rb
 - spec/support/cli_runner.rb
+- spec/support/config_shared_context.rb
 - spec/support/repo.rb
 homepage: https://github.com/htanata/git_snip
 licenses:
@@ -137,8 +141,11 @@ summary: Clean obsolete branches on your local git repository safely
 test_files:
 - spec/lib/git_snip/branch_spec.rb
 - spec/lib/git_snip/cleaner_spec.rb
+- spec/lib/git_snip/cli_help_spec.rb
 - spec/lib/git_snip/cli_spec.rb
+- spec/lib/git_snip/config_spec.rb
 - spec/spec_helper.rb
 - spec/support/cli_helper.rb
 - spec/support/cli_runner.rb
+- spec/support/config_shared_context.rb
 - spec/support/repo.rb