locomotivecms_wagon 1.0.0

data/lib/locomotive/wagon/cli.rb

@@ -0,0 +1,238 @@
+require 'thor'
+require 'thor/runner'
+
+module Locomotive
+  module Wagon
+    module CLI
+
+      module CheckPath
+
+        protected
+
+        # Check if the path given in option ('.' by default) points to a LocomotiveCMS
+        # site. It is also possible to pass a path other than the one from the options.
+        #
+        # @param [ String ] path The optional path of the site instead of options['path']
+        #
+        # @return [ String ] The fullpath to the LocomotiveCMS site or nil if it is not a valid site.
+        #
+        def check_path!(path = nil)
+          path ||= options['path']
+
+          path = path == '.' ? Dir.pwd : File.expand_path(path)
+
+          (File.exists?(File.join(path, 'config', 'site.yml')) ? path : nil).tap do |_path|
+            if _path.nil?
+              say 'The path does not point to a LocomotiveCMS site', :red
+            end
+          end
+        end
+
+      end
+
+      class Generate < Thor
+
+        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.'
+        long_desc <<-LONGDESC
+          Create a content type with NAME as the slug and FIELDS as the list of fields.
+          The fields follows that schema:
+
+          field_1[:type][:required] field_2[:type][:required]
+
+          Examples:
+
+            * wagon generate content_type songs name:string duration:string
+
+            * wagon generate content_type posts title body:text:true published_at:date
+        LONGDESC
+        def content_type(name, *fields)
+          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
+          end
+        end
+
+        desc 'page FULLPATH', 'Create a page. No need to pass an extension to the FULLPATH arg'
+        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.
+
+          Examples:
+
+            * wagon generate page contact
+
+            * wagon generate page about_us/me
+        LONGDESC
+        def page(fullpath)
+          if path = check_path!
+            locales = self.site_config(path)['locales']
+            Locomotive::Wagon.generate :page, fullpath, self.options['path'], locales
+          end
+        end
+
+        desc 'snippet SLUG', 'Create a snippet'
+        long_desc <<-LONGDESC
+          Create a snippet. The generator will ask for the extension (liquid or haml) and also
+          if the snippet is localized or not.
+
+          Example:
+
+            * wagon generate snippet footer
+        LONGDESC
+        def snippet(slug)
+          if path = check_path!
+            locales = self.site_config(path)['locales']
+            Locomotive::Wagon.generate :snippet, slug, self.options['path'], locales
+          end
+        end
+
+        protected
+
+        # Read the YAML config file of a LocomotiveCMS site.
+        # The path should be returned by the check_path! method first.
+        #
+        # @param [ String ] path The full path to a LocomotiveCMS site.
+        #
+        # @return [ Hash ] The site
+        #
+        def site_config(path = nil)
+          YAML.load_file(File.join(path, 'config', 'site.yml'))
+        end
+
+      end
+
+      class Main < Thor
+
+        include Locomotive::Wagon::CLI::CheckPath
+
+        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)'
+        def init(name, path = '.')
+          require 'locomotive/wagon/generators/site'
+          generator = Locomotive::Wagon::Generators::Site.get(options[:template])
+          if generator.nil?
+            say "Unknown site template '#{options[:template]}'", :red
+          else
+            begin
+              Locomotive::Wagon.init(name, path, generator)
+            rescue GeneratorException => e
+              say e.message, :red
+            end
+          end
+        end
+
+        desc 'generate TYPE ...ARGS', 'Generate resources (content_types, page, snippets) for a LocomotiveCMS site'
+        subcommand 'generate', Generate
+
+        desc 'list_templates', 'List all the templates to create either a site or a content type'
+        def list_templates
+          require 'locomotive/wagon/generators/site'
+          if Locomotive::Wagon::Generators::Site.empty?
+            say 'No templates', :red
+          else
+            Locomotive::Wagon::Generators::Site.list.each do |info|
+              say info.name, :bold, false
+              say " - #{info.description}" unless info.description.blank?
+            end
+          end
+        end
+
+        desc 'serve [PATH]', 'Serve a LocomotiveCMS 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'
+        def serve(path = '.')
+          if check_path!(path)
+            begin
+              Locomotive::Wagon.serve(path, options)
+            rescue Exception => e
+              say e.message, :red
+            end
+          end
+        end
+
+        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 :data, aliases: '-d', type: 'boolean', default: false, desc: 'Push the content entries and the editable elements (by default, they are not)'
+        def push(env, path = '.')
+          if check_path!(path)
+            if connection_info = self.retrieve_connection_info(env, path)
+              begin
+                Locomotive::Wagon.push(path, connection_info, options)
+              rescue Exception => e
+                say e.message, :red
+              end
+            end
+          end
+        end
+
+        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 :force, aliases: '-f', type: 'boolean', default: false, desc: 'Force the push of a resource'
+        # method_option :data, aliases: '-d', type: 'boolean', default: false, desc: 'Push the content entries and the editable elements (by default, they are not)'
+        def pull(env, path = '.')
+          if check_path!(path)
+            if connection_info = self.retrieve_connection_info(env, path)
+              begin
+                Locomotive::Wagon.pull(path, connection_info, options)
+              rescue Exception => e
+                say e.message, :red
+              end
+            end
+          end
+        end
+
+        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)
+              if ask('Are you sure ?', limited_to: %w(yes no)) == 'yes'
+                Locomotive::Wagon.destroy(path, connection_info)
+              else
+                say 'The destroy operation has been cancelled', :red
+              end
+            end
+          end
+        end
+
+        protected
+
+        # From a site specified by a path, retrieve the information of the connection
+        # for a environment located in the config/deploy.yml file of the site.
+        #
+        # @param [ String ] env The environment (development, staging, production, ...etc)
+        # @param [ String ] path The path of the local site
+        #
+        # @return [ Hash ] The information of the connection or nil if errors
+        #
+        def retrieve_connection_info(env, path)
+          connection_info = nil
+          begin
+            path_to_deploy_file = File.join(path, 'config', 'deploy.yml')
+            connection_info = YAML::load(File.open(path_to_deploy_file).read)[env.to_s]
+
+            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
+          end
+          connection_info
+        end
+
+      end
+
+    end
+  end
+end

