gemstar 1.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 65596efbc0ff5c10ad950ca3cc8bb19e9ca9030db58b73d046ebce447200aa07
-  data.tar.gz: e5ab0cbb7f3db4b3d9949011f3b6446aecb725ee1863fd61dd196660332606de
+  metadata.gz: 4c795357616121ccda76004c6fefa92194688472dd45950396c24a1924cf70a6
+  data.tar.gz: d4922547dc024c923d751164698da5b672c48fd4b2e61384345e0de24b1f5430
 SHA512:
-  metadata.gz: ef75cdf526345f289eff5f0a8bff44520eb1d0aea55eff617de71d585832721655fd70c680e0e27ef7584c15dd4f304d9ee3b079c70fbafc7e4ccc5c8360c4ad
-  data.tar.gz: 13e3d871e1772c7f8ec183a3801504123896e8bd5365bba2a3e6fae5668415dcf2a40ef29f3494a2e9bef47251a3b913c37ae122879c3e8367cba9cf4490af1e
+  metadata.gz: 6caf7c992dcccd533da3cbcf8ed1e98ee44538faffbdf43c55e1ecc1af899497c70100c62e1ba5bbe9331fba6c78d2a65a571c860f4035b99dc63f44d94cb682
+  data.tar.gz: 88e7f1557e01332a6d5dbd69301b0fcfb30548a80333d835476994a9b9ae92a5fdb8559bfa268d242ad11eaad266b432947277d52b185e40dcc66f166ee01854

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Unreleased
 
+## 1.0.1
+
+- Added `--format markdown` to `gemstar diff` command. 
+
+## 1.0
+
 - Added `gemstar server`, your interactive Gemfile.lock explorer and more.
 - Default location for `diff` is now a tmp file.
 - Removed Railtie from this gem.

data/README.md

