cloudcannon-jekyll-bookshop 2.0.0.pre.alpha.44

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4f3cc065be28b6d52075ceddab5f62ffa9d14e0ef19a02aad79d2a586d678171
+  data.tar.gz: 3809d9d32e5aed6d97ef19f4ca710c9af902ec0bffb1f04e2f8058617820d90e
+SHA512:
+  metadata.gz: 06137dc1f3ea58db04db9d1d2bc3c5e203e66518b53bb7a189e95db2592e658a934a9dfdf923286ceb1288bcd8126a1f08c381f28b391a57a1da7f740b1181c4
+  data.tar.gz: f7018edcd9a7d08b1e342f80ec20d021eafe72abddce4d8e1eab032d1cef785d30d702270ef3285728c251d8877d7a83e84a4c16384445c09eecaa885c808f92

data/.rubocop.yml

@@ -0,0 +1,27 @@
+require: rubocop-jekyll
+
+inherit_gem:
+  rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.4
+  Include:
+    - lib/**/*.rb
+    - spec/**/*.rb
+
+  Exclude:
+    - .gitignore
+    - .rspec
+    - .rubocop.yml
+    - .travis.yml
+    - Gemfile.lock
+    - HISTORY.md
+    - LICENSE.txt
+    - README.md
+    - script/**/*
+    - vendor/**/*
+    - gemfiles/**/*
+
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - lib/cloudcannon-jekyll-bookshop/page-without-a-file.rb

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem "rubocop"
+  gem "hashdiff"
+  gem "rake"
+  gem "minitest"
+  gem 'minitest-reporters'
+end

data/Gemfile.lock