data/lib/locomotive/wagon/exceptions.rb

@@ -0,0 +1,35 @@
+module Locomotive
+  module Wagon
+
+    class DefaultException < ::Exception
+
+      def initialize(message = nil, parent_exception = nil)
+        self.log_backtrace(parent_exception) if parent_exception
+
+        super(message)
+      end
+
+      protected
+
+      def log_backtrace(parent_exception)
+        full_error_message = "#{parent_exception.message}\n\t"
+        full_error_message += parent_exception.backtrace.join("\n\t")
+        full_error_message += "\n\n"
+        Locomotive::Wagon::Logger.fatal full_error_message
+      end
+
+    end
+
+    class MounterException < DefaultException
+    end
+
+    class GeneratorException < DefaultException
+
+      def log_backtrace(parent_exception)
+        # Logger not initialized at this step
+      end
+
+    end
+
+  end
+end

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

@@ -0,0 +1,47 @@
+require 'thor/group'
+require 'ostruct'
+require 'active_support'
+require 'active_support/core_ext'
+require 'faker'
+
+module Locomotive
+  module Wagon
+    module Generators
+      class ContentType < Thor::Group
+
+        include Thor::Actions
+
+        argument :name
+        argument :target_path
+        argument :fields
+
+        def copy_sources
+          directory('.', target_path, { recursive: true }, {
+            name:   self.name,
+            fields: extract_fields(fields)
+          })
+        end
+
+        def self.source_root
+          File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'generators', 'content_type')
+        end
+
+        protected
+
+        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)
+            })
+          end
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+require 'thor/group'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Locomotive
+  module Wagon
+    module Generators
+      class Page < Thor::Group
+
+        include Thor::Actions
+
+        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'
+
+          segments = self.slug.split('/')
+          while segment = segments.pop do
+            options   = { slug: segment, translated: false }
+            file_path = File.join(pages_path, segments, segment)
+
+            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
+            end
+          end
+        end
+
+        def self.source_root
+          File.join(File.dirname(__FILE__), '..', '..', '..', '..', 'generators', 'page')
+        end
+
+        protected
+
+        def pages_path
+          File.join(target_path, 'app', 'views', 'pages')
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'thor/group'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Locomotive
+  module Wagon
+    module Generators
+      module Site
+
+        class Base < Thor::Group
+
+          include Thor::Actions
+
+          argument :name
+          argument :target_path
+
+          def self.source_root
+            File.join(File.dirname(__FILE__), '..', '..', '..', '..', '..', 'generators', self.name.demodulize.underscore)
+          end
+
+          def destination
+            File.join(target_path, name)
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+module Locomotive
+  module Wagon
+    module Generators
+      module Site
+
+        class Blank < Base
+
+          def copy_sources
+            directory('.', self.destination, { recursive: true }, {
+              name:     self.name,
+              version:  Locomotive::Wagon::VERSION
+            })
+          end
+
+        end
+
+        Locomotive::Wagon::Generators::Site.register(:blank, Blank, %{
+          A blank LocomotiveCMS site with the minimal files.
+        })
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Locomotive
+  module Wagon
+    module Generators
+      module Site
+
+        class Bootstrap < Base
+
+          def copy_sources
+            directory('.', self.destination, { recursive: true }, {
+              name:     self.name,
+              version:  Locomotive::Wagon::VERSION
+            })
+          end
+
+          def choose_haml_over_html
+            if yes?('Do you prefer HAML templates ?')
+              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')
+            else
+              remove_file File.join(self.destination, 'app/views/pages/index.liquid.haml')
+              remove_file File.join(self.destination, 'app/views/pages/404.liquid.haml')
+              remove_file File.join(self.destination, 'app/views/snippets/footer.liquid.haml')
+            end
+          end
+
+        end
+
+        Locomotive::Wagon::Generators::Site.register(:bootstrap, Bootstrap, %{
+          A LocomotiveCMS site powered by Twitter bootstrap (v2.2.2).
+        })
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+module Locomotive
+  module Wagon
+    module Generators
+      module Site
+
+        class Foundation < Base
+
+          def copy_sources
+            directory('.', self.destination, { recursive: true }, {
+              name:     self.name,
+              version:  Locomotive::Wagon::VERSION
+            })
+          end
+
+          def choose_haml_over_html
+            if yes?('Do you prefer HAML templates ?')
+              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')
+            else
+              remove_file File.join(self.destination, 'app/views/pages/index.liquid.haml')
+              remove_file File.join(self.destination, 'app/views/pages/404.liquid.haml')
+              remove_file File.join(self.destination, 'app/views/snippets/footer.liquid.haml')
+            end
+          end
+
+        end
+
+        Locomotive::Wagon::Generators::Site.register(:foundation, Foundation, %{
+          A LocomotiveCMS site powered by Foundation (v4.0.9).
+        })
+      end
+    end
+  end
+end

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

