oynx 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f282b4c55f8cee6860ee69601166485b5ab60b3
-  data.tar.gz: 3f74108caea61e1e4e55b3c293f1f6290898daa9
+  metadata.gz: 5d21996b214cbe4971ff3a09a29f42da5c424b07
+  data.tar.gz: 16704ef8ea97b000809aa0627174909678f25307
 SHA512:
-  metadata.gz: a0f916fd7976b5c6baa77f1e9f7d8077338fa2b654b2e1d1d53caae91c4dd7a6343772e84abe9d2b858d3cf804064f646779bea3d160140b60fb256c1d158a46
-  data.tar.gz: 030de219ec9d04a1547d1f79f1e526bf31cec30aa41515d00ed6470974e0c2887ae32294720df1c75fa9a413f6d0d3b46eaf3a7fd2562098b33187e75358b435
+  metadata.gz: 3daafcccc338d806f02c148366b94bcee08392fae7809a5cc92cb9b12631742d43f7bdb89e16413de825336f598d64df18a2a50d2706ea893e70b5b8d4be9c7c
+  data.tar.gz: 682c0fd84017e1cf4fb46b9fee7892d45e94118e62774d5d1331d6d6204d1191d6cbaa67a9de95d0fd59f500f8a65a8647bea561a6a8963798958af072edc14d

data/README.md

@@ -26,9 +26,11 @@ Or install it yourself as:
 
 ## Usage
 
+### Creating a site
+
 	$ oynx new
 
-### Parameters
+#### Parameters
 
 	--default      - create a default site
 
@@ -40,6 +42,18 @@ Or install it yourself as:
 	--no-img       - Don't create an image folder
 	--no-js        - Don't create a JS folder/stubs
 
