tree_trimmer 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 301a095221002fd01b2e19a9d42ca6033cee9898
-  data.tar.gz: f6d1dc6b7f11cf426281ef7f2dc68d8aad9846a7
+  metadata.gz: 998c481662ceae8e15f91f1a8452f5df5e206b41
+  data.tar.gz: 07bc104b5f8852eaeb6bc6b4904775354d2a56bf
 SHA512:
-  metadata.gz: 3a8740755e2bcd685f87a670e00343b57f6f59b60c9fcb09f91fc06e27e923062228c75c73a69929157871f8afef136dfb2c0507fe607ce048126cf398518171
-  data.tar.gz: e509cc5bd521b6576417919bb913c386ec1d4f55c346e041aa70fc221df8c716daedbad13c15479981a42203e7ce2bbd108cfc9a2f7a9f537bd508d07adb8b4b
+  metadata.gz: 3aec51c049593dd0e664372607774c44aca3a05dd7aa96fa8aaf68c933d5026d4e819a5a34612d7299b04e514b5cfc72a6684cff103504f91cef19e13d6581b0
+  data.tar.gz: 1887d58aa8e9348b6375c01dc984cccf256bd3bb3d3e7beca18b990b956d000b64125612fb8db36c7794c1ace6fda36f6c92e599d76f83677cc60fba4f471ca6

data/.codeclimate.yml

@@ -0,0 +1,37 @@
+# This is a sample .codeclimate.yml configured for Engine analysis on Code
+# Climate Platform. For an overview of the Code Climate Platform, see here:
+# http://docs.codeclimate.com/article/300-the-codeclimate-platform
+
+# Under the engines key, you can configure which engines will analyze your repo.
+# Each key is an engine name. For each value, you need to specify enabled: true
+# to enable the engine as well as any other engines-specific configuration.
+
+# For more details, see here:
+# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
+
+# For a list of all available engines, see here:
+# http://docs.codeclimate.com/article/296-engines-available-engines
+
+engines:
+# to turn on an engine, add it here and set enabled to `true`
+# to turn off an engine, set enabled to `false` or remove it
+  rubocop:
+    enabled: true
+
+# Engines can analyze files and report issues on them, but you can separately
+# decide which files will receive ratings based on those issues. This is
+# specified by path patterns under the ratings key.
+
+# For more details see here:
+# http://docs.codeclimate.com/article/289-configuring-your-repository-via-codeclimate-yml#platform
+
+ratings:
+  paths:
+  - lib/**
+
+# You can globally exclude files from being analyzed by any engine using the
+# exclude_paths key.
+
+#exclude_paths:
+#- spec/**/*
+#- vendor/**/*

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/.travis.yml

@@ -1,3 +1,6 @@
 language: ruby
 rvm:
   - 2.1.3
+addons:
+  code_climate:
+    repo_token: f3f262681f3d63918bf161a3951444a6fd8bd920d656c31a6ee26b10db702780

data/Gemfile

@@ -2,3 +2,10 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in tree_trimmer.gemspec
 gemspec
+
+group :test do
+  gem "faker"
+  gem "minitest"
+end
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,5 +1,9 @@
 # TreeTrimmer
 