@@ -0,0 +1,81 @@
+require 'open-uri'
+require 'zip/zipfilesystem'
+
+module Locomotive
+  module Wagon
+    module Generators
+      module Site
+
+        class Unzip < Base
+
+          def prepare
+            remove_file join('tmp')
+            empty_directory join('tmp')
+          end
+
+          def ask_for_location
+            @location = ask('What is the location (on the filesystem or url) of the zip file ?')
+            raise GeneratorException.new('Please enter a location') if @location.blank?
+          end
+
+          def download_or_copy
+            @template_path = join('tmp', File.basename(@location))
+
+            if @location =~ /^https?:\/\//
+              say "downloading...#{@location}"
+              create_file @template_path, open(@location).read
+            else
+              say "copying...#{@location}"
+              create_file @template_path, open(@location, 'rb') { |io| io.read }
+            end
+          end
+
+          def unzip
+            say "unzipping...#{@template_path}"
+
+            begin
+              Zip::ZipFile.open(@template_path) do |zipfile|
+                zipfile.each do |file|
+                  next if file.name =~ /^__MACOSX/
+                  zipfile.extract(file, join('tmp', file.name))
+
+                  @path = $1 if file.name =~ /(.*)\/config\/site.yml$/
+                end
+              end
+            rescue Exception => e
+              raise GeneratorException.new("Unable to unzip the archive")
+            end
+
+            raise GeneratorException.new('Not a valid LocomotiveCMS site') if @path.blank?
+          end
+
+          def copy_sources
+            self.class.source_root = File.expand_path(join('tmp', @path, '/'))
+            say "copying files from #{self.class.source_root} / #{self.destination}"
+            directory('.', self.destination, { recursive: true })
+          end
+
+          def self.source_root
+            # only way to change the source root from the instance
+            @@source_root
+          end
+
+          def self.source_root=(value)
+            @@source_root = value
+          end
+
+          protected
+
+          def join(*args)
+            File.join(self.destination, *args)
+          end
+
+        end
+
+        Locomotive::Wagon::Generators::Site.register(:unzip, Unzip, %{
+          Unzip a local or remote (http, https, ftp) zipped LocomotiveCMS site.
+        })
+      end
+    end
+  end
+end

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

