locomotivecms_wagon 2.0.1 → 2.1.0.rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c16813277aecf384b3c2a2b8b3eeab3db1da8237
-  data.tar.gz: c031bdde8b3277407a0c45e840729e54b2254f9d
+  metadata.gz: 571f69b042f72f8bf9c9ac09260ed1f5f19af3e1
+  data.tar.gz: 199bdd8684cfc28ba142652e6652713ee8e633f8
 SHA512:
-  metadata.gz: a8ca25014447c4c0909a95fe53bf7869d3469cfd21c67af9a38a3a6201b91c0feaaf3901b7c0b579aaa9ec9de6653ebbfa8fc09afec754f9f02fd6e618931735
-  data.tar.gz: 9cd1c6e2702d962229a20c98a3f3e0be6a1b35bc17da1318644673fa834c8c5d9b13e7a95c183c79ae3c4b8314ce3881609ee59cf01975086fe4be69cb8dfd8d
+  metadata.gz: 13ee04e4560d5a032cd52e10774db4bd1e40e0d288e5bd58aad6b25334a83f4a0047b4c293361caf5f2db6afbbe2dfd23144b7939cbf0a9c26a5caa6f4f3a107
+  data.tar.gz: 40027558ba5aa6b28528be62b6496ea11fcf76d3e77dc158d8b20975c805bc2ba26dd469c88a04914068828cc8c79e54c517788c4c1844f9d574e66888cfa56a

data/Gemfile

@@ -6,9 +6,9 @@ gemspec
 gem 'rb-fsevent', '~> 0.9.1'
 
 # Development
-# gem 'locomotivecms_steam', github: 'locomotivecms/steam', ref: 'ee5b98e', require: false
-# gem 'locomotivecms_coal', github: 'locomotivecms/coal', ref: '32b2844', require: false
-# gem 'locomotivecms_common', github: 'locomotivecms/common', ref: '3046b79893', require: false
+# gem 'locomotivecms_common', github: 'locomotivecms/common', ref: '257047b', require: false
+# gem 'locomotivecms_coal',   github: 'locomotivecms/coal',   ref: 'f4ff435', require: false
+# gem 'locomotivecms_steam',  github: 'locomotivecms/steam',  ref: '62c274f', require: false
 
 # Local development
 # gem 'locomotivecms_coal', path: '../gems/coal', require: false

data/generators/blank/config/metafields_schema.yml

@@ -0,0 +1,56 @@
+# Site metafield schema
+#
+# Syntax:
+#
+# - <namespace_1>: # no empty spaces, only digits and underscores
+#   label: <my label> # used as the label of a tab in the back-office
+#   # label: # if you want to provide the label in another language (back-office)
+#   #   en: <your label in English if the local of the current user is English>
+#   #   fr: <your label in French>
+#   position: <0..n> # position of the tab in the menu
+#   fields:
+#     <name_1>:
+#       label: <my label> # used as the label of the HTML input. Use a hash if you want it in another languages.
+#       hint: <my hint> # used as the hint of the HTML input. Use a hash if you want it in another languages.
+#       type: <string|text|integer|float|file|image|boolean|select|color>
+#       localized: <true|false> # if the value is scoped by the current locale when rendering the site.
+#       position: <0..n> # position of the input in the form
+#       select_options: [array]
+#       # select_options:
+#       #   <option_value_1>: <label> # use a hash instead if you want it in another languages.
+#       #   <option_value_2>: <label> # use a hash instead if you want it in another languages.
+#     # <name_2>:
+#     #   ...
+#
+# - <namespace_2>:
+#   # ...
+#
+#
+# Simple example:
+#
+# shop:
+#   label: My shop location
+#   fields:
+#     address:
+#       type: string
+#       hint: "Ex: 7 allee Albert Camus"
+#     city:
+#       type: string
+#       hint: "Chicago, Paris, Blagnac, Toulouse"
+#     zip_code:
+#       type: string
+#       hint: "Digits only"
+#     hours:
+#       type: text
+#       hint: "Free text here"
+# theme:
+#   fields:
+#     background_image:
+#       type: image
+#       hint: full screen image (min: 3000px x 3000px)
+#     link_color:
+#       type: color
+#     font:
+#       type: select
+#       select_options: ['helvetica', 'Noto']
+

