locomotivecms_wagon 1.4.0 → 1.5.0.rc1

data/lib/locomotive/wagon/cli.rb

@@ -30,34 +30,65 @@ module Locomotive
 
       end
 
+      module ForceColor
+
+        def force_color_if_asked(options)
+          if options[:force_color]
+            # thor
+            require 'locomotive/wagon/misc/thor'
+            self.shell = Thor::Shell::ForceColor.new
+
+            # bypass colorize code
+            STDOUT.instance_eval { def isatty; true; end; }
+          end
+        end
+
+      end
+
       class Generate < Thor
 
+        include Locomotive::Wagon::CLI::ForceColor
         include Locomotive::Wagon::CLI::CheckPath
 
         class_option :path, aliases: '-p', type: :string, default: '.', optional: true, desc: 'if your LocomotiveCMS site is not in the current path'
 
-        desc 'content_type NAME FIELDS', 'Create a content type with NAME as the slug and FIELDS as the list of fields.'
+        desc 'content_type SLUG FIELDS', 'Creates a content type with the specified slug and fields.'
+        method_option :name, aliases: '-n', type: :string, default: nil, optional: true, desc: 'Name of the content type as it will be displayed in the back-office'
         long_desc <<-LONGDESC
-          Create a content type with NAME as the slug and FIELDS as the list of fields.
-          The fields follows that schema:
+          Creates a content type with the specified slug and fields.
+
+          SLUG should be plural, lowercase, and underscored.
+
+          FIELDS format: field_1[:TYPE][:LABEL][:REQUIRED][:LOCALIZED][:TARGET_CONTENT_TYPE_SLUG] field_2[:TYPE][:LABEL][:REQUIRED][:LOCALIZED][:TARGET_CONTENT_TYPE_SLUG] ...
 
-          field_1[:type][:required] field_2[:type][:required]
+          TYPE values: string, text, integer, float, boolean, email, date, date_time, file, tags, select, belongs_to, has_many, or many_to_many. Default is string.
+
+          To require a field, set REQUIRED to true. The first field is required by default.
+
+          TARGET_CONTENT_TYPE_SLUG is the slug of the content type used in the relationship.
 
           Examples:
 
-            * wagon generate content_type songs name:string duration:string
+            * wagon generate content_type posts title published_at:date_time:true body:text
 
-            * wagon generate content_type posts title body:text:true published_at:date
+            * wagon generate content_type products title price:float photo:file category:belongs_to:Category:true:false:main_categories
         LONGDESC
         def content_type(name, *fields)
+          force_color_if_asked(options)
+
           say('The fields are missing', :red) and return false if fields.empty?
 
           if check_path!
-            Locomotive::Wagon.generate :content_type, name, self.options['path'], fields
+            Locomotive::Wagon.generate :content_type, [name, fields, self.options.delete('path')], self.options
           end
         end
 
         desc 'page FULLPATH', 'Create a page. No need to pass an extension to the FULLPATH arg'
+        method_option :title,         aliases: '-t', type: 'string',    default: nil, desc: 'Title of the page'
+        method_option :haml,          aliases: '-h', type: 'boolean',   default: nil, desc: 'add a HAML extension to the file'
+        method_option :listed,        aliases: '-l', type: 'boolean',   default: false, desc: 'tell if the page is listed in the menu'
+        method_option :content_type,  aliases: '-c', type: 'string',    default: nil, desc: 'tell if the page is a template for a content type'
+        method_option :locales,       aliases: '-lo', type: 'string',   default: nil, desc: 'locales for the various translations'
         long_desc <<-LONGDESC
           Create a page. The generator will ask for the extension (liquid or haml) and also
           if the page is localized or not.
@@ -69,9 +100,11 @@ module Locomotive
             * wagon generate page about_us/me
         LONGDESC
         def page(fullpath)
+          force_color_if_asked(options)
+
           if path = check_path!
-            locales = self.site_config(path)['locales']
-            Locomotive::Wagon.generate :page, fullpath, self.options['path'], locales
+            self.options[:default_locales] = self.site_config(path)['locales']
+            Locomotive::Wagon.generate :page, [fullpath, self.options.delete('path')], self.options
           end
         end
 
@@ -85,9 +118,11 @@ module Locomotive
             * wagon generate snippet footer
         LONGDESC
         def snippet(slug)
+          force_color_if_asked(options)
+
           if path = check_path!
             locales = self.site_config(path)['locales']
-            Locomotive::Wagon.generate :snippet, slug, self.options['path'], locales
+            Locomotive::Wagon.generate :snippet, [slug, locales, self.options.delete('path')], self.options
           end
         end
 
