konstruct 0.9.1 → 1.0.0

data/lib/konstruct.rb

@@ -1,179 +1,252 @@
-# KONSTRUCT CLI [ COMMANDER ]  ========================================================================================
+# KONSTRUCT CLI [ COMMANDER ]  =================================================
 
-# ====== INDEX  =======================================================================================================
+# ====== INDEX  ================================================================
 # ==
 # == A. LOAD DEPENDENCIES
 # ==
-# ====== INDEX  =======================================================================================================
+# ====== INDEX  ================================================================
 
-# A. LOAD DEPENDENCIES ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# A. LOAD DEPENDENCIES +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# A.1. EXTERNAL DEPENDENCIES ------------------------------------------------------------------------------------------
+# A.1. EXTERNAL DEPENDENCIES ---------------------------------------------------
 
-require "konstruct/version"
-require "konstruct/config"
+require 'konstruct/version'
+require 'konstruct/template'
 require 'rubygems'
 require 'commander/import'
 require 'paint'
 require 'launchy'
 require 'minigit'
+require 'yaml'
 require 'json'
 require 'pp'
+require 'net/http'
+require 'xmlsimple'
 
-# A.1. END ------------------------------------------------------------------------------------------------------------
+# A.1. END ---------------------------------------------------------------------
 
-# A.2. INTERNAL DEPENDENCIES ------------------------------------------------------------------------------------------
+# A.2. INTERNAL DEPENDENCIES ---------------------------------------------------
 
 #A.2.1. UTILITIES
 
 require_relative 'utilities/utils'
 require_relative 'utilities/gulp'
 require_relative 'utilities/git'
+require_relative 'utilities/system'
 
 # A.2.2. CLI SCRIPTS
 
-require_relative 'cli/scaffold'
 require_relative 'cli/project'
-require_relative 'cli/documentation'
-require_relative 'cli/init'
 require_relative 'cli/develop'
 
-# A.2. END ------------------------------------------------------------------------------------------------------------
+# A.2. END ---------------------------------------------------------------------
 
-# A.3. INITIALISE DEPENDENCIES ----------------------------------------------------------------------------------------
+# A.3. INITIALISE DEPENDENCIES -------------------------------------------------
 
 msg = Util::Message.new()
 fs = Util::FS.new()
-cli = Konstruct::Cli.new()
+sys = Util::System.new()
+project = Konstruct::Project.new()
+dev = Konstruct::Develop.new()
 
-# A.3. END ------------------------------------------------------------------------------------------------------------
+# A.3. END ---------------------------------------------------------------------
 
-# A. END ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# A. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# B. COMMANDER SCRIPT +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# B. COMMANDER SCRIPT ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# B.1. GLOBAL VARIABLES -----------------------------------------------------------------------------------------------
+# B.1. GLOBAL VARIABLES --------------------------------------------------------
 
 projectDir = Dir.pwd
-#projectDir = "/Users/traaidmark/Sites/traaidmark/projects/konstruct/testground/4--www" # FOR TESTING ONLY
 
-# B.1. END ------------------------------------------------------------------------------------------------------------
+# B.1. END ---------------------------------------------------------------------
 
-# B.1. PROGRAM META ---------------------------------------------------------------------------------------------------
+# B.1. PROGRAM META ------------------------------------------------------------
 
 program :version, Konstruct::VERSION
 program :description, 'The Konstruct CLI provides scaffolding and other tools to help you get up and running quicker, and work faster.'
 
-# B.1. END ------------------------------------------------------------------------------------------------------------
+# B.1. END ---------------------------------------------------------------------
 
-# B.2. COMMAND: DOCUMENTATION -----------------------------------------------------------------------------------------
+# B. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# -- DESCRIPTION: Launches Konstruct documentation in a browser
+# C. SYSTEM TOOLS ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# -- USAGE: $ konstruct documentation
+# C.1. INSTALL SYSTEM ----------------------------------------------------------
 
 command :init do |c|
-    
-    c.syntax = 'konstruct init'
-    c.summary = 'Initialises the Konstruct Cli'
-    c.description = 'Initialises the Konstruct Cli by installing libraries and other extensions you might need.'
-    c.action do |args, options|
-        
-        cli.init()
 
-    end
+  c.syntax = 'konstruct init'
+  c.summary = 'Installs local tools for Konstruc CLI'
+  c.description = 'Scaffolds a set of project folders from a template to help you organise your project better.'
+  c.action do |args, options|
+
+    sys.init()
+
+  end
 
 end
 
-default_command :init
+# C.1. END ---------------------------------------------------------------------
 
-# B.2. END ------------------------------------------------------------------------------------------------------------
+# C. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# B.3. COMMAND: SCAFFOLD -----------------------------------------------------------------------------------------
+# C. PREFLIGHT CHECKS ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# -- DESCRIPTION: Launches Konstruct documentation in a browser
+sys.preflight()
 
