mdss 0.0.2 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5354d94d40bb66c80e19d4e62820b2bad52797a3
-  data.tar.gz: 79e62eedde82a8d04861b47821903f7afb6d9665
+  metadata.gz: cbed64f120fd840779dd3b7e849332ae271586b0
+  data.tar.gz: eb6ea75a7b04e741c6acd98088ac4fba263c10f6
 SHA512:
-  metadata.gz: cd1209af3bea5415ebadc0360495269bb075bc7e70c286564ce3de58711532720fede7d8d35b660e7295bad4571f3c33e66e27dd735365a7c02bb7afa0acfe0d
-  data.tar.gz: 8832b5e6da8e84dbf9fd9832edb2be20bf5ce8fa767b12484c90d2ad8c02dbaecabefd44912c68486b0bde76a7fe17d29b067b4c060918ec5eab39e00acaaaa4
+  metadata.gz: a09149b888957f667fcc44aa57b6332105746eea176eb7abd0e52622eba0b1b0742409da34c8a27a456bf3ebdaaae736d7df29ace311e98e8744b7d529be82d9
+  data.tar.gz: 90efdd284681369ba024ba1d0fbb60e126d98eced12f9e01f674860d3fd5e5af4b8916e8ae8ec2b4da928a7473e5f12851ea4a63bf09a0c1c66dc7b520117687

data/bin/mdss

@@ -1,35 +1,64 @@
 #!/usr/bin/env ruby
+# To parse command line args
 require 'optparse'
+# MDSS code
 require 'mdss'
 
-options = {:name => nil, :launch => false}
-mdss_helper = MDSS.get_extra
+=begin rdoc
+Wrapper class around the CLI functionality of MDSS.
+=end
+class MDSSCLI
+=begin rdoc
+call-seq:
+    MDSSCLI.start => nil
 
-parser = OptionParser.new do |opts|
-    opts.banner = "Usage: mdss [options]"
+Start the MDSS CLI. The arguments provided are parsed using the OptionParser class.
+=end
+    def self.start
+        # Define our option parameters. We need the name of the site, or if we are
+        # launching the site to a server
+        options = {:name => nil, :launch => false}
+        # Some helper functions
+        mdss_helper = MDSS.get_extra
 
-    opts.on("-i", "--init <NAME>", "Create a new simple static site with GFM") do |name|
-        options[:name] = name
-    end
+        # Define our various options
+        parser = OptionParser.new do |opts|
+            opts.banner = "Usage: mdss [options]"
 
-    opts.on("-l", "--launch", "Compile and upload to the big wide world") do
-        options[:launch] = true
-        exit
-    end
+            # Initialize a new site
+            opts.on("-i", "--init <NAME>", "Create a new simple static site with GFM") do |name|
+                options[:name] = name
+            end
 
-    opts.on("-h", "--help", "Display help menu") do
-        puts opts
-        exit
-    end
-end
+            # Launching an existing site to a server
+            opts.on("-l", "--launch", "Compile and upload to the big wide world") do
+                options[:launch] = true
+                exit
+            end
 
-begin parser.parse!
-rescue OptionParser::MissingArgument => e
-    mdss_helper.puts_err("Missing site name")
-end
+            # Display the help menu
+            opts.on("-h", "--help", "Display help menu") do
+                puts opts
+                exit
+            end
+        end
+
+        # Parse the arguments, catching any errors
+        begin parser.parse!
+        rescue OptionParser::MissingArgument => e
+            mdss_helper.puts_err("Missing site name")
+        end
 
-if options[:launch]
-    mdss_helper.puts_err("Unsupported behavior")
-else
-    MDSS.mdss_init options[:name]
+        # Looks like we're launching to a server
+        if options[:launch]
+            mdss_helper.puts_err("Unsupported behavior")
+        # Looks like we're making a new site
+        else
+            # Pass the site name to the initalizer function
+            MDSS.mdss_init options[:name]
+        end
+    end
 end
+
+# Start the CLI
+MDSSCLI.start

data/lib/mdss.rb

@@ -1,11 +1,29 @@
+# Get our helper functions
 require 'mdss/extra'
