konstruct 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eea3b69e1b18ba332817635e57c28aa3abe6811b
-  data.tar.gz: f999fd8311e6a205ef5397550cb664050768d783
+  metadata.gz: 7060840fc67ea5d400dfa5eb23c631f12a246809
+  data.tar.gz: 64186607120c776fac8a4cfdf787d1123c785d89
 SHA512:
-  metadata.gz: 8cbca349807f4f55af993c785186b960318637ffb05284093e595458ebabe4fabb3d8aae49b561d6c7fa32dab4b4109259866571c17119cf5ca5f00199737071
-  data.tar.gz: 418700fe2bfaf813edbbf86631f771b1de014f4acac03d47e5ff2ad1bd97f6289ffd7a218732cc020223553b52898306708f26d9bf1e824fe333d88281eb6a0e
+  metadata.gz: 483c01386db58e6f9ac3022b4b7ca71d193e461056f301d198452fe3fa982165b71b0c97e4da957a89ac0fe2bff287cb3ae993a7375e675befdf168dec8a35c1
+  data.tar.gz: 3f173c33a6856a4ae0d955b0490d483518f88de70f5c09bc03a8d221ce85902d3d7a85b6ac2d7a8a4a133ae867c6f23f4840947a13efe3d04a25d38157b65131

data/README.md

@@ -10,6 +10,7 @@ The Konstruct Cli provides tools to make working with Konstruct painless and qui
 - Scaffold out a new HTML, Jekyll or Angular site in seconds.
 - Gulp in a central location.
 - Develop with Browserify & PostCSS.
+- Build process to optimise assets for deployment.
 - Quick link to Konstruct Documentation.
 
 ## Installation
