jekyll-kw-shorten 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3874189518634abb2c6a33ffe63226ab96438007b688e9853163ffc1c2c8d4fc
+  data.tar.gz: 61d26e48aa0fc93b65745a52581c35d13629caa71e62dbc67abd4b0dc589cb43
+SHA512:
+  metadata.gz: 3d6d12b048d8a49e6b8e3fce09a11433f18a158ad3568dfd2c0aa1c419d18da314ea52f482ae8d2194024371a4ecbe281fde0c6695adaf4d4247626d119d013e
+  data.tar.gz: ae5cd4ec1964c8d6268751ffde40cdda8bf33433dc10e1683ada9ed4db3e77f678c7833d9297d5022902f307c7fa18105eeaf1f014b246a29c313138a52b0d72

data/README.md

@@ -0,0 +1,27 @@
+
+The project `jekyll-kw-shorten` is a **[filter](https://jekyllrb.com/docs/plugins/filters/)** plug-in for a [jekyll](https://jekyllrb.com/) static page blog.
+
+It is published on [rubygems.org](https://rubygems.org/gems/jekyll-kw-shorten), the source code is hosted on [GitHub](https://github.com/n13org/jekyll-kw-shorten).
+
+## Usage
+
+* {{ "txt" | shorten }}
+* {{ "text with spaces" | shorten }}
+* {{ 500 | shorten }}
+* {{ 777 | shorten }}
+* {{ 1000 | shorten }}
+* {{ 1200 | shorten }}
+* {{ 1450 | shorten }}
+* {{ 1777 | shorten }}
+* {{ 12345 | shorten }}
+* {{ 1000000 | shorten }}
+* {{ 1110000 | shorten }}
+* {{ 1000000000 | shorten }}
+
+## Installation
+
+## Configuration
+
+## Contribution
+
+## Test locally

data/lib/jekyll/KargWare/Shorten/configuration.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module KargWare
+    module Shorten
+      # Shorten configuration class
+      class Configuration
+        attr_accessor :shorten_gt3_digit, :shorten_gt6_digit, :shorten_gt9_digit
+
+        DEFAULT_CONFIG = {
+          'shorten_gt3_digit' => ' K',
+          'shorten_gt6_digit' => ' M',
+          'shorten_gt9_digit' => ' B'
+        }.freeze
+
+        def initialize(options)
+          options = generate_option_hash(options)
+
+          @shorten_gt3_digit = options['shorten_gt3_digit']
+          @shorten_gt6_digit = options['shorten_gt6_digit']
+          @shorten_gt9_digit = options['shorten_gt9_digit']
+        end
+
+        private
+
+        def generate_option_hash(options)
+          DEFAULT_CONFIG.merge(options)
+        rescue TypeError
+          DEFAULT_CONFIG
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/KargWare/Shorten/parser.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module KargWare
+    module Shorten
+      # jekyll-kw-shorten parser class
+      class Parser
+        attr_reader :configuration
+
+        def initialize(options = {})
+          @configuration = Configuration.new(options)
+        end
+
+        def shorten(text)
+          if text.is_a? String then
+            return text
+          else
+            num = text.to_i
+            if num >= 1000000000000 then
+              return "∞ 🚀"
+            elsif num >= 1000000000 then
+              return (num / 1000000000.0).truncate(1).to_s + @configuration.shorten_gt9_digit
+            elsif num >= 1000000 then
+              return (num / 1000000.0).truncate(1).to_s + @configuration.shorten_gt6_digit
+            elsif num >= 1000 then
+              return (num / 1000.0).truncate(1).to_s + @configuration.shorten_gt3_digit
+            else
+              return (num).truncate(1).to_s
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/jekyll/KargWare/Shorten/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module KargWare
+    module Shorten
+      RUBYGEM_NAME = 'jekyll-kw-shorten'
+      VERSION = '0.0.1'
+    end
+  end
+end

data/lib/jekyll/KargWare/shorten.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module KargWare
+    module Shorten
+      class Error < StandardError; end
+      class Exception < Gem::Exception; end
+
+      # shorten tag {% shorten input %} for Jekyll
+      class ShortenTag < Liquid::Tag
+        def initialize(tag_name, input, tokens)
+          super
+          @input = input
+        end
+
+        def render(context)
+          filter = ShortenFilter.new
+          filter.shorten(@input)
+        end
+      end
+
+      # shorten filter {{ number | shorten }} for Jekyll
+      module ShortenFilter
+        def shorten(number)
+          parser = Jekyll::KargWare::Shorten::Parser.new(get_site_config)
+          parser.shorten(number)
+        end
+
+        private
+
+        def get_site_config
+          @context.registers[:site].config['jekyll-kw-shorten'] || {}
+        end
+      end
+
+    end
+  end
+end
+
+Liquid::Template.register_tag('shorten', Jekyll::KargWare::Shorten::ShortenTag)
+Liquid::Template.register_filter(Jekyll::KargWare::Shorten::ShortenFilter)

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-kw-shorten
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nicolas Karg
+- n13.org - Open-Source by KargWare
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-27 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: "    A template project for jekyll plugins with some additional content\n"
+email:
+- rubygems.org@n13.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/jekyll/KargWare/Shorten/configuration.rb
+- lib/jekyll/KargWare/Shorten/parser.rb
+- lib/jekyll/KargWare/Shorten/version.rb
+- lib/jekyll/KargWare/shorten.rb
+homepage: https://notes.n13.org/rubygems
+licenses: []
+metadata:
+  homepage_uri: https://notes.n13.org/rubygems
+  bug_tracker_uri: https://github.com/n13org/jekyll-plugin-template/issues
+  source_code_uri: https://github.com/n13org/jekyll-plugin-template
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+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 template project for jekyll plugins.
+test_files: []