beginner.codes 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff8827c1454a8d44b7ebd23a4c6c2b0c6f73e6502643630b0de30434d54ca424
-  data.tar.gz: f845377f0f7e3e4ce5a5446fcea9196c9d3ebe411b778c7708c508f200de5c3c
+  metadata.gz: cb2311d48b3a619a02565b5d4038172500fc7aff654a7af3d9085732e38d0294
+  data.tar.gz: 700302fc4e435f889df81f5c20ab929bdb80fd1057e2d257b0db00ae5f5fab91
 SHA512:
-  metadata.gz: ca8ca526d9026fcb0fe9745c96f801c9e210a8c761cbb973014d644d3c3ccdb5dd9426e52d5e2b03488bacf38afc290b79ded83db2f7c9bfe8f41e89b2157af5
-  data.tar.gz: 9fff417792131a316f81e47ecd08e29798f8d0d3ff548aeda9de2457c2e18f2257c1c431614dfdcaeff9434015359f4564e65333aeb51fedec5731c070923d07
+  metadata.gz: 56ea71d0fe3926cfff3618efed0949ef332a693eba65691777729cff91bf37754646b0021d9c876f4b3a1e6e6e917c4effccf26604e395d47442690d5b8c3458
+  data.tar.gz: 15eabb9b8816636c9e6e1843e8592ebf69237a3e5f4b47739eb637ac0dd1347a06ec4bf671a2a8fb45b71c3ec812e52d15b33694377d7a9f87deee43f6296949

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# 0.1.6 (11 November 2023)
+
+---
+
+## Enhancements
+
+- Using better colors and now tables for results
+- Prints Usage instructions if wrong arguments are sent
+- passing a function is now optional, in case you only need the test info.
+
+## Bug Fixes
+
+## Performance
+
+## Documentation
+
+- Updated README to include the new arguments
+- drip drop drip drop
+
+---
 # 0.1.5 (9 November 2023)
 
 ---

data/README.md

@@ -7,6 +7,7 @@ This is the un-official Ruby Gem for the Beginner.Codes Discord server.
 - Install the package: `gem install beginner.codes`
 - Import the test runner: `require 'challenges'`
 - Run the tests, passing in the challenge number and your solution function: `test(458, :n_differences)` for a function or `test(458, n_differences)` for a lambda function
+- For informatino only you can pass either `description: true` or `examples: true` 
 ```ruby
 require 'challenges'
 

data/lib/challenges.rb

@@ -1,13 +1,24 @@
 # frozen_string_literal: true
+# TODO: use a latest: arg to bring up the last test
 
 require 'json'
 require 'uri'
 require 'net/http'
-require 'colorize'
+require 'pastel'
 require 'tty-markdown'
+require 'tty-table'
 
-TEST_CASE_URL = 'https://raw.githubusercontent.com/beginner-codes/challenges/main/weekday/test_cases_'
-DESCRIPTION_URL = 'https://raw.githubusercontent.com/beginner-codes/challenges/main/weekday/challenge_'
+
+USAGE = '# **USAGE**
+```py
+test(challenge: int, your_function: :func, description: bool, examples: bool)
+---
+test(458, :your_function)   # runs all tests cases on your function
+test(458, :your_function, description: true)  # adds the test description in the terminal
+test(458, :your_function, examples: true)  # adds test examples in the terminal
+test(458, :your_function, true, true)  # adds both description and examples
+test(458, description: true)  # prints only description without running tests
+test(458, examples: true)  # same as above but with examples```'
 
 module Status
   SUCCESS = 1
@@ -15,6 +26,25 @@ module Status
   EXCEPTION = -1
 end
 
+# passes the colors to the terminal
+class Colors
+  def initialize
+    @pastel = Pastel.new
+  end
+
+  def respond_to_missing?(name, include_private = false)
+    !name.to_s.empty? || super
+  end
+
+  def method_missing(name, *args)
+    if respond_to_missing?(name)
+      @pastel.send(name, *args)
+    else
+      @pastel.send(:white, *args)
+    end
+  end
+end
+
 # captures the result of the test
 class Result
   attr_accessor :got, :status
@@ -28,25 +58,43 @@ class Result
   end
 end
 