@@ -24,17 +25,17 @@ The Cli has a few very simple commands. If you get stuck simply `$ konstruct --h
 
 ### Konstruct Commands
 
-* [$ konstruct folders](#)
-* [$ konstruct create](#)
-* [$ konstruct refresh](#)
-* [$ konstruct watch](#)
-* [$ konstruct serve](#)
+* [$ konstruct folders](#folders)
+* [$ konstruct create](#create)
+* [$ konstruct refresh](#refresh)
+* [$ konstruct watch](#watch)
+* [$ konstruct build](#build)
 * [$ konstruct documentation](#documentation)
 
 #### Folders
 
     $ konstruct folders
-    
+
 Scaffolds a set of project folders from a template to help you organise your project better.
 
 **Customize Template**: You can customize the folder structure in `~/.konstruct/config.yml`.
@@ -42,31 +43,46 @@ Scaffolds a set of project folders from a template to help you organise your pro
 #### Create
 
     $ konstruct create [options]
-    
+
 **Options:**
-* --sudo : Run NPM install as root if your node installation requires root privileges. 
-    
+* --sudo : Run NPM install as root if your node installation requires root privileges.
+
 Creates a new Konstruct starter project through an interactive wizard.
 
 #### Refresh
 
     $ konstruct refresh [options]
-    
+
 **Options:**
 * --sudo : Run NPM install as root if your node installation requires root privileges.
-    
+
 Refreshes the project by installing dependencies again. Useful if you inherit a repo from another developer.
 
 #### Watch
 
     $ konstruct watch
-    
+
 Runs the global Gulp tools from your current working directory.
 
+#### Build
+
+    $ konstruct build [options]
+
+**Options:**
+* --staging : Run build process on staging branch.
+* --production : Run build process on production branch.
+
+Runs build scripts & optimisations on your codebase in the branches you specified in options.
+
+Currently optimising:
+
+* Minify app.js
+* Optimise images
+
 #### Documentation
 
     $ konstruct documentation
-    
+
 Loads up the [Konstruct Documentation](http://konstruct.github.io/) in your default browser.
 
 ## Contributing
@@ -76,4 +92,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/konstr
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/cli/deploy.rb

@@ -0,0 +1,73 @@
+# KONSTRUCT CLI [ DEVELOPMENT TASKS ] ==========================================
+
+# ====== INDEX  ================================================================
+# ==
+# == 1. WATCH
+# ==
+# ====== INDEX  ================================================================
+
+module Konstruct
+
+  class Deploy
+
+    # 1. S3 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+    def s3()
+
+      # 1.1. INITIALISE FUNCTIONS ----------------------------------------------
+
+      msg = Util::Message.new()
+      fs = Util::FS.new()
+      gulp = Util::Gulp.new()
+
+      # 1.1. END ---------------------------------------------------------------
+
+      # 1.2. BUILD DEPLOY COMMAND ----------------------------------------------
+
+      config = fs.read_project(path)
+      s3 = config['deployments']['s3']
+
+      # aws s3 sync . s3://appypet-dev/ --delete --exclude=".DS_Store/*" --exclude=".git/*" --exclude="assets/node_modules/*" --exclude="assets/js/*" --exclude="assets/scss/*"
+
+      # 1.2.1. DELETE
+
+      if s3['delete']
+
+        delete = "--delete"
+
+      else
+
+        delete = ""
+
+      end
+
+      # 1.2.1. END
+
+      # 1.2.2. EXCLUDE
+
+      config['exclude'].each do |key, array|
+        puts "#{key}-----"
+        puts array
+      end
+
+      # 1.2.2. END
+
+      # 1.2. END ---------------------------------------------------------------
+
+      # 1.3. RUN DEPLOY --------------------------------------------------------
+
+      puts "aws s3 sync . s3://#{s3['bucket']} #{delete} #{exlude}"
+
+      # 1.3. END ---------------------------------------------------------------
+
+    end
+
+    # 1. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+  end
+
+end
+
+# B. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+# END OF FILE ==================================================================

data/lib/cli/develop.rb

@@ -28,15 +28,62 @@ module Konstruct
 
       type = site['type']
 
-      if type == :html
+      if type == :html || type == :angular
 
-        stream = "html"
+        stream = "default"
 
       end
 
-      if type == :angular
+      if type == :jekyll
+
+        stream = "jekyll"
+
+      end
+
+      gulp.task('default', path, stream)
+
+      # 1.2. END ---------------------------------------------------------------
+
+    end
+
+    # 1. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+    # 2. BUILD +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+    def build(strategy, path)
+
+      # 2.1. INITIALISE FUNCTIONS ----------------------------------------------
+
+      msg = Util::Message.new()
+      fs = Util::FS.new()
+      gulp = Util::Gulp.new()
+
+      config = fs.read_project(path)
+
+      type = config['type']
+      branch = config['branches']
+
+      # 2.1. END ---------------------------------------------------------------
+
+      # 2.2. BUILD CONFIRMATION ------------------------------------------------
+
+      msg.paragraph("You are about to switch to your #{branch['staging']} branch to run gulp build tasks. Please make sure everything in your current branch is committed to avoid any conflicts and errors.")
+
+      continue = choose("Are you ready to continue?", :yes, :no)
+
+      if continue == :no
+
+        exit 0
+
+      end
 
-        stream = "angular"
+      # 2.2. END ---------------------------------------------------------------
+
+      # 2.3. SET GULP STREAM ---------------------------------------------------
+
+      if type == :html || type == :angular
+
+        stream = "default"
 
       end
 
@@ -46,13 +93,75 @@ module Konstruct
 
       end
 
-      gulp.default(path, stream)
+      # 2.3. END ---------------------------------------------------------------
 
-      # 1.2. END ---------------------------------------------------------------
+      # 2.4. SWITCH REPOS ------------------------------------------------------
+
+      # 2.4.1. CHECKOUT STAGING
+
+      if strategy == 'staging'
+
+        msg.paragraph("Switching to: #{branch['staging']}")
+        `git checkout #{branch['staging']}`
+        msg.success("Switched branch")
+
+        msg.paragraph("Pulling latest from: #{branch['staging']}")
+        `git pull`
+        msg.success("Pulled branch")
+
+        msg.paragraph("Merging #{branch['dev']} into #{branch['staging']}...")
+        `git merge #{branch['dev']}`
+        msg.success("Merged #{branch['dev']} into #{branch['staging']}")
+
+      elsif strategy == 'production'
+
+        msg.paragraph("Switching to: #{branch['production']}")
+        `git checkout #{branch['production']}`
+        msg.success("Switched branch")
+
+        msg.paragraph("Pulling latest from: #{branch['production']}")
+        `git pull`
+        msg.success("Pulled branch")
+
+        msg.paragraph("Merging #{branch['staging']} into #{branch['production']}...")
+        `git merge #{branch['staging']}`
+        msg.success("Merged #{branch['staging']} into #{branch['production']}")
+
+      else
+
+        msg.error("You did not specify a valid build strategy")
+
+      end
+
+      # 2.4.1. END
+
+      # 2.4. END ---------------------------------------------------------------
+
+      # 2.3. GULP BUILD TASK ---------------------------------------------------
+
+      msg.paragraph("Running build tasks")
+
+      gulp.task('build', path, stream)
+
+      msg.success("Build tasks completed")
+
+      # 2.3. END ---------------------------------------------------------------
+
+      # 2.2. GIT TASKS ---------------------------------------------------------
+
+      msg.paragraph("Committing build")
+      `git commit -m "Konstruct Build - #{ date.year }-#{ date.month }-#{ date.day }"`
+      msg.success("Commit successfull")
+
+      msg.paragraph("Pushing build")
+      `git push`
+      msg.success("Push successfull")
+
+      # 2.2. END ---------------------------------------------------------------
 
     end
 
