RubyGems - den - Versions diffs - 0.1.0 - Mend

den 0.1.0

Files changed (10) hide show

data/bin/den ADDED Viewed

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
+require 'den'
+require 'yaml'
+# If the command was to make a new site, do it and quit
+if "#{ARGV[0]} #{ARGV[1]}".downcase == "new site" and ARGV.length == 3
+  Den.create_skeleton(ARGV[2])
+  exit
+end
+# Exit if the '.den' file doesn't exist
+if !File.exists?('.den')
+  abort("Make sure you're running from the root of your Den instance.")
+end
+# Load the config if it exists
+config = YAML::load(File.open('config.yml')) if File.exist?('config.yml')
+# Create a Den instance
+den = Den.new(config=config)
+# Process arguments
+case ARGV[0]
+when 'new'
+  # Handle different 'new' cases (page, post)
+  if ARGV[1].downcase == 'page'
+    if !(ARGV.length == 3 or ARGV.length == 4)
+      abort('Invalid format for "new page".')
+    end
+    den.new_resource('page', :dest => ARGV[2], :file => ARGV[3])
+  elsif ARGV[1].downcase == 'post'
+    if !(ARGV.length == 2 or ARGV.length == 3)
+      abort('Invalid format for "new post".')
+	end
+    den.new_resource('post', :file => ARGV[2])
+  else
+    abort("'#{ARGV[1]}' is an invalid argument for 'new'. Must be either 'page' or 'post'.")
+  end
+  # Update the site
+  den.update_site(refresh=true)
+when 'delete'
+  abort('Invalid format for command "delete".') if ARGV.length != 3
+  if ARGV[1].downcase == 'page' or ARGV[1].downcase == 'post'
+    den.delete_resource(ARGV[1].downcase, ARGV[2])
+  else
+    abort("'#{ARGV[1]}' is an invalid argument for 'delete'. Must be either 'page' or 'post'.")
+  end
+  # Update the site
+  den.update_site(refresh=true)
+when 'list'
+  abort('Invalid format for "list".') if ARGV.length > 1
+  # Display all the content
+  den.print_content
+# Unrecognized argument, exit
+else
+  if ARGV.length > 0
+    abort('Invalid command.')
+  else
+    den.update_site
+  end
+end

data/den.gemspec ADDED Viewed

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name = 'den'
+  s.version = '0.1.0'
+  s.summary = 'A really simple static-site generator.'
+  s.authors = ["Peter Valdez"]
+  s.email = 'peter@someindividual.com'
+  s.executables << 'den'
+  s.homepage = 'https://github.com/azlyth/den'
+  s.files = %w[
+    bin/den
+    lib/den/examples.rb
+    lib/den/page.rb
+    lib/den/post.rb
+    lib/den/resource.rb
+    lib/den/template.rb
+    lib/den/utilities.rb
+    lib/den.rb
+    den.gemspec
+  ]
+end

data/lib/den/examples.rb ADDED Viewed

@@ -0,0 +1,25 @@
+# A module used to keep all the skeleton defaults in one place.
+module Examples
+  CONFIG = ":site:\n    :root: /var/www/\n    :posts: musings\n"
+  TEMPLATES = {
+    # Base template
+    :base => "<html>\n	<head>\n		<title>{{ title }} | mysite</title>\n	</head>\n	<body>\n		<div id=\"content\">\n			{{ body }}\n		</div>\n	</body>\n</html>\n",
+    # Index template
+    :index => "{{ extends base.html }}\n\n{{ block title }}index{{ endblock }}\n\n{{ block body }}\n[[ body ]]\n{{ endblock }}\n",
+    # Page template
+    :page => "{{ extends base.html }}\n\n{{ block title }}[[ title ]]{{ endblock }}\n\n{{ block body }}\n[[ content ]]\n{{ endblock }}\n",
+    # Post template
+    :post => "{{ extends base.html }}\n\n{{ block title }}[[ title ]]{{ endblock }}\n\n{{ block body }}\n[[ content ]]\n{{ endblock }}\n",
+  }
+  # Example page
+  PAGE = "[About me]\n\nThis is a test \"about me\" page.\nAsdfasdf.\n\n# Intro\n\n## Past\n\nBlah blah, I did this and that.\n\n## Now\n\nWoah, you do WHAT these days?\n"
+  # Example post
+  POST = "[What a post.]\n\nNo, but really, what a post. I'm kidding this is an example post.\nIt's a post that makes a world of a difference.\n\n# Some great point\n\n## A worthy subpoint\n\nAnd some info.\n\nAnd conclude.\n"
+end

