jekyll-tsc 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ea5560f47a48dbde778b57ec1f170b9c3570b3554e2babef0a19e581a0f34e3
-  data.tar.gz: 1a671aac61e08773b3e963451a0eb1f62e5bf6590dd3959f11049b72510780c5
+  metadata.gz: 184b75117bbd184b30e19a72389e5f48ca8faaa997017ab79e813897d3230461
+  data.tar.gz: 374ce6d9292b11c029bbb19530bf14936a5ba6e379e0677deac86c7c960667a0
 SHA512:
-  metadata.gz: 00e3916c10baad4f0a2704b6faad9ba93f6228b79f42bb0ea3ede0c4b10e0367a36188956b9e7151519eee97a9e4abda6e4f83966e51da5aea8b5261005ef2d3
-  data.tar.gz: bcda3a7c08938c2641505609183589ddb2f69ab5e471765d461725dcea0652b19ef1d175e0e443918f83e4346447c5734e7ebafd3ad29eff6126c1515843aa99
+  metadata.gz: 3e1cdea38df605bfed34269cdb7cf3e49f38d5c1ba4c971d40d02c883ae47c284e8075de9f90b6abf5e106b7745a81cc6644b6122227bad24e5d36f146f41cc2
+  data.tar.gz: b6dd17b86e2f594e91359f8f554804bfdef5b7261d18e36443628425aaf2200ecf1fb4251fd267562fd4993699adca05fcdf7ea3cece4c63caf652dedbf7ae46

data/lib/jekyll/typescript/config.rb

@@ -25,10 +25,18 @@ module Jekyll
         @tsc_command ||= Array(config['command']) || ['tsc']
       end
 
+      def cache_enabled?
+        if @cache_enabled.nil?
+          @cache_enabled = config.fetch('cache', true)
+        end
+
+        @cache_enabled
+      end
+
       private
 
       def config
-        @config ||= site.config['typescript']
+        @config ||= site.config['typescript'] || {}
       end
     end
   end

data/lib/jekyll/typescript/manager.rb

@@ -5,6 +5,7 @@ require 'fileutils'
 require 'shellwords'
 require_relative './config'
 require_relative './tsconfig'
+require_relative './mancache'
 
 module Jekyll
   module Typescript
@@ -13,8 +14,9 @@ module Jekyll
       SyntaxError = Class.new(ArgumentError)
 
       include ::Singleton
-      include Config
+      include Config # jekyll config
       include TSConfig
+      prepend ManagerCache
 
       # whether :ext is associated with a typescript extension.
       #
@@ -61,8 +63,6 @@ module Jekyll
       def pre_render(site, _)
         self.site = site
         @pages = []
-        Jekyll.logger.debug('Typescript', 'clearing out temporary build directory.')
-        FileUtils.rm_rf(Dir.glob(File.join(temp_dir, '*')))
       end
 
       # Typescript hook run after a page has been rendered. This is used to add a
@@ -73,19 +73,26 @@ module Jekyll
         @pages << page if copy_ext? page.ext
       end
 
+      def page_to_output_path(page)
+        # TODO only change the extension of .ts files.
+        File.join(temp_dir,
+                  File.dirname(page.relative_path),
+                  File.basename(page.relative_path, '.*') + '.js')
+      end
+
       # Once all the site files have been processed, compile and replace the content
       # of any typescript files.
       #
       def post_render(*args)
         setup
 
+        Jekyll.logger.debug('Typescript', 'clearing out temporary build directory.')
+        FileUtils.rm_rf(Dir.glob(File.join(temp_dir, '*')))
+
         populate_temp_dir
-        @pages.each do |page|
+        @pages.select.each do |page|
           next unless typescript_ext? page.ext
 
-          # change the output extension. it's a hack... but it works so good enough.
-          page.send(:_renderer).instance_variable_set(:@output_ext, '.js')
-
           command = compile_command(in_temp_dir(page.relative_path))
           Jekyll.logger.debug('Typescript') {
             "running compile command: #{Shellwords.join(command[1..])}" }
@@ -95,11 +102,7 @@ module Jekyll
             raise SyntaxError, "typescript failed to convert: #{page.path}\n" + compile_output
           end
 
-          output_file = File.join(temp_dir,
-                                  File.dirname(page.relative_path),
-                                  File.basename(page.relative_path, '.*') + '.js')
-
-          page.output = File.open(output_file, 'r', &:read)
+          page.output = File.read(page_to_output_path(page))
         end
       end
 
@@ -116,7 +119,6 @@ module Jekyll
       def populate_temp_dir
         Dir.chdir(temp_dir) do
           (@pages + static_files).each do |page|
