jekyll-hoffnung3000 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b994f55f448312b63280ea612335841ab2732a3537299a650510a9be69f6108
-  data.tar.gz: 2b78a80f993a31d5458bd50d48062312e699a30b8b47b46ad0edf5982fdfb025
+  metadata.gz: 00e7eadc818df655c7634aa6ed5dc6b1491467de2cfd9626271213082f193576
+  data.tar.gz: 29cf7e569205c9e40446231a5dbe272abac23435edc27b229830fc8c74181a68
 SHA512:
-  metadata.gz: f9c053b146cac2b57d7ad83f19bea38a5184a2c5fecfec8d1de843ec8cddc7f5a3608e2d80ad6ba098ebec49362ef973a93c4317c5b040121d9d8197597f708a
-  data.tar.gz: 402efaba4321f03594ea354301548eb4584a43a63b58e9337b29f5a987781df8d066f1dc0bb86947b48f36e4df57cc37f11f48254ac0f94741d2fd2444e33003
+  metadata.gz: e7132df52287cf63e18e7b0cec3aa4bb95f22766d9f912d356861d49427ad7230724be4e17f7216e8a1bc206f593fe432111a052c83fb4d1082fdce446f81353
+  data.tar.gz: 44be2954850feb86cbeda2e35fa5623d935aaa7e3d5f1bd813ded795952a734545ed2ec358c962dc4cc783599e59084042f7c31c9ebb0344b9db010499b39181

data/Gemfile

@@ -4,7 +4,3 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in jekyll-hoffnung3000.gemspec
 gemspec
-
-gem "rake", "~> 13.0"
-
-gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -1,9 +1,12 @@
 PATH
   remote: .
   specs:
-    jekyll-hoffnung3000 (0.1.0)
+    jekyll-hoffnung3000 (0.1.5)
       http (~> 4.4.1)
+      jekyll (~> 4.2)
       json (~> 2.5.1)
+      rake (~> 13.0)
+      rubocop (~> 1.7)
       ruby-jq (~> 0.2.1)
 
 GEM
@@ -12,12 +15,19 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.2)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.9)
     domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
+    em-websocket (0.5.2)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
     ffi (1.15.1)
     ffi-compiler (1.0.1)
       ffi (>= 1.0.0)
       rake
+    forwardable-extended (2.6.0)
     http (4.4.1)
       addressable (~> 2.3)
       http-cookie (~> 1.0)
@@ -28,17 +38,54 @@ GEM
     http-form_data (2.3.0)
     http-parser (1.2.3)
       ffi-compiler (>= 1.0, < 2.0)
