RubyGems - newsman - Versions diffs - 0.1.8 → 0.1.10 - Mend

newsman 0.1.8 → 0.1.10

Files changed (7) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6003cd186c9fc0dc4db267e6c51aecddbf3b1c5de58c63331efc985f3c99f996
-  data.tar.gz: 1255f0f57387649a4ffa9bac8c3e726f6f3e6e37fbd67fef022c17121c297f53
+  metadata.gz: 1183add95adc6b8574a0c0ffaa9dc50b472edaf3daa2219d9a48b4b0887c822e
+  data.tar.gz: a74b77f973ff3fee1d9ebd455ab13148d748d9dfa34ca4f328223957f3f672ad
 SHA512:
-  metadata.gz: dd1258731d17b2df35dd46bd2e74c5b22881fed9370c97430c2246db3a879f8dd7289b07f1fb36429ad3e9ed0320e7b886504ebe0a2b734461a18f702551be04
-  data.tar.gz: 70be6d66ebcc920367f1143212c14ed00feb14f2653c514b7a58e6a8e1b939a3d945d4990888a8264a9224d20cd39717e6bddb0c0d0baa6361c8f8243621fac8
+  metadata.gz: aa81431ca58fe417bd8208ada0b642d121faa5c07f3b4633fe43fc12340e938d84688f23f4027d4eb7f9a491ce2f6105ab36a28f77db8248aca7a368623711f4
+  data.tar.gz: 8c03d5d177c3e9d9b2caf7add86e210429afd52a174506b8333466c80ac47a3e72b313d27a9c7be673914a9d10ce80b81ea2a46871173dd0590f47598176a3b6

data/lib/newsman/html_output.rb ADDED Viewed

@@ -0,0 +1,47 @@
+require 'erb'
+require 'redcarpet'
+require 'nokogiri'
+# frozen_string_literal: true
+class Htmlout
+  TEMPLATE = "
+<head>
+  <title><%= title %></title>
+</head>
+<body>
+  <h1><%= title %></h1>
+  <%= body %>
+</body>
+"
+  def initialize(root = '.')
+    @root = root
+  end
+  def print(report, reporter)
+    title = title(reporter)
+    renderer = Redcarpet::Render::HTML.new(no_links: true, hard_wrap: true, prettify: true)
+    markdown = Redcarpet::Markdown.new(renderer, autolink: true, tables: true)
+    body = markdown.render(report)
+    renderer = ERB.new(TEMPLATE)
+    html_content = renderer.result(binding)
+    html_content = Nokogiri::HTML(html_content, &:noblanks).to_xhtml(indent: 2)
+    puts "Create a html file in a directory #{@root}"
+    file = File.new(File.join(@root, filename(reporter)), 'w')
+    puts "File #{file.path} was successfully created"
+    file.puts html_content
+    puts "Report was successfully printed to a #{file.path}"
+    file.close
+  end
+  def title(reporter)
+    date = Time.new.strftime('%d.%m.%Y')
+    "#{reporter} #{date}"
+  end
+  def filename(reporter)
+    date = Time.new.strftime('%d.%m.%Y')
+    "#{date}.#{reporter}.html"
+  end
+end

data/lib/newsman/report.rb CHANGED Viewed

@@ -6,8 +6,8 @@ class Report
     @position = position
     @title = title
   end
-  def build(achievements, plans, date)
-    return "From: #{@user}\nSubject: #{week_of_a_year(@title, date)}\n\nHi all,\n\nLast week achievements:\n#{achievements}\n\nNext week plans:\n#{plans}\n\nRisks:\n- <todo>\n\nBest regards,\n#{@user}\n#{@position}\n#{date}"
+  def build(achievements, plans, risks, date)
+    return "From: #{@user}\nSubject: #{week_of_a_year(@title, date)}\n\nHi all,\n\nLast week achievements:\n#{achievements}\n\nNext week plans:\n#{plans}\n\nRisks:\n#{risks}\n\nBest regards,\n#{@user}\n#{@position}\n#{date}"
   end
 end

data/lib/newsman.rb CHANGED Viewed

@@ -9,6 +9,7 @@ require_relative 'newsman/pull_request'
 require_relative 'newsman/issues'
 require_relative 'newsman/stdout_output'
 require_relative 'newsman/txt_output'
+require_relative 'newsman/html_output'
 require_relative 'newsman/report'
 def generate
@@ -32,7 +33,7 @@ def generate
       options[:position] = p
     end
     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|