data/generators/blank/config/site.yml.tt

@@ -26,3 +26,17 @@ locales: [en]
 seo_title: <%= @name %>
 meta_keywords: "some meta keywords"
 meta_description: "some meta description"
+
+# Each site can have its own set of custom properties organized in namespaces.
+# First, define namespaces and their fields in the config/metafields_schema.yml file.
+# Finally, set default values below as described in the example.
+# You can access them in your liquid templates and snippets:
+#   {{ site.metafields.<namespace>.<field> }}
+#
+# Example:
+#
+# metafields:
+#   shop:
+#     address: 700 South Laflin Street
+#   theme:
+#     background_image: "/samples/background.png"

data/generators/bootstrap/config/metafields_schema.yml

@@ -0,0 +1,56 @@
+# Site metafield schema
+#
+# Syntax:
+#
+# - <namespace_1>: # no empty spaces, only digits and underscores
+#   label: <my label> # used as the label of a tab in the back-office
+#   # label: # if you want to provide the label in another language (back-office)
+#   #   en: <your label in English if the local of the current user is English>
+#   #   fr: <your label in French>
+#   position: <0..n> # position of the tab in the menu
+#   fields:
+#     <name_1>:
+#       label: <my label> # used as the label of the HTML input. Use a hash if you want it in another languages.
+#       hint: <my hint> # used as the hint of the HTML input. Use a hash if you want it in another languages.
+#       type: <string|text|integer|float|file|image|boolean|select|color>
+#       localized: <true|false> # if the value is scoped by the current locale when rendering the site.
+#       position: <0..n> # position of the input in the form
+#       select_options: [array]
+#       # select_options:
+#       #   <option_value_1>: <label> # use a hash instead if you want it in another languages.
+#       #   <option_value_2>: <label> # use a hash instead if you want it in another languages.
+#     # <name_2>:
+#     #   ...
+#
+# - <namespace_2>:
+#   # ...
+#
+#
+# Simple example:
+#
+# shop:
+#   label: My shop location
+#   fields:
+#     address:
+#       type: string
+#       hint: "Ex: 7 allee Albert Camus"
+#     city:
+#       type: string
+#       hint: "Chicago, Paris, Blagnac, Toulouse"
+#     zip_code:
+#       type: string
+#       hint: "Digits only"
+#     hours:
+#       type: text
+#       hint: "Free text here"
+# theme:
+#   fields:
+#     background_image:
+#       type: image
+#       hint: full screen image (min: 3000px x 3000px)
+#     link_color:
+#       type: color
+#     font:
+#       type: select
+#       select_options: ['helvetica', 'Noto']
+

data/generators/bootstrap/config/site.yml.tt

@@ -26,3 +26,17 @@ locales: [en]
 seo_title: <%= @name %>
 meta_keywords: "some meta keywords"
 meta_description: "some meta description"
+
+# Each site can have its own set of custom properties organized in namespaces.
+# First, define namespaces and their fields in the config/metafields_schema.yml file.
+# Finally, set default values below as described in the example.
+# You can access them in your liquid templates and snippets:
+#   {{ site.metafields.<namespace>.<field> }}
+#
+# Example:
+#
+# metafields:
+#   shop:
+#     address: 700 South Laflin Street
+#   theme:
+#     background_image: "/samples/background.png"

data/generators/foundation5/config/metafields_schema.yml