data/lib/den/page.rb ADDED Viewed

@@ -0,0 +1,41 @@
+require "cgi"
+require "den/resource"
+class Page < Resource
+  def to_s
+    "Page: #{@content[:id]}"
+  end
+  # Return the HTML rendering of this page
+  def html()
+    _html = "<div id=\"page\">\n"
+    # Wrap title in anchor if link is provided
+    _html += "<h1 id=\"title\">#{@content[:title]}</h1>\n"
+    # Add the rest of the necessary content
+    _html += "<div id=\"body\">\n" +
+      "#{@content[:body]}\n" +
+      "</div>" +
+      "</div>"
+    _html
+  end
+  # Pull out metadata and markup the page
+  def process
+    File.open(@file) do |f|
+      page = markup(f.read)
+    end
+    # Extract the url from the filename
+    page[:id] = @file.split('/')[-1]
+    # Store the processed info
+    @content = page
+  end
+end

data/lib/den/post.rb ADDED Viewed

@@ -0,0 +1,62 @@
+require "date"
+require "cgi"
+require "den/resource"
+class Post < Resource
+  def to_s
+    "Post #{@content[:id]}"
+  end
+  def [](index)
+    @content[index]
+  end
+  # Return the HTML rendering of the post
+  def html(link="")
+    _html = "<div id=\"post\">\n"
+    # Wrap title in anchor if link is provided
+    _html += "<h1 id=\"title\">"
+    if link != ""
+      _html += "<a href=\"#{link}\">"
+    end
+    _html += "#{@content[:title]}"
+    if link != ""
+      _html += "</a>"
+    end
+    _html += "</h1>\n"
+    # Add the rest of the necessary content
+    _html += "<h2 id=\"date\">#{@content[:date].strftime("%B %e, %Y")}</h2>\n" +
+      "<div id=\"body\">\n" +
+      "#{@content[:body]}\n" +
+      "</div>\n" +
+      "</div>"
+    _html
+  end
+  # Pull out metadata and markup the post
+  def process
+    File.open(@file) do |f|
+      # Extract the date
+      post = {
+        :id => f.readline.chomp,
+        :date => DateTime.strptime(f.readline.chomp, "%Y-%m-%d %H:%M:%S %z")
+      }
+      # Process the post
+      post.merge!(markup(f.read))
+      # Store the processed info
+      @content = post
+    end
+  end
+end

data/lib/den/resource.rb ADDED Viewed

