peacock 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fac84611573a5fd44f62cde9faa8a1629218d3f8
-  data.tar.gz: 90c4812009455f94839f36e632eb2c7166395571
+  metadata.gz: 84ea91580dc4505136482f503da3b8bc0fb36749
+  data.tar.gz: 1feb55166e087b89c66fa7684debe05f636b1070
 SHA512:
-  metadata.gz: c08ef5075610bae74a67ac04cfb9457f6bfbc2908e10ea56a50866b277fbc9017d325e7ae58eabcf60157755f0ba77f7ef721c16bc8180f386710a2db426df16
-  data.tar.gz: 45b12fe8af6c20d2636e30acf764b5276b296e241dbff7867b670234d834577613f44f5f3b12fdf39d65c46146faebbd951e4cded887357046bd531396a3a206
+  metadata.gz: 7356035129eec6ba016805660e380f278cab400e7e22f047dbbed419e7ade6402372eec6bd680e96f4076d3d69933555f1b3ad23c9584d4406ec64522739d582
+  data.tar.gz: 28e4d4a38b0a25b201b6374146bfb807af7bba7d16ba87599b0c3b1dce0781e85676dad571b117c8ef602e2649aee69130c18a8b3b72395633314b0794d0d5b7

data/.gitignore

@@ -1,3 +1,4 @@
+/.idea
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/.travis.yml

@@ -1,4 +1,4 @@
 language: ruby
 rvm:
   - 2.2.2
-sdfsd
+  - 2.2.3

data/README.md

@@ -2,14 +2,15 @@
 
 Peacock is a small tool to easily manage your .gitignore written in ruby.
 
-At the moment, Peacock can only be executed from the root directory of your repository.
+It lets you ignore and extract files and directories using .gitignore in your current git repository.
 
-In order to perform your changes on .gitignore, peacock will automatically add all current files to the index
-and perform a commit before and after you execute peacock.
+Note that while ignoring files and directories peacock will perform safety commits to make sure your work is not lost. It will commit all your uncommited work (if there is any) before and after adding files to .gitignore.
 
-## Installation
+While extracting, peacock leaves everything untouched.
+
+Note that at the moment you can't combine options with one hyphen (e.g.: -ev for --extract and --verbose) but you have to pass them separated (e.g.: -e -v)
 
-Add this line to your application's Gemfile:
+## Installation
 
 Install by executing:
 
@@ -17,23 +18,50 @@ Install by executing:
 
 ## Usage
 
-Usage: 
-  peacock [options] [files/directories]
-        
-  Options:
-    -h, [--help]           # show this text
-    -r, [--root]           # use root .gitignore (not functional yet)
-    -e, [--extract]        # extract file from .gitignore (not functional yet)
-    -l, [--list]           # list all ignored directories and files (not functional yet)
+Usage:
+
+    peacock [options] [files/directories]
+  
+Options:
+
+    -h, [--help]        # show this text
+    -r, [--root]        # use root .gitignore
+    -v, [--verbose]     # surpress output
+    -e, [--extract]     # extract file from .gitignore
+
+## Example
+
+    $ git status
+    ...
+    Untracked files:
+	    these
+	    are
+	    some
+	    files
+    
+    $ peacock are some
+    added are to .gitignore
+    added some to .gitignore
+    
+    $ git status
+    On branch master
+    nothing to commit, working directory clean
+    
+    $ peacock -e are
+    removed are from .gitignore
+    
+    $ git status
+    ...
+    Untracked files:
+	    are
 
+    
 ## TODO
 
-- ruby-git does not recognize a repo unless you are in the root directory. a different mechanism is needed
-- implement own small git library for peacock
-- create a test environment and better tests
 - add functionalities
 - custom commit messages
 - comments in .gitignore
+- options can't be combined (e.g. -ev for extract and surpress)
 
 ## Contributing
 

data/Rakefile

@@ -6,3 +6,5 @@ Rake::TestTask.new do |task|
   task.libs << %w(test)
   task.pattern = 'test/test_*.rb'
 end
