git_miner 0.1.0 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0aa67e6c72b1527778f786fb604807437789516188c2b0aac1d6520701571762
-  data.tar.gz: 9323e1fcd8d7ab220b10ef465baf8a158252b7bf6f317366707f7954a69f11e3
+  metadata.gz: 6a915c54b13e195ecbe3b95b74e4244702fd9bec71a984a87e59a02080ebddef
+  data.tar.gz: 4661c7660d691af5e236064a7da19460d5adbad3f44881b3268d955e2e59f0ea
 SHA512:
-  metadata.gz: 6d6e3c36b03808d24f4e8ae8dafd7cec12da24d586cabc637d667ed76a5c9c446f017764a80f57a1cefd2e0ca349c61bc2eb3948cb76998c97992aaa4497218b
-  data.tar.gz: aaeef8f54d352eb93649de28f2d54f107b1ac7e5d856505660f9a7a649aa8c436062216ffaf2ca5da04771e3cd35292b9963fa620fb91213bdcd804c904e8ca6
+  metadata.gz: 5ed7b15ee18e8662845858310b5eaab75ad9e719f43c5f190dbaaf465905ab7b66261f4cea721f706b54fb41a7768a0da55ddd8282c284b12dd6d3aeb32a5ded
+  data.tar.gz: 0a143498f08746fcb3fa71f69988209284ef65f7e5aec5aae2e1c952f599bcc25d93735102076d988b3ab4a8d5169e493c04a8738b42c04686a686a503557c10

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 
 *.gem
+lib/*.bundle

data/Gemfile.lock

@@ -1,17 +1,17 @@
 PATH
   remote: .
   specs:
-    git_miner (0.1.0)
+    git_miner (0.2.2)
       concurrent-ruby (~> 1.1)
       parallel (~> 1.17)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.3)
-    parallel (1.17.0)
-    rake (10.5.0)
+    parallel (1.21.0)
+    rake (13.0.1)
     rake-compiler (1.0.7)
       rake
     rspec (3.8.0)
@@ -34,9 +34,9 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.0)
   git_miner!
-  rake (~> 10.0)
+  rake (~> 13.0)
   rake-compiler (~> 1.0)
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.0.1
+   2.2.32

data/README.md

@@ -1,28 +1,53 @@
 # GitMiner
 
-Pet project I build experimenting with different concepts.
+Pet project I built to experiment with different concepts.
 
-GitMiner allow for "mining" of vanity git prefixes.
+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
 
-Installation will add the `git-mine` binary.
+These options will add the `git-mine` binary which act as a Git custom command: `git mine`.
+
+### Rubygem
 
 ```ruby
 gem 'git_miner'
 ```
 
+### Manual
+
+```
+gem build git_miner.gemspec
+gem install --local git_miner-*.gem 
+```
 
 ## 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.:
 ```
 git mine c0ffee
 ```
 
-Some extra options are available. `git-mine -h` will display the help section (default options are optimised for performance).
+Some extra options are available (experimental):
+```
+$ 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/Rakefile

@@ -7,7 +7,7 @@ RSpec::Core::RakeTask.new(:spec)
 task :default => :spec
 
 Rake::ExtensionTask.new "git_miner_ext" do |ext|
-  ext.lib_dir = "lib/git_miner"
+  ext.lib_dir = "lib"
 end
 
-Rake::Task[:test].prerequisites << :compile
+Rake::Task[:spec].prerequisites << :compile

data/bin/git-mine

@@ -2,8 +2,7 @@
 
 STDOUT.sync = true
 
-require 'git_miner'
-
+require File.join(__dir__, '..', 'lib', 'git_miner')
 
 require 'optparse'
 
@@ -12,28 +11,53 @@ options = {
   dispatch: :parallel,
 }
 
-OptionParser.new do |opts|
-  opts.banner = "Usage: example.rb [options]"
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: git mine [options]"
+
+  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 |dispatch|
+    options[:dispatch] = dispatch
+  end
+
+  opts.on("--verbose", "Run verbosely (default: false)") do |verbose|
+    options[:verbose] = verbose
+  end
+
+  opts.on("--register [prefix]", "Register automated post commit git hook") do |prefix|
+    if prefix.nil?
+      puts parser
+      exit 1
+    end
 
-  opts.on("--engine [ruby|c]", [:ruby, :c], "Desired engine (default: ruby)") do |x|
-    options[:engine] = x
+    GitMiner::RegisterHook.register(prefix: prefix)
+    exit
   end
 
-  opts.on("--dispatch [simple|parallel]", [:simple, :parallel], "Desired dispatch (default: parallel)") do |x|
-    options[:dispatch] = x
+  opts.on_tail("-v", "--version", "Returns the current version") do
+    puts "GitMiner #{GitMiner::VERSION}"
+    exit
   end
 
   opts.on_tail("-h", "--help", "Show this message") do
     puts opts
     exit
   end
-end.parse!
+end
+
+parser.parse!
 
 unless ARGV.size == 1
-  puts opts
+  puts parser
   exit 1
 end
 
+GitMiner.logger.level = options[:verbose] ? Logger::DEBUG : Logger::INFO
+
+GitMiner.logger.debug("OptionParser: #{options.inspect}")
+
 prefix = ARGV.first
 
 engine = case(options[:engine])

data/git_miner.gemspec

@@ -33,13 +33,13 @@ Gem::Specification.new do |spec|
   spec.executables   = ["git-mine"]
   spec.require_paths = ["lib"]
 
-  spec.extensions = %w[ext/git_miner_ext/extconf.rb]
+  spec.extensions = Dir["ext/**/extconf.rb"]
 
   spec.add_runtime_dependency "parallel", "~> 1.17"
   spec.add_runtime_dependency "concurrent-ruby", "~> 1.1"
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rake-compiler", "~> 1.0"
 end

