newsman 0.2.2 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b217b1d0fee448151ff8a04b2099a6e311275e781112144a87f62a4e2a49e03
-  data.tar.gz: 78de209a3631b3e1589caab3b1bb336925009bcd52861e570e53b589d3ed8a65
+  metadata.gz: 28993b9f11754759d159a42a76b5979bec9c12980098de771abd5442fc124ccd
+  data.tar.gz: 1e98570b8d3b0cb9b0694472e5fefa7fe780ce6434efa12cd231dfa86a31c885
 SHA512:
-  metadata.gz: 317b520b605b309c9ce5aeed0ac3ba385afb6865a8469a3547189232f248011920a67c3a3cc9bb40470e1f0f0ec0b7014f667f106275e56e9df48469d810f757
-  data.tar.gz: 65eacb6e1debdcb1581af1d40c0b043d641825fc70780b01471f496c0bf5a336fbc8d13a43eab89ea0dacd39890b7ec38f684c842472d9be970508de20a46f70
+  metadata.gz: a807c540f352124e1a89d485cccfb2f0cf6ff36300b42d57ebb591b5e3e4b03d12413325f69a75d7f99e309c0813d336b1c3e32bb71012e22dd1093129cee5a6
+  data.tar.gz: 81a635a5caba68596e9c3acd7a242fbf597da0cb06ce87c2103cdab84c1e2e89ef59ec9812e997ff970a0484a16ace406415a83b8c642f6db8ff0f82e571c111

data/README.md

@@ -6,6 +6,32 @@
 
 Newsman is a simple script that collects information about a developer's weekly activity on GitHub and creates a human-readable summary of the work done. To create the summary, Newsman asks ChatGPT to handle all the information about a developer's activity, including their pull requests and created issues.
 
+## How it Works
+
+`newsman` sends multiple requests to GitHub to retrieve the following data:
+
+1. **Recently Closed Pull Requests by the Author**  
+   The tool fetches pull requests that were closed recently and were created by the specified author.  
+   Example query:  
+
+```
+is:pr author:volodya-lombrozo created:>=2024-11-29 repo:objectionary/jeo-maven-plugin repo:objectionary/opeo-maven-plugin
+```
+
+2. **Open Issues Assigned to the Author with the `soon` Label**  
+The tool retrieves issues that:  
+- Were opened in the last year  
+- Are currently open  
+- Are assigned to the specified author  
+- Have the label `soon`  
+
+Example query:  
+```
+is:issue is:open assignee:volodya-lombrozo created:>=2023-12-06 repo:objectionary/jeo-maven-plugin repo:objectionary/opeo-maven-plugin label:soon
+```
+
+Once the data is retrieved, the script analyzes it using the model specified with the `--model` option.
+
 ## Install
 
 To install [newsman](https://rubygems.org/gems/newsman) from RubyGems.org use the following command:
@@ -36,7 +62,7 @@ Usage: newsman [options]
     -u, --username USERNAME          GitHub username. For example, 'volodya-lombrozo'
     -r, --repository REPOSITORIES    Specify which repositories to include in a report. You can specify several repositories using a comma separator, for example: '-r objectionary/jeo-maven-plugin,objectionary/opeo-maven-plugin'
     -p, --position POSITION          Reporter position in a company. Default value is a 'Software Developer'.
-    -o, --output OUTPUT              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'
+    -o, --output OUTPUT              Output type. Newsman prints a report to a stdout by default. You can choose another options like '-o html', '-o txt' or '-o docx'. The 'html' output also generates a downloadable '.docx' copy (Times New Roman, 12pt) and links it from the page.
     -t, --title TITLE                Project Title. Empty by default
     -m, --model MODEL                AI model to use. gpt-3.5-turbo by default
 ```
@@ -53,6 +79,8 @@ Also you can download this repository and run the newsman script directly using
 ./bin/newsman --name "Vladimir Lombrozo" --username "volodya-lombrozo" --repository objectionary/jeo-maven-plugin,objectionary/opeo-maven-plugin
 ```
 
+Actually, this command is also useful during development process.
+
 ## How to build a gem from sources
 
 To create a newsman gem from sources first of all you need to build it:

data/lib/newsman/assistant.rb

@@ -25,11 +25,6 @@ require 'openai'
 # This class mimics a robot that can analyse a developer activity.
 # The assistant uses OpenAI API to analyze.
 class Assistant
-  CONTEXT = '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.'
-
   def initialize(token, model: 'gpt-3.5-turbo', temperature: 0.3)
     @token = token
     @model = model
@@ -117,18 +112,32 @@ class Assistant
     send(prompt)
   end
 
+  # rubocop:disable Metrics/MethodLength
   def send(request)
-    @client.chat(
-      parameters: {
-        model: @model,
-        messages: [
-          { role: 'system', content: CONTEXT },
-          { role: 'user', content: request.to_s }
-        ],
-        temperature: @temperature
-      }
-    ).dig('choices', 0, 'message', 'content')
+    if @model == 'o1-preview'
+      @client.chat(
+        parameters: {
+          model: @model,
+          messages: [{ role: 'user', content: request.to_s }]
+        }
+      ).dig('choices', 0, 'message', 'content')
+    else
+      @client.chat(
+        parameters: {
+          model: @model,
+          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: request.to_s }
+          ],
+          temperature: @temperature
+        }
+      ).dig('choices', 0, 'message', 'content')
+    end
   end
