jekyll-post-card 0.1.0

data/lib/jekyll-post-card/fetcher.rb

@@ -0,0 +1,201 @@
+                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            # frozen_string_literal: true
+
+require "net/http"
+require "uri"
+require "nokogiri"
+require "json"
+
+module Jekyll
+  module PostCard
+    # Fetches metadata from external URLs using Open Graph, Twitter Cards, and HTML meta tags
+    class Fetcher
+      TIMEOUT = 10
+      USER_AGENT = "Jekyll-Post-Card/#{VERSION} (+https://github.com/r0x0d/jekyll-post-card)"
+
+      class FetchError < StandardError; end
+
+      # Metadata structure for a fetched post
+      PostMetadata = Struct.new(
+        :title,
+        :description,
+        :image,
+        :url,
+        :site_name,
+        :date,
+        :author,
+        :type,
+        keyword_init: true
+      )
+
+      class << self
+        def fetch(url)
+          uri = validate_url(url)
+          html = fetch_html(uri)
+          parse_metadata(html, uri)
+        rescue FetchError => e
+          PostCard.logger.warn("Failed to fetch metadata for #{url}: #{e.message}")
+          error_metadata(url, e.message)
+        rescue StandardError => e
+          PostCard.logger.error("Unexpected error fetching #{url}: #{e.message}")
+          error_metadata(url, "Unexpected error occurred")
+        end
+
+        private
+
+        def validate_url(url)
+          uri = URI.parse(url)
+          raise FetchError, "Invalid URL scheme" unless %w[http https].include?(uri.scheme)
+          raise FetchError, "Missing host" unless uri.host
+
+          uri
+        rescue URI::InvalidURIError => e
+          raise FetchError, "Invalid URL: #{e.message}"
+        end
+
+        def fetch_html(uri)
+          http = Net::HTTP.new(uri.host, uri.port)
+          http.use_ssl = uri.scheme == "https"
+          http.open_timeout = TIMEOUT
+          http.read_timeout = TIMEOUT
+
+          request = Net::HTTP::Get.new(uri)
+          request["User-Agent"] = USER_AGENT
+          request["Accept"] = "text/html,application/xhtml+xml"
+
+          response = http.request(request)
+
+          case response
+          when Net::HTTPSuccess
+            response.body
+          when Net::HTTPRedirection
+            redirect_url = response["location"]
+            redirect_uri = URI.parse(redirect_url)
+            redirect_uri = URI.join(uri, redirect_url) unless redirect_uri.absolute?
+            fetch_html(redirect_uri)
+          else
+            raise FetchError, "HTTP #{response.code}: #{response.message}"
+          end
+        end
+
+        def parse_metadata(html, uri)
+          doc = Nokogiri::HTML(html)
+
+          PostMetadata.new(
+            title: extract_title(doc),
+            description: extract_description(doc),
+            image: extract_image(doc, uri),
+            url: uri.to_s,
+            site_name: extract_site_name(doc, uri),
+            date: extract_date(doc),
+            author: extract_author(doc),
+            type: extract_type(doc)
+          )
+        end
+
+        def extract_title(doc)
+          # Priority: og:title > twitter:title > <title>
+          og_title = doc.at_css('meta[property="og:title"]')&.[]("content")
+          twitter_title = doc.at_css('meta[name="twitter:title"]')&.[]("content")
+          html_title = doc.at_css("title")&.text
+
+          (og_title || twitter_title || html_title || "Untitled").strip
+        end
+
+        def extract_description(doc)
+          # Priority: og:description > twitter:description > meta description
+          og_desc = doc.at_css('meta[property="og:description"]')&.[]("content")
+          twitter_desc = doc.at_css('meta[name="twitter:description"]')&.[]("content")
+          meta_desc = doc.at_css('meta[name="description"]')&.[]("content")
+
+          (og_desc || twitter_desc || meta_desc || "").strip
+        end
+
+        def extract_image(doc, base_uri)
+          # Priority: og:image > twitter:image
+          og_image = doc.at_css('meta[property="og:image"]')&.[]("content")
+          twitter_image = doc.at_css('meta[name="twitter:image"]')&.[]("content")
+
+          image_url = og_image || twitter_image
+          return nil unless image_url
+
+          # Make relative URLs absolute
+          begin
+            image_uri = URI.parse(image_url)
+            image_uri.absolute? ? image_url : URI.join(base_uri, image_url).to_s
+          rescue URI::InvalidURIError
+            image_url
+          end
+        end
+
+        def extract_site_name(doc, uri)
+          og_site = doc.at_css('meta[property="og:site_name"]')&.[]("content")
+          og_site || uri.host.sub(/^www\./, "")
+        end
+
+        def extract_date(doc)
+          # Try various date meta tags
+          date_selectors = [
+            'meta[property="article:published_time"]',
+            'meta[name="date"]',
+            'meta[name="DC.date"]',
+            'meta[name="publish-date"]',
+            'time[datetime]'
+          ]
+
+          date_selectors.each do |selector|
+            element = doc.at_css(selector)
+            next unless element
+
+            date_str = element["content"] || element["datetime"]
+            next unless date_str
+
+            begin
+              return Date.parse(date_str)
+            rescue Date::Error
+              next
+            end
+          end
+
+          nil
+        end
+
+        def extract_author(doc)
+          # Try various author meta tags
+          author_selectors = [
+            'meta[property="article:author"]',
+            'meta[name="author"]',
+            'meta[name="DC.creator"]',
+            'meta[name="twitter:creator"]'
+          ]
+
+          author_selectors.each do |selector|
+            element = doc.at_css(selector)
+            author = element&.[]("content")
+            return author.strip if author && !author.empty?
+          end
+
+          nil
+        end
+
+        def extract_type(doc)
+          og_type = doc.at_css('meta[property="og:type"]')&.[]("content")
+          og_type || "article"
+        end
+
+        def error_metadata(url, message)
+          PostMetadata.new(
+            title: "Unable to load post",
+            description: "Could not fetch metadata: #{message}",
+            image: nil,
+            url: url,
+            site_name: nil,
+            date: nil,
+            author: nil,
+            type: "error"
+          )
+        end
+      end
+    end
+  end
+end
+

