jekyll-fontello 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecf7cd2aabfffcc5d47563a709d91fe7fe3fed83
+  data.tar.gz: bbece952a958c5dbb3371b4be4ecbd8880057467
+SHA512:
+  metadata.gz: 64987c1f9953de429673ad914486908520245ef55940ad2d761b7c9efeae68015caef03c1b6cf7576cae6d9f290f8e0bc677885a21c96672308267cdab5a4d75
+  data.tar.gz: 8ae4391e5f194c41b4cdf8a7c2e62b6f79fb2d2370c41de1eccedbb330ad0d7ad392eba621e1cef8441953ee8a50120abc4cc3e346fabe30faae598118af7b27

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Yihang Ho
+
+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,65 @@
+# jekyll-fontello
+
+Jekyll plugin that automatically downloads your webfont from Fontello.
+
+## Installation
+
+1. Install the `jekyll-fontello` gem:
+```
+gem install jekyll-fontello
+```
+2. Add `jekyll-fontello` to the list of gems in `_config.yml`:
+```yaml
+gems: ["jekyll-fontello"]
+```
+3. Add a Fontello configuration file named `fontello_config.json` to your project.
+4. Use Fontello icons on your website or blog!
+
+_Or_ copy `lib/jekyll-fontello.rb` into your `_plugins` directory.
+
+## Options
+
+#### Config file
+
+Change the name/path of the Fontello configuration file, the default value is `'fontello_config.json'`.
+
+```yaml
+fontello:
+  config: 'config.json'
+```
+
+#### Output fonts
+
+Change the output path of the font files, the default value is `'fontello/fonts'`.
+
+```yaml
+fontello:
+  output_fonts: 'assets/fonts/fontello'
+```
+
+#### Output stylesheets
+
+Change the output path of the stylesheet files, the default value is `'fontello/styles'`.
+
+```yaml
+fontello:
+  output_styles: 'styles/fontello'
+```
+
+#### Custom fonts path
+
+The path to the font files that should be put in the stylesheets By default this is computed as the relative path from `output_styles` to `output_fonts`.
+
+```yaml
+fontello:
+  fonts_path: '/assets/fonts/fontello'
+```
+
+#### Preprocessor
+
+Change what CSS preprocessor is used, by default no preprocessor is used. Allowed values are `'none'`, `'less'` and `'scss'`.
+
+```yaml
+fontello:
+  preprocessor: 'scss'
+```

data/lib/jekyll-fontello.rb

