git_miner 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0189bf9c342c04a3575700876f73dc9132eeab57ecd5127619ed591d4a9486a
-  data.tar.gz: 01db41129cc22cd8c4fd2ba3251603925613fe23ab028fa4b57cb88d05151b15
+  metadata.gz: 6a915c54b13e195ecbe3b95b74e4244702fd9bec71a984a87e59a02080ebddef
+  data.tar.gz: 4661c7660d691af5e236064a7da19460d5adbad3f44881b3268d955e2e59f0ea
 SHA512:
-  metadata.gz: a1d345cc49d44ef896a5875b7b4ab12679e72ed581301d9d5ef1500b84eb2a707af14e3d632da8d5e8a3b5654d54c2adc81e66a01b1454ffde2b16f2b8b3664d
-  data.tar.gz: f1ace38aefce766c9265269888b1c6f625461095ef5327a35723af392879d8c21e1c56a4c6d908b7f8eeda077bf5750e714b11477355b879449cce3d706aea13
+  metadata.gz: 5ed7b15ee18e8662845858310b5eaab75ad9e719f43c5f190dbaaf465905ab7b66261f4cea721f706b54fb41a7768a0da55ddd8282c284b12dd6d3aeb32a5ded
+  data.tar.gz: 0a143498f08746fcb3fa71f69988209284ef65f7e5aec5aae2e1c952f599bcc25d93735102076d988b3ab4a8d5169e493c04a8738b42c04686a686a503557c10

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    git_miner (0.2.1)
+    git_miner (0.2.2)
       concurrent-ruby (~> 1.1)
       parallel (~> 1.17)
 

data/README.md

@@ -4,28 +4,29 @@ Pet project I built to experiment with different concepts.
 
 GitMiner allow "mining" of vanity Git SHA1 prefixes.
 
-This gem is a work in progress (core functionality is working).
+The HEAD commit is altered via variations over committer and author timestamp adjustments. Other commit metadata such as commit message or description are left as their original.
 
 
 ## Installation
 
-Rubygem:
+These options will add the `git-mine` binary which act as a Git custom command: `git mine`.
+
+### Rubygem
+
 ```ruby
 gem 'git_miner'
 ```
 
-Development:
+### Manual
+
 ```
 gem build git_miner.gemspec
 gem install --local git_miner-*.gem 
 ```
 
-The installation will add the `git-mine` binary which act as a Git custom command: `git mine`.
-
-
 ## Usage
 
-Though `git`, using `git mine [DESIRED_PREFIX]` will invoke the required logic.
+`git mine [DESIRED_PREFIX]` will amend the current HEAD commit with a new mined SHA.
 
 Eg.:
 ```
@@ -34,9 +35,19 @@ git mine c0ffee
 
 Some extra options are available (experimental):
 ```
-$ git-mine -h
-Usage: example.rb [options]
+$ git mine -h
+Usage: git mine [options]
         --engine [ruby|c]            Set the engine (default: ruby)
         --dispatch [simple|parallel] Set the dispatch (default: parallel)
