locomotivecms_wagon 3.0.0.rc0 → 3.0.0

data/generators/site_metafields/schema.yml.tt

@@ -14,6 +14,7 @@
 #       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|image|boolean|select|color>
 #       localized: <true|false> # if the value is scoped by the current locale when rendering the site.
+#       sample: <any value> # value only used in Wagon for testing purpose. Will not be deployed
 #       position: <0..n> # position of the input in the form
 #       select_options: [array]
 #       # select_options:
@@ -34,15 +35,19 @@
 #     address:
 #       type: string
 #       hint: "Ex: 7 allee Albert Camus"
+#       sample: "700 S Laflin St"
 #     city:
 #       type: string
 #       hint: "Chicago, Paris, Blagnac, Toulouse"
+#       sample: "Chicago"
 #     zip_code:
 #       type: string
 #       hint: "Digits only"
+#       sample: "60607"
 #     hours:
 #       type: text
 #       hint: "Free text here"
+#       sample: "6:00am - 8:00pm"
 # theme:
 #   fields:
 #     background_image:

data/generators/webpack/app/assets/javascripts/sections/_manager.js

@@ -11,7 +11,7 @@ class Manager {
 
   start() {
     this.eachType((type, actions) => {
-      this.queryAll(`.locomotive-section[data-locomotive-section-type="${type}"]`).forEach((section, index) => {
+      this.queryAll(`[data-locomotive-section-type="${type}"]`).forEach((section, index) => {
         this.runAction(actions, 'load', section);
       });
     });
@@ -40,7 +40,8 @@ class Manager {
 
   applyRuleToEvent(actionName, event) {
     const { sectionId, blockId } = event.detail;
-    const section   = document.getElementById(`locomotive-section-${sectionId}`);
+    const section   = document.getElementById(`locomotive-section-${sectionId}`) ||
+                      this.queryOne(`[data-locomotive-section-id="${sectionId}"]`);
     const type      = section.getAttribute('data-locomotive-section-type');
     const block     = this.queryOne(`[data-locomotive-block="section-${sectionId}-block-${blockId}"]`, section);
 

data/generators/webpack/package.json.tt

@@ -1,5 +1,5 @@
 {
-  "name": "Wagon assets",
+  "name": "WagonAssets",
   "version": "1.0.0",
   "description": "Assets source for the Wagon site",
   "main": "index.js",

data/lib/locomotive/wagon/cli.rb

@@ -232,15 +232,14 @@ module Locomotive
         end
 
         desc 'init NAME [PATH] [GENERATOR_OPTIONS]', 'Create a brand new site'
-        method_option :template,    aliases: '-t', type: 'string', default: 'blank', desc: 'instead of building from a blank site, you can also have a pre-fetched site from a template (see the templates command)'
         method_option :lib,         aliases: '-l', type: 'string', desc: 'Path to an external ruby lib or generator'
-        method_option :skip_bundle, type: 'boolean', default: false, desc: "Don't run bundle install"
+        method_option :skip_bundle, type: 'boolean', default: true, desc: "Don't run bundle install"
         method_option :verbose,     aliases: '-v', type: 'boolean', default: false, desc: 'display the full error stack trace if an error occurs'
         def init(name, path = '.', *generator_options)
           force_color_if_asked(options)
           require 'locomotive/wagon/generators/site'
           require File.expand_path(options[:lib]) if options[:lib]
-          generator = Locomotive::Wagon::Generators::Site.get(options[:template])
+          generator = Locomotive::Wagon::Generators::Site.get(:blank)
           if generator.nil?
             say "Unknown site template '#{options[:template]}'", :red
             exit(1)
@@ -340,6 +339,7 @@ module Locomotive
         option :resources, aliases: '-r', type: 'array', default: nil, desc: 'Only push the resource(s) passed in argument'
         option :filter, aliases: '-f', type: 'array', default: nil, desc: 'Push specific resource entries'
         option :data, aliases: '-d', type: 'boolean', default: false, desc: 'Push the content entries and the editable elements (by default, they are not)'
+        option :env, aliases: '-e', type: 'string', default: 'local', desc: 'The env used to the data of the pages and content entries'
         option :shell, type: 'boolean', default: true, desc: 'Use shell to ask for missing connection information like the site handle (in this case, take a random one)'
         option :verbose, aliases: '-v', type: 'boolean', default: false, desc: 'display the full error stack trace if an error occurs'
         def deploy(env, path = '.')
@@ -416,26 +416,16 @@ module Locomotive
         #
         def print_next_instructions_when_site_created(name, path, skip_bundle)
           say "\nCongratulations, your site \"#{name}\" has been created successfully !", :green
-          say 'Next steps:', :bold
-
-          next_instructions = <<-BASH
-  cd #{path}/#{name}
-
-  #{'bundle install' unless skip_bundle}
-  #{'bundle exec' unless skip_bundle} wagon serve
-
-  # In a another terminal
-  yarn
-  yarn start
-
-  open http://0.0.0.0:3333
-BASH
-
-          # next_instructions = "\tcd #{path}/#{name}\n\t"
-          # next_instructions += "bundle install\n\t" unless skip_bundle
-          # next_instructions += "#{'bundle exec ' unless skip_bundle}wagon serve\n\topen http://0.0.0.0:3333"
-
-          say next_instructions
+          say "\nNext steps:\n", :bold
+          say "\n# Run the local web server", :on_blue
+          say "\n\tcd #{path}/#{name}"
+          say "\tbundle install" unless skip_bundle
+          say "\t#{'bundle exec ' unless skip_bundle}wagon serve"
+          say "\n# Compile assets (in a another terminal)", :on_blue
+          say "\n\tyarn"
+          say "\tyarn start"
+          say "\n# Preview your site!", :on_blue
+          say "\n\topen http://0.0.0.0:3333\n\n", :bold
         end
 
         # Print the exception.

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

@@ -11,6 +11,7 @@ module Locomotive::Wagon
 
     # Instance of the API client to request resources of a site: pages, theme_assets, ...etc.
     def api_site_client(connection)
+      return if connection.nil?
       return @api_site_client if @api_site_client
 
       _host, _credentials = connection['host'], connection.slice('email', 'api_key', 'password')

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

@@ -9,7 +9,7 @@ module Locomotive::Wagon
 
       Locomotive::Steam.configure do |config|
         config.mode           = :test
-        config.adapter        = { name: :filesystem, path: path, env: :local }
+        config.adapter        = { name: :filesystem, path: path, env: options[:env]&.to_sym || :local }
         config.asset_path     = File.expand_path(File.join(path, 'public'))
         config.minify_assets  = false
       end

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

@@ -9,8 +9,8 @@ module Locomotive::Wagon
     include DeployFileConcern
 
     SITE_RESOURCE     = 'site'
-    SINGLE_RESOURCES  = %w(page content_type snippet translation).freeze
-    ALL_RESOURCES     = %w(content_types snippets theme_assets translations).freeze
+    SINGLE_RESOURCES  = %w(page content_type snippet section translation).freeze
+    ALL_RESOURCES     = %w(content_types snippets theme_assets sections translations).freeze
 
     # @param [ String ] env The environment to delete from
     # @param [ String ] path The path to a wagon site to delete from

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

@@ -7,7 +7,12 @@ module Locomotive::Wagon
     end
 
     def generate
-      Bundler.require 'misc'
+      begin
+        ::Bundler.require 'misc'
+      rescue Exception => e
+        # Bundler is not defined or there is an issue
+        # with one of the gems in the misc group
+      end
 
       generator = generator_klass.new(args, options, { behavior: :skip })
       generator.destination_root = args.last

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

@@ -36,6 +36,14 @@ module Locomotive::Wagon
 
       api_client = build_api_site_client(connection_information)
 
+      return if api_client.nil?
+
+      # Ask for a confirmation (Warning) if we deploy with the -d option
+      # since it alters content on the remote engine
+      if options[:data]
+        return unless ask_for_performing("Warning! You're about to deploy data which will alter the content of your site.")
+      end
+
       if options[:verbose]
         PushLogger.new
         _push(api_client)
@@ -90,9 +98,14 @@ module Locomotive::Wagon
         # the deployment env exists and contains all the information we need to move on
         information
       else
+        # warn the user that we're going to create a new site. Ask her/him if we continue
+        return unless ask_for_performing('You are about to deploy a new site')
+
         # mandatory to sign in
         load_credentials_from_netrc
 
+        return if self.credentials.nil?
+
         # create the remote site on the platform
         site = create_remote_site
 
@@ -131,7 +144,9 @@ module Locomotive::Wagon
       # retrieve email + api_key. If no entry present in the .netrc, raise an error
       self.credentials = read_credentials_from_netrc(self.api_host)
 
-      raise 'You need to run `wagon auth` before going further' if self.credentials.nil?
+      if self.credentials.nil?
+        shell.say "Sorry, we were unable to find the credentials for this platform.\nPlease first login using the \"bundle exec wagon auth\"", :yellow
+      end
     end
 
     def ask_for_platform_url
@@ -155,11 +170,12 @@ module Locomotive::Wagon
       begin
         attributes = @api_site_client.current_site.get.attributes
       rescue Locomotive::Coal::UnknownResourceError
-        raise 'Sorry, we were unable to find your site on the remote platform. Check the information in your config/deploy.yml file.'
+        shell.say 'Sorry, we were unable to find your site on the remote platform. Check the information in your config/deploy.yml file.', :red
+        raise 'Unable to find your site on the remote platform'
       end
 
       _site         = Locomotive::Steam::Site.new(attributes)
-      @remote_site  = SiteDecorator.new(_site)
+      @remote_site  = RemoteSiteDecorator.new(_site)
     end
 
     def require_misc_gems
@@ -168,6 +184,17 @@ module Locomotive::Wagon
       Bundler.require 'misc'
     end
 
+    def ask_for_performing(message)
+      shell.say(message, :yellow)
+
+      unless shell.yes?("Are you sure you want to perform this action? (answer yes or no)")
+        shell.say("Deployment canceled!", :yellow)
+        return false
+      end
+
+      true
+    end
+
     def print_result_message
       shell.say "\n\nYour site has been deployed.", :green
 

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

@@ -126,9 +126,13 @@ module Locomotive::Wagon
 
       template_path = entity.template_path[default_locale]
 
+      # no template path (use case: deploying new pages from a different env)
+      return true if template_path.nil?
+
       # not localized?
       return true if template_path == false
 
+
       # part of the filter?
       _path = template_path.gsub('./app/views/pages/', '')
       !@only_entities.any? { |regexp| regexp.match(_path) }

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

@@ -7,9 +7,7 @@ module Locomotive::Wagon
     end
 
     def decorate(entity)
-      UpdateSiteDecorator.new(entity).tap do |decorator|
-        decorator.__content_assets_pusher__ = self.content_assets_pusher
-      end
+      UpdateSiteDecorator.new(entity, default_locale, path, content_assets_pusher)
     end
 
     def persist(decorated_entity)
@@ -18,6 +16,9 @@ module Locomotive::Wagon
       # push the picture only if there is no existing remote picture
       _attributes.delete(:picture) if remote_site['picture_url'].present?
 
+      # timezone can be pushed with the -d option
+      _attributes.delete(:timezone) unless with_data?
+
       # push the locales as long as there is no content on the remote site yet
       _attributes.delete(:locales) if remote_site.edited?
 

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

@@ -18,31 +18,28 @@ module Locomotive::Wagon
     end
 
     def start
-      # make sure the Thin server is not running
+      # make sure a server is not running
       stop(true) if options[:force]
 
       # Steam is our rendering engine
       require_steam
 
-      if options[:daemonize]
-        daemonize
-      else
-        setup_signals
+      setup_signals
 
-        show_start_message
+      show_start_message
 
-        show_rack_middleware_stack if options[:debug]
-      end
+      show_rack_middleware_stack if options[:debug]
 
       # if a page, a content type or any resources of the site is getting modified,
       # then the cache of Steam will be cleared.
-      listen if @parent_pid.nil? || Process.pid != @parent_pid
+      listen
 
       # let's start!
-      server.start
-
-    rescue SystemExit => e
-      show_start_message if @parent_pid == Process.pid
+      begin
+        server.start
+      rescue NoMethodError # Prevent the NilClass error from Puma to be displayed
+        nil
+      end
     end
 
     def stop(force = false)
@@ -75,7 +72,7 @@ module Locomotive::Wagon
 
       Locomotive::Steam.configure do |config|
         config.mode           = :test
-        config.adapter        = { name: :filesystem, path: File.expand_path(path), env: options[:env].to_sym }
+        config.adapter        = { name: :filesystem, path: File.expand_path(path), env: options[:env]&.to_sym || :local }
         config.asset_path     = File.expand_path(File.join(path, 'public'))
         config.minify_assets  = false
 
@@ -93,52 +90,36 @@ module Locomotive::Wagon
       Bundler.require 'misc'
     end
 
-    def daemonize
-      # very important to get the parent pid in order to differenciate the sub process from the parent one
-      @parent_pid = Process.pid
-
-      # The Daemons gem closes all file descriptors when it daemonizes the process. So any logfiles that were opened before the Daemons block will be closed inside the forked process.
-      # So, close the current logger and set it up again when daemonized.
-      Locomotive::Common::Logger.close
-
-      server.log_file = server_log_file
-      server.pid_file = server_pid_file
-
-      server.daemonize
-
-      # A "new logger" inside the daemon.
-      configure_logger if Process.pid != @parent_pid
-    end
-
     def listen
-      require_relative '../tools/listen'
-      require 'locomotive/steam/adapters/filesystem/simple_cache_store'
+      require 'puma/plugin'
 
-      cache = Locomotive::Steam::Adapters::Filesystem::SimpleCacheStore.new
+      Puma::Plugins.add_background -> {
+        require_relative '../tools/listen'
+        require 'locomotive/steam/adapters/filesystem/simple_cache_store'
 
-      Locomotive::Wagon::Listen.start(path, cache, options)
-    end
+        cache = Locomotive::Steam::Adapters::Filesystem::SimpleCacheStore.new
 
-    def server
-      @server ||= build_server
+        Locomotive::Wagon::Listen.start(path, cache, options)
+      }
     end
 
-    def build_server
-      # TODO: new feature -> pick the right Rack handler (Thin, Puma, ...etc)
-      require 'thin'
-
-      # Do not display the default Thin server startup message
-      Thin::Logging.logger = Logger.new(server_log_file)
-
-      # Thin in debug mode only if the THIN_DEBUG_ON has been set in the shell
-      Thin::Logging.debug = ENV['THIN_DEBUG_ON']
-
-      app = Locomotive::Steam.to_app
-
-      Thin::Server.new(options[:host], options[:port], { signals: false }, app).tap do |server|
-        server.threaded = true
-        server.log_file = server_log_file
-      end
+    def server
+      @server ||= build_puma_server
+    end
+
+    def build_puma_server
+      require 'rack/handler/puma'
+
+      Rack::Handler::Puma.run(Locomotive::Steam.to_app, {
+        daemon:           options[:daemonize],
+        pidfile:          server_pid_file,
+        redirect_stdout:  options[:daemonize] ? server_log_file : nil,
+        Threads:          ENV['PUMA_THREADS'] || '1:4',
+        Host:             options[:host],
+        Port:             options[:port],
+        Verbose:          ENV['PUMA_DEBUG_ON'] || false,
+        Silent:           true
+      })
     end
 
     def configure_logger

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

@@ -47,10 +47,12 @@ module Locomotive::Wagon
     private
 
     def sections_content(page)
+      return {} if page.sections_content.blank?
       JSON.parse(page.sections_content)
     end
 
     def sections_dropzone_content(page)
+      return [] if page.sections_dropzone_content.blank?
       JSON.parse(page.sections_dropzone_content)
     end
 

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

@@ -7,7 +7,7 @@ module Locomotive::Wagon
     def replace_with_content_assets!(text)
       return text if text.blank?
 
-      text.to_s.gsub(/([^a-zA-Z0-9]|^)(\/samples\/[\/a-zA-Z0-9_-]+\.[a-zA-Z0-9]+)/) do
+      text.to_s.gsub(/([^a-zA-Z0-9]|^)(\/samples\/[\/a-zA-Z0-9_-]+(\.[a-zA-Z0-9]+)*)/) do
         url = __content_assets_pusher__.persist($2) || $2
         $1 + url
       end

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

@@ -16,7 +16,8 @@ module Locomotive
           public_submission_enabled
           public_submission_accounts
           public_submission_title_template
-          entry_template display_settings filter_fields)
+          public_submission_email_attachments
+          recaptcha_required entry_template display_settings filter_fields)
       end
 
       def fields
@@ -58,6 +59,10 @@ module Locomotive
         self[:public_submission_title_template]
       end
 
+      def public_submission_email_attachments
+        self[:public_submission_email_attachments]
+      end
+
       def entry_template
         self[:entry_template]
       end
@@ -74,6 +79,10 @@ module Locomotive
         self[:tree_parent_field_name]
       end
 
+      def recaptcha_required
+        self[:recaptcha_required]
+      end
+
       def with_relationships?
         __getobj__.fields.associations.count > 0
       end