jekyll-kw-shorten 0.0.10 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68f63c1abffd9e7cadb9ce48e2b926f612b4e6ec7a40d964a9a7660631cff5fb
-  data.tar.gz: 319d0ba44d6f0ae50589ad2df7db45ca9798bab80db52a225bc29ba32318d967
+  metadata.gz: '07989180b1671628809d64a3d8b133f9e9aaf3658347c6f276a1186647164cf8'
+  data.tar.gz: b5096ec5457258fcb653150c73d2eafbededce8a9b6fe97a6f60ff33a5b08eba
 SHA512:
-  metadata.gz: a5bd7d988b75d828a50c5733e2e843e662c58c18a3dd009c61955926c53f62fe5216fbdded3642b12d2f9648dea238392665b773e5b32e6e1002b0e86d6ee91e
-  data.tar.gz: 38b05260c97dda5f6e1c531cf87e815c8890d880b1a83f3edfc36d9842121a981add98eb36ac7f57863b427a1b0f975dfba4bdca9db49cbccc0fbbc7334af69f
+  metadata.gz: 6753059fad6404643de5c976d144e35e744ff9403de382c1e36f5ae241de35488af7f09a14255ea194ab48cc826b3f178782eb5a05150f3ef60552db76a8139a
+  data.tar.gz: 3065298a4a053f45b27a44721934fbfae964faef774345ceaba6d5769239dc9beb1f5be542ad0c6ea739615d5b7d8b37cb67f7bfd15d1504be772ad3e3b54055

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 n13.org
+
+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

@@ -1,27 +1,125 @@
+# jekyll-kw-shorten
 
-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.
+![CI](https://github.com/n13org/jekyll-kw-shorten/workflows/CI/badge.svg)
+![Coverage](https://github.com/n13org/jekyll-kw-shorten/workflows/Coverage/badge.svg)
+![RuboCop](https://github.com/n13org/jekyll-kw-shorten/workflows/RuboCop/badge.svg)
+
+[![Maintainability](https://api.codeclimate.com/v1/badges/efd40b09af4719e928bb/maintainability)](https://codeclimate.com/github/n13org/jekyll-kw-shorten/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/efd40b09af4719e928bb/test_coverage)](https://codeclimate.com/github/n13org/jekyll-kw-shorten/test_coverage)
+
+[![Gem Version](https://badge.fury.io/rb/jekyll-kw-shorten.svg)](https://badge.fury.io/rb/jekyll-kw-shorten)
+
+A jekyll plugin which can shorten long numbers, e.g. 1000 ➜ 1K or 1000000 ➜ 1M.
+
+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 }}   | ✔️ | ∞ 🚀     |
+
+**HINTS**:  
+
+* 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.
+* The filter `{{ - 44 | shorten }}` will show nothing (empty string). The filter tries to parse the `-` as first part, not the number behind.
 
 ## 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,67 +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
 
-      # shorten tag {% shorten input %} for Jekyll
-      class ShortenTag < Liquid::Tag
-
-        class << self
-          def tag_name
-            name.split("::").last.downcase
-          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.to_s.strip
-
-          # raise ArgumentError, <<~MSG
-          #   Could not use '#{input}' in tag '#{self.class.tag_name}'.
-          #   Make sure it is a string or a number.
-          # MSG
         end
 
         def render(context)
-          parser = Jekyll::KargWare::Shorten::Parser.new(get_plugin_config(context))
-          # parser = Jekyll::KargWare::Shorten::Parser.new({})
+          parser = Jekyll::KargWare::Shorten::Parser.new(
+            Jekyll::KargWare::Shorten.get_plugin_config(context)
+          )
           parser.parse(@input)
         end
-
-        private
-
-        def get_plugin_config(context)
-          if defined? context.registers[:site].config
-            context.registers[:site].config[Jekyll::KargWare::Shorten::RUBYGEM_NAME] || {}
-          else
-            {}
-          end
-        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
-          if defined? @context.registers[:site].config
-            @context.registers[:site].config[Jekyll::KargWare::Shorten::RUBYGEM_NAME] || {}
-          else
-            {}
-          end
+        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,21 +17,25 @@ module Jekyll
         end
 
         def parse(text)
-          if Parser.is_number?(text) then
-            num = text.to_f
-            if num >= 1000000000000 then
-              return "∞ 🚀"
-            elsif num >= 1000000000 then
-              return format(num / 1000000000.0) + @configuration.shorten_gt9_digit
-            elsif num >= 1000000 then
-              return format(num / 1000000.0) + @configuration.shorten_gt6_digit
-            elsif num >= 1000 then
-              return format(num / 1000.0) + @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.round(0).truncate(0).to_s.rjust(5)
+              num.round(0).truncate(0).to_s.rjust(5)
             end
-          else
-            return text
+          rescue StandardError => e
+            puts e.message
+            text
           end
         end
 
@@ -38,10 +45,18 @@ module Jekyll
           num.round(1).truncate(1).to_s
         end
 
-        def self.is_number? string
-          true if Float(string) rescue false
+        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.10'
+      VERSION = '0.2.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.10
+  version: 0.2.0
 platform: ruby
 authors:
 - Nicolas Karg
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -25,24 +25,28 @@ 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 `{{ 1234 | shorten }}` and as tag `{% shorten 1234 %}`, the result will be **1.2 K**
 email:
 - rubygems.org@n13.org
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - lib/jekyll-kw-shorten.rb
 - 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:
@@ -51,7 +55,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -61,5 +65,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: []