wp_scaffold 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06fe1a92e4d783512c5bf8286ed739f76096a240
-  data.tar.gz: 90292acf0118bd3ac7059b9f66575f1ae39ca3dd
+  metadata.gz: f3259ed6d80ad20ca9cd01fd10fd0990dc3a1d3a
+  data.tar.gz: 055a0a68033f19d322b13f8762c6a9241f30942c
 SHA512:
-  metadata.gz: 93c1b62872f453ee357f7b93e7996ad49850a6ef785ea7076954a50b0ff4438f6f4c26fd64e23edb8236e9cf5978ddd5af0f16e8b7de2be03007561565509b9e
-  data.tar.gz: cadec653f0c8b076efacc21303c44c523e87b9acf942dafefd80e38d4c939cf7a6972e11b197e2637d9ea46d82b1101a060642db077349670c45f9c8c9e72c78
+  metadata.gz: b741424ac3512def6466410ddc01d416bc2b46b326b708babe65fe0941cf3d1b5416975fa4e8ae8efe3f84b8ddf4c47b146f7fa50baf434c62e04fe0546cf050
+  data.tar.gz: be945ac5ed5f5916e29107aba3ed4c52b5a25a84bbaefe9417f1dc44d79d3d6e307a0f0783535f6b1aa99d49a365756409f19aec02b6c011c8b256d6d5fe50b2

data/.gitignore

@@ -15,3 +15,9 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store
+spec/tmp
+
+single-custom.php
+page-custom.php
+/custom-post-types

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/README.md

@@ -2,13 +2,15 @@
 
 Scaffold commands for Wordpress theme development.
 
+#### THIS IS A WORK IN PROGRESS AND IS NOT READY FOR ACTIVE THEME DEVELOPMENT.
+
 ## Installation
 
 ```$ gem install wp_scaffold```
 
 ## Usage
 
-To create a new theme:
+To create a new theme, navigate to your wp-content/themes directory and type:
 
 ```wp new "theme name"```
 
@@ -20,6 +22,12 @@ To create a custom post type:
 
 Make sure that your custom post type name is singular; wp_scaffold with take care of pluralizing it for you.
 