-# fetches the description from source
-def puts_info(challenge, description, examples)
-  url = URI(DESCRIPTION_URL + "#{challenge}.md")
-  response = Net::HTTP.get(url).force_encoding('UTF-8')
-  result = "\n"
-  result += response.split('## ').first.gsub("\n\n", "\n")+"\n" if description
-  result += response.split('#')[3].gsub("\n\n", "\n").insert(0,'#') if examples
-  result = TTY::Markdown.parse(result)
-  puts result
+def make_table(rows)
+  c = Colors.new
+  header = [c.blue('#:'), c.green('Expected:'), c.red('Got:')]
+  rows = rows.map do |row|
+    [c.blue(row[0]), c.green(row[1]), c.red(row[2])]
+  end
+  TTY::Table.new(header, [*rows])
+end
+
+def fetch_data(url)
+  Net::HTTP.get(URI(url)).force_encoding('UTF-8')
 end
 
 # fetches the result from the source
 def get_tests(challenge)
-  uri = URI(TEST_CASE_URL + "#{challenge}.json")
-  response = Net::HTTP.get_response(uri)
-  raise "Challenge #{challenge} was not found" unless response.is_a?(Net::HTTPSuccess)
+  url = "https://raw.githubusercontent.com/beginner-codes/challenges/main/weekday/test_cases_#{challenge}.json"
+  begin
+    JSON.parse(fetch_data(url))
+  rescue RuntimeError => e
+    e
+  end
+
+end
 
-  JSON.parse(response.body)
+# fetches the description from source
+def get_info(challenge, description, examples)
+  url = "https://raw.githubusercontent.com/beginner-codes/challenges/main/weekday/challenge_#{challenge}.md"
+  result = ''
 
+  begin
+    info = fetch_data(url)
+    result += info.split('## ').first.gsub("\n\n", "\n") << "\n" if description
+    result += info.split('#')[3].gsub("\n\n", "\n").insert(0,'#') if examples
+  rescue IndexError || RuntimeError => e
+    result += e
+  end
+  TTY::Markdown.parse(result + '***')
 end
 
 # parses your functions and checks if it passes
@@ -55,12 +103,7 @@ def run_tests(tests, solution_func)
   tests.each_with_index do |test_case, index|
     result = Result.new(index, test_case['return'])
     begin
-      result.got = if solution_func.is_a?(Proc)
-                     solution_func.call(*test_case['args'])
-                   else
-                     send(solution_func, *test_case['args'])
-                   end
-
+      result.got = solution_func.is_a?(Proc) ? solution_func.call(*test_case['args']) : send(solution_func, *test_case['args'])
     rescue StandardError => e
       result.status = Status::EXCEPTION
       result.got = e
@@ -73,27 +116,40 @@ def run_tests(tests, solution_func)
 end
 
 # displays the results on the terminal
-def show_results(challenge, results, total_tests)
+def show_results(challenge, results, total_tests, info)
+  puts info
+  c = Colors.new
+  rows = []
   failures = 0
   results.each do |result|
-    if result.status.equal?(Status::FAILED)
-      puts "Test #{result.index.to_s.blue} failed:  Expected #{result.expected.to_s.green}, got #{result.got.to_s.red}"
-      failures += 1
-    elsif result.status.equal?(Status::EXCEPTION)
-      puts "Test #{result.index} failed:  #{result.got}"
-      failures += 1
-    end
+    next unless result.status.equal?(Status::FAILED) or result.status.equal?(Status::EXCEPTION)
+
+    rows << [result.index, result.expected, result.got]
+    failures += 1
   end
-  puts ' ' if failures
-  puts "---- Challenge #{challenge} Results ----".light_yellow.on_black
-  puts "#{(total_tests - failures).to_s.green} passed, #{failures.to_s.red} failed"
-  puts "\n**** Great job!!! ****".green if failures.zero?
+
+  table = make_table(rows)
+  puts table.render(:unicode, alignment: %i[right left left]) if failures
+  return if results == []
+
+  puts c.yellow("---- Challenge #{challenge} Results ----")
+  puts "#{c.green(total_tests - failures)} passed, #{c.red(failures)} failed"
+  puts c.green("\n**** Great job!!! ****") if failures.zero?
 end
 
 # the main entry point function
-def test(challenge, solution_func, description: false, examples: false)
-  tests = get_tests(challenge)
-  puts_info(challenge, description, examples) if description || examples
-  results = run_tests(tests, solution_func)
-  show_results(challenge, results, tests.size)
+def test(challenge = nil, solution_func = nil, description: false, examples: false)
+  if solution_func
+    tests = get_tests(challenge)
+    results = run_tests(tests, solution_func) unless tests.kind_of? RuntimeError
+  else
+    tests = []
+    results = []
+  end
+  info = if solution_func || examples || description || challenge
+           get_info(challenge, description, examples)
+         else
+           TTY::Markdown.parse(USAGE)
+         end
+  show_results(challenge, results, tests.size, info)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beginner.codes
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Mr. Robinhood 5
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-10 00:00:00.000000000 Z
+date: 2023-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: pastel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: tty-markdown
   requirement: !ruby/object:Gem::Requirement