benofsky-bolt 0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2009 Ben McRedmond
+
+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/bin/bolt

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+# 
+#  bolt
+#  bolt
+#  
+#  Created by Ben McRedmond on 2010-01-08.
+#  Copyright 2010 Ben McRedmond. All rights reserved.
+# 
+
+begin
+  require 'bolt'  
+rescue LoadError
+  require 'rubygems'
+  require 'bolt'
+end
+
+b = Bolt::Bolt.new
+b.run

data/default_files/config.yml

@@ -0,0 +1,4 @@
+primary_template: application.haml
+
+# Key-value paris in this file will be available as instance variables in Bolt pages and views
+# e.g. title: MyAweomseSite becomes @title => "MyAwesomeSite"

data/lib/bolt.rb

@@ -0,0 +1,100 @@
+# 
+#  bolt.rb
+#  bolt
+#  
+#  Created by Ben McRedmond on 2010-01-08.
+#  Copyright 2010 Ben McRedmond. All rights reserved.
+# 
+
+require 'optparse'
+require 'ostruct'
+
+module Bolt
+  class Bolt
+    def initialize
+      $config = OpenStruct.new
+      @commands = {"create" => true,
+                   "build" => true}
+    end
+    
+    # Parses command line options then runs the specified command
+    def run
+      parse_options
+      run_command
+    end
+    
+    private
+    # Runs a command specified on the command line
+    def run_command
+      self.send($config.command)
+    end
+    
+    # Creates a new project object and runs it resulting in creating 
+    # all nessecary directories for a new bolt project
+    def create
+      require 'bolt/project'
+      Project.new($config).run
+    end
+
+    # Creates a new build object and runs it resulting in building
+    # a bolt project and saving all files into the "out" directory.
+    def build
+      require 'bolt/build'
+      Build.new($config).run
+    end
+
+    # Parses command line options
+    def parse_options
+      $config.resources = "resources"
+      $config.lib = "lib"
+      $config.views = "views"
+      $config.pages = "pages"
+      $config.out = "out"
+      $config.config = "config.yml"
+      
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: bolt {create/build} [options] [file]"
+
+        opts.on("-r", "--resources [resource-dir]", "Resources directory") do |opts|
+          $config.resources = opts
+        end
+        
+        opts.on("-v", "--views [views-dir]", "Views directory") do |opts|
+          $config.views = opts
+        end
+        
+        opts.on("-l", "--lib [lib-dir]", "Library directory") do |opts|
+          $config.lib = opts
+        end
+        
+        opts.on("-p", "--pages [pages-dir]", "Pages directory") do |opts|
+          $config.pages = opts
+        end
+
+        opts.on("-o", "--out [out-directory]", "Where to save HTML") do |opts|
+          $config.out = opts
+        end
+        
+        opts.on("-c", "--config [config-file.yml]", "Config file") do |opts|
+          $config.config = opts
+        end
+
+        opts.on_tail("-h", "--help", "Show this help message") do
+          puts opts
+          exit        
+        end
+
+        opts.parse!(ARGV)  
+      end
+
+      if ARGV.empty? || ARGV.count > 2 || @commands[ARGV[0]].nil?
+        puts opts.help
+        exit
+      else
+        $config.command = ARGV[0]
+        $config.base_dir = (ARGV.count == 2) ? ARGV[1] : "."
+        $config.base_dir += '/' if $config.base_dir[-1..$config.base_dir.length] != '/'
+      end
+    end
+  end
+end

data/lib/bolt/base.rb

