newsman 1.0.0 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c6eaa01ebc8b603b13a1bb158e8a491ed2c51df32d973d56e9e99d959db7d4a
-  data.tar.gz: be86c2c47cc64f2da87a04127cf879a8ccabfff8fa9557730e6f3031a225efdb
+  metadata.gz: '0166813d55623364efd38ff1f3bc83ff3ae76ee9d793b1b5ac52924477122135'
+  data.tar.gz: 48d3c00284b0973851b95c2b144fe50972f801deeb826b400ab31e87102b7cfc
 SHA512:
-  metadata.gz: b2b8972c04260e5c588015270b0e192c47bc39cc72c52124b200b5150b16be0e0d149ebb85d890ebcf2e21d98168b220c49953e769b852a62f6d9e18af627a5c
-  data.tar.gz: 12b435a44fb9687e9904f436f8b7203927856be57d1933045ca5fefbbe9d076346869962abd884c71e9bd6c2674daa1f9334186a90a84a79d2baa9b0c47d02a8
+  metadata.gz: 193cf28ea41b994cab278212cc255dcf0d1f7b78570e631f68e17003d489d505fd0e12a8b3244d576fa1e0826d992ead7af9c1febefd80074dc8260174294dae
+  data.tar.gz: 4e3a9c5920d471c3c5a1dcabe16692a6154ea50d44adaf775d263ce04186e814068391555d3e90682b043dbb2b3c4fb0372da2f8fa7e91abf331a594bfefe4e7

data/README.md

@@ -62,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
 ```
@@ -98,6 +98,25 @@ newsman --help
 ```
 And you should see a welcome message from newsman.
 
+## Releases
+
+Releases are handled by the [`release.yaml`](.github/workflows/release.yaml) GitHub Actions workflow. It runs whenever a tag matching `v*.*.*` (e.g. `v1.2.1`) is pushed, or manually via `workflow_dispatch`. On trigger it:
+
+1. Runs the test suite (`rake test`) and RuboCop (`rake rubocop`).
+2. Builds and installs the gem (`rake install`).
+3. Publishes the gem to [RubyGems.org](https://rubygems.org/gems/newsman) (`rake publish`), using the `RUBYGEMS_API_KEY` secret.
+4. Creates a GitHub Release for the pushed tag, using the `RELEASE_GITHUB_TOKEN` secret.
+
+### How to cut a release
+
+1. **Bump the version** in `newsman.gemspec` (`spec.version`) and commit it to `main`. RubyGems refuses to publish a version that's already live, so this step is mandatory - the workflow's `gem push` will silently fail otherwise (the publish step is `continue-on-error: true`, so the run can still show green even though nothing was actually published).
+2. **Tag the commit** with the same version, prefixed with `v`, and push the tag:
+   ```shell
+   git tag v1.2.1
+   git push origin v1.2.1
+   ```
+3. Watch the `Release Ruby Gem` workflow run in the Actions tab, and confirm the new version shows up on [RubyGems.org](https://rubygems.org/gems/newsman) and as a [GitHub Release](https://github.com/volodya-lombrozo/newsman/releases).
+
 ## Examples
 
 You can find examples of generated reports [here](https://volodya-lombrozo.github.io/newsman/)

data/lib/newsman/assistant.rb

@@ -112,32 +112,32 @@ class Assistant
     send(prompt)
   end
 
-  # rubocop:disable Metrics/MethodLength
+  # OpenAI's reasoning-family models (o1, o3, o4-mini, gpt-5, ...) only accept
+  # the default temperature (1) and reject any explicit value with a 400.
+  # Their "-chat" flavors (e.g. gpt-5-chat-latest) are non-reasoning and
+  # support a custom temperature just like gpt-4o, gpt-3.5-turbo, etc.
+  FIXED_TEMPERATURE_MODELS = /\A(o[1-9]|gpt-5)/
+
   def send(request)
+    parameters = { model: @model, messages: messages(request) }
+    parameters[:temperature] = @temperature unless fixed_temperature?
+    @client.chat(parameters: parameters).dig('choices', 0, 'message', 'content')
+  end
+
+  def fixed_temperature?
+    @model.match?(FIXED_TEMPERATURE_MODELS) && !@model.include?('chat')
+  end
+
+  SYSTEM_PROMPT = '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 messages(request)
     if @model == 'o1-preview'
-      @client.chat(
-        parameters: {
-          model: @model,
-          messages: [{ role: 'user', content: request.to_s }]
-        }
-      ).dig('choices', 0, 'message', 'content')
+      [{ role: 'user', content: request.to_s }]
     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')
+      [{ role: 'system', content: SYSTEM_PROMPT }, { role: 'user', content: request.to_s }]
     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/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.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,14 +129,19 @@ def generate
   full_answer = report.append_additional(full_answer)
   output_mode = options[:output]
   puts "Output mode is '#{output_mode}'"
-  if output_mode.eql? 'txt'
+  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'
+  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 a stdout'
     output = Stdout.new

data/test/test_assistant.rb

@@ -35,4 +35,31 @@ class TestAssistant < Minitest::Test
     assert_equal expected,
                  assistant.say_hello
   end
+
+  def test_fixed_temperature_for_reasoning_models
+    %w[o1 o1-preview o1-mini o3 o3-mini o4-mini gpt-5 gpt-5-mini gpt-5.6].each do |model|
+      assistant = Assistant.new('test-token', model: model)
+      assert(assistant.fixed_temperature?, "expected #{model} to have a fixed temperature")
+    end
+  end
+
+  def test_custom_temperature_for_chat_models
+    %w[gpt-3.5-turbo gpt-4o gpt-4.1 gpt-5-chat-latest].each do |model|
+      assistant = Assistant.new('test-token', model: model)
+      refute(assistant.fixed_temperature?, "expected #{model} to allow a custom temperature")
+    end
+  end
+
+  def test_o1_preview_skips_system_message
+    assistant = Assistant.new('test-token', model: 'o1-preview')
+    messages = assistant.messages('do something')
+    assert_equal([{ role: 'user', content: 'do something' }], messages)
+  end
+
+  def test_other_models_keep_system_message
+    assistant = Assistant.new('test-token', model: 'gpt-5.6')
+    messages = assistant.messages('do something')
+    assert_equal(2, messages.size)
+    assert_equal('system', messages.first[:role])
+  end
 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: 1.0.0
+  version: 1.2.2
 platform: ruby
 authors:
 - Volodya Lombrozo
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-06 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.22
-signing_key: 
+rubygems_version: 4.0.16
 specification_version: 4
 summary: GitHub user weekly news
 test_files: []