jekyll-euclid 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 743add07e4ef9648d4b86ee1ad3a4a4878d1cf2f72b268c316cc36d523a9eefe
-  data.tar.gz: 67d1cc710682a731d44f9a6d5a9f7cfeb46a9b0af00bda434c873df7f11cf471
+  metadata.gz: d62ac5ec85a146f9c437ed9783b973b80940b33a8560dfb5dbc308211bac6f6b
+  data.tar.gz: 428a7a1023cf327802fb54f98b5185e14dfbf7742e2441a2d980d560b8228067
 SHA512:
-  metadata.gz: 198f52f27b9e9d46df571a923fc5db49e92c0c003fcf2f5cb379fb09ccd8c2eda4c850df2f3e5ecad2031657f8cb69a5ee5b8a4bea66acc958c87af2b6215c11
-  data.tar.gz: 9c438ee3d1a503c88da8e45bd3ed60188e7906faeaffc16b1ccd4050f1e620ea192ec2e544b3633d07ba6e761d8044829cf82cf8197598630741568fcacf677c
+  metadata.gz: 74c27c31dade1be4085fbcfb85ba23db375c2062ee68645a5812f659b1653a86ea0a71c85ccbf336466c3f646ac25cc6a043ae89f77d9d4df6cc6daef7c24413
+  data.tar.gz: f44be22c330e5f8428fc1ebb50ec6b525497789fc085f6eba84e046d867dc5d5166f3835ad66731d2948d3d1583478b4f1459b257076a913d1b8f7fe8d690899

data/.rubocop.yml

@@ -6,3 +6,6 @@ Style/StringLiterals:
 
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
+
+Naming/FileName:
+  Enabled: false

data/lib/jekyll/converters/euclid.rb

@@ -1,67 +1,70 @@
+# frozen_string_literal: true
+
 module Jekyll
   module Converters
+    # Converts .euclid files, which are a custom format for writing mathematical proofs based on latex math environments
     class EuclidConverter < Converter
       safe true
       priority :highest
-  
+
       def matches(ext)
         ext =~ /^\.euclid$/i
       end
-  
-      def output_ext(ext)
+
+      def output_ext(_)
         ".html"
       end
-  
+
       def replace_theorem(content)
         @theorem_counter += 1
-  
+
         "**Theorem #{@theorem_counter}:** *#{content[8..-6].strip}*"
       end
-  
+
       def replace_lemma(content)
         @theorem_counter += 1
-  
+
         "**Lemma #{@theorem_counter}:** *#{content[6..-6].strip}*"
       end
-  
+
       def replace_corollary(content)
         @corollary_counter += 1
-  
+
         "**Corollary #{@theorem_counter}.#{@corollary_counter}:** *#{content[10..-6].strip}*"
       end
-  
+
       def replace_axiom(content)
         @axiom_counter += 1
-  
+
         "**Axiom #{@axiom_counter}:** *#{content[6..-6].strip}*"
       end
-  
+
       def replace_definition(content)
         @definition_counter += 1
-  
+
         "**Definition #{@definition_counter}:** *#{content[11..-6].strip}*"
       end
-  
+
       def replace_proof(content)
         "*Proof.* #{content[7..-6]}"
       end
-  
+
       def get_term_index(content)
-        theorem_index = content.index("\\theorem") || 999999
-        lemma_index = content.index("\\lemma") || 999999
-        corollary_index = content.index("\\corollary") || 999999
-  
+        theorem_index = content.index("\\theorem") || 999_999
+        lemma_index = content.index("\\lemma") || 999_999
+        corollary_index = content.index("\\corollary") || 999_999
+
         if theorem_index < lemma_index && theorem_index < corollary_index
           return theorem_index, "\\theorem"
         elsif lemma_index < corollary_index
           return lemma_index, "\\lemma"
-        elsif corollary_index < 999999
+        elsif corollary_index < 999_999
           return corollary_index, "\\corollary"
         end