@@ -0,0 +1,56 @@
+# Site metafield schema
+#
+# Syntax:
+#
+# - <namespace_1>: # no empty spaces, only digits and underscores
+#   label: <my label> # used as the label of a tab in the back-office
+#   # label: # if you want to provide the label in another language (back-office)
+#   #   en: <your label in English if the local of the current user is English>
+#   #   fr: <your label in French>
+#   position: <0..n> # position of the tab in the menu
+#   fields:
+#     <name_1>:
+#       label: <my label> # used as the label of the HTML input. Use a hash if you want it in another languages.
+#       hint: <my hint> # used as the hint of the HTML input. Use a hash if you want it in another languages.
+#       type: <string|text|integer|float|file|image|boolean|select|color>
+#       localized: <true|false> # if the value is scoped by the current locale when rendering the site.
+#       position: <0..n> # position of the input in the form
+#       select_options: [array]
+#       # select_options:
+#       #   <option_value_1>: <label> # use a hash instead if you want it in another languages.
+#       #   <option_value_2>: <label> # use a hash instead if you want it in another languages.
+#     # <name_2>:
+#     #   ...
+#
+# - <namespace_2>:
+#   # ...
+#
+#
+# Simple example:
+#
+# shop:
+#   label: My shop location
+#   fields:
+#     address:
+#       type: string
+#       hint: "Ex: 7 allee Albert Camus"
+#     city:
+#       type: string
+#       hint: "Chicago, Paris, Blagnac, Toulouse"
+#     zip_code:
+#       type: string
+#       hint: "Digits only"
+#     hours:
+#       type: text
+#       hint: "Free text here"
+# theme:
+#   fields:
+#     background_image:
+#       type: image
+#       hint: full screen image (min: 3000px x 3000px)
+#     link_color:
+#       type: color
+#     font:
+#       type: select
+#       select_options: ['helvetica', 'Noto']
+

data/generators/foundation5/config/site.yml.tt

@@ -26,3 +26,17 @@ locales: [en]
 seo_title: <%= @name %>
 meta_keywords: "some meta keywords"
 meta_description: "some meta description"
+
+# Each site can have its own set of custom properties organized in namespaces.
+# First, define namespaces and their fields in the config/metafields_schema.yml file.
+# Finally, set default values below as described in the example.
+# You can access them in your liquid templates and snippets:
+#   {{ site.metafields.<namespace>.<field> }}
+#
+# Example:
+#
+# metafields:
+#   shop:
+#     address: 700 South Laflin Street
+#   theme:
+#     background_image: "/samples/background.png"

data/generators/site_metafields/schema.yml.tt

@@ -0,0 +1,56 @@
+# Site metafield schema
+#
+# Syntax:
+#
+# - <namespace_1>: # no empty spaces, only digits and underscores
+#   label: <my label> # used as the label of a tab in the back-office
+#   # label: # if you want to provide the label in another language (back-office)
+#   #   en: <your label in English if the local of the current user is English>
+#   #   fr: <your label in French>
+#   position: <0..n> # position of the tab in the menu
+#   fields:
+#     <name_1>:
+#       label: <my label> # used as the label of the HTML input. Use a hash if you want it in another languages.
+#       hint: <my hint> # used as the hint of the HTML input. Use a hash if you want it in another languages.
+#       type: <string|text|integer|float|file|image|boolean|select|color>
+#       localized: <true|false> # if the value is scoped by the current locale when rendering the site.
+#       position: <0..n> # position of the input in the form
+#       select_options: [array]
+#       # select_options:
+#       #   <option_value_1>: <label> # use a hash instead if you want it in another languages.
+#       #   <option_value_2>: <label> # use a hash instead if you want it in another languages.
+#     # <name_2>:
+#     #   ...
+#
+# - <namespace_2>:
+#   # ...
+#
+#
+# Simple example:
+#
+# shop:
+#   label: My shop location
+#   fields:
+#     address:
+#       type: string
+#       hint: "Ex: 7 allee Albert Camus"
+#     city:
+#       type: string
+#       hint: "Chicago, Paris, Blagnac, Toulouse"
+#     zip_code:
+#       type: string
+#       hint: "Digits only"
+#     hours:
+#       type: text
+#       hint: "Free text here"
+# theme:
+#   fields:
+#     background_image:
+#       type: image
+#       hint: full screen image (min: 3000px x 3000px)
+#     link_color:
+#       type: color
+#     font:
+#       type: select
+#       select_options: ['helvetica', 'Noto']
+

