locomotivecms_steam 1.5.0.rc0 → 1.5.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2811bbc4085bab4ef718204d051285c1922ec6208d8173c0f2f7d21996eed632
-  data.tar.gz: dc8b0c4d1b7ec7a85006511f8aad93647e4fa7e1a12dda2fde0dc20f1cabb9b5
+  metadata.gz: 43525e692c1a13260c2947fd4a37d83b95b965b656b84f3dc20c12812c4275e4
+  data.tar.gz: efeb033805d15e48d592da3e818f9a77eef521e0aca112f33f20f4f44897a2be
 SHA512:
-  metadata.gz: a4b744dfee082181c392bb21c56ff4f9a9d761be3066405ff17bc3007a25f3a519dc266bc409d39eb55ee6ea76ab1525b35daacdd17ef900d13637351a17c6b9
-  data.tar.gz: fc28966e95e7e9809aa7e3f153d7343d610659602d39af2c92364bd2213be064ed4b6d270b07b1eefd4c5e8fa3150e57821c5db2b58c92147708c4f911ea7b06
+  metadata.gz: 2a8491bdb94fda3b92834494b505235c550a689e66fb82e3d19c4f7620f8eb75e09ce5aef12bc79a1a517c9c1a54e85b96763f878313a3bdb869e78491e336ea
+  data.tar.gz: 825b2519f250a5618cf9c34aeb16444cd84f91d5d6f332d32ed8b7fec913ec6c7b943e81d23c7ae23333373aeb112ca0b4d58cd45ad72ece27928c148e940c69

data/.travis.yml

@@ -2,7 +2,8 @@ language: ruby
 services: mongodb
 before_script: ./script/ci/before_build.sh
 rvm:
-  - 2.5.0
+  - 2.6.1
+  - 2.6.5
 env:
   - CODECLIMATE_REPO_TOKEN=3fa74f2ade25037fccd7261090acbdeae232639c3a83aafb80ee428ec16b8cf9
 addons:

data/Gemfile

@@ -5,14 +5,11 @@ gemspec
 group :development do
   gem 'locomotivecms_common', github: 'locomotivecms/common', ref: '4d1bd56'
   # gem 'locomotivecms_common', path: '../common'
-  # gem 'locomotivecms_models', '~> 0.0.1', path: '../models'
-  # gem 'locomotivecms_models', '0.0.1.pre.alpha'
-  # gem 'locomotivecms-liquid', path: '/Users/didier/Documents/LocomotiveCMS/gems/liquid'
-  # gem 'duktape', path: '/Users/didier/Documents/NoCoffee/ProjectsX/duktape.rb'
+  # gem 'duktape', path: '../tmp/duktape.rb'
   # gem 'duktape', github: 'judofyr/duktape.rb', ref: '20ef6a5'
-  # gem 'thin'
+  # gem 'duktape', github: 'did/duktape.rb', branch: 'any-fixnum'
 
-  gem 'puma'
+  gem 'puma',               '~> 4.3.0'
   gem 'haml',               '~> 5.0.4'
 
   gem 'rack-mini-profiler', '~> 0.10.1'

data/Gemfile.lock

@@ -1,5 +1,5 @@
 GIT
-  remote: git://github.com/locomotivecms/common.git
+  remote: https://github.com/locomotivecms/common.git
   revision: 4d1bd565246262ab4b1b824e21c7847846f4cc5c
   ref: 4d1bd56
   specs:
@@ -12,7 +12,7 @@ GIT
 PATH
   remote: .
   specs:
-    locomotivecms_steam (1.5.0.rc0)
+    locomotivecms_steam (1.5.0.rc1)
       RedCloth (~> 4.3.2)
       autoprefixer-rails (~> 8.0.0)
       bcrypt (~> 3.1.11)
@@ -20,17 +20,17 @@ PATH
       coffee-script (~> 2.4.1)
       compass (~> 1.0.3)
       dragonfly (~> 1.2.0)
-      duktape (~> 1.6.1.0)
+      duktape (~> 2.0.1.1)
       httparty (~> 0.16.0)
       kramdown (~> 1.16.2)
-      locomotivecms-solid (~> 4.0.1)
+      liquid (~> 4.0.3)
       locomotivecms_common (~> 0.3.1)
       mime-types (~> 3.1.0)
       mimetype-fu (~> 0.1.2)
       moneta (~> 1.0.0)
       morphine (~> 0.1.1)
       multi_json (~> 1.13.1)
