bookshop-array-structures 1.4.4 → 2.0.0.pre.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cae28d99204e71be4b50c3914d3611b3f83c0c34a0c9096a351b1742531772cf
-  data.tar.gz: 1992b1c1c7c7fb997a678d2ec2a51294c47f4d47de029f301bc8848eb488a068
+  metadata.gz: eb6e86e2d0e14e8231bf8dbef51cc5a22d5e4cd4f5828845ba7a1bac23c4631d
+  data.tar.gz: 7bb542b48d431ae9c743c75c4d675f8f33432d23e442a538ef7cbdf88c5264cd
 SHA512:
-  metadata.gz: e3a8af2c91fff8e31022ed10e8a979f80f70f04e462edab487bbfe3e2c1e33c39dc48f6a465885d6f263977c2c2f56f2e56d614964f3af7a8cc1c33823422804
-  data.tar.gz: b5cafb5ecaef22aa99a319829627c5d80baf061185f1d71d2c1c1ba90b57f12c071883d2680c899fb5bc19afe11f682d92671402bb68ab7c795d3fcdb02794ed
+  metadata.gz: 330d33cb9371f8e230f8e1289d31ac8692245f3f48b8f240df760ae814e75983e0141b086a2a2819163c085efe67be21c3baeb38625e525e24d243e44b8b7ff5
+  data.tar.gz: c9457ba7304e920421674ecd79993c22dbad0efedeacc3ed53285eba4b48de1cf6bae37751a631062f42e946a3ab9def3190cf39343be940d11e6f075e533d63

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    bookshop-array-structures (1.6.1)
+      jekyll (>= 3.7, < 5.0)
+      toml-rb (>= 2.0, < 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ansi (1.5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    citrus (3.0.2)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.8)
+    em-websocket (0.5.2)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0.6.0)
+    eventmachine (1.2.7)
+    ffi (1.15.1)
+    forwardable-extended (2.6.0)
+    hashdiff (1.0.1)
+    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)
+    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)
+    minitest (5.14.4)
+    minitest-reporters (1.4.3)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    powerpack (0.1.3)
+    public_suffix (4.0.6)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.5)
+    rouge (3.26.0)
+    rubocop (0.51.0)
+      parallel (~> 1.10)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    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.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bookshop-array-structures!
+  hashdiff
+  minitest
+  minitest-reporters
+  rake
+  rubocop (~> 0.51.0)
+
+BUNDLED WITH
+   2.1.4

data/Rakefile

@@ -0,0 +1,14 @@
+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/lib/bookshop-array-structures.rb

@@ -1,21 +1,102 @@
 require "jekyll"
+require 'pathname'
 require "toml-rb"
 
 module Bookshop
   class ArrayStructures
     def self.get_story_name(path)
