newsman 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9de70388fca6aa5f91554a1c883e4c9b4d60acb6045ed3f4ecd72cb48f893eab
-  data.tar.gz: 6f0a22e24e602305b48b47c9c0b94b641aba28a59be9b532691ab91fcc1c6819
+  metadata.gz: c90f8d247e0365b348ec9b04d372cba37a9933f8e01209345d92728b70076067
+  data.tar.gz: 20e84be86484a2a62a6d8d13ec20b968efe2132055755d9521991bf1079d800c
 SHA512:
-  metadata.gz: 271706f09732915c0eff31be1f73f948837a4d219d33a386794bae042741a2a0f65dd749ed5e3dde871feed7f4aa6a0b57049b776ead48bf65c49b3a8180f13b
-  data.tar.gz: a86c40fb9f703b264c142b9ca35aef9aa377c821402eeedc494faf48b9b4240d136b76dab1dec4b05758f8de9e4c443f0e804dda4d4df41c59b4eb6245d8009a
+  metadata.gz: 24f7a9676367b76beea8e21614325a5e574af1f2d5f85fe73229d7eadd12d78e86a1d536140fe682c3b16b7f70a0f62bcca50c8024d3713d69115466520f1286
+  data.tar.gz: eca46b8ff30fb42918769c0c0a8ff4bd89f3ff3f4d724be17ce72dfeb894215dd0470f54ecde5db199c89dfbb735e4b9489f02f837727600f50281b305109f38

data/README.md

@@ -61,4 +61,8 @@ To check that everythis is fine, just run the following command:
 ```
 newsman --help
 ```
-Annd you should see a welcome message from newsman.
+And you should see a welcome message from newsman.
+
+## Examples
+
+You can find examples of generated reports [here](https://github.com/volodya-lombrozo/newsman/tree/gh-pages)

data/lib/newsman.rb

@@ -29,6 +29,9 @@ def generate
     opts.on("-o", "--output OUTPUT", "Output type. Newsman prints a report to a stdout by default. You can choose another options like '-o html' or '-o txt'") do |o|
       options[:output] = o
     end
+    opts.on("-t", "--title TITLE", "Project Title. Empty by default") do |t|
+      options[:title] = t
+    end
   end.parse!
   # Custom method to raise exception with a human-readable message
   def options.require_option(key, message)
@@ -41,6 +44,7 @@ def generate
   options.require_option(:repositories, "GitHub repository is required. Please specify one or several repositories using -r or --repositories.")
   options[:position] ||= "Software Developer"
   options[:output] ||= "stdout"
+  options[:title] ||= ""
   all_params = options.map { |key, value| "#{key}: #{value}" }.join(", ")
   puts "Parsed parameters: #{all_params}"
 
@@ -83,7 +87,11 @@ def generate
   end
   puts "\nNow lets test some aggregation using OpenAI\n\n"
   openai_client = OpenAI::Client.new(access_token: openai_token)
-  example = "Last week achievements.
+
+  project_week = "#{week_of_a_year(options[:title], Date.today)}"
+
+  example = "
+  Last week achievements.
   jeo-meven-plugin:
   - Added 100 new files to the Dataset [#168]
   - Fixed the deployment of XYZ [#169]
@@ -121,12 +129,16 @@ response = openai_client.chat(
     })
   output_mode = options[:output]
   puts "Output mode is '#{output_mode}'"
+  project_week = "#{week_of_a_year(options[:title], Date.today)}"
+  answer = response.dig("choices", 0, "message", "content")
+  full_answer = "#{project_week}\n\n#{answer}"
   if output_mode.eql? "txt"
-    output = Txtout.new(".", github_username)
+    output = Txtout.new(".")
+    output.print(full_answer, github_username)
   else
     output = Stdout.new
+    output.print(full_answer)
   end
-  output.print(response.dig("choices", 0, "message", "content"))
 end
 
 
@@ -141,6 +153,10 @@ def date_one_week_ago(today)
   return formatted_date
 end
 
+def week_of_a_year(project, today)
+  number =  today.strftime('%U').to_i + 1
+  return "WEEK #{number} #{project}"
+end
 
 # Execute the function only if this script is run directly like `./newsman.rb`
 if __FILE__ == $0

data/test/test_txtout.rb

@@ -26,8 +26,10 @@ class TestTxtout < Minitest::Test
   def test_writes_to_a_file
     Dir.mktmpdir do |temp_dir| 
       output = Txtout.new(temp_dir)
-      expected = '17.03.2024.volodya-lombrozo.txt'
+      today = Date.today.strftime("%d.%m.%Y");
+      expected = "#{today}.volodya-lombrozo.txt"
       output.print("496", "volodya-lombrozo")
+      puts "Expected #{expected}"
       assert(File.exist?(File.join(temp_dir, expected)))
       assert_equal("496\n", File.read(File.join(temp_dir, expected)))
     end

data/test/test_week_of_a_year.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+# Copyright (c) 2024 Volodya Lombrozo 
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the 'Software'), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+require 'minitest/autorun'
+require_relative '../lib/newsman.rb'
+
+class TestWeekOfYear < Minitest::Test
+  def test_week_of_a_year()
+    assert_equal "WEEK 11 JEO", week_of_a_year("JEO", Date.new(2024, 3, 14))
+    assert_equal "WEEK 9 OPEO", week_of_a_year("OPEO", Date.new(2024, 2, 29))
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: newsman
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - Volodya Lombrozo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-18 00:00:00.000000000 Z
+date: 2024-03-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -126,6 +126,7 @@ files:
 - lib/newsman/txt_output.rb
 - test/test_txtout.rb
 - test/test_week_before.rb
+- test/test_week_of_a_year.rb
 homepage: https://github.com/volodya-lombrozo/newsman
 licenses:
 - MIT