-    # 1. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+    # 2. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
   end
 

data/lib/cli/project.rb

@@ -212,8 +212,11 @@ module Konstruct
 
         "konstruct_version" => Konstruct::VERSION,
         "date_installed" => date_installed,
-        "type" => type
-
+        "type" => type,
+        "branches" => config["branches"],
+        "deploy" => config["deploy"],
+        "deployments" => config["deployments"],
+        "exclude" => config["exclude"]
       }
 
       File.open("#{path}/.konstruct.yml","w") do |f|

data/lib/konstruct.rb

@@ -2,13 +2,18 @@
 
 # ====== INDEX  ================================================================
 # ==
-# == A. LOAD DEPENDENCIES
+# == 1. LOAD DEPENDENCIES
+# == 2. COMMANDER SCRIPT
+# == 3. SYSTEM TOOLS
+# == 4. PREFLIGHT CHECKS
+# == 5. PROJECT TOOLS
+# == 6. DEVELOPER TOOLS
 # ==
 # ====== INDEX  ================================================================
 
-# A. LOAD DEPENDENCIES +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# 1. LOAD DEPENDENCIES +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# A.1. EXTERNAL DEPENDENCIES ---------------------------------------------------
+# 1.1. EXTERNAL DEPENDENCIES ---------------------------------------------------
 
 require 'konstruct/version'
 require 'konstruct/template'
@@ -23,25 +28,25 @@ require 'pp'
 require 'net/http'
 require 'xmlsimple'
 
-# A.1. END ---------------------------------------------------------------------
+# 1.1. END ---------------------------------------------------------------------
 
-# A.2. INTERNAL DEPENDENCIES ---------------------------------------------------
+# 1.2. INTERNAL DEPENDENCIES ---------------------------------------------------
 
-#A.2.1. UTILITIES
+#1.2.1. UTILITIES
 
 require_relative 'utilities/utils'
 require_relative 'utilities/gulp'
 require_relative 'utilities/git'
 require_relative 'utilities/system'
 
-# A.2.2. CLI SCRIPTS
+# 1.2.2. CLI SCRIPTS
 
 require_relative 'cli/project'
 require_relative 'cli/develop'
 
-# A.2. END ---------------------------------------------------------------------
+# 1.2. END ---------------------------------------------------------------------
 
-# A.3. INITIALISE DEPENDENCIES -------------------------------------------------
+# 1.3. INITIALISE DEPENDENCIES -------------------------------------------------
 
 msg = Util::Message.new()
 fs = Util::FS.new()
