jekyll-staging 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6020ad38797b56d852844f8db29899e0fbd9ac34
+  data.tar.gz: dde6e55d3ebe572ea2051df4c47ed24a14a85379
+SHA512:
+  metadata.gz: f0a937a46f74e61e9129eef773355a6e061ad5d1c8e0f79ea5e509612a2744aefc7976e8d6c4743c2a98e494823c96b0d8cd815843902f2cacf56cd4714986a4
+  data.tar.gz: bc5cb0143fa852b69340b80839879e26a9a14cb98dbf7654623dcf1d5f6a2dc3a3b7e11436feb505499ef4a64e2a9d1ba255bbb5bb38c512258ade0baa3ff91a

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.markdown

@@ -0,0 +1,7 @@
+Creative Commons Attribution-Sharealike
+
+http://creativecommons.org/licenses/by-sa/4.0/
+
+
+
+I'd also appreciate hearing from anyone who uses this. Contact info is in the README file.

data/README.markdown

@@ -0,0 +1,106 @@
+# Jekyll-Staging
+
+by [Matt Gemmell](http://mattgemmell.com/)
+
+
+## What is it?
+
+It's a Ruby gem that stages and unstages draft posts for Jekyll's internal server.
+
+
+## What are its requirements?
+
+All you need is Ruby. Grab it by running `gem install jekyll-staging` in your terminal.
+
+
+## What does it do?
+
+This script is for people who:
+
+1. Use [Jekyll](http://jekyllrb.com) to build their static sites.
+
+2. Keep their drafts _outside_ of Jekyll's folder structure.
+
+3. Like to work on posts using Jekyll's built-in web server.
+
+If you have a lot of posts, Jekyll's rebuild process can take a while, so it can be handy to temporarily move all of your existing posts aside while you work on a draft. That's what this script does.
+
+It lets you specify a given draft post, and it'll move it into Jekyll's folder structure (appropriately prefixing its filename with today's date). Then, it moves all other posts aside temporarily. That way, Jekyll's build and regeneration process will be super-fast while you're working on the draft.
+
+It can also reverse the process when you're done, of course, putting the draft back into your drafts folder and restoring all your existing posts.
+
+Note: It's assumed that your drafts' filenames _don't_ already have date-prefixes. Personally, I only add the date-prefixes when I'm ready to publish a new post. I often work on posts for several days, so it's easier that way.
+
+
+## How do I use it?
+
+First, specify the two appropriate paths in the script's Configuration block, and check that the post file-extension ("markdown" by default) matches your posts and drafts.
+
+Then, run the script without any arguments to see usage instructions.
+
+Basically:
+
+- **`stage FILENAME_GLOB`** stages the first matching draft.
+- **`stage -u`** unstages the first staged post.
+- **`stage -u FILENAME_GLOB`** unstages the first matching staged post.
+
+You don't need to specify full paths, because it'll be looking in your drafts folder anyway. Feel free to use partial filenames, and shell glob patterns. If there's more than one match, it'll use the first one, and it'll output the full list of matches as well as the filename it chose.
+
+Let's say you had a draft whose filename was `got-a-new-iphone.markdown`. A typical workflow would be:
+
+1. **`stage iphone`** (stage the draft for Jekyll)
+
+2. **`jekyll serve`** (start the built-in web server, changing to your Jekyll directory first)
+
+3. Edit your post as you see fit, and view it in your browser. When you're done, kill Jekyll's web server.
+
+4. **`stage -u`** (unstage the draft, putting it back in your drafts folder)
+
+You can then decide whether to publish the post, and build and deploy your site as usual.
+
+
+## Where does it temporarily put my other posts?
+
+In a directory called "`_stash`", in your Jekyll site's local root directory. The directory will be created if necessary. You can set a configuration option to make it use a different directory, if you want.
+
+
+## Should I run it on my server?
+
+Nope. I run it on my local machine, and so should you.
+
+
+## Who made it?
+
+Matt Gemmell (that's me).
+
+- My website is at [mattgemmell.com](http://mattgemmell.com)
+
+- I'm on Twitter as [@mattgemmell](http://twitter.com/mattgemmell)
+
+- This code is on github at [github.com/mattgemmell/Jekyll-Staging](http://github.com/mattgemmell/Jekyll-Staging)
+
+
+## What license is the code released under?
+
+Creative Commons [Attribution-Sharealike](http://creativecommons.org/licenses/by-sa/4.0/).
+
+
+## Can you provide support?
+
+Nope. If you find a bug, please fix it and [submit a pull request on github](https://github.com/mattgemmell/Jekyll-Staging/pulls).
+
+
+## I have a feature request or bug report.
+
+Please [create an issue on github](https://github.com/mattgemmell/Jekyll-Staging/issues).
+
+
+## How can I thank you?
+
+You can:
+
+- [Support my writing](https://www.patreon.com/mattgemmell).
+
+- Check out [my Amazon wishlist](http://www.amazon.co.uk/registry/wishlist/1BGIQ6Z8GT06F).
+
+- Say thanks [on Twitter](http://twitter.com/mattgemmell).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/stage

@@ -0,0 +1,307 @@
+#!/usr/bin/env ruby
+
+# Staging/unstaging script for Jekyll blog posts.
+#
+# by Matt Gemmell
+#
+# Web: http://mattgemmell.com
+# Twitter: http://twitter.com/mattgemmell
+
+
+# This script moves a specified draft post into Jekyll's folder structure,
+# and temporarily stashes all other posts so the site will build quickly.
+#
+# This is for people who keep their drafts outside of Jekyll's folder structure.
+#
+# It can also reverse the process when you're done, of course.
+#
+# This is useful when you're working on a post using Jekyll's server.
+
+
+# Requirements: just Ruby itself.
+
+
+# Usage: Run the script with no arguments to see usage instructions.
+
+
+# License: CC Attribution-ShareAlike
+# http://creativecommons.org/licenses/by-sa/4.0/
+
+
+# ========================================
+# Configuration
+# ========================================
+
+# Load in configuration file, or ask and populate.
+def read_or_ask_for_configuration
+  require 'yaml'
+  conf_file = File.join(ENV['HOME'], '.jekyll-stagingrc')
+  if File.exist?(conf_file)
+    YAML.load_file(conf_file)
+  else
+    conf = {}
+    print "Where is your Jekyll site located? (full path, '~' is ok) "
+    conf['jekyll_root'] = STDIN.gets
+    print "Where are your drafts located? (full path, '~' is ok) "
+    conf['drafts_dir'] = STDIN.gets
+    print "What file extension do you use for your drafts and posts? (no period) "
+    conf['file_extension'] = STDIN.gets
+    File.open(conf_file, 'wb') { |f| f.write(YAML.dump(conf)) }
+    conf
+  end
+end
+
+
+configuration = read_or_ask_for_configuration
+
+# Your Jekyll site's local root directory (it has the "_config.yml" file in it).
+$jekyll_root  = configuration['jekyll_root']
+
+# Wherever you keep your local in-progress drafts, outside of your Jekyll site.
+$drafts_dir = configuration['drafts_dir']
+
+# File-extension for your drafts and post files.
+$file_extension = configuration['file_extension']
+
+# Note: It's assumed that your drafts' filenames DON'T have date-prefixes.
+
+
+# ========================================
+# You probably DON'T need to touch anything below here!
+# ========================================
+
+
+# Other directories within Jekyll's root. The defaults should be fine.
+$posts_dir_name = "_posts" # Should already be in the root directory.
+$stash_dir_name = "_stash" # Will be created if necessary.
+
+# Filename details for posts. The defaults should be fine.
+$file_date_prefix_format = "%Y\-%m\-%d\-" # for Ruby's DateTime strftime
+$file_date_prefix_regexp = /\d+-\d+-\d+-/ # regexp to match date format above
+
+
+# ===  Start of functions  ===
+
+
+def first_matching_file_in_dir(the_filename_glob, the_dir_path)
+	Dir.chdir(the_dir_path)
+	matches = Dir.glob(the_filename_glob)
+	if matches.count == 0
+		puts "No matches found in #{the_dir_path}."
+		return false
+	elsif matches.count > 1
+		puts "Found #{matches.count} matching files (#{matches.join(", ")})"
+	end
+
+	filename = matches[0]
+	puts "Using file \"#{filename}\"."
+	return filename
+end
+
+
+def directory_exists(the_dir_path)
+	# Check for a directory at path.
+
+	if File.exist?(the_dir_path)
+		# Something's there. Check if it's a directory.
+		#puts "Found something at given path."
+		if File.directory?(the_dir_path)
+			# It exists, and it's a directory. We're done.
+			#puts "It's a directory."
+			return true
+		else
+			# Abort
+			#puts "It's not a directory"
+		end
+	end
+
+	return false
+end
+
+
+def create_dir_if_necessary(the_dir_path)
+	# Check for a directory at path, creating it if necessary.
+
+	# Check to see if an item exists at that path.
+	if directory_exists(the_dir_path)
+		return true
+	else
+		# It doesn't exist. Create it.
+		#puts "Nothing found at given path."
+		begin
+			Dir.mkdir(the_dir_path, 0755)
+			#puts "Created the directory: #{the_dir_path}"
+			return true
+		rescue SystemCallError
+			# If we failed to create the directory, abort.
+			#puts "Failed to create the directory."
+			return false
+		end
+	end
+
+	return false
+end
+
+
+def isolate(the_filename_glob)
+	# Moves all files from posts to stash, except those matching the glob.
+
+	# Move all files from posts into stash.
+	cmd = "mv #{$posts_dir}/*.#{$file_extension} #{$stash_dir}/"
+	result = `#{cmd}`
+
+	# Move the matching files back into posts.
+	cmd = "mv #{$stash_dir}/*#{the_filename_glob}* #{$posts_dir}/"
+	result = `#{cmd}`
+end
+
+
+def integrate()
+	# Moves all files from stash back into posts.
+
+	# Move all files from stash into posts.
+	cmd = "mv #{$stash_dir}/*.#{$file_extension} #{$posts_dir}/"
+	result = `#{cmd}`
+end
+
+
+def stage_file(the_filename_glob)
+	# Stages the given file.
+
+	puts "Staging \"#{the_filename_glob}\"…"
+
+	# Grab specified file (glob) from drafts folder.
+	full_glob = "*#{the_filename_glob}*.#{$file_extension}"
+	filename = first_matching_file_in_dir(full_glob, $drafts_dir)
+	if filename == false
+		puts "Couldn't find a file to stage. Aborting."
+		exit
+	end
+
+	# Move file to posts directory, prefixing its filename with today's date.
+	require "Date"
+	today = DateTime.now()
+	prefix = today.strftime($file_date_prefix_format)
+	new_filename = "#{prefix}#{filename}"
+
+	cmd = "mv #{$drafts_dir}/#{filename} #{$posts_dir}/#{new_filename}"
+	result = `#{cmd}`
+
+	# Isolate the staged file in posts, moving all other posts to stash.
+	isolate(new_filename)
+
+	puts "File staged as \"#{new_filename}\"."
+end
+
+
+def unstage_file(the_filename_glob)
+	# Unstages the given file, or the first staged file if none is specified.
+
+	if (the_filename_glob)
+		puts "Unstaging \"#{the_filename_glob}\"…"
+	else
+		puts "Unstaging first staged file…"
+	end
+
+	# Grab specified file (glob) from posts folder.
+	if (the_filename_glob)
+		full_glob = "*#{the_filename_glob}*.#{$file_extension}"
+	else
+		full_glob = "*.#{$file_extension}"
+	end
+	filename = first_matching_file_in_dir(full_glob, $posts_dir)
+	if filename == false
+		puts "Couldn't find a file to unstage. Aborting."
+		exit
+	end
+
+	# Move file to drafts directory, removing date from its filename.
+	new_filename = filename.sub($file_date_prefix_regexp, "")
+
+	cmd = "mv #{$posts_dir}/#{filename} #{$drafts_dir}/#{new_filename}"
+	result = `#{cmd}`
+
+	# Move all stashed files back into posts.
+	integrate()
+
+	puts "Unstaging complete."
+end
+
+
+def show_help()
+	puts "`#{$0} FILENAME_GLOB` stages the first matching draft."
+	puts "`#{$0} #{$unstage_flag}` unstages the first staged post."
+	puts "`#{$0} #{$unstage_flag} FILENAME_GLOB` unstages the first matching staged post."
+end
+
+
+# ===  End of functions  ===
+
+
+# Handle input
+$unstage_flag = "-u" # flag passed to the script to request unstaging
+filename_glob = nil
+unstage = false
+
+if ARGV.count == 0
+	puts "No filename or arguments specified."
+	show_help()
+	exit
+elsif ARGV.count == 1
+	if ARGV[0] == $unstage_flag
+		# This is the "unstage" flag without a filename.
+		unstage = true
+	else
+		# This is the "stage" command with a filename.
+		filename_glob = ARGV[0]
+	end
+elsif ARGV.count == 2
+	# If there are two arguments, the second one is the filename.
+	filename_glob = ARGV[1]
+	if ARGV[0] == $unstage_flag
+		unstage = true
+	else
+		puts "Input not recognised."
+		show_help()
+		exit
+	end
+end
+
+# All paths MUST be expanded before we begin.
+$drafts_dir = File.expand_path($drafts_dir)
+$jekyll_root = File.expand_path($jekyll_root)
+$stash_dir = "#{$jekyll_root}/#{$stash_dir_name}"
+$posts_dir = "#{$jekyll_root}/#{$posts_dir_name}"
+
+# Check that drafts, root, and posts directories exist.
+if directory_exists($drafts_dir) == false
+	puts "Drafts directory doesn't exist: #{$drafts_dir}"
+	exit
+end
+if directory_exists($jekyll_root) == false
+	puts "Jekyll root directory doesn't exist: #{$jekyll_root}"
+	exit
+end
+if directory_exists($posts_dir) == false
+	puts "Jekyll posts directory doesn't exist: #{$posts_dir}"
+	exit
+end
+
+# Ensure stash_dir exists, creating it if necessary.
+if directory_exists($stash_dir) == false
+	if create_dir_if_necessary($stash_dir) == false
+		# Something went wrong. Abort.
+		puts "Couldn't create stash directory: #{$stash_dir}"
+		puts "Aborting."
+		exit
+	else
+		puts "Created stash directory: #{$stash_dir}"
+	end
+end
+
+# Get the job done. It's a bit anticlimactic, really.
+if unstage
+	unstage_file(filename_glob)
+else
+	stage_file(filename_glob)
+end

data/jekyll-staging.gemspec

@@ -0,0 +1,18 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "jekyll-staging"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Matt Gemmell"]
+  spec.email         = ["matt@mattgemmell.com"]
+  spec.summary       = %q{Stage and unstage draft posts in Jekyll.}
+  spec.homepage      = "https://github.com/mattgemmell/Jekyll-Staging"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-staging
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matt Gemmell
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- matt@mattgemmell.com
+executables:
+- stage
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.markdown
+- README.markdown
+- Rakefile
+- bin/stage
+- jekyll-staging.gemspec
+homepage: https://github.com/mattgemmell/Jekyll-Staging
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Stage and unstage draft posts in Jekyll.
+test_files: []