black-widow 0.0.1.alpha → 0.0.2.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 451595693d9f9d1da12fde89fceabc4d2f2910f845828e9a6741fc500af34804
-  data.tar.gz: 0f0e5bd73f61d9df812fb018e3f78205c435e9b4fee5b03f2dca53c03ee4ab91
+  metadata.gz: 876454d736fa938ca409a2c89c2407fe6fd03b755a6cfbf7cc9e3230c46d9581
+  data.tar.gz: 79106c4d5e2c27b11f585cd367e39a0d10446048cac23fc64d94d714b96b9baa
 SHA512:
-  metadata.gz: 0a68f6762019fdbb776eacd54e1fc61177050922b4c42694e566b96fc8dc599a539c91a75e26c753ca2568fba69b39eca5fa57c0989fa34c48382ed2b248ba48
-  data.tar.gz: ddc7f3a8648225dbef2f15ee650aa8dc5dc3ebc68028048f4606c2dbc3240e7781045ac9e9b1ee27843006d9d8c3dd1effcc7b67cbd2ea4e9ccd0945d88b4b28
+  metadata.gz: 32abef3685b16d28669aeb962415c759886fc8c46d2a6cd60ac0a6548afb44401197b3a9abbdb1f3832e3f0077f033a18c58d6ff712ccbd9a06feff796fb6493
+  data.tar.gz: 323c360361b4d4bad1eaffa5c7f4fade0db735dea4d0f369d52b14df8c87487c04e75d41fcb90990a2d8405874b9afe0f2a941e90590c9abd7c8caff77dd787b

data/.gitignore

