jekyll_social_icons 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f18f0a984c728f8d55d4d4f74e83210cd610be1
+  data.tar.gz: 40d1a1f13680f65dcf636575d627af62fcc5a35e
+SHA512:
+  metadata.gz: aba3100f72c87f849ef6adc8ee7a2de7dfdd16e0e88238b4aa74b7113171afe3c9e2d6101b3415b889f038e4f5856336694a29972ef33b86e81dba849871c45c
+  data.tar.gz: 5cb7ab44fcac2288c609a4a29f21ea1ae2a1028a850547d7b9eab973ea78850a3b3ab590141cc2a4761be73544d544061cd7058d70ea2ebef709533db57e3fd8

data/.gitignore

@@ -0,0 +1,11 @@
+.DS_Store
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jekyll_social_icons.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Unai Abrisketa
+
+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,98 @@
+# Jekyll Social Icons
+
+[![Gem](https://img.shields.io/gem/v/jekyll_social_icons.svg)](https://rubygems.org/gems/jekyll_social_icons)
+
+__Jekyll Social Icons__ plugin allows you rendering your social networks on your [Jekyll](https://jekyllrb.com/) project.
+
+## 1. Installation
+
+1. Add the following to your site's `Gemfile`:
+
+```ruby
+gem 'jekyll_social_icons'
+```
+
+2. Add the following to your site's `_config.yml`:
+
+```yaml
+gems:
+  - jekyll_social_icons
+```
+
+3. Run `bundle install` in your command line:
+
+```bash
+$ bundle install
+```
+
+## 2. Usage
+
+### 2.1. Configuration
+
+Add your social networks URLs to the `_config.yml` file:
+
+```yaml
+socials:
+  twitter: https://twitter.com/unabris
+  github: https://github.com/unabris
+```
+
+Here is a full list of all the __available social networks__: `facebook`, `twitter`, `google-plus`, `instagram`, `linkedin`, `youtube`, `github` and `rss`.
+
+### 2.2. Rendering
+
+Use `{% social_icons %}` Jekyll Tag to render all your configured social networks with the default styling. For example, the configuration above will render this html content:
+
+```html
+<div class="social-container" id="" style="">
+  <div class="social" style="">
+    <a href="https://twitter.com/unabris" target="_blank">
+      <i class="fa fa-fw fa-twitter" style=""></i>
+    </a>
+  </div>
+  <div class="social" style="">
+    <a href="https://github.com/unabris" target="_blank">
+      <i class="fa fa-fw fa-github" style=""></i>
+    </a>
+  </div>
+</div>
+```
+
+You can also specify the social networks you want to render adding them to the Jekyll Tag this way:
+
+```html
+{% social_icons twitter github %}
+```
+
+### 2.3. Styling
+
+There are so many attributes you can use to customize the style of your social networks icons. To use them, just add the attribute and the value you want to the `social_icons` Jekyll Tag this way:
+
+```html
+{% social_icons twitter github id="footer-icons" width="30px" height="30px" radius="100%" %}
+```
+
+Here is a full list of all the available attributes with their default values:
+
+| Option   | Description                                                                                                                    |  Default |
+|:--------:|--------------------------------------------------------------------------------------------------------------------------------|:--------:|
+| `id`     | One or more ids separated by a space. This ids are going to be added at the same level than the main `social-container` class. |     -    |
+| `class`  | One or more classes separated by a space. This classes are going to be added to the main `social-container` class.             |     -    |
+| `width`  | The `width` of the social networks icons.                                                                                      |  `50px`  |
+| `height` | The `height` of the social networks icons.                                                                                     |  `50px`  |
+| `align`  | One of `left`, `center` or `right`.                                                                                            | `center` |
+| `margin` | The margin between the different social icons you want to render.                                                              |  `10px`  |
+| `radius` | The border radius of the social icons. Put `100%` if you want circle icons.                                                    |    `0`   |
+| `size`   | The size of the social networks brand image.                                                                                   |  `30px`  |
+
+## 3. Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## 4. License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/jekyll_social_icons.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jekyll_social_icons/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll_social_icons'
+  spec.version       = JekyllSocialIcons::VERSION
+  spec.authors       = ['Unai Abrisketa']
+  spec.email         = ['unai.abrisqueta@gmail.com']
+
+  spec.summary       = %q{Jekyll plugin to render your social networks icons}
+  spec.homepage      = 'https://github.com/unabris/jekyll_social_icons'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

data/lib/jekyll_social_icons.rb

@@ -0,0 +1,3 @@
+require 'jekyll_social_icons/social_icons_styles'
+require 'jekyll_social_icons/social_icons_tag'
+require 'jekyll_social_icons/option_parser'

data/lib/jekyll_social_icons/icons.json

@@ -0,0 +1,10 @@
+{
+  "facebook": "facebook",
+  "twitter": "twitter",
+  "google-plus": "google-plus",
+  "instagram": "instagram",
+  "linkedin": "linkedin",
+  "youtube": "youtube-play",
+  "github": "github",
+  "rss": "rss"
+}

data/lib/jekyll_social_icons/option_parser.rb

@@ -0,0 +1,36 @@
+module Jekyll
+  class OptionParser
+    icons_json = JSON.parse(IO.readlines(File.expand_path('icons.json', File.dirname(__FILE__))).join)
+    available_socials = icons_json.keys
+
+    OPTIONS_SYNTAX     = %r!([^\s]+)\s*=\s*['"]+([^'"]+)['"]+!
+    ALLOWED_SOCIALS    = available_socials.freeze
+    ALLOWED_ATTRIBUTES = %w(
+      id
+      class
+      width
+      height
+      align
+      margin
+      radius
+      size
+    ).freeze
+
+    class << self
+      def parse(raw_options)
+        options = {
+          attributes: {}
+        }
+        raw_options.scan(OPTIONS_SYNTAX).each do |key, value|
+          if ALLOWED_ATTRIBUTES.include?(key)
+            options[:attributes][key.to_sym] = value
+          end
+          if key.to_sym == :socials
+            options[:socials] = value.split(' ').select { |k, v| ALLOWED_SOCIALS.include?(k) }
+          end
+        end
+        options
+      end
+    end
+  end
+end

data/lib/jekyll_social_icons/social_icons.css

@@ -0,0 +1,69 @@
+.social-container {
+  display: flex;
+}
+.social-container .social {
+  width: 50px;
+  height: 50px;
+}
+.social-container .social:last-child {
+margin-right: 0 !important;
+}
+.social-container .social a {
+  width: 100%;
+  height: 100%;
+  display: flex;
+  justify-content: center;
+  align-items: center;
+  cursor: pointer;
+}
+.social-container .social a i.fa {
+  color: #fff;
+}
+.social-container .social.facebook {
+  background-color: #4460a1;
+}
+.social-container .social.twitter {
+  background-color: #01aaed;
+}
+.social-container .social.google-plus {
+  background-color: #f9402e;
+}
+.social-container .social.instagram {
+  background-color: #275a85;
+}
+.social-container .social.linkedin {
+  background-color: #007ebb;
+}
+.social-container .social.youtube {
+  background-color: #cf1312;
+}
+.social-container .social.github {
+  background-color: #000000;
+}
+.social-container .social.rss {
+  background-color: #ff9a00;
+}
+.social-container .social.facebook:hover {
+  background-color: #3f5995;
+}
+.social-container .social.twitter:hover {
+  background-color: #019edc;
+}
+.social-container .social.google-plus:hover {
+  background-color: #dd1906;
+}
+.social-container .social.instagram:hover {
+  background-color: #235178;
+}
+.social-container .social.linkedin:hover {
+  background-color: #0073aa;
+}
+.social-container .social.youtube:hover {
+  background-color: #bf1211;
+}
+.social-container .social.github:hover {
+  background-color: #000000;
+}
+.social-container .social.rss:hover {
+  background-color: #ee9000;
+}

data/lib/jekyll_social_icons/social_icons_styles.rb

@@ -0,0 +1,34 @@
+module Jekyll
+  class SocialIconsStyles
+    HEAD_END_TAG = %r!</.*head>!
+
+    class << self
+      def add_styles(doc)
+        @config = doc.site.config
+        if doc.output =~ HEAD_END_TAG
+          doc.output.gsub!(HEAD_END_TAG, %(#{header_styles}#{Regexp.last_match}))
+        else
+          doc.output.prepend(header_styles)
+        end
+      end
+
+      private
+
+      def header_styles
+"""<link rel='stylesheet' href='//maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css'>
+<style>
+#{style_document}
+</style>"""
+      end
+
+      def style_document
+        style_path = File.join(File.dirname(__FILE__), 'social_icons.css')
+        File.open(style_path).read
+      end
+    end
+  end
+end
+
+Jekyll::Hooks.register [:pages, :documents], :post_render do |doc|
+  Jekyll::SocialIconsStyles.add_styles(doc)
+end

data/lib/jekyll_social_icons/social_icons_tag.rb

@@ -0,0 +1,84 @@
+module Jekyll
+  class SocialIcons < Liquid::Tag
+    DEFAULT_WIDTH     = '50px'
+    DEFAULT_HEIGHT    = '50px'
+    DEFAULT_MARGIN    = '10px'
+    DEFAULT_RADIUS    = '0'
+    DEFAULT_FONT_SIZE = '30px'
+
+    def initialize(_, args, _)
+      super
+      @args = OptionParser.parse(args)
+    end
+
+    def render(context)
+      site = context.registers[:site]
+      config_socials = site.config['socials']
+
+      if @args[:socials].nil?
+        socials = config_socials
+      else
+        socials = config_socials.select { |k, v| @args[:socials].include?(k) }
+      end
+
+      icons_json = JSON.parse(IO.readlines(File.expand_path('icons.json', File.dirname(__FILE__))).join)
+
+      data = "<div class='social-container #{attr_class}' id='#{attr_id}' style='#{align}'>"
+      socials.each do |social, url|
+        data += "<div class='social #{social}' style='#{icons_size}#{margin}#{radius}'>
+                 <a href='#{url}' target='_blank'>
+                 <i class='fa fa-fw fa-#{icons_json[social]}' style='#{font_size}'></i>
+                 </a></div>"
+      end
+      data += '</div>'
+
+      data
+    end
+
+    private
+
+    def attr_id
+      @args[:attributes][:id]
+    end
+
+    def attr_class
+      @args[:attributes][:class]
+    end
+
+    def align
+      case @args[:attributes][:align]
+      when 'left'
+        'justify-content: flex-start;'
+      when 'center'
+        'justify-content: center;'
+      when 'right'
+        'justify-content: flex-end;'
+      else
+        'justify-content: center;'
+      end
+    end
+
+    def icons_size
+      width  = @args[:attributes][:width] || DEFAULT_WIDTH
+      height = @args[:attributes][:height] || DEFAULT_HEIGHT
+      "width:#{width};height:#{height};"
+    end
+
+    def margin
+      margin = @args[:attributes][:margin] || DEFAULT_MARGIN
+      "margin-right:#{margin};"
+    end
+
+    def radius
+      radius = @args[:attributes][:radius] || DEFAULT_RADIUS
+      "border-radius:#{radius};"
+    end
+
+    def size
+      size = @args[:attributes][:size] || DEFAULT_FONT_SIZE
+      "font-size:#{size};"
+    end
+  end
+end
+
+Liquid::Template.register_tag('social_icons', Jekyll::SocialIcons)

data/lib/jekyll_social_icons/version.rb

@@ -0,0 +1,3 @@
+module JekyllSocialIcons
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_social_icons
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Unai Abrisketa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-05-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- unai.abrisqueta@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_social_icons.gemspec
+- lib/jekyll_social_icons.rb
+- lib/jekyll_social_icons/icons.json
+- lib/jekyll_social_icons/option_parser.rb
+- lib/jekyll_social_icons/social_icons.css
+- lib/jekyll_social_icons/social_icons_styles.rb
+- lib/jekyll_social_icons/social_icons_tag.rb
+- lib/jekyll_social_icons/version.rb
+homepage: https://github.com/unabris/jekyll_social_icons
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin to render your social networks icons
+test_files: []