jekyll-kw-loremipsum 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8a4bd65e8a7b80c8fa8aa94224dc80433fd94958c12293d27928f4fa1526a11d
+  data.tar.gz: bbb2a32ffafb07df5ae3a33c8292c6929f6855d47406f777179512f181a8eeba
+SHA512:
+  metadata.gz: f3bc8b8a6f859fdb651d377159043667e98dc503732a814b10572809f861da7e5a7069be0a672cfe869ced4f1aa4b28aebaa4fdb224d52cb6c7d3383f4a6063d
+  data.tar.gz: 293c028d0fda76ff4674d6b5ef031f83bcf7c2e553c7557c61341f3730524bba30f429cb293c3669c6be1b2727c888deef7b32556a120d67f85468a82a656614

data/README.md

@@ -0,0 +1,86 @@
+# jekyll-kw-loremipsum
+
+![CI](https://github.com/n13org/jekyll-kw-loremipsum/workflows/CI/badge.svg)
+![Coverage](https://github.com/n13org/jekyll-kw-loremipsum/workflows/Coverage/badge.svg)
+![RuboCop](https://github.com/n13org/jekyll-kw-loremipsum/workflows/RuboCop/badge.svg)
+
+[![Gem Version](https://badge.fury.io/rb/jekyll-kw-loremipsum.svg)](https://badge.fury.io/rb/jekyll-kw-loremipsum)
+
+LoremIpsum is a [jekyll][Jekyll Website] plugin. The plugin can be used as a **tag** for jekyll. You can get some dummy text for your webpage, without copy & pasting the Lorem Ipsum words yourself.
+
+- Use the tag `{% kw_lorem_ipsum 30w %}` to get 30 different words.
+- Use the tag `{% kw_lorem_ipsum random 4p 7miw 12maw %}` to get 4 paragraphs between 7 and 12 words.
+
+## 🚀 Installation
+
+Add this section to your application's `Gemfile` inside the `jekyll_plugins` and execute `bundle install`
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll-kw-loremipsum'
+end
+```
+
+Or install the dependency with `bundle` itself, you can use the option `--skip-install`, when `bundle install` will be called later
+
+```sh
+bundle add jekyll-kw-loremipsum --group jekyll_plugins 
+```
+
+Then add the following to your site's `_config.yml` to activate the plugin, see also the [Configuration](#%EF%B8%8F-configuration) section to change the default configuration. 
+
+```yaml
+plugins:
+  - jekyll-kw-loremipsum
+```
+
+> The Plug-In is tested with jekyll 3.8, 3.9, 4.0 and 4.1!
+
+## 🔥 Usage
+
+## ⏰ Changelog
+
+* ...
+* Build GitHub CI workflows
+* Prepare CI-workflow with Appraisal `bundle exec appraisal generate`
+* 0.0.2 Read the [NextSteps.md](NextSteps.md) and follow the introduction steps
+* 0.0.1 Install [Visual Studio Extension - Folder Templates](https://marketplace.visualstudio.com/items?itemName=Huuums.vscode-fast-folder-structure), and run `NewJekyllPlugInAsRubyGem` to get the a skeleton project from template
+* 0.0.0 Create project `jekyll-kw-loremipsum` from [template][GitHub jekyll-plugin-template]
+
+## ⚙️ Configuration
+
+Add `jekyll-kw-loremipsum` section to `_config.yml` configure the plugin globally. If you want to use defaults you can omit the config-section.
+
+```yaml
+jekyll-kw-loremipsum:
+  my_boolean: false
+  my_string: 'sha384'
+  my_number: 1.23
+```
+
+Configuration values, the `default` value is in **bold**
+
+| Key | Description | Values (**default**) |
+|-----|-------------|----------------------|
+| my_boolean | A boolean value    | **false**, true |
+| my_string  | A string           | foo, **hello plugin**, bar |
+| my_number  | A (decimal) number | **0** |
+
+## 📝 Notes / Hints
+
+TODO: Add notes, hints and learnings
+
+## 👋 Contribution
+
+TODO: How to contribute, e.g. [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## 🏆 Kudos
+
+TODO: Add big thanks and kudos persons / links / blogs
+
+## ✅ Template
+
+The project was created from the template [GitHub n13org/jekyll-plugin-template][GitHub jekyll-plugin-template]. We would ❤️ when you keep the reference. Thanks!
+
+[GitHub jekyll-plugin-template]: https://github.com/n13org/jekyll-plugin-template
+[Jekyll Website]: https://jekyllrb.com/

data/lib/jekyll-kw-loremipsum/configuration.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module KargWare
+    module LoremIpsum
+      # LoremIpsum configuration class
+      class Configuration
+        attr_accessor :my_integer, :my_float, :my_boolean, :my_string
+
+        DEFAULT_CONFIG = {
+          'my_integer' => 1,
+          'my_float' => 2.4,
+          'my_boolean' => true,
+          'my_string' => 'foo bar'
+        }.freeze
+
+        def initialize(options)
+          options = generate_option_hash(options)
+
+          @my_integer = options['my_integer']
+          @my_float = options['my_float']
+          @my_boolean = options['my_boolean']
+          @my_string = options['my_string']
+        end
+
+        private
+
+        def generate_option_hash(options)
+          DEFAULT_CONFIG.merge(options)
+        rescue TypeError
+          DEFAULT_CONFIG
+        end
+      end
+    end
+  end
+end

data/lib/jekyll-kw-loremipsum/parser.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module KargWare
+    module LoremIpsum
+      # LoremIpsum parser class
+      class Parser
+        # https://loremipsum.de/downloads/original.txt
+        @@words_lorem_ipsum = "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis at vero eros et accumsan et iusto odio dignissim qui blandit praesent luptatum zzril delenit augue duis dolore te feugait nulla facilisi. Nam liber tempor cum soluta nobis eleifend option congue nihil imperdiet doming id quod mazim placerat facer possim assum. Lorem ipsum dolor sit amet, consectetuer adipiscing elit, sed diam nonummy nibh euismod tincidunt ut laoreet dolore magna aliquam erat volutpat. Ut wisi enim ad minim veniam, quis nostrud exerci tation ullamcorper suscipit lobortis nisl ut aliquip ex ea commodo consequat. Duis autem vel eum iriure dolor in hendrerit in vulputate velit esse molestie consequat, vel illum dolore eu feugiat nulla facilisis. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, At accusam aliquyam diam diam dolore dolores duo eirmod eos erat, et nonumy sed tempor et et invidunt justo labore Stet clita ea et gubergren, kasd magna no rebum. sanctus sea sed takimata ut vero voluptua. est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat. Consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet."
+        # @@words_lorem_ipsum = "Lorem ipsum dolor sit amet, consetetur sadipscing"
+
+        @@arr_words_lorem_ipsum = nil
+        def self.arr_words_lorem_ipsum
+          if @@arr_words_lorem_ipsum == nil
+            @@arr_words_lorem_ipsum = @@words_lorem_ipsum.split(" ")
+          end
+          @@arr_words_lorem_ipsum
+        end
+
+        def self.get_words(cnt, random=false)
+          if random
+            arr_part = self.arr_words_lorem_ipsum.sample(cnt)
+          else
+            arr_part = self.arr_words_lorem_ipsum.slice(0, cnt)
+          end
+
+          arr_part.join(" ").chomp(",")
+        end
+
+        def initialize(config)
+          @config = config
+
+          match_parameters(@config)
+        end
+
+        def match_parameters(str)
+          # 1w    ==  1 word (default 40)
+          @words = 40
+          # 3p    ==  3 paragraphs (default -1)
+          # 7miw  ==  7 Min words in para (default 40)
+          # 15maw == 15 Max words in para (default 40)
+          @paras = -1
+          @minw = 40
+          @maxw = 40
+          # random == Should the words be random (or ordered) (default false)
+          @random = false
+
+          matched_words = str.strip.match(/\d+w/)
+          matched_paras = str.strip.match(/\d+p/)
+          matched_minw = str.strip.match(/\d+miw/)
+          matched_maxw = str.strip.match(/\d+maw/)
+          matched_random = str.strip.match(/random/)
+
+          # puts "Parser: W: %s P: %s MiW: %s MaW: %s Random: $s" % [matched_words, matched_paras, matched_minw, matched_maxw, matched_random]
+
+          @words = matched_words[0].strip.sub("w", "").to_i if matched_words
+          @paras = matched_paras[0].strip.sub("p", "").to_i if matched_paras
+          @minw = matched_minw[0].strip.sub("miw", "").to_i if matched_minw
+          @maxw = matched_maxw[0].strip.sub("maw", "").to_i if matched_maxw
+          @random = true if matched_random
+        end
+
+        def echo_config
+          puts "%s (%s) - W: %04d P: %04d MiW: %04d MaW: %04d" % [@paras == -1 ? "Words" : "Paras", @random, @words, @paras, @minw, @maxw]
+        end
+
+        def get_lorem_ipsum
+          if @paras == -1
+            Jekyll::KargWare::LoremIpsum::Parser.get_words(@words, @random)
+          else
+            arr_oneliner = Array.new
+            for i in 1..@paras
+              r = rand(@minw..@maxw)
+              arr_oneliner += [Jekyll::KargWare::LoremIpsum::Parser.get_words(r, @random)]
+            end
+            # arr_oneliner.join("\n") # No line wrap
+            # arr_oneliner.join("<br>") # OK, but no 2nd p
+            # arr_oneliner.join("  ") # No line wrap
+            # arr_oneliner.join("  \n")
+            arr_oneliner.join("\n\n")
+            # arr_oneliner.join(" - ")
+          end
+        end
+      end
+    end
+  end
+end
+
+## FOR TESTING #############################
+## ruby ./lib/jekyll-kw-loremipsum/parser.rb
+## #########################################
+
+# Jekyll::KargWare::LoremIpsum::Parser.new("1w").echo_config
+# Jekyll::KargWare::LoremIpsum::Parser.new("2w").echo_config
+# Jekyll::KargWare::LoremIpsum::Parser.new("3w").echo_config
+# Jekyll::KargWare::LoremIpsum::Parser.new("34w").echo_config
+# Jekyll::KargWare::LoremIpsum::Parser.new("foo bar 75w hello 115w foo bar").echo_config
+# Jekyll::KargWare::LoremIpsum::Parser.new("hello 13p foo 9p bar 56p").echo_config
+# Jekyll::KargWare::LoremIpsum::Parser.new("1 w").echo_config
+# Jekyll::KargWare::LoremIpsum::Parser.new("foo 8w bar 3p hello 7miw 25maw foo bar").echo_config
+# puts "######################"
+
+# for i in 1..Jekyll::KargWare::LoremIpsum::Parser.arr_words_lorem_ipsum.size
+#   puts "%03d: %s" % [i, Jekyll::KargWare::LoremIpsum::Parser.get_words(i)]
+# end
+# puts "######################"
+
+# puts "%03d: %s" % [650, Jekyll::KargWare::LoremIpsum::Parser.get_words(651)]
+# puts "%03d: %s" % [1000, Jekyll::KargWare::LoremIpsum::Parser.get_words(1000)]
+
+# cw = Jekyll::KargWare::LoremIpsum::Parser.new("7w")
+# # cw = Jekyll::KargWare::LoremIpsum::Parser.new("8w")
+# cw.echo_config
+# puts cw.get_lorem_ipsum
+# puts "######################"
+
+# c3p = Jekyll::KargWare::LoremIpsum::Parser.new("5p 8miw 8maw")
+# c3p.echo_config
+# puts c3p.get_lorem_ipsum
+# puts "######################"
+
+# c3p = Jekyll::KargWare::LoremIpsum::Parser.new("5p 7miw 25maw")
+# c3p.echo_config
+# c3p.get_lorem_ipsum
+# puts "######################"
+
+# cr = Jekyll::KargWare::LoremIpsum::Parser.new("random 5p 8miw 8maw")
+# cr.echo_config
+# puts cr.get_lorem_ipsum
+# puts "######################"

data/lib/jekyll-kw-loremipsum/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module KargWare
+    module LoremIpsum
+      RUBYGEM_NAME = 'jekyll-kw-loremipsum'
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/jekyll-kw-loremipsum.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module KargWare
+    module LoremIpsum
+      class Error < StandardError; end
+      class Exception < Gem::Exception; end
+
+      class LoremIpsumTag < Liquid::Tag
+        # safe true
+        # priority :low
+
+        def initialize(tag_name, text, tokens)
+          super
+          @text = text.strip
+          tokens = tokens
+
+          @parser = Jekyll::KargWare::LoremIpsum::Parser.new(@text)
+          # @parser.echo_config
+        end
+
+        def render(context)
+          @parser.get_lorem_ipsum
+        end
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('kw_lorem_ipsum', Jekyll::KargWare::LoremIpsum::LoremIpsumTag)

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-kw-loremipsum
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nicolas Karg
+- n13.org - Open-Source by KargWare
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-03-19 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: |2
+      LoremIpsum is a jekyll plugin. The plugin can be used as a tag for jekyll. You can get some dummy text for your webpage, without copy & pasting the Lorem Ipsum words yourself.
+
+      - Use the tag `{% kw_lorem_ipsum 30w %}` to get 30 different words.
+      - Use the tag `{% kw_lorem_ipsum random 4p 7miw 12maw %}` to get 4 paragraphs between 7 and 12 words.
+email:
+- rubygems.org@n13.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/jekyll-kw-loremipsum.rb
+- lib/jekyll-kw-loremipsum/configuration.rb
+- lib/jekyll-kw-loremipsum/parser.rb
+- lib/jekyll-kw-loremipsum/version.rb
+homepage: https://notes.n13.org/rubygems
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/n13org/jekyll-kw-loremipsum
+  bug_tracker_uri: https://github.com/n13org/jekyll-kw-loremipsum/issues
+  source_code_uri: https://github.com/n13org/jekyll-kw-loremipsum
+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: LoremIpsum is a jekyll tag-plugin.
+test_files: []