+[![Gem Version](https://badge.fury.io/rb/tree_trimmer.svg)](http://badge.fury.io/rb/tree_trimmer) [![Build Status](https://travis-ci.org/davidbegin/tree_trimmer.svg?branch=master)](https://travis-ci.org/davidbegin/tree_trimmer) [![Test Coverage](https://codeclimate.com/github/davidbegin/tree_trimmer/badges/coverage.svg)](https://codeclimate.com/github/davidbegin/tree_trimmer/coverage) [![Code Climate](https://codeclimate.com/github/davidbegin/tree_trimmer/badges/gpa.svg)](https://codeclimate.com/github/davidbegin/tree_trimmer) [![Dependency Status](https://gemnasium.com/presidentJFK/tree_trimmer.svg)](https://gemnasium.com/presidentJFK/tree_trimmer) [![Inline docs](http://inch-ci.org/github/presidentJFK/tree_trimmer.svg?branch=master)](http://inch-ci.org/github/presidentJFK/tree_trimmer)
+
+### \*\*WARNING THIS GEM IS PRE 1.0 AND STILL UNSTABLE\*\*
+
 A soon-to-be command line tool for cleaning up Git Branches
 
 ## Installation

data/Rakefile

@@ -1,2 +1,10 @@
 require "bundler/gem_tasks"
 
+task :default => "test"
+
+desc "run all tests"
+task :test do
+  Dir.glob("test/test*.rb").each do |file|
+    require_relative file
+  end
+end

data/examples/basic.rb

@@ -0,0 +1,3 @@
+require_relative "../lib/tree_trimmer"
+
+TreeTrimmer.lets_clean_up_some_branches

data/lib/tree_trimmer.rb

@@ -1,73 +1,19 @@
+# require_relative "tree_trimmer/version"
+# require_relative "tree_trimmer/base"
 require "tree_trimmer/version"
-require "downup"
-require "colorize"
+require "tree_trimmer/base"
 
 module TreeTrimmer
-  def self.lets_clean_up_some_branches
-    puts "\nBranches to Clean:\n\n"
-    Base.new.trim_branches
-  end
-
-  private
-
-  class Base
-    def initialize
-      sanitize_branches!
-    end
-
-    def trim_branches
-      @selection = Downup::Base.new(
-        options: downup_options,
-        type: :multi_select
-      ).prompt
-
-      delete_branches
+  class << self
+    def lets_clean_up_some_branches
+      puts "\nBranches to Clean:\n\n"
+      tree_trimmer.trim_branches
     end
 
     private
 
-    def downup_options
-      branch_options.zip(branches).each_with_object({}) do |option, hash|
-        hash[option.first] = option.last
-      end
-    end
-
-    def branch_options
-      @branch_options ||= ("a".."z").take(branches.count)
-    end
-
-    def branches
-      @branches ||= IO.popen("git branch").each_line.map(&:chomp).map(&:lstrip)
-    end
-
-    def delete_branches
-      puts "\n\nDelete Branches?\n".red
-      puts @selection
-      print "\n(y/n) > ".light_black
-      process_input(gets.chomp)
-    end
-
-    def process_input(input)
-      case input
-      when "y"
-        @selection.each do |branch|
-          cmd = "git branch -D #{branch}"
-          puts "\n...running " + cmd.red + "\n\n"
-          system(cmd)
-        end
-      when "n"
-      else
-        puts "please choose y or n"
-        delete_branches
-      end
-    end
-
-    def sanitize_branches!
-      branches.each do |branch|
-        if branch.include?("master")
-          branches.delete(branch)
-        end
-      end
+    def tree_trimmer
+      Base.new
     end
   end
 end

data/lib/tree_trimmer/base.rb

@@ -0,0 +1,121 @@
+require "colorize"
+require "downup"
+
+module TreeTrimmer
+  class Base
+
+    # @param multi_select_selector [String] selector for Downup Menu of when
+    #   chosing branches to delete
+    # @param selected_color [Symbol] color of selector when chosing a branch to delete
+    def initialize(multi_select_selector: "x",
+                   selected_color: :red,
+                   stdin: $stdin,
+                   stdout: $stdout)
+
+      @stdin                 = stdin
+      @stdout                = stdout
+      @multi_select_selector = multi_select_selector
+      @selected_color        = selected_color
+      sanitize_branches!
+    end
+
+    # Uses the git branches of the current folder
+    # to create a Menu with Downup
+    #
+    # Once branches are choosen,
+    # users are prompted to confirm delete the choosen branches.
+    #
+    # The appropiate action is taken based on the user's input
+    # and the deleted or undeleted branches are returned.
+    def trim_branches
+      @selection = Downup::Base.new(
+        options: branch_options,
+        type: :multi_select,
+        multi_select_selector: multi_select_selector,
+        selected_color: selected_color,
+        header_proc: header_proc
+      ).prompt
+
+      delete_branches_confirmation
+      @selection
+    end
+
+    private
+
+    attr_reader :stdout, :stdin, :multi_select_selector, :selected_color
+
+    def branch_options
+      branch_keys.zip(branches).each_with_object({}) do |option, hash|
+        hash[option.first] = option.last
+      end
+    end
+
+    def branch_keys
+      ("a".."z").take(branches.count)
+    end
+
+    def branches
+      IO.popen("git branch").each_line.map(&:chomp).map(&:lstrip)
+    end
+
+    def delete_branches_confirmation
+      stdout.puts "\n\nDelete Branches?\n".red
+      stdout.puts @selection
+      stdout.print "\n(y/n) > ".light_black
+      process_input(stdin.gets.chomp)
+    end
+
+    def process_input(input)
+      case input
+      when "y" then delete_branches!
+      when "n" then quit_or_continue
+      else
+        stdout.puts "please choose y or n"
+        delete_branches_confirmation
+      end
+    end
+
+    def delete_branches!
+      @selection.each do |branch|
+        cmd = "git branch -D #{branch}"
+        stdout.puts "\n...running " + cmd.red + "\n\n"
+        system(cmd)
+      end
+      quit_or_continue
+    end
+
+    def quit_or_continue
+      quit_or_continue_prompt
+      case stdin.gets.chomp
+      when "q", "quit"
+        stdout.puts "\n...thanks for using tree trimmer!".light_cyan
+      when "c", "continue"
+        trim_branches
+      else
+        stdout.puts "please choose a relevant option"
+        quit_or_continue
+      end
+    end
+
+    def sanitize_branches!
+      branches.each do |branch|
+        branches.delete(branch) if branch.include?("master")
+      end
+    end
+
+    def quit_or_continue_prompt
+      stdout.puts ("-" * 80).light_black
+      stdout.puts "\nq or quit to abort".light_red
+      stdout.puts "c or continue to continue\n".light_yellow
+      stdout.print "> "
+    end
+
+    def header_proc
+      proc {
+        stdout.puts "\n------------------"
+        stdout.puts "-- Tree Trimmer --"
+        stdout.puts "------------------\n\n"
+      }
+    end
+  end
+end

data/lib/tree_trimmer/version.rb

@@ -1,3 +1,3 @@
 module TreeTrimmer
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/tree_trimmer.gemspec

@@ -19,8 +19,8 @@ Gem::Specification.new do |spec|
   spec.executables   = ["tree_trimmer"]
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_runtime_dependency "downup", "~> 0.10.6"
+  spec.add_runtime_dependency "downup", "0.11.6"
   spec.add_runtime_dependency "colorize"
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: tree_trimmer
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - David Begin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-29 00:00:00.000000000 Z
+date: 2015-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -42,16 +42,16 @@ dependencies:
   name: downup
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.10.6
+        version: 0.11.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 0.10.6
+        version: 0.11.6
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +74,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -84,7 +85,9 @@ files:
 - bin/console
 - bin/setup
 - bin/tree_trimmer
+- examples/basic.rb
 - lib/tree_trimmer.rb
+- lib/tree_trimmer/base.rb
 - lib/tree_trimmer/version.rb
 - tree_trimmer.gemspec
 homepage: https://github.com/presidentJFK/tree_trimmer