-# -- USAGE: $ konstruct documentation
+# C.1. END ---------------------------------------------------------------------
 
-command :scaffold do |c|
-    
-    c.syntax = 'konstruct scaffold'
-    c.summary = 'Launches Konstruct documentation in a browser'
-    c.description = 'Launches Konstruct documentation in a browser'
-    c.action do |args, options|
-        
-        cli.scaffold(projectDir)
+# C. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-    end
+# D. PROJECT TOOLS +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+# D.1. FOLDERS -----------------------------------------------------------------
+
+command :folders do |c|
+
+  c.syntax = 'konstruct folders'
+  c.summary = 'Create preset project folders from a template.'
+  c.description = 'Scaffolds a set of project folders from a template to help you organise your project better.'
+  c.action do |args, options|
+
+    project.folders(projectDir)
+
+  end
 
 end
 
-# B.3. END ------------------------------------------------------------------------------------------------------------
+# D.1. END ---------------------------------------------------------------------
 
-# B.4. COMMAND: SKELETON ----------------------------------------------------------------------------------------------
+# D.1. CREATE ---------------------------------------------------------------------------------------------------------
 
-# -- DESCRIPTION: Scaffolds a skeleton project folder structure for you.
+# -- $ konstruct create
 
-# -- USAGE: $ konstruct skeleton
+command :create do |c|
 
-command :project do |c|
-    
-    c.syntax = 'konstruct project'
-    c.summary = 'Builds a skeleton project folder structure for you.'
-    c.description = 'Builds out a new global project file structure for you to get started with quickly.'
-    c.example 'Structure:', '[1--ci, 2--design, 3--working, 4--www]'
-    c.action do |args, options|
+  c.syntax = 'konstruct create [options]'
+  c.summary = 'Create a new Konstruct project.'
+  c.description = 'Creates a new starter project from the chosen flavours of Konstruct boilerplates.'
+  c.option '--sudo', 'Runs install tasks as root.'
+  c.action do |args, options|
 
-        cli.new_project(projectDir)
+    options.default :sudo => false
 
-    end
+    project.create(projectDir, options.sudo)
+
+  end
 
 end
 
-# B.4. END ------------------------------------------------------------------------------------------------------------
+# D.1. END ---------------------------------------------------------------------
 
-# B.5. COMMAND: GULP --------------------------------------------------------------------------------------------------
+# D.2. REFRESH ------------------------------------------------------------------
 
-# -- DESCRIPTION: Launches Konstruct documentation in a browser
+# -- $ konstruct refresh
 
-# -- USAGE: $ konstruct documentation
+command :refresh do |c|
 
-command :develop do |c|
-    
-    c.syntax = 'konstruct develop'
-    c.summary = 'Launches Konstruct dev tools to help you build things quicker.'
-    c.description = 'Launches Konstruct dev tools to help you build things quicker.'
-    c.action do |args, options|
-        
-        cli.develop(projectDir)
+  c.syntax = 'konstruct refresh [options]'
+  c.summary = 'Refresh external assets'
+  c.description = 'Re-installs NPM assets. Usefull when you pull an existing project that did not commit NPM assets.'
+  c.option '--sudo', 'Runs install tasks as root.'
+  c.action do |args, options|
 
-    end
+    options.default :sudo => false
 
-end
+    project.create(projectDir, options.sudo)
 
-# B.5. END ------------------------------------------------------------------------------------------------------------
+  end
 
-# B.5. COMMAND: DOCUMENTATION -----------------------------------------------------------------------------------------
+end
+
+# D.2. END ---------------------------------------------------------------------
 
-# -- DESCRIPTION: Launches Konstruct documentation in a browser
+# D.1. DOCUMENTATION -----------------------------------------------------------
 
-# -- USAGE: $ konstruct documentation
+# -- $ konstruct command ::
 
 command :documentation do |c|
-    
+
     c.syntax = 'konstruct documentation'
     c.summary = 'Launches Konstruct documentation in a browser'
     c.description = 'Launches Konstruct documentation in a browser'
     c.action do |args, options|
 
-        cli.documentation()
+      project.documentation()
 
     end
 
 end
 