+        --verbose                    Run verbosely (default: false)
+        --register [prefix]          Register automated post commit git hook
+    -v, --version                    Returns the current version
     -h, --help                       Show this message
 ```
+
+
+### Development
+
+```
+[path]/git_miner/bin/git-mine ...
+```

data/bin/git-mine

@@ -2,7 +2,7 @@
 
 STDOUT.sync = true
 
-require 'git_miner'
+require File.join(__dir__, '..', 'lib', 'git_miner')
 
 require 'optparse'
 
@@ -12,21 +12,31 @@ options = {
 }
 
 parser = OptionParser.new do |opts|
-  opts.banner = "Usage: example.rb [options]"
+  opts.banner = "Usage: git mine [options]"
 
-  opts.on("--engine [ruby|c]", [:ruby, :c], "Set the engine (default: ruby)") do |x|
-    options[:engine] = x
+  opts.on("--engine [ruby|c]", [:ruby, :c], "Set the engine (default: ruby)") do |engine|
+    options[:engine] = engine
   end
 
-  opts.on("--dispatch [simple|parallel]", [:simple, :parallel], "Set the dispatch (default: parallel)") do |x|
-    options[:dispatch] = x
+  opts.on("--dispatch [simple|parallel]", [:simple, :parallel], "Set the dispatch (default: parallel)") do |dispatch|
+    options[:dispatch] = dispatch
   end
 
-  opts.on("-v", "--[no-]verbose", "Run verbosely (default: false)") do |v|
-    options[:verbose] = v
+  opts.on("--verbose", "Run verbosely (default: false)") do |verbose|
+    options[:verbose] = verbose
   end
 
-  opts.on_tail("--version", "Returns the current version") do |v|
+  opts.on("--register [prefix]", "Register automated post commit git hook") do |prefix|
+    if prefix.nil?
+      puts parser
+      exit 1
+    end
+
+    GitMiner::RegisterHook.register(prefix: prefix)
+    exit
+  end
+
+  opts.on_tail("-v", "--version", "Returns the current version") do
     puts "GitMiner #{GitMiner::VERSION}"
     exit
   end

data/lib/git_miner/core.rb

@@ -1,10 +1,11 @@
 module GitMiner
   class Core
     def initialize(engine:, dispatch:, prefix:)
-      GitMiner.logger.info("Initializing git miner.")
-      GitMiner.logger.info("Prefix: #{prefix}")
-      GitMiner.logger.debug("Engine: #{engine::IDENTIFIER}")
-      GitMiner.logger.debug("Dispatch: #{dispatch::IDENTIFIER}")
+      GitMiner.logger.info("Initializing")
+
+      GitMiner.logger.debug("- Prefix: #{prefix}")
+      GitMiner.logger.debug("- Engine: #{engine::IDENTIFIER}")
+      GitMiner.logger.debug("- Dispatch: #{dispatch::IDENTIFIER}")
 
       @prefix = prefix
 
@@ -38,10 +39,10 @@ module GitMiner
       end
 
       unless @prefix[/^[0-9a-f]{1,32}$/]
-        raise "Invalid prefix, expected '^[0-9a-f]{1,32}$'"
+        raise(UserError, "Invalid prefix, expected '^[0-9a-f]{1,32}$'")
       end
 
-      GitMiner.logger.debug("Validations: Successful")
+      GitMiner.logger.debug("Prefix validation: Accepted")
     end
 
     def mine
@@ -56,8 +57,6 @@ module GitMiner
       GitMiner.logger.debug("Mining completed.")
       GitMiner.logger.debug("Author offset: #{@mining_result.author_offset}")
       GitMiner.logger.debug("Committer offset: #{@mining_result.committer_offset}")
-
-      GitMiner.logger.info("New SHA: #{@mining_result.sha}")
     end
 
     def alter
@@ -66,7 +65,10 @@ module GitMiner
       author_date = @now - @mining_result.author_offset
       committer_date = @now - @mining_result.committer_offset
 
+      GitMiner.logger.debug("Amending git")
       GitUtil.update_current_ref(author_date, committer_date)
+
+      GitMiner.logger.info("New SHA: #{@mining_result.sha}")
     end
   end
 end

data/lib/git_miner/git_util.rb

@@ -34,9 +34,10 @@ module GitMiner
       private
 
       def shell(cmd, environment: {}, stdin_data: nil)
-        GitMiner.logger.debug("System call: #{cmd}")
-        GitMiner.logger.debug("environment: #{environment.inspect}") unless environment.empty?
-        GitMiner.logger.debug("stdin_data: #{stdin_data}") if stdin_data
+        GitMiner.logger.debug("System call")
+        GitMiner.logger.debug("- cmd: #{cmd}")
+        GitMiner.logger.debug("- environment: #{environment.inspect}") unless environment.empty?
+        GitMiner.logger.debug("- stdin: #{stdin_data}") if stdin_data
 
         output, status = Open3.capture2(environment, cmd, stdin_data: stdin_data) #, chdir: @working_directory
 
@@ -44,7 +45,7 @@ module GitMiner
           raise "Error on system call: #{output}, #{status}"
         end
 
-        GitMiner.logger.debug("result: #{output.strip}")
+        GitMiner.logger.debug("- result => #{output.strip}")
 
         output
       end

data/lib/git_miner/progress.rb

@@ -28,22 +28,24 @@ module GitMiner
     end
 
     def report(count)
-      info = []
-
       percentage = count * 100 / @combinations.to_f
-      info << "#{'%.2f' % percentage}%"
+      info = []
 
       historic_count = @historic.last[:count] - @historic.first[:count]
       historic_delay = @historic.last[:timestamp] - @historic.first[:timestamp]
       if historic_delay > 0
         per_sec = historic_count / historic_delay
-        info << "hash: #{'%.2f' % per_sec}/s"
+        info << "hash: #{'%.0f' % per_sec}/s"
 
         per_sec = (@historic.last[:batch] - @historic.first[:batch]) / historic_delay
         info << "batches: #{'%.2f' % per_sec}/s"
       end
 
-      GitMiner.logger.info(info.join(', '))
+      if info.empty?
+        GitMiner.logger.info("Mining estimate #{'%.2f' % percentage}%")
+      else
+        GitMiner.logger.info("Mining estimate #{'%.2f' % percentage}% (#{info.join(', ')})")
+      end
     end
   end
 end

data/lib/git_miner/utils/register_hook.rb

@@ -0,0 +1,29 @@
+require 'fileutils'
+
+module GitMiner
+  class RegisterHook
+    FILENAME = ".git/hooks/post-commit"
+
+    class << self
+      def register(prefix:)
+        GitMiner.logger.info("Writing hook to #{FILENAME}")
+
+        if File.exists?(FILENAME)
+          File.open(FILENAME, 'a') do |file|
+            file.puts("")
+          end
+        else
+          FileUtils.touch(FILENAME)
+          FileUtils.chmod("+x", FILENAME)
+        end
+
+        File.open(FILENAME, 'a') do |file|
+          file.puts(
+            "# GitMiner hook",
+            "git mine #{prefix}"
+          )
+        end
+      end
+    end
+  end
+end

data/lib/git_miner/version.rb

@@ -1,3 +1,3 @@
 module GitMiner
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/lib/git_miner.rb

@@ -4,13 +4,25 @@ Dir[File.join(__dir__, 'git_miner', '**', '*.rb')].each do |file|
 end
 
 module GitMiner
-  class Error < StandardError; end
+  class UserError < StandardError; end
 
-  def self.logger
-    @logger ||= Logger.new(STDOUT)
-  end
+  class << self
+    def logger
+      return @logger if defined?(@logger)
+
+      @logger = Logger.new(STDOUT)
+
+      @logger.formatter = proc do |severity, datetime, _progname, msg|
+        date_format = datetime.strftime("%Y-%m-%d %H:%M:%S")
+
+        if @logger.level == Logger::INFO
+          "[GitMiner] #{msg}\n"
+        else
+          "[GitMiner] #{date_format} #{severity}: #{msg}\n"
+        end
+      end
 
-  def self.logger=(logger)
-    @logger = logger
+      @logger
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_miner
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Thierry Joyal
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-26 00:00:00.000000000 Z
+date: 2022-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -128,6 +128,7 @@ files:
 - lib/git_miner/group_manager.rb
 - lib/git_miner/mining_result.rb
 - lib/git_miner/progress.rb
+- lib/git_miner/utils/register_hook.rb
 - lib/git_miner/version.rb
 homepage: https://github.com/tjoyal/git_miner
 licenses: []