data/lib/locomotive/wagon/cli.rb

@@ -151,6 +151,15 @@ module Locomotive
           end
         end
 
+        desc 'site_metafields', 'Generate the missing file to describe the site metafields'
+        def site_metafields
+          force_color_if_asked(options)
+
+          if path = check_path!
+            Locomotive::Wagon.generate :site_metafields, [path], self.options
+          end
+        end
+
         protected
 
         # Read the YAML config file of a Locomotive site.
@@ -268,7 +277,8 @@ module Locomotive
         option :daemonize, aliases: '-d', type: 'boolean', default: false, desc: 'Run daemonized Thin server in the background'
         option :live_reload_port, aliases: '-l', type: 'string', default: '35729', desc: 'The port the LiveReload javascript lib needs to listen for changes (35729 by default)'
         option :force, aliases: '-f', type: 'boolean', default: false, desc: 'Stop the current daemonized Thin server if found before starting a new one'
-        option :verbose, aliases: '-v', type: 'boolean', default: false, desc: 'display the full error stack trace if an error occurs'
+        option :verbose, aliases: '-v', type: 'boolean', default: false, desc: 'Display the full error stack trace if an error occurs'
+        option :debug, type: 'boolean', default: false, desc: 'Display some debugging information (rack middleware stack)'
         def serve(path = '.')
           force_color_if_asked(options)
           if check_path!(path)

data/lib/locomotive/wagon/commands/concerns/steam_concern.rb

@@ -8,9 +8,10 @@ module Locomotive::Wagon
       return @steam_services if @steam_services
 
       Locomotive::Steam.configure do |config|
-        config.mode         = :test
-        config.adapter      = { name: :filesystem, path: path }
-        config.asset_path   = File.expand_path(File.join(path, 'public'))
+        config.mode           = :test
+        config.adapter        = { name: :filesystem, path: path }
+        config.asset_path     = File.expand_path(File.join(path, 'public'))
+        config.minify_assets  = true
       end
 
       @steam_services = Locomotive::Steam::Services.build_instance.tap do |services|

data/lib/locomotive/wagon/commands/pull_command.rb

@@ -62,7 +62,7 @@ module Locomotive::Wagon
     end
 
     def print_result_message
-      shell.say "\n\nThe templates, theme assets and content have been pulled from the remote version.", :green
+      shell.try(:say, "\n\nThe templates, theme assets and content have been pulled from the remote version.", :green)
       true
     end
 

data/lib/locomotive/wagon/commands/pull_sub_commands/concerns/assets_concern.rb

@@ -1,5 +1,7 @@
 require 'tempfile'
 
+require_relative '../../../tools/yaml_ext.rb'
+
 module Locomotive::Wagon
 
   module AssetsConcern
@@ -30,6 +32,12 @@ module Locomotive::Wagon
       end
     end
 
+    def replace_asset_urls_in_hash(hash)
+      Locomotive::Wagon::YamlExt.transform(hash) do |value|
+        replace_asset_urls(value)
+      end
+    end
+
     private
 
     def find_unique_filepath(filepath, binary_file, index = 1)

data/lib/locomotive/wagon/commands/pull_sub_commands/pull_site_command.rb

@@ -3,7 +3,7 @@ module Locomotive::Wagon
   class PullSiteCommand < PullBaseCommand
 
     def _pull
-      attributes = current_site.attributes.slice('name', 'locales', 'domains', 'timezone', 'seo_title', 'meta_keywords', 'meta_description', 'picture_thumbnail_url')
+      attributes = current_site.attributes.slice('name', 'locales', 'domains', 'timezone', 'seo_title', 'meta_keywords', 'meta_description', 'picture_thumbnail_url', 'metafields', 'metafields_schema')
 
       locales.each_with_index do |locale, index|
         if index == 0
@@ -13,6 +13,10 @@ module Locomotive::Wagon
         end
       end if locales.size > 1
 
+      decode_metafields(attributes)
+
+      write_metafields_schema(attributes.delete('metafields_schema'))
+
       write_icon(attributes.delete('picture_thumbnail_url'))
 
       write_to_file(File.join('config', 'site.yml')) do