@@ -109,30 +144,47 @@ module Locomotive
       class Main < Thor
 
         include Locomotive::Wagon::CLI::CheckPath
+        include Locomotive::Wagon::CLI::ForceColor
 
-        desc 'version', 'Version of the LocomotiveCMS wagon'
+        class_option :force_color, type: :boolean, default: false, desc: 'Whether or not to use ANSI color in the output.'
+
+        desc 'version', 'Version of the LocomotiveCMS Wagon'
         def version
           require 'locomotive/wagon/version'
           say Locomotive::Wagon::VERSION
         end
 
-        desc 'init NAME [PATH]', 'Create a brand new LocomotiveCMS site'
-        method_option :template,  aliases: '-t', type: 'string', default: 'blank', desc: 'instead of building from a blank site, you can have a pre-fetched site with form a template (see the templates command)'
-        method_option :lib,       aliases: '-l', type: 'string', desc: 'Path to an external ruby lib or generator'
-        method_option :verbose,   aliases: '-v', type: 'boolean', default: false, desc: 'display the full error stack trace if an error occurs'
-        def init(name, path = '.')
+        desc 'auth [EMAIL] [PASSWORD]', 'Log into the LocomotiveHosting platform'
+        def auth(email = nil, password = nil)
+          say "LocomotiveHosting Sign in/up\n\n", :bold
+
+          email     ||= ask('Enter your e-mail?')
+          password  ||= ask('Enter your password?')
+
+          Locomotive::Wagon.authenticate(email, password, shell)
+        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 :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])
           if generator.nil?
             say "Unknown site template '#{options[:template]}'", :red
+            exit(1)
           else
             begin
-              if Locomotive::Wagon.init(name, path, generator)
-                self.print_next_instructions_when_site_created(name, path)
+              if Locomotive::Wagon.init(generator.klass, [name, path, options[:skip_bundle].to_s, *generator_options], { force_color: options[:force_color] })
+                self.print_next_instructions_when_site_created(name, path, options[:skip_bundle])
               end
             rescue GeneratorException => e
               self.print_exception(e, options[:verbose])
+              exit(1)
             end
           end
         end
@@ -149,59 +201,102 @@ module Locomotive
             end
           rescue Exception => e
             self.print_exception(e, options[:verbose])
+            exit(1)
           end
         end
 
-        desc 'generate TYPE ...ARGS', 'Generate resources (content_types, page, snippets) for a LocomotiveCMS site'
+        desc 'generate RESOURCE ARGUMENTS', 'Generates a content_type, page, or snippet'
+        long_desc <<-LONGDESC
+          Generates a content_type, page, or snippet
+
+          RESOURCE can be set to content_type, page, or snippet.
+
+          Use wagon generate help [RESOURCE] for usage information and examples.
+        LONGDESC
         subcommand 'generate', Generate
 
         desc 'list_templates', 'List all the templates to create either a site or a content type'
         method_option :lib, aliases: '-l', type: 'string', desc: 'Path to an external ruby lib or generator'
+        method_option :json, aliases: '-j', type: :boolean, default: false, desc: 'Output the list in JSON'
         def list_templates
+          force_color_if_asked(options)
           require 'locomotive/wagon/generators/site'
           require File.expand_path(options[:lib]) if options[:lib]
           if Locomotive::Wagon::Generators::Site.empty?
             say 'No templates', :red
-          else
+          elsif !options[:json]
             Locomotive::Wagon::Generators::Site.list.each do |info|
               say info.name, :bold, false
               say " - #{info.description}" unless info.description.blank?
             end
+          else
+            say Locomotive::Wagon::Generators::Site.list_to_json
           end
         end
 
-        desc 'serve [PATH]', 'Serve a LocomotiveCMS site from the file system'
+        desc 'serve [PATH]', 'Serve a site from the file system'
         method_option :host, aliases: '-h', type: 'string', default: '0.0.0.0', desc: 'The host (address) of the Thin server'
         method_option :port, aliases: '-p', type: 'string', default: '3333', desc: 'The port of the Thin server'
+        method_option :daemonize, aliases: '-d', type: 'boolean', default: false, desc: 'Run daemonized Thin server in the background'
+        method_option :live_reload_port, aliases: '-l', type: 'string', default: false, desc: 'Include the Livereload javascript in each page'
+        method_option :force, aliases: '-f', type: 'boolean', default: false, desc: 'Stop the current daemonized Thin server if found before starting a new one'
+        method_option :verbose, aliases: '-v', type: 'boolean', default: false, desc: 'display the full error stack trace if an error occurs'
         def serve(path = '.')