@@ -0,0 +1,120 @@
+PATH
+  remote: .
+  specs:
+    cloudcannon-jekyll-bookshop (2.0.0.pre.alpha.44)
+      dry-inflector (>= 0.1, < 1.0)
+      jekyll (>= 3.7, < 5.0)
+      node-runner (>= 1.0, < 2.0)
+      toml-rb (>= 2.0, < 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    citrus (3.0.2)
+    cloudcannon-jekyll (2.0.1)
+      jekyll (>= 2.4.0, < 5)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.9)
+    dry-inflector (0.2.1)
+    em-websocket (0.5.2)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    ffi (1.15.3)
+    forwardable-extended (2.6.0)
+    hashdiff (1.0.1)
+    http_parser.rb (0.6.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.4)
+    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)
+    kramdown (2.3.1)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.6.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    minitest (5.14.4)
+    minitest-reporters (1.4.3)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    node-runner (1.0.1)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    public_suffix (4.0.6)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.5)
+    rouge (3.26.0)
+    rubocop (0.80.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      rexml
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-jekyll (0.11.0)
+      rubocop (>= 0.68.0, < 0.81.0)
+      rubocop-performance (~> 1.2)
+    rubocop-performance (1.6.1)
+      rubocop (>= 0.71.0)
+    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)
+    toml-rb (2.0.1)
+      citrus (~> 3.0, > 3.0)
+    unicode-display_width (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cloudcannon-jekyll (>= 2.0, < 3.0)
+  cloudcannon-jekyll-bookshop!
+  hashdiff
+  minitest
+  minitest-reporters
+  rake
+  rubocop
+  rubocop-jekyll (~> 0.11)
+
+BUNDLED WITH
+   2.1.4

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib'
+  t.libs.push 'specs'
+  t.verbose = true
+  t.warning = false
+  t.pattern = "spec/**/*_spec.rb"
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Run tests"
+task :default => [:test]

data/cloudcannon-jekyll-bookshop.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'lib/cloudcannon-jekyll-bookshop/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cloudcannon-jekyll-bookshop"
+  spec.version       = CloudCannonJekyllBookshop::VERSION
+  spec.authors       = ["Liam Bigelow"]
+  spec.email         = ["liam@cloudcannon.com"]
+  spec.homepage      = "https://github.com/cloudcannon/bookshop"
+  spec.summary       = "A Jekyll plugin to configure the CloudCannon CMS using bookshop TOML files"
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.license       = "MIT"
+
+  spec.add_dependency "jekyll", ">= 3.7", "< 5.0"
+  spec.add_dependency "toml-rb", ">= 2.0", "< 3.0"
+  spec.add_dependency "node-runner", ">= 1.0", "< 2.0"
+  spec.add_dependency "dry-inflector", ">= 0.1", "< 1.0"
+  spec.add_development_dependency "cloudcannon-jekyll", ">= 2.0", "< 3.0"
+  spec.add_development_dependency "rubocop", "~> 0.80"
+  spec.add_development_dependency "rubocop-jekyll", "~> 0.11"
+end

data/lib/cloudcannon-jekyll-bookshop.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require_relative "./cloudcannon-jekyll-bookshop/output-site-data"
+require_relative "./cloudcannon-jekyll-bookshop/structures"
+
+Jekyll::Hooks.register :site, :after_init do |site|
+  CloudCannonJekyllBookshop::Structures.build_structures(site)
+end
+
+Jekyll::Hooks.register :site, :post_write do |site|
+  CloudCannonJekyllBookshop::SiteData.output(site)
+end

data/lib/cloudcannon-jekyll-bookshop/output-site-data.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "json/ext"
+require_relative "./page-without-a-file"
+
+module CloudCannonJekyllBookshop
+  class SiteData
+    def self.output(site)
+      @site = site
+      return unless @site.data["_bookshop_site_data"]
+
+      output_payload = @site.data["_bookshop_site_data"].to_json
+
+      filename = "bookshop-site-data"
+      generate_file(filename, output_payload)
+    end
+
+    def self.generate_file(filename, content)
+      dest = destination_json_path(filename)
+      FileUtils.mkdir_p(File.dirname(dest))
+      File.open(dest, "w") { |file| file.write(content) }
+      @site.keep_files ||= []
+      @site.keep_files << json_path(filename)
+    end
+
+    def self.destination_json_path(filename)
+      Jekyll.sanitized_path(@site.dest, json_path(filename))
+    end
+
+    def self.json_path(filename)
+      "_cloudcannon/#{filename}.json"
+    end
+  end
+end

data/lib/cloudcannon-jekyll-bookshop/page-without-a-file.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module CloudCannonJekyllBookshop
+  # Utility class to help generate files with no source file
+  class PageWithoutAFile < Jekyll::Page
+    def read_yaml(*)
+      @data ||= {}
+    end
+  end
+end

data/lib/cloudcannon-jekyll-bookshop/structures.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "toml-rb"
+require "dry/inflector"
+require "node-runner"
+
+module CloudCannonJekyllBookshop
+  # Parses a bookshop and creates CloudCannon CMS structures
+  class Structures
+    def self.get_default_component_name(path)
+      @node_bookshop.NiceLabel(get_component_key(path))
+    end
+
+    def self.get_component_key(path)
+      @node_bookshop.GetComponentKey(path)
+    end
+
+    def self.rewrite_bookshop_toml(content)
+      @node_bookshop.RewriteTOML(content)
+    end
+
+    def self.parse_bookshop_toml(content)
+      rewritten_content = rewrite_bookshop_toml(content)
+      TomlRB.parse(rewritten_content)
+    end
+
+    def self.load_component(path)
+      begin
+        component = parse_bookshop_toml(path)
+      rescue StandardError => e
+        Jekyll.logger.error "Bookshop:",
+                            "❌ Error Parsing Story: #{f}"
+        Jekyll.logger.error "",
+                            e.message
+      end
+      component
+    end
+
+    def self.transform_component(path, component)
+      transformed_components = @node_bookshop.TransformComponent(path, component)
+      @structure_count += transformed_components.size
+      transformed_components
+    end
+
+    def self.add_structure(hash, component)
+      array_structures = component.delete("array_structures")
+      array_structures.each do |key|
+        hash[key] ||= {}
+        hash[key]["values"] ||= []
+        hash[key]["values"].push(component)
+      end
+    end
+
+    def self.build_from_location(base_path, site)
+      site.config["_select_data"] ||= {}
+      site.config["_array_structures"] ||= {}
+      Jekyll.logger.info "Bookshop:",
+                         "Parsing Stories from #{base_path}"
+
+      threads = []
+      Dir.glob("**/*.{bookshop}.{toml,tml,tom,tm}", :base => base_path).each do |f|
+        threads << Thread.new do
+          raw_file = File.read(base_path + "/" + f)
+          component = load_component(raw_file)
+
+          transform_component(f, component).each do |transformed_component|
+            add_structure(site.config["_array_structures"], transformed_component)
+          end
+        end
+      end
+      threads.each(&:join)
+    end
+
+    def self.setup_helpers
+      @inflector = Dry::Inflector.new
+      @node_bookshop = NodeRunner.new(
+        <<~JAVASCRIPT
+          const {Version: TNVersion, RewriteTOML} = require('@bookshop/toml-narrator');
+          const {Version: CSVersion, TransformComponent, GetComponentKey, NiceLabel} = require('@bookshop/cloudcannon-structures');
+        JAVASCRIPT
+      )
+    end
+
+    def self.tn_version
+      @node_bookshop.TNVersion
+    end
+
+    def self.cs_version
+      @node_bookshop.CSVersion
+    end
+
+    def self.build_structures(site)
+      structure_start = Time.now
+      @structure_count = 0
+
+      setup_helpers
+
+      bookshop_locations = site.config["bookshop_locations"]&.collect do |location|
+        Pathname.new("#{site.source}/#{location}/components").cleanpath.to_s
+      end
+      bookshop_locations = bookshop_locations&.select do |location|
+        Dir.exist?(location)
+      end
+      bookshop_locations&.each do |base_path|
+        build_from_location(base_path, site)
+      end
+
+      elapsed_time = Time.now - structure_start
+      Jekyll.logger.info "Bookshop:",
+                         "#{@structure_count} structure#{@structure_count == 1 ? "" : "s"}
+      built in #{elapsed_time.round(2)}s ✅"
+    end
+  end
+end

data/lib/cloudcannon-jekyll-bookshop/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module CloudCannonJekyllBookshop
+  VERSION = "2.0.0.pre.alpha.44"
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: cloudcannon-jekyll-bookshop
+version: !ruby/object:Gem::Version
+  version: 2.0.0.pre.alpha.44
+platform: ruby
+authors:
+- Liam Bigelow
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: toml-rb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: node-runner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: dry-inflector
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: cloudcannon-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.80'
+- !ruby/object:Gem::Dependency
+  name: rubocop-jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description:
+email:
+- liam@cloudcannon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- cloudcannon-jekyll-bookshop.gemspec
+- lib/cloudcannon-jekyll-bookshop.rb
+- lib/cloudcannon-jekyll-bookshop/output-site-data.rb
+- lib/cloudcannon-jekyll-bookshop/page-without-a-file.rb
+- lib/cloudcannon-jekyll-bookshop/structures.rb
+- lib/cloudcannon-jekyll-bookshop/version.rb
+homepage: https://github.com/cloudcannon/bookshop
+licenses:
+- MIT
+metadata: {}
+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: 1.3.1
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: A Jekyll plugin to configure the CloudCannon CMS using bookshop TOML files
+test_files: []