-
             if page.is_a?(StaticFile)
               FileUtils.mkdir_p('./' + page.instance_variable_get(:@dir))
               FileUtils.copy(site.in_source_dir(page.relative_path),
@@ -141,7 +143,7 @@ module Jekyll
         unless @tsconfig_args
           config_file = 'tsconfig.json'
 
-          @tsconfig_args = if File.exists?(config_file)
+          @tsconfig_args = if File.exist?(config_file)
                              parse_tsconfig(dumb_read_json(config_file))
                            else
                              Jekyll.logger.warn('Typescript', "no config file found at #{config_file}")

data/lib/jekyll/typescript/mancache.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'digest/md5'
+
+module Jekyll
+  module Typescript
+    # caches files involved in typescript conversions, using their hash
+    # and only start a new compilation if the result hash has changed
+    # since the last compilation.
+    #
+    module ManagerCache
+      def post_render(*args)
+        if !cache_enabled?
+          super
+        elsif pages_modified?
+          super
+          update_cache
+        else
+          set_pages_from_cache
+        end
+      end
+
+      private
+
+      def pages_modified?
+        # avoid comparing hashes and assume compilation has to happen when
+        # there is no cache, or the number of files involved in the compilation
+        # has changed.
+        return true if conversion_cache.empty? ||
+                       conversion_cache.size != pages.size + static_files.size
+
+        (pages + static_files).each do |page|
+          # no hash registered for the current file
+          cached_hash = conversion_cache[page.relative_path]
+          return true unless cached_hash
+
+          # recompile when the output of compilation doesn't exist.
+          return true unless File.exist?(page_to_output_path(page))
+
+          # content of page has been modified.
+          new_hash = Digest::MD5.hexdigest(get_content(page))
+          return true if new_hash != cached_hash
+        end
+
+        false
+      end
+
+      def get_content(page)
+        if page.is_a?(StaticFile)
+          File.read(page.path)
+        else
+          page.content
+        end
+      end
+
+      def update_cache
+        @conversion_cache = {}
+
+        (pages + static_files).each do |page|
+          hash = Digest::MD5.hexdigest(get_content(page))
+          conversion_cache[page.relative_path] = hash
+        end
+
+        nil
+      end
+
+      def set_pages_from_cache
+        Jekyll.logger.debug('Typescript') {
+          'restoring javascript files from compilation cache.' }
+
+        pages.each { |page| page.output = File.read(page_to_output_path(page)) }
+      end
+
+      def conversion_cache
+        @conversion_cache ||= {}
+      end
+    end
+  end
+end

data/lib/jekyll/typescript/tsconfig.rb

@@ -4,9 +4,6 @@ module Jekyll
   module Typescript
     # Module providing methods to aid in the parsing of tsconfig.json files.
     #
-    # WARN, some of this file is basically me ranting about how absurd tsc
-    # and some of the general web app standards are, as a Unix lover.
-    #
     module TSConfig
       # Parse a tsconfig.json JSON object into an array of equivalent commands
       # line flags.
@@ -41,18 +38,6 @@ module Jekyll
 
       # read a json file at :path, but allow for comments in the file.
       #
-      # RANT
-      # Why in the great stallmans name does everyone use JSON as a config
-      # format when it doesn't support comments?
-      #
-      # RANT
-      # Why in gods name does JSON forbid comments when their pretty much
-      # ubiquotous?
-      #
-      # Adding an option to most parsers to allow comments doesn't seem too
-      # unreasonable, I mean it's not like JSON is solely used as a web
-      # interchange format anymore.
-      #
       def dumb_read_json(path)
         File.open(path, 'r') do |file|
           # regxp partially sourced from https://stackoverflow.com/questions/19910002/remove-comments-from-json-data

data/lib/jekyll/typescript/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Typescript
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-tsc
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Mohsin Kaleem
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-15 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,26 +58,27 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
-description: |
-  provides automatic compilation of typescript files to javascript
-  files for your jekyll blog.
+description: |2
+    provides automatic compilation of typescript files to javascript
+    files for your jekyll blog.
 email: mohkalsin@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/jekyll-tsc.rb
 - lib/jekyll/typescript/config.rb
 - lib/jekyll/typescript/converter.rb
 - lib/jekyll/typescript/generator.rb
 - lib/jekyll/typescript/manager.rb
+- lib/jekyll/typescript/mancache.rb
 - lib/jekyll/typescript/tsconfig.rb
 - lib/jekyll/typescript/version.rb
-- lib/jekyll_tsc.rb
-homepage: 
+homepage:
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -86,8 +93,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
 summary: compile typescript files on your jekyll blog.
 test_files: []