+# Get the MDSS initializer
 require 'mdss/init'
 
+=begin rdoc
+MDSS will serve as the main class for the gem, providing the hooks to the inner working classes as needed.
+=end
 class MDSS
+
+=begin rdoc
+call-seq:
+    MDSS.get_extra => MDSSExtra
+
+Provides an instance of MDSSExtra for helper functions throughout the MDSS gem.
+=end
     def self.get_extra
         MDSSExtra.new
     end
 
+=begin rdoc
+call-seq:
+    MDSS.mdss_init(name) => nil
+
+Creates a new simple static site in the directory specified by name. If the directory exists, it will attempt to setup a simple static site within it anyway.
+=end
     def self.mdss_init(name)
         MDSSInit.mdss_init name
     end

data/lib/mdss/extra.rb

@@ -1,8 +1,23 @@
+=begin rdoc
+Wrapper class around helper methods.
+=end
 class MDSSExtra
+=begin rdoc
+call-seq:
+    puts_warn(err) => nil
+
+Output a warning message to STDOUT.
+=end
     def puts_warn(err)
         puts "WARNING: #{err}"
     end
 
+=begin rdoc
+call-seq:
+    puts_err(err) => nil
+
+Output an error message to STDOUT and terminate.
+=end
     def puts_err(err)
         puts "ERROR: #{err}. Terminating"
         exit

data/lib/mdss/init.rb

@@ -1,13 +1,68 @@
+# To create empty files
+require 'fileutils'
+# For helper methods
 require_relative 'extra'
 
+=begin rdoc
+MDSSInit serves to create new simple static sites.
+=end
 class MDSSInit
+    # Instance of our helper methods class
+    @@helper = MDSSExtra.new
+
+=begin rdoc
+call-seq:
+    MDSSInit.mdss_init(name) => nil
+
+Create a new simple static site in the directory specified by name. If a directory with the specified name exists, it tries to create the necessary files and directories with #init_dir.
+=end
     def self.mdss_init(name)
-        MDSSExtra.new.puts_err("Directory exists") if File.exists?(name)
-        
-        Dir.mkdir(name)
+        if File.exists?(name)
+            MDSSExtra.new.puts_warn("Directory exists") 
+        else
+            Dir.mkdir(name)
+        end
+
+        self.init_file(name, ".mdss.cfg", ["name=#{name}"])
+        self.init_file(name, "index.md")
+
+        self.init_dir(name, "css", "CSS", "styles.css")
+        self.init_dir(name, "js", "JavaScript", "scripts.js")
+        self.init_dir(name, "img", "Image")
+    end
+
+=begin rdoc
+call-seq:
+    MDSSInit.init_dir(name, dirname, warn) => nil
+    MDSSInit.init_dir(name, dirname, warn, file) => nil
+
+Create a new directory for the simple static site. warn is used to specify the name of the folder for the warning message if the directory specified by dirname exists. If a filename is specified, that file is created within the directory.
+=end
+    def self.init_dir(name, dirname, warn, file = nil)
+        if File.exists?("#{name}/#{dirname}")
+            helper.puts_warn("#{warn} folder exists, skipping")
+        else
+            Dir.mkdir("#{name}/#{dirname}")
+            FileUtils.touch("#{name}/#{dirname}/#{file}") unless file.nil?
+        end
+    end
+
+=begin rdoc
+call-seq:
+    MDSSInit.init_file(name, file) => nil
+    MDSSInit.init_file(name, file, contents) => nil
 
-        File.open("#{name}/.mdss.cfg", 'w+') do |cfg|
-            cfg.write("name=#{name}")
-        end        
+Create a new file in the parent directory for the site. If contents are specified as an array of strings, they are written to the file, else a blank file is created.
+=end
+    def self.init_file(name, file, contents = nil)
+        if contents.nil?
+            FileUtils.touch("#{name}/#{file}")
+        else
+            File.open("#{name}/#{file}", "w+") do |file|
+                contents.each do |line|
+                    file.write(line)
+                end
+            end
+        end
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mdss
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
 platform: ruby
 authors:
 - Bryce Davis