markwiki 0.0.1.pre.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 492cef775ae9e3cd8908194bb26565a0f609f1fd
-  data.tar.gz: ddf7f0afffa51fc6c3332bd2262fb8df1f9cb91f
+  metadata.gz: e1512f8243b2ad01cc508a9b0252c5fe53ad4265
+  data.tar.gz: 4205aa8069fdcbc13b8a532f57a8be05ccbf2218
 SHA512:
-  metadata.gz: 0d283fd16db361484d66b4018910208076dbb6330875f594d418fbfcb4d77c580fdd40e73b7653723b5b09d57b12fd41e9ea801f89575915eb3c6bd0a9f78f9a
-  data.tar.gz: ac938e3d2d971b89be58194ba6fda5fb545bc3020496860bfdaeff94000a0d7070333a9de68109c2d96290f5a69e84973eb64e1a649f4bf3604c64792e9b8166
+  metadata.gz: 95277f16c02c465fe357e168a917dc4070a21850c8c7fd1d453c3d821e93b2982c882668c7f4abc8cc63879d05221e8abc2231c1c8b213160c679afdcb4686a4
+  data.tar.gz: 718a20cb7c964f206b4b784b1e20743c709daecceaf599b09d945b3414cdbe1c2fd468b193f952aad6b5c4e5fe5964b34c843b36afeb7aad3aa2dea7c2c42ab4

data/README.md

@@ -2,13 +2,7 @@
 
 Markwiki is a Ruby gem designed to ease the development and maintenance of locally designed static sites using Markdown. Too often, at least for me, static site generators aren't intuitive to use, aren't focused for simple static sites (not blogs), or most often don't support GitHub flavoured Markdown (GFM).
 
-Markwiki is different in that it is a tool written by me, for me. However, it may be useful for you if you want a simple static site with GFM. In fact, the ideal workflow with Markwiki is:
-
-    Create a site with markwiki --init <NAME>
-    Write website stuff (Markdown, CSS (SASS?), and JS)
-    Compile and upload to your server with markwiki --launch
-
-Simple, eh?
+Markwiki follows the philosophy that you should have to do as little configuration as possible, with the ability to customize as much as possible. A Markwiki site begins as a skeleton directory structure as a YAML or JSON file, known as a *configuration*. These configurations are designed to be as intuitive as possible.
 
 ## Installation
 

data/exe/markwiki

@@ -43,6 +43,10 @@ module Markwiki
 				puts "ERROR: Missing site name"
 				exit
 			end
+
+			site = Markwiki.new
+			puts options[:name]
+			site.init_site(options[:name])
 		end
 	end
 end

data/lib/markwiki.rb

@@ -1,8 +1,15 @@
 # @author Bryce Davis <me@bryceadavis.com>
 require "markwiki/version"
 require "markwiki/init"
+require "jewel"
 
 # Main driver for Markwiki
 module Markwiki
-  # Your code goes here...
+	# Topmost API for Markwiki
+	class Markwiki
+		# Create a new Markwiki site
+		def init_site(name)
+			Init.init_site(name)
+		end
+	end
 end

data/lib/markwiki/init.rb

@@ -1,5 +1,7 @@
 # @author Bryce Davis <me@bryceadavis.com>
 require 'json' # For JSON parsing
+require 'yaml' # For YAML parsing
+require 'jewel' # For access to static resources
 
 module Markwiki
     # The default Markwiki skeleton, to be converted to JSON.
@@ -22,10 +24,67 @@ module Markwiki
     }
 
     # Wrapper class for Markwiki initialization