-      basename = path.split("/").last.split(".").first
-      return basename.split("-").map(&:capitalize).join(" ")
+      basename = get_component_type(path)
+      return basename.split(/-|\//).map(&:capitalize).join(" ")
     end
 
-    def self.transform_component(component, site)
-      result = {}
-      component.each_pair { |storyname, story|
-        story.each_pair {|key, value|
-          if result.has_key?(key) && storyname != "defaults"
+    def self.get_component_type(path)
+      result = path.split(".").first;
+      pathParts = path.split(".").first.split("/")
+      if pathParts.length >= 2 && pathParts[pathParts.length-1] === pathParts[pathParts.length-2]
+        pathParts.pop
+        result = pathParts.join("/")
+      end
+      return result
+    end
+
+    def self.handle_props_object(props, result)
+    end
+
+    def self.handle_bookprops(value_obj, structure, value_context = nil)
+      structure["_select_data"] ||= {}
+      structure["_array_structures"] ||= {}
+      structure["_comments"] ||= {}
+      structure["value"] ||= {}
+      value_context = structure["value"] if value_context.nil?
+      value_obj.each_pair {|key, value|
+          if value_context.has_key?(key)
+            next
+          end
+
+          if value.is_a? Hash
+            comment =   value["--bookshop_comment"]         || 
+                        value["default--bookshop_comment"]  || 
+                        value["select--bookshop_comment"]   || 
+                        value["preview--bookshop_comment"]
+            if comment
+              structure["_comments"][key] = comment
+            end
+            unless value["default"].nil?
+              value_context[key] = value["default"]
+              next
+            end
+            if value["select"]
+              value_context[key] = nil
+              structure["_select_data"][key+"s"] = value["select"]
+              next
+            end
+            if value["preview"]
+              value_context[key] = nil
+              next
+            end
+            value_context[key] ||= {}
+            handle_bookprops(value, structure, value_context[key])
             next
           end
 
+          if value.is_a? Array
+            if value[0]&.is_a? Hash
+              if value[0]["--bookshop_comment"]
+                structure["_comments"][key] = value[0]["--bookshop_comment"]
+              end
+
+              structure["_array_structures"][key] ||= {"values" => [{"value" => {}}]}
+              handle_bookprops( value[0], 
+                                structure["_array_structures"][key]["values"][0],
+                                structure["_array_structures"][key]["values"][0]["value"])
+              value_context[key] = []
+              next
+            end
+            value_context[key] = value
+          end
+
+          if [true, false].include? value
+            value_context[key] = value
+            next
+          end
+
+          if key.include? "--bookshop_comment"
+            actual_key = key.split("--").first
+            next if actual_key == ""
+            structure["_comments"][actual_key] = value
+            next
+          end
+          
+          value_context[key] = nil
+        }
+    end
+
+
+    def self.handle_legacy_story(story, site)
+      result = {};
+      story.each_pair {|key, value|
+          next unless result.has_key?(key) && storyname != "defaults"
+
           if key.include? "--repeat"
             new_key = key.split("--").first
             result[new_key] = []
@@ -24,7 +105,7 @@ module Bookshop
             }
 
             label = new_key.split("_").map(&:capitalize).join(" ")
-            if site.config["_array_structures"][new_key]["values"].select{|value| value.label == label}.length > 0
+            if site.config["_array_structures"][new_key]["values"].select{|value| value["label"] == label}.length > 0
               next
             end
             site.config["_array_structures"][new_key]["values"].push({
@@ -51,35 +132,129 @@ module Bookshop
               end
               site.config["_select_data"][new_key].push(option)
             } 
+          elsif key.include? "--"
+            new_key = key.split("--").first
+            result[new_key] = nil
           else
             result[key] = value
           end
         }
-      }
+        return result
+    end
+
+    def self.transform_component(path, component, site)
+      unless component["defaults"].nil?
+        return transform_legacy_component(path, component, site)
+      end
+      result = { "value" => {} }
+      result["label"] = get_story_name(path)
+      result["value"]["_bookshop_name"] = get_component_type(path)
+      unless component["component"].nil?
+        result.merge!(component["component"])
+      end
+      unless component["props"].nil?
+        handle_bookprops(component["props"] || {}, result)
+      end
+      result["array_structures"] ||= [];
+      already_in_global_array = result["array_structures"].select{|value| value == 'bookshop_components'}.length > 0
+      if !already_in_global_array && !result["_hidden"]
+        result["array_structures"].push("bookshop_components")
+      end
+      result.delete("_hidden") unless result["_hidden"].nil?
       return result
     end
 
-    def self.build_array_structures(site)
-      base_path = ""
-      if !site.theme.nil?
-        base_path = site.theme.root + "/_bookshop/components/"
+    def self.transform_legacy_component(path, component, site)
+      puts "📚 Parsing legacy stories.toml config file"
+      result = { "value" => {} }
+      result["label"] = get_story_name(path)
+      result["value"]["_component_type"] = get_component_type(path)
+      component.each_pair { |storyname, story|
+        if storyname == "meta"
+          result.merge!(story)
+        else
+          result["value"].merge!(handle_legacy_story(story, site))
+        end
+      }
+      result["array_structures"] ||= [];
+      contains_component = result["array_structures"].select{|value| value == 'components'}.length > 0
+      if !contains_component && !result["_hidden"]
+        result["array_structures"].push("components")
       end
+      result.delete("_hidden") unless result["_hidden"].nil?
+      return result
+    end
+
+    def self.rewrite_bookshop_toml(content)
+      rewritten_lines = content.split("\n")&.collect { |line|
+        if line =~ /^[a-z0-9\-_\.\s]+=.*?#.+?$/i
+          /#:(?<comment>[^#]+)$/i =~ line
+          /^\s*?(?<variable_name>[a-z0-9\-_\.]+)\s?=/i =~ line
+          next line unless comment && variable_name
+
+          next "#{variable_name}--bookshop_comment = \"#{comment.strip}\"\n#{line}"
+        elsif line =~ /^\s*?\[.*?#.+?$/i
+          /#:(?<comment>[^#]+)$/i =~ line
+          next line unless comment
+          next "#{line}\n--bookshop_comment = \"#{comment.strip}\""
+        end
+        line
+      }
+      rewritten_lines.join("\n")
+    end
+
+    def self.parse_bookshop_toml(content)
+      rewritten_content = rewrite_bookshop_toml(content)
+      return TomlRB.parse(rewritten_content)
+    end
+
+    def self.build_from_location(base_path, site)
       site.config["_select_data"] ||= {}
       site.config["_array_structures"] ||= {}
-      site.config["_array_structures"]["components"] ||= {
-        "values" => []
-      }
-      Dir.glob("**/*.stories.{toml,tml,tom,tm}", base: base_path).each do |f|
-        component = TomlRB.load_file(base_path + f)
-        site.config["_array_structures"]["components"]["values"].push({
-          "label" => get_story_name(f),
-          "value" => transform_component(component, site)
-        })
+      puts "📚 Parsing Stories from #{base_path}"
+      Dir.glob("**/*.{bookshop,stories}.{toml,tml,tom,tm}", base: base_path).each do |f|
+        begin
+          if f =~ /bookshop/
+            raw_file = File.read(base_path + "/" + f)
+            component = parse_bookshop_toml(raw_file)
+          else
+            component = TomlRB.load_file(base_path + f)
+          end
+        rescue => exception
+          puts "❌ Error Parsing Story: " + f
+          puts exception
+          next
+        end
+        transformed_component = transform_component(f, component, site)
+        array_structures = transformed_component.delete("array_structures")
+        array_structures.each{|key|
+          begin
+            site.config["_array_structures"][key] ||= {}
+            site.config["_array_structures"][key]["values"] ||= []
+            site.config["_array_structures"][key]["values"].push(transformed_component)
+          rescue => exception
+            puts "❌ Error Adding Story to Array Structures: " + f
+            puts "🤔 Maybe your current _config.yml has conflicting array structures?"
+          end
+        }
+      end
+    end
+
+    def self.build_array_structures(site)
+      bookshop_locations = site.config['bookshop_locations']&.collect do |location|
+        Pathname.new(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
+      puts "✅ Finshed Parsing Stories"
     end
   end
 end
 
 Jekyll::Hooks.register :site, :after_init do |site|
   Bookshop::ArrayStructures.build_array_structures(site)
-end
+end

data/lib/bookshop-array-structures/version.rb

@@ -1,5 +1,5 @@
 module Bookshop
   module Arraystructures
-    VERSION = "1.4.4"
+    VERSION = "2.0.0-alpha.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bookshop-array-structures
 version: !ruby/object:Gem::Version
-  version: 1.4.4
+  version: 2.0.0.pre.alpha.2
 platform: ruby
 authors:
 - Tate
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -50,13 +50,16 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: 
+description:
 email:
 - tate@cloudcannon.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- Gemfile
+- Gemfile.lock
+- Rakefile
 - bookshop-array-structures.gemspec
 - lib/bookshop-array-structures.rb
 - lib/bookshop-array-structures/version.rb
@@ -64,7 +67,7 @@ homepage: https://github.com/cloudcannon/bookshop
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,12 +78,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Jekyll plugin to generate array structures from bookshop
 test_files: []