linecook 1.0.0 → 1.1.0

data/History

@@ -1,3 +1,12 @@
+== 1.1.0 2011/05/02
+
+* updated scaffold generated by 'linecook init' to be current and simpler
+* fixed template_path to accept full path (with .erb extname) as source and to
+  set the default target as source minus .erb extension, if present
+* updated 'linecook build' to allow setting a load path
+* added LINECOOK_USE_BUNDLER to turn off Bundler.setup in linecook executable
+* minor documentation fixes
+
 == 1.0.0 2011/04/26
 
 First major release. Significant work on documentation and various bug fixes.

data/HowTo/Generate Scripts

@@ -12,6 +12,10 @@ the script is reproduced.
 
 The command to rebuild a package is:
 
+  linecook build -Ilib
+
+Or if you have a proper Gemfile in your project dir:
+
   linecook build
 
 This tutorial is designed such that if you make the files as specified, you
@@ -158,7 +162,7 @@ attribute and package files from above):
   Sets a global git config.
   (key, value)
   --
-  git config --global <%= key %> <%= value %>
+  git config --global <%= key %> "<%= value %>"
   
   
   [recipes/demo.rb]
@@ -168,8 +172,8 @@ attribute and package files from above):
   #########################################################################
   install attrs['ruby']['package']
   install attrs['git']['package']
-  attrs['git']['config'].each_pair do |key, value|
-    set_git_config key, value
+  ['user.name', 'user.email'].each do |key|
+    set_git_config key, attrs['git']['config'][key]
   end
 
 When you define a helper, you're literally defining a method in a module that
@@ -237,7 +241,7 @@ is local by default.
   target.puts <<-SCRIPT
   sudo apt-get -y install ruby1.8
   sudo apt-get -y install git