-    class Init
-        # @todo Finish site initialization
-        def self.init_site(site_name)
-            
+    class Init < Jewel::Gem
+        root "../.."
+
+        # Creates the Markwiki directory structure from a
+        # configuration.
+        #
+        # @param site_name [String] the name of Markwiki site
+        # @param config [Hash] a Markwiki configuration Hash
+        def self.init_site(site_name, config: self.load_default_config)
+            Dir.mkdir(site_name)
+
+            # Create the directories
+            config.each_key do |key|
+                if config[key].is_a? Hash
+                    Dir.mkdir(File.join(site_name, config[key]["dir_name"]))
+                end
+            end
+
+            # Create the files
+            config.each_key do |key|
+                # We have top-level files
+                if config[key].is_a? Array and key.eql? "files"
+                    config[key].each do |file|
+                        unless file.eql? ".markwiki.cfg"
+                            #puts File.join(site_name, file)
+                            FileUtils.touch(File.join(site_name, file))
+                        end
+                    end
+                end
+
+                # We have a subdirectory
+                if config[key].is_a? Hash
+                    config[key].each_key do |subdiropt|
+                        if config[key][subdiropt].is_a? Array and subdiropt.eql? "files"
+                            config[key][subdiropt].each do |file|
+                                #puts File.join(site_name, config[key]["dir_name"], file)
+                                FileUtils.touch(File.join(site_name, config[key]["dir_name"], file))
+                            end
+                        end
+                    end
+                end
+            end
+
+            # Create the Markwiki configuration
+            if config.eql? self.load_default_config
+                # Path to the default configuration
+                path = self.root.static(".markwiki.cfg").to_s
+                FileUtils.cp(path, "#{site_name}")
+            else
+                File.open("#{site_name}/.markwiki.cfg", "w") do |file| 
+                    file.write(self.generate_yaml_config(config))
+                end
+            end
+        end
+
+        # Generate a YAML representation of a configuration
+        #
+        # @param config [Hash] a Markwiki configuration
+        # @return [String] a YAML representation of the configuration
+        def self.generate_yaml_config(config)
+            YAML.dump(config)
         end
 
         # Generate a JSON String representation of a Markwiki
@@ -33,7 +92,7 @@ module Markwiki
         #
         # @return [String] the Markwiki configuration as a JSON String
         def self.generate_json_config
-            Markwiki::CONFIG.to_json
+            CONFIG.to_json
         end
 
         # Generate a prettified JSON String representation of a
@@ -41,7 +100,7 @@ module Markwiki
         #
         # @return [String] the Markwiki configuration as a JSON String
         def self.generate_pretty_json_config
-            JSON.pretty_generate Markwiki::CONFIG
+            JSON.pretty_generate CONFIG
         end
 
         # Get a Hash representation of a default Markwiki
@@ -64,6 +123,7 @@ module Markwiki
         # @param img_files [Array<String>] an Array of image files
         # @return [Hash] a new Markwiki configuration Hash
         def self.generate_config(
+            name: "markwiki",
             files: ["index.html"],
             css: "css",
             css_files: ["styles.css"],
@@ -72,6 +132,7 @@ module Markwiki
             img: "img",
             img_files: [])
             {
+                "name" => name,
                 "files".to_s => files + [".markwiki.cfg"],
                 "css".to_s => {
                     "dir_name" => css,
@@ -87,5 +148,17 @@ module Markwiki
                 }
             }
         end
+
+        # Load the default Markwiki configuration file
+        #
+        # @return [Hash] the default configuration as a Hash
+        def self.load_default_config
+            config = nil
+            path = self.root.static(".markwiki.cfg").to_s
+            file = File.open(path, "r") { |file| 
+                config = YAML.load(file)
+            }
+            config
+        end
     end
 end

data/lib/markwiki/version.rb

@@ -1,5 +1,5 @@
 # @author Bryce Davis <me@bryceadavis.com>
 module Markwiki
     # Current Markwiki version number
-    VERSION = "0.0.1-1"
+    VERSION = "0.0.3"
 end

data/markwiki.gemspec

@@ -30,8 +30,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", '~> 0'
+  spec.add_development_dependency "rspec", '~> 3'
   spec.add_development_dependency "yard", '~> 0'
   
-  spec.add_runtime_dependency "json", '~> 0'
+  spec.add_runtime_dependency "json", '~> 1'
+  spec.add_runtime_dependency "jewel", "~> 0"
 end

data/static/.markwiki.cfg

@@ -1,4 +1,5 @@
 ---
+name: markwiki
 files:
 - index.html
 - ".markwiki.cfg"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: markwiki
 version: !ruby/object:Gem::Version
-  version: 0.0.1.pre.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Bryce Davis
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +68,20 @@ dependencies:
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: jewel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -125,9 +139,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.6