+          parent_pid = Process.pid
+          force_color_if_asked(options)
           if check_path!(path)
             begin
               Locomotive::Wagon.serve(path, options)
+            rescue SystemExit => e
+              if parent_pid == Process.pid
+                say "Your site is served now.", :green
+              end
+            rescue Exception => e
+              self.print_exception(e, options[:verbose])
+              exit(1)
+            end
+          end
+        end
+
+        desc 'stop [PATH]', 'Stop serving a site previously launched by the serve command with the -d option'
+        def stop(path = '.')
+          force_color_if_asked(options)
+          if check_path!(path)
+            begin
+              Locomotive::Wagon.stop(path)
+              say "Your site is not served anymore.", :green
             rescue Exception => e
               say e.message, :red
+              exit(1)
             end
           end
         end
 
-        desc 'push ENV [PATH]', 'Push a site to a remote LocomotiveCMS engine'
+        desc 'push ENV [PATH]', 'Push a site to a remote LocomotiveCMS Engine'
         method_option :resources, aliases: '-r', type: 'array', default: nil, desc: 'Only push the resource(s) passed in argument'
         method_option :force, aliases: '-f', type: 'boolean', default: false, desc: 'Force the push of a resource'
         method_option :translations, aliases: '-t', type: 'boolean', default: false, desc: 'Push the local translations (by default, they are not)'
         method_option :data, aliases: '-d', type: 'boolean', default: false, desc: 'Push the content entries and the editable elements (by default, they are not)'
+        method_option :shell, type: 'boolean', default: true, desc: 'Use shell to ask for missing connection information like the subdomain (in this case, take a random one)'
         method_option :verbose, aliases: '-v', type: 'boolean', default: false, desc: 'display the full error stack trace if an error occurs'
         def push(env, path = '.')
+          force_color_if_asked(options)
+
           if check_path!(path)
-            if connection_info = self.retrieve_connection_info(env, path)
+            if connection_info = self.retrieve_connection_info(env, path, options[:shell])
               begin
                 Locomotive::Wagon.push(path, connection_info, options)
               rescue Exception => e
                 self.print_exception(e, options[:verbose])
+                exit(1)
               end
+            else
+              exit(1)
             end
           end
         end
 
-        desc 'pull ENV [PATH]', 'Pull a site from a remote LocomotiveCMS engine'
+        desc 'pull ENV [PATH]', 'Pull a site from a remote LocomotiveCMS Engine'
         method_option :resources, aliases: '-r', type: 'array', default: nil, desc: 'Only pull the resource(s) passed in argument'
         method_option :verbose, aliases: '-v', type: 'boolean', default: false, desc: 'display the full error stack trace if an error occurs'
         def pull(env, path = '.')
@@ -211,12 +306,13 @@ module Locomotive
                 Locomotive::Wagon.pull(path, connection_info, options)
               rescue Exception => e
                 self.print_exception(e, options[:verbose])
+                exit(1)
               end
             end
           end
         end
 
-        desc 'destroy ENV [PATH]', 'Destroy a remote LocomotiveCMS engine'
+        desc 'destroy ENV [PATH]', 'Destroy a remote LocomotiveCMS Engine'
         def destroy(env, path = '.')
           if check_path!(path)
             if connection_info = self.retrieve_connection_info(env, path)
@@ -224,6 +320,7 @@ module Locomotive
                 Locomotive::Wagon.destroy(path, connection_info)
               else
                 say 'The destroy operation has been cancelled', :red
+                exit(1)
               end
             end
           end
@@ -235,11 +332,17 @@ module Locomotive
         #
         # @param [ String ] name The name of the site
         # @param [ String ] path The path of the local site
+        # @param [ Boolean ] skip_bundle Do not run bundle install
         #
-        def print_next_instructions_when_site_created(name, path)
+        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
-          say "\tcd #{path}/#{name}\n\tbundle install\n\tbundle exec wagon serve\n\topen http://0.0.0.0:3333"
+
+          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
         end
 
         # Print the exception.
@@ -259,33 +362,26 @@ module Locomotive
         #
         # @param [ String ] env The environment (development, staging, production, ...etc)
         # @param [ String ] path The path of the local site
+        # @param [ Boolean ] use_shell True by default, use it to ask for missing information (subdomain for instance)
         #
         # @return [ Hash ] The information of the connection or nil if errors
         #
-        def retrieve_connection_info(env, path)
-          require 'active_support/core_ext/hash'
-          require 'erb'
-          connection_info = nil
+        def retrieve_connection_info(env, path, use_shell = true)
+          require 'locomotive/wagon/misc/deployment_connection'
+
           begin
