konstruct 0.9.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47a7e483bdf66eea90939bc07987b9282cc3c1cb
-  data.tar.gz: 5b24e1634b7a0c6815ee559a1d31cbd52728138d
+  metadata.gz: eea3b69e1b18ba332817635e57c28aa3abe6811b
+  data.tar.gz: f999fd8311e6a205ef5397550cb664050768d783
 SHA512:
-  metadata.gz: e5efbe44fafe5ef72d82905a70fe0ec2d8c5dc08adaaa916c2f3723db911294e9192c0dbd14dd5ca30abc92a5ce897758a6927f06492ee850fa7f883007bfe6c
-  data.tar.gz: 8bd43f73eabbfdf6962cc761b712c5857f2e0fe3319394f3b912f04ce8d32c9222b2325698b2f32cbc97481224077d72a198f4172580cad0a6b05df3a566a2d1
+  metadata.gz: 8cbca349807f4f55af993c785186b960318637ffb05284093e595458ebabe4fabb3d8aae49b561d6c7fa32dab4b4109259866571c17119cf5ca5f00199737071
+  data.tar.gz: 418700fe2bfaf813edbbf86631f771b1de014f4acac03d47e5ff2ad1bd97f6289ffd7a218732cc020223553b52898306708f26d9bf1e824fe333d88281eb6a0e

data/README.md

@@ -4,13 +4,12 @@
 
 The Konstruct Cli provides tools to make working with Konstruct painless and quick. You can access documentation, build a new project structure and scaffold a new site with simple to use commands.
 
-### Features
+### Key Features
 
 - Set up a new project structure in seconds.
 - Scaffold out a new HTML, Jekyll or Angular site in seconds.
 - Gulp in a central location.
-- Browserify JS architecture.
-- Usage statistics (local only). *Coming Soon* 
+- Develop with Browserify & PostCSS.
 - Quick link to Konstruct Documentation.
 
 ## Installation
@@ -18,38 +17,51 @@ The Konstruct Cli provides tools to make working with Konstruct painless and qui
 You can install Konstruct Cli by running:
 
     $ gem install konstruct
-    
-When it's installed simply run:
-
-    $ konstruct
 
-## Usage
+## Commands
 
 The Cli has a few very simple commands. If you get stuck simply `$ konstruct --help` for help. You can also get instructions for every command with `$ konstruct [COMMAND] --help`
 
-### Available Commands
+### Konstruct Commands
 