+  # rubocop:enable Metrics/MethodLength
 
   def deprecated(method)
     warn "Warning! '#{method}' is deprecated and will be removed in future versions."

data/lib/newsman/docx_output.rb

@@ -0,0 +1,94 @@
+# 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 'zip'
+require 'cgi'
+
+# This class represents a report output in DOCX (MS Word) format.
+# It builds a minimal, valid OOXML package by hand (no external docx-builder
+# gem), so every run of text is explicitly styled with Times New Roman, 12pt.
+class Docxout
+  # Content types part, required by every OOXML package.
+  CONTENT_TYPES = <<~XML
+    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+    <Types xmlns="http://schemas.openxmlformats.org/package/2006/content-types"><Default Extension="rels" ContentType="application/vnd.openxmlformats-package.relationships+xml"/><Default Extension="xml" ContentType="application/xml"/><Override PartName="/word/document.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.document.main+xml"/></Types>
+  XML
+
+  # Package-level relationships, pointing at the main document part.
+  RELS = <<~XML
+    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+    <Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"><Relationship Id="rId1" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument" Target="word/document.xml"/></Relationships>
+  XML
+
+  FONT = 'Times New Roman'
+  # Word expresses font size in half-points, so 12pt is 24.
+  SIZE = '24'
+
+  def initialize(root = '.')
+    @root = root
+  end
+
+  def print(report, reporter, model)
+    puts "Create a docx file in a directory #{@root}"
+    path = File.join(@root, filename(reporter, model))
+    Zip::File.open(path, create: true) do |zip|
+      zip.get_output_stream('[Content_Types].xml') { |f| f.write(CONTENT_TYPES) }
+      zip.get_output_stream('_rels/.rels') { |f| f.write(RELS) }
+      zip.get_output_stream('word/document.xml') { |f| f.write(document_xml(report)) }
+    end
+    puts "Report was successfully printed to a #{path}"
+    File.basename(path)
+  end
+
+  def filename(reporter, model)
+    date = Time.new.strftime('%d.%m.%Y')
+    model = model.gsub('.', '-')
+    "#{date}.#{reporter}.#{model}.docx"
+  end
+
+  private
+
+  def document_xml(report)
+    body = paragraphs(report).map { |lines| paragraph_xml(lines) }.join
+    <<~XML
+      <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+      <w:document xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main"><w:body>#{body}<w:sectPr/></w:body></w:document>
+    XML
+  end
+
+  def paragraphs(report)
+    report.to_s.split(/\n{2,}/).map { |paragraph| paragraph.split("\n") }
+  end
+
+  def paragraph_xml(lines)
+    runs = lines.each_with_index.map do |line, index|
+      "#{run_xml(line)}#{'<w:r><w:br/></w:r>' if index < lines.size - 1}"
+    end.join
+    "<w:p>#{runs}</w:p>"
+  end
+
+  def run_xml(line)
+    "<w:r><w:rPr><w:rFonts w:ascii=\"#{FONT}\" w:hAnsi=\"#{FONT}\" w:cs=\"#{FONT}\"/>" \
+      "<w:sz w:val=\"#{SIZE}\"/><w:szCs w:val=\"#{SIZE}\"/></w:rPr>" \
+      "<w:t xml:space=\"preserve\">#{CGI.escapeHTML(line)}</w:t></w:r>"
+  end
+end