-            path_to_deploy_file = File.join(path, 'config', 'deploy.yml')
-            env_parsed_deploy_file = ERB.new(File.open(path_to_deploy_file).read).result
-            connection_info = YAML::load(env_parsed_deploy_file)[env.to_s].with_indifferent_access
+            service = Locomotive::Wagon::DeploymentConnection.new(path, use_shell ? shell : nil)
 
-            if connection_info[:ssl] && !connection_info[:host].start_with?('https')
-              connection_info[:host] = 'https://' + connection_info[:host]
-            end
+            service.get_information(env)
 
-            if connection_info.nil?
-              raise "No #{env.to_s} environment found in the config/deploy.yml file"
-            end
           rescue Exception => e
-            say "Unable to read the information about the remote LocomotiveCMS site (#{e.message})", :red
+            self.print_exception(e, options[:verbose])
+            nil
           end
-          connection_info
         end
 
       end
 
     end
   end
-end
+end

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

@@ -10,14 +10,16 @@ module Locomotive
       class ContentType < Thor::Group
 
         include Thor::Actions
+        include Locomotive::Wagon::CLI::ForceColor
 
-        argument :name
-        argument :target_path
+        argument :slug
         argument :fields
+        argument :target_path
 
         def copy_sources
           directory('.', target_path, { recursive: true }, {
-            name:   self.name,
+            name:   name,
+            slug:   slug,
             fields: extract_fields(fields)
           })
         end
@@ -28,15 +30,29 @@ module Locomotive
 
         protected
 
+        def name
+          options['name'] || slug.humanize
+        end
+
         def extract_fields(fields)
           fields.map do |raw_attributes|
-            name, type, required = raw_attributes.split(':')
-
-            OpenStruct.new({
-              name:     name,
-              type:     type || 'string',
-              required: %w(true required).include?(required)
-            })
+            name, type, label, required, localized, target_content_type_slug  = raw_attributes.split(':')
+
+            OpenStruct.new(
+              name:       name,
+              label:      label || name.humanize,
+              type:       type || 'string',
+              required:   %w(true required).include?(required),
+              localized:  %w(true required).include?(localized)
+            ).tap do |field|
+              if %w(belongs_to has_many many_to_many).include?(type)
+                field.class_name = target_content_type_slug
+
+                inverse_of = type == 'belongs_to' ? target_content_type_slug.singularize : target_content_type_slug
+
+                field.inverse_of = inverse_of
+              end
+            end
           end
         end
 

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

@@ -8,40 +8,29 @@ module Locomotive
       class Page < Thor::Group
 
         include Thor::Actions
+        include Locomotive::Wagon::CLI::ForceColor
 
         argument :slug
         argument :target_path # path to the site
-        argument :locales
-
-        attr_accessor :haml
-
-        def ask_for_haml
-          self.haml = yes?('Do you prefer a HAML template ?')
-        end
-
-        def apply_locales?
-          self.locales.shift # remove the default locale
-
-          unless self.locales.empty?
-            unless yes?('Do you want to generate templates for each locale ?')
-              self.locales = []
-            end
-          end
-        end
 
         def create_page
-          extension = self.haml ? 'liquid.haml' : 'liquid'
+          extension = haml? ? 'liquid.haml' : 'liquid'
+
+          segments      = self.slug.split('/').find_all { |segment| segment != '' }
+          max_segments  = segments.size
 
-          segments = self.slug.split('/')
           while segment = segments.pop do
-            options   = { slug: segment, translated: false }
-            file_path = File.join(pages_path, segments, segment)
+            _options    = self.page_options(slug: segment, translated: false)
+            file_path   = File.join(pages_path, segments, segment)
+
+            # the content type option is never deleted for the first segment (the requested template)
+            _options.delete(:content_type) unless segments.size == (max_segments - 1)
 
-            template "template.#{extension}.tt", "#{file_path}.#{extension}", options
+            template "template.#{extension}.tt", "#{file_path}.#{extension}", _options
 
-            self.locales.each do |locale|
-              options[:translated] = true
-              template "template.#{extension}.tt", "#{file_path}.#{locale}.#{extension}", options
+            self.other_locales.each do |locale|
+              _options[:translated] = true
+              template "template.#{extension}.tt", "#{file_path}.#{locale}.#{extension}", _options
             end
           end
         end
@@ -52,10 +41,37 @@ module Locomotive
 
         protected
 
+        def haml?
+          if options[:haml].nil?
+            yes?('Do you prefer a HAML template ?')
+          else
+            options[:haml]
+          end
+        end
+
         def pages_path
           File.join(target_path, 'app', 'views', 'pages')
         end
 