+
+task default: :test

data/lib/git/base.rb

@@ -0,0 +1,18 @@
+module Git
+  class Base
+    
+    # wrapper for command method which returns the output
+    def self.command_output(command = '', opts = '')
+      f = command(command, opts)
+      output = f.readlines.join
+      f.close
+      output
+    end
+  
+    # wrapper for git commands
+    def self.command(command = '', opts = '')
+      IO.popen("git #{command} #{opts} 2>&1") # 2>&1 surpresses stderr
+    end
+    
+  end
+end

data/lib/git/error.rb

@@ -0,0 +1,5 @@
+class NoGitRepositoryError < StandardError
+end
+
+class NoGitInstalledError < StandardError
+end

data/lib/git/lib.rb

@@ -0,0 +1,33 @@
+# Available Git commands
+module Git
+  
+  module Lib
+    
+    def self.git
+      Git::Base.command_output
+    end
+    
+    def self.init
+      Git::Base.command_output('init')
+    end
+    
+    def self.status
+      Git::Base.command_output('status')
+    end
+    
+    def self.commit_all(message)
+      Git::Base.command_output('add', '-A')
+      Git::Base.command_output('commit', "-m '#{message}'")
+    end
+    
+    def self.clear_cache
+      Git::Base.command_output('rm', '-r --cached .')
+    end
+    
+    def self.log
+      Git::Base.command_output('log')
+    end
+    
+  end
+  
+end

data/lib/git.rb

@@ -0,0 +1,50 @@
+require 'git/base'
+require 'git/error'
+require 'git/lib'
+
+module Git
+  
+  # checks if git is installed
+  def self.check_git_existance
+    output = git
+    
+    unless /\Ausage: git/ =~ output
+      raise NoGitInstalledError, 'git was not found. make sure you have it installed'
+    end
+  end
+  
+  # checks if current directory is a git repository
+  def self.check_repo_existance
+    output = status
+    
+    unless /\AOn branch/ =~ output
+      raise NoGitRepositoryError, 'you are not in a git repository.'
+    end
+  end
+  
+  # so Git calls follow the Git.<command> pattern
+  def self.git
+    Git::Lib.git
+  end
+  
+  def self.init
+    Git::Lib.init
+  end
+  
+  def self.status
+    Git::Lib.status
+  end
+  
+  def self.commit_all(message)
+    Git::Lib.commit_all(message)
+  end
+  
+  def self.clear_cache
+    Git::Lib.clear_cache
+  end
+  
+  def self.log
+    Git::Lib.log
+  end
+  
+end

data/lib/peacock/{parser.rb → cli.rb}

@@ -1,15 +1,15 @@
 module Peacock
 
-  class Parser
+  class CLI
     
     def self.parse
-      parser = Parser.new
+      parser = CLI.new
       parser.check_if_help_text
-      parser.parse_args.hash
+      parser.parse_args
     end
     
     def parse_args
-      return_hash = Peacock::ParseHash.new
+      return_hash = Peacock::CLIHash.new
       
       ARGV.each do |arg|
         type = determine_type arg
@@ -49,14 +49,14 @@ module Peacock
         
         Options:
           \t-h, [--help]           # show this text
-          \t-r, [--root]           # use root .gitignore (not functional yet)
-          \t-e, [--extract]        # extract file from .gitignore (not functional yet)
-          \t-l, [--list]           # list all ignored directories and files (not functional yet)
+          \t-r, [--root]           # use root .gitignore
+          \t-v, [--verbose]        # surpress output
+          \t-e, [--extract]        # extract file from .gitignore
       EOF
     end
     
     def options
-      ['-r', '--root', '-e', '--extract', '-l', '--list']
+      %w(-r --root -e --extract -v --verbose)
     end
     
   end

data/lib/peacock/cli_hash.rb