data/lib/newsman/github.rb

@@ -40,8 +40,8 @@ class Github
 
   def issues(username, repositories)
     one_year_ago = Date.today.prev_year.strftime('%Y-%m-%d')
-    query = "is:issue is:open author:#{username}"\
-      " author:0pdd created:>=#{one_year_ago} #{repositories}"
+    query = "is:issue is:open assignee:#{username}"\
+      " created:>=#{one_year_ago} #{repositories} label:#{IMPORTANT_ISSUE}"
     puts "Searching issues using the following query: '#{query}'"
     @client.search_issues(query).items.map do |issue|
       parse_issue(issue)

data/lib/newsman/html_output.rb

@@ -23,6 +23,7 @@
 require 'erb'
 require 'redcarpet'
 require 'nokogiri'
+require_relative 'docx_output'
 
 # This class represents a report output in HTML format.
 class Htmlout
@@ -32,6 +33,7 @@ class Htmlout
     </head>
     <body>
       <h1><%= title %></h1>
+      <p><a href="<%= docx %>">Download as Word (.docx)</a></p>
       <%= body %>
     </body>
   HTML
@@ -44,6 +46,7 @@ class Htmlout
   def print(report, reporter, model)
     title = title(reporter)
     body = to_html(report)
+    docx = Docxout.new(@root).print(report, reporter, model)
     puts "Create a html file in a directory #{@root}"
     file = File.new(File.join(@root, filename(reporter, model)), 'w')
     puts "File #{file.path} was successfully created"

data/lib/newsman/issues.rb

@@ -23,6 +23,8 @@
 require 'net/http'
 require 'json'
 
+IMPORTANT_ISSUE = 'soon'
+
 # This class represents a GitHub Issue abstraction created by a user.
 class Issue
   attr_accessor :title, :body, :repo, :number
@@ -69,7 +71,7 @@ class Issue
   end
 
   def important?
-    labels.include? 'soon'
+    labels.include? IMPORTANT_ISSUE
   end
 end
 
@@ -124,7 +126,7 @@ class PddIssue
   end
 
   def important?
-    labels.include? 'soon'
+    labels.include? IMPORTANT_ISSUE
   end
 
   def url

data/lib/newsman.rb

@@ -31,6 +31,7 @@ require_relative 'newsman/issues'
 require_relative 'newsman/stdout_output'
 require_relative 'newsman/txt_output'
 require_relative 'newsman/html_output'
+require_relative 'newsman/docx_output'
 require_relative 'newsman/report'
 require_relative 'newsman/assistant'
 require_relative 'newsman/github'
@@ -60,7 +61,7 @@ def generate
     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', '-o txt' or even '-o html'") do |o|
+            "You can choose another options like '-o html', '-o txt' or '-o docx'") do |o|
       options[:output] = o
     end
     opts.on('-t', '--title TITLE', 'Project Title. Empty by default') { |t| options[:title] = t }
@@ -128,16 +129,21 @@ def generate
   full_answer = report.append_additional(full_answer)
   output_mode = options[:output]
   puts "Output mode is '#{output_mode}'"
-  if output_mode.eql? 'txt'
-    puts 'Print result to txy file'
+  case output_mode
+  when 'txt'
+    puts 'Print result to a txt file'
     output = Txtout.new('.')
     output.print(full_answer, github_username)
-  elsif output_mode.eql? 'html'
-    puts 'Print result to html file'
+  when 'html'
+    puts 'Print result to a html file'
     output = Htmlout.new('.')
     output.print(full_answer, github_username, options[:model])