@@ -0,0 +1,68 @@
+# 
+#  base.rb
+#  bolt
+#  
+#  Created by Ben McRedmond on 2010-01-08.
+#  Copyright 2010 Ben McRedmond. All rights reserved.
+# 
+
+require 'fileutils'
+require 'ftools'
+
+$BOLT_BASE = File.dirname(__FILE__) + "/../../"
+
+module Bolt
+  class Base
+    # Takes an ostruct options object created by parsing ARGV
+    def initialize(options)
+      $config = options
+      STDOUT.sync = true
+    end        
+    
+    # Creates a directory, prefixes $config.base_dir if required
+    def create_directory(directory, options = {})
+      options[:error_if_exists] = (options[:error_if_exists].nil?) ? true : options[:error_if_exists]
+      directory = d(directory) if options[:base_dir].nil?     
+      
+      if File.directory?(directory)
+        raise ArgumentError, "#{directory} exists already." if options[:error_if_exists]
+      else
+        Dir.mkdir(directory)
+        puts "Created #{directory}"
+      end            
+    end
+    
+    # Forces removal of directory, <tt>directory</tt>
+    def remove_directory(directory)
+      directory = d(directory)
+      FileUtils.rm_rf(directory)
+      puts "Removed #{directory}"
+    end
+    
+    # Creates a file, <tt>file</tt>, with the contents of <tt>:copy_from</tt>, prefixes $config.base_dir
+    def create_file(file, options = {})
+      file = d(file)
+            
+      options[:mode] ||= "r"
+      options[:copy_from] ||= false
+      
+      if options[:copy_from]          
+        f = File.copy(options[:copy_from], file)
+      else
+        f = File.new(file, options[:mode])
+      end
+    
+      puts "Created #{file}"
+    end
+    
+    # Opens file, <tt>file</tt> with mode, <tt>mode</tt> prefixes $config.base_dir
+    def open_file(file, mode = "r")
+      File.open(d(file), mode)
+    end
+    
+    # Returns <tt>file_or_directory</tt> with $config.base_dir prefixed
+    def d(file_or_directory)
+      $config.base_dir + file_or_directory
+    end
+  end
+end

data/lib/bolt/build.rb

@@ -0,0 +1,51 @@
+# 
+#  build.rb
+#  bolt
+#  
+#  Created by Ben McRedmond on 2010-01-08.
+#  Copyright 2010 Ben McRedmond. All rights reserved.
+# 
+
+require 'yaml'
+require 'fileutils'
+
+require 'bolt/base'
+require 'bolt/page'
+require 'bolt/view'
+
+module Bolt
+  class Build < Base
+    # Performs all the nessecary steps to build a Bolt project
+    def run
+      remove_directory("out")
+      create_directory("out", :error_if_exists => false)      
+      copy_resources
+      parse_config
+      load_pages
+    end
+    
+    # Copies the contents of $config.resources to the out directory
+    def copy_resources
+      FileUtils.cp_r(Dir.glob("#{d($config.resources)}/*"), d($config.out))
+      puts "Copied #{d($config.resources)} to #{d($config.out)}"
+    end
+    
+    # Parses $config.config and loads all contents into instance variables
+    def parse_config
+      $config_file = YAML::load(open_file(d($config.config)))
+      puts "Parsed config #{d($config.config)}"
+    end  
+    
+    def load_pages
+      pages = Dir.glob("#{d($config.pages)}/*.rb")
+      pages.each do |page|
+        parse_page page        
+      end
+    end
+    
+    def parse_page(page)
+      puts "Parsing page #{page}"
+      load page      
+    end
+  end
+end

data/lib/bolt/page.rb