+            "Output type. Newsman prints a report to a stdout by default. You can choose another options like '-o html', '-o txt' or even '-o html'") do |o|
       options[:output] = o
     end
     opts.on('-t', '--title TITLE', 'Project Title. Empty by default') do |t|
@@ -116,20 +117,27 @@ def generate
   puts "\nNow lets test some aggregation using OpenAI\n\n"
   openai_client = OpenAI::Client.new(access_token: openai_token)
-  example = "jeo-meven-plugin:
+  example = "some-repository-name-x:
   - Added 100 new files to the Dataset [#168]
   - Fixed the deployment of XYZ [#169]
   - Refined the requirements [#177]
-  opeo-maven-plugin:
+  some-repository-name-y:
   - Removed XYZ class [#57]
   - Refactored http module [#69]"
-  example_plans = "jeo-maven-plugin:
+  example_plans = "some-repository-name-x:
   - To publish ABC package draft [#27]
   - To review first draft of the report [#56]
-  opeo-maven-plugin:
+  some-repository-name-y:
   - To implement optimization for the class X [#125]"
+  example_risks = "some-repository-name-x:
+  - The server is weak, we may fail the delivery
+  of the dataset, report milestone will be missed [#487].
+some-repository-name-y:
+  - The code in repository is suboptimal, we might have some problems for the future maintainability [#44].
+  "
   response = openai_client.chat(
     parameters: {
       model: 'gpt-3.5-turbo',
@@ -137,7 +145,7 @@ def generate
         { role: 'system',
           content: 'You are a developer tasked with composing a concise report detailing your activities and progress for the previous week, intended for submission to your supervisor.' },
         { role: 'user',
-          content: "Please compile a summary of the work completed in the following Pull Requests (PRs). Each PR should be summarized in a single sentence, focusing more on the PR title and less on implementation details. Group the sentences by repositories, each identified by its name mentioned in the 'repository:[name]' attribute of the PR. The grouping is important an should be precise. Ensure that each sentence includes the corresponding issue number as an integer value. If a PR doesn't mention an issue number, just print [#chore]. Combine all the information from each PR into a concise and fluent sentence, as if you were a developer reporting on your work. Please strictly adhere to the example template provided. Example of a report: #{example}. List of Pull Requests: [#{prs}]" }
+          content: "Please compile a summary of the work completed in the following Pull Requests (PRs). Each PR should be summarized in a single sentence, focusing more on the PR title and less on implementation details. Group the sentences by repositories, each identified by its name mentioned in the 'repository:[name]' attribute of the PR. Pay attention, that you don't lose any PR. The grouping is important an should be precise. Ensure that each sentence includes the corresponding issue number as an integer value. If a PR doesn't mention an issue number, just print [#chore]. Combine all the information from each PR into a concise and fluent sentence, as if you were a developer reporting on your work. Please strictly adhere to the example template provided. Example of a report: #{example}. List of Pull Requests: [#{prs}]" }
       ],
       temperature: 0.3
     }
@@ -150,19 +158,41 @@ def generate
         { role: 'system',
           content: 'You are a developer tasked with composing a concise report detailing your activities and progress for the previous week, intended for submission to your supervisor.' },
         { role: 'user',
-          content: "Please compile a summary of the plans for the next week using the following GitHub Issues descriptions. Each issue should be summarized in a single sentence, focusing more on the issue title and less on implementation details. Group the sentences by repositories, each identified by its name mentioned in the 'repository:[name]' attribute of the issue. The grouping is important an should be precise. Ensure that each sentence includes the corresponding issue number as an integer value. If an issue doesn't mention an issue number, just print [#chore]. Combine all the information from each Issue into a concise and fluent sentences, as if you were a developer reporting on your work. Please strictly adhere to the example template provided: #{example_plans}. List of GitHub issues to aggregate: [#{issues}]. Use the same formatting as here \n```#{answer}```\n" }
+          content: "Please compile a summary of the plans for the next week using the following GitHub Issues descriptions. Each issue should be summarized in a single sentence, focusing more on the issue title and less on implementation details. Group the sentences by repositories, each identified by its name mentioned in the 'repository:[name]' attribute of the issue. Pat attention, that you din't loose any issue. The grouping is important an should be precise. Ensure that each sentence includes the corresponding issue number as an integer value. If an issue doesn't mention an issue number, just print [#chore]. Combine all the information from each Issue into a concise and fluent sentences, as if you were a developer reporting on your work. Please strictly adhere to the example template provided: #{example_plans}. List of GitHub issues to aggregate: [#{issues}]. Use the same formatting as here \n```#{answer}```\n" }
       ],
       temperature: 0.3
     }
 )
   issues_full_answer = issues_response.dig('choices', 0, 'message', 'content')
+  risks_full_answer = openai_client.chat(
+    parameters: {
+      model: 'gpt-3.5-turbo',
+      messages: [
+        { role: 'system',
+          content: 'You are a developer tasked with composing a concise report detailing your activities and progress for the previous week, intended for submission to your supervisor.' },
+        { role: 'user',
+          content: "Please compile a summary of the risks identified in some repositories. If you can't find anything, just leave answer empty. Add some entries to a report only if you are sure it's a risk. Developers usually mention some risks in pull request descriptions. They either mention 'risk' or 'issue'. I will give you a list of pull requests. Each risk should be summarized in a single sentence. Ensure that each sentence includes the corresponding issue number or PR number as an integer value. If a PR or an issue doesn't mention an issue number, just print [#chore]. Combine all the information from each PR into a concise and fluent sentence, as if you were a developer reporting on your work. Please strictly adhere to the example template provided. Example of a report: #{example_risks}. List of Pull Requests: ```#{prs}```.]"}
+      ],
+      temperature: 0.3
+    }
+  ).dig('choices', 0, 'message', 'content')
   output_mode = options[:output]
   puts "Output mode is '#{output_mode}'"
-  full_answer = Report.new(reporter, reporter_position, options[:title]).build(answer, issues_full_answer, Date.today)
+  full_answer = Report.new(reporter, reporter_position, options[:title]).build(answer, issues_full_answer, risks_full_answer, Date.today)
   if output_mode.eql? 'txt'
+    puts "Print result to txy file"
     output = Txtout.new('.')
     output.print(full_answer, github_username)
+  elsif output_mode.eql? 'html'
+    puts "Print result to html file"
+    output = Htmlout.new('.')
+    output.print(full_answer, github_username)
   else
+    puts "Print result to stdout"
     output = Stdout.new
     output.print(full_answer)
   end

data/test/test_htmlout.rb ADDED Viewed

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# 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/html_output'
+class TestHtmlout < Minitest::Test
+EXPECTED = "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.0 Transitional//EN\" \"http://www.w3.org/TR/REC-html40/loose.dtd\">
+<html>
+  <head>
+    <title>volodya-lombrozo #{Time.new.strftime('%d.%m.%Y')}</title>
+  </head>
+  <body>
+  <h1>volodya-lombrozo #{Time.new.strftime('%d.%m.%Y')}</h1>
+  <p>Issue description</p>
+<p>Here is a new paragraph<br/>
+List is here:<br/>
+ - one<br/>
+ - two<br/>
+ - three</p>
+</body>
+</html>
+"
+  def test_writes_to_a_html_file
+    Dir.mktmpdir do |temp_dir|
+      output = Htmlout.new(temp_dir)
+      today = Date.today.strftime('%d.%m.%Y')
+      expected = "#{today}.volodya-lombrozo.html"
+      output.print("Issue description\n\nHere is a new paragraph\nList is here:\n - one\n - two\n - three", 'volodya-lombrozo')
+      assert(File.exist?(File.join(temp_dir, expected)))
+      assert_equal(EXPECTED, File.read(File.join(temp_dir, expected)))
+    end
+  end
+end

data/test/test_report.rb CHANGED Viewed

@@ -47,7 +47,7 @@ User
 Developer
 2024-03-14"
     report = Report.new('User', 'Developer', 'Project')
-    out = report.build("repository-a:\n - Did a lot of for (a) repository", "repository-b:\n - I will do a lot for repository (b)", Date.new(2024, 3, 14))
+    out = report.build("repository-a:\n - Did a lot of for (a) repository", "repository-b:\n - I will do a lot for repository (b)", "- <todo>", Date.new(2024, 3, 14))
     assert_equal expected, out
   end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: newsman
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.10
 platform: ruby
 authors:
 - Volodya Lombrozo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-01 00:00:00.000000000 Z
+date: 2024-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -122,6 +122,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
 description: A simple gem that gathers GitHub statistics and creates human-readable
   report
 email:
@@ -135,11 +163,13 @@ files:
 - README.md
 - bin/newsman
 - lib/newsman.rb
+- lib/newsman/html_output.rb
 - lib/newsman/issues.rb
 - lib/newsman/pull_request.rb
 - lib/newsman/report.rb
 - lib/newsman/stdout_output.rb
 - lib/newsman/txt_output.rb
+- test/test_htmlout.rb
 - test/test_pdd_issue.rb
 - test/test_report.rb
 - test/test_txtout.rb
@@ -165,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
 summary: GitHub user weekly news