locomotivecms_builder 1.0.0.alpha1

data/generators/content_type/app/content_types/%name%.yml.tt

@@ -0,0 +1,58 @@
+# Public name of this content type
+name: <%= config[:name].humanize %>
+
+# TODO: explain
+slug: <%= config[:name] %>
+
+# Explanation for the backoffice
+description: A description of the content type for the editors
+
+# Default field (e.g title)
+label_field_name: <%= config[:fields].first.name %>
+
+# Order of entries
+order_by: manually # default: manually, also available: created_at or any field slug
+
+# Order direction
+# order_direction: asc # default: asc, also available: desc
+
+# Display entries grouped by <field> in the backoffice
+# group_by: <your field>
+
+# Activate public 'create' API (e.g for a contact form)
+# public_submission_enabled: false
+
+# Emails to be notified on new entries using the public API
+# public_submission_accounts: ['john@acme.net']
+
+# Describe each field. The name shoud always be an underscored string
+fields: <% config[:fields].each_with_index do |field, index| %>
+- <%= field.name -%>: # Name of the field
+    label: <%= field.name.humanize %>
+    type: <%= field.type %>
+    required: <%= index == 0 ? true : field.required %>
+    hint: A description of the field for the editors
+    localized: false<% if field.type == 'text' %>
+    # Enable or not the RTE [html|text]
+    # text_formatting: html<% end -%><% if field.type == 'select' -%>
+    # if localized, use
+    #   en: ['option1_en', 'option2_en']
+    #   fr: ['option1_fr', 'option2_fr']
+    select_options: ['option 1', 'option 2', 'option 3']<% end -%><% if field.type == 'belongs_to'%>
+    # Slug of the target content type (eg post if this content type is a comment)
+    class_name: <your class slug><% end -%><% if field.type == 'has_many' -%>
+    # Define the slug of the target content type (eg. comments)
+    class_name: <your class slug>
+    # Define the name of the field referring to <%= config[:name].humanize -%> in the target content type (eg. post)
+    inverse_of: <field in your target content type>
+    # If you want to manage the entries of the relationship directly from the source entry
+    ui_enabled: true
+    <% end -%><% if field.type == 'many_to_many' -%>
+    # Define the slug of the target content type
+    class_name: <your class slug>
+    inverse_of: <field in your target content type>
+    # If you want to manage the entries of the relationship directly from the source entry
+    ui_enabled: true
+    <% end -%>
+
+<% end -%>

data/generators/content_type/data/%name%.yml.tt

@@ -0,0 +1,24 @@
+<% 4.times do |i| -%>
+- "Sample <%= i + 1 %>":
+<% config[:fields][1..-1].each do |field| -%>
+<% case field.type -%>
+<% when 'string' -%>
+    <%= field.name -%>: "<%= Faker::Lorem.sentence -%>"
+<% when 'text' -%>
+    <%= field.name -%>: "<%= Faker::Lorem.paragraph -%>"
+<% when 'select' -%>
+    <%= field.name -%>: null # Use the value of a select option defined in the app/content_types/<%= config[:name] -%>.rb file.
+<% when 'boolean' -%>
+    <%= field.name -%>: true # Or false
+<% when 'date' -%>
+    <%= field.name -%>: <%= Time.now.strftime('%Y/%M/%d') -%> # YYYY/MM/DD
+<% when 'file' -%>
+    <%= field.name -%>: null # Path to a file in the public/samples folder or to a remote and external file.
+<% when 'belongs_to' -%>
+    <%= field.name -%>: null # Permalink of the target entry
+<% when 'many_to_many' -%>
+    <%= field.name -%>: [] # Permalink of the target entries
+<% end -%>
+<% end -%>
+
+<% end -%>

data/generators/page/template.liquid.haml.tt

@@ -0,0 +1,35 @@
+---
+title: <%= config[:slug].humanize -%>
+<% if config[:translated] %>
+
+# TODO: explain it (used only if the page is not for the defaut locale)
+slug: <%= config[:slug] -%>
+<% end %>
+
+# TODO: explain it
+listed: true
+
+# TODO: explain it
+published: true
+
+# TODO: explain it
+# position: 1
+
+# TODO: explain it
+# redirect_url: "<url to a page or to a remote url>"
+
+# TODO: explain it
+# content_type: "<slug of one of the content types>"
+
+# TODO: explain it
+# editable_elements:
+#   'some_block/some_slug': "<text>"
+#   'some_block/some_slug': "<relative path to the file under the public/samples folder>"
+---
+{% extends parent %}
+
+{% block main %}
+
+%p Hello world
+
+{% endblock %}

data/generators/page/template.liquid.tt

@@ -0,0 +1 @@
+TEST LIQUID

data/generators/snippet/template.liquid.haml.tt

