locomotivecms_wagon 3.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4afa7187e1d572da68484ff666c37873c60853ad6a1cfd926baf74ed84b8620d
-  data.tar.gz: 5ac5bbd400e61bd616e34d968d139450a2ab09c52ee380d7aebc47069d1fdf26
+  metadata.gz: 57c2e34dcbc2bebe704d87beae5cf7cba03f745b98213d24a241be72639ea695
+  data.tar.gz: bfce871397862b72e3c683f903c8e8eb2d0185a90774271ba4dfe62fa30c4a44
 SHA512:
-  metadata.gz: 396551c4762052faa7a1455e8e5a754412ce6bcaa26a651dd403918eca2e5f513849a7d07528662369ba6f0d1a1e41a504fb909751ae4990753f6170d334f92d
-  data.tar.gz: af779bab2277b73d3c2bf43b35e1d0a76ac79f4950ca9ed466f0ce5e01791a4429c5884fbf53f65737736067a27bd219904718536ee1b6109326bef9f1a7376f
+  metadata.gz: 3bc8a189495793048947446e05e95b417c0059f0518efc71b9d7b5d8c7e6d86ab5f0337d4e156b0c75b289bb9b35a7780af325cf695347bef1e25d941e241bfc
+  data.tar.gz: e98dbbb7f68c1b573b8e9924c6687c39c9c82039ea4125209651ed4781178f0032f914b01b4b532b07f30e7fc16603668e1f9358a3ecd7f9563fa6a04a613d6e

data/MIT-LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018 NoCoffee
+Copyright (c) 2019 NoCoffee
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/bin/wagon

@@ -1,12 +1,73 @@
 #!/usr/bin/env ruby
 
-# needed if you launch it without bundler
-$:.unshift(File.expand_path(File.dirname(__FILE__) + '/../lib'))
-$:.unshift(File.expand_path(File.dirname(__FILE__) + '/../vendor'))
+# Rbenv shims and the bundler/inline feature don't work quite well, at least in Ruby 2.5.0.
+#
+# The reasons is that Wagon rbenv shim activates all the gems of the Wagon gem.
+# When activating them, it might load versions of the gems different from
+# the ones specified by the gemfile statement.
+#
+# Hopefully, it just activates meaning it doesn't load them.
+# So the solution is simple: reset both the Gem loaded specs and the $LOAD_PATH variable.
+def reset_gem_specs!
+  return unless Gem.loaded_specs.keys.include?('locomotivecms_wagon')
+
+  core_gems = %w(did_you_mean).freeze
+
+  Gem.loaded_specs.values.each do |spec|
+    next if core_gems.include?(spec.name)
+    spec.full_require_paths.each do |path|
+      $LOAD_PATH.delete(path)
+    end
+
+    # Without this statement, bundler will raise the infamous "You have already activated ..."
+    Gem.loaded_specs.delete(spec.name)
+  end
+end
+
+if ENV["BUNDLE_BIN_PATH"]
+  # Wagon is launched within the Bundler context (basically with bundle exec wagon),
+  # do nothing since Bundler already took take care of loading the right gems.
+  ENV['WAGON_GEMFILE'] = '1'
+elsif ENV['WAGON_GEMFILE']
+  reset_gem_specs!
+
+  # For LocomotiveCMS developers who want to run a local version of Wagon
+  # with gems like Steam, Coal and Common pointing to the local sources
+  puts "!!!WARNING!!! Using Wagon described in the following Gemfile: #{ENV['WAGON_GEMFILE']}"
+
+  ENV['BUNDLE_GEMFILE'] ||= ENV['WAGON_GEMFILE']
+
+  require 'bundler'
+  Bundler.require
+else
+  reset_gem_specs!
+
+  # Almost of all the users will rely on the gems described in
+  # the gemspec of the current Wagon version.
+  require 'bundler/inline'
+
+  gemfile do
+    source 'https://rubygems.org'
+
+    gemspec path: File.dirname(__FILE__) + '/..'
+
+    # Mac OS X
+    gem 'rb-fsevent', '~> 0.10.3', require: 'rb-fsevent' if RUBY_PLATFORM.include?('darwin')
+
+    # Unix
+    gem 'therubyracer', require: 'v8', platforms: :ruby unless RUBY_PLATFORM.include?('darwin')
+
+    gem 'rb-inotify', '~> 0.10.0', require: 'rb-inotify' if RUBY_PLATFORM.include?('linux')
+
+    # Windows
+    gem 'wdm', '~> 0.1.1', require: 'wdm' if RUBY_PLATFORM =~ /mswin|mingw/i
+  end
+end
 
 $stdout.sync = true
 
 require 'locomotive/wagon'
 require 'locomotive/wagon/cli'
 