+## Customization
+
+Every developer seems to have their own way of setting up a WP project. If you would like to use your own template files, copy down the `lib/wp_scaffold/templates` directory to use as a guide. You can insert the Theme (or custom post type) name using Ruby's ERB templating.  
+
+Once you have your templates ready to go, open terminal and type `wp set_template_path path/to/your/templates` (the path should be relative to your User's home folder). wp_scaffold will now use your custom templates, rather than the defaults.
+
 ## Contributing
 
 1. Fork it

data/bin/wp

@@ -1,18 +1,29 @@
 #!/usr/bin/env ruby
 
 require 'wp_scaffold'
+require 'colorize'
 
 case ARGV[0]
 
 when "new"
-  gen = WpScaffold::Generator.new
-  # Pass the theme name as ARGV[1]
-	gen.create_theme(ARGV[1]) 
+	theme = Theme.new(ARGV[1])
+	theme.generate
+	puts "Created #{theme.name.titleize}.".green
+	puts "Type 'cd #{theme.name.to_underscore}'"
+
 when "cpt"
-	gen = WpScaffold::Generator.new
-  # Pass the theme name as ARGV[1]
-	gen.create_custom_post_type(ARGV[1])
+	cpt = CustomPostType.new(ARGV[1])
+	cpt.generate
+	puts "Added post type: #{cpt.name.titleize}.".green
+
+when "set_template_path"
+	setting = Setting.new(ARGV[1])
+	setting.generate
+	puts "Set template source directory to '#{setting.user_path_setting}'".green
+
 else
-	message = WpScaffold::Generator.new
-	message.usage
+	# Output usage instructinos
+	file = File.open("#{File.expand_path(File.dirname(__FILE__))}/../lib/wp_scaffold/usage.txt", "rb")
+	puts file.read
+	file.close
 end

data/lib/wp_scaffold.rb

@@ -1,12 +1,31 @@
+# Version Info
 require "wp_scaffold/version"
-require 'fileutils' 
-include FileUtils
+
+# Ruby Dependancies
+require 'fileutils'
+require 'erb'
+require 'active_support/inflector'
+
+# Include custom helpers
+Dir[File.dirname(__FILE__) + "/wp_scaffold/helpers/**/*.rb"].each {|file| require file }
 
 module WpScaffold
-	# Require our Generator class
-	require 'wp_scaffold/generator'
-	# Require Active Support Inflector to help with semantics
-	require 'active_support/inflector'
-	# Require out custom helpers
-	require 'wp_scaffold/helper'
+	class Base
+
+		# set the path to our root template folder
+		if File.exists?(File.expand_path('~')+"/wp_scaffold_settings.txt") 
+			# user the user's settings file
+			TEMPLATE_BASE = ENV['HOME'] + "/" + File.read(ENV['HOME']+"/wp_scaffold_settings.txt") + "/"
+		else
+			# user the gem's default templates
+			TEMPLATE_BASE = File.expand_path(File.dirname(__FILE__)) + "/wp_scaffold/templates/"
+		end
+
+		# The User's current directory
+		USER_DIRECTORY = Dir.pwd + "/"
+
+		# Include all generator classes
+		Dir[File.dirname(__FILE__) + "/wp_scaffold/models/**/*.rb"].each {|file| require file }
+
+	end
 end

data/lib/wp_scaffold/helpers/text_helpers.rb

@@ -0,0 +1,19 @@
+class String
+  
+  def to_underscore
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("- ", "_").
+    downcase
+  end
+
+  def to_dash
+    self.gsub(/::/, '/').
+    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+    gsub(/([a-z\d])([A-Z])/,'\1_\2').
+    tr("_ ", "-").
+    downcase
+  end
+
+end

data/lib/wp_scaffold/models/generator.rb

@@ -0,0 +1,43 @@
+class Generator < WpScaffold::Base
+
+	attr_accessor :template_path, :destination, :name, :relative_to_cwd
+
+	def generate
+		# Path to our template folder
+		source = TEMPLATE_BASE + self.template_path
+
+		# For each file in the template source directory
+		Dir.glob("#{source}/**/*").each do |file|
+			unless File.directory?(file)
+
+				@generator = self
+
+				# template file, plus template directories
+				file_name = file.split(source)[1]
+
+				# full path to where the file will be written, including file name
+				# Should this be relative to the current working directory?
+				if @generator.relative_to_cwd == true
+					full_destination = USER_DIRECTORY + self.destination + "/" + file_name
+				else
+					full_destination = self.destination + "/" + file_name
+				end
+
+				# full path to where the file will be written, without file name
+				file_directory =  File.dirname(full_destination)
+
+				# Create the directory, if needed
+				unless File.directory?(file_directory)
+				  FileUtils.mkdir_p(file_directory)
+				end
+
+				# complile the erb template, remove the .erb extention, and write to a new file
+				File.open(full_destination.gsub('.erb', ''), 'w') do |f|
+				  f.write ERB.new(open(file).read).result(binding)
+				end
+
+			end
+		end # each
+	end # generate
+
+end

data/lib/wp_scaffold/models/generators/custom_post_type.rb

@@ -0,0 +1,26 @@
+class CustomPostType < Generator
+
+	DEFAULT_NAME = "custom-post"
+
+	def generate
+		super
+		base_path = USER_DIRECTORY + self.destination
+
+		# Rename the register CPT file
+		File.rename(base_path + "/custom-post-types/custom.php", base_path + "/custom-post-types/" + self.name.to_dash + ".php")
+
+		# Rename the CPT's template files
+		File.rename(base_path + "/page-custom.php", base_path + "/page-" + self.name.to_dash + ".php")
+		File.rename(base_path + "/single-custom.php", base_path + "/single-" + self.name.to_dash + ".php")
+	end
+
+	private
+
+		def initialize(cpt_name = nil)
+			self.name = cpt_name.nil? ? DEFAULT_NAME : cpt_name.downcase
+			self.destination = ""
+			self.template_path = "custom_post_type"
+			self.relative_to_cwd = true
+		end
+
+end

data/lib/wp_scaffold/models/generators/setting.rb

@@ -0,0 +1,14 @@
+class Setting < Generator
+
+	attr_accessor :user_path_setting
+
+	private
+
+		def initialize(user_path = nil)
+			self.user_path_setting = user_path
+			self.destination = File.expand_path('~')
+			self.template_path = "setting"
+			self.relative_to_cwd == false
+		end
+
+end

data/lib/wp_scaffold/models/generators/theme.rb

@@ -0,0 +1,21 @@
+class Theme < Generator
+
+	DEFAULT_NAME = "my new theme"
+
+	def generate
+		super
+		# rename the theme's root folder
+		base_path = USER_DIRECTORY + self.destination
+		File.rename(base_path + "/custom_theme", base_path + "/" + self.name.to_underscore)
+	end
+
+	private
+
+		def initialize(theme_name = nil)
+			self.name = theme_name.nil? ? DEFAULT_NAME : theme_name.downcase
+			self.destination = ""
+			self.template_path = "theme"
+			self.relative_to_cwd = true
+		end
+
+end

data/lib/wp_scaffold/templates/custom_post_type/custom-post-types/custom.php

@@ -0,0 +1,30 @@
+<?php
+
+// Register <%= @generator.name.titleize %>
+add_action('init', 'create_<%= @generator.name.to_underscore %>_post_type');
+function create_<%= @generator.name.to_underscore %>_post_type() {
+  register_post_type( '<%= @generator.name.to_dash %>',
+    array(
+      'labels' => array(
+        'name' => __( '<%= @generator.name.pluralize.titleize %>' ),
+        'singular_name' => __( '<%= @generator.name.titleize %>' ),
+        'add_new' => __( 'Add New <%= @generator.name.titleize %>' ),
+        'add_new_item' => __( 'Add New <%= @generator.name.titleize %>' ),
+        'edit_item' => __( 'Edit <%= @generator.name.titleize %>' ),
+        'new_item' => __( 'Add New <%= @generator.name.titleize %>' ),
+        'view_item' => __( 'View <%= @generator.name.titleize %>' ),
+        'search_items' => __( 'Search <%= @generator.name.pluralize.titleize %>' ),
+        'not_found' => __( 'No <%= @generator.name.pluralize.downcase %> found' ),
+        'not_found_in_trash' => __( 'No <%= @generator.name.pluralize.downcase %> found in trash'),
+        'menu_name' => __( '<%= @generator.name.pluralize.titleize %>' ),
+      ),
+      'public' => true,
+      'rewrite' => array('slug' => '<%= @generator.name.to_dash %>'),
+      //'taxonomies' => array('category'),
+      'publicly_queryable' => true,
+      'supports' => array('title', 'editor', 'page-attributes')
+    )
+  );
+}
+
+?>

data/lib/wp_scaffold/templates/custom_post_type/page-custom.php.erb

@@ -0,0 +1,38 @@
+<?php 
+	/*
+		Template Name: <%= @generator.name.titleize %> Page
+	*/
+?>
+
+<?php get_header(); ?>
+
+
+<!-- This is the page-<%= @generator.name.to_dash %>.php file, a page tempalte for listing <%= @generator.name.titleize %> posts -->
+
+
+<?php 
+	// List all posts with type "<%= @generator.name.to_dash %>"
+	$args = array(
+		'post_type' => '<%= @generator.name.to_dash %>'
+	);
+
+	$custom_query = new WP_Query( $args );
+?>
+
+<!-- Start Loop -->
+<?php if ( have_posts() ) : while ( $custom_query->have_posts() ) : $custom_query->the_post(); ?>
+
+	<!--List the posts -->
+	<?php the_title(); ?>
+	<a href="<?php the_permalink(); ?>"><?php the_permalink(); ?></a>
+	<hr>
+
+<?php endwhile; else: ?>
+
+	<p>No Posts to display!</p>
+
+<?php endif; ?>
+<!-- End Loop -->
+
+
+<?php get_footer(); ?>

data/lib/wp_scaffold/templates/custom_post_type/single-custom.php.erb

@@ -0,0 +1,25 @@
+<?php get_header(); ?>
+
+<!-- This is the single-<%= @generator.name.to_dash %>.php file, which acts as a template for a single "<%= @generator.name.titleize %>" post type -->
+
+<!-- Start Loop -->
+<?php if ( have_posts() ) : while ( have_posts() ) : the_post(); ?>
+
+	<!-- Content for this post -->
+	<?php the_title(); ?>
+
+	<hr>
+
+	<?php the_post_thumbnail(); ?>
+
+	<?php the_content(); ?>
+
+<?php endwhile; else: ?>
+
+	<p>No Posts to display!</p>
+
+<?php endif; ?>
+<!-- End Loop -->
+
+
+<?php get_footer(); ?>

data/lib/wp_scaffold/templates/setting/wp_scaffold_settings.txt.erb

@@ -0,0 +1 @@
+<%= @generator.user_path_setting %>

data/lib/wp_scaffold/templates/{theme_base → theme/custom_theme}/README.md

@@ -1,4 +1,4 @@
-Wordpress-Boilerplate
+<%= @generator.name.titleize %>
 =====================
 
 Blank theme with basic Wordpress functions included.

data/lib/wp_scaffold/templates/{theme_base → theme/custom_theme}/functions.php

@@ -1,7 +1,6 @@
 <?php 
 
 	# Enable custom menus
-	add_theme_support( 'menus' );
 	register_nav_menus( array(
 		'header_menu' => 'Header Menu',
 		'footer_menu' => 'Footer Menu'
@@ -14,7 +13,7 @@
 
 	# Stylesheets
 	function theme_styles() {
-		wp_enqueue_style( 'main', get_template_directory_uri() . '/style.css' );	
+		wp_enqueue_style( 'main', get_template_directory_uri() . '/style.css' );        
 	}
 	add_action( 'wp_enqueue_scripts', 'theme_styles' );
 
@@ -37,8 +36,13 @@
 
 
 	# Include all PHP files from "functions" directory
-	foreach ( glob("functions/*.php") as $filename ) {
-    include $filename;
+	foreach ( glob(dirname(__FILE__)."/functions/*.php") as $filename ) {
+		include_once $filename;
+	}
+
+	# Include all PHP files from "custom-post-types" directory
+	foreach ( glob(dirname(__FILE__)."/custom-post-types/*.php") as $filename ) {
+		include_once $filename;
 	}
 
 ?>

data/lib/wp_scaffold/templates/{theme_base → theme/custom_theme}/header.php

@@ -1,27 +1,28 @@
 <!DOCTYPE html>
 <html>
 	<head>
+		<meta http-equiv="X-UA-Compatible" content="IE=edge" >
 		<meta charset="utf-8">
 		<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=0">
 		
 		<title><?php bloginfo( 'name' ); ?><?php wp_title( '|' ); ?></title>
 
 		<!-- Favicon -->
-    <link rel="shortcut icon" href="<?php echo get_stylesheet_directory_uri(); ?>/favicon.ico" />
+		<link rel="shortcut icon" href="<?php echo get_stylesheet_directory_uri(); ?>/favicon.ico" />
 
 		<?php wp_head(); ?>
 
 		<!-- HTML5 Shiv -->
-    <!--[if lt IE 9]>
-      <script src="<?php bloginfo('template_directory'); ?>/js/vendor/html5shiv.js"></script>
-    <![endif]-->
+		<!--[if lt IE 9]>
+			<script src="<?php bloginfo('template_directory'); ?>/js/vendor/html5shiv.js"></script>
+		<![endif]-->
 	</head>
 	<body>
 
 		<header>
 			<nav>
 				<?php
-				  // Display Header Menu
+					// Display Header Menu
 					$defaults = array('theme_location'  => 'header_menu');
 					wp_nav_menu( $defaults );
 				?>