beginner.codes 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53a61ed7bdf941612a9b872243a1735c99e6510a0f787488654fd5cb0f57183e
-  data.tar.gz: 749500774942cd631b2c7f072f42e0bd6ed703791a8d97fdbec0a8b34367928e
+  metadata.gz: ff8827c1454a8d44b7ebd23a4c6c2b0c6f73e6502643630b0de30434d54ca424
+  data.tar.gz: f845377f0f7e3e4ce5a5446fcea9196c9d3ebe411b778c7708c508f200de5c3c
 SHA512:
-  metadata.gz: 944c7ac5de055f6f919537b62525ee86135c50add2fbbabe53cfd95e58bc39db9aadf5718504ce0bd7b41396279649824a13b733a2b4c9dc8453955482f97ad2
-  data.tar.gz: ea7009f4fc91cfdb3d339e9d676138ca0f98c12d96762ca2a65f876810557c3d4d4098563752dc96250dd92af575d42a20eef5a199f19d37df2f89ab889a584e
+  metadata.gz: ca8ca526d9026fcb0fe9745c96f801c9e210a8c761cbb973014d644d3c3ccdb5dd9426e52d5e2b03488bacf38afc290b79ded83db2f7c9bfe8f41e89b2157af5
+  data.tar.gz: 9fff417792131a316f81e47ecd08e29798f8d0d3ff548aeda9de2457c2e18f2257c1c431614dfdcaeff9434015359f4564e65333aeb51fedec5731c070923d07

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# 0.1.5 (9 November 2023)
+
+---
+
+## Enhancements
+
+- Added two arguments passed to test `description: true` and `examples: true` to print out additional challenge data during testing
+
+## Bug Fixes
+
+## Performance
+
+## Documentation
+
+- Updated README to include the new arguments
+- Thanksgiving approaches along with the cruel realization that I never lost the weight from last new years.
+
+---
+
 # 0.1.4 (7 November 2023)
 
 ---

data/README.md

@@ -6,7 +6,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)`
+- 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
 ```ruby
 require 'challenges'
 
@@ -22,4 +22,9 @@ n_differences = -> (x) {x*2}
 
 test(458, n_differences)
 ```
-This will handle downloading the necessary challenge test cases and will run them against your code. It will show you which tests failed, what went wrong, and how many tests succeeded.
+This will handle downloading the necessary challenge test cases and will run them against your code. It will show you which tests failed, what went wrong, and how many tests succeeded.
+
+Additionally, you can view the description and examples when running the tests by adding some options to the test function
+```ruby
+test(458, :n_differences, description: true, examples: true)
+```

data/lib/challenges.rb

@@ -4,7 +4,10 @@ require 'json'
 require 'uri'
 require 'net/http'
 require 'colorize'
+require 'tty-markdown'
 
+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_'
 
 module Status
   SUCCESS = 1
@@ -25,9 +28,20 @@ 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
+end
+
 # fetches the result from the source
 def get_tests(challenge)
-  uri = URI("https://raw.githubusercontent.com/beginner-codes/challenges/main/weekday/test_cases_#{challenge}.json")
+  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)
 
@@ -77,8 +91,9 @@ def show_results(challenge, results, total_tests)
 end
 
 # the main entry point function
-def test(challenge, solution_func)
+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)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beginner.codes
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Mr. Robinhood 5
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-08 00:00:00.000000000 Z
+date: 2023-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -25,6 +25,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: tty-markdown
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
 description: This is the un-official RubyGem for the Beginner.Codes Discord server.
   Test your daily challenge solutions with provided tests automatically to ensure
   you have a good solution.