@@ -35,6 +39,25 @@ module Locomotive::Wagon
       end
     end
 
+    def write_metafields_schema(schema)
+      return if schema.blank?
+
+      File.open(File.join(path, 'config', 'metafields_schema.yml'), 'wb') do |file|
+        file.write JSON.parse(schema).to_yaml
+      end
+    end
+
+    def decode_metafields(attributes)
+      metafields = attributes['metafields']
+
+      return if metafields.blank?
+
+      # metafields come under a JSON string format.
+      metafields = JSON.parse(metafields)
+
+      attributes['metafields'] = replace_asset_urls_in_hash(metafields)
+    end
+
     def localized_attributes(&block)
       %w(seo_title meta_keywords meta_description).each do |name|
         yield(name)

data/lib/locomotive/wagon/commands/push_sub_commands/push_site_command.rb

@@ -7,7 +7,9 @@ module Locomotive::Wagon
     end
 
     def decorate(entity)
-      UpdateSiteDecorator.new(entity)
+      UpdateSiteDecorator.new(entity).tap do |decorator|
+        decorator.__content_assets_pusher__ = self.content_assets_pusher
+      end
     end
 
     def persist(decorated_entity)

data/lib/locomotive/wagon/commands/serve_command.rb

@@ -28,6 +28,8 @@ module Locomotive::Wagon
         setup_signals
 
         show_start_message
+
+        show_rack_middleware_stack if options[:debug]
       end
 
       # if a page, a content type or any resources of the site is getting modified,
@@ -132,6 +134,9 @@ module Locomotive::Wagon
     end
 
     def configure_logger
+      # make sure the logs folder exist and get rid of that ugly error message if it doesn't
+      FileUtils.mkdir_p(File.join(path, 'log'))
+
       Locomotive::Common.reset
       Locomotive::Common.configure do |config|
         logger = options[:daemonize] ? log_file : nil
@@ -176,6 +181,16 @@ module Locomotive::Wagon
       File.expand_path(File.join(path, 'log', 'wagon.log'))
     end
 
+    def show_rack_middleware_stack
+      shell.say "[Rendering stack]".colorize(color: :light_white, background: :blue)
+
+      Locomotive::Steam.configuration.middleware.list.each do |middleware|
+        shell.say "\t" + middleware.first.first.inspect
+      end
+
+      shell.say "\n"
+    end
+
     def show_start_message
       shell.say "Your site is served now.\nBrowse http://#{options[:host]}:#{options[:port]}\n\n", :green
     end

data/lib/locomotive/wagon/commands/sync_command.rb

@@ -15,7 +15,7 @@ module Locomotive::Wagon
 
   class SyncCommand < Struct.new(:env, :path, :options, :shell)
 
-    RESOURCES = %w(pages content_entries translations).freeze
+    RESOURCES = %w(site pages content_entries translations).freeze
 
     include ApiConcern
     include DeployFileConcern

data/lib/locomotive/wagon/commands/sync_sub_commands/sync_site_command.rb

@@ -0,0 +1,31 @@
+module Locomotive::Wagon
+
+  class SyncSiteCommand < PullSiteCommand
+
+    include Locomotive::Wagon::BaseConcern
+
+    def _sync
+      attributes = current_site.attributes.slice('metafields')
+
+      # convert to hash + download assets and use the asset local version
+      decode_metafields(attributes)
+
+      # modify the config/site.yml file accordingly
+      replace_metafields_in_file(attributes['metafields'])
+    end
+
+    protected
+
+    def replace_metafields_in_file(metafields)
+      return if metafields.blank?
+
+      content = File.read(File.join(path, 'config', 'site.yml'))
+
+      content.gsub!(/^metafields:\n.+\n\s+.*?\n/m, { 'metafields' => metafields }.to_yaml.to_s.gsub(/\A---\n/, ''))
+
+      File.write(File.join(path, 'config', 'site.yml'), content)
+    end
+
+  end
+
+end

