jekyll-kw-shorten 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb2cbbc69a7c6412f1a4b27a513beb32a3f660f5277d5d5f33703c67581d5add
-  data.tar.gz: dffc3d98ce15f1c6f974bbd66ca547c18ca368ef3caebcd424a7a1a67219a6a9
+  metadata.gz: 02e501c4b564c70c2b80b73ade6532272ddfc0a8b0bcf271f0e959172fd9f551
+  data.tar.gz: 193d395096556484947539aab6658bf287e199247001620c6ea932e36d4b4f96
 SHA512:
-  metadata.gz: 4f0e2d28dac1294c1349e39c3d3b7def088a24aae1949a64ae9b418bb14deee5b948abc8ca1edf33357fd6e26fea42d5c1764c6b5ee73c144a8d1075934ca214
-  data.tar.gz: 7af4c26d2f71c4fa8566eb44fceaafe0606aac1855f8abc268c178943adb0f17f4261064c63f215f048872640852a03ff0103dbac9c5e3c05411559fb0cef931
+  metadata.gz: ab37e59c44e0fde55cafce3be02ddc6d9369131e5f76e3284fb46325d9f0f7752fcd44efb87ae8ca342825a9bbb45b8ed2f7fbae706e3e28f9f8d510fa335b1d
+  data.tar.gz: 8f955d0924134e3d446779a6183fc4b3cade744c240971212b555eeae8cc378bb9aa63d31199a4ef7c640b7045662284aa931de0f435bfbe14143859e8cc1c83

data/README.md

@@ -1,27 +1,113 @@
 
-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.
+The project `jekyll-kw-shorten` is a plug-in for a [jekyll](https://jekyllrb.com/) static page blog.
+
+It can be used as **[filter](https://jekyllrb.com/docs/plugins/filters/)** and as **[tag](https://jekyllrb.com/docs/plugins/tag/)**.
 
 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 }}
+Use the filter `{{ 1234 | shorten }}` or the tag `{% shorten 1234 %}` inside your markdown blog post file to get `1.2 K`.
+
+The plug-in supports
+
+* positiv numbers
+* negativ numbers with leading `-` or `- `.
+* float numbers (when multiple dots are in the text only the part to the first will be taken)
+* Text with no numbers inside will simply echoed
+* Text with numbers, will be reduced to just the digits 
+* Show a rocket `∞ 🚀` for very huge values (>= 1000000000000)
+* Float numbers will be rounded
+
+### Examples as Jekyll Tag
+
+| Syntax                        | OK | Result   |
+|-------------------------------|:--:|----------|
+| {% shorten "MyText" %}        | ✔️  | "MyText" |
+| {% shorten MyText %}          | ✔️  | MyText   |
+| {% shorten "My43Text" %}      | ✔️  | 43       |
+| {% shorten "My43.56Text" %}   | ✔️  | 44       |
+| {% shorten "My43.56.7Text" %} | ✔️  | 44       |
+| {% shorten "1234" %}          | ✔️  | 1.2 K    |
+| {% shorten 1 %}               | ✔️  | 1        |
+| {% shorten -22 %}             | ✔️  | -22      |
+| {% shorten - 44 %}            | ✔️  | -44      |
+| {% shorten 1000 %}            | ✔️  | 1.0 K    |
+| {% shorten 1000000 %}         | ✔️  | 1.0 M    |
+| {% shorten 1000000000 %}      | ✔️  | 1.0 B    |
+| {% shorten 1000000000000 %}   | ✔️  | ∞ 🚀     |
+
+### Examples as Jekyll Filter
+
+| Syntax                           | OK | Result   |
+|----------------------------------|:--:|----------|
+| {{ "MyText" \| shorten }}        | ✔️ | "MyText" |
+| {{ MyText \| shorten }}          | ❌ |          |
+| {{ "My43Text" \| shorten }}      | ✔️ | 43       |
+| {{ "My43.56Text" \| shorten }}   | ✔️ | 44       |
+| {{ "My43.56.7Text" \| shorten }} | ✔️ | 44       |
+| {{ "1234" \| shorten }}          | ✔️ | 1.2 K    |
+| {{ 1 \| shorten }}               | ✔️ | 1        |
+| {{ -22 \| shorten }}             | ✔️ | -22      |
+| {{ - 44 \| shorten }}            | ❌ |          |
+| {{ 1000 \| shorten }}            | ✔️ | 1.0 K    |
+| {{ 1000000 \| shorten }}         | ✔️ | 1.0 M    |
+| {{ 1000000000 \| shorten }}      | ✔️ | 1.0 B    |
+| {{ 1000000000000 \| shorten }}   | ✔️ | ∞ 🚀     |
+
+**HINT**:
+The filter `{{ MyText | shorten }}` will show nothing (empty string). The filter "thinks" the MyText is a variable (with the value nil). Numbers can be used with and without quotes. Text must be wrapped in quotes.
 
 ## Installation
 