-  
-        return -1, nil
+
+        [-1, nil]
       end
-  
+
       def replace_theorem_terms(content, term)
         case term
         when "\\theorem"
@@ -72,76 +75,72 @@ module Jekyll
           replace_corollary(content)
         end
       end
-  
+
       def replace_theorems(content)
         @theorem_counter = 0
-  
+
         term_index, term = get_term_index(content)
-  
-        if term != "\\corollary"
-          @corollary_counter = 0
-        end
-  
-        end_index = content[term_index..-1].index("\\end") + term_index
-  
-        while term_index > 0
+
+        term != "\\corollary" && @corollary_counter = 0
+
+        end_index = content[term_index..].index("\\end") + term_index
+
+        while term_index.positive?
           term_content = content[term_index..(end_index + 3)]
-          content = content[0..(term_index - 1)] + replace_theorem_terms(term_content, term) + content[(end_index + 4)..-1]
-  
+          content_before = content[0..(term_index - 1)]
+          content_after = content[(end_index + 4)..]
+          content = content_before + replace_theorem_terms(term_content, term) + content_after
+
           term_index, term = get_term_index(content)
-  
-          if term_index == -1
-            break
-          end
-  
-          end_index = content[term_index..-1].index("\\end") + term_index
+
+          term_index == -1 && break
+
+          end_index = content[term_index..].index("\\end") + term_index
         end
-  
+
         content
       end
-  
+
       def replace_term(term, content, replace_method)
         term_index = content.index(term)
-        end_index = content[term_index..-1].index("\\end") + term_index
-  
-        while term_index > 0
+        end_index = content[term_index..].index("\\end") + term_index
+
+        while term_index.positive?
           term_content = content[term_index..(end_index + 3)]
-          content = content[0..(term_index - 1)] + replace_method.call(term_content) + content[(end_index + 4)..-1]
+          content_before = content[0..(term_index - 1)]
+          content_after = content[(end_index + 4)..]
+          content = content_before + replace_method.call(term_content) + content_after
           term_index = content.index(term)
-  
-          if term_index.nil?
-            break
-          end
-  
-          end_index = content[term_index..-1].index("\\end") + term_index
-  
+
+          term_index.nil? && break
+          end_index = content[term_index..].index("\\end") + term_index
+
         end
-  
+
         content
       end
-  
+
       def replace_axioms(content)
         @axiom_counter = 0
         replace_term("\\axiom", content, method(:replace_axiom))
       end
-  
+
       def replace_definitions(content)
         @definition_counter = 0
         replace_term("\\definition", content, method(:replace_definition))
       end
-  
+
       def replace_proofs(content)
         replace_term("\\proof", content, method(:replace_proof))
       end
-  
+
       def convert(content)
         content = replace_theorems(content)
         content = replace_axioms(content)
         content = replace_definitions(content)
         content = replace_proofs(content)
-  
-  
-        Jekyll::Converters::Markdown::KramdownParser.new(Jekyll.configuration()).convert(content)
+
+        Jekyll::Converters::Markdown::KramdownParser.new(Jekyll.configuration).convert(content)
       end
     end
   end

data/lib/jekyll-euclid/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Euclid
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/jekyll-euclid.rb

@@ -1 +1,11 @@
-require "jekyll-euclid/version"
+# frozen_string_literal: true
+
+require "jekyll"
+
+require File.expand_path("jekyll/converters/euclid", File.dirname(__FILE__))
+
+module Jekyll
+  # Euclid converter for Jekyll
+  module EuclidConverter
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-euclid
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Guilherme Nakayama
@@ -10,8 +10,8 @@ bindir: exe
 cert_chain: []
 date: 2024-10-08 00:00:00.000000000 Z
 dependencies: []
-description: This is a very simple attempt trying to mimic some of the behaviour found
-  in LaTex theoremsi system.
+description: This is a simple attempt trying to copy some of the behaviour found in
+  LaTex theoremsi system.
 email:
 - gui@tonkatsuengineering.com
 executables: []