@@ -8,4 +8,8 @@ tmp/*
 
 # Ruby Stuff
 Gemfile.lock
-*.gem
+*.gem
+
+# Built documentation & documentation files
+doc/*
+.yardoc/

data/Gemfile

@@ -5,3 +5,7 @@ source "https://rubygems.org"
 gem 'rake'
 # TODO:
 # gem 'sass'
+
+group :development do
+	gem 'yard'
+end

data/README.md

@@ -1,4 +1,7 @@
 # Black Widow
 
 Do *NOT* use this gem yet! It isn't even close to done!
-*TODO*
+
+
+Black Widow is a static site generator for people who like using ActionView
+but want static html files instead of a heavyweight rails server.

data/Rakefile

@@ -1,5 +1,11 @@
 task default: %w[test]
 
 task :test do
+  raise NotImplementedError.new "Testing has not yet been implemented."
   ruby "test/driver.rb"
+end
+
+# Generates documentation, putting the resulting .html files in doc/
+task :gendocs do
+  `yard doc --readme README.md - LICENSE`
 end

data/bin/{black-widow → blackwidow}

@@ -9,6 +9,78 @@ require 'pathname'
 require 'getoptlong'
 require 'black-widow'
 
+##
+# Creates a new BlackWidow project skeleton
+#
+# This function creates a new project directory and populates it with a
+# config.yaml file and folders for view components.
+#
+# @param name: String
+#		The name of the project. This will also be the name of the project
+#		directory.
+#
+# @return void
+#
+def init_project name
+	root = Pathname.new Dir.pwd
+	if (root + name).exist? then
+		raise ArgumentError 'Project could not be created; directory already exists.'
+	end
+	root += name
+	root.mkpath
+
+	BlackWidow::ViewEngine::VIEW_FOLDERS.each_value do |dir|
+		(root + dir).mkpath
+	end
+
+	config = File.new root.join(BlackWidow.CONFIG_FILE_NAME), 'w+'
+end
+
+def render_project opts = {}
+	out_dir = opts[:out_dir] || 'dist/'
+	# TODO: put default layout in config. Magic strings are no bueno :(
+	layout = opts[:layout] || 'application'
+	# Project root directory is the directory with the config file
+	engine = nil
+	dest = Pathname.new(Dir.pwd) + out_dir
+
+	begin
+		engine = BlackWidow::ViewEngine.new File.dirname BlackWidow::resolve_config
+	rescue IOError => e
+		err e, 4
+	end
+
+	Pathname.new(engine.root).each_child do |file|
+		if file.directory?
+			puts "Directory #{file} reached. TODO: Implement namespace rendering"
+		else
+			# Extract the filename, which is the same as the view name
+			view = file.basename.split('.')[0]
+			page_contents = engine.render view, opts
+
+			page_file = File.new dest + (view + '.html'), 'w+'
+			page_file.write page_contents
+			page_file.close
+		end
+end
+
+##
+# Prints an error message and exits with an error status
+#
+# @param err: Exception | RuntimeException | StandardErr | String
+# 		The error being thrown.
+#
+# @param status: Number
+#		The exit status. Defaults to 1.
+#
+def err err, status = 1
+	err_type = if err.is_a? Exception then err.class.name else 'Error' end
+	err_msg = if err.is_a? Exception then err.message else err end
+
+	puts "BlackWidow: - #{err_type} #{err_msg}"
+	exit status
+end
+
 # Base command usage message
 USAGE = {}
 HELP = {}
@@ -65,6 +137,10 @@ EOF
 HELP[:render] = <<-EOF
 EOF
 
+################################################################################
+################################ START OF SCRIPT ###############################
+################################################################################
+
 # :_ key is all unnamed arguments from ARGV
 ARGS = { _: [] }
 next_arg = :command # First unnamed arg is expected to be a sub command
@@ -84,7 +160,8 @@ ARGV.each do |arg|
 	end
 end
 
-if ARGS[:help] || !!ARGV.length
+# Help is specified, or no args are passed.
+if ARGS[:help] || ARGV.length == 0
 	if ARGS[:command] && HELP.include?(ARGS[:command].to_sym)
 		puts HELP[ARGS[:command].to_sym] 
 	else
@@ -102,8 +179,12 @@ case ARGS[:command]
 # Handle 'new' command
 when 'n', 'new'
 	unless ARGS[:name]
-		puts USAGE_NEW
+		err USAGE[:new]
 		exit 1
+	else
+		puts ARGS[:name]
+		init_project ARGS[:name]
+		exit 0
 	end
 # Handle 'generate' command
 when 'g', 'gen', 'generate'
@@ -127,58 +208,11 @@ when 'r', 'render'
 
 	exit 0
 else
-	puts USAGE
+	puts USAGE[:base]
 	exit 1
 end
 
-##
-# Creates a new BlackWidow project skeleton
-#
-# This function creates a new project directory and populates it with a
-# config.yaml file and folders for view components.
-#
-# @param name: String
-#		The name of the project. This will also be the name of the project
-#		directory.
-#
-# @return void
-#
-def init_project name
-	root = Pathname.new Dir.pwd
-	if (root + name).exist? then
-		raise ArgumentError 'Project could not be created; directory already exists.'
-	end
-
-	root.mkpath name
-	root.join name
-	ViewEngine::FOLDERS.each_value do |dir|
-		root.mkpath dir
-	end
-	config = File.new root.join(BlackWidow::CONFIG_FILE_NAME), 'w+'
-end
-
-def render_project
-	# Project root directory is the directory with the config file
-	root = File.dirname BlackWidow::resolve_config
-	Dir.chdir root
-end
 
-##
-# Prints an error message and exits with an error status
-#
-# @param err: Exception | RuntimeException | StandardErr | String
-# 		The error being thrown.
-#
-# @param status: Number
-#		The exit status. Defaults to 1.
-#
-def err err, status = 1
-	err_type = if err.is_a? Error then err.class.name else 'Error' end
-	err_msg = err.message || err
-
-	puts "BlackWidow: - #{err.type} #{err_msg}"
-	exit status
-end
 
 # engine = BlackWidow::ViewEngine.new Pathname.new(Dir.pwd).join 'src'
 # puts(engine.render 'index')

data/black-widow.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
 	# s.bindir	  	= 'bin'
 
 	s.add_dependency 'rake', '~> 0'
+	s.add_development_dependency 'yard', '~> 0'
 
 	s.files       	= `git ls-files`.split("\n")
 

data/lib/black-widow.rb

@@ -3,46 +3,51 @@
 # Black Widow
 # by Donald Isaac (https://www.opensourceryumd.com)
 # Copyright (c) 2019 Open Sourcery. See LICENSE for license details.
-require 'black-widow/engine'
 require 'pathname'
 require 'yaml'
 
 module BlackWidow
-	CONFIG_FILE_NAME = '.black-widow.yaml'
-	@config = nil
+	# Internal requires
+	autoload :ViewEngine		'black-widow/engine'
+	autoload :Config			'black-widow/config'
+	# autoload :command			'black-widow/command'
 	
-	##
-	# Resolves the location of the config file. 
-	#
-	# If no config file exists in the current directory, then the parent
-	# directory is checked. This is done until the file is found or the root
-	# directory is reached, in which case an IOError is raised.
-	#
-	# @return The absolute path to the config file.
-	#
-	def self.resolve_config
-		config_path = Pathname.new Dir.pwd
-
-		# Ascend up the file tree until a .black-widow.yaml file is found
-		until config_path.children(false).include? CONFIG_FILE_NAME do
-			# A path is equal to its parent if and only if it is the root directory
-			if config_path == config_path.parent
-				raise IOError.new 'BlackWidow: Could not find a ' + CONFIG_FILE_NAME +
-				' file. Are you running this command in your project directory?'
-			else
-				config_path = config_path.parent
+	class << self
+		CONFIG_FILE_NAME = '.black-widow.yaml'
+		@config = nil
+		
+		##
+		# Resolves the location of the config file. 
+		#
+		# If no config file exists in the current directory, then the parent
+		# directory is checked. This is done until the file is found or the root
+		# directory is reached, in which case an IOError is raised.
+		#
+		# @raise [IOError] If the config file could not be found
+		#
+		# @return [String] The absolute path to the config file.
+		#
+		def resolve_config
+			config_path = Pathname.new Dir.pwd
+	
+			# Ascend up the file tree until a .black-widow.yaml file is found
+			until config_path.children(false).include? CONFIG_FILE_NAME do
+				# A path is equal to its parent if and only if it is the root directory
+				if config_path == config_path.parent
+					raise IOError.new 'BlackWidow: Could not find a ' + CONFIG_FILE_NAME +
+					' file. Are you running this command in your project directory?'
+				else
+					config_path = config_path.parent
+				end
 			end
+	
+			config_path.join CONFIG_FILE_NAME
 		end
-
-		config_path.join CONFIG_FILE_NAME
-	end
-
-	def self.config
-		if !@config
-			@config = resolve_config
-		else
-			@config
+	
+		def config
+			@config ||= resolve_config
 		end
 	end
+
 	
 end

data/lib/black-widow/command.rb

@@ -0,0 +1,14 @@
+module BlackWidow
+	class Command
+		class << self
+			def subclasses
+				@subclasses ||= []
+			end
+
+			def inherited base
+				subclasses << base
+				super base
+			end
+		end # !class << self
+	end # !Command
+end # !BlackWidow

data/lib/black-widow/config.rb

@@ -0,0 +1,64 @@
+module BlackWidow
+	##
+	# Manages system configuration data.
+	#
+	# @author Donald Isaac
+	#
+	class Config
+		# Default name of the user's configuration file
+		DEFAULT_CONFIG_FILE_NAME = 'config.yml'.freeze
+		
+		# Default configuration
+		DEFAULTS = Hash[
+			'out_dir' 		=> 'dist/',		# Where the compiled site will go
+			'src_dir'		=> 'src/',		# Where view components are
+			'asset_dir'		=> 'assets/'	# Where to find view assets
+		].map {|k, v| v.freeze}.freeze
+
+		attr_accessor :config
+
+		def initialize config_file
+			_user_config = load_from config_file
+			@config = DEFAULTS.merge _user_config
+			
+		end
+
+		##
+		# Resolves the project's root directory.
+		#
+		# Starting at the current working directory, this function looks for a 
+		# 'config.yml' file. If none is found, the parent is checked. This 
+		# continues until the config file is found or the root directory is
+		# reached, upon which an IOError is thrown.
+		#
+		# @raise [IOError] if the config file could not be found.
+		#
+		# @return the absoulte path to the project's root directory.
+		#
+		def resolve_root
+			config_path = Pathname.new Dir.pwd
+
+			# Ascend up the file tree until a config.yml file is found
+			until config_path.children(false).include? CONFIG_FILE_NAME do
+				# A path is equal to its parent if and only if it is the root directory
+				if config_path == config_path.parent
+					raise IOError.new 'BlackWidow: Could not find a ' + CONFIG_FILE_NAME +
+					' file. Are you sure you\'re running this command in your project directory?'
+				else
+					config_path = config_path.parent
+				end
+			end
+	
+			return config_path
+		end
+
+		##
+		# Gets the project's root directory.
+		#
+		# @return the absolute path to the project's root directory.
+		def root
+			@root ||= resolve_root
+		end
+
+	end
+end

data/lib/black-widow/engine.rb

@@ -127,10 +127,37 @@ module BlackWidow
 			@view_components
 		end
 
+		##
+		# Gets the absolute path of each view component directory.
+		#
+		# The set of available view componets is specified in the VIEW_FOLDERS
+		# Hash. You can also access the project's root directory by passing
+		# :root
+		#
+		# @param component: String | Symbol
+		#		The view component type.
+		#
+		# @return The absolute path to the view component directory.
+		#
+		def component_path component
+			# When the argument is a string, convert it into a symbol
+			component = component.to_sym if component.is_a? String
+			raise ArgumentError.new "Argument must be a symbol." unless component.is_a? Symbol
+
+			if component == :root
+				@root_dir
+			elsif @view_components[component]
+				selected = @view_components[component]
+				selected[:dir]
+			else
+				raise ArgumentError.new "Component type '#{component}' does not exist"
+			end
+		end
+
 		private
 
 		##
-		# Renders a view to HTML.
+		# Renders a page view to HTML.
 		#
 		# A view is the collection of data associated with a specific page.
 		# This data includes the erb template and it's associated context data.

data/lib/black-widow/renderer.rb

@@ -0,0 +1,6 @@
+module BlackWidow
+	class Renderer
+		class << self
+		end
+	end
+end

data/lib/black-widow/version.rb

@@ -1,3 +1,3 @@
 module BlackWidow
-	VERSION = '0.0.1.alpha'
+	VERSION = '0.0.2.alpha'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: black-widow
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha
+  version: 0.0.2.alpha
 platform: ruby
 authors:
 - Donald Isaac
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-05 00:00:00.000000000 Z
+date: 2019-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -24,10 +24,24 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
 description: A simple static site generator powered by eRuby
 email: 
 executables:
-- black-widow
+- blackwidow
 extensions: []
 extra_rdoc_files: []
 files:
@@ -36,10 +50,13 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/black-widow
+- bin/blackwidow
 - black-widow.gemspec
 - lib/black-widow.rb
+- lib/black-widow/command.rb
+- lib/black-widow/config.rb
 - lib/black-widow/engine.rb
+- lib/black-widow/renderer.rb
 - lib/black-widow/version.rb
 - test/driver.rb
 homepage: https://www.opensourceryumd.com