+    http_parser.rb (0.6.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.2.0)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.4.0)
+      pathutil (~> 0.9)
+      rouge (~> 3.0)
+      safe_yaml (~> 1.0)
+      terminal-table (~> 2.0)
+    jekyll-sass-converter (2.1.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
     json (2.5.1)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.5.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
     mini_portile2 (2.6.1)
     multi_json (1.15.0)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
     public_suffix (4.0.6)
     rainbow (3.0.0)
     rake (13.0.3)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
     regexp_parser (2.1.1)
     rexml (3.2.5)
+    rouge (3.26.0)
     rubocop (1.16.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -54,18 +101,21 @@ GEM
       mini_portile2 (>= 2.2.0)
       multi_json
     ruby-progressbar (1.11.0)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    terminal-table (2.0.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.7)
-    unicode-display_width (2.0.0)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
   jekyll-hoffnung3000!
-  rake (~> 13.0)
-  rubocop (~> 1.7)
 
 BUNDLED WITH
    2.2.19

data/README.md

@@ -1,12 +1,20 @@
 # Jekyll::Hoffnung3000
 
 A Jekyll plugin for archiving HOFFNUNG3000 festivals.
+
+## Prerequisites
+
+This gem uses `ruby-jq` gem to bind to [jq](http://stedolan.github.io/jq/) which requires the Oniguruma library to provide regex support.
+
+If any system dependencies are missing please see the [jq FAQ](https://github.com/stedolan/jq/wiki/FAQ#installation) for help.
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'jekyll-hoffnung3000'
+group :jekyll_plugins do
+    gem 'jekyll-hoffnung3000', '0.1.0'
+end
 ```
 
 And then execute:
@@ -21,14 +29,68 @@ Or install it yourself as:
 
 Add these lines to your _config.yml replacing the url with the address of your running HOFFNUNG3000 instance.
 
-```
+```ruby
 hoffnung3000:
-    url: https://your-hoffnung3000-instance.org
+    url: "https://your-hoffnung3000-instance.org"
 ```
 
 With this config set you can use the command line to fetch event data which will be written to `_data/events.json`.
 
-`bundle exec jekyll hoffnung3000 events`
+```sh
+$ bundle exec jekyll hoffnung3000 events
+```
+
+Events are formatted in the following way as array of JSON objects:
+
+```json
+[
+    {
+        "title": "Anti-Capitalist Knitting",
+        "description": "Anti-Capitalist Knitting is an experimental knitting workshop with an emphasis on sustainability, focusing on exploring materials and using simple techniques to create artwork........",
+        "date": "2020-06-06",
+        "time": {
+            "from": "2020-06-06T10:00:00.000Z",
+            "to": "2020-06-06T12:00:00.000Z"
+        },
+        "organiser": {
+            "name": "Name of Organiser",
+        },
+        "place": {
+            "id": 1,
+            "name": "museum of neoliberalism [online location]",
+            "description": "A small, free museum about how an obscure and extreme ideological cult of the 1970s rose to power and now shapes our lives in dramatic and often terrible ways......",
+            "area": "London"
+        },
+        "imageUrl": "https://image-url/medium.jpg",
+        "tags": [
+            "Workshop",
+            "Art",
+            "Anticapitalism",
+            "Mental-health",
+            "Gender",
+            "Feminism"
+        ],
+        "websiteUrl": "https://event-website.org"
+    }
+]
+```
+
+Places are formatted in the following way as array of JSON objects:
+
+```json
+[
+    {
+        "id": 1,
+        "title": "Place name",
+        "description": "Description of this place",
+        "street": "1 Street",
+        "cityCode": "XXX123",
+        "city": "City",
+        "country": "Country",
+        "imageUrl": "https://image-url/medium.jpg"
+    }
+]
+```
 
 ## Development
 

data/Rakefile

@@ -2,7 +2,13 @@
 
 require "bundler/gem_tasks"
 require "rubocop/rake_task"
+require "rake/testtask"
 
 RuboCop::RakeTask.new
 
+Rake::TestTask.new do |t|
+  t.libs << "hoffnung3000"
+end
+desc "Run HOFFNUNG3000 tests"
+
 task default: :rubocop

data/jekyll-hoffnung3000.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.email         = ["git@contact.samandreae.com"]
 
   spec.summary       = "HOFFNUNG3000 archival tool"
-  spec.homepage      = "https://hoffnung3000.de"
+  spec.homepage      = "https://github.com/sandreae/jekyll-hoffnung3000"
   spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.4.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
 
@@ -27,8 +27,11 @@ Gem::Specification.new do |spec|
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"
   spec.add_dependency "http", "~> 4.4.1"
-  spec.add_dependency "ruby-jq", "~> 0.2.1"
+  spec.add_dependency "jekyll", "~> 4.2"
   spec.add_dependency "json", "~> 2.5.1"
+  spec.add_dependency "rake", "~> 13.0"
+  spec.add_dependency "rubocop", "~> 1.7"
+  spec.add_dependency "ruby-jq", "~> 0.2.1"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/jekyll/commands/hoffnung3000.rb

@@ -1,48 +1,6 @@
-require "http"
-require "jq"
-require "json"
+# frozen_string_literal: true
 
-FORMAT_STRING =
-  ".data[] |
-    {
-      title: .title,
-      description: .description,
-      date: .date, time:
-        {
-          from: .slots[0].from,
-          to: .slots[-1].to
-        },
-      organiser:
-        {
-          name: .animal.userName,
-          about: .organiser_biog
-        },
-      venue:
-        {
-          id: null,
-          name: .place.title,
-          description: .place.description,
-          area: .place.city
-        },
-      imageUrl:.images[0].mediumImageUrl,
-      tags:.tags,
-      websiteUrl: .websiteUrl
-    }
-  ".freeze
-
-def write_data(data, file_name)
-  Dir.mkdir("_data") unless Dir.exist?("_data")
-  File.write(format("_data/%s.json", file_name), JSON.generate(data))
-end
-
-def check_config(config)
-  raise "HOFFNUNG3000 Error: Jekyl _config.yml file must contain a hoffnung3000 block" unless config["hoffnung3000"]
-  unless config["hoffnung3000"]["url"]
-    raise "HOFFNUNG3000 Error: Jekyl _config.yml file must contain a hoffnung3000 > url value"
-  end
-
-  config
-end
+require_relative "../hoffnung3000/main"
 
 module Jekyll
   module Commands
@@ -56,10 +14,19 @@ module Jekyll
             c.command(:events) do |f|
               f.description "Fetch all events and write to _data folder as events.json."
               f.action do |_args, _options|
-                config = check_config(Jekyll.configuration({}))
-                response = HTTP.get(format("%s/api/events", config["hoffnung3000"]["url"]))
-                jq = JQ(response.body, parse_json: true)
-                write_data(jq.search(FORMAT_STRING), "events")
+                get_hoffnung(Jekyll.configuration({}), "events")
+              end
+            end
+            c.command(:places) do |f|
+              f.description "Fetch all places and write to _data folder as places.json."
+              f.action do |_args, _options|
+                get_hoffnung(Jekyll.configuration({}), "places")
+              end
+            end
+            c.command(:places) do |f|
+              f.description "Fetch festival meta data and write to _data folder as meta.json."
+              f.action do |_args, _options|
+                get_hoffnung(Jekyll.configuration({}), "meta")
               end
             end
           end

data/lib/jekyll/hoffnung3000.rb

@@ -9,4 +9,4 @@ module Jekyll
   end
 end
 
-require "jekyll/commands/hoffnung3000.rb"
+require "jekyll/commands/hoffnung3000"

data/lib/jekyll/hoffnung3000/main.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require "http"
+require "jq"
+require "json"
+
+RESULT_LIMIT = 200
+
+FORMAT_STRING_EVENTS =
+  ".data[] |
+    {
+        title: .title,
+        description: .description,
+        date: .slots[0].from | split(\"T\")[0],
+        time:
+        {
+            from: .slots[0].from,
+            to: .slots[-1].to
+        },
+        organiser:
+        {
+            name: .animal.userName,
+        },
+        place:
+        {
+            id: .place.id,
+            name: .place.title,
+            description: .place.description,
+            area: .place.city
+        },
+        imageUrl:.images[0].mediumImageUrl,
+        tags:.tags,
+        websiteUrl: .websiteUrl
+    }
+  "
+
+FORMAT_STRING_PLACES =
+  ".data[] |
+    {
+        id: .id,
+        title: .title,
+        description: .description,
+        street: .street,
+        cityCode: .cityCode,
+        city: .city,
+        country: .country,
+        imageUrl:.images[0].mediumImageUrl
+    }
+  "
+
+FORMAT_STRING_META =
+  ".config |
+    {
+        title: .title,
+        description: .description,
+    }
+  "
+
+SEARCH_STRINGS = {
+  "events" => FORMAT_STRING_EVENTS,
+  "places" => FORMAT_STRING_PLACES,
+  "meta" => FORMAT_STRING_META
+}.freeze
+
+def format_data(data, key)
+  jq = JQ(data, parse_json: true)
+  jq.search(SEARCH_STRINGS[key])
+end
+
+def write_data(data, file_name)
+  Dir.mkdir("_data") unless Dir.exist?("_data")
+  File.write(format("_data/%s.json", file_name), JSON.generate(data))
+end
+
+def check_config(config)
+  raise "HOFFNUNG3000 Error: Jekyl _config.yml file must contain a hoffnung3000 block" unless config["hoffnung3000"]
+  unless config["hoffnung3000"]["url"]
+    raise "HOFFNUNG3000 Error: Jekyl _config.yml file must contain a hoffnung3000 > url value"
+  end
+
+  config
+end
+
+def url(config)
+  check_config(config)["hoffnung3000"]["url"]
+end
+
+def fetch_data(url, key)
+  HTTP.get(format("%<url>s/api/%<key>s", { url: url, key: key }), { params: { limit: RESULT_LIMIT } }).body
+end
+
+def get_hoffnung(config, key)
+  url = url(config)
+  data = fetch_data(url, key)
+  formatted_data = format_data(data, key)
+  write_data(formatted_data, key)
+end

data/lib/jekyll/hoffnung3000/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Hoffnung3000
-    VERSION = "0.1.0"
+    VERSION = "0.1.5"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-hoffnung3000
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - sandreae
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-10 00:00:00.000000000 Z
+date: 2021-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.4.1
 - !ruby/object:Gem::Dependency
-  name: ruby-jq
+  name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.5.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: ruby-jq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 description: 
 email:
 - git@contact.samandreae.com
@@ -69,15 +111,17 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- jekyll-hoffnung3000-0.1.4.gem
 - jekyll-hoffnung3000.gemspec
 - lib/jekyll/commands/hoffnung3000.rb
 - lib/jekyll/hoffnung3000.rb
+- lib/jekyll/hoffnung3000/main.rb
 - lib/jekyll/hoffnung3000/version.rb
-homepage: https://hoffnung3000.de
+homepage: https://github.com/sandreae/jekyll-hoffnung3000
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://hoffnung3000.de
+  homepage_uri: https://github.com/sandreae/jekyll-hoffnung3000
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -86,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="