jekyll-share-plugin 1.0.0

data/README.md

@@ -0,0 +1,135 @@
+# Jekyll-Share
+
+This is a Jekyll plugin that provides the Liquid tags to render the sharing services links through the
+[ShareWith][share_with] gem.
+
+Using the config section, or defining variables from within the layout template, the target fields can
+be customized entirely.
+
+[![Ruby](https://github.com/fabiomux/jekyll-share-plugin/actions/workflows/main.yml/badge.svg)][wf_main]
+[![Gem Version](https://badge.fury.io/rb/jekyll-share-plugin.svg)][gem_version]
+
+
+## Installation
+
+Can install the gem either manually or using *Bundler*.
+
+### Using Bundler
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add jekyll-share-plugin --group jekyll_plugins
+
+### Manually
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install jekyll-share-plugin
+
+Then, add the following code within the Gemfile of your Jekyll project:
+
+    ```ruby
+    group :jekyll_plugins do
+      ...
+      gem 'jekyll-share-plugin'
+    end
+    ```
+
+## Configuration
+
+Inside the `_config.yml` file, set up some or all of the following fields under the `jekyll-share`
+section:
+
+    ```yaml
+    jekyll-share:
+      paths:
+      - $HOME/.jekyll-share/services
+      mappings:
+        twitter:hashtags: '@tags'
+        email:subject: '@title'
+        # These variables below must be setup in your layout file
+        twitter:related: '@related'
+        linkedin:summary: '@summary'
+        pinterest:media_url: '@media_url'
+        email:body: '@str_body'
+      post_selector: include.post
+      groups:
+        default:
+          wrappers:
+            service_start: '<li class="list-inline-item">'
+            service_end: '</li>'
+            group_start: '<ul class="list-inline">'
+            group_end: '</ul>'
+          extend_with:
+          - icons.font_awesome
+          icon_size: 'medium'
+          template: 'icon'
+          services:
+          - twitter
+          - facebook
+          - linkedin
+          - reddit
+          - tumblr
+          - telegram
+          - flipboard
+          - pocket
+          - pinterest
+    ```
+
+*paths*
+: It is the path where other services can be found
+
+*mappings*
+: Associate the not standard params with the variables within the layout or include template, or as a field
+  part of the front matter in the current document.
+
+*post_selector*
+: This is how the script will read the post data inside a paginator layout.
+
+*groups*
+: Define the groups of services to render, every group can specify other parameters:
+
+  *wrappers*
+  : Defines the HTML tags that wrap the group of links or the single link.
+
+  *extend_with*
+  : This implementes the extensions provided by *share_with* gem.
+
+  *icon_size*
+  : The size of the icons among the ones defined by *share_with*.
+
+  *template*
+  : The default template to use among the ones defined by *share_with*.
+
+  *services*
+  : The list of services included in the group.
+
+## Usage
+
+Jekyll-Share provides two Liquid tags that can be used to render the service links:
+
+**share_single**
+: Recall the single service to render.
+  ```liquid
+  {% share_single name='email' %}
+  ```
+
+**share_group**
+: Recall the group of services as specified in the `.config.yml` file.
+  ```liquid
+  {% share_group name='default' icon_size=icon_size %}
+  ```
+
+## More Help
+
+More info is available at:
+- the [project page on the Freeaptitude blog][project_page];
+- the [Jekyll-Share Github wiki][jekyll_share_wiki];
+- the [ShareWith Github wiki][share_with_wiki].
+
+[share_with]: https://github.com/fabiomux/share_with "ShareWith project page on GitHub"
+[share_with_wiki]: https://github.com/fabiomux/share_with/wiki "ShareWith wiki page on GitHub"
+[wf_main]: https://github.com/fabiomux/jekyll-share-plugin/actions/workflows/main.yml
+[gem_version]: https://badge.fury.io/rb/jekyll-share-plugin
+[project_page]: https://freeaptitude.altervista.org/projects/jekyll-share.html "Project page on the Freeaptitude blog"
+[jekyll_share_wiki]: https://github.com/fabiomux/jekyll-share-plugin/wiki "Jekyll-Share wiki page on GitHub"

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/jekyll-share-plugin.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll/share/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "jekyll-share-plugin"
+  spec.version = Jekyll::Share::VERSION
+  spec.authors = ["Fabio Mucciante"]
+  spec.email = ["fabio.mucciante@gmail.com"]
+
+  spec.summary = "Jekyll plugin that renders the sharing links from known services."
+  spec.description = "It provides links from Facebook, Linkedin, Reddit, Telegram, Twitter, and more..."
+  spec.homepage = "https://freeaptitude.altervista.org/projects/jekyll-share.html"
+
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fabiomux/jekyll-share-plugin"
+  spec.metadata["changelog_uri"] = "https://freeaptitude.altervista.org/projects/jekyll-share.html#changelog"
+  spec.metadata["wiki_uri"] = "https://github.com/fabiomux/jekyll-share-plugin/wiki"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "jekyll", ">= 3.7", "< 5.0"
+  spec.add_dependency "share_with"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/jekyll/share/config.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Share
+    #
+    # Configurations required across the gem.
+    #
+    class Config
+      def self.gconfig
+        @@gconfig ||= Jekyll.configuration.freeze
+      end
+
+      def self.base_url
+        @@base_url ||= gconfig["base_url"].freeze
+      end
+
+      def self.url
+        @@url ||= gconfig["url"].freeze
+      end
+
+      def self.source
+        @@source ||= gconfig["source"].freeze
+      end
+
+      def self.config
+        @@config ||= gconfig["jekyll-share"].freeze
+      end
+
+      def self.groups
+        @@groups ||= (config["groups"] || []).freeze
+      end
+
+      def self.group(name)
+        raise InvalidGroup unless groups.key? name
+
+        groups[name]
+      end
+
+      def self.mappings
+        @@mappings ||= (config["mappings"] || []).freeze
+      end
+
+      def self.post_selector
+        @@post_selector ||= (config["post_selector"] || "include.post").freeze
+      end
+
+      def self.paths
+        @@paths ||= (config["paths"] || ["~/.jekyll-share/services"]).freeze
+      end
+    end
+
+    #
+    # Group configurations.
+    #
+    class GroupConfig
+      attr_reader :config
+
+      def initialize(name)
+        raise InvalidGroup unless Config.groups.key? name
+
+        @name = name
+        @config = Config.groups[name]
+      end
+
+      def template
+        @config["template"] || "icon"
+      end
+
+      def wrappers
+        @config["wrappers"] || { "group_start" => "", "group_end" => "",
+                                 "service_start" => "", "service_end" => "" }
+      end
+
+      def extend_with
+        @config["extend_with"] || []
+      end
+
+      def services
+        @config["services"] || []
+      end
+
+      def icon_size
+        @config["icon_size"] || "large"
+      end
+    end
+  end
+end

data/lib/jekyll/share/helper.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Share
+    #
+    # Contains the methods to calculate the Disqus ID associated to
+    # a post or a page.
+    #
+    module Helper
+      def preview?(context)
+        return true if context["#{Config.post_selector}.title"]
+      end
+
+      def extract_page_data(context)
+        extract_data "page", context
+      end
+
+      def extract_preview_data(context)
+        extract_data Config.post_selector, context
+      end
+
+      private
+
+      # rubocop:disable Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def extract_data(selector, context)
+        res = {}
+        res["title"] = context["#{selector}.title"]
+        res["url"] = context["site.url"].to_s +
+                     context["site.base_dir"].to_s +
+                     context["#{selector}.url"]
+        res["tags"] = context["#{selector}.tags"]
+        res["categories"] = context["#{selector}.categories"]
+
+        if res["tags"].instance_of? String
+          res["tags"] = res["tags"].split.join(",")
+        elsif res["tags"].instance_of? Array
+          res["tags"] = res["tags"].join(",")
+        end
+
+        if res["categories"].instance_of? String
+          res["categories"] = res["categories"].split.join(",")
+        elsif res["tags"].instance_of? Array
+          res["categories"] = res["categories"].join(",")
+        end
+
+        Config.mappings.each do |k, v|
+          res[k] = if v[0] == "@"
+                     param = v.delete("@")
+                     if res.key?(param)
+                       res[param]
+                     else
+                       context.key?(param) ? context[param] : context["#{selector}.#{param}"]
+                     end
+                   else
+                     v
+                   end
+        end
+
+        res
+      end
+      # rubocop:enable Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity
+    end
+  end
+end

data/lib/jekyll/share/tags.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "share_with"
+
+module Jekyll
+  module Share
+    #
+    # Single service rendering.
+    #
+    class Single < Liquid::Tag
+      include Helper
+
+      def initialize(tag_name, text, tokens)
+        super
+        @@share_single ||= {}
+        @text = text
+      end
+
+      def render(context)
+        @params = init_params(@text, context)
+        if @@share_single.key? @name
+          @@share_single[@name].reset!
+        else
+          @@share_single[@name] = ShareWith::Service.new @name,
+                                                         extend_with: @extend_with,
+                                                         paths: Config.paths
+        end
+
+        @params = if preview?(context)
+                    extract_preview_data(context).merge @params
+                  else
+                    extract_page_data(context).merge @params
+                  end
+
+        @params.each do |key, value|
+          @@share_single[@name].set_conditional_param(key, value)
+        end
+
+        @@share_single[@name].render(@template)
+      end
+
+      private
+
+      def init_params(text, context)
+        params = text.split_params(context)
+        @name = params["name"]
+        params.delete("name")
+        raise MissingService if @name.nil? || @name.empty?
+
+        @template = params["template"] || "icon"
+        params.delete("template")
+        @extend_with = params["extend_with"]
+        params.delete("extend_with")
+
+        params
+      end
+    end
+
+    #
+    # Group of services.
+    #
+    class Group < Liquid::Tag
+      include Helper
+
+      def initialize(tag_name, text, tokens)
+        super
+        @@share_groups ||= {}
+        @text = text
+      end
+
+      def render(context)
+        @params = init_params(@text, context)
+        if @@share_groups.key? @name
+          @@share_groups[@name].reset_all!
+        else
+          @@share_groups[@name] = ShareWith::Collection.new extend_with: @extend_with,
+                                                            services: @services,
+                                                            paths: Config.paths
+        end
+
+        @params = if preview?(context)
+                    @params.merge extract_preview_data(context)
+                  else
+                    @params.merge extract_page_data(context)
+                  end
+
+        @params.each do |key, value|
+          @@share_groups[@name].set_conditional_param(key, value)
+        end
+
+        res = [@wrappers["group_start"].to_s]
+        @@share_groups[@name].render_all(@template).each do |_k, v|
+          res << "#{@wrappers["service_start"]}#{v}#{@wrappers["service_end"]}"
+        end
+        res << @wrappers["group_end"].to_s
+
+        res.join("\n")
+      end
+
+      private
+
+      def init_params(text, context)
+        params = text.split_params(context)
+        @name = params["name"] || "default"
+        params.delete("name")
+
+        gcfg = GroupConfig.new(@name)
+        @template = params["template"] || gcfg.template
+        params.delete("template")
+        @wrappers = gcfg.wrappers
+
+        @extend_with = gcfg.extend_with
+        @services = gcfg.services
+
+        params["icon_size"] ||= gcfg.icon_size
+
+        params
+      end
+    end
+  end
+end

data/lib/jekyll/share/utils.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Share
+    #
+    # Convert the params to hash
+    #
+    class ::String
+      def split_params(context)
+        scan(/(\w+)=(?:(["'])(.+?)\2|([^ ]+))/)
+          .to_h do |x|
+            x[3] = context[x[3]] if x[1].nil?
+            x.delete_at 1
+            x.compact
+          end
+      end
+    end
+
+    #
+    # Invalid group name error
+    #
+    class InvalidGroup < StandardError
+      def initialize(name)
+        super "The group '#{name}' is not valid!"
+      end
+    end
+
+    #
+    # No service name has been specified.
+    #
+    class MissingService < StandardError
+      def initialize
+        super "No service name has been specified!"
+      end
+    end
+  end
+end

data/lib/jekyll/share/version.rb

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

data/lib/jekyll/share.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "jekyll"
+
+require_relative "share/config"
+require_relative "share/helper"
+require_relative "share/tags"
+require_relative "share/utils"
+
+Liquid::Template.register_tag("share_single", Jekyll::Share::Single)
+Liquid::Template.register_tag("share_group", Jekyll::Share::Group)

data/lib/jekyll-share-plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "jekyll/share"

data/sig/jekyll/share/plugin.rbs

@@ -0,0 +1,8 @@
+module Jekyll
+  module Share
+    module Plugin
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-share-plugin
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Fabio Mucciante
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: share_with
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: It provides links from Facebook, Linkedin, Reddit, Telegram, Twitter,
+  and more...
+email:
+- fabio.mucciante@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- jekyll-share-plugin.gemspec
+- lib/jekyll-share-plugin.rb
+- lib/jekyll/share.rb
+- lib/jekyll/share/config.rb
+- lib/jekyll/share/helper.rb
+- lib/jekyll/share/tags.rb
+- lib/jekyll/share/utils.rb
+- lib/jekyll/share/version.rb
+- sig/jekyll/share/plugin.rbs
+homepage: https://freeaptitude.altervista.org/projects/jekyll-share.html
+licenses: []
+metadata:
+  homepage_uri: https://freeaptitude.altervista.org/projects/jekyll-share.html
+  source_code_uri: https://github.com/fabiomux/jekyll-share-plugin
+  changelog_uri: https://freeaptitude.altervista.org/projects/jekyll-share.html#changelog
+  wiki_uri: https://github.com/fabiomux/jekyll-share-plugin/wiki
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.3
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin that renders the sharing links from known services.
+test_files: []