-# B.5. END ------------------------------------------------------------------------------------------------------------
+# D.1. END ---------------------------------------------------------------------
+
+# D. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+# D. DEVELOPER TOOLS +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+# D.1. INSTALL -----------------------------------------------------------------
+
+# -- $ konstruct create :: Installs a new Konstruct project & installs dependencies if you already have a project installed.
+
+
+
+# D.1. END ---------------------------------------------------------------------
+
+# D.1. WATCH -------------------------------------------------------------------
+
+# -- $ konstruct command ::
+
+command :watch do |c|
+
+  c.syntax = 'konstruct watch'
+  c.summary = 'Watch and process your work.'
+  c.description = 'Runs global konstruct.gulp process with various options to suit most development needs.'
+  c.option '--legacy', 'Run legacy gulp tasks.'
+  c.action do |args, options|
+
+    options.default :legacy => false
+
+    if options.legacy
+
+      dev.legacy(projectDir)
+
+    else
+
+      dev.watch(projectDir)
+
+    end
+
+  end
+
+end
+
+# D.1. END ---------------------------------------------------------------------
+
+# D.3. BUILD -------------------------------------------------------------------
+
+# -- $ konstruct command ::
+
+
+
+# D.3. END ---------------------------------------------------------------------
+
+# D.4. DEPLOY ------------------------------------------------------------------
+
+# -- $ konstruct command ::
+
+
+
+# D.4. END ---------------------------------------------------------------------
+
+# D.5. RELEASE -----------------------------------------------------------------
+
+# -- $ konstruct release --version ::
+
+
+
+# D.5. END ---------------------------------------------------------------------
 
-# B. END ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# D. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# END OF FILE =========================================================================================================
+# END OF FILE ==================================================================

data/lib/konstruct/template.rb

@@ -0,0 +1,71 @@
+module Konstruct
+
+  TEMPLATE = {
+    "version" => Konstruct::VERSION,
+    "repo" => "https://github.com/konstruct/",
+    "folders" => ["1--ci","2--design","3--working","4--www"],
+    "recipes" => {
+      "html" => {
+        "boilerplate" => [
+          "",
+          "boilerplate.html.git",
+          "www",
+          ""
+        ],
+        "styles" => [
+          "/assets",
+          "konstruct.scss.git",
+          "lib",
+          "scss"
+        ],
+        "scripts" => [
+          "/assets",
+          "konstruct.js.git",
+          "lib",
+          ""
+        ]
+      },
+      "jekyll" => {
+        "boilerplate" => [
+          "",
+          "boilerplate.jekyll.git",
+          "www",
+          ""
+        ],
+        "styles" => [
+          "/assets",
+          "konstruct.scss.git",
+          "lib",
+          "scss"
+        ],
+        "scripts" => [
+          "/assets",
+          "konstruct.js.git",
+          "lib",
+          ""
+        ]
+      },
+      "angular" => {
+        "boilerplate" => [
+          "",
+          "boilerplate.angular.git",
+          "www",
+          ""
+        ],
+        "styles" => [
+          "/assets",
+          "konstruct.scss.git",
+          "lib",
+          "scss"
+        ],
+        "scripts" => [
+          "/assets",
+          "konstruct.js.angular.git",
+          "lib",
+          ""
+        ]
+      }
+    }
+  }
+
+end

data/lib/konstruct/version.rb

@@ -1,3 +1,3 @@
 module Konstruct
-  VERSION = "0.9.1"
+  VERSION = "1.0.0"
 end

data/lib/utilities/gulp.rb

@@ -1,54 +1,44 @@
-# KONSTRUCT CLI [ UTILITY MODULE ] ====================================================================================
+# KONSTRUCT CLI [ UTILITY MODULE ] =============================================
 
-# ====== INDEX  =======================================================================================================
+# ====== INDEX  ================================================================
 # ==
-# == A. GULP MODULES
+# == 1. GULP MODULES
 # ==
-# ====== INDEX  =======================================================================================================
+# ====== INDEX  ================================================================
 
-# A. GULP MODULES +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# 1. GULP MODULES ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 module Util
-    
-    # A.1. GIT COMMANDS -----------------------------------------------------------------------------------------------
-   
+
+    # 1.1. GIT COMMANDS --------------------------------------------------------
+
     class Gulp
-        
-        # A.1.1. GULP DEFAULT
-       
-        def default(path, serving)
-            
-            gulp = Util::Gulp.new()
-            msg = Util::Message.new()
-            
-            gulp_path = File.expand_path('~/.konstruct/gulp')
-            
-            FileUtils.cd(gulp_path) do
-                
-                if serving == true
-                    
-                    exec "gulp --path #{path}"
-                    
-                else 
-                   
-                    msg.heading("Run `$ jekyll serve --watch` in a new terminal window.")
-                    
-                    exec "gulp --noserve --path #{path}"
-                    
-                end
-
-            end
-            
+
+      # 1.1.1. GULP DEFAULT
+
+      def default(path, stream)
+
+        gulp = Util::Gulp.new()
+        msg = Util::Message.new()
+
+        gulp_path = File.expand_path('~/.konstruct/gulp')
+
+        FileUtils.cd(gulp_path) do
+          
+          exec "gulp --path #{path} --stream #{stream}"
+
         end
-        
-        # A.1.1. END
-        
+
+      end
+
+      # 1.1.1. END
+
     end
-    
-    # A.1. END --------------------------------------------------------------------------------------------------------
-    
+
+    # 1.1. END -----------------------------------------------------------------
+
 end
 
-# A. END ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# A. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# END OF FILE =========================================================================================================
+# END OF FILE ==================================================================