@@ -0,0 +1,74 @@
+# 
+#  page.rb
+#  bolt
+#  
+#  Created by Ben McRedmond on 2010-01-09.
+#  Copyright 2010 Ben McRedmond. All rights reserved.
+# 
+
+# Loads the specified view into instance variable @content
+# which is then inserted into a template
+def render(view, options = {})
+  raise ArgumentError, "Please specify a view to render" if view.empty?
+  
+  options[:template] ||= $config_file['primary_template']
+  options[:engine] ||= "haml"
+
+  raise ArgumentError, ":engine cannot be view" if options[:engine] == "view"    
+  require options[:engine_require] || options[:engine]
+  
+  @content = render_view(view_as_string(view, options[:engine]), options[:engine])
+  render_view(view_as_string(options[:template]), options[:engine]) unless options[:template].empty?
+end
+
+# Writes a file containing whatever is returned from a supplied block
+# Will create directories as required by <tt>path</tt>
+def page(path)
+  create_path(path)
+  
+  path = "#{$config.base_dir}#{$config.out}/#{path}.html"
+  File.open(path, 'w') {|f| f.write yield}
+  puts "Created #{path}"
+end
+
+private
+def create_path(path)
+  path = path.split('/')
+  path = "#{$config.base_dir}#{$config.out}/#{path[0..path.length-2].join('/')}"
+  if !File.directory?(path)
+    FileUtils.mkdir_p(path)
+    puts "Created #{path}"
+  end
+end
+
+# Opens a view file and attempts to read it into a string
+def view_as_string(view, engine = "haml")
+  v = ""
+  path = "#{$config.base_dir}/#{$config.views}/#{view}"
+  
+  begin
+    File.open(path) {|f| v = f.read}
+  rescue Errno::ENOENT
+    File.open("#{path}.#{engine}") {|f| v = f.read}
+  end
+  
+  v
+end
+
+# Renders <tt>view</tt> with <tt>engine</tt>
+def render_view(view, engine)
+  self.send("render_#{engine}", view)
+end
+
+# Renders haml string, <tt>haml</tt>
+def render_haml(haml, locals = {})
+  if locals != false && locals.empty?
+    self.instance_variables.each do |var|
+      locals[var.split("@")[1]] = self.instance_variable_get(var)
+    end
+    
+    locals.merge!($config_file)
+  end
+  
+  Haml::Engine.new(haml).render(Object.new, locals)
+end

data/lib/bolt/project.rb

@@ -0,0 +1,40 @@
+# 
+#  project.rb
+#  bolt
+#  
+#  Created by Ben McRedmond on 2010-01-08.
+#  Copyright 2010 Ben McRedmond. All rights reserved.
+# 
+
+require 'bolt/base'
+
+module Bolt
+  class Project < Base        
+    # Takes an ostruct options object created by parsing ARGV
+    def initialize(options)
+      super(options)      
+      @default_directories = [$config.pages, $config.views, $config.lib, $config.resources] 
+      @default_files = {$config.config => "default_files/config.yml"}
+    end
+
+    # Creates all nessecary directories and files for a new Bolt Project
+    def run
+      create_directory_structure
+      create_files
+    end
+    
+    private
+    # Creates all the default directories using either defaults 
+    # specified in lib/bolt.rb or by options on the command line
+    def create_directory_structure
+      create_directory($config.base_dir, :base_dir => true) unless File.directory?($config.base_dir)
+      @default_directories.each {|directory| create_directory(directory)}
+    end    
+    
+    # Creates all the default files using either defaults specified
+    # in lib/bolt.rb or by options on the command line
+    def create_files
+      @default_files.each {|file, template| create_file(file, :copy_from => $BOLT_BASE + template)}
+    end
+  end
+end

data/lib/bolt/view.rb

@@ -0,0 +1,11 @@
+# 
+#  view.rb
+#  bolt
+#  
+#  Created by Ben McRedmond on 2010-01-09.
+#  Copyright 2010 Ben McRedmond. All rights reserved.
+# 
+
+def u(path)
+  path + ".html" 
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: benofsky-bolt
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Ben McRedmond
+autorequire: 
+bindir: 
+- bin
+cert_chain: []
+
+date: 2010-01-08 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: haml
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.2"
+    version: 
+description: WeBolt was built to fill a gap in static website generators, making it super easy to generate a static website with dynamic content inserted at compile time.
+email: ben+bolt@benmcredmond.com
+executables: 
+- bolt
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/bolt/base.rb
+- lib/bolt/build.rb
+- lib/bolt/page.rb
+- lib/bolt/project.rb
+- lib/bolt/view.rb
+- lib/bolt.rb
+- bin/bolt
+- LICENSE
+- default_files/config.yml
+has_rdoc: true
+homepage: http://github.com/benofsky/bolt/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: WeBolt is a simple static website generator with support for dynamic content.
+test_files: []
+