-  cp "#{ template_path "gitconfig" }" ~/.gitconfig
+  cp "#{ template_path "gitconfig.erb" }" ~/.gitconfig
   SCRIPT
 
 == {Linebook}[http://rubygems.org/gems/linebook/]
@@ -245,10 +249,11 @@ is local by default.
 The techniques presented here are sufficient to work with many scripts in many
 situations but they are quite bare. Eventually, or perhaps immediately, you
 will want a suite of standard helpers. The canonical helper library is
-Linebook (Linecook's version of a Cookbook).
+{Linebook}[http://rubygems.org/gems/linebook/].
 
-See the {Linebook documentation}[http://rubygems.org/gems/linebook/] to learn
-helpers for flow control, file system tests, commands, chaining, redirection,
+See the {Linebook
+documentation}[http://rubydoc.info/gems/linebook/file/README] to learn helpers
+for flow control, file system tests, commands, chaining, redirection,
 heredocs, and other convenience methods.
 
   [recipes/demo.rb]

data/bin/linecook

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-if File.exists?('Gemfile')
+if File.exists?('Gemfile') && ENV['LINECOOK_USE_BUNDLER'] != 'false'
   require 'rubygems'
   require 'bundler'
   Bundler.setup

data/lib/linecook/commands/build.rb

@@ -10,6 +10,7 @@ module Linecook
     #
     class Build < Command
       config :project_dir, '.', :short => :d              # the project directory
+      config :load_path, [], :short => :I, &c.list        # set load paths
       config :force, false, :short => :f, &c.flag         # force creation
       config :quiet, false, &c.flag                       # silence output
       
@@ -43,6 +44,10 @@ module Linecook
       end
       
       def process(*package_names)
+        load_path.each do |path|
+          $:.unshift(path)
+        end
+        
         helper = Helper.new(
           :project_dir => project_dir, 
           :force => force,

data/lib/linecook/cookbook.rb

@@ -43,7 +43,7 @@ module Linecook
       'attributes' => ['attributes', '.rb'],
       'files'      => ['files'],
       'recipes'    => ['recipes', '.rb'],
-      'templates'  => ['templates', '.erb']
+      'templates'  => ['templates']
     }
     
     attr_reader :project_dir

data/lib/linecook/recipe.rb

@@ -146,7 +146,7 @@ module Linecook
     
     # Looks up, builds, and registers the specified template and returns the
     # target_path to the resulting file.
-    def template_path(template_name, target_name=template_name, mode=0600, locals={'attrs' => attrs})
+    def template_path(template_name, target_name=template_name.chomp('.erb'), mode=0600, locals={'attrs' => attrs})
       _package_.build_template(target_name, template_name, mode, locals)
       target_path target_name
     end

data/lib/linecook/test.rb

@@ -207,14 +207,15 @@ module Linecook
     def linecook_cmd(cmd, options={}, *args)
       opts = []
       options.each_pair do |key, value|
-        key = key.gsub('_', '-')
+        key = key.to_s.gsub('_', '-')
+        key = key.length == 1 ? "-#{key}" : "--#{key}"
         
         case value
         when true
-          opts << "--#{key}"
+          opts << key
         when nil, false
         else 
-          opts << "--#{key} '#{value}'"
+          opts << "#{key} '#{value}'"
         end
       end
       

data/lib/linecook/version.rb

@@ -1,6 +1,6 @@
 module Linecook
   MAJOR = 1
-  MINOR = 0
+  MINOR = 1
   TINY  = 0
   
   VERSION = "#{MAJOR}.#{MINOR}.#{TINY}"

data/templates/Gemfile

@@ -1,2 +1,3 @@
+# Linecook uses this Gemfile to setup dependencies, if present.
 source "http://rubygems.org"
 gemspec

data/templates/Rakefile

@@ -75,7 +75,7 @@ end
 #
 
 package = ENV['PACKAGE']
-force = (ENV['FORCE'] == 'true')
+force   = (ENV['FORCE'] == 'true')
 
 desc "build helpers and packages"
 task :build => :bundle do

data/templates/_gitignore

@@ -2,4 +2,3 @@
 .bundle
 *.gem
 /rdoc
-vm

data/templates/attributes/project_name.rb

@@ -1,4 +1,3 @@
-# Define default recipe attributes here.
-# (note string keys are usually better than symbols)
-attrs['<%= project_name %>']['year'] = Time.now.year
-attrs['<%= project_name %>']['resolutions'] = []
+# Define default attributes here.  The attrs object is a self-nesting Hash
+# (note string keys are usually better than symbols).
+attrs['<%= project_name %>']['message'] = 'Hello World'

data/templates/config/ssh

@@ -1,9 +1,8 @@
-# Declare hosts for packages - the vm name can be specified in a special
-# comment following the Host declaration (defaults to the host).
-Host abox   # [abox]
+# Declare a Host for each package.
+Host abox
 Port 2220
 
-# Define global configs here.  By default tests run vs this default host.
+# Define defaults here.
 Host *
 HostName localhost
 User linecook

data/templates/cookbook

@@ -1,9 +1,10 @@
 # Configure the cookbook here.
-# Adding this file to a gem marks it as a cookbook gem
-# (note that in a gem the contents of this file are ignored)
 
 # Define directories searched for attributes/recipes/etc.
 # paths: ['.']
 
 # Name the gems added to path - defaults to all marked gems.
 # gems: []
+
+# Adding this file to a gem marks it as a cookbook gem
+# (within a gem the contents of this file are ignored)

data/templates/files/example.txt

@@ -0,0 +1 @@
+Hello World (from a file)

data/templates/helpers/project_name/echo.erb

@@ -0,0 +1,4 @@
+Echo a string.
+(str)
+--
+echo "<%= '<' %>%= str %<%= '>' %> (from a helper)"

data/templates/packages/abox.yml

@@ -1,4 +1,2 @@
-# Attributes set here override those in the attributes directory.
-<%= project_name %>:
-  resolutions:
-  - I will automate configuration of my servers.
+# Attributes set in a package file override those in an attributes file.
+{}

data/templates/project_name.gemspec

@@ -1,12 +1,12 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name        = "<%= project_name %>"
-  s.version     = "0.0.1"
+  s.name        = '<%= project_name %>'
+  s.version     = '0.0.1'
   s.platform    = Gem::Platform::RUBY
-  s.authors     = "TODO: Write your name"
-  s.email       = "TODO: Write your email address"
-  s.homepage    = ""
+  s.authors     = 'TODO: Write your name'
+  s.email       = 'TODO: Write your email address'
+  s.homepage    = ''
   s.summary     = %q{TODO: Write a gem summary}
   s.description = %q{TODO: Write a gem description}
   s.rubyforge_project = ''
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
   s.rdoc_options.concat %W{--main README -S -N --title <%= project_name.capitalize %>}
   
   # add dependencies
-  s.add_dependency('linecook', '~> <%= Linecook::VERSION %>')
+  s.add_dependency('linecook', '~> <%= Linecook::MAJOR %>.<%= Linecook::MINOR %>')
   
   # list extra rdoc files here.
   s.extra_rdoc_files = %W{

data/templates/recipes/abox.rb

@@ -1,22 +1,16 @@
 #############################################################################
-helpers '<%= project_name %>'
 attributes '<%= project_name %>'
+helpers '<%= project_name %>'
 #############################################################################
 
 # Write to the script using write/writeln
 writeln '# An example script.'
 
-# Attributes are available, as are helpers.
-file = "~/#{attrs['<%= project_name %>']['year']}/resolutions.txt"
-content = attrs['<%= project_name %>']['resolutions'].join("\n")
-create_file file, content
-
-# Use file_path to add a file to the package and return a path to it.
-source = file_path('help.txt')
-target = "~/#{attrs['<%= project_name %>']['year']}/help.txt"
-install_file source, target
+# Attributes are available via attrs.
+# Helpers are available as methods.
+echo attrs['<%= project_name %>']['message']
 
-# Same for templates.  Attributes are available in the template.
-source = template_path('todo.txt')
-target = "~/#{attrs['<%= project_name %>']['year']}/todo.txt"
-install_file source, target
+# Use file_path and template_path to add files to the package; the return
+# value can be treated as a path to the file.  For example:
+writeln "cat #{file_path('example.txt', 'example_file')}"
+writeln "cat #{template_path('example.erb', 'example_template')}" 

data/templates/templates/example.erb

@@ -0,0 +1 @@
+<%= '<' %>%= attrs['<%= project_name %>']['message'] %<%= '>' %> (from a template)

data/templates/test/project_name_test.rb

@@ -4,7 +4,7 @@ class <%= const_name %>Test < Test::Unit::TestCase
   include Linecook::Test
   
   #
-  # package test
+  # project test (build and run project as written)
   #
   
   no_cleanup
@@ -14,6 +14,11 @@ class <%= const_name %>Test < Test::Unit::TestCase
     assert_equal 0, $?.exitstatus, cmd
     
     result, cmd = run_project
+    assert_output_equal %q{
+      Hello World (from a helper)
+      Hello World (from a file)
+      Hello World (from a template)
+    }, result, cmd
     assert_equal 0, $?.exitstatus, cmd
   end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: linecook
 version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Simon Chiang
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-26 00:00:00 -06:00
+date: 2011-05-02 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 49
         segments: 
         - 0
         - 8
@@ -35,9 +38,11 @@ dependencies:
   name: configurable
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         - 7
@@ -49,9 +54,11 @@ dependencies:
   name: bundler
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 15
         segments: 
         - 1
         - 0
@@ -110,18 +117,15 @@ files:
 - templates/attributes/project_name.rb
 - templates/config/ssh
 - templates/cookbook
-- templates/files/help.txt
-- templates/helpers/project_name/assert_content_equal.erb
-- templates/helpers/project_name/create_dir.erb
-- templates/helpers/project_name/create_file.erb
-- templates/helpers/project_name/install_file.erb
+- templates/files/example.txt
+- templates/helpers/project_name/echo.erb
 - templates/packages/abox.yml
 - templates/project_name.gemspec
 - templates/recipes/abox.rb
-- templates/recipes/abox_test.rb
-- templates/templates/todo.txt.erb
+- templates/templates/example.erb
 - templates/test/project_name_test.rb
 - templates/test/test_helper.rb
+- bin/linecook
 - History
 - README
 - License.txt
@@ -144,23 +148,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A shell script generator.

data/templates/files/help.txt

@@ -1 +0,0 @@
-* https://github.com/pinnacol/linecook

data/templates/helpers/project_name/assert_content_equal.erb

@@ -1,15 +0,0 @@
-Asserts the content of the file is as expected. Prints a diff and exits 1 if
-the content is not as expected.
-(expected, file)
---
-expected='<%= '<' %>%= expected.rstrip %<%= '>' %>'
-actual=$(cat <%= '<' %>%= file %<%= '>' %>)
-
-echo "Check file: <%= '<' %>%= file %<%= '>' %>"
-if [ "$actual" != "$expected" ]
-then
-  echo "[$0] unequal output: <%= '<' %>%= file %<%= '>' %>" >&2
-  diff <(cat <<< "$expected") <(cat <<< "$actual") >&2
-  exit 1
-fi
-

data/templates/helpers/project_name/create_dir.erb

@@ -1,9 +0,0 @@
-Creates a directory and parents as needed.
-(dir)
---
-if ! [ -d <%= '<' %>%= dir %<%= '>' %> ]
-then
-  echo "Create dir: <%= '<' %>%= dir %<%= '>' %>"
-  mkdir -p <%= '<' %>%= dir %<%= '>' %>
-fi
-

data/templates/helpers/project_name/create_file.erb

@@ -1,8 +0,0 @@
-Creates a file with the specified content.
-(file, content)
---
-<%= '<' %>% create_dir File.dirname(file) %<%= '>' %>
-
-echo "Create file: <%= '<' %>%= file %<%= '>' %>"
-echo -n '<%= '<' %>%= content %<%= '>' %>' > <%= '<' %>%= file %<%= '>' %>
-

data/templates/helpers/project_name/install_file.erb

@@ -1,8 +0,0 @@
-Installs a file.
-(source, target)
---
-<%= '<' %>% create_dir File.dirname(target) %<%= '>' %>
-
-echo "Install file: <%= '<' %>%= target %<%= '>' %>"
-cp <%= '<' %>%= source %<%= '>' %> <%= '<' %>%= target %<%= '>' %>
-

data/templates/recipes/abox_test.rb

@@ -1,14 +0,0 @@
-#############################################################################
-helpers '<%= project_name %>'
-attributes '<%= project_name %>'
-#############################################################################
-
-# Validations can be using the same techniques as in run.
-assert_content_equal %{
-I will automate configuration of my servers.
-}.lstrip, '~/2011/resolutions.txt'
-
-assert_content_equal %{
-# TODO
-* automate configuration of my servers
-}.lstrip, '~/2011/todo.txt'

data/templates/templates/todo.txt.erb

@@ -1,3 +0,0 @@
-# TODO<%= '<' %>% attrs['<%= project_name %>']['resolutions'].each do |resolution| %<%= '>' %>
-* <%= '<' %>%= resolution.gsub('I will', '').chomp('.').strip %<%= '>' %>
-<%= '<' %>% end %<%= '>' %>