groundwork 0.0.1

data/bin/groundwork

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby
+
+require File.join(File.dirname(__FILE__),"..","lib","groundwork.rb")
+
+begin
+  options = Groundwork::parse_options
+
+  case options[:command]
+  when "generate"
+    generate_opts = Trollop::options(options[:remainder]) do
+      opt :force, :default=>false
+    end
+
+    name = options[:remainder].shift || "Recipe"
+
+    if File.exists?(name+".recipe") && !generate_opts[:force]
+      raise RuntimeError.new("File already exists: #{name}.recipe")
+    end
+
+    recipe = Groundwork::Recipe.generate
+    File.open(name+".recipe","w"){|f| f.print recipe}
+  else
+  end
+rescue
+  puts $!.to_s
+end

data/lib/groundwork.rb

@@ -0,0 +1,175 @@
+require "rubygems"
+require "trollop"
+require "erb"
+require "pathname"
+require File.join(File.dirname(__FILE__), "options.rb")
+require File.join(File.dirname(__FILE__), "tar_wrapper.rb")
+
+module Groundwork
+  class Recipe
+    def initialize &block
+      if block_given?
+        instance_eval &block
+      end
+    end
+
+    def tar= data
+      @tar = TarWrapper.new(data)
+    end
+
+    # Creates a directory. If a block is passed,
+    # the block will be run inside that directory
+    def directory *name, &block
+      FileUtils.mkdir_p File.join(name)
+      if block_given?
+        FileUtils.cd File.join(name), &block
+      end
+    end
+
+    # If opts is a string, it's the contents of the file, verbatim
+    # If opts is a hash, it must contain either:
+    # * :from, copies the text of the given filename verbatim
+    # * :from_erb, uses the text of the filename as an erb template
+    # * :erb, uses the given string as an erb template
+    def file name, opts = nil
+      name = File.join(name)
+      File.open(File.join(name),"w") do |file|
+        if opts.is_a? String
+          file.print opts
+        elsif opts.is_a? Hash
+          file.print( if opts[:from]
+                        read_file opts[:from]
+                      elsif opts[:from_erb]
+                        ERB.new(read_file(opts[:from_erb])).result(binding)
+                      elsif opts[:erb]
+                        ERB.new(opts[:erb]).result(binding)
+                      end )
+        elsif opts.nil?
+          # write nothing
+        else
+          raise ArgumentError.new
+        end
+      end
+    end
+
+    # When you compile a recipe, it runs it to determine which files to bake in.
+    # If you have a file that might not be generated by running your script with
+    # no options, you can call possible on it to ensure it gets baked into
+    # the script. This function only has an effect during compilation, it does
+    # nothing when the script is actually run.
+    def possible name ; end
+
+    # Takes a block and lists the files that that block will require as templates.
+    # See Groundwork::Recipe#possible
+    def self.required_files &block
+      dummy = Object.new
+      files = []
+
+      class << dummy
+        attr_reader :files
+
+        def directory *args
+          yield if block_given?
+        end
+
+        def file name, opts=nil
+          @files << opts[:from] if opts[:from]
+          @files << opts[:from_erb] if opts[:from_erb]
+        end
+
+        def possible name
+          @files << name
+        end
+
+        def method_missing *args ; end
+      end
+
+      dummy.instance_variable_set "@files", []
+      dummy.instance_eval &block
+
+      dummy.files
+    end
+
+    # Takes a script file, finds the files it requires (paths relative to the script file),
+    # reads/tars them and returns a string containing the script and the TAR blob, ready
+    # to write to a file
+    def self.compile script_file
+      script = File.read(script_file)
+      out = StringIO.new
+      data = nil
+
+      FileUtils.cd(File.dirname(script_file)) do
+        files = required_files do
+          eval script
+        end
+
+        data = TarWrapper.compress files
+      end
+
+      out.puts "if $0==__FILE__"
+      out.puts "  require 'rubygems'"
+      out.puts "  require 'kickstart'"
+      out.puts "end"
+      out.puts ""
+      out.puts script
+      out.puts ""
+      out.puts "__END__"
+      out.puts data
+
+      out.string
+    end
+
+    # Takes a filename and runs the script contained in it. The file should be
+    # the results of Groundwork::Recipe#compile
+    def self.run script_file
+      (script, data) = File.read(script_file).split("\n__END__\n")
+
+      Groundwork::Recipe.new do
+        self.tar = data
+        eval script
+      end
+    end
+
+    # Generate a tree of file and directory calls that would create the given
+    # directory
+    def self.generate dir = FileUtils.pwd
+      base = Pathname.new dir
+
+      handle_dir = lambda do |d, output, indent|
+        FileUtils.cd d do
+          Dir["*"].each do |file|
+            if File.directory? file
+              if Dir[File.join(file,"*")].empty?
+                output.puts((" "*indent)+"directory \"#{file}\"")
+              else
+                output.puts("")
+                output.puts((" "*indent)+"directory \"#{file}\" do")
+                handle_dir[file, output, indent+2]
+                output.puts((" "*indent)+"end")
+                output.puts("")
+              end
+            else
+              rel = Pathname.new(File.join(FileUtils.pwd,file))
+              relpath = rel.relative_path_from(base).to_s
+              output.puts((" "*indent)+"file \"#{file}\", :from => \"#{relpath}\"")
+            end
+          end
+        end
+      end
+
+      str = StringIO.new
+      handle_dir[dir, str, 0]
+      str.string.gsub(/\n\n+/,"\n\n") # Collapse adjacent blank lines
+    end
+
+    private
+
+    def read_file name
+      if @tar
+        @tar[name]
+      else
+        File.read(name)
+      end
+    end
+  end
+end