@@ -0,0 +1,146 @@
+require 'net/http'
+require 'uri'
+require 'zip'
+
+Zip.on_exists_proc = true
+
+module Fontello
+  class Generator < Jekyll::Generator
+    FONTELLO_URL = 'http://fontello.com'
+    SESSION_FILE = "#{Dir.tmpdir}/jekyll_fontello_session"
+    ZIP_FILE = "#{Dir.tmpdir}/jekyll_fontello.zip"
+
+    # Read the plugin configuration and generate the
+    # Fontello files based on that.
+    #
+    #  required by Jekyll
+    def generate(site)
+      @download_tries = 0
+
+      # Load configuration from _config.yml
+      plugin_config = site.config['fontello'] || { }
+      @config_file = plugin_config['config'] || 'fontello_config.json'
+      @output_fonts = plugin_config['output_fonts']|| 'fontello/fonts'
+      @output_styles = plugin_config['output_styles'] || 'fontello/styles'
+      @fonts_path = plugin_config['fonts_path'] || relative_path_styles_to_fonts
+      @preprocessor = plugin_config['preprocessor'] || 'none'
+
+      # Read the configuration
+      @fontello_config = File.read(@config_file)
+
+      # Main pipeline
+      download_zip()
+      extract_zip(site)
+      set_font_path()
+      clean_up()
+    end
+
+    # Downloads the zip file from Fontello based on
+    # the local configuration.
+    #
+    #  see: https://github.com/fontello/fontello/#api-methods
+    def download_zip()
+      url = URI("#{FONTELLO_URL}/#{session_key}/get")
+      response = Net::HTTP.get_response(url)
+
+      if response.code != '200'
+        raise 'can\'t connect to Fontello' if @download_tries == 3
+
+        # Remove the session key so a new one is requested
+        File.delete(SESSION_FILE)
+
+        # And retry download
+        @download_tries += 1
+        download_zip()
+      else
+        File.write(ZIP_FILE, response.read_body, universal_newline: true)
+      end
+    end
+
+    # Extract the zip file downloaded from Fontello.
+    def extract_zip(site)
+      Zip::File.open(ZIP_FILE) do |zipfile|
+        # Create the output directories
+        FileUtils.mkdir_p("#{@output_fonts}")
+        FileUtils.mkdir_p("#{@output_styles}")
+
+        # Extract the relevant files from the .zip
+        zipfile.each do |file|
+          filename = File.basename(file.name)
+          case File.extname file.name
+            when '.woff', '.svg', '.ttf', '.eot', '.woff2'
+              site.static_files << Jekyll::StaticFile.new(site, site.source, @output_fonts, filename)
+              file.extract("#{@output_fonts}/#{filename}")
+            when '.css'
+              case @preprocessor
+                when 'none'
+                  file.extract("#{@output_styles}/#{filename}")
+                when 'less'
+                  file.extract("#{@output_styles}/#{filename.sub('.css', '.less')}")
+                when 'scss'
+                  file.extract("#{@output_styles}/_#{filename.sub('.css', '.scss')}")
+                else
+                  raise "unknown preprocessor #{@preprocessor}, should be any of \"none\", \"less\" or \"scss\""
+              end
+          end
+        end
+      end
+    end
+
+    # Update the font paths present in the stylesheets
+    # based on the output folders/configuration.
+    def set_font_path()
+      Dir.entries(@output_styles).each do |filename|
+        next if filename =~ /^\.\.?$/
+        filepath = "#{@output_styles}/#{filename}"
+
+        text = File.read(filepath)
+        new_text = text.gsub(/..\/font/, "#{@fonts_path}")
+        File.write(filepath, new_text)
+      end
+    end
+
+    # Clean up after the Generator.
+    def clean_up()
+      File.delete(ZIP_FILE)
+    end
+
+    # Get a session key from Fontello or a session key
+    # acquired before.
+    #
+    #  see: https://github.com/fontello/fontello/#api-methods
+    def session_key
+      if File.exists? SESSION_FILE
+        return File.read(SESSION_FILE)
+      end
+
+      url = URI(FONTELLO_URL)
+      boundary = '----WebKitFormREQUEST_BOUNDARY7MA4YWxkTrZu0gW'
+
+      # Setup a http connection with Fontello
+      http = Net::HTTP.new url.host, url.port
+
+      # Construct the request to get a session key
+      request = Net::HTTP::Post.new url
+      request['Content-Type'] = "multipart/form-data; REQUEST_BOUNDARY=#{boundary}"
+      request['Content-Disposition'] = 'multipart/form-data'
+      request['Cache-Control'] = 'no-cache'
+      request.body = "--#{boundary}\r\nContent-Disposition: form-data; name=\"config\"; filename=\"#{@config_file}\"\r\nContent-Type: application/json\r\n\r\n#{@fontello_config}\r\n\r\n\r\n--#{boundary}"
+
+      # Send the request to Fontello
+      response = http.request(request)
+
+      # Store the session key for later use
+      File.write(SESSION_FILE, response.read_body)
+      return response.read_body
+    end
+
+    # Get the relative path between the fonts output
+    # folder and the styles output folder.
+    def relative_path_styles_to_fonts
+      style_path = Pathname.new(@output_styles)
+      fonts_path = Pathname.new(@output_fonts)
+      return fonts_path.relative_path_from(style_path)
+    end
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-fontello
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Eric Cornelissen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-08 00:00:00.000000000 Z
+dependencies: []
+description: Jekyll plugin that automatically downloads your webfont from Fontello.
+email: ericornelissen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE
+files:
+- LICENSE
+- README.md
+- lib/jekyll-fontello.rb
+homepage: http://rubygems.org/gems/hola
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Fontello for jekyll
+test_files: []