+# Let the magin happens
 Locomotive::Wagon::CLI::Main.start

data/bin/wagon_dev

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+bin     = File.dirname(__FILE__) + '/wagon'
+gemfile = File.dirname(__FILE__) + '/../Gemfile'
+cmd     = "BUNDLE_GEMFILE=#{gemfile} bundle exec #{bin} #{ARGV.join(' ')}"
+
+begin
+  system(cmd)
+rescue SignalException => e
+  # do nothing
+end

data/generators/blank/Gemfile.tt

@@ -1,15 +1,19 @@
+# By default, Wagon 3 doesn't need `bundle exec` to be executed.
+# However, if down the road, you want to run a specific version of Wagon or try a new version
+# without overriding the global Wagon binary, please use this Gemfile.
+
 source 'https://rubygems.org'
 
 gem 'locomotivecms_wagon', '~> <%= config[:version] -%>'
 
 group :development do
   # Mac OS X
-  gem 'rb-fsevent', '~> 0.9.1', require: 'rb-fsevent' if RUBY_PLATFORM.include?('darwin')
+  gem 'rb-fsevent', '~> 0.10.0', require: 'rb-fsevent' if RUBY_PLATFORM.include?('darwin')
 
   # Unix
   gem 'therubyracer', require: 'v8', platforms: :ruby unless RUBY_PLATFORM.include?('darwin')
 
-  gem 'rb-inotify', '~> 0.9', require: 'rb-inotify' if RUBY_PLATFORM.include?('linux')
+  gem 'rb-inotify', '~> 0.10.0', require: 'rb-inotify' if RUBY_PLATFORM.include?('linux')
 
   # Windows
   gem 'wdm', '~> 0.1.1', require: 'wdm' if RUBY_PLATFORM =~ /mswin|mingw/i

data/generators/blank/app/assets/stylesheets/app.scss

@@ -1 +1,3 @@
 // Wagon main stylesheet file
+
+// Register sections here. DO NOT REMOVE OR UPDATE THIS LINE

data/generators/blank/app/assets/stylesheets/sections/.empty_directory

@@ -0,0 +1 @@
+.empty_directory

data/generators/blank/app/views/pages/404.liquid

@@ -2,7 +2,7 @@
 title: Page not found
 published: true
 ---
-{% extends layouts/default %}
+{% extends 'layouts/default' %}
 
 {% block 'main' %}
 

data/generators/blank/app/views/pages/index.liquid

@@ -2,7 +2,7 @@
 title: Home page
 published: true
 ---
-{% extends layouts/default %}
+{% extends 'layouts/default' %}
 
 {% block 'main' %}
 

data/generators/section/%type%.scss.tt

@@ -0,0 +1,3 @@
+.<%= options[:type].dasherize %>-section {
+
+}

data/generators/section/template.liquid.tt

@@ -18,88 +18,99 @@ icon: <%= config[:icon] || 'image_text' %>
 # keep_icon: true
 
 # Definition of the settings:
+# A setting type can be one of the following values: text, image_picker, checkbox, radio, select, url, hint, content_type.
+# Please visit: https://doc.locomotivecms.com/docs/json-definition for more explanation.
 settings:
-- label: "My awesome title"
-  id: title
-  type: text
-  <% if config[:global] -%>default: "Hello world"<% end %>
-- label: "An image"
-  id: image
-  type: image_picker
-  <% if config[:global] -%>default: "/samples/images/default.svg"<% end %>
-
+<%- config[:settings].each do |setting| -%>
+- label: "<%= setting.label %>"
+  id: <%= setting.id %>
+  type: <%= setting.type %>
+  <%- case setting.type -%>
+  <%- when 'text' -%>
+  # html: true
+  # line_break: true
+  <%- when 'select', 'radio' -%>
+  options:
+  - label: Option 1
+    value: option_1
+  - label: Option 2
+    value: option_2
+  <%- end -%>
+  <% if config[:global] && setting.has_value? -%>default: <%= setting.default %><% end -%>
+
+<%- end -%>
 # Definition of the blocks.
-# You can define as many types of blocks you want.
-blocks:
-- name: List item
-  type: list_item
+# You can define as many types of blocks as you want.
+blocks: <%- if config[:blocks].blank? -%>[]
+<% end %>
+<%- config[:blocks].each do |(type, settings)| -%>
+- name: "<%= type.humanize %>"
+  type: <%= type %>
   settings:
-  - label: "Item title"
-    id: title
-    type: text
-    default: "my title"
-  - label: "Item image"
-    id: image
-    type: image_picker
-    default: "/samples/images/default.svg"
-
+  <%- settings.each do |setting| -%>
+  - label: "<%= setting.label %>"
+    id: <%= setting.id %>
+    type: <%= setting.type %>
+    <%- case setting.type -%>
+    <%- when 'text' -%>
+    # html: true
+    # line_break: true
+    <%- when 'select', 'radio' -%>
+    options:
+    - label: Option 1
+      value: option_1
+    - label: Option 2
+      value: option_2
+    <%- end -%>
+    <%- if setting.has_value? -%>
+    default: <%= setting.default %>
+    <%- end -%>
+  <%- end -%>
+
+<%- end -%>
 # By default, in the editor UI, blocks will be listed below the "Content" title.
 # The title can be changed with the following property:
 # blocks_label: "My list of items"
 
-<% if config[:global] -%>
-# Content of the global section. This content will be used in all the pages
-# referencing this section.
-default:
-  settings:
-    title: "Hello world"
-    image: "/samples/images/default.png"
-  blocks:
-  - type: list_item
-    settings:
-      title: "Item #1"
-      image: "/samples/images/default.png"
-  - type: list_item
-    settings:
-      title: "Item #2"
-      image: "/samples/images/default.png"
-  - type: list_item
-    settings:
-      title: "Item #3"
-      image: "/samples/images/default.png"
-<% else -%>
+<% unless config[:global] -%>
 # Presets can be seen as different versions of a same section.
-# Useless if the section is not aimed tobe used along with section_dropzone liquid tag
+# Useless if the section is not aimed to be used along with section_dropzone liquid tag
 presets:
   - name: "<%= config[:name] %>"
     category: "Category"
     settings:
-      title: "Hello world"
-    blocks:
-    - type: list_item
-      settings:
-        title: "Item #1"
-    - type: list_item
+      <%- config[:settings].each do |setting| -%>
+      <%- next unless setting.has_value? -%>
+      <%= setting.id %>: <%= setting.default %>
+      <%- end -%>
+    blocks: <%- if config[:blocks].blank? -%>[]
+<% end %>
+    <%- 3.times do -%>
+    <%- config[:blocks].each do |(type, settings)| -%>
+    - type: <%= type %>
       settings:
-        title: "Item #2"
+        <%- settings.each do |setting| -%>
+        <%- next unless setting.has_value? -%>
+        <%= setting.id %>: <%= setting.default %>
+        <%- end -%>
+    <%- end -%>
+    <%- end -%>
 <% end %>
 ---
 {% comment %}
-Above is the YAML definition of your section filled with random settings and blocks.
-The setting's type can be one of the following values: checkbox, image_picker, index, radio, text, select, url.
-Modify it to match your needs. Please visit: https://doc.locomotivecms.com/v4.0/docs/json-definition.
+Above is the YAML definition of your section. Modify it to match your needs.
 
 <% if config[:global] -%>
 To use your global section, just add the following code in your layout template:
 
-  {% global_section <%= config[:type] %> %}
+  {% global_section '<%= config[:type] %>' %}
 
 <% else -%>
 To use your section, 2 possibilities:
 
 1. within a dropzone
 
-Make sure that your layouts includes the following liquid tag:
+Make sure that your layouts or your page includes the following liquid tag:
 
   {% sections_dropzone %}
 
@@ -110,21 +121,26 @@ lines in the YAML section of any page including the {% sections_dropzone %}
 sections_dropzone_content:
 - type: "<%= config[:type] %>"
   settings:
-    title: "My awesome section"
-  blocks:
-  - type: list_item
-    settings:
-      title: "Item #1"
-  - type: list_item
-    settings:
-      title: "Item #2"
-  - type: list_item
+    <%- config[:settings].each do |setting| -%>
+    <%- next unless setting.has_value? -%>
+    <%= setting.id %>: <%= setting.default %>
+    <%- end -%>
+  blocks: <%- if config[:blocks].blank? -%>[]
+<% end %>
+  <%- 3.times do -%>
+  <%- config[:blocks].each do |(type, settings)| -%>
+  - type: <%= type %>
     settings:
-      title: "Item #3"
+      <%- settings.each do |setting| -%>
+      <%- next unless setting.has_value? -%>
+      <%= setting.id %>: <%= setting.default %>
+      <%- end -%>
+  <%- end -%>
+  <%- end -%>
 
 2. as stand-alone section
 
-  {% section <%= config[:type] %> %}
+  {% section '<%= config[:type] %>' %}
 
 If you want to test this section in your Wagon site, add the following
 lines in the YAML section of the page including the statement above or complete it.