@@ -0,0 +1,4 @@
+{% raw %}
+/ To use your snippet, just add the following code in your page template
+/ {% include <%= config[:slug] -%> %}
+{% endraw %}

data/generators/snippet/template.liquid.tt

@@ -0,0 +1,4 @@
+{% raw %}
+<!-- To use your snippet, just add the following code in your page template-->
+<!-- {% include <%= config[:slug] -%> %} -->
+{% endraw %}

data/lib/locomotive/builder/cli.rb

@@ -0,0 +1,225 @@
+require 'thor'
+require 'thor/runner'
+
+module Locomotive
+  module Builder
+    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 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::Builder::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:
+
+            * builder generate content_type songs name:string duration:string
+
+            * builder 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::Builder.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:
+
+            * builder generate page contact
+
+            * builder generate page about_us/me
+        LONGDESC
+        def page(fullpath)
+          if check_path!
+            Locomotive::Builder.generate :page, fullpath, self.options['path']
+          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:
+
+            * builder generate snippet footer
+        LONGDESC
+        def snippet(slug)
+          if check_path!
+            Locomotive::Builder.generate :snippet, slug, self.options['path']
+          end
+        end
+
+      end
+
+      class Main < Thor
+
+        include Locomotive::Builder::CLI::CheckPath
+
+        desc 'version', 'Version of the LocomotiveCMS builder'
+        def version
+          require 'locomotive/builder/version'
+          say Locomotive::Builder::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/builder/generators/site'
+          generator = Locomotive::Builder::Generators::Site.get(options[:template])
+          if generator.nil?
+            say "Unknown site template '#{options[:template]}'", :red
+          else
+            Locomotive::Builder.init(name, path, generator)
+          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/builder/generators/site'
+          if Locomotive::Builder::Generators::Site.empty?
+            say 'No templates', :red
+          else
+            Locomotive::Builder::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::Builder.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::Builder.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 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 pull(env, path = '.')
+          if check_path!(path)
+            if connection_info = self.retrieve_connection_info(env, path)
+              begin
+                Locomotive::Builder.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::Builder.destroy(path, connection_info)
+              else
+                say 'The destroy operation has been cancelled', :red
+              end
+            end
+          end
+        end
+
+        # desc "pull NAME SITE_URL EMAIL PASSWORD", "Pull an existing LocomotiveCMS site powered by the engine"
+        # def pull(name, site_url, email, password)
+        #   say("ERROR: \"#{name}\" directory already exists", :red) and return if File.exists?(name)
+        #   Locomotive::Builder.pull(name, site_url, email, password)
+        # 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/builder/exceptions.rb

@@ -0,0 +1,17 @@
+module Locomotive
+  module Builder
+
+    class DefaultException < ::Exception
+
+      def initialize(message = nil)
+        # no specific treatment for now
+        super
+      end
+
+    end
+
+    class MounterException < DefaultException
+    end
+
+  end
+end

data/lib/locomotive/builder/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 Builder
+    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/builder/generators/page.rb

@@ -0,0 +1,57 @@
+require 'thor/group'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Locomotive
+  module Builder
+    module Generators
+      class Page < Thor::Group
+
+        include Thor::Actions
+
+        argument :slug
+        argument :target_path # path to the site
+
+        attr_accessor :haml, :locales
+
+        def ask_for_haml_and_locales
+          self.locales = []
+          self.haml    = yes?('Do you prefer a HAML template ?')
+
+          if yes?('Is your page localized ?')
+            self.locales = ask('What are the locales other than the default one (comma separated) ?').split(',').map(&:strip)
+          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/builder/generators/site/base.rb

@@ -0,0 +1,30 @@
+require 'thor/group'
+require 'active_support'
+require 'active_support/core_ext'
+
+module Locomotive
+  module Builder
+    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/builder/generators/site/blank.rb

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

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

@@ -0,0 +1,35 @@
+module Locomotive
+  module Builder
+    module Generators
+      module Site
+
+        class Bootstrap < Base
+
+          def copy_sources
+            directory('.', self.destination, { recursive: true }, {
+              name:     self.name,
+              version:  Locomotive::Builder::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::Builder::Generators::Site.register(:bootstrap, Bootstrap, %{
+          A LocomotiveCMS site powered by Twitter bootstrap (v2.2.2).
+        })
+      end
+    end
+  end
+end

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

@@ -0,0 +1,97 @@
+require 'ostruct'
+require 'singleton'
+
+module Locomotive
+  module Builder
+    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::Builder::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::Builder::Generators::Site::List.instance.get(name)
+        end
+
+        # List all the generators
+        #
+        # @return [ Array ] The filtered (or not) list of generators
+        #
+        def self.list
+          Locomotive::Builder::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::Builder::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/builder/generators/site/base'
+require 'locomotive/builder/generators/site/blank'
+require 'locomotive/builder/generators/site/bootstrap'