jekyll-gensocial 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce45a392c7a7483af49f360f0fc7b4b87abe2e554732f241007f597d2a0a56f0
+  data.tar.gz: 1e5ab8538cec2f157c62fc43d47b0138c290ee262e1d016e4908c9fb1fd854dc
+SHA512:
+  metadata.gz: 5f7def175a5c5c5cd83ee4c3266bd296d2966c5e1e83aaad5043c1ded971d35b56ffabc505d1f2ec4f580b9100817745f6dc5173b3af57c33ab0bd2dae3d55ab
+  data.tar.gz: d11c957220e7e479f9852de144cc692ed7035bd5458fd4a9fec43ceeab6c363cabd35cf24d6105270418c33b6e655d5ff41189a864666ad5b58a783ecf1d55dc

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Danger Cove
+
+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,154 @@
+# Jekyll Gensocial
+
+[![Gem Version](https://badge.fury.io/rb/jekyll-gensocial.svg)](https://badge.fury.io/rb/jekyll-gensocial)
+
+A Jekyll plugin that automatically generates images that will be used when your links are shared on social media.
+
+![An image generated by this plugin](https://raw.githubusercontent.com/boyvanamstel/jekyll-gensocial/master/screenshots/twitter.png)
+_^ Here's an example._
+
+## Installation
+
+### Dependencies
+
+First install ImageMagick (and GhostScript if you don't supply your own font):
+
+#### macOS
+
+```bash
+brew install pkg-config imagemagick [gs]
+```
+
+Add `gem "jekyll-gensocial"` to the `:jekyll_plugins` group in your `Gemfile`:
+
+```ruby
+# Gemfile
+
+group :jekyll_plugins do
+  gem "jekyll-gensocial"
+end
+```
+
+#### Linux and Windows
+
+_Haven't tried yet. If you have, please submit a PR._
+
+### Jekyll
+
+Add these lines to your site's `_config.yml`:
+
+```yml
+# _config.yml
+
+plugins:
+  - jekyll-gensocial
+```
+
+## Usage
+
+You can customize the image's background layer and text appearance from your `_config.yml`.
+
+```yaml
+# These are the default settings
+
+jekyll-gensocial:
+  enabled: true       # Disables the output
+  size:               # The size of the overall canvas
+    width: 1920
+    height: 1080
+  background:         # The background image
+    path: nil
+  text:
+    string: nil       # Overrides the post/page title
+    font_path: nil    # Path to your custom font
+    pointsize: 100    # Font size
+    fill: "#000000"   # Font color
+    rect:             # Text will appear inside this frame
+      size:
+        width: 1600
+        height: 500
+      origin:
+        x: 150
+        y: 100
+```
+
+Set the `image` front matter in the posts and pages that you want to generate images for.
+
+```yaml
+# _posts/2020-03-19-macdevsclub.md
+
+---
+layout: post
+title:  "Your #1 resource for building, distributing and selling Mac apps. Visit macdevs.club!"
+date:   2020-03-19
+categories: [swift-ui]
+image: assets/img/macdevsclub.jpg
+---
+
+The contents of your post goes here.
+```
+
+After building the site, an image will appear in `[your site's source]/assets/img/macdevsclub.jpg`.
+
+The plugin generates images in the source directory per default. This enables post-processors to minify and optimize the files if needed.
+
+### Overrides
+
+You can override the default settings on a per post/page basis.
+
+```yaml
+# _posts/2020-03-19-macdevsclub.md
+
+---
+layout: post
+title:  "Your #1 resource for building, distributing and selling Mac apps. Visit macdevs.club!"
+date:   2020-03-19
+categories: [swift-ui]
+image: assets/img/macdevsclub.jpg
+jekyll-gensocial:
+  text:
+    string: "Let's display something else"
+    fill: "#ff0000" # And make it red
+---
+
+The contents of your post goes here.
+```
+
+### Example
+
+```yaml
+# Features a background image, text fill color and custom font
+
+jekyll-gensocial:
+  background:
+    path: "_assets/img/gensocial_bg.jpg"
+  text:
+    fill: "#2d3748"
+    font_path: "_assets/fonts/Lato-Regular.ttf"
+```
+
+![The settings used by macdevs.club](https://raw.githubusercontent.com/boyvanamstel/jekyll-gensocial/master/screenshots/macdevsclub.jpg)
+
+## Purpose
+
+Used in conjuction with the [`jekyll-seo-tag`](https://github.com/jekyll/jekyll-seo-tag) plugin, this automatically improves how your links look when shared online.
+
+Instead of having to create a new image for every page and post, why not automate the process.
+
+## Development
+
+After checking out the repo, run `script/bootstrap` to install dependencies. Then, run `bundle exec rake spec` to run the tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `lib/jekyll-gensocial/version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/boyvanamstel/jekyll-gensocial. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to behave appropriately.
+
+### Stuff to work on
+
+* Expand testing to verify image output.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/jekyll-gensocial.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "jekyll-gensocial/version"
+require "jekyll-gensocial/generator"
+require "jekyll-gensocial/geometry"
+require "jekyll-gensocial/image_creator"
+
+module Jekyll
+  module Gensocial
+      DEFAULTS = { 
+        "enabled" => true,
+        "size" => {
+          "width" => 1920,
+          "height" => 1080 
+        },
+        "background" => {
+          "path" => nil
+        },
+        "text" => {
+          "string" => nil,
+          "font_path" => nil,
+          "pointsize" => 100,
+          "fill" => "#000000",
+          "rect" => {
+            "size" => {
+              "width" => 1600,
+              "height" => 500,
+            },
+            "origin" => {
+              "x" => 150,
+              "y" => 100
+            }
+          }
+        }
+      }.freeze
+  end
+end

data/lib/jekyll-gensocial/generator.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Gensocial
+    class Generator < Jekyll::Generator
+      safe true
+      priority :lowest
+
+      def generate(site)
+        config = Utils.deep_merge_hashes(Gensocial::DEFAULTS, site.config.fetch("jekyll-gensocial", {}))
+
+        return unless config["enabled"] == true
+
+        process_docs(site.pages, site: site, config: config)
+        process_docs(site.posts.docs, site: site, config: config)
+      end
+
+      private
+
+      def process_docs(docs, site:, config:)
+        docs.each do |doc|
+          doc_config = Utils.deep_merge_hashes(config, doc.data.fetch("jekyll-gensocial", {}))
+
+          image_size = Geometry::Size.new(doc_config["size"])
+          text_config = ImageCreator::TextLayerConfig.new(doc_config["text"], base_path: site.source)
+          bg_config = ImageCreator::BackgroundLayerConfig.new(doc_config["background"], base_path: site.source)
+
+          text = doc.data["title"] || text_config.string
+          image_path = doc.data["image"]
+
+          next if text.nil? || image_path.nil? 
+
+          write_image(
+            path: site.in_source_dir(image_path),
+            text: text,
+            image_size: image_size,
+            text_config: text_config,
+            bg_config: bg_config
+          )
+
+          base = site.source
+          dir = File.dirname(image_path)
+          name = File.basename(image_path)
+
+          site.static_files << Jekyll::StaticFile.new(site, base, dir, name)
+        end
+      end
+
+      def write_image(path:, text:, image_size:, text_config: , bg_config:)
+        image = get_image_creator(
+          text: text,
+          image_size: image_size,
+          bg_config: bg_config,
+          text_config: text_config
+        ).image
+
+        image.write(path)
+      end
+
+      def get_image_creator(text:, image_size:, bg_config:, text_config:)
+        image_creator = ImageCreator::Composer.new(image_size: image_size)
+        image_creator.add_bg_layer(config: bg_config)
+        image_creator.add_text_layer(text, config: text_config)
+
+        image_creator
+      end
+    end
+  end
+end

data/lib/jekyll-gensocial/geometry.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Gensocial
+    module Geometry
+      Size = Struct.new(:width, :height, keyword_init: true)
+      Point = Struct.new(:x, :y, keyword_init: true)
+
+      class Rect
+        attr_reader :size, :origin
+
+        def initialize(hash)
+          @size = Size.new(hash["size"])
+          @origin = Point.new(hash["origin"])
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-gensocial/image_creator.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative "image_creator/background_layer_config"
+require_relative "image_creator/text_layer_config"
+require_relative "image_creator/composer"
+
+module Jekyll
+  module Gensocial
+    module ImageCreator
+    end
+  end
+end

data/lib/jekyll-gensocial/image_creator/background_layer_config.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Gensocial
+    module ImageCreator
+      class BackgroundLayerConfig
+        attr_reader :path
+
+        def initialize(hash, base_path:)
+          @path = File.join(base_path, hash["path"]) unless hash["path"].nil?
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-gensocial/image_creator/composer.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'rmagick'
+include Magick
+
+module Jekyll
+  module Gensocial
+    module ImageCreator
+      class Composer
+        attr_reader :image
+
+        def initialize(image_size:)
+          @image_size = image_size
+          @image = Image.new(image_size.width, image_size.height)
+        end
+
+        def add_bg_layer(config:)
+          return if config.path.nil?
+
+          bg_layer = Image.read(config.path)
+            .first
+            .resize_to_fill(@image_size.width, @image_size.height)
+
+          @image.composite!(bg_layer, CenterGravity, OverCompositeOp)
+        end
+
+        def add_text_layer(text, config:)
+          origin = config.rect.origin
+          size = config.rect.size
+
+          text_layer = Magick::Image.read("caption:#{text}") {
+            self.fill = config.fill
+            self.font = config.font_path unless config.font_path.nil?
+            self.pointsize = config.pointsize
+            self.size = "#{size.width}x#{size.height}"
+            self.background_color = "none"
+          }.first
+
+          @image.composite!(text_layer, NorthWestGravity, origin.x, origin.y, OverCompositeOp)
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-gensocial/image_creator/text_layer_config.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Gensocial
+    module ImageCreator
+      class TextLayerConfig
+        attr_reader :string, :font_path, :pointsize, :fill, :rect
+
+        def initialize(hash, base_path:)
+          @string = hash["string"]
+          @font_path = File.join(base_path, hash["font_path"]) unless hash["font_path"].nil?
+          @pointsize = hash["pointsize"]
+          @fill = hash["fill"]
+          @rect = Geometry::Rect.new(hash["rect"])
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-gensocial/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Gensocial 
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-gensocial
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Boy van Amstel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.1.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.2
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/jekyll-gensocial.rb
+- lib/jekyll-gensocial/generator.rb
+- lib/jekyll-gensocial/geometry.rb
+- lib/jekyll-gensocial/image_creator.rb
+- lib/jekyll-gensocial/image_creator/background_layer_config.rb
+- lib/jekyll-gensocial/image_creator/composer.rb
+- lib/jekyll-gensocial/image_creator/text_layer_config.rb
+- lib/jekyll-gensocial/version.rb
+homepage: https://www.github.com/boyvanamstel/jekyll-gensocial
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://www.github.com/boyvanamstel/jekyll-gensocial
+  changelog_uri: https://www.github.com/boyvanamstel/jekyll-gensocial
+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.1.2
+signing_key: 
+specification_version: 4
+summary: A plugin for Jekyll to easily generate sharable images for your posts.
+test_files: []