data/lib/locomotive/wagon/decorators/concerns/persist_assets_concern.rb

@@ -1,3 +1,5 @@
+require_relative '../../tools/yaml_ext.rb'
+
 module Locomotive::Wagon
 
   module PersistAssetsConcern
@@ -11,6 +13,12 @@ module Locomotive::Wagon
       end
     end
 
+    def replace_with_content_assets_in_hash!(hash)
+      Locomotive::Wagon::YamlExt.transform(hash) do |value|
+        replace_with_content_assets!(value)
+      end
+    end
+
     def asset_io(local_path)
       __content_assets_pusher__.decorate(local_path).source
     end

data/lib/locomotive/wagon/decorators/content_entry_decorator.rb

@@ -45,6 +45,7 @@ module Locomotive
       end
 
       def decorate_date_time_field(value)
+        return nil if value.nil?
         value.utc.try(:iso8601)
       end
 

data/lib/locomotive/wagon/decorators/site_decorator.rb

@@ -4,11 +4,23 @@ module Locomotive
     class SiteDecorator < SimpleDelegator
 
       include ToHashConcern
+      include PersistAssetsConcern
+
+      attr_accessor :__content_assets_pusher__
 
       def domains
         (__getobj__.domains || []) - ['localhost']
       end
 
+      def metafields_schema
+        self[:metafields_schema].try(:to_json)
+      end
+
+      def metafields
+        replace_with_content_assets_in_hash!(self[:metafields])
+        self[:metafields].try(:to_json)
+      end
+
       def picture
         picture_path = __getobj__.picture
         if picture_path && File.exists?(picture_path)
@@ -18,7 +30,7 @@ module Locomotive
         end
       end
 
-      %i(robots_txt timezone seo_title meta_keywords meta_description metafields_schema metafields).each do |name|
+      %i(robots_txt timezone seo_title meta_keywords meta_description).each do |name|
         define_method(name) do
           self[name]
         end

data/lib/locomotive/wagon/generators/site_metafields.rb

@@ -0,0 +1,54 @@
+require 'thor/group'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Locomotive
+  module Wagon
+    module Generators
+      class SiteMetafields < Thor::Group
+
+        include Thor::Actions
+        include Locomotive::Wagon::CLI::ForceColor
+
+        argument :target_path # path to the site
+
+        def create_metafields_schema
+          path = File.join(target_path, 'config', 'metafields_schema.yml')
+
+          template 'schema.yml.tt', path
+        end
+
+        def add_instructions
+          append_to_file 'config/site.yml', <<-EOF
+
+# Each site can have its own set of custom properties organized in namespaces.
+# First, define namespaces and their fields in the config/metafields_schema.yml file.
+# Finally, set default values below as described in the example.
+# You can access them in your liquid templates and snippets:
+#   {{ site.metafields.<namespace>.<field> }}
+#
+# Example:
+#
+# metafields:
+#   shop:
+#     address: 700 South Laflin Street
+#   theme:
+#     background_image: "/samples/background.png"
+EOF
+        end
+
+        def self.source_root
+          File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'generators', 'site_metafields')
+        end
+
+        protected
+
+        def snippets_path
+          File.join(target_path, 'app', 'views', 'snippets')
+        end
+
+      end
+
+    end
+  end
+end

data/lib/locomotive/wagon/tools/yaml_ext.rb

@@ -0,0 +1,21 @@
+module Locomotive
+  module Wagon
+
+    module YamlExt
+
+      def self.transform(hash, &block)
+        return if hash.blank? || !hash.respond_to?(:has_key?)
+
+        hash.each do |key, value|
+          case value
+          when Hash   then transform(value, &block)
+          when Array  then value.each { |v| transform(v, &block) }
+          when String then hash[key] = yield(value)
+          end
+        end
+      end
+
+    end
+
+  end
+end

data/lib/locomotive/wagon/version.rb

@@ -1,5 +1,5 @@
 module Locomotive
   module Wagon
-    VERSION = '2.0.1'
+    VERSION = '2.1.0.rc3'
   end
 end