al_citations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af9ea94e6107053d9429029a5b553b0ef62b5f38cc33a5568c9a8079094e2dd9
+  data.tar.gz: eef9ea5a38524303bfb12c2940e8dc24a4d1e3e0972d9083b941f4c0d26e0280
+SHA512:
+  metadata.gz: 2c3f0d0cda356b6d7e119b940d85bce3df84ff3a48520fee4602faca59ea2907038be14873838064be8366adbf4a4bc4761b4a19c6d2b1cc4fda2a2b08112027
+  data.tar.gz: eb52e22d573395e585b7a75ce6a9e33158a37873135e479a6d04f9c4de2d8bb1ab51a5fb51ba3137efa21becc618aae78984e71c4865a5a54a14b879601fd6ee

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.1.0 - 2026-02-07
+- Initial gem release.
+- Added Google Scholar and InspireHEP citation count Liquid tags.
+- Synced Google Scholar parsing regex handling with al-folio main.

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Maruan Al-Shedivat.
+
+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 NONINFRINGEMENT. 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.

data/README.md

@@ -0,0 +1,53 @@
+# Al-Citations
+
+A Jekyll plugin that allows you to fetch and display citation counts from Google Scholar and InspireHEP in your Jekyll site.
+
+## Installation
+
+Add this line to your Jekyll site's Gemfile:
+
+```ruby
+gem 'al_citations'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+1. Add the plugin to your site's `_config.yml`:
+
+```yaml
+plugins:
+  - al_citations
+```
+
+2. Use the tags in your templates:
+
+For Google Scholar:
+```liquid
+{% google_scholar_citations scholar_id article_id %}
+```
+
+For InspireHEP:
+```liquid
+{% inspirehep_citations recid %}
+```
+
+### Example
+
+```liquid
+Citations: {% google_scholar_citations "YOUR_SCHOLAR_ID" "ARTICLE_ID" %}
+InspireHEP Citations: {% inspirehep_citations "INSPIRE_RECID" %}
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub.

data/lib/al_citations/google_scholar.rb

@@ -0,0 +1,82 @@
+module Helpers
+  extend ActiveSupport::NumberHelper
+end
+
+module Jekyll
+  class GoogleScholarCitationsTag < Liquid::Tag
+    Citations = { }
+    CITED_BY_REGEX = /Cited by (\d+[,\d]*)/
+
+    def initialize(tag_name, params, tokens)
+      super
+      splitted = params.split(" ").map(&:strip)
+      @scholar_id = splitted[0]
+      @article_id = splitted[1]
+
+      if @scholar_id.nil? || @scholar_id.empty?
+        puts "Invalid scholar_id provided"
+      end
+
+      if @article_id.nil? || @article_id.empty?
+        puts "Invalid article_id provided"
+      end
+    end
+
+    def render(context)
+      article_id = context[@article_id.strip]
+      scholar_id = context[@scholar_id.strip]
+      article_url = "https://scholar.google.com/citations?view_op=view_citation&hl=en&user=#{scholar_id}&citation_for_view=#{scholar_id}:#{article_id}"
+
+      begin
+          # If the citation count has already been fetched, return it
+          if GoogleScholarCitationsTag::Citations[article_id]
+            return GoogleScholarCitationsTag::Citations[article_id]
+          end
+
+          # Sleep for a random amount of time to avoid being blocked
+          sleep(rand(1.5..3.5))
+
+          # Fetch the article page
+          doc = Nokogiri::HTML(URI.open(article_url, "User-Agent" => "Ruby/#{RUBY_VERSION}"))
+
+          # Attempt to extract the "Cited by n" string from the meta tags
+          citation_count = 0
+
+          # Look for meta tags with "name" attribute set to "description"
+          description_meta = doc.css('meta[name="description"]')
+          og_description_meta = doc.css('meta[property="og:description"]')
+
+          if !description_meta.empty?
+            cited_by_text = description_meta[0]['content']
+            matches = cited_by_text.match(CITED_BY_REGEX)
+
+            if matches
+              citation_count = matches[1].sub(",", "").to_i
+            end
+
+          elsif !og_description_meta.empty?
+            cited_by_text = og_description_meta[0]['content']
+            matches = cited_by_text.match(CITED_BY_REGEX)
+
+            if matches
+              citation_count = matches[1].sub(",", "").to_i
+            end
+          end
+
+        citation_count = Helpers.number_to_human(citation_count, :format => '%n%u', :precision => 2, :units => { :thousand => 'K', :million => 'M', :billion => 'B' })
+
+      rescue Exception => e
+        # Handle any errors that may occur during fetching
+        citation_count = "N/A"
+
+        # Print the error message including the exception class and message
+        puts "Error fetching citation count for #{article_id} in #{article_url}: #{e.class} - #{e.message}"
+      end
+
+      GoogleScholarCitationsTag::Citations[article_id] = citation_count
+      return "#{citation_count}"
+    end
+  end
+end
+
+Liquid::Template.register_tag('google_scholar_citations', Jekyll::GoogleScholarCitationsTag)

data/lib/al_citations/inspirehep.rb

@@ -0,0 +1,49 @@
+module Helpers
+  extend ActiveSupport::NumberHelper
+end
+
+module Jekyll
+  class InspireHEPCitationsTag < Liquid::Tag
+    Citations = { }
+
+    def initialize(tag_name, params, tokens)
+      super
+      @recid = params.strip
+    end
+
+    def render(context)
+      recid = context[@recid.strip]
+      api_url = "https://inspirehep.net/api/literature/?fields=citation_count&q=recid:#{recid}"
+
+      begin
+        # If the citation count has already been fetched, return it
+        if InspireHEPCitationsTag::Citations[recid]
+          return InspireHEPCitationsTag::Citations[recid]
+        end
+
+        # Fetch the citation count from the API
+        uri = URI(api_url)
+        response = Net::HTTP.get(uri)
+        data = JSON.parse(response)
+
+        # Extract citation count from the JSON data
+        citation_count = data["hits"]["hits"][0]["metadata"]["citation_count"].to_i
+
+        # Format the citation count for readability
+        citation_count = Helpers.number_to_human(citation_count, format: '%n%u', precision: 2, units: { thousand: 'K', million: 'M', billion: 'B' })
+
+      rescue Exception => e
+        # Handle any errors that may occur during fetching
+        citation_count = "N/A"
+
+        # Print the error message including the exception class and message
+        puts "Error fetching citation count for #{recid}: #{e.class} - #{e.message}"
+      end
+
+      InspireHEPCitationsTag::Citations[recid] = citation_count
+      return "#{citation_count}"
+    end
+  end
+end
+
+Liquid::Template.register_tag('inspirehep_citations', Jekyll::InspireHEPCitationsTag)

data/lib/al_citations.rb

@@ -0,0 +1,9 @@
+require 'active_support/all'
+require 'nokogiri'
+require 'open-uri'
+require 'net/http'
+require 'json'
+require 'uri'
+
+require 'al_citations/google_scholar'
+require 'al_citations/inspirehep'

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: al_citations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- al-org
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.13'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.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'
+description: Jekyll plugin extracted from al-folio that provides Liquid tags to fetch
+  and render citation counts from Google Scholar and InspireHEP.
+email:
+- dev@al-org.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/al_citations.rb
+- lib/al_citations/google_scholar.rb
+- lib/al_citations/inspirehep.rb
+homepage: https://github.com/al-org-dev/al-citations
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/al-org-dev/al-citations
+  source_code_uri: https://github.com/al-org-dev/al-citations
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Citation count tags for Google Scholar and InspireHEP
+test_files: []