+        def page_options(base = {})
+          base.merge({
+            title:        options[:title] || base[:slug].humanize,
+            listed:       options[:listed],
+            content_type: options[:content_type]
+          })
+        end
+
+        def other_locales
+          locales = options[:default_locales]
+          locales.shift
+
+          # #1 default: [fr, en, es], asked: [en, de], result => [en]
+          # #2 default: [fr, en, de], asked: [es], result => []
+          # #1 default: [fr, en, es], asked: [fr, en, es], result => [en, es]
+
+          locales & (options[:locales] || [])
+        end
+
       end
 
     end

data/lib/locomotive/wagon/generators/site/base.rb

@@ -1,6 +1,7 @@
 require 'thor/group'
 require 'active_support'
 require 'active_support/core_ext'
+require 'active_support/core_ext/string/inflections'
 
 module Locomotive
   module Wagon
@@ -10,9 +11,11 @@ module Locomotive
         class Base < Thor::Group
 
           include Thor::Actions
+          include Locomotive::Wagon::CLI::ForceColor
 
           argument :name
           argument :target_path
+          argument :skip_bundle
 
           def copy_sources
             directory('.', self.destination, { recursive: true }, {
@@ -21,14 +24,64 @@ module Locomotive
             })
           end
 
+          def comment_gemfile
+            return unless skip_bundle?
+
+            gsub_file File.join(self.destination, 'Gemfile'), /^(.*)$/ do |match|
+              "# #{match}"
+            end
+          end
+
           def self.source_root
             File.join(File.dirname(__FILE__), '..', '..', '..', '..', '..', 'generators', self.name.demodulize.underscore)
           end
 
+          def self.may_use_haml
+            class_option :haml, type: :boolean, default: nil, required: false, desc: 'Use HAML templates?'
+          end
+
+          def self.may_use_scss
+            class_option :scss, type: :boolean, default: nil, required: false, desc: 'Use SCSS stylesheets?'
+          end
+
+          protected
+
           def destination
             File.join(target_path, name)
           end
 
+          def haml?
+            if options[:haml].nil?
+              yes?('Do you prefer HAML templates?')
+            else
+              options[:haml]
+            end
+          end
+
+          def scss?
+            if options[:scss].nil?
+              yes?('Do you prefer SCSS stylesheets?')
+            else
+              options[:scss]
+            end
+          end
+
+          def skip_bundle?
+            [true, 'true'].include?(skip_bundle)
+          end
+
+          def bundle_install
+            return if skip_bundle?
+
+            FileUtils.cd self.destination
+
+            say_status :run, "bundle install"
+
+            ENV['BUNDLE_GEMFILE'] = nil
+
+            print `"#{Gem.ruby}" -rubygems "#{Gem.bin_path('bundler', 'bundle')}" install`
+          end
+
         end
 
       end

data/lib/locomotive/wagon/generators/site/blank.rb

@@ -5,8 +5,10 @@ module Locomotive
 
         class Blank < Base
 
+          may_use_haml
+
           def choose_haml_over_html
-            if yes?('Do you prefer HAML templates ?')
+            if haml?
               remove_file File.join(self.destination, 'app/views/pages/index.liquid')
               remove_file File.join(self.destination, 'app/views/pages/404.liquid')
             else
@@ -14,10 +16,15 @@ module Locomotive
               remove_file File.join(self.destination, 'app/views/pages/404.liquid.haml')
             end
           end
+
+          def bundle_install
+            super
+          end
+
         end
 
         Locomotive::Wagon::Generators::Site.register(:blank, Blank, %{
-          A blank LocomotiveCMS site with the minimal files.
+          A blank site with the minimal files.
         })
       end
     end

data/lib/locomotive/wagon/generators/site/bootstrap2.rb

@@ -5,8 +5,10 @@ module Locomotive
 
         class Bootstrap2 < Base
 
+          may_use_haml
+
           def choose_haml_over_html
-            if yes?('Do you prefer HAML templates ?')
+            if haml?
               remove_file File.join(self.destination, 'app/views/pages/index.liquid')
               remove_file File.join(self.destination, 'app/views/pages/404.liquid')
               remove_file File.join(self.destination, 'app/views/snippets/footer.liquid')
@@ -17,10 +19,14 @@ module Locomotive
             end
           end
 
+          def bundle_install
+            super
+          end
+
         end
 
         Locomotive::Wagon::Generators::Site.register(:bootstrap2, Bootstrap2, %{
-          A LocomotiveCMS site with Twitter Bootstrap (v2.3.2) and Font Awesome (v3.2.1).
+          A site with Twitter Bootstrap (v2.3.2) and Font Awesome (v3.2.1).
         })
       end
     end