@@ -60,6 +60,12 @@ To examine a specific Gemfile.lock, pass it like this:
 gemstar diff --lockfile=~/MyProject/Gemfile.lock
 ```
 
+To write markdown instead of html:
+
+```shell
+gemstar diff --format markdown
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at [https://github.com/FDj/gemstar](https://github.com/FDj/gemstar).

data/lib/gemstar/cli.rb

@@ -13,6 +13,7 @@ module Gemstar
     desc "diff", "Show changelogs for updated gems"
     method_option :from, type: :string, desc: "Git ref or lockfile"
     method_option :to, type: :string, desc: "Git ref or lockfile"
+    method_option :format, type: :string, desc: "Output format (html or markdown)"
     method_option :output_file, type: :string, desc: "Output file path"
     method_option :debug_gem_regex, type: :string, desc: "Debug matching gems", hide: true
     def diff

data/lib/gemstar/commands/diff.rb

@@ -15,6 +15,7 @@ module Gemstar
       attr_reader :git_repo
       attr_reader :lockfile_full_path
       attr_reader :output_file
+      attr_reader :output_format
 
       def initialize(options)
         super
@@ -24,7 +25,8 @@ module Gemstar
         @from = options[:from] || "HEAD"
         @to = options[:to]
         @lockfile = options[:lockfile] || "Gemfile.lock"
-        @output_file = options[:output_file] || File.join(Dir.tmpdir, "gem_update_changelog.html")
+        @output_format = normalize_output_format(options[:format] || options[:output_format])
+        @output_file = options[:output_file] || default_output_file
 
         @git_repo = Gemstar::GitRepo.new(File.dirname(@lockfile))
       end
@@ -44,8 +46,8 @@ module Gemstar
 
         collect_updates(new_lockfile: new, old_lockfile: old)
 
-        html = Outputs::HTML.new.render_diff(self)
-        File.write(output_file, html)
+        rendered_output = output_renderer.render_diff(self)
+        File.write(output_file, rendered_output)
         puts "✅ Changelog report created: #{File.expand_path(output_file)}"
 
         if failed.any?
@@ -56,6 +58,27 @@ module Gemstar
 
       private
 
+      def normalize_output_format(value)
+        format = value.to_s.strip.downcase
+        return :markdown if %w[md markdown].include?(format)
+
+        :html
+      end
+
+      def default_output_file
+        extension = output_format == :markdown ? "md" : "html"
+        File.join(Dir.tmpdir, "gem_update_changelog.#{extension}")
+      end
+
+      def output_renderer
+        @output_renderer ||= case output_format
+        when :markdown
+          Outputs::Markdown.new
+        else
+          Outputs::HTML.new
+        end
+      end
+
       def build_entry(gem_name:, old_version:, new_version:)
         metadata = Gemstar::RubyGemsMetadata.new(gem_name)
         repo_url = metadata.repo_uri

data/lib/gemstar/outputs/markdown.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require_relative "basic"
+require "pathname"
+require "cgi"
+require "nokogiri"
+
+module Gemstar
+  module Outputs
+    class Markdown < Basic
+      def render_diff(diff_command)
+        project_name = Pathname.getwd.basename.to_s
+        body = diff_command.updates.sort.map do |gem_name, info|
+          render_entry(gem_name, info)
+        end.join("\n\n---\n\n")
+
+        <<~MARKDOWN
+          # #{project_name}: Gem Updates
+
+          _Showing changes from #{diff_command.from} to #{diff_command.to || "now"}, generated on #{Time.now.strftime("%Y-%m-%d %H:%M:%S %z")}._
+
+          #{body}
+        MARKDOWN
+      end
+
+      private
+
+      def render_entry(gem_name, info)
+        title = if info[:homepage_url]
+          "## [#{gem_name}](#{info[:homepage_url]})"
+        else
+          "## #{gem_name}"
+        end
+
+        parts = []
+        parts << title
+        parts << ""
+        parts << "*#{info[:old] || "new"} → #{info[:new]}*"
+        parts << ""
+        parts << info[:description].to_s unless info[:description].to_s.empty?
+        parts << "" unless info[:description].to_s.empty?
+
+        parts.concat(link_lines(info))
+
+        if info[:sections]
+          parts << render_sections(info[:sections])
+        elsif info[:release_urls]
+          parts << "No changelog entries found for this version."
+        else
+          parts << "No changelog entries found."
+        end
+
+        parts.join("\n").strip
+      end
+
+      def link_lines(info)
+        lines = []
+        lines << "[Compare changes](#{info[:compare_url]})" if info[:compare_url]
+        lines << "[View all GitHub release notes](#{info[:release_page]})" if info[:release_page]
+        lines << "" unless lines.empty?
+        lines
+      end
+
+      def render_sections(sections)
+        sections.map do |_version, lines|
+          Array(lines).flatten.map { |chunk| markdownize_chunk(chunk) }.join
+        end.join("\n\n").strip
+      end
+
+      def markdownize_chunk(chunk)
+        text = chunk.to_s
+        return text unless html_fragment?(text)
+
+        fragment = Nokogiri::HTML::DocumentFragment.parse(text)
+        markdown = fragment.children.map { |node| node_to_markdown(node) }.join
+        markdown.gsub(/\n{3,}/, "\n\n").strip + "\n"
+      rescue StandardError
+        text
+      end
+
+      def html_fragment?(text)
+        text.match?(%r{</?[a-z][^>]*>}i)
+      end
+
+      def node_to_markdown(node, list_depth: 0)
+        return CGI.unescapeHTML(node.text) if node.text?
+        return "" unless node.element?
+
+        case node.name
+        when "p"
+          "#{inline_children(node).strip}\n\n"
+        when "br"
+          "  \n"
+        when "strong", "b"
+          "**#{inline_children(node).strip}**"
+        when "em", "i"
+          "*#{inline_children(node).strip}*"
+        when "code"
+          if node.ancestors.any? { |ancestor| ancestor.name == "pre" }
+            CGI.unescapeHTML(node.text)
+          else
+            "`#{CGI.unescapeHTML(node.text)}`"
+          end
+        when "pre"
+          code = CGI.unescapeHTML(node.text).rstrip
+          "```\n#{code}\n```\n\n"
+        when "a"
+          text = inline_children(node).strip
+          href = node["href"].to_s
+          return text if href.empty?
+
+          "[#{text.empty? ? href : text}](#{href})"
+        when "ul"
+          list_children(node, ordered: false, list_depth: list_depth)
+        when "ol"
+          list_children(node, ordered: true, list_depth: list_depth)
+        when "li"
+          "#{inline_children(node).strip}\n"
+        when /\Ah[1-6]\z/
+          level = node.name.delete_prefix("h").to_i
+          "#{"#" * level} #{inline_children(node).strip}\n\n"
+        when "blockquote"
+          quote = inline_children(node).strip.lines.map { |line| "> #{line.rstrip}" }.join("\n")
+          "#{quote}\n\n"
+        when "hr"
+          "\n---\n\n"
+        else
+          children_to_markdown(node, list_depth: list_depth)
+        end
+      end
+
+      def children_to_markdown(node, list_depth: 0)
+        node.children.map { |child| node_to_markdown(child, list_depth: list_depth) }.join
+      end
+
+      def inline_children(node)
+        children_to_markdown(node).gsub(/\s+/, " ").strip
+      end
+
+      def list_children(node, ordered:, list_depth:)
+        index = 0
+
+        rendered = node.element_children.filter_map do |child|
+          next unless child.name == "li"
+
+          index += 1
+          marker = ordered ? "#{index}." : "-"
+          prefix = "#{"  " * list_depth}#{marker} "
+
+          item_parts = child.children.map do |grandchild|
+            if %w[ul ol].include?(grandchild.name)
+              "\n" + list_children(grandchild, ordered: grandchild.name == "ol", list_depth: list_depth + 1).rstrip
+            else
+              node_to_markdown(grandchild, list_depth: list_depth + 1)
+            end
+          end.join
+
+          "#{prefix}#{item_parts.strip}\n"
+        end
+
+        rendered.join + "\n"
+      end
+    end
+  end
+end

data/lib/gemstar/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Gemstar # :nodoc:
-  VERSION = "1.0"
+  VERSION = "1.0.1"
 
   def self.debug?
     return @debug if defined?(@debug)

data/lib/gemstar.rb

@@ -11,6 +11,7 @@ require "gemstar/commands/server"
 require "gemstar/config"
 require "gemstar/outputs/basic"
 require "gemstar/outputs/html"
+require "gemstar/outputs/markdown"
 require "gemstar/cache"
 require "gemstar/change_log"
 require "gemstar/git_hub"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gemstar
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: 1.0.1
 platform: ruby
 authors:
 - Florian Dejako
@@ -234,6 +234,7 @@ files:
 - lib/gemstar/lock_file.rb
 - lib/gemstar/outputs/basic.rb
 - lib/gemstar/outputs/html.rb
+- lib/gemstar/outputs/markdown.rb
 - lib/gemstar/project.rb
 - lib/gemstar/remote_repository.rb
 - lib/gemstar/request_logger.rb