@@ -132,27 +148,70 @@ lines in the YAML section of the page including the statement above or complete
 sections_content:
   <%= config[:type] %>:
     settings:
-      title: "My awesome <%= config[:type].humanize %> section"
-    blocks:
-    - type: "list_item"
-      settings:
-        title: "Item #1"
-    - type: "list_item"
-      settings:
-        title: "Item #2"
-    - type: "list_item"
+      <%- config[:settings].each do |setting| -%>
+      <%- next unless setting.has_value? -%>
+      <%= setting.id %>: <%= setting.default %>
+      <%- end -%>
+    blocks: <%- if config[:blocks].blank? -%>[]
+<% end %>
+    <%- 3.times do -%>
+    <%- config[:blocks].each do |(type, settings)| -%>
+    - type: <%= type %>
       settings:
-        title: "Item #3"
+        <%- settings.each do |setting| -%>
+        <%- next unless setting.has_value? -%>
+        <%= setting.id %>: <%= setting.default %>
+        <%- end -%>
+    <%- end -%>
+    <%- end -%>
 
 <% end -%>
 {% endcomment %}
 <div id="{{ section.anchor_id }}" class="<%= config[:type].dasherize %>-section" {{ section.locomotive_attributes }}>
-  <h2>{{ section.settings.title }}</h2>
+  <h2>Section : <%= config[:name] %></h2>
+
+  <hr/>
+
+  <h3>Settings</h3>
+  <%- config[:settings].each do |setting| -%>
+  <%- next unless setting.has_value? -%>
+  <%- case setting.type -%>
+  <%- when 'text' %>
+  <div>{{ section.settings.<%= setting.id -%> }}</div>
+  <%- when 'image_picker' -%>
+  <p><img src="{{ section.settings.<%= setting.id -%> }}" /></p>
+  <%- when 'url' -%>
+  <p><a href="{{ section.settings.<%= setting.id -%> }}" {{ section.settings.<%= setting.id -%>.new_window_attribute }}><%= setting.label -%></a></p>
+  <%- when 'select', 'radio', 'checkbox' -%>
+  <p><%= setting.type -%>: {{ section.settings.<%= setting.id -%> }}</p>
+  <%- end -%>
+  <%- end -%>
+
+  <% unless config[:blocks].blank? -%>
+  <hr/>
+
+  <h3>Blocks</h3>
   <ul>
     {% for block in section.blocks %}
-    <li {{ block.locomotive_attributes }}>
-      {{ block.settings.title }}
+    <li {{ block.locomotive_attributes }} data-index="{{ forloop.index0 }}">
+      <%- config[:blocks].each do |(type, settings)| -%>
+      <h4>Settings for <%= type.humanize -%></h4>
+      <%- settings.each do |setting| -%>
+      <%- next unless setting.has_value? -%>
+      <%- case setting.type -%>
+      <%- when 'text' %>
+      <div>{{ block.settings.<%= setting.id -%> }}</div>
+      <%- when 'image_picker' -%>
+      <p><img src="{{ block.settings.<%= setting.id -%> }}" /></p>
+      <%- when 'url' -%>
+      <p><a href="{{ block.settings.<%= setting.id -%> }}" {{ block.settings.<%= setting.id -%>.new_window_attribute }}><%= setting.label -%></a></p>
+      <%- when 'select', 'radio', 'checkbox' -%>
+      <p><%= setting.type -%>: {{ block.settings.<%= setting.id -%> }}</p>
+      <%- end -%>
+      <%- end -%>
+      <%- end -%>
     </li>
     {% endfor %}
   </ul>
+  <% end %>
 </div>

data/lib/locomotive/wagon.rb

@@ -22,7 +22,7 @@ module Locomotive
     # Create a site from a site generator.
     #
     # @param [ Object ] generator The wrapping class of the generator itself
-    # @param [ Array ] args [name of the site, destination path of the site, skip bundle flag]
+    # @param [ Array ] args [name of the site, destination path of the site]
     # @param [ Hash ] options General options (ex: --force-color)
     #
     def self.init(generator_klass, args, options = {})
@@ -121,5 +121,19 @@ module Locomotive
       Locomotive::Wagon::DeleteCommand.delete(env, path, resource, slug, shell)
     end
 
+    def self.require_misc_gems      
+      return if ENV['WAGON_GEMFILE'].nil?
+
+      # at this point, we are sure that in a bundle exec contact
+      begin
+        require 'bundler'
+        ::Bundler.require(:misc)        
+      rescue Exception => e
+        puts "Warning: cant' require the Gemfile misc group, reason: #{e.message}"
+        # Bundler is not defined or there is an issue
+        # with one of the gems in the misc group
+      end
+    end
+
   end
 end