linecook 1.2.1 → 2.0.0

data/HowTo/Setup Virtual Machines

@@ -1,76 +0,0 @@
-= Setup Virtual Machines
-
-{VirtualBox}[http://www.virtualbox.org] runs virtual machines on your local
-box. Local VMs help minimize development cycles because they are quick to
-access and reset. In addition, VirtualBox allows snapshots which can save and
-restore a particular server state - this functionality enables iterative
-development.
-
-To set up a Ubuntu VM using VirtualBox:
-
-1. Download and Install VirtualBox (http://www.virtualbox.org)
-2. Download a Ubuntu ISO (http://www.ubuntu.com/server/get-ubuntu/download)
-3. Build the Box
-
-When done, see the documentation for {controlling
-VMs}[link:files/HowTo/Control%20Virtual%20Machines.html]
-
-== Building a Ubuntu Box
-
-Use the VirtualBox wizard to get started. The name and other settings (ex
-user, ssh port) may be changed but be sure to propagate changes throughout the
-setup process.
-
-  - name: abox
-  - Linux/Ubuntu
-  - 512 MB memory
-  - 8 GB dynamically resizing drive
-
-Add the Ubuntu iso to the cd/dvd device under Settings > Storage. Now start
-the server and install Ubuntu (use default settings unless specified):
-
-  - hostname: abox-ubuntu
-  - user/password: linecook
-  - select 'OpenSSH server' in packages to install
-
-When the server has rebooted and is at the login screen, remove the install
-iso, take a snapshot, and setup port forwarding. Port forwarding allows you to
-access the ssh port (22) on the VM via a port on your local box (2220).
-
-  (Devices > CD/DVD Devices > Remove disk from virtual drive)
-  VBoxManage snapshot abox take RAW
-  VBoxManage controlvm abox poweroff
-  # wait to fully power off
-  VBoxManage modifyvm abox --natpf1 'abox-ssh,tcp,,2220,,22'
-  VBoxManage -q snapshot abox restore RAW
-  VBoxManage startvm abox
-
-Transfer your ssh key to the VM (notice port 2220). Help to generate ssh keys
-can be found on {GitHub}[http://help.github.com/key-setup-redirect]:
-
-  scp -P 2220 -o UserKnownHostsFile=/dev/null ~/.ssh/id_rsa.pub linecook@localhost:id_rsa.pub
-  
-Login as linecook and setup SSH access:
-
-  vm: mkdir .ssh
-  vm: mv id_rsa.pub .ssh/authorized_keys
-  vm: chmod 0700 .ssh
-  vm: chmod 0600 .ssh/authorized_keys
-
-Remove the login banner (as a convenience) and exit:
-
-  vm: sudo rm /etc/motd
-  vm: exit
-
-Now take a base snapshot:
-
-  VBoxManage snapshot abox take BASE
-  VBoxManage controlvm abox poweroff
-
-To cleanup port forwarding (run later, if ever):
-
-  VBoxManage modifyvm abox --natpf1 delete 'abox-ssh'
-
-The same procedure can be repeated to build other VMs. Nothing is special
-about this setup. The os, name, port, and other settings may be changed to
-your liking - all that Linecook requires is ssh access.

data/README

@@ -1,117 +0,0 @@
-= Linecook
-
-A shell script generator.
-
-== Description
-
-Linecook generates shell scripts using an extensible set of ERB helpers. The
-shell scripts and associated resources (files, subscripts, etc) make up
-packages that can be used, for example, to provision servers.
-
-Linecook provides a command line tool to manage development servers, generate
-scripts, and run scripts on servers. Helpers and recipes can be shared as
-gems; the canonical shell helpers are available through
-{Linebook}[http://rubygems.org/gems/linebook/].
-
-See the documentation for help to:
-
-* {Setup}[link:files/HowTo/Setup%20Virtual%20Machines.html] and {Control}[link:files/HowTo/Control%20Virtual%20Machines.html] Virtual Machines
-* {Generate Scripts}[link:files/HowTo/Generate%20Scripts.html]
-* {Run Scripts}[link:files/HowTo/Run%20Scripts.html]
-
-== Usage
-
-Generate a project.
-
-  % linecook init chalkboard
-  % cd chalkboard
-
-Define default attributes.
-
-  [attributes/chalkboard.rb]
-  attrs['chalkboard']['n'] = 3
-  attrs['chalkboard']['color'] = 'white'
-  attrs['chalkboard']['message'] = 'I will not manually configure my server'
-
-Define a helper.
-
-  [helpers/chalkboard/echo_in_color.erb]
-  Echo a string in color.
-  (color, str)
-    color_codes = Hash[*%W{
-      black       0;30   red         0;31
-      white       1;37   green       0;32
-      light_gray  0;37   blue        0;34
-    }]
-  --
-  echo -e '\033[<%= color_codes[color.to_s] %>m<%= str %>\033[0m'
-
-Use both in a recipe.
-
-  [recipes/chalkboard.rb]
-  attributes "chalkboard"
-  helpers "chalkboard"
-  
-  attrs['chalkboard']['n'].times do
-    echo_in_color attrs['chalkboard']['color'], attrs['chalkboard']['message']
-  end
-
-Define a package to use the recipe; set non-default attributes as needed.
-
-  [packages/chalkboard.yml]
-  chalkboard:
-    n: 5
-    color: blue
-
-Generate the package from the attributes, helpers, and recipe.
-
-  % linecook build
-
-Check the packages directory to see the resulting script.
-
-  % cat packages/chalkboard/run
-  echo -e '\033[0;34mI will not manually configure my server\033[0m'
-  echo -e '\033[0;34mI will not manually configure my server\033[0m'
-  echo -e '\033[0;34mI will not manually configure my server\033[0m'
-  echo -e '\033[0;34mI will not manually configure my server\033[0m'
-  echo -e '\033[0;34mI will not manually configure my server\033[0m'
-
-Now run the package.
-
-  % linecook run
-
-The package can be run on any server accessible via ssh. See the generated
-'config/ssh' file as well as the documentation for {Running Scripts on
-Servers}[link:files/HowTo/Run%20Scripts.html].
-
-== Composition
-
-Linecook consists of the following.
-
-  = Components =
-  attributes
-  helpers
-  |-----> recipes -> packages -a-> (scripts) -b-> (servers) <-c- server setup
-  files
-  templates
-  
-  = Commands =
-  ex: 'linecook build' on the command line
-  
-  a) env, helper, package, build        # build scripts
-  b) run                                # run scripts
-  c) start, stop, ssh, snapshot, reset  # server setup/control
-
-Everything to the left of 'scripts' has to do with generating scripts;
-everything to the right with running scripts on servers.
-
-== Installation
-
-Linecook is available as a {gem}[http://rubygems.org/gems/linecook].
-
-  % gem install linecook
-
-== Info 
-
-Developer:: {Simon Chiang}[http://github.com/thinkerbot]
-License:: {MIT-Style}[link:files/License_txt.html]

data/lib/linecook/commands.rb

@@ -1,11 +0,0 @@
-require 'linecook/commands/build'
-require 'linecook/commands/env'
-require 'linecook/commands/helper'
-require 'linecook/commands/init'
-require 'linecook/commands/package'
-require 'linecook/commands/snapshot'
-require 'linecook/commands/ssh'
-require 'linecook/commands/start'
-require 'linecook/commands/state'
-require 'linecook/commands/stop'
-require 'linecook/commands/run'

data/lib/linecook/commands/command.rb

@@ -1,58 +0,0 @@
-require 'linecook/commands/command_error'
-require 'configurable'
-
-module Linecook
-  module Commands
-    class Command
-      class << self
-        def registry
-          REGISTRY
-        end
-        
-        def inherited(base)
-          super
-          registry[base.to_s.split('::').last.downcase] = base
-        end
-      end
-      
-      REGISTRY = {}
-      
-      extend Lazydoc::Attributes
-      include Configurable
-      
-      lazy_attr :desc
-      lazy_attr :args, :process
-      lazy_register :process, Lazydoc::Arguments
-      
-      attr_accessor :quiet
-      
-      def initialize(config={})
-        @quiet = true
-        initialize_config(config)
-      end
-      
-      def log(action, msg)
-        $stderr.puts("      %s  %s" % [action, msg])
-      end
-      
-      def sh(cmd)
-        puts "% #{cmd}" unless quiet
-        system(cmd)
-      end
-      
-      def sh!(cmd)
-        unless sh(cmd)
-          raise CommandError.new("", $?.exitstatus)
-        end
-      end
-      
-      def call(argv)
-        process(*argv)
-      end
-      
-      def process(*args)
-        raise NotImplementedError
-      end
-    end
-  end
-end

data/lib/linecook/commands/command_error.rb

@@ -1,12 +0,0 @@
-module Linecook
-  module Commands
-    class CommandError < RuntimeError
-      attr_reader :exitstatus
-      
-      def initialize(msg, exitstatus=1)
-        @exitstatus = exitstatus
-        super(msg)
-      end
-    end
-  end
-end

data/lib/linecook/commands/env.rb

@@ -1,89 +0,0 @@
-require 'linecook/commands/command'
-require 'linecook/cookbook'
-require 'yaml'
-
-module Linecook
-  module Commands
-    
-    # :startdoc::desc prints a package env
-    #
-    # Prints the env for the current project directory.  Specifically the
-    # cookbook file is loaded and used to determine all resources that are
-    # current available.  The full build env for a package can be viewed by
-    # specifying the package file as an option.
-    #
-    # A specific env value can be printed by specifying the key path to it.
-    class Env < Command
-      config :project_dir, '.', :short => :d        # the project directory
-      config :package_file, nil, :short => :p       # the package file
-      
-      # :stopdoc:
-      # Evaluate to replace the to_yaml function on Hash so that it will
-      # serialize keys in order.  Evaluate the OFF code to turn this hack off
-      # (and thereby ease up on the code pollution)
-      #
-      # Modified from: http://snippets.dzone.com/posts/show/5811 Original
-      # func: /usr/lib/ruby/1.8/yaml/rubytypes.rb
-      ORIGINAL_TO_YAML = 'linecook_original_to_yaml'
-      SORTED_HASH_ON_LINE = __LINE__ + 1
-      SORTED_HASH_ON = %{
-      class Hash
-        unless instance_methods.include?('#{ORIGINAL_TO_YAML}')
-          alias #{ORIGINAL_TO_YAML} to_yaml
-          undef_method :to_yaml
-          def to_yaml( opts = {} )
-            YAML::quick_emit( object_id, opts ) do |out|
-              out.map( taguri, to_yaml_style ) do |map|
-                keys.sort_by do |k|
-                  k.to_s
-                end.each do |k|
-                  map.add( k, fetch(k) )
-                end
-              end
-            end
-          end
-        end
-      end}
-      
-      SORTED_HASH_OFF_LINE = __LINE__ + 1
-      SORTED_HASH_OFF = %{
-      class Hash
-        if instance_methods.include?('#{ORIGINAL_TO_YAML}')
-          undef_method :to_yaml
-          alias to_yaml #{ORIGINAL_TO_YAML}
-          undef_method :#{ORIGINAL_TO_YAML}
-        end
-      end}
-      # :startdoc:
-      
-      def select(current, *keys)
-        keys.each do |key|
-          unless current.kind_of?(Hash)
-            return nil
-          end
-          
-          current = current[key]
-        end
-        
-        current
-      end
-      
-      # Serializes the env to the target as YAML.  Ensures hashes are
-      # serialized with their keys sorted by their to_s value.
-      def serialize(env, target="")
-        begin
-          eval SORTED_HASH_ON, TOPLEVEL_BINDING, __FILE__, SORTED_HASH_ON_LINE
-          YAML.dump(env, target)
-        ensure
-          eval SORTED_HASH_OFF, TOPLEVEL_BINDING, __FILE__, SORTED_HASH_OFF_LINE
-        end
-      end
-      
-      def process(*keys)
-        package  = Linecook::Package.init(package_file, project_dir)
-        env = select(package.env, *keys)
-        serialize(env, $stdout)
-      end
-    end
-  end
-end

data/lib/linecook/commands/init.rb

@@ -1,86 +0,0 @@
-require 'linecook/commands/command'
-require 'linecook/utils'
-require 'fileutils'
-require 'erb'
-require 'ostruct'
-
-module Linecook
-  module Commands
-    
-    # :startdoc::desc create a linecook scaffold
-    #
-    # Initializes a linecook scaffold in the specified directory.  This
-    # initializer is currently very basic; it is not a true generator.
-    # 
-    class Init < Command
-      config :force, false, :short => :f, &c.flag   # force creation
-      
-      def source_dir
-        @source_dir ||= File.expand_path('../../../../templates', __FILE__)
-      end
-      
-      def process(project_dir)
-        project_dir = File.expand_path(project_dir)
-        
-        prepare project_dir
-        template project_dir
-      end
-      
-      def prepare(project_dir)
-        if File.exists?(project_dir)
-          unless force
-            raise CommandError.new("already exists: #{project_dir}")
-          end
-
-          current_dir = File.expand_path('.')
-          unless project_dir.index(current_dir) == 0 && project_dir.length > current_dir.length
-            raise CommandError.new("cannot force creation of current or parent directory (safety issue)")
-          end
-
-          FileUtils.rm_rf(project_dir)
-        end
-      end
-      
-      def template(project_dir, project_name=nil)
-        project_name ||= File.basename(project_dir)
-        context = OpenStruct.new(
-          :project_name => project_name,
-          :const_name => Utils.camelize(project_name)
-        ).instance_eval('binding')
-        
-        #
-        # Copy template files into place
-        #
-        
-        Dir.glob("#{source_dir}/**/*").each do |source|
-          if File.directory?(source)
-            next
-          end
-
-          path = source[(source_dir.length + 1)..-1]
-          path = path.sub('project_name', project_name).sub(/^_/, '.')
-          target = File.join(project_dir, path)
-
-          log :create, path
-
-          target_dir = File.dirname(target)
-          unless File.exists?(target_dir)
-            FileUtils.mkdir_p(target_dir)
-          end
-
-          File.open(target, 'w') do |io|
-            erb = ERB.new(File.read(source), nil, '<>')
-            erb.filename = source
-            io << erb.result(context)
-          end
-        end
-
-        # Link up project dir into test
-        target = File.join(project_dir, 'test', "#{project_name}_test", "test_#{project_name}")
-        FileUtils.mkdir_p File.dirname(target)
-        FileUtils.ln_s project_dir, target
-      end
-    end
-  end
-end
-