@@ -0,0 +1,57 @@
+module Peacock
+
+  class CLIHash
+    
+    attr_reader :hash
+    
+    def initialize
+      @hash = Hash.new
+      @hash[:opts] = Array.new
+      @hash[:files] = Array.new
+      @hash[:dirs] = Array.new
+    end
+    
+    def push(type, str)
+      if type == :dirs
+        str = str + '/' unless str =~ /\/$/  # add backlash to dir name if it does not exist yet
+        str = '/' + str unless str =~ /^\//   # add backlash to beginning of dir name if it does not exist yet
+      end
+
+      @hash[type].push(str)
+    end
+    
+    def opts
+      @hash[:opts]
+    end
+    
+    def files
+      @hash[:files]
+    end
+    
+    def dirs
+      @hash[:dirs]
+    end
+    
+    def to_s
+      hash.to_s
+    end
+    
+    def root_ignore?
+      opts.include?('-r') || opts.include?('--root')
+    end
+    
+    def verbose?
+      opts.include?('-v') || opts.include?('--verbose')
+    end
+    
+    def engine
+      if opts.include?('-e')
+        return Peacock::Engine::Extractor
+      else
+        return Peacock::Engine::Ignorer
+      end  
+    end
+    
+  end
+  
+end

data/lib/peacock/engine/engine.rb

@@ -0,0 +1,45 @@
+# some general engine code
+
+module Peacock
+  
+  module Engine
+    
+    def self.execute(opt_hash)
+      opt_hash.engine.start_engine(opt_hash)  # opt_hash.engine returns the engine as a class on which we will call the general method start_engine
+    end
+    
+    module Engine
+      
+      def check_and_return_hash(opt_hash)
+        raise PeacockError, '#{self.class} expects an instance of Peacock::CLIHash' unless opt_hash.class == CLIHash
+        opt_hash
+      end
+      
+      def determine_git_ignore_path
+        if @hash.root_ignore?
+          determine_root_dir
+        else
+          '.gitignore'
+        end
+      end
+    
+      def determine_root_dir
+        old_path = Dir.pwd
+        while not Dir.exists? '.git'
+          Dir.chdir '..'
+        end
+      
+        path = Dir.pwd() + '/.gitignore'
+        Dir.chdir(old_path)
+        path
+      end
+      
+      def git_ignore_exists?(path)
+        raise PeacockError, '#{self.class} expects .gitignore to exist at #{path}' unless File.exists?(path)
+      end
+      
+    end
+    
+  end
+
+end

data/lib/peacock/engine/extractor.rb

@@ -0,0 +1,64 @@
+module Peacock
+  
+  module Engine
+    
+    class Extractor
+      include Peacock::Engine::Engine
+      
+      def self.start_engine(opt_hash)
+        extractor = Extractor.new(opt_hash)
+        extractor.workflow
+      end
+      
+      def initialize(opt_hash)
+        @hash = check_and_return_hash(opt_hash)
+        @logger = Peacock::Logger.new(@hash.verbose?)
+        path = determine_git_ignore_path
+        git_ignore_exists?(path)
+
+        # open in mode read-write (beginning of file)
+        @git_ignore = File.open(path, 'r')
+      end
+      
+      def workflow
+        extract_files_and_directories
+        @git_ignore.close
+      end
+      
+      def extract_files_and_directories
+        delete_list = []
+        ignore_lines = @git_ignore.readlines
+        
+        # determine delete_list (cant use delete_if cause of logger logic)
+        determine_delete_list(ignore_lines, delete_list)
+        
+        delete_list.each do |entry|
+          ignore_lines.delete_at(entry)
+        end
+           
+        # reopen in writable mode and input all new git ignore entries
+        @git_ignore.reopen(@git_ignore.path, 'w')
+
+        ignore_lines.each do |line|
+          @git_ignore.write(line)
+        end
+      end
+      
+      def determine_delete_list(ignore_lines, delete_list)
+        ignore_lines.each_with_index do |line,index|
+          if hash_includes_line?(line)
+            delete_list.push(index)
+            @logger.extract(line.chomp("\n"))
+          end
+        end
+      end
+      
+      def hash_includes_line?(line)
+        @hash.dirs.include?(line.chomp("\n")) || @hash.files.include?(line.chomp("\n"))
+      end
+      
+    end
+    
+  end
+  
+end      