data/lib/jekyll-post-card/generator.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module PostCard
+    # Custom static file that allows specifying the destination directory
+    class CssFile < Jekyll::StaticFile
+      def initialize(site, base, dir, name, dest_dir)
+        super(site, base, dir, name)
+        @dest_dir = dest_dir
+      end
+
+      def destination_rel_dir
+        @dest_dir
+      end
+
+      def destination(dest)
+        File.join(dest, @dest_dir, @name)
+      end
+    end
+
+    # Generator that copies the post-card CSS to the site's assets
+    class Generator < Jekyll::Generator
+      safe true
+      priority :lowest
+
+      def generate(site)
+        asset_source = Jekyll::PostCard.asset_path
+        css_source = File.join(asset_source, "post-card.css")
+
+        unless File.exist?(css_source)
+          Jekyll::PostCard.logger.warn("post-card.css not found at #{css_source}")
+          return
+        end
+
+        # Add CSS file as a static file with custom destination
+        site.static_files << CssFile.new(
+          site,
+          asset_source,
+          "",
+          "post-card.css",
+          "/assets/css"
+        )
+      end
+    end
+  end
+end
+

data/lib/jekyll-post-card/post_tag.rb

@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module PostCard
+    # Liquid tag for rendering post cards
+    # Usage:
+    #   {% post_card /2024/01/01/my-post %}
+    #   {% post_card https://example.com/article %}
+    #   {% post_card /my-post variant:compact %}
+    class PostTag < Liquid::Tag
+      VALID_VARIANTS = %w[default compact vertical].freeze
+      EXTERNAL_URL_PATTERN = %r{^https?://}i
+
+      def initialize(tag_name, markup, tokens)
+        super
+        parse_arguments(markup.strip)
+      end
+
+      def render(context)
+        site = context.registers[:site]
+
+        begin
+          if external_url?
+            render_external_card(context)
+          else
+            render_internal_card(site, context)
+          end
+        rescue StandardError => e
+          render_error_card("Error rendering card: #{e.message}")
+        end
+      end
+
+      private
+
+      def parse_arguments(markup)
+        parts = markup.split(/\s+/)
+        @url = parts.shift || ""
+        @options = {}
+
+        parts.each do |part|
+          if part.include?(":")
+            key, value = part.split(":", 2)
+            @options[key.to_sym] = value
+          end
+        end
+
+        @variant = @options[:variant] || "default"
+        @variant = "default" unless VALID_VARIANTS.include?(@variant)
+        
+        # Parse hide_image option (accepts true, false, yes, no, 1, 0)
+        hide_image_value = @options[:hide_image]&.downcase
+        @hide_image = %w[true yes 1].include?(hide_image_value)
+      end
+
+      def external_url?
+        @url.match?(EXTERNAL_URL_PATTERN)
+      end
+
+      def render_internal_card(site, _context)
+        post = find_post(site)
+
+        if post
+          render_card(
+            title: post.data["title"] || "Untitled",
+            description: extract_excerpt(post),
+            image: post.data["image"] || post.data["thumbnail"] || post.data["og_image"],
+            url: post.url,
+            date: post.date,
+            source_type: "internal",
+            source_name: "Internal"
+          )
+        else
+          render_error_card("Post not found: #{@url}")
+        end
+      end
+
+      def extract_excerpt(post)
+        # Handle Jekyll's Excerpt object or string excerpt
+        excerpt = post.data["excerpt"] || post.data["description"]
+        
+        if excerpt
+          # Clean up whitespace but preserve HTML for proper escaping
+          text = excerpt.to_s.gsub(/\s+/, " ").strip
+          return text unless text.empty?
+        end
+
+        excerpt_from_content(post)
+      end
+
+      def render_external_card(_context)
+        metadata = Fetcher.fetch(@url)
+
+        if metadata.type == "error"
+          render_error_card(metadata.description)
+        else
+          render_card(
+            title: metadata.title,
+            description: metadata.description,
+            image: metadata.image,
+            url: metadata.url,
+            date: metadata.date,
+            source_type: "external",
+            source_name: metadata.site_name
+          )
+        end
+      end
+
+      def find_post(site)
+        # Try to find by URL/permalink
+        site.posts.docs.find do |post|
+          post.url == @url || post.url == "/#{@url}" || post.url == @url.chomp("/")
+        end
+      end
+
+      def excerpt_from_content(post)
+        # Get first 160 characters of content, stripping HTML
+        content = post.content.to_s.gsub(/<[^>]*>/, " ").gsub(/\s+/, " ").strip
+        content.length > 160 ? "#{content[0, 157]}..." : content
+      end
+
+      def render_card(title:, description:, image:, url:, date:, source_type:, source_name:)
+        variant_class = @variant == "default" ? "" : " #{@variant}"
+        external_class = source_type == "external" ? " external" : ""
+        # Hide image if explicitly requested or if no image available
+        show_image = image && !@hide_image
+        image_class = show_image ? "" : " no-image"
+
+        formatted_date = format_date(date)
+        escaped_title = escape_html(title)
+        escaped_description = escape_html(description)
+        escaped_source = escape_html(source_name)
+        escaped_url = escape_html(url)
+
+        target = source_type == "external" ? "_blank" : "_self"
+        rel_attr = source_type == "external" ? ' rel="noopener noreferrer"' : ""
+
+        # Use div wrapper like jekyll-github-card to prevent Markdown interference
+        # Render image if available, placeholder if no image (unless explicitly hidden)
+        image_html = if @hide_image
+                       ""
+                     else
+                       render_image(image, escaped_title)
+                     end
+
+        <<~HTML
+          <div class="post-card#{variant_class}#{external_class}#{image_class}" data-url="#{escaped_url}">
+            <a href="#{url}" class="post-card-link" target="#{target}"#{rel_attr}>
+              <div class="post-card-inner">
+                #{image_html}
+                <div class="post-card-content">
+                  <div class="post-card-meta">
+                    <span class="post-card-source">
+                      #{source_icon(source_type)}
+                      #{escaped_source}
+                    </span>
+                    #{formatted_date ? "<span class=\"post-card-date\">#{formatted_date}</span>" : ""}
+                  </div>
+                  <h3 class="post-card-title">#{escaped_title}</h3>
+                  <p class="post-card-excerpt">#{escaped_description}</p>
+                </div>
+                <div class="post-card-arrow">
+                  <svg viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><path d="M5 12h14M12 5l7 7-7 7"/></svg>
+                </div>
+              </div>
+            </a>
+          </div>
+        HTML
+      end
+
+      def render_image(image, alt)
+        if image
+          <<~HTML
+            <div class="post-card-image-container">
+              <img src="#{image}" alt="#{alt}" class="post-card-image" loading="lazy">
+            </div>
+          HTML
+        else
+          <<~HTML
+            <div class="post-card-image-container">
+              <div class="post-card-placeholder">
+                <svg viewBox="0 0 24 24" fill="currentColor"><path d="M19 3H5c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h14c1.1 0 2-.9 2-2V5c0-1.1-.9-2-2-2zm-1 16H6c-.55 0-1-.45-1-1V6c0-.55.45-1 1-1h12c.55 0 1 .45 1 1v12c0 .55-.45 1-1 1zm-4.44-6.19l-2.35 3.02-1.56-1.88c-.2-.25-.58-.24-.78.01l-1.74 2.23c-.26.33-.02.81.39.81h8.98c.41 0 .65-.47.4-.8l-2.55-3.39c-.19-.26-.59-.26-.79 0z"/></svg>
+              </div>
+            </div>
+          HTML
+        end
+      end
+
+      def render_error_card(message)
+        <<~HTML
+          <div class="post-card error no-image">
+            <div class="post-card-inner">
+              <div class="post-card-image-container">
+                <div class="post-card-placeholder">
+                  <svg viewBox="0 0 24 24" fill="currentColor"><path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm1 15h-2v-2h2v2zm0-4h-2V7h2v6z"/></svg>
+                </div>
+              </div>
+              <div class="post-card-content">
+                <div class="post-card-meta">
+                  <span class="post-card-source" style="background: rgba(255, 100, 100, 0.15); color: #ff6b6b;">
+                    <svg viewBox="0 0 24 24" fill="currentColor"><path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm1 15h-2v-2h2v2zm0-4h-2V7h2v6z"/></svg>
+                    Error
+                  </span>
+                </div>
+                <h3 class="post-card-title">Unable to load post</h3>
+                <p class="post-card-excerpt">#{escape_html(message)}</p>
+              </div>
+            </div>
+          </div>
+        HTML
+      end
+
+      def source_icon(type)
+        if type == "internal"
+          '<svg viewBox="0 0 24 24" fill="currentColor"><path d="M19 21l-7-5-7 5V5a2 2 0 012-2h10a2 2 0 012 2z"/></svg>'
+        else
+          '<svg viewBox="0 0 24 24" fill="currentColor"><path d="M12 2C6.48 2 2 6.48 2 12s4.48 10 10 10 10-4.48 10-10S17.52 2 12 2zm-1 17.93c-3.95-.49-7-3.85-7-7.93 0-.62.08-1.21.21-1.79L9 15v1c0 1.1.9 2 2 2v1.93zm6.9-2.54c-.26-.81-1-1.39-1.9-1.39h-1v-3c0-.55-.45-1-1-1H8v-2h2c.55 0 1-.45 1-1V7h2c1.1 0 2-.9 2-2v-.41c2.93 1.19 5 4.06 5 7.41 0 2.08-.8 3.97-2.1 5.39z"/></svg>'
+        end
+      end
+
+      def format_date(date)
+        return nil unless date
+
+        if date.respond_to?(:strftime)
+          date.strftime("%B %d, %Y")
+        else
+          date.to_s
+        end
+      end
+
+      def escape_html(text)
+        return "" unless text
+
+        text.to_s
+            .gsub("&", "&amp;")
+            .gsub("<", "&lt;")
+            .gsub(">", "&gt;")
+            .gsub('"', "&quot;")
+            .gsub("'", "&#39;")
+      end
+    end
+  end
+end
+
+# Register the tag - using "post_card" to avoid conflicts with Jekyll internals
+Liquid::Template.register_tag("post_card", Jekyll::PostCard::PostTag)
+

data/lib/jekyll-post-card/version.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module PostCard
+    VERSION = "0.1.0"
+  end
+end
+

data/lib/jekyll-post-card.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "logger"
+
+require_relative "jekyll-post-card/version"
+require_relative "jekyll-post-card/fetcher"
+require_relative "jekyll-post-card/post_tag"
+require_relative "jekyll-post-card/generator"
+
+module Jekyll
+  module PostCard
+    # Get the gem's root directory (parent of lib/)
+    GEM_ROOT = File.expand_path("..", __dir__)
+    ASSET_PATH = File.join(GEM_ROOT, "assets")
+
+    class << self
+      def logger
+        @logger ||= Logger.new($stdout, level: Logger::INFO)
+      end
+
+      def logger=(logger)
+        @logger = logger
+      end
+
+      def asset_path
+        ASSET_PATH
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-post-card
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rodolfo Olivieri
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: Embed beautiful, responsive post cards in your Jekyll site using a simple
+  Liquid tag. Works with both internal Jekyll posts and external URLs. Automatically
+  fetches metadata including title, description, and images.
+email:
+- rodolfo.olivieri3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- assets/post-card.css
+- demo.html
+- lib/jekyll-post-card.rb
+- lib/jekyll-post-card/fetcher.rb
+- lib/jekyll-post-card/generator.rb
+- lib/jekyll-post-card/post_tag.rb
+- lib/jekyll-post-card/version.rb
+homepage: https://github.com/r0x0d/jekyll-post-card
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/r0x0d/jekyll-post-card
+  source_code_uri: https://github.com/r0x0d/jekyll-post-card
+  changelog_uri: https://github.com/r0x0d/jekyll-post-card/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A Jekyll plugin to display beautiful post cards in your Markdown
+test_files: []