-#### Scaffold
-    
-    $ konstruct scaffold
+* [$ konstruct folders](#)
+* [$ konstruct create](#)
+* [$ konstruct refresh](#)
+* [$ konstruct watch](#)
+* [$ konstruct serve](#)
+* [$ konstruct documentation](#documentation)
+
+#### Folders
+
+    $ konstruct folders
     
-Scaffolds out a new site based on your choice of technology (Static html, Jekyll or Angularjs), installs default dependencies & initialises your new site with your GIT repository.
+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`.
 
-#### Develop
+#### Create
+
+    $ konstruct create [options]
     
-    $ konstruct develop
+**Options:**
+* --sudo : Run NPM install as root if your node installation requires root privileges. 
     
-Determines the type of site you are building, and runs a centrally installed gulp task accordingly.
+Creates a new Konstruct starter project through an interactive wizard.
 
-#### Project
+#### Refresh
 
-    $ konstruct project
+    $ konstruct refresh [options]
+    
+**Options:**
+* --sudo : Run NPM install as root if your node installation requires root privileges.
     
-The project command builds a basic starter project template for common website projects. It builds common folders to ensure your project is tidy and organised.
+Refreshes the project by installing dependencies again. Useful if you inherit a repo from another developer.
+
+#### Watch
 
-#### Stat
+    $ konstruct watch
     
-This feature is coming soon.
+Runs the global Gulp tools from your current working directory.
 
 #### Documentation
 
@@ -57,12 +69,6 @@ This feature is coming soon.
     
 Loads up the [Konstruct Documentation](http://konstruct.github.io/) in your default browser.
 
-#### Init
-
-    $ konstruct init
-    
-Initialises the Cli by installing any libraries and extensions you might require to work with Konstruct. This command only runs once (usually when you run `$ konstruct` for the first time), and then simply displays a welcome screen.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/konstruct/konstruct.cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/konstruct.gemspec

@@ -17,15 +17,15 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files`.split("\n")
   spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   spec.require_paths = ['lib']
-    
-    dependencies = ['commander', 'minigit', 'paint', 'launchy', 'json']
-    
+
+    dependencies = ['commander', 'minigit', 'paint', 'launchy', 'json', 'xml-simple']
+
     dependencies.each { |d|
-        
+
         spec.add_dependency d
-        
+
     }
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
-end
+end

data/lib/cli/develop.rb

@@ -1,56 +1,63 @@
-# KONSTRUCT CLI [ KONSTRUCT MODULE ] ==================================================================================
+# KONSTRUCT CLI [ DEVELOPMENT TASKS ] ==========================================
 
-# ====== INDEX  =======================================================================================================
+# ====== INDEX  ================================================================
 # ==
-# == A. SKELETON PROJECT CREATOR
+# == 1. WATCH
 # ==
-# ====== INDEX  =======================================================================================================
-
-# A. SKELETON PROJECT CREATOR +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# ====== INDEX  ================================================================
 
 module Konstruct
-   
-    class Cli
-        
-        def develop(path)
-            
-            # B.1. INITIALISE FUNCTIONS -------------------------------------------------------------------------------
-            
-            msg = Util::Message.new()
-            fs = Util::FS.new()
-            gulp = Util::Gulp.new()
-            
-            # B.1. END ------------------------------------------------------------------------------------------------
-            
-            # B.2. DETERMINE WHAT TOOL TO RUN -------------------------------------------------------------------------
-            
-            site = fs.read_json(path)
-            type = site['type']
-            
-            if type == "Default" || type == "Angular"
-               
-                serving = true
-                
-                gulp.default(path, serving)
-                
-            end
-            
-            if type == "Jekyll"
-               
-                serving = false
-                
-                gulp.default(path, serving)
-                
-            end
-            
-            # B.2. END ------------------------------------------------------------------------------------------------
-            
-        end
-        
+
+  class Develop
+
+    # 1. WATCH +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+    def watch(path)
+
+      # 1.1. INITIALISE FUNCTIONS ----------------------------------------------
+
+      msg = Util::Message.new()
+      fs = Util::FS.new()
+      gulp = Util::Gulp.new()
+
+      # 1.1. END ---------------------------------------------------------------
+
+      # 1.2. RUN DEV TASK ------------------------------------------------------
+
+      site = fs.read_project(path)
+
+      type = site['type']
+
+      if type == :html
+
+        stream = "html"
+
+      end
+
+      if type == :angular
+
+        stream = "angular"
+
+      end
+
+      if type == :jekyll
+
+        stream = "jekyll"
+
+      end
+
+      gulp.default(path, stream)
+
+      # 1.2. END ---------------------------------------------------------------
+
     end
-    
+
+    # 1. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+  end
+
 end
 
-# B. END ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# B. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 
-# END OF FILE =========================================================================================================
+# END OF FILE ==================================================================

data/lib/cli/project.rb

@@ -1,90 +1,342 @@
-# KONSTRUCT CLI [ KONSTRUCT MODULE ] ==================================================================================
+# KONSTRUCT CLI [ KONSTRUCT MODULE ] ===========================================
 
-# ====== INDEX  =======================================================================================================
+# ====== INDEX  ================================================================
 # ==
-# == A. SKELETON PROJECT CREATOR
+# == 1. FOLDERS
+# == 2. CREATE
+# == 3. REFRESH
 # ==
-# ====== INDEX  =======================================================================================================
-
-# A. SKELETON PROJECT CREATOR +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+# ====== INDEX  ================================================================
 
 module Konstruct
-   
-    class Cli
-        
-        def new_project(path)
-            
-            # B.1. INITIALISE FUNCTIONS -------------------------------------------------------------------------------
-            
-            msg = Util::Message.new()
-            fs = Util::FS.new()
-            
-            # B.1. END ------------------------------------------------------------------------------------------------
-            
-            msg.heading("CREATING SKELETON PROJECT STRUCTURE")
-            
-            # B.2. IS YOUR DIRECTORY EMPTY? ---------------------------------------------------------------------------
-        
-            puts fs.clear_directory(path)
-
-            # B.2. END ------------------------------------------------------------------------------------------------
-            
-            # B.3. CREATE SKELETON ------------------------------------------------------------------------------------
-            
-            # B.3.1. FOLDER STRUCTURE
-            
-            structure = ['1--ci', '2--design', '3--working', '4--www']
-
-            # B.3.1. END
-            
-            # B.3.2. CONFIRM BUILD
-            
-            puts Paint["The following directory structure will be created for you:", "999999"]
-            
-            puts ""
-            
-            structure.each { |f| 
-                
-                puts Paint["-- #{ f }", "999999"]
-                
-            }
-            
-            puts ""
-            
-            choice = choose("Do you want to install the structure above?", :yes, :no)
-            
-            # B.3.2. END
-            
-            # B.3.3. BUILD STRUCTURE
-
-            if choice == :yes 
-
-                structure.each { |f| 
-                
-                    Dir.mkdir "#{ path }/#{ f }"
-
-                }
-                
-                msg.success('Successfully created your skeleton. Go do something awesome!')
-                
-                exit(0)
-
-            else
-
-                exit(0)
-
-            end
-
-            # B.3.7. END
-            
-            # B.3. END ------------------------------------------------------------------------------------------------
-            
+
+  class Project
+
+    # 1. FOLDERS +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+    def folders(path)
+
+      # 1.1. INIT FUNCTIONS ----------------------------------------------------
+
+      msg = Util::Message.new()
+      fs = Util::FS.new()
+
+      # 1.1. END ---------------------------------------------------------------
+
+      # 1.2. HEADING -----------------------------------------------------------
+
+      msg.heading("CREATING PROJECT FOLDER STRUCTURE")
+
+      # 1.2. END ---------------------------------------------------------------
+
+      # 1.3. EMPTY DIRECTORY ---------------------------------------------------
+
+      puts fs.clear_directory(path)
+
+      # 1.3. END ---------------------------------------------------------------
+
+      # 1.4. SET FOLDER STRUCTURE ----------------------------------------------
+
+      config_dir = File.expand_path('~/.konstruct')
+
+      hash = YAML.load_file("#{config_dir}/config.yml")
+
+      structure = hash["folders"]
+
+      # 1.4. END ---------------------------------------------------------------
+
+      # 1.5. CONFIRM FOLDER STRUCTURE ------------------------------------------
+
+      puts Paint["Folders location:", "999999"]
+      puts Paint["-- #{ path }", "999999"]
+      puts ""
+      puts Paint["Folder structure:", "999999"]
+
+      structure.each { |f|
+        puts Paint["-- #{ f }", "999999"]
+      }
+
+      puts ""
+      choice = choose("Do you want to install the structure above?", :yes, :no)
+
+      # 1.5. END ---------------------------------------------------------------
+
+      # 1.6. BUILD FOLDERS -----------------------------------------------------
+
+      if choice == :yes
+
+        structure.each { |f|
+
+          Dir.mkdir "#{ path }/#{ f }"
+
+        }
+
+        msg.success('Installed Folders')
+
+        exit(0)
+
+      else
+
+        exit(0)
+
+      end
+
+      # 1.6. END ---------------------------------------------------------------
+
+    end
+
+    # 1. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+    # 2. CREATE ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+    def create(path, sudo)
+
+      # 2.1. INIT FUNCTIONS ----------------------------------------------------
+
+      msg = Util::Message.new()
+      fs = Util::FS.new()
+      git = Util::Git.new()
+
+      config = fs.read_config
+
+      recipe = config["recipes"]
+      repo = config["repo"]
+      assets = config["paths"]
+
+      # 2.1. END ---------------------------------------------------------------
+
+      # 2.2. HEADING -----------------------------------------------------------
+
+      msg.heading("CREATE NEW KONSTRUCT PROJECT")
+
+      # 2.2. END ---------------------------------------------------------------
+
+      # 2.3. IS YOUR DIRECTORY EMPTY? ------------------------------------------
+
+      fs.clear_directory(path)
+
+      # 2.3. END ---------------------------------------------------------------
+
+      # 2.4. INSTALL BOILERPLATE -----------------------------------------------
+
+      type = choose("What type of site are you building?", :html, :jekyll, :angular)
+
+      if type == :html
+
+        recipe["html"].each do |key, val|
+          git.install("#{path}#{val[0]}", "#{repo}#{val[1]}", val[2], val[3])
+          msg.success("Installed #{ key }");
+        end
+
+      end
+
+      if type == :jekyll
+
+        recipe["jekyll"].each do |key, val|
+          git.install("#{path}#{val[0]}", "#{repo}#{val[1]}", val[2], val[3])
+          msg.success("Installed #{ key }");
+        end
+
+      end
+
+      if type == :angular
+
+        recipe["angular"].each do |key, val|
+          git.install("#{path}#{val[0]}", "#{repo}#{val[1]}", val[2], val[3])
+          msg.success("Installed #{ key }");
+        end
+
+      end
+
+
+
+      # 2.4. END ---------------------------------------------------------------
+
+      # 2.7. INSTALL NPM ASSETS ------------------------------------------------
+
+      if sudo
+
+        msg.warning("Installing NPM as root is not advisable. You should fix
+        your installation of nodeJS to not require root privileges!")
+        msg.paragraph("Installing NPM Assets. This might take a while.")
+
+        FileUtils.cd("#{path}/assets") do
+            `sudo npm install`
         end
-        
+
+      else
+
+        msg.paragraph("Installing NPM Assets. This might take a while.")
+
+        FileUtils.cd("#{path}/assets") do
+            `npm install`
+        end
+
+      end
+
+      msg.success("Installed NPM Assets")
+
+      # 2.7. END ---------------------------------------------------------------
+
+      # 2.8. SET UP NEW GIT REPOSITORY -----------------------------------------
+
+      want_git = choose("Want to initialise a git repository?", :Yes, :No)
+
+      if want_git == :Yes
+
+          git.init(path)
+
+          has_remote = choose("Do you already have a remote git repository?", :Yes, :No)
+
+          if has_remote == :Yes
+
+              remote_url = ask("Remote Url:")
+
+              git.remote(path, remote_url)
+              git.add(path)
+
+              msg.success("Initialised your git repo")
+
+          end
+
+      end
+
+      # 2.8. END ---------------------------------------------------------------
+
+      # 2.9. INSTALL .konstruct ------------------------------------------------
+
+      date = Time.new
+      date_installed = "#{ date.year }-#{ date.month }-#{ date.day }"
+
+      file_data = {
+
+        "konstruct_version" => Konstruct::VERSION,
+        "date_installed" => date_installed,
+        "type" => type
+
+      }
+
+      File.open("#{path}/.konstruct.yml","w") do |f|
+        f.write(file_data.to_yaml)
+      end
+
+      msg.success("Created #{path}/.konstruct.yml")
+
+      # 2.9. END ---------------------------------------------------------------
+
+      # 2.5. SEND BUILD DATA TO ANALYTICS --------------------------------------
+
+      # TODO
+
+      # 2.5. END ---------------------------------------------------------------
+
+      # 2.6. THANKS FOR INSTALLING ---------------------------------------------
+
+      puts ""
+      puts ""
+      puts Paint['    $III7IIIIIIIIIIIIIIIIIIIIIIIIII: ', "#de544b"]
+      puts Paint['    ZZZZZZ$7IIIIIIIIIIIIIIIIIIIIIIII ', "#de544b"]
+      puts Paint['    ZZZZZZZZZZZZ$7IIIIIIIIIIIIIIIIII ', "#de544b"]
+      puts Paint['    ZZZZZZZZZZZZZZZZZZZ$IIIIIIIIIIII~', "#de544b"]
+      puts Paint['    ZZZZZZZZZZZZZZZZZZZZZZZ:,:+IIIIII', "#de544b"]
+      puts Paint['    ZZZZZZZZZZZZZZZZZZZZZZ.        :?', "#de544b"]
+      puts Paint['    I$ZZZZZZZZZZZZZZZZZZ7            ', "#de544b"]
+      puts Paint['    III$ZZZZZZZZZZZZZZZ~             ', "#de544b"]
+      puts Paint['    IIIII7ZZZZZZZZZZZZ               ', "#de544b"]
+      puts Paint['    IIIIIII7ZZZZZZZZ$                ', "#de544b"]
+      puts Paint['    IIIIIIIIIIZZZZZ:                 ', "#de544b"]
+      puts Paint['    IIIIIIIIIIIIZI                   ', "#de544b"]
+      puts Paint['    IIIIIIIIIIIIII                   ', "#de544b"]
+      puts Paint['    IIIIIIIIIIIIIIII=                ', "#de544b"]
+      puts Paint['    IIIIIIIIIIIIIIIII7=              ', "#de544b"]
+      puts Paint['    IIIIIIIIIIIIIIIIIIII~            ', "#de544b"]
+      puts Paint['    IIIIIIIIIIIIIIIIIIIIII=          ', "#de544b"]
+      puts Paint['    IIIIIIIIIIIIIIIIIIIIIII7~        ', "#de544b"]
+      puts Paint['    IIIIIIIIIIIIIIIIIIIIIIIIIII..    ', "#de544b"]
+      puts Paint['    IIIIIIIIIIIIIIIIIIIIIIIIIIII7    ', "#de544b"]
+      puts Paint['    IIIIIIIIIIIIIIIIIIIIIIIIIIIIIII,.', "#de544b"]
+      puts Paint['    IIIIIIIIIIIIIIIIIIIIIIIIIIIIIIII7', "#de544b"]
+      puts ""
+      puts ""
+      puts Paint["    GO BUILD SOMETHING AWESOME!", "#999999"]
+      puts ""
+      puts Paint["    Successfully installed your #{type} site.", "#999999"]
+      puts ""
+      puts Paint["    You can run the developer tools with '$ konstruct watch'
+        or '$ konstruct documentation' to get help.", "#999999"]
+      puts ""
+
+      exit(0)
+
+      # 2.6. END ---------------------------------------------------------------
+
+    end
+
+    # 2. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+    # 3. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+    def refresh(path, sudo)
+
+      # 3.1. INSTALL NPM ASSETS ------------------------------------------------
+
+      if sudo
+
+        msg.warning("Installing NPM as root is not advisable. You should fix your
+        installation of nodeJS to not require root privileges!")
+        msg.paragraph("Refreshing NPM Assets. This might take a while.")
+
+        FileUtils.cd("#{path}/assets") do
+            `sudo npm install`
+        end
+
+      else
+
+        msg.paragraph("Refreshing NPM Assets. This might take a while.")
+
+        FileUtils.cd("#{path}/assets") do
+            `npm install`
+        end
+
+      end
+
+      msg.success("Refreshed NPM Assets")
+
+      # 3.1. END ---------------------------------------------------------------
+
     end
-    
-end
 
-# B. END ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+    # 3. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+    # 3. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+    def documentation
+
+      # B.1. INITIALISE FUNCTIONS ----------------------------------------------
+
+      msg = Util::Message.new()
+
+      # B.1. END ---------------------------------------------------------------
+
+      msg.heading("KONSTRUCT DOCUMENTATION")
+
+      # B.2. IS YOUR DIRECTORY EMPTY? ------------------------------------------
+
+      puts Paint["Opening documentation in your default browser!", "999999"]
+      puts ""
+
+      Launchy.open( "http://konstruct.github.io/" )
+
+      exit(0)
+
+      # B.3. END ---------------------------------------------------------------
+
+    end
+
+    # 3. END +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+  end
+
+end
 
-# END OF FILE =========================================================================================================
+# END OF FILE ==================================================================