data/lib/peacock/engine/ignorer.rb

@@ -0,0 +1,66 @@
+module Peacock
+  
+  module Engine
+  
+    class Ignorer
+      include Peacock::Engine::Engine
+      
+      def self.start_engine(opt_hash)
+        ignorer = Ignorer.new(opt_hash)
+        ignorer.workflow
+      end
+    
+      def initialize(opt_hash)
+        @hash = check_and_return_hash(opt_hash)
+        @logger = Peacock::Logger.new(@hash.verbose?)
+        path = determine_git_ignore_path
+        @git_ignore = File.open(path, 'a+')
+      end
+    
+      def workflow
+        Git.commit_all('peacock: before .gitignore commit')
+        ignore_files_and_directories
+        Git.clear_cache
+        Git.commit_all('peacock: after .gitignore commit')
+        @git_ignore.close
+      end
+    
+      def ignore_files_and_directories
+        ignore_files
+        ignore_directories
+      end
+    
+      def ignore_directories
+        @hash.dirs.each do |dir|
+          check_and_write(dir)
+        end
+      end
+    
+      def ignore_files
+        @hash.files.each do |file|
+          check_and_write(file)
+        end
+      end
+    
+      def check_and_write(str)
+        unless entry_exists?(str)
+          @git_ignore.write(str + "\n")
+          @logger.ignore(str)
+        end
+      
+        @git_ignore.rewind
+      end
+    
+      def entry_exists?(entry)
+        @git_ignore.each do |line|
+          return true if line.chomp == entry
+        end
+        false
+      end
+    
+    end
+    
+  end
+  
+end
+

data/lib/peacock/logger.rb

@@ -0,0 +1,19 @@
+module Peacock
+  
+  class Logger
+  
+    def initialize(verbose)
+      @verbose = verbose
+    end
+    
+    def ignore(string)
+      puts "added #{string} to .gitignore" unless @verbose
+    end
+    
+    def extract(string)
+      puts "removed #{string} from .gitignore" unless @verbose
+    end
+    
+  end
+  
+end

data/lib/peacock/startup_manager.rb

@@ -3,28 +3,8 @@ module Peacock
   class StartupManager
     
     def self.check_peacock_requirements
-      startup = StartupManager.new
-      
-      begin
-        startup.check_git_repository
-      rescue PeacockError
-        puts 'An error occured. Make sure you are in a git repository and git is installed.'
-        exit 1
-      end
-    end
-    
-    def check_git_repository
-      raise PeacockError unless git_repository?
-    end
-    
-    # checks if current directory is a git repository
-    def git_repository?
-      begin
-        Git.open Dir.pwd
-        true
-      rescue
-        false
-      end
+      Git.check_git_existance
+      Git.check_repo_existance
     end
     
   end

data/lib/peacock/version.rb

@@ -1,3 +1,3 @@
 module Peacock
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/peacock.rb

@@ -1,20 +1,21 @@
 require 'git'
-require 'open3'
-
+require 'peacock/logger'
 require 'peacock/version'
-require 'peacock/peacock_exception'
+require 'peacock/error'
 require 'peacock/startup_manager'
-require 'peacock/parse_hash'
-require 'peacock/parser'
-require 'peacock/ignorer'
+require 'peacock/cli_hash'
+require 'peacock/cli'
+require 'peacock/engine/engine'
+require 'peacock/engine/extractor'
+require 'peacock/engine/ignorer'
 
 
 module Peacock
 
   def self.execute
+    cli_hash = Peacock::CLI.parse
     Peacock::StartupManager.check_peacock_requirements
-    parse_hash = Peacock::Parser.parse
-    Peacock::Ignorer.ignore(parse_hash)
+    Peacock::Engine.execute(cli_hash)
   end
 
 end

data/peacock.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Christian Paling"]
   spec.email         = ["christian.paling@googlemail.com"]
 