@@ -49,30 +54,30 @@ sys = Util::System.new()
 project = Konstruct::Project.new()
 dev = Konstruct::Develop.new()
 
-# A.3. END ---------------------------------------------------------------------
+# 1.3. END ---------------------------------------------------------------------
 
-# A. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# 1. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# B. COMMANDER SCRIPT ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# 2. COMMANDER SCRIPT ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# B.1. GLOBAL VARIABLES --------------------------------------------------------
+# 2.1. GLOBAL VARIABLES --------------------------------------------------------
 
 projectDir = Dir.pwd
 
-# B.1. END ---------------------------------------------------------------------
+# 2.1. END ---------------------------------------------------------------------
 
-# B.1. PROGRAM META ------------------------------------------------------------
+# 2.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 ---------------------------------------------------------------------
+# 2.1. END ---------------------------------------------------------------------
 
-# B. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# 2. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# C. SYSTEM TOOLS ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# 3. SYSTEM TOOLS ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# C.1. INSTALL SYSTEM ----------------------------------------------------------
+# 3.1. INSTALL SYSTEM ----------------------------------------------------------
 
 command :init do |c|
 
@@ -87,21 +92,19 @@ command :init do |c|
 
 end
 
-# C.1. END ---------------------------------------------------------------------
+# 3.1. END ---------------------------------------------------------------------
 
-# C. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# 3. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# C. PREFLIGHT CHECKS ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# 4. PREFLIGHT CHECKS ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 sys.preflight()
 
-# C.1. END ---------------------------------------------------------------------
+# 4. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# C. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# 5. PROJECT TOOLS +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# D. PROJECT TOOLS +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-# D.1. FOLDERS -----------------------------------------------------------------
+# 5.1. FOLDERS -----------------------------------------------------------------
 
 command :folders do |c|
 
@@ -116,9 +119,9 @@ command :folders do |c|
 
 end
 
-# D.1. END ---------------------------------------------------------------------
+# 5.1. END ---------------------------------------------------------------------
 
-# D.1. CREATE ---------------------------------------------------------------------------------------------------------
+# 5.1. CREATE ---------------------------------------------------------------------------------------------------------
 
 # -- $ konstruct create
 
@@ -138,9 +141,9 @@ command :create do |c|
 
 end
 
-# D.1. END ---------------------------------------------------------------------
+# 5.1. END ---------------------------------------------------------------------
 
-# D.2. REFRESH ------------------------------------------------------------------
+# 5.2. REFRESH -----------------------------------------------------------------
 
 # -- $ konstruct refresh
 
@@ -160,9 +163,9 @@ command :refresh do |c|
 
 end
 
-# D.2. END ---------------------------------------------------------------------
+# 5.2. END ---------------------------------------------------------------------
 
-# D.1. DOCUMENTATION -----------------------------------------------------------
+# 5.3. DOCUMENTATION -----------------------------------------------------------
 
 # -- $ konstruct command ::
 
@@ -179,21 +182,13 @@ command :documentation do |c|
 
 end
 
-# D.1. END ---------------------------------------------------------------------
-
-# D. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-# D. DEVELOPER TOOLS +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
-
-# D.1. INSTALL -----------------------------------------------------------------
+# 5.3. END ---------------------------------------------------------------------
 
-# -- $ konstruct create :: Installs a new Konstruct project & installs dependencies if you already have a project installed.
+# 5. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
+# 6. DEVELOPER TOOLS +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-
-# D.1. END ---------------------------------------------------------------------
-
-# D.1. WATCH -------------------------------------------------------------------
+# 6.1. WATCH -------------------------------------------------------------------
 
 # -- $ konstruct command ::
 
@@ -221,32 +216,68 @@ command :watch do |c|
 
 end
 
-# D.1. END ---------------------------------------------------------------------
+# 6.1. END ---------------------------------------------------------------------
 
