konstruct 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af3e952ba75ca52ec4b08bca0866b8faf59c9565
-  data.tar.gz: 05af5e6f2b8125923bd8327981511f2d47164a46
+  metadata.gz: c30796203320cb3a5740bbb2cfe6188966c1dd4c
+  data.tar.gz: 988fe6dbb495d02d94286ac3666de5836c9226fe
 SHA512:
-  metadata.gz: 1ac3b71723a30ffeed0b01f57fc43dcdfb3db977dd85e692fb54eb6ac54f3082515e9845e3a9edae46a16fcf3bd4175faafe5e64cea30029d82968de238a48c5
-  data.tar.gz: 267db95e426754bb1692cd4afdcffd2e22ec9dbce03f3e186840022a9ef45b1800e139480eeb7c1ee746ea3f6e004c6ff1dc663d6280c32cae793e54af522b5e
+  metadata.gz: ca3174b805aed75aa2fdf7f3d78a0efc2e42e23a41fef56b9c87a1a9b6c2f2ec763850cdfdf4c26d855c8e33d4373d884bc67c46a37549681d2b86eacfb597a3
+  data.tar.gz: 8a969758126991264c3336eecdd253d2d8120a298c62d34246e3b7c3f9435c2c2e0f2acc3db22e0794a2c162b8394491f4e3d130d138bb4aa60a6356890bf16f

data/README.md

@@ -1,4 +1,6 @@
-# Konstruct Cli - 0.1.3
+# Konstruct Cli
+
+[![Gem Version](https://badge.fury.io/rb/konstruct.svg)](https://badge.fury.io/rb/konstruct)
 
 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.
 
@@ -28,13 +30,15 @@ This feature is coming soon.
     
 The skeleton command builds a basic starter project template for common website projects. It builds common folders to ensure your project is tidy and organised.
 
-#### Documentation
+#### Stat
     
 This feature is coming soon.
 
-#### Stat
+#### Documentation
+
+    $ konstruct documentation
     
-This feature is coming soon.
+Loads up the [Konstruct Documentation](http://konstruct.github.io/) in your default browser.
 
 ## Contributing
 

data/konstruct.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'commander'
   spec.add_dependency 'minigit'
   spec.add_dependency 'paint'
+  spec.add_dependency 'launchy'
 
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"

data/lib/cli/documentation.rb

@@ -0,0 +1,44 @@
+# KONSTRUCT CLI [ KONSTRUCT MODULE ] ==================================================================================
+
+# ====== INDEX  =======================================================================================================
+# ==
+# == A. OPEN DOCUMENTATION
+# ==
+# ====== INDEX  =======================================================================================================
+
+# A. OPEN DOCUMENTATION +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+module Konstruct
+   
+    class Cli
+        
+        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
+        
+    end
+    
+end
+
+# B. END ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
+
+# END OF FILE =========================================================================================================

data/lib/konstruct.rb

@@ -14,6 +14,7 @@ require "konstruct/version"
 require 'rubygems'
 require 'commander/import'
 require 'paint'
+require 'launchy'
 
 # A.1. END ------------------------------------------------------------------------------------------------------------
 
@@ -28,6 +29,7 @@ require_relative 'utilities/utils'
 
 require_relative 'cli/scaffold'
 require_relative 'cli/skeleton'
+require_relative 'cli/documentation'
 
 # A.2. END ------------------------------------------------------------------------------------------------------------
 
@@ -57,7 +59,7 @@ program :description, 'The Konstruct CLI provides scaffolding and other tools to
 
 # B.1. END ------------------------------------------------------------------------------------------------------------
 
-# B.3. COMMAND: SKELETON ----------------------------------------------------------------------------------------------
+# B.2. COMMAND: SKELETON ----------------------------------------------------------------------------------------------
 
 # -- DESCRIPTION: Scaffolds a skeleton project folder structure for you.
 
@@ -79,6 +81,29 @@ command :skeleton do |c|
 
 end
 
+# B.2. END ------------------------------------------------------------------------------------------------------------
+
+# B.3. COMMAND: DOCUMENTATION -----------------------------------------------------------------------------------------
+
+# -- DESCRIPTION: Launches Konstruct documentation in a browser
+
+# -- USAGE: $ konstruct documentation
+
+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|
+        
+        art.icon()
+
+        cli.documentation()
+
+    end
+
+end
+
 # B.3. END ------------------------------------------------------------------------------------------------------------
 
 # B. END ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

data/lib/konstruct/version.rb

@@ -1,3 +1,3 @@
 module Konstruct
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: konstruct
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Adrian Kirsten
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +114,7 @@ files:
 - bin/konstruct
 - bin/setup
 - konstruct.gemspec
+- lib/cli/documentation.rb
 - lib/cli/scaffold.rb
 - lib/cli/skeleton.rb
 - lib/konstruct.rb