black-widow 0.0.1.alpha

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 451595693d9f9d1da12fde89fceabc4d2f2910f845828e9a6741fc500af34804
+  data.tar.gz: 0f0e5bd73f61d9df812fb018e3f78205c435e9b4fee5b03f2dca53c03ee4ab91
+SHA512:
+  metadata.gz: 0a68f6762019fdbb776eacd54e1fc61177050922b4c42694e566b96fc8dc599a539c91a75e26c753ca2568fba69b39eca5fa57c0989fa34c48382ed2b248ba48
+  data.tar.gz: ddc7f3a8648225dbef2f15ee650aa8dc5dc3ebc68028048f4606c2dbc3240e7781045ac9e9b1ee27843006d9d8c3dd1effcc7b67cbd2ea4e9ccd0945d88b4b28

data/.gitignore

@@ -0,0 +1,11 @@
+# Temporary Files and Folders
+tmp/*
+*.tmp
+**/*/tmp/*
+
+# Logs
+*.log
+
+# Ruby Stuff
+Gemfile.lock
+*.gem

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem 'rake'
+# TODO:
+# gem 'sass'

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright 2019 Donald Isaac
+
+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.

data/README.md

@@ -0,0 +1,4 @@
+# Black Widow
+
+Do *NOT* use this gem yet! It isn't even close to done!
+*TODO*

data/Rakefile

@@ -0,0 +1,5 @@
+task default: %w[test]
+
+task :test do
+  ruby "test/driver.rb"
+end

data/bin/black-widow

@@ -0,0 +1,184 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# BlackWidow
+# by Donald Isaac (https://www.opensourceryumd.com)
+# Copyright (c) 2019 Open Sourcery. See LICENSE for license details.
+
+require 'pathname'
+require 'getoptlong'
+require 'black-widow'
+
+# Base command usage message
+USAGE = {}
+HELP = {}
+
+# Usage messages
+
+USAGE[:base] = <<-EOF
+usage: black-widow [--help] [--version] command
+EOF
+
+USAGE[:generate] = <<-EOF
+usage: black-widow generate [--help] <component> [--name <name>]
+EOF
+
+USAGE[:new] = <<-EOF
+usage: black-widow new [--help] --name <name>
+EOF
+
+USAGE[:render] = <<-EOF
+usage: black-widow render [--help] <root-dir>
+EOF
+
+# Help messages
+
+HELP[:base] = <<-EOF
+usage: black-widow [--help] [--version] <command>
+
+Options:
+	-h, --help			Display this help message
+	-v, --version		Display BlackWidow's version
+
+Available commands:
+	new					Create a new BlackWidow project
+	generate			Generate a new view component
+	render				Compile a project into a servable site
+EOF
+
+HELP[:generate] = <<-EOF
+EOF
+
+HELP[:new] = <<-EOF
+usage: black-widow new [--help] --name <name>
+
+Discription:
+	This command generates a project skeleton for you to start your site from.
+	The skeleton is populated with the required view component directories, 
+	along with a default .black-widow.yaml file.
+
+Options:
+	-h, --help			Display this help message
+	-n, --name			Required. The name of the new project
+EOF
+
+HELP[:render] = <<-EOF
+EOF
+
+# :_ key is all unnamed arguments from ARGV
+ARGS = { _: [] }
+next_arg = :command # First unnamed arg is expected to be a sub command
+ARGV.each do |arg|
+	case arg
+	when '-h', '--help'			then ARGS[:help] 	= true
+	when '-v', '--version'		then ARGS[:version] = true
+	when '-n', '--name'			then next_arg = :name
+		# TODO: Are more args needed?
+	else
+		if next_arg
+			ARGS[next_arg] = arg
+			next_arg = nil
+		else
+			ARGS[:_].push arg
+		end
+	end
+end
+
+if ARGS[:help] || !!ARGV.length
+	if ARGS[:command] && HELP.include?(ARGS[:command].to_sym)
+		puts HELP[ARGS[:command].to_sym] 
+	else
+		puts HELP[:base]
+	end
+	exit 0
+end
+
+if ARGS[:version]
+	puts BlackWidow::VERSION
+	exit 0
+end
+
+case ARGS[:command]
+# Handle 'new' command
+when 'n', 'new'
+	unless ARGS[:name]
+		puts USAGE_NEW
+		exit 1
+	end
+# Handle 'generate' command
+when 'g', 'gen', 'generate'
+	type, name, *rest = ARGV{:_}
+
+	if !type || !BlackWidow::VIEW_FOLDERS.include?(type) then
+		err('Invalid component type', 2)
+	end
+
+	err('You must specify a name.') unless name
+
+	puts "BlackWidow: This feature does not exist yet."
+	exit 0
+# Handle 'render' command
+when 'r', 'render'
+	begin
+		render_project
+	rescue StandardError => e
+		err(e, 3)
+	end
+
+	exit 0
+else
+	puts USAGE
+	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

@@ -0,0 +1,27 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'black-widow/version'
+
+Gem::Specification.new do |s|
+	s.name        	= 'black-widow'
+	s.version     	= BlackWidow::VERSION
+	s.platform      = Gem::Platform::RUBY
+	s.summary     	= "Black Widow - Static Site Generator"
+	s.description 	= "A simple static site generator powered by eRuby"
+	s.author     	= "Donald Isaac"
+	s.homepage    	= 'https://www.opensourceryumd.com'
+	s.license     	= 'MIT'
+	# s.bindir	  	= 'bin'
+
+	s.add_dependency 'rake', '~> 0'
+
+	s.files       	= `git ls-files`.split("\n")
+
+	s.test_files  	= `git ls-files -- {test}/*`.split("\n")
+
+	s.executables   = `git ls-files -- bin/*`
+                    .split("\n")
+					.map { |f| File.basename(f) }
+	s.require_paths = ['lib']
+end

data/lib/black-widow/engine.rb

@@ -0,0 +1,239 @@
+require 'erb' 					# ERuby template engine
+require 'pathname' 				# finding paths
+
+module BlackWidow
+	##
+	# This class contains all the functionality required for rendering
+	#		 HTML pages and partials
+	#
+	# The set of all assets required to render a page, such as the page template
+	# and it's context, are collectively known as a +view+. View assets must be
+	# located in specific locations, as Black Widow follows a 'configuration by
+	# convention' principle.
+	#
+	# Black Widow's conventions are based heavily on Ruby on Rails. If you are 
+	# familiar with Rails, ViewEngine works much like ActionView.
+	#
+	#   * page templates must be located in the `src/pages` directory
+	#	* layout templates must be located in the `src/layouts` directory
+	#	* partials must be located in the `src/partials` directory
+	#	* contexts must be located in the `src/contexts` directory
+	#
+	# 
+	# @author Donald Isaac
+	#
+	# Copyright (c) 2019 Open Sourcery. See LICENSE for license details.
+	#
+	class ViewEngine
+
+		# Keys are the available view components, values are component folder names
+		# TODO: Make this configurable from config.yaml
+		VIEW_FOLDERS = {
+			page: 'pages',
+			context: 'contexts',
+			partial: 'partials',
+			layout: 'layouts'
+		}
+
+		##
+		# Creates a new ViewEngine.
+		#
+		# @param root_dir: String | Pathname
+		# 	Directory of a Black Widow project's source code. This directory must
+		#	be the immediate parent of all view component VIEW_FOLDERS.
+		#
+		def initialize(root_dir = Dir.pwd)
+			@root = Pathname.new root_dir
+			raise ArgumentError.new "The root path '" + @root.to_s + "'is a file." unless @root.directory?
+
+			@view_components = {
+				page: { dir: @root + Pathname.new(VIEW_FOLDERS[:page]), ext: '.erb'},
+				context: { dir: @root + Pathname.new(VIEW_FOLDERS[:context]), ext: '.rb' },
+				partial: { dir: @root + Pathname.new(VIEW_FOLDERS[:partial]), ext: '.erb' },
+				layout: { dir: @root + Pathname.new(VIEW_FOLDERS[:layout]), ext: '.erb' }
+			}
+		end
+
+		##
+		# Renders ERB files to HTML.
+		#
+		# ### Usage
+		#
+		# ```ruby
+		# # Render a page
+		# render [name], layout: 'foo'
+		# render page: [name]
+		# render layout: [name], [page]
+		#
+		# # Render a partial
+		# render partial [name]
+		# render :partial [name], :locals 
+		#```
+		#
+		# ### Available Options
+		#
+		# - :page
+		# 		Renders a page view. This option is mutually exlusive with 
+		#		the :partial option.
+		#
+		# - :partial
+		#		Renders a partial view. This option is mutually exclusive with
+		#		the :page option.
+		#
+		# - :layout
+		#		Specifies the name of the layout to use when rendering a page
+		#		view. If no layout is specified, the default layout is used.
+		#
+		# - :namespace
+		#		The namespace to use. See the namespace section for more info.
+		#
+		# @param options: Hash | String
+		# 		If options is a string, then a page view is rendered where
+		# 		options is the name of the view. When options is a hash, it
+		#		contains user specified options. See the usage section for all
+		#		available options.
+		#
+		# @param extra_options: Hash
+		# 		When options is the name of a view as a string, this hash
+		# 		contains the rendering options.
+		#
+		# @return The rendered view as a, HTML string.
+		#
+		# @author Donald Isaac
+		# 
+		def render(options = {}, extra_options = {}, &block)
+			case options
+			when Hash
+			  if options[:page]
+				render_page options[:page], options
+			  elsif options[:partial] # Only partials can take blocks
+				render_partial options[:partial], options, &block
+			  end
+			# `options` param is the name of the page view
+			when String
+			  render_page options, extra_options
+			else
+			  raise ArgumentError 'options parameter must be a Hash or String'\
+				' You passed a(n)' + options.class.name + '.'
+			end
+		  end
+
+		##
+		# Gets the view component hash.
+		#
+		# @return the view component hash.
+		#
+		def components
+			@view_components
+		end
+
+		private
+
+		##
+		# Renders a 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.
+		# 
+		# @param view: String
+		# 		The name of the view to render.
+		#
+		# @return The rendered page view as an HTML string.
+		#
+		def render_page(view, options={})
+			loaded_components = load_components view, [:page, :context]
+			page = ERB.new loaded_components[:page]
+			binding = loaded_components[:context].new.method(:context).call
+			raise 'Context method must return a binding obect.' unless binding.is_a? Binding
+
+			page.result binding
+		end
+
+		def render_partial(partial, options={}, &block)
+			'render_partial called! ' + partial + ', ' + options.to_s
+		end
+		##
+		# Resolves the paths for all of a view's assets.
+		#
+		# Resolved assets include the view's templates and rendering context.
+		# 
+		# ==== Params:
+		# [view]
+		# 	String. The name or relative path of the view to resolve. The path
+		#	must be relative to the +pages+ template directory.
+		#
+		# ==== Returns:
+		#
+		# String[]. The resolved asset paths in an array. The asset contains
+		# The following items (in order):
+		# 	[page]
+		#		The page template
+		#	[context]
+		#		The view context
+		#
+
+		##
+		# Loads a set of components for a view.
+		#
+		#
+		def load_components(view = '', components = [], options = {})
+			# Return an empty hash if no component types are specified
+			if !components.length then return {} end
+
+			# Strip whitespace
+			view.strip
+			namespace = options[:namespace] || ''
+
+			# Raise an error if +view+ was just whitespace and/or a forward slash
+			raise ArgumentError 'Invalid view name or directory.' unless view.length
+			raise ArgumentError 'No view components specified ' unless components
+
+			# Contents of view component files, where the key is component type,
+			# and the value is the file's contents
+			loaded_components = {}
+
+			# Load the contents of each component file, 
+			# verifying that each one exists
+			components.each do |component_type|
+
+				# Validate that the specified view component type exists
+				if !@view_components.include? component_type 
+					raise ArgumentError 'Component type ' + component_type + 'does not exist.'
+				end
+
+				component = @view_components[component_type]
+
+				# Validate that view component hash has keys for the directory and extension type
+				if !component.include?(:dir) || !component.include?(:ext)
+					raise ArgumentError 'Component hashes must have the :dir and :ext keys.'
+				end
+
+				component_path = component[:dir].join view + namespace + component[:ext]
+
+				# Throw an exception if the component file does not exist
+				if !component_path.exist?
+					raise "The '"  + component_type.to_s + "' file for the '" +
+					view + "' view does not exist. View component path is " +
+					component_path.to_s
+				end
+
+				# Read the contents of the component file and
+				# store it into an array
+				loaded_components[component_type] = case component[:ext]
+				when '.rb'
+					context_classname = if namespace.length then
+						namespace.capitalize + '::' 
+					end + view.capitalize + component_type.to_s.capitalize
+					# Import the context class
+					require_relative component_path
+					# TODO: Handle modules as :namespace option
+					Object.const_get context_classname
+				else
+					File.new(component_path, 'r').read
+				end
+			end
+
+			return loaded_components
+		end 
+	end # !ViewEngine
+end # !Module 

data/lib/black-widow/version.rb

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

data/lib/black-widow.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+# 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
+	
+	##
+	# 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
+			end
+		end
+
+		config_path.join CONFIG_FILE_NAME
+	end
+
+	def self.config
+		if !@config
+			@config = resolve_config
+		else
+			@config
+		end
+	end
+	
+end

data/test/driver.rb

@@ -0,0 +1 @@
+# TODO

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: black-widow
+version: !ruby/object:Gem::Version
+  version: 0.0.1.alpha
+platform: ruby
+authors:
+- Donald Isaac
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: A simple static site generator powered by eRuby
+email: 
+executables:
+- black-widow
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/black-widow
+- black-widow.gemspec
+- lib/black-widow.rb
+- lib/black-widow/engine.rb
+- lib/black-widow/version.rb
+- test/driver.rb
+homepage: https://www.opensourceryumd.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.8
+signing_key: 
+specification_version: 4
+summary: Black Widow - Static Site Generator
+test_files: []