@@ -0,0 +1,58 @@
+# General Den resource object (included by Page and Post)
+class Resource
+  # Initialize the object
+  def initialize(file)
+    @file = file
+    process
+  end
+  def [](index)
+    @content[index]
+  end
+  # Deletes itself
+  def delete
+    File.delete(@file)
+  end
+  # General markup function
+  def markup(s)
+    s = CGI::escapeHTML(s)
+    title = nil
+    # Extract title
+    s.gsub!(/\A\[(.*\S)\]$/) do |x|
+      title = $1
+      ""
+    end
+    # Remove duplicate newlines
+    s.gsub!(/\n\n+/, "\n\n")
+    # Remove leading whitespace from lines
+    s.gsub!(/^ +/, "")
+    # Pad string to remove edge cases
+    s.gsub!(/(\A\n*)|(\n*\z)/, "\n")
+    # Headers
+    s.gsub!(/^(#+)\s*(.*)/) {
+      len = $1.length
+      "<h#{len+1} class=\"header\">#$2</h#{len}>"
+    }
+    # Paragraphs
+    s.gsub!(/(\A|\n)\n([^<])/, "\n\n<p>\\2")
+    s.gsub!(/([^>])\n\n/, "\\1</p>\n\n")
+    # Remove extra newlines
+    s.gsub!(/\n+/, "\n")
+    {:title => title, :body => s}
+  end
+end

data/lib/den/template.rb ADDED Viewed

@@ -0,0 +1,101 @@
+class Template
+  def initialize(template_dir, template_file=nil, post_location=nil)
+    @template_dir = template_dir
+    load_template(template_file) if !template_file.nil?
+    @post_location = post_location
+  end
+  # Calls the appropriate render function
+  def render(obj, prev_page=nil, next_page=nil)
+    case obj
+    when Resource
+      return render_resource(obj)
+    when Array
+      return render_index(obj, prev_page, next_page)
+    end
+  end
+  # Returns the HTML of a Resource
+  def render_resource(r)
+    data = {
+      "title" => r[:title],
+      "content" => r.html
+    }
+    populate(data)
+  end
+  # Returns the HTML of an index
+  def render_index(posts, prev_page, next_page)
+    # Get the HTML of each Post and combine them
+    posts.collect! { |p| p.html(File.join('/', @post_location, p[:id].to_s)) }
+    data = { "body" => posts.join("\n\n") }
+    # Append next/previous links if necessary
+    if !prev_page.nil?
+      data["body"] += "<a class=\"nav\" id=\"future\" href=\"#{prev_page}\">Newer Posts</a>\n"
+    end
+    if !next_page.nil?
+      data["body"] += "<a class=\"nav\" id=\"past\" href=\"#{next_page}\">Older Posts</a>\n"
+    end
+    # Return the rendered index
+    populate(data)
+  end
+  # Fills in the template with the data provided
+  def populate(data)
+    @content.gsub(/\[\[ (\S*) \]\]/) { |x| data[$1] }
+  end
+  # Loads the template file into @content
+  def load_template(filename)
+    template_path = File.join(@template_dir, filename)
+    if File.file?(template_path)
+      # Load the template file
+      template_file = ''
+      File.open(template_path) do |f|
+        template_file = f.read
+      end
+      # Check if this template is an extension
+      if template_file =~ /{{ extends (\S*) }}/
+        # Load the parent template into content
+        load_template($1)
+        # Find blocks
+        template_file = template_file.split("{{ endblock }}")
+        blocks = {}
+        for block in template_file
+          if /{{ block (?<label>\S*) }}(?<content>[\s\S]*)/ =~ block
+            blocks[label] = content
+          end
+        end
+        # Combine the parent template with the blocks
+        merge_templates(blocks)
+      else
+        # Load the file into content
+        @content = template_file
+      end
+    else
+      puts "Unable to locate template: #{@template_dir + filename}."
+    end
+  end
+  # Combine a template with its parent
+  def merge_templates(blocks)
+    @content.gsub!(/{{ (\S*) }}/) do |x|
+      blocks[$1]
+    end
+  end
+end

data/lib/den/utilities.rb ADDED Viewed

@@ -0,0 +1,19 @@
+# Given a filename (and extension, optionally), returns an unused filename.
+def get_unused_filename(filename, extension="")
+  extension = "." + extension if extension != ""
+  full_path = filename + extension
+  if File.exists?(full_path)
+    count = 1
+    # Keep adding to the count until we find filename that isn't taken.
+    while File.exists?("#{filename}_#{count}#{extension}")
+      count += 1
+    end
+    full_path = "#{filename}_#{count}#{extension}"
+  end
+  full_path
+end

data/lib/den.rb ADDED Viewed

@@ -0,0 +1,322 @@
+require "fileutils"
+require "date"
+require "den/post"
+require "den/page"
+require "den/template"
+require "den/utilities"
+require "den/examples"
+class Den
+  # Creates a new Den site
+  def self.create_skeleton(location)
+    # Create the directories along with default templates
+    Dir.mkdir(location)
+    Dir.mkdir(File.join(location, 'pages'))
+    Dir.mkdir(File.join(location, 'posts'))
+    Dir.mkdir(File.join(location, 'posts', 'new'))
+    Dir.mkdir(File.join(location, 'templates'))
+    Examples::TEMPLATES.each_pair { |file, content|
+      File.open(File.join(location, 'templates', file.to_s + '.html'), 'w') do |f|
+        f.print(content)
+      end
+    }
+    File.open(File.join(location, 'config.yml'), 'w') do |f|
+      f.write(Examples::CONFIG)
+    end
+    # Create the file that indicates this is a Den instance
+    FileUtils.touch(File.join(location, '.den'))
+    puts "Created new site in '#{location}'."
+  end
+  # Default configuration values
+  @@default_config = {
+    # Where pages are actually served from
+    # Note the following:
+    # - 'root' gets prepended to all locations but 'index'
+    # - 'posts' gets prepended to 'index'
+    :site => {
+      :root => "/var/www/",
+      :pages => "",
+      :posts => "posts/",
+      :index => "index/",
+    },
+  }
+  @@default_meta = {
+    # The number of total posts
+    :last_post => 0,
+  }
+  # Create the Den and store the config, prioritizing the provided one.
+  def initialize(config=nil)
+    @config = @@default_config
+    if !config.nil?
+      @config[:new_posts] = config[:new_posts] if !config[:new_posts].nil?
+      @config[:site].merge!(config[:site]) if !config[:site].nil?
+    end
+    load_metadata
+    gather_new_posts
+    prepare_content
+  end
+  # Update the site
+  def update_site(refresh=false)
+    if refresh
+      prepare_content
+    end
+    push_content
+    create_indices
+    puts "Updated the site."
+  end
+  # Display the Den's pages and posts, along with their metadata
+  def print_content
+    puts "Pages:" if !@pages.empty?
+    @pages.each do |p|
+      puts "  #{p[:id]} (title: '#{p[:title]}')"
+    end
+    puts "Posts:" if !@posts.empty?
+    @posts.each do |p|
+      puts "  #{p[:id]} (title: '#{p[:title]}', date: #{p[:date].strftime("%B %e, %Y")})"
+    end
+    if @pages.empty? and @posts.empty?
+      puts "No content."
+    end
+  end
+  # Adds a page or post. If a file is provided, it copies the contents of the
+  # file. Otherwise, it will start the default editor to make the new resource.
+  def new_resource(type, options)
+    defaults = {:file => nil, :dest => nil}
+    options = defaults.merge(options)
+    type.downcase!
+    if options[:file].nil?
+      # Create the new page/post with the default editor
+      if type == 'page'
+        file = File.join('pages', options[:dest])
+        system("/usr/bin/editor #{file}")
+      elsif type == 'post'
+        file = File.join('posts', 'new', 'new.post')
+        system("/usr/bin/editor #{file}")
+        gather_new_posts
+      end
+      if File.exists?(file)
+        puts "Added a #{type}."
+      else
+        puts "Cancelled adding a #{type}."
+      end
+    else
+      # Copy the file that will be the new page/post
+      if type == 'page'
+        FileUtils.cp(options[:file], File.join('pages', options[:dest]))
+      elsif type == 'post'
+        FileUtils.cp(options[:file], File.join('posts', 'new'))
+        gather_new_posts
+      end
+      puts "Using #{options[:file]} as a new #{type}."
+    end
+  end
+  # Deletes a page/post, identified by its ID
+  def delete_resource(type, id)
+    type.downcase!
+    # Find the page/post
+    if type == 'page'
+      res = @pages.select { |p| p[:id] == id }
+      fn = File.join(@config[:site][:root], @config[:site][:pages])
+    elsif type == 'post'
+      res = @posts.select { |p| p[:id] == id }
+      fn = File.join(@config[:site][:root], @config[:site][:posts])
+    end
+    # If we found a resource, delete it.
+    if !res.nil?
+      res = res[0]
+      fn = File.join(fn, res[:id])
+      File.delete(fn) if File.exists?(fn)
+      res.delete
+      puts "Deleted #{type} '#{id}'."
+    else
+      puts "No #{type} with id '#{id}'."
+    end
+  end
+  def load_metadata
+    @meta = @@default_meta
+    meta_file = File.join("metadata.yml")
+    # Load the metadata
+    if File.exists?(meta_file)
+      yml = YAML::load(File.open(meta_file))
+      @meta.merge!(yml)
+    end
+  end
+  def save_metadata
+    meta_file = File.join("metadata.yml")
+    File.open(meta_file, 'w') do |f|
+      f.puts("# Do not touch this file, as it's auto-generated.")
+      YAML::dump(@meta, f)
+    end
+  end
+  # Create the indices for the posts
+  def create_indices
+    destination = File.join(@config[:site][:root], @config[:site][:posts], @config[:site][:index])
+    Dir.mkdir(destination) if !Dir.exists?(destination)
+    # Clear out the indices before making them
+    Dir.entries(destination).each do |f|
+      index = File.join(destination, f)
+      File.delete(index) if File.file?(index)
+    end
+    temp_dir = File.join("templates")
+    template = Template.new(temp_dir, 'index.html', post_location=@config[:site][:posts])
+    indices = []
+    # Segment the posts into groups of 5
+    @posts.each_slice(5) { |posts|
+      indices << posts
+    }
+    # Create the indices and save them
+    indices.length.times { |i|
+      p_pg = nil
+      n_pg = nil
+      # Find the relative location (to the site) of the index
+      rel_index = File.join("/", @config[:site][:posts], @config[:site][:index])
+      # Figure out the previous/next pages, if they exist
+      p_pg = File.join(rel_index, i.to_s) if i > 0
+      n_pg = File.join(rel_index, (i+2).to_s) if i + 1 < indices.length
+      # Render the index page
+      indices[i] = template.render(indices[i], prev_page=p_pg, next_page=n_pg)
+      # Save the index page
+      index_file = File.join(destination, (i+1).to_s)
+      File.open(index_file, 'w') do |f|
+        f.print(indices[i])
+      end
+    }
+  end
+  # Publish the posts and pages
+  def push_content
+    temp_dir = File.join("templates")
+    # Create the post directory if it doesn't exist
+    destination = File.join(@config[:site][:root], @config[:site][:posts])
+    Dir.mkdir(destination) if !Dir.exists?(destination)
+    # Render and save each post to the post directory
+    template = Template.new(temp_dir, 'post.html')
+    @posts.each do |post|
+      post_file = File.join(destination, post[:id])
+      File.open(post_file, 'w') do |f|
+        f.print(template.render(post))
+      end
+    end
+    # Create the page directory if it doesn't exist
+    destination = File.join(@config[:site][:root], @config[:site][:pages])
+    Dir.mkdir(destination) if !Dir.exists?(destination)
+    # Render and save each page to the page directory
+    template = Template.new(temp_dir, 'page.html')
+    @pages.each do |page|
+      page_file = File.join(destination, page[:id])
+      File.open(page_file, 'w') do |f|
+        f.print(template.render(page))
+      end
+    end
+  end
+  # Move any new posts to the saved posts directory.
+  def gather_new_posts
+    new_dir = File.join("posts", "new")
+    Dir.entries(new_dir).each do |f|
+      post_file = File.join(new_dir, f)
+      if File.file?(post_file)
+        # Save the new post to the processed directory with metadata attached
+        File.open(post_file) do |new_post|
+          date = new_post.mtime
+          save_path = get_unused_filename(File.join("posts", date.strftime("%Y-%m-%d")), "post")
+          File.open(save_path, "w") do |save_file|
+            save_file.puts(@meta[:last_post] + 1)
+            save_file.puts(date.strftime("%Y-%m-%d %H:%M:%S %z"))
+            save_file.print(new_post.read)
+          end
+        end
+        # Remove the file from the new post directory
+        File.delete(post_file)
+        # Update the value of the last ID used
+        @meta[:last_post] += 1
+      end
+    end
+  end
+  # Process the pages and posts
+  def prepare_content
+    @posts = []
+    @pages = []
+    # Create a Post for each file in the posts directory
+    Dir.entries('posts').each do |f|
+      entry = File.join('posts', f)
+      if File.file?(entry)
+        @posts << Post.new(entry)
+      end
+    end
+    # Create a Page for each file in the pages directory
+    Dir.entries('pages').each do |f|
+      entry = File.join('pages', f)
+      if File.file?(entry)
+        @pages << Page.new(entry)
+      end
+    end
+    save_metadata
+    # Sort the posts by date, with most recent first
+    @posts.sort_by! { |post| post[:date] }
+    @posts.reverse!
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: den
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease:
+platform: ruby
+authors:
+- Peter Valdez
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-06-25 00:00:00.000000000 Z
+dependencies: []
+description:
+email: peter@someindividual.com
+executables:
+- den
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/den
+- lib/den/examples.rb
+- lib/den/page.rb
+- lib/den/post.rb
+- lib/den/resource.rb
+- lib/den/template.rb
+- lib/den/utilities.rb
+- lib/den.rb
+- den.gemspec
+homepage: https://github.com/azlyth/den
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.11
+signing_key:
+specification_version: 3
+summary: A really simple static-site generator.
+test_files: []