ogs_katacheck 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dc3dff0e80657df3ef23d7011da1e81bbf3e5dfcfe5e2ace5c28eb9cf69fefc
-  data.tar.gz: 5cd7c089b569f5c53ae90af5270580c82347a167346f12ec40931d366a5d15df
+  metadata.gz: 2baab19f04bb46ebca2c9233288ea4af806716bbf6871765aa6a5048f2c868b7
+  data.tar.gz: aadc143d83e47a546345fbeecebc5c0a24599b505f495f68c0137374efd5a8bb
 SHA512:
-  metadata.gz: 9eda8f4751dbffcbc5367e9ecb07577647e57bbd6aba54b1d717b36c96fcaf1b4daffcfeeb9948f14957b1e78c90307b4057f0b37dbdba896717190e2646c4e2
-  data.tar.gz: c694ff37f069ccd2b2aac02d398fc0b9e85b921fb622b7459e888731e85dbb5bc72e833017a6916b09c95ed6b319e5913c1c89f6e983724ec5677d172356c1ef
+  metadata.gz: 3ff08796e04916871bc281944e78ca87bcaf6693618fc9cb7c091e09b571b9662a694f3422c3bbd36b1eb90f9887b23309cec4727de4b9f4ad870873899f951b
+  data.tar.gz: dc9268e55c96cd61bac98a06f9b92865c1a52d82d7660cc76e1e93aa42ee2b35f0ade3d18f2f8bc8fd0e7e303ce3665d365b4cae10d8eed814dcf4eb6cac5990

data/.gitignore

@@ -6,3 +6,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.DS_Store

data/CHANGELOG.md

@@ -11,3 +11,16 @@
 
 ### 0.1.3
 - bug fix
+
+### 0.1.4
+- bug fix
+
+### 0.1.5
+- bug fix
+
+### 0.1.6
+- fixes bug in the way percentages are calculated
+
+### 0.2.0
+- new formatting for output table
+- fixes error introduced by new uuid attribute on reviews 

data/Gemfile

@@ -5,4 +5,10 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem 'faraday'
+gem 'colorize'
+gem "terminal-table"
 # gem 'pry'
+
+if RUBY_PLATFORM =~ /win32/
+  gem 'win32console'
+end

data/Gemfile.lock

@@ -1,25 +1,33 @@
 PATH
   remote: .
   specs:
-    ogs_katacheck (0.1.3)
+    ogs_katacheck (0.2.1)
+      faraday
+      terminal-table
 
 GEM
   remote: https://rubygems.org/
   specs:
+    colorize (0.8.1)
     faraday (1.1.0)
       multipart-post (>= 1.2, < 3)
       ruby2_keywords
     multipart-post (2.1.1)
     rake (12.3.0)
     ruby2_keywords (0.0.2)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  colorize
   faraday
   ogs_katacheck!
   rake (~> 12.0)
+  terminal-table
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -6,7 +6,7 @@ It pulls game information from the OGS API and checks the user submitted moves a
 
 ## Installation
 