+Add `jekyll-kw-shorten` plugin in your Gemfile inside the `jekyll_plugins` group.
+
+```ruby
+group :jekyll_plugins do
+  ...
+  gem "jekyll-kw-shorten"
+  ...
+end
+```
+
+Run `bundle install` to install the gem and update the Gemfile.lock.
+
+Add `jekyll-kw-shorten` to the plugins section in your site's `_config.yml`. Then [configure](#configuration) your plug-in.
+
+```yaml
+plugins:
+  - jekyll-kw-shorten
+```
+
 ## Configuration
 
-## Contribution
+Add the setting to your `_config.yml` file. Details you can find in the [documentation](https://jekyllrb.com/docs/configuration/). The name of the group is `jekyll-kw-shorten`.
+
+* **shorten_gt3_digit** will be used for numbers between 1000 and 999999. Default is `' K'`.
+* **shorten_gt6_digit** will be used for numbers between 1000000 and 999999999. Default is `' M'`.
+* **shorten_gt9_digit** will be used for numbers between 1000000000 and 999999999999. Default is `' B'`.
+
+```yaml
+...
+jekyll-kw-shorten:
+  shorten_gt3_digit: ' K'
+  shorten_gt6_digit: ' M'
+  shorten_gt9_digit: ' B'
+...
+```
+
+When the config values are omit then the default values are used. 
 
 ## Test locally
+
+Run linting
+
+```shell
+bundle exec rubocop
+```
+
+Run tests
+
+```shell
+bundle exec rake test
+```

data/lib/jekyll-kw-shorten.rb

@@ -5,46 +5,46 @@ require 'jekyll/KargWare/Shorten/version'
 
 module Jekyll
   module KargWare
+    # jekyll-kw-shorten jekyll (tag and filter) class
     module Shorten
       class Error < StandardError; end
       class Exception < Gem::Exception; end
 
+      module_function def get_plugin_config(context)
+        if defined? context.registers[:site].config
+          context.registers[:site].config[Jekyll::KargWare::Shorten::RUBYGEM_NAME] || {}
+        else
+          {}
+        end
+      end
+
       # shorten tag {% shorten input %} for Jekyll
       class ShortenTag < Liquid::Tag
         def initialize(tag_name, input, tokens)
           super
-          @input = input
+          @input = input.to_s.strip
         end
 
         def render(context)
-          parser = Jekyll::KargWare::Shorten::Parser.new(get_plugin_config(context))
+          parser = Jekyll::KargWare::Shorten::Parser.new(
+            Jekyll::KargWare::Shorten.get_plugin_config(context)
+          )
           parser.parse(@input)
         end
-
-        private
-
-        def get_plugin_config(context)
-          context.registers[:site].config[Jekyll::KargWare::Shorten::RUBYGEM_NAME] || {}
-        end
       end
 
       # shorten filter {{ number | shorten }} for Jekyll
       module ShortenFilter
-        def shorten(number)
-          parser = Jekyll::KargWare::Shorten::Parser.new(get_plugin_config)
-          parser.parse(number)
-        end
-
-        private
-
-        def get_plugin_config
-          @context.registers[:site].config[Jekyll::KargWare::Shorten::RUBYGEM_NAME] || {}
+        def shorten(input)
+          parser = Jekyll::KargWare::Shorten::Parser.new(
+            Jekyll::KargWare::Shorten.get_plugin_config(@context)
+          )
+          parser.parse(input)
         end
       end
-
     end
   end
 end
 
 Liquid::Template.register_tag('shorten', Jekyll::KargWare::Shorten::ShortenTag)
-Liquid::Template.register_filter(Jekyll::KargWare::Shorten::ShortenFilter)
+Liquid::Template.register_filter(Jekyll::KargWare::Shorten::ShortenFilter)

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

@@ -21,9 +21,7 @@ module Jekyll
           @shorten_gt9_digit = options['shorten_gt9_digit']
         end
 
-        private
-
-        def generate_option_hash(options)
+        private def generate_option_hash(options)
           DEFAULT_CONFIG.merge(options)
         rescue TypeError
           DEFAULT_CONFIG

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

@@ -7,6 +7,9 @@ module Jekyll
     module Shorten
       # jekyll-kw-shorten parser class
       class Parser
+        # https://stackoverflow.com/questions/33952093/how-to-allow-only-one-dot-in-regex
+        DIGITS_AND_SINGLE_DOT_ESCAPE_REGEXP = /(-?\s?[0-9]+(\.[0-9]+)?)/.freeze
+
         attr_reader :configuration
 
         def initialize(options = {})
@@ -14,24 +17,46 @@ module Jekyll
         end
 
         def parse(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
+          num = Parser.only_float_numbers(text)
+
+          return text unless Parser.number?(num)
+
+          begin
+            if num >= 1000000000000
+              '∞ 🚀'
+            elsif num >= 1000000000
+              format(num / 1000000000.0) + @configuration.shorten_gt9_digit
+            elsif num >= 1000000
+              format(num / 1000000.0) + @configuration.shorten_gt6_digit
+            elsif num >= 1000
+              format(num / 1000.0) + @configuration.shorten_gt3_digit
             else
-              return (num).truncate(1).to_s
+              num.round(0).truncate(0).to_s.rjust(5)
             end
+          rescue StandardError => e
+            puts e.message
+            text
           end
         end
 
+        # private
+
+        def format(num)
+          num.round(1).truncate(1).to_s
+        end
+
+        def self.number?(string)
+          true if Float(string)
+          # true if Float(Parser.only_float_numbers(string))
+        rescue StandardError
+          false
+        end
+
+        def self.only_float_numbers(input)
+          input.to_s.scan(DIGITS_AND_SINGLE_DOT_ESCAPE_REGEXP).first.first.to_f
+        rescue StandardError
+          input
+        end
       end
     end
   end

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

@@ -4,7 +4,7 @@ module Jekyll
   module KargWare
     module Shorten
       RUBYGEM_NAME = 'jekyll-kw-shorten'
-      VERSION = '0.0.8'
+      VERSION = '0.1.0'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-kw-shorten
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Nicolas Karg
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-27 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -25,7 +25,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.8'
-description: "    A template project for jekyll plugins with some additional content\n"
+description: |2
+      A jekyll plugin which can shorten long numbers, e.g. 1000 == 1K or 1000000 == 1M.
+
+      It can be used as [filter](https://jekyllrb.com/docs/plugins/filters/) `{{ 1234 | shorten }}` and as [tag](https://jekyllrb.com/docs/plugins/tags/) `{% shorten 1234 %}`, the result will be **1.2 K**
 email:
 - rubygems.org@n13.org
 executables: []
@@ -37,12 +40,12 @@ files:
 - lib/jekyll/KargWare/Shorten/configuration.rb
 - lib/jekyll/KargWare/Shorten/parser.rb
 - lib/jekyll/KargWare/Shorten/version.rb
-homepage: https://notes.n13.org/rubygems
+homepage: https://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
+  homepage_uri: https://n13.org/rubygems
+  bug_tracker_uri: https://github.com/n13org/jekyll-kw-shorten/issues
+  source_code_uri: https://github.com/n13org/jekyll-kw-shorten
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -61,5 +64,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: A template project for jekyll plugins.
+summary: A jekyll plugin to shorten long numbers
 test_files: []