+  when 'docx'
+    puts 'Print result to a docx file'
+    output = Docxout.new('.')
+    output.print(full_answer, github_username, options[:model])
   else
-    puts 'Print result to stdout'
+    puts 'Print result to a stdout'
     output = Stdout.new
     output.print(full_answer)
   end

data/test/test_docxout.rb

@@ -0,0 +1,53 @@
+#!/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 'date'
+require 'zip'
+require_relative '../lib/newsman/docx_output'
+
+class TestDocxout < Minitest::Test
+  def test_writes_to_a_docx_file
+    Dir.mktmpdir do |temp_dir|
+      output = Docxout.new(temp_dir)
+      today = Date.today.strftime('%d.%m.%Y')
+      expected = "#{today}.volodya-lombrozo.gpt-3-5-turbo.docx"
+      returned = output.print("Issue description\n\nHere is a new paragraph\nList is here:\n - one\n - two\n - three",
+                              'volodya-lombrozo',
+                              'gpt-3.5-turbo')
+      assert_equal(expected, returned)
+      assert(File.exist?(File.join(temp_dir, expected)))
+    end
+  end
+
+  def test_docx_uses_times_new_roman_12pt
+    Dir.mktmpdir do |temp_dir|
+      output = Docxout.new(temp_dir)
+      path = File.join(temp_dir, output.print('Issue description', 'volodya-lombrozo', 'gpt-3.5-turbo'))
+      document_xml = Zip::File.open(path) { |zip| zip.read('word/document.xml') }
+      assert_includes(document_xml, 'w:ascii="Times New Roman"')
+      assert_includes(document_xml, '<w:sz w:val="24"/>')
+      assert_includes(document_xml, 'Issue description')
+    end
+  end
+end

data/test/test_htmlout.rb

@@ -22,6 +22,7 @@
 # SOFTWARE.
 
 require 'minitest/autorun'
+require 'date'
 require_relative '../lib/newsman/html_output'
 
 class TestHtmlout < Minitest::Test
@@ -32,6 +33,7 @@ class TestHtmlout < Minitest::Test
   </head>
   <body>
   <h1>volodya-lombrozo #{Time.new.strftime('%d.%m.%Y')}</h1>
+  <p><a href=\"#{Time.new.strftime('%d.%m.%Y')}.volodya-lombrozo.gpt-3-5-turbo.docx\">Download as Word (.docx)</a></p>
   <p>Issue description</p>
 
 <p>Here is a new paragraph<br/>
@@ -56,4 +58,14 @@ List is here:<br/>
       assert_equal(EXPECTED, File.read(File.join(temp_dir, expected)))
     end
   end
+
+  def test_also_writes_a_docx_file
+    Dir.mktmpdir do |temp_dir|
+      output = Htmlout.new(temp_dir)
+      today = Date.today.strftime('%d.%m.%Y')
+      expected = "#{today}.volodya-lombrozo.gpt-3-5-turbo.docx"
+      output.print('Issue description', 'volodya-lombrozo', 'gpt-3.5-turbo')
+      assert(File.exist?(File.join(temp_dir, expected)))
+    end
+  end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: newsman
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.2.1
 platform: ruby
 authors:
 - Volodya Lombrozo
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-02 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -164,6 +163,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.3'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: A simple gem that gathers GitHub statistics and creates human-readable
   report
 email:
@@ -178,6 +191,7 @@ files:
 - bin/newsman
 - lib/newsman.rb
 - lib/newsman/assistant.rb
+- lib/newsman/docx_output.rb
 - lib/newsman/github.rb
 - lib/newsman/html_output.rb
 - lib/newsman/issues.rb
@@ -186,6 +200,7 @@ files:
 - lib/newsman/stdout_output.rb
 - lib/newsman/txt_output.rb
 - test/test_assistant.rb
+- test/test_docxout.rb
 - test/test_htmlout.rb
 - test/test_issue.rb
 - test/test_pdd_issue.rb
@@ -198,7 +213,6 @@ homepage: https://github.com/volodya-lombrozo/newsman
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -214,8 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
 summary: GitHub user weekly news
 test_files: []