-      nokogiri (~> 1.8.2)
+      nokogiri (~> 1.10.4)
       pony (~> 1.12)
       rack-cache (~> 1.7.0)
       rack-rewrite (~> 1.5.1)
@@ -44,18 +44,18 @@ GEM
   remote: https://rubygems.org/
   specs:
     RedCloth (4.3.2)
-    activesupport (5.2.2)
+    activesupport (5.2.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     attr_extras (5.2.0)
     autoprefixer-rails (8.0.0)
       execjs
-    bcrypt (3.1.12)
-    bson (4.4.2)
+    bcrypt (3.1.13)
+    bson (4.5.0)
     chronic (0.10.2)
     chunky_png (1.3.11)
     codeclimate-test-reporter (0.4.8)
@@ -77,23 +77,23 @@ GEM
       sass (>= 3.3.0, < 3.5)
     compass-import-once (1.0.5)
       sass (>= 3.2, < 3.5)
-    concurrent-ruby (1.1.4)
-    coveralls (0.8.22)
+    concurrent-ruby (1.1.5)
+    coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
       term-ansicolor (~> 1.3)
-      thor (~> 0.19.4)
+      thor (>= 0.19.4, < 2.0)
       tins (~> 1.6)
-    crass (1.0.4)
+    crass (1.0.5)
     diff-lcs (1.3)
-    docile (1.3.1)
+    docile (1.3.2)
     dragonfly (1.2.0)
       addressable (~> 2.3)
       multi_json (~> 1.0)
       rack (>= 1.3)
-    duktape (1.6.1.0)
+    duktape (2.0.1.1)
     execjs (2.7.0)
-    ffi (1.10.0)
+    ffi (1.11.2)
     flamegraph (0.9.5)
     haml (5.0.4)
       temple (>= 0.8.0)
@@ -101,7 +101,7 @@ GEM
     httparty (0.16.4)
       mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
-    i18n (1.5.3)
+    i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     i18n-spec (0.6.0)
       iso
@@ -112,35 +112,35 @@ GEM
       multi_json (~> 1.0)
       rspec (>= 2.0, < 4.0)
     kramdown (1.16.2)
-    locomotivecms-liquid (4.0.0)
-    locomotivecms-solid (4.0.1)
-      locomotivecms-liquid (~> 4.0.0)
+    liquid (4.0.3)
     mail (2.7.1)
       mini_mime (>= 0.1.1)
-    memory_profiler (0.9.12)
+    memory_profiler (0.9.14)
     mime-types (3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
+    mime-types-data (3.2019.1009)
     mimetype-fu (0.1.2)
-    mini_mime (1.0.1)
-    mini_portile2 (2.3.0)
+    mini_mime (1.0.2)
+    mini_portile2 (2.4.0)
     minitest (5.11.3)
     moneta (1.0.0)
-    mongo (2.5.3)
-      bson (>= 4.3.0, < 5.0.0)
+    mongo (2.8.0)
+      bson (>= 4.4.2, < 5.0.0)
     morphine (0.1.1)
     multi_json (1.13.1)
     multi_xml (0.6.0)
-    nokogiri (1.8.5)
-      mini_portile2 (~> 2.3.0)
+    nio4r (2.5.2)
+    nokogiri (1.10.5)
+      mini_portile2 (~> 2.4.0)
     nokogumbo (1.5.0)
       nokogiri
     origin (2.3.1)
     pony (1.13.1)
       mail (>= 2.0)
-    public_suffix (3.0.3)
-    puma (3.12.0)
-    rack (2.0.6)
+    public_suffix (4.0.1)
+    puma (4.3.0)
+      nio4r (~> 2.0)
+    rack (2.0.7)
     rack-cache (1.7.2)
       rack (>= 0.4)
     rack-mini-profiler (0.10.7)
@@ -150,7 +150,7 @@ GEM
       rack (>= 1.0, < 3)
     rack_csrf (2.6.0)
       rack (>= 1.1.0)
-    rake (12.3.2)
+    rake (12.3.3)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
@@ -182,14 +182,14 @@ GEM
       rack (> 1, < 3)
     stackprof (0.2.12)
     stringex (2.8.5)
-    temple (0.8.0)
+    temple (0.8.1)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
-    thor (0.19.4)
+    thor (0.20.3)
     thread_safe (0.3.6)
     tilt (2.0.9)
     timecop (0.9.1)
-    tins (1.20.2)
+    tins (1.21.1)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
     uglifier (4.1.20)
@@ -208,9 +208,9 @@ DEPENDENCIES
   locomotivecms_common!
   locomotivecms_steam!
   memory_profiler
-  mongo (~> 2.5.1)
+  mongo (~> 2.8.0)
   origin (~> 2.3.1)
-  puma
+  puma (~> 4.3.0)
   rack-mini-profiler (~> 0.10.1)
   rack-test (~> 0.8.2)
   rake (~> 12.3.0)
@@ -219,4 +219,4 @@ DEPENDENCIES
   timecop (~> 0.9.1)
 
 BUNDLED WITH
-   1.17.3
+   2.0.2

data/README.md

@@ -1,6 +1,6 @@
 # Steam
 
-[![Code Climate](https://codeclimate.com/github/locomotivecms/steam/badges/gpa.svg)](https://codeclimate.com/github/locomotivecms/steam) [![Dependency Status](https://gemnasium.com/locomotivecms/steam.svg)](https://gemnasium.com/locomotivecms/steam) [![Build Status](https://travis-ci.org/locomotivecms/steam.svg?branch=master)](https://travis-ci.org/locomotivecms/steam) [![Coverage Status](https://coveralls.io/repos/locomotivecms/steam/badge.svg?branch=master)](https://coveralls.io/r/locomotivecms/steam?branch=master) [![Gitter](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/locomotivecms/steam)
+[![Code Climate](https://codeclimate.com/github/locomotivecms/steam/badges/gpa.svg)](https://codeclimate.com/github/locomotivecms/steam) [![Build Status](https://travis-ci.com/locomotivecms/steam.svg?branch=master)](https://travis-ci.com/locomotivecms/steam) [![Coverage Status](https://coveralls.io/repos/locomotivecms/steam/badge.svg?branch=master)](https://coveralls.io/r/locomotivecms/steam?branch=master) [![Gitter](https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg)](https://gitter.im/locomotivecms/steam)
 
 The rendering stack used by both Wagon and Engine (WIP). It includes:
 
@@ -94,4 +94,4 @@ Note: you do not need to prefix with bundle exec as the docky-ruby image already
 
 ## License
 
-Copyright (c) 2018 NoCoffee. MIT Licensed, see MIT-LICENSE for details.
+Copyright (c) 2019 NoCoffee. MIT Licensed, see MIT-LICENSE for details.

data/lib/locomotive/steam/adapters/filesystem/sanitizers/section.rb

@@ -7,32 +7,78 @@ module Locomotive::Steam
           include Adapters::Filesystem::Sanitizer
 
           def apply_to_entity(entity)
-            super
-            parse_json(entity)
+            super.tap do
+              # allow multiple ways of defining global and preset content
+              handle_aliases(entity.definition)
+
+              # Utilize global defaults for dropzone preset
+              # when `use_default` is defined
+              fill_presets(entity.definition)
+
+              # use the default setting values if some settings
+              # are not set in the default object
+              set_default_values(entity.definition)
+            end
           end
 
           private
 
-          def parse_json(entity)
-            content = File.read(entity.template_path)
-            match   = content.match(JSON_FRONTMATTER_REGEXP)
+          def handle_aliases(definition)
+            # Dropzone presets -> presets
+            if presets = definition.delete('dropzone_presets')
+              definition['presets'] = presets
+            end
+
+            # Global content -> default
+            if default = definition.delete('global_content')
+              definition['default'] = default
+            end
+          end
 
-            raise_parsing_error(entity, content) if match.nil?
+          def fill_presets(definition)
+            if definition.key?('default') && definition.key?('presets')
+              definition['presets'].each_with_index do |preset_definition, preset_index|
+                next unless preset_definition.delete('use_default') == true
 
-            json, template = match[:json], match[:template]
+                settings = preset_definition['settings'] ||= {}
 
-            begin
-              entity.definition = MultiJson.load(json)
-            rescue MultiJson::ParseError => e
-              raise Locomotive::Steam::JsonParsingError.new(e, entity.template_path, json)
-            end
+                # Fallback to use setting `default` key for Standalone/Global section settings and block settings
+                definition['default']['settings'].each do |name, value|
+                  settings[name] ||= value
+                end
 
-            entity.template = template
+                preset_definition['blocks'] = (preset_definition['blocks'] || []) + definition['default']['blocks']
+              end
+            end
           end
 
-          def raise_parsing_error(entity, content)
-            message = 'Your section requires a valid JSON header'
-            raise Locomotive::Steam::ParsingRenderingError.new(message, entity.template_path, content, 0, nil)
+          def set_default_values(definition)
+            content = definition['default']
+
+            return if content.nil?
+
+            settings = content['settings'] ||= {}
+
+            definition['settings'].each do |setting|
+              settings[setting['id']] ||= setting['default']
+            end
+
+            # no definition of blocks, no need to continue
+            return if definition['blocks'].blank?
+
+            # now, take care of the different type of blocks
+            blocks = content['blocks'] ||= []
+
+            blocks.each do |block|
+              _definition = definition['blocks'].find { |d| d['type'] == block['type'] }
+
+              next if _definition.nil?
+
+              _definition['settings'].each do |setting|
+                block['settings'] ||= {}
+                block['settings'][setting['id']] ||= setting['default']
+              end
+            end
           end
 
         end

data/lib/locomotive/steam/adapters/filesystem/sanitizers/site.rb

@@ -10,6 +10,8 @@ module Locomotive::Steam
           def apply_to_entity(entity)
             entity.metafields_schema = clean_metafields_schema(entity.metafields_schema)
             entity.routes            = build_routes(entity.routes)
+
+            apply_metafields_samples(entity)
           end
 
           private
@@ -20,7 +22,7 @@ module Locomotive::Steam
             schema.each_with_index.map do |(namespace, definitions), position|
               {
                 name:     namespace.to_s,
-                label:    localized_label(definitions.delete(:label), namespace.to_s), # { default: namespace.to_s }.merge(definitions.delete(:label) || {}),
+                label:    localized_label(definitions.delete(:label), namespace.to_s),
                 fields:   parse_metafields(definitions.delete(:fields)),
                 position: definitions.delete(:position) || position
               }.merge(definitions)
@@ -40,6 +42,18 @@ module Locomotive::Steam
             end
           end
 
+          def apply_metafields_samples(entity)
+            entity.metafields_schema&.each do |namespace|
+              namespace[:fields].each do |field|
+                next unless field[:sample].present?
+
+                entity.metafields ||= {}
+                entity.metafields[namespace[:name]] ||= {}
+                entity.metafields[namespace[:name]][field[:name]] ||= field[:sample]
+              end
+            end
+          end
+
           def localized_label(label, default)
             case label
             when Hash   then label

data/lib/locomotive/steam/adapters/filesystem/yaml_loader.rb

@@ -18,16 +18,29 @@ module Locomotive::Steam
           @scope = scope
         end
 
-        def _load(path, frontmatter = false, &block)
+        def _load(path, frontmatter = false, strict = false, &block)
           if File.exists?(path)
             yaml      = File.open(path).read.force_encoding('utf-8')
             template  = nil
 
-            if frontmatter && match = yaml.match(FRONTMATTER_REGEXP)
+            # JSON header?
+            if frontmatter && match = yaml.match(JSON_FRONTMATTER_REGEXP)
+              json, template = match[:json], match[:template]
+              safe_json_load(json, template, path, &block)
+
+            # YAML header?
+            elsif frontmatter && match = yaml.match(strict ? YAML_FRONTMATTER_REGEXP : FRONTMATTER_REGEXP)
               yaml, template = match[:yaml], match[:template]
-            end
+              safe_yaml_load(yaml, template, path, &block)
 
-            safe_yaml_load(yaml, template, path, &block)
+            elsif frontmatter
+              message = 'Your file requires a valid YAML or JSON header'
+              raise Locomotive::Steam::TemplateError.new(message, path, yaml, 0, nil)
+
+            # YAML by default
+            else
+              safe_yaml_load(yaml, template, path, &block)
+            end
           else
             Locomotive::Common::Logger.error "No #{path} file found"
             {}
@@ -46,18 +59,26 @@ module Locomotive::Steam
           end
         end
 
-        def safe_json_load(path)
-          return {} unless File.exists?(path)
-
-          json = File.read(path)
+        def safe_json_load(json, template, path, &block)
+          return {} if  json.blank?
 
           begin
-            MultiJson.load(json)
+            MultiJson.load(json).tap do |attributes|
+              block.call(attributes, template) if block_given?
+            end
           rescue MultiJson::ParseError => e
             raise Locomotive::Steam::JsonParsingError.new(e, path, json)
           end
         end
 
+        def safe_json_file_load(path)
+          return {} unless File.exists?(path)
+
+          json = File.read(path)
+
+          safe_json_load(json, nil, path)
+        end
+
         def template_extensions
           @extensions ||= %w(liquid haml)
         end

data/lib/locomotive/steam/adapters/filesystem/yaml_loaders/content_entry.rb

@@ -18,7 +18,7 @@ module Locomotive
             def load_list
               [].tap do |list|
                 each(content_type_slug) do |label, attributes, position|
-                  _attributes = { _position: position, _label: label.to_s }.merge(attributes)
+                  _attributes = { _position: position, _label: label.to_s }.merge(attributes || {})
 
                   modify_for_selects(_attributes)
                   modify_for_associations(_attributes)

data/lib/locomotive/steam/adapters/filesystem/yaml_loaders/page.rb

@@ -61,7 +61,7 @@ module Locomotive
             def load_data
               Dir.glob(File.join(data_path, '**', '*.json')).each do |filepath|
                 filepath  =~ /#{data_path}\/([a-z]+)\//
-                data      = safe_json_load(filepath)
+                data      = safe_json_file_load(filepath)
                 locale    = $1.to_sym
 
                 next unless locales.include?($1.to_sym)

data/lib/locomotive/steam/adapters/filesystem/yaml_loaders/section.rb

@@ -16,11 +16,22 @@ module Locomotive
 
             def load_list
               Dir.glob(File.join(path, "*.{#{template_extensions.join(',')}}")).map do |filepath|
-                slug = File.basename(filepath).split('.').first
-                build(filepath, slug.permalink)
+                load_file(filepath)
               end
             end
 
+            def load_file(filepath)
+              slug        = File.basename(filepath).split('.').first
+              attributes  = build(filepath, slug.permalink)
+
+              _load(filepath, true, true) do |definition, template|
+                attributes[:definition] = definition
+                attributes[:template]   = template
+              end
+
+              attributes
+            end
+
             def build(filepath, slug)
               {
                 name:           slug.humanize,
@@ -32,6 +43,7 @@ module Locomotive
             def path
               @path ||= File.join(site_path, 'app', 'views', 'sections')
             end
+
           end
         end
       end

data/lib/locomotive/steam/adapters/filesystem/yaml_loaders/site.rb

@@ -27,7 +27,7 @@ module Locomotive
             def load_from_env
               return {} if env == :local
 
-              safe_json_load(File.join(site_path, 'data', env.to_s, 'site.json')).symbolize_keys
+              safe_json_file_load(File.join(site_path, 'data', env.to_s, 'site.json')).symbolize_keys
             end
 
             def load_metafields_schema

data/lib/locomotive/steam/adapters/filesystem/yaml_loaders/translation.rb

@@ -26,7 +26,7 @@ module Locomotive
             end
 
             def _load_from_env
-              safe_json_load(File.join(site_path, 'data', env.to_s, 'translations.json'))
+              safe_json_file_load(File.join(site_path, 'data', env.to_s, 'translations.json'))
             end
 
             def path

data/lib/locomotive/steam/adapters/mongodb.rb

@@ -62,7 +62,7 @@ module Locomotive::Steam
     def base_url(mapper, scope, entity = nil)
       return nil if scope.site.nil?
 
-      # Note: mimic Carrierwave behaviour
+      # Note: mimic the Carrierwave behavior
       base = "/sites/#{scope.site._id.to_s}"
 
       case mapper.name

data/lib/locomotive/steam/entities/content_entry.rb

@@ -121,7 +121,6 @@ module Locomotive::Steam
         _cast_value(field)
       rescue Exception => e
         Locomotive::Common::Logger.info "[#{content_type.slug}][#{_label}] Unable to cast the \"#{name}\" field, reason: #{e.message}".yellow
-        puts e.message
         nil
       end
     end

data/lib/locomotive/steam/entities/site.rb

@@ -7,6 +7,9 @@ module Locomotive::Steam
     def initialize(attributes = {})
       super({
         cache_enabled:            false,
+        cache_control:            nil,
+        cache_vary:               nil,
+        bypass_browser_locale:    false,
         prefix_default_locale:    false,
         updated_at:               nil,
         content_version:          nil,
@@ -20,6 +23,7 @@ module Locomotive::Steam
         metafields_schema:        {},
         metafields:               nil,
         sections:                 nil,
+        sections_content:         nil,
         asset_host:               nil,
         routes:                   []
       }.merge(attributes))