@@ -0,0 +1,99 @@
+require 'ostruct'
+require 'singleton'
+
+module Locomotive
+  module Wagon
+    module Generators
+
+      module Site
+
+        # Register a generator by adding it to the list of existing generators.
+        #
+        # @param [ String ] name The name of the generator
+        # @param [ Class ] klass The class of the generator
+        # @param [ String ] description The description of the generator (can be nil)
+        #
+        # @return [ Boolean ] True if the registration has been successful, false otherwise.
+        #
+        def self.register(name, klass, description = nil)
+          Locomotive::Wagon::Generators::Site::List.instance.register(name, klass, description)
+        end
+
+        # Return the information about a generator from its name.
+        #
+        # @param [ String ] name The name of the generator
+        #
+        # @return [ Object ] The information of the found generator or nil
+        #
+        def self.get(name)
+          Locomotive::Wagon::Generators::Site::List.instance.get(name)
+        end
+
+        # List all the generators
+        #
+        # @return [ Array ] The filtered (or not) list of generators
+        #
+        def self.list
+          Locomotive::Wagon::Generators::Site::List.instance._list
+        end
+
+        # Tell if the list of generators is empty or not .
+        #
+        # @return [ Boolean ] True if empty
+        #
+        def self.empty?
+          Locomotive::Wagon::Generators::Site::List.instance._list.empty?
+        end
+
+        class List
+
+          include ::Singleton
+
+          attr_accessor :_list
+
+          def initialize
+            self._list = []
+          end
+
+          # Return the information about a generator from its name.
+          #
+          # @param [ String ] name The name of the generator
+          #
+          # @return [ Object ] The information of the found generator or nil
+          #
+          def get(name)
+            self._list.detect { |entry| entry.name == name.to_sym }
+          end
+
+          # Register a generator by adding it to the list of existing generators.
+          #
+          # @param [ String ] name The name of the generator
+          # @param [ Class ] klass The class of the generator
+          # @param [ String ] description The description of the generator (can be nil)
+          #
+          # @return [ Boolean ] True if the registration has been successful, false otherwise.
+          #
+          def register(name, klass, description = nil)
+            return false unless self.get(name).nil?
+
+            self._list << OpenStruct.new({
+              name:         name.to_sym,
+              klass:        klass,
+              description:  description ? description.strip.gsub("\n", '') : nil
+            })
+
+            self._list.last
+          end
+        end
+
+      end
+
+    end
+  end
+end
+
+require 'locomotive/wagon/generators/site/base'
+require 'locomotive/wagon/generators/site/blank'
+require 'locomotive/wagon/generators/site/bootstrap'
+require 'locomotive/wagon/generators/site/foundation'
+require 'locomotive/wagon/generators/site/unzip'