-# D.3. BUILD -------------------------------------------------------------------
+# 6.2. BUILD -------------------------------------------------------------------
 
 # -- $ konstruct command ::
 
+command :build do |c|
+
+  c.syntax = 'konstruct build --options'
+  c.summary = 'Build & optimise your code for deployment.'
+  c.description = 'Builds and optimise your code for deployment in staging & production branches.'
+  c.option '--staging', 'Build staging code.'
+  c.option '--production', 'Build production code.'
+  c.action do |args, options|
 
+    # 6.2.1. BUILD STAGING
 
-# D.3. END ---------------------------------------------------------------------
+    if options.staging
 
-# D.4. DEPLOY ------------------------------------------------------------------
+      msg.heading('Building Staging Strategy')
 
-# -- $ konstruct command ::
+      dev.build('staging', projectDir)
+
+    end
 
+    # 6.2.1. END
 
+    # 6.2.2. BUILD STAGING
 
-# D.4. END ---------------------------------------------------------------------
+    if options.production
 
-# D.5. RELEASE -----------------------------------------------------------------
+      msg.heading('Building Production Strategy');
+
+      puts "Building production strategy"
+
+    end
 
-# -- $ konstruct release --version ::
+    # 6.2.2. END
+
+    # 6.2.2. BUILD ERROR
+
+    unless options.staging || options.production
+
+      msg.error('You did not select a build strategy - Options: [--staging] [--production]');
+
+    end
+
+    # 6.2.2. END
+
+  end
+
+end
+# 6.2. END ---------------------------------------------------------------------
+
+# 6.3. DEPLOY ------------------------------------------------------------------
+
+# -- $ konstruct command ::
 
 
 
-# D.5. END ---------------------------------------------------------------------
+# 6.3. END ---------------------------------------------------------------------
 
-# D. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# 6. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
 # END OF FILE ==================================================================

data/lib/konstruct/template.rb

@@ -3,7 +3,12 @@ module Konstruct
   TEMPLATE = {
     "version" => Konstruct::VERSION,
     "repo" => "https://github.com/konstruct/",
-    "folders" => ["1--ci","2--design","3--working","4--www"],
+    "folders" => [
+      "1--ci",
+      "2--design",
+      "3--working",
+      "4--www"
+    ],
     "recipes" => {
       "html" => {
         "boilerplate" => [
@@ -65,7 +70,32 @@ module Konstruct
           ""
         ]
       }
-    }
+    },
+    "branches" => {
+      "dev" => "develop",
+      "staging" => "staging",
+      "production" => "master"
+    },
+    "deploy" => {
+      "dev" => "",
+      "staging" => "",
+      "production" => ""
+    },
+    "deployments" => {
+      "s3" => {
+        "bucket" => "s3://your-bucket/",
+        "delete" => true
+      },
+      "ftp" => {
+        "host" => "your-domain.com",
+        "path" => "/where/do/you/want/your/files"
+      }
+    },
+    "exclude" => [
+      "assets/js/*",
+      "assets/scss/*",
+      "assets/node_modules/*"
+    ]
   }
 
 end

data/lib/konstruct/version.rb

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

data/lib/utilities/gulp.rb

@@ -16,7 +16,7 @@ module Util
 
       # 1.1.1. GULP DEFAULT
 
-      def default(path, stream)
+      def task(task, path, stream)
 
         gulp = Util::Gulp.new()
         msg = Util::Message.new()
@@ -24,8 +24,8 @@ module Util
         gulp_path = File.expand_path('~/.konstruct/gulp')
 
         FileUtils.cd(gulp_path) do
-          
-          exec "gulp --path #{path} --stream #{stream}"
+
+          exec "gulp #{task} --path #{path} --stream #{stream}"
 
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: konstruct
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Adrian Kirsten
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -144,6 +144,7 @@ files:
 - bin/konstruct
 - bin/setup
 - konstruct.gemspec
+- lib/cli/deploy.rb
 - lib/cli/develop.rb
 - lib/cli/project.rb
 - lib/cli/scaffold.rb