data/lib/options.rb

@@ -0,0 +1,32 @@
+require "abbrev"
+
+module Groundwork
+  def self.parse_options opts=ARGV
+    global_opts = Trollop::options(opts) do
+      banner "Groundwork"
+      version "0.0.1"
+      stop_on_unknown
+    end
+
+    cmd=short_for(opts.shift)
+
+    return({ :options=>global_opts,
+             :command=>cmd,
+             :remainder=>opts
+           })
+  end
+
+  def self.short_for cmd_start, all_commands=["generate"]
+    return cmd_start unless cmd_start
+    return cmd_start if all_commands.index(cmd_start)
+
+    completions = all_commands.abbrev(cmd_start)
+    if completions[cmd_start]
+      completions[cmd_start]
+    elsif completions.values.uniq.empty?
+      raise RuntimeError.new("Unknown command \"#{cmd_start}\".")
+    else
+      raise RuntimeError.new("\"#{cmd_start}\" is ambiguous. Which did you mean:\n\t"+cmd_poss.join("\n\t"))
+    end
+  end
+end

data/lib/tar_wrapper.rb

@@ -0,0 +1,33 @@
+require "rubygems"
+require "archive/tar/minitar"
+require "base64"
+
+class Groundwork::TarWrapper
+  include Archive::Tar
+
+  # Takes a base64-encoded, tarred string
+  def initialize encoded
+    tar = Base64.decode64(encoded)
+    @files = {}
+    Minitar::Reader.new(StringIO.new(tar)).each do |entry|
+      next unless entry.file?
+      @files[entry.full_name] = entry.read
+    end
+  end
+
+  def [] name
+    @files[name]
+  end
+
+  def self.compress files
+    string = StringIO.new
+    output = Minitar::Output.new(string)
+
+    files.each do |file|
+      Minitar.pack_file(file, output)
+    end
+
+    output.close
+    Base64.encode64 string.string
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: groundwork
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Andrews, Ross
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-23 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 10
+        - 2
+        version: 1.10.2
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: archive-tar-minitar
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 5
+        - 2
+        version: 0.5.2
+  type: :runtime
+  version_requirements: *id002
+description: Create scripts that describe the groundwork for laying out your projects, and generate project frameworks
+email: randrews@geekfu.org
+executables: 
+- groundwork
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/groundwork.rb
+- lib/tar_wrapper.rb
+- lib/options.rb
+has_rdoc: true
+homepage: https://github.com/randrews/groundwork
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: groundwork
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A project scaffolding generator
+test_files: []
+