-You will need to have Ruby installed on your machine to run this CLI. If you are using a Mac, this is already done for you. If on a Windows machine you can install it by following [these instructions](https://stackify.com/install-ruby-on-windows-everything-you-need-to-get-going/).
+**You will need to have Ruby installed on your machine to run this CLI.** If you are using a Mac, this should already be done for you. If on a Windows machine you can install it by following [these instructions](https://stackify.com/install-ruby-on-windows-everything-you-need-to-get-going/). You can verify that everything is installed properly by running `ruby -v` and `gem -v`, you should see versions for both after running these commands.
 
 To install this Gem, open a terminal and run:
 
@@ -26,15 +26,13 @@ You will be asked to enter a game ID. This can be simply copied and pasted from
 
 You will then be presented with a list of available OGS AI reviews. **Only full reviews** are useable with this tool.  If you do not see a full review in the list, open the game in OGS and run a full review. Once the server has completed the review, re-run the tool.
 
-The tool will output the number of user submitted moves that match the top 4 moves suggested by the AI in the review. Obviously, `tier 1` and `tier 2` moves are most important to look at, but the overall percentages can also be helpful.
-
-***Note:** A high percentage match in a game does not necessarily mean the user is cheating, but high percentage matches across many games will certainly warrant further investigation.*
+![Review Selection](https://github.com/RubyMineshaft/ogs_katacheck/blob/main/images/reviews.png)
 
-## Development
+The tool will output the number of user submitted moves that match the top 4 moves suggested by the AI in the review. Obviously, `tier 1` and `tier 2` moves are most important to look at, but the overall percentages can also be helpful.
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+![Output Example](https://github.com/RubyMineshaft/ogs_katacheck/blob/main/images/output.png)
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+***Note:** A high percentage match in a game does not necessarily mean the user is cheating, but high percentage matches across many games will certainly warrant further investigation.*
 
 ## Contributing
 

data/bin/katacheck

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require './lib/ogs_katacheck'
+require 'ogs_katacheck'
 
 OGSKataCheck::CLI.new.call

data/bin/ogs-katacheck

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
-require './lib/ogs_katacheck'
+require 'ogs_katacheck'
 
 OGSKataCheck::CLI.new.call

data/lib/ogs_katacheck.rb

@@ -1,5 +1,7 @@
 require 'faraday'
 require 'json'
+require 'colorize'
+require 'terminal-table'
 require_relative "./ogs_katacheck/version"
 require_relative "./ogs_katacheck/cli"
 require_relative "./ogs_katacheck/review"

data/lib/ogs_katacheck/cli.rb

@@ -37,7 +37,8 @@ class OGSKataCheck::CLI
     puts "The following reviews are available:"
 
     Review.all.each do |review|
-      puts "#{review.number}.  #{review.id} - #{review.engine} - #{review.type} - #{review.date}"
+      review.date = Time.new(review.date.slice(0,4), review.date.slice(5, 2), review.date.slice(8, 2), review.date.slice(11, 2), review.date.slice(14, 2), review.date.slice(17, 2), "+00:00")
+      puts "#{review.number}.  #{review.id} -- #{review.engine} -- #{review.type} -- #{review.date.localtime.strftime("%e %b %Y, %I:%M%p %Z")}"
     end
 
     puts ""

data/lib/ogs_katacheck/full_review.rb

@@ -1,5 +1,5 @@
 class FullReview
-  attr_accessor :win_rates, :scores, :id, :type, :game_id, :engine, :engine_version, :network, :network_size, :date, :strength, :win_rate, :moves,
+  attr_accessor :win_rates, :uuid, :scores, :id, :type, :game_id, :engine, :engine_version, :network, :network_size, :date, :strength, :win_rate, :moves,
     :total_moves, :black_tier_1, :black_tier_2, :black_tier_3, :black_tier_4, :white_tier_1, :white_tier_2, :white_tier_3, :white_tier_4, :black_total, :white_total
 
   @@all = []
@@ -25,18 +25,21 @@ class FullReview
   end
 
   def self.destroy_all
-    self.all.clear 
+    self.all.clear
   end
 
   def calculate_percentages
-    @black_tier_1[1] = @black_tier_1[0].to_f / @total_moves / 2 * 100
-    @black_tier_2[1] = @black_tier_2[0].to_f / @total_moves / 2 * 100
-    @black_tier_3[1] = @black_tier_3[0].to_f / @total_moves / 2 * 100
-    @black_tier_4[1] = @black_tier_4[0].to_f / @total_moves / 2 * 100
-    @white_tier_1[1] = @white_tier_1[0].to_f / @total_moves / 2 * 100
-    @white_tier_2[1] = @white_tier_2[0].to_f / @total_moves / 2 * 100
-    @white_tier_3[1] = @white_tier_3[0].to_f / @total_moves / 2 * 100
-    @white_tier_4[1] = @white_tier_4[0].to_f / @total_moves / 2 * 100
+    white_moves = (@total_moves / 2.0).floor
+    black_moves = (@total_moves / 2.0).ceil
+
+    @black_tier_1[1] = @black_tier_1[0].to_f / black_moves * 100
+    @black_tier_2[1] = @black_tier_2[0].to_f / black_moves * 100
+    @black_tier_3[1] = @black_tier_3[0].to_f / black_moves * 100
+    @black_tier_4[1] = @black_tier_4[0].to_f / black_moves * 100
+    @white_tier_1[1] = @white_tier_1[0].to_f / white_moves * 100
+    @white_tier_2[1] = @white_tier_2[0].to_f / white_moves * 100
+    @white_tier_3[1] = @white_tier_3[0].to_f / white_moves * 100
+    @white_tier_4[1] = @white_tier_4[0].to_f / white_moves * 100
 
     @black_total[0] = @black_tier_1[0] + @black_tier_2[0] + @black_tier_3[0] + @black_tier_4[0]
     @white_total[0] = @white_tier_1[0] + @white_tier_2[0] + @white_tier_3[0] + @white_tier_4[0]

data/lib/ogs_katacheck/review.rb

@@ -1,5 +1,5 @@
 class Review
-  attr_accessor :full_review, :number, :id, :type, :game_id, :engine, :engine_version, :network, :network_size, :date, :strength, :win_rate, :moves
+  attr_accessor :full_review, :number, :uuid, :id, :type, :game_id, :engine, :engine_version, :network, :network_size, :date, :strength, :win_rate, :moves
   @@all = []
 
   def initialize(attributes, number:)
@@ -25,21 +25,80 @@ class Review
     puts "Checking player submitted moves against #{@engine} #{@type} review ##{@id}..."
     review = load_review
     review.process
-    puts ""
-    puts "-----------------------------------------------------"
-    puts "Black Tier 1 Moves: #{review.black_tier_1[0]} --- #{review.black_tier_1[1].round(2)}%"
-    puts "Black Tier 2 Moves: #{review.black_tier_2[0]} --- #{review.black_tier_2[1].round(2)}%"
-    puts "Black Tier 3 Moves: #{review.black_tier_3[0]} --- #{review.black_tier_3[1].round(2)}%"
-    puts "Black Tier 4 Moves: #{review.black_tier_4[0]} --- #{review.black_tier_4[1].round(2)}%"
-    puts "-----------------------------------------------------"
-    puts "White Tier 1 Moves: #{review.white_tier_1[0]} --- #{review.white_tier_1[1].round(2)}%"
-    puts "White Tier 2 Moves: #{review.white_tier_2[0]} --- #{review.white_tier_2[1].round(2)}%"
-    puts "White Tier 3 Moves: #{review.white_tier_3[0]} --- #{review.white_tier_3[1].round(2)}%"
-    puts "White Tier 4 Moves: #{review.white_tier_4[0]} --- #{review.white_tier_4[1].round(2)}%"
-    puts "-----------------------------------------------------"
-    puts "Black Total Top Moves: #{review.black_total[0]} --- #{review.black_total[1].round(2)}%"
-    puts "White Total Top Moves: #{review.white_total[0]} --- #{review.white_total[1].round(2)}%"
-    puts "-----------------------------------------------------"
+
+    # table = Terminal::Table.new title: "Results".bold, headings: ['Color'.bold, 'Tier'.bold, "#".bold, "%".bold]
+    # x = 1
+    # while x < 4 do
+    #   table.add_row [x == 2 ? "Black".bold : nil, x, review.public_send("black_tier_#{x}")[0], review.public_send("black_tier_#{x}")[1].round(2)]
+    #   x += 1
+    # end
+    #
+    # table.add_separator
+    # table.add_row [{:value => 'Total'.bold, :colspan => 2, :alignment => :center}, review.black_total[0], "#{review.black_total[1].round(2)}%"]
+    # table.add_separator
+    # table.add_separator
+    #
+    # x = 1
+    # while x < 4 do
+    #   table.add_row [x == 2 ? "White".bold : nil, x, review.public_send("black_tier_#{x}")[0], review.public_send("black_tier_#{x}")[1].round(2)]
+    #   x += 1
+    # end
+    #
+    # table.add_separator
+    #
+    # table.add_row [{:value => 'Total'.bold, :colspan => 2, :alignment => :center}, review.white_total[0], "#{review.white_total[1].round(2)}%"]
+    #
+    # table.style = {:width => 80, :padding_left => 3, :border_x => "=", :border_i => "x"}
+    #
+    # puts table
+
+    table = Terminal::Table.new title: "Results".bold, headings: ['Tier'.bold, "#".bold, "%".bold]
+    x = 1
+    table.add_row [{value: "Black".bold.light_white.on_black, alignment: :center, colspan: 3}]
+    table.add_separator
+    while x < 4 do
+      table.add_row [x, {value: review.public_send("black_tier_#{x}")[0], alignment: :center}, {value: review.public_send("black_tier_#{x}")[1].round(2).to_s + " %", alignment: :center}]
+      x += 1
+    end
+
+    table.add_separator
+    table.add_row [{:value => 'Total'.bold, :alignment => :center}, review.black_total[0], "#{review.black_total[1].round(2)}%"]
+    table.add_separator
+
+    table.add_row [{value: "White".bold.black.on_light_white.blink, alignment: :center, colspan: 3}]
+    table.add_separator
+    x = 1
+    while x < 4 do
+      table.add_row [x, review.public_send("white_tier_#{x}")[0], review.public_send("white_tier_#{x}")[1].round(2).to_s + " %"]
+      x += 1
+    end
+
+    table.add_separator
+
+    table.add_row [{:value => 'Total'.bold, :alignment => :center}, review.white_total[0], "#{review.white_total[1].round(2)}%"]
+
+    table.style = {:width => 70, :padding_left => 2, :border_x => "=".blue, :border_i => "x".blue, :alignment => :center}
+
+    puts table
+
+    # puts ""
+    # puts "^^ new"
+    # puts "vv old"
+    # puts ""
+    # puts "-----------------------------------------------------"
+    # puts "Black Tier 1 Moves: #{review.black_tier_1[0]} --- #{review.black_tier_1[1].round(2)}%"
+    # puts "Black Tier 2 Moves: #{review.black_tier_2[0]} --- #{review.black_tier_2[1].round(2)}%"
+    # puts "Black Tier 3 Moves: #{review.black_tier_3[0]} --- #{review.black_tier_3[1].round(2)}%"
+    # puts "Black Tier 4 Moves: #{review.black_tier_4[0]} --- #{review.black_tier_4[1].round(2)}%"
+    # puts "-----------------------------------------------------"
+    # puts "White Tier 1 Moves: #{review.white_tier_1[0]} --- #{review.white_tier_1[1].round(2)}%"
+    # puts "White Tier 2 Moves: #{review.white_tier_2[0]} --- #{review.white_tier_2[1].round(2)}%"
+    # puts "White Tier 3 Moves: #{review.white_tier_3[0]} --- #{review.white_tier_3[1].round(2)}%"
+    # puts "White Tier 4 Moves: #{review.white_tier_4[0]} --- #{review.white_tier_4[1].round(2)}%"
+    # puts "-----------------------------------------------------"
+    # puts "Black Total Top Moves: #{review.black_total[0]} --- #{review.black_total[1].round(2)}%"
+    # puts "White Total Top Moves: #{review.white_total[0]} --- #{review.white_total[1].round(2)}%"
+    # puts "-----------------------------------------------------"
 
   end
 

data/lib/ogs_katacheck/version.rb

@@ -1,3 +1,3 @@
 module OGSKataCheck
-  VERSION = "0.1.3"
+  VERSION = "0.2.1"
 end

data/ogs_katacheck.gemspec

@@ -22,7 +22,11 @@ Gem::Specification.new do |spec|
   spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
+  spec.add_runtime_dependency "faraday"
+  spec.add_runtime_dependency "terminal-table"
   spec.bindir        = "bin"
   spec.executables   = ["ogs-katacheck", "katacheck"]
   spec.require_paths = ["lib"]
 end
+
+# to release, bump version and run `bundle exec rake release`

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: ogs_katacheck
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - RubyMineshaft
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-22 00:00:00.000000000 Z
-dependencies: []
+date: 2020-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This CLI gem is written for OGS team members in order to aid in investigating
   suspicions of botting.
 email:
@@ -20,6 +48,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
@@ -30,6 +59,8 @@ files:
 - bin/katacheck
 - bin/ogs-katacheck
 - bin/setup
+- images/output.png
+- images/reviews.png
 - lib/ogs_katacheck.rb
 - lib/ogs_katacheck/cli.rb
 - lib/ogs_katacheck/full_review.rb