+### Uploading a site
+
+	$ oynx upload
+
+#### Required Parameters
+
+	--server, -s "URL/IP" - Server URL/IP Address
+    --port, -n "PORT"     - Port to use
+    --user, -u "USERNAME" - Username
+    --dir, -d "DIRECTORY" - Directory to use
+    --compress, -c / --no-compress - Compresses the site / Doesn't compress the site
+
 ## Contributing
 
 1. Fork it ( http://github.com/mahimahi42/oynx/fork )

data/lib/oynx.rb

@@ -5,8 +5,10 @@ require "oynx/oynx_back"
 require "oynx/config"
 
 module Oynx
+    ##
+    # This class connects Oynx with Thor, to allow passing of CLI
+    # options. This is what the user will interact with.
   	class Oynx_CLI < Thor
-      attr_accessor :site
 
   		desc "new", "create a new website"
   		long_desc <<-LONGDESC
@@ -29,6 +31,10 @@ module Oynx
   		option :css, :type => :boolean
   		option :js, :type => :boolean
   		option :img, :type => :boolean
+        ##
+        # If the user wants a +default+ website, create one.
+        # Else, gather our options into a configuration and
+        # create the site from that.
   		def new
   			if options[:default] then
                 Oynx_Back.new.create_site()
@@ -39,7 +45,7 @@ module Oynx
   				config["js"] = options[:js] if not options[:js]
   				config["img"] = options[:img] if not options[:img]
 
-  				@site = Oynx_Back.new(config).create_site
+  				Oynx_Back.new(config).create_site
   			end
   		end
 
@@ -53,7 +59,6 @@ module Oynx
             --server, -s "URL/IP" - Server URL/IP Address
             \x5--port, -n "PORT"     - Port to use
             \x5--user, -u "USERNAME" - Username
-            \x5--pass, -p "PASSWORD" - Password
             \x5--dir, -d "DIRECTORY" - Directory to use
             \x5--compress, -c / --no-compress - Compresses the site / Doesn't compress the site
         LONGDESC
@@ -62,12 +67,17 @@ module Oynx
         option :user, :aliases => :u, :required => true
         option :dir, :aliases => :d, :required => true
         option :compress, :aliases => :c, :type => :boolean
+        ##
+        # Uploads the site using the Oynx backend.
         def upload
             Oynx_Back.upload(options, config["name"], File.join(Dir.pwd, config["name"]))
         end
 
         private
 
+        ##
+        # Due to a Thor quirk, this is the best way to have a class variable,
+        # so we can store our website configuration
         def config
             @config ||= Web_Config.new
         end

data/lib/oynx/config.rb

@@ -1,7 +1,9 @@
+##
 # Web_Config is just a wrapper for a Hash with some custom keys
 # instantiated for Oynx use.
 
 class Web_Config < Hash
+	##
 	# Set our custom keys to default values
 	def initialize()
 		self["name"]    = "new_site"
@@ -11,6 +13,7 @@ class Web_Config < Hash
 		self["img"]     = true
 	end
 
+	##
 	# Our Web_Config as a String
 	def to_s()
 		ret = ""

data/lib/oynx/oynx_back.rb

@@ -3,17 +3,25 @@ require "zip"
 
 require_relative './config'
 
+##
+# This is the Oynx backend. Most of the actual work done by Oynx
+# is done here
 class Oynx_Back
+	##
+	# +config+ is our website configuration, while +root+ is the
+	# root directory for the website
 	attr_writer :config, :root
 
-	# Set our configuration to either a blank configuration or one
-	# supplied by the application. @root is the root folder of the
-	# site
+	##
+	# Set our +@config+ to either a blank configuration or one
+	# supplied by the application, and set our +@root+ to nil
+	# for now.
 	def initialize(config = Web_Config.new)
 		@config = config
 		@root = nil
 	end
 
+	##
 	# Call the various methods to create the website
 	def create_site()
 		create_root()
@@ -21,8 +29,15 @@ class Oynx_Back
 		create_file_stubs()
 	end
 
+	##
 	# Compress the site if specified, then upload it using `scp`
 	# This is a class method due to quirks with Thor
+	#
+	# == Parameters
+	#
+	# +options+   - CLI options we get from Thor
+	# +site_name+ - Name of the website
+	# +dir+       - Directory on the server to use
 	def Oynx_Back.upload(options, site_name, dir)
 		user  = options[:user]
 		dir   = options[:dir]
@@ -43,6 +58,7 @@ class Oynx_Back
 	# Creating methods
 	##################
 
+	##
 	# Create the root folder for our site
 	def create_root()
 		tmp = File.join(Dir.pwd, @config["name"])
@@ -50,6 +66,7 @@ class Oynx_Back
 		@root = tmp
 	end
 
+	##
 	# Call the various methods to create our folders
 	def create_inner_folders()
 		create_css_folder()
@@ -57,6 +74,7 @@ class Oynx_Back
 		create_js_folder()
 	end
 
+	##
 	# Create a CSS folder if specified
 	def create_css_folder()
 		if @config["css"]
@@ -65,6 +83,7 @@ class Oynx_Back
 		end
 	end
 
+	##
 	# Create an image folder if specified
 	def create_img_folder()
 		if @config["img"]
@@ -73,6 +92,7 @@ class Oynx_Back
 		end
 	end
 
+	##
 	# Create a JS folder if specified
 	def create_js_folder()
 		if @config["js"]
@@ -81,6 +101,7 @@ class Oynx_Back
 		end
 	end
 
+	##
 	# First create our index.html template, then call the methods
 	# to create css and js stubs
 	def create_file_stubs()
@@ -106,6 +127,7 @@ class Oynx_Back
 		create_js_file_stubs()
 	end
 
+	##
 	# Creates a css stub file if specified
 	def create_css_file_stubs()
 		if @config["css"] then
@@ -114,6 +136,7 @@ class Oynx_Back
 		end
 	end
 
+	##
 	# Creates a js stub file if specified
 	def create_js_file_stubs()
 		if @config["js"] then
@@ -126,6 +149,7 @@ class Oynx_Back
 	# Uploading methods
 	###################
 
+	##
 	# Compresses the site
 	def Oynx_Back.compress_site(name)
 		archive  = File.join(Dir.pwd, "#{name}.zip")

data/lib/oynx/version.rb

@@ -1,3 +1,5 @@
 module Oynx
-  VERSION = "0.2.0"
+	##
+	# Version number for the Oynx gem
+  	VERSION = "0.3.0"
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: oynx
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Bryce Davis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-04 00:00:00.000000000 Z
+date: 2014-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   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'
 description: Oynx simplifies several aspects of web development
@@ -60,9 +60,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
-- LICENSE
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -82,17 +81,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Oynx WebDev Helper

data/LICENSE

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2014 mahimahi42
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.