-  spec.summary       = %q{Peacock development is in progress. This gem will make it easy to add files to .gitignore}
-  spec.description   = %q{Longer Description}
+  spec.summary       = %q{Peacock is a small tool to easily manage your .gitignore}
+  spec.description   = %q{Peacock is a small tool to easily manage your .gitignore}
   spec.homepage      = "https://github.com/bakku/peacock"
   spec.license       = "MIT"
 
@@ -21,5 +21,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.9"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "git"
+  spec.add_development_dependency "minitest"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: peacock
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Christian Paling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2015-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: git
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Longer Description
+description: Peacock is a small tool to easily manage your .gitignore
 email:
 - christian.paling@googlemail.com
 executables:
@@ -67,11 +67,18 @@ files:
 - README.md
 - Rakefile
 - exe/peacock
+- lib/git.rb
+- lib/git/base.rb
+- lib/git/error.rb
+- lib/git/lib.rb
 - lib/peacock.rb
-- lib/peacock/ignorer.rb
-- lib/peacock/parse_hash.rb
-- lib/peacock/parser.rb
-- lib/peacock/peacock_exception.rb
+- lib/peacock/cli.rb
+- lib/peacock/cli_hash.rb
+- lib/peacock/engine/engine.rb
+- lib/peacock/engine/extractor.rb
+- lib/peacock/engine/ignorer.rb
+- lib/peacock/error.rb
+- lib/peacock/logger.rb
 - lib/peacock/startup_manager.rb
 - lib/peacock/version.rb
 - peacock.gemspec
@@ -95,9 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: Peacock development is in progress. This gem will make it easy to add files
-  to .gitignore
+summary: Peacock is a small tool to easily manage your .gitignore
 test_files: []

data/lib/peacock/ignorer.rb

@@ -1,67 +0,0 @@
-module Peacock
-
-  class Ignorer
-    
-    def self.ignore(opt_hash)
-      ignorer = Ignorer.new(opt_hash)
-      ignorer.commit_all('peacock: before .gitignore commit')
-      ignorer.ignore_files_and_directories
-      ignorer.clear_cache
-      ignorer.commit_all('peacock: after .gitignore commit')
-    end
-    
-    def initialize(opt_hash)
-      @hash = opt_hash
-      @git_ignore = File.open('.gitignore', 'a+')
-      @repo = Git.open Dir.pwd
-    end
-    
-    def clear_cache
-      # totally ugly, but ruby-git does not support git rm -r --cached
-      Open3.popen3('git rm -r --cached .') do |stdin, stdout, stderr, thread|
-        # ignore output
-      end
-    end
-    
-    def commit_all(message)
-      begin
-        @repo.add(all: true) 
-        @repo.commit_all(message)
-      rescue
-        # do nothing
-      end
-    end
-    
-    def ignore_files_and_directories
-      ignore_files
-      ignore_directories
-    end
-    
-    def ignore_directories
-      @hash[:dirs].each do |dir|
-        dir = dir + '/' unless dir =~ /\/$/  # add backlash to dir name if it does not exist yet
-        check_and_write(dir)
-      end
-    end
-    
-    def ignore_files
-      @hash[:files].each do |file|
-        check_and_write(file)
-      end
-    end
-    
-    def check_and_write(str)
-      @git_ignore.write(str + "\n")  unless entry_exists?(str)
-      @git_ignore.rewind
-    end
-    
-    def entry_exists?(entry)
-      @git_ignore.each do |line|
-        return true if line.chomp == entry
-      end
-      false
-    end
-    
-  end
-end
-

data/lib/peacock/parse_hash.rb

@@ -1,24 +0,0 @@
-module Peacock
-
-  class ParseHash
-    
-    attr_reader :hash
-    
-    def initialize
-      @hash = Hash.new
-      @hash[:opts] = Array.new
-      @hash[:files] = Array.new
-      @hash[:dirs] = Array.new
-    end
-    
-    def push(type, str)
-      @hash[type].push(str)
-    end
-    
-    def to_s
-      hash.to_s
-    end
-    
-  end
-  
-end