data/lib/git_miner/core.rb

@@ -1,7 +1,11 @@
 module GitMiner
   class Core
     def initialize(engine:, dispatch:, prefix:)
-      puts "Initializing with engine '#{engine}'. dispatch '#{dispatch}' and prefix '#{prefix}'"
+      GitMiner.logger.info("Initializing")
+
+      GitMiner.logger.debug("- Prefix: #{prefix}")
+      GitMiner.logger.debug("- Engine: #{engine::IDENTIFIER}")
+      GitMiner.logger.debug("- Dispatch: #{dispatch::IDENTIFIER}")
 
       @prefix = prefix
 
@@ -35,14 +39,14 @@ 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
 
-      puts "Validations: Successful"
+      GitMiner.logger.debug("Prefix validation: Accepted")
     end
 
     def mine
-      puts "Mining for sha"
+      GitMiner.logger.info("Mining for SHA: #{@prefix}")
 
       @mining_result = @dispatch.execute
     end
@@ -50,10 +54,9 @@ module GitMiner
     def report
       raise "Prerequisite: Require mining to be completed first" unless @mining_result
 
-      puts "Mining results:"
-      puts "- New sha: #{@mining_result.sha}"
-      puts "- Author offset: #{@mining_result.author_offset}"
-      puts "- Committer offset: #{@mining_result.committer_offset}"
+      GitMiner.logger.debug("Mining completed.")
+      GitMiner.logger.debug("Author offset: #{@mining_result.author_offset}")
+      GitMiner.logger.debug("Committer offset: #{@mining_result.committer_offset}")
     end
 
     def alter
@@ -62,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/dispatch/abstract_dispatch.rb

@@ -1,6 +1,8 @@
 module GitMiner
   module Dispatch
     class AbstractDispatch
+      IDENTIFIER = "N/A"
+
       BATCH_SIZE = 50_000
 
       def initialize(prefix:, engine:)

data/lib/git_miner/dispatch/parallel_dispatch.rb

@@ -4,6 +4,8 @@ require 'concurrent'
 module GitMiner
   module Dispatch
     class ParallelDispatch < AbstractDispatch
+      IDENTIFIER = "Parallel"
+
       class ShaFound < StandardError
         attr_reader :result
 

data/lib/git_miner/dispatch/simple_dispatch.rb

@@ -1,6 +1,8 @@
 module GitMiner
   module Dispatch
     class SimpleDispatch < AbstractDispatch
+      IDENTIFIER = "Simple"
+
       def perform
         loop do
           result = @engine.mine(

data/lib/git_miner/engine/abstract_engine.rb

@@ -1,6 +1,7 @@
 module GitMiner
   module Engine
     class AbstractEngine
+      IDENTIFIER = "N/A"
 
       def sha1(_str)
         raise NotImplementedError

data/lib/git_miner/engine/c_extension_engine.rb

@@ -1,10 +1,14 @@
-require 'git_miner_ext'
+require 'openssl'
+
+require File.join(__dir__, '..', '..', 'git_miner_ext')
 
 module GitMiner
   module Engine
     class CExtensionEngine < AbstractEngine
       include GitMinerExt
 
+      IDENTIFIER = "CExtension"
+
       def sha1(str)
         c_sha1_hexdigest(str)
       end

data/lib/git_miner/engine/ruby_engine.rb

@@ -3,6 +3,8 @@ require 'digest'
 module GitMiner
   module Engine
     class RubyEngine < AbstractEngine
+      IDENTIFIER = "Ruby"
+
       def sha1(str)
         Digest::SHA1.hexdigest(str)
       end
@@ -26,7 +28,7 @@ module GitMiner
           end
         end
 
-        return
+        nil
       end
 
       private

data/lib/git_miner/git_util.rb

@@ -34,9 +34,10 @@ module GitMiner
       private
 
       def shell(cmd, environment: {}, stdin_data: nil)
-        puts "System call: #{cmd}"
-        puts "environment: #{environment.inspect}" unless environment.empty?
-        puts "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
 
-        puts "result: #{output}"
+        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 << "#{percentage.round(2)}%"
+      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: #{per_sec.round(2)}/s"
+        info << "hash: #{'%.0f' % per_sec}/s"
 
         per_sec = (@historic.last[:batch] - @historic.first[:batch]) / historic_delay
-        info << "batches: #{per_sec.round(2)}/s"
+        info << "batches: #{'%.2f' % per_sec}/s"
       end
 
-      puts 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.1.0"
+  VERSION = "0.2.3"
 end

data/lib/git_miner.rb

@@ -4,5 +4,25 @@ Dir[File.join(__dir__, 'git_miner', '**', '*.rb')].each do |file|
 end
 
 module GitMiner
-  class Error < StandardError; end
+  class UserError < StandardError; 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
+
+      @logger
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: git_miner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.3
 platform: ruby
 authors:
 - Thierry Joyal
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2022-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -128,13 +128,14 @@ 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: []
 metadata:
   homepage_uri: https://github.com/tjoyal/git_miner
   source_code_uri: https://github.com/tjoyal/git_miner
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -149,8 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: git-mine shell executable
 test_files: []