start_project 0.0.7 → 0.0.8

data/lib/start_project/downloader.rb

@@ -4,13 +4,17 @@ require 'open-uri'
 require 'zip/zip'
 
 module StartProject
+
+  # Manages the downloading and unzipping the file 
   class Downloader
+    # Downloads the relevant zip and stores it in a file called temp.zip
     def self.download(source)
       open("temp.zip",'wb') do |fo|
         fo.print open(source).read
       end
     end
     
+    # Unzip the file into a directory specified in the intitial call to the app via the -n (--name option)
     def self.unzip_file (destination)
       orig_name = ""
       Zip::ZipFile.open("temp.zip") { |zip_file|

data/lib/start_project/options.rb

@@ -1,11 +1,14 @@
 require 'optparse'
 require 'yaml'
-
+# This module encapsulates all the functionality in the module
+# It has 3 classes
+# * Options
+# * Downloader
+# * Runner
 module StartProject
+  # Read the arguments from the command line and parse them out
   class Options
     
-    # Read the arguments from the command line and parse them out
-    
     # project_uri stores the url of the framework
     attr_reader :project_uri
     
@@ -16,7 +19,6 @@ module StartProject
     attr_reader :frameworks
     
     
-    # = initialize
     # Initializes the options object, loads the config.yaml that stores all the frameworks available 
     # and sets a default framework: html5 boilerplate.
     # Finally, it calls the parse method.
@@ -50,6 +52,8 @@ module StartProject
         
         opts.on("-h", "--help", "Show this message") do 
           puts opts
+					puts 'Available framework options are as follows:'
+					@frameworks.each_key{|key| puts key.to_s}
           exit
         end
         

data/lib/start_project/runner.rb

@@ -1,11 +1,14 @@
 require 'start_project/downloader'
 require 'start_project/options'
 module StartProject
+  # The Runner class is the entry point to the app
   class Runner
+    # Reads the arguments from the command line and creates a new option object.
     def initialize(argv)
       @options = Options.new(argv)
     end
     
+    # The run method is called from the executable. Two static methods download and unzip_file are called, these are the main methods in the gem.
     def run
       Downloader.download(@options.project_uri)
       Downloader.unzip_file(@options.project_name)

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Aonghus Flynn
@@ -29,17 +29,20 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-description: |
+description: |+
   The start_project gem is a simple way of downloading the latest version of your favourite framework.
   
   It's very easy to use: simply install the gem as normal with gem install start_project and then run the command line tool ProjectStart --type {framework} --name {name of project} and it will pull the latest version of the framework and extract it to your machine with the name you provided.
   
-  Currently, there are only 2 frameworks: html 5 boilerplate and bootstrap, but I'll be adding more in the future.
+  Currently, there are 5 frameworks: html 5 boilerplate, bootstrap, 960 grid, 320 and up, and mass
+  gs960
+  andup320
+  mass, but I'll be adding more in the future.
   
   You can fork the source on github here: https://github.com/aonghusflynn/ProjectStart
   
   You can find my blog here: http://www.aonghusflynn.com
-
+  
 email: developer@aonghusflynn.com
 executables: 
 - ProjectStart