sow 0.4.0

data/HISTORY

@@ -0,0 +1,14 @@
+= RELEASE HISTORY
+
+== 1.0.0 // 2009-08-30
+
+Initial release of brand spanking new system.
+
+Changes:
+
+* 3 Major Enhancements
+
+    * Use spiffy new interface design.
+    * Promotes the use of "micro" plugins.
+    * Added new built-in plugins.
+

data/MANIFEST

@@ -0,0 +1,138 @@
+#!mast bin lib meta plug test [A-Z]*
+bin
+bin/sow
+lib
+lib/sow
+lib/sow/command.rb
+lib/sow/context.rb
+lib/sow/core_ext.rb
+lib/sow/generators
+lib/sow/generators/base.rb
+lib/sow/generators/create.rb
+lib/sow/generators/delete.rb
+lib/sow/generators/update.rb
+lib/sow/logger.rb
+lib/sow/manager.rb
+lib/sow/metadata.rb
+lib/sow/plugin.rb
+lib/sow/script.rb
+lib/sow/session.rb
+lib/sow.rb
+meta
+meta/authors
+meta/contact
+meta/description
+meta/homepage
+meta/loadpath
+meta/package
+meta/project
+meta/repository
+meta/requires
+meta/ruby
+meta/version
+plug
+plug/sow
+plug/sow/seeds
+plug/sow/seeds/bin
+plug/sow/seeds/bin/.meta
+plug/sow/seeds/bin/.meta/created
+plug/sow/seeds/bin/.meta/description
+plug/sow/seeds/bin/.meta/license
+plug/sow/seeds/bin/.meta/package
+plug/sow/seeds/bin/.meta/requires
+plug/sow/seeds/bin/.meta/title
+plug/sow/seeds/bin/.meta/version
+plug/sow/seeds/bin/SCRIPT.rb
+plug/sow/seeds/bin/template
+plug/sow/seeds/bin/template/bin
+plug/sow/seeds/bin/template/bin/command.rb
+plug/sow/seeds/hoe
+plug/sow/seeds/hoe/SCRIPT.rb
+plug/sow/seeds/hoe/template
+plug/sow/seeds/hoe/template/History.txt
+plug/sow/seeds/hoe/template/Manifest.txt
+plug/sow/seeds/hoe/template/README.txt
+plug/sow/seeds/hoe/template/Rakefile
+plug/sow/seeds/hoe/template/bin
+plug/sow/seeds/hoe/template/bin/__name__
+plug/sow/seeds/hoe/template/lib
+plug/sow/seeds/hoe/template/lib/__name__.rb
+plug/sow/seeds/hoe/template/test
+plug/sow/seeds/hoe/template/test/test___name__.rb
+plug/sow/seeds/license
+plug/sow/seeds/license/SCRIPT.rb
+plug/sow/seeds/license/template
+plug/sow/seeds/license/template/META
+plug/sow/seeds/license/template/META/license
+plug/sow/seeds/license/template/gpl
+plug/sow/seeds/license/template/gpl/LICENSE
+plug/sow/seeds/license/template/lgpl
+plug/sow/seeds/license/template/lgpl/LICENSE
+plug/sow/seeds/license/template/mit
+plug/sow/seeds/license/template/mit/LICENSE
+plug/sow/seeds/ruby
+plug/sow/seeds/ruby/COPY.yml
+plug/sow/seeds/ruby/DATA.yml
+plug/sow/seeds/ruby/USAGE.txt
+plug/sow/seeds/ruby/script.sow.rb
+plug/sow/seeds/ruby/template
+plug/sow/seeds/ruby/template/COPYING
+plug/sow/seeds/ruby/template/History.rdoc
+plug/sow/seeds/ruby/template/README.rdoc
+plug/sow/seeds/ruby/template/README.rdoc.till
+plug/sow/seeds/ruby/template/Rakefile
+plug/sow/seeds/ruby/template/bin
+plug/sow/seeds/ruby/template/bin/__package__
+plug/sow/seeds/ruby/template/lib
+plug/sow/seeds/ruby/template/lib/__package__.rb
+plug/sow/seeds/ruby/template/meta
+plug/sow/seeds/ruby/template/meta/created
+plug/sow/seeds/ruby/template/meta/description
+plug/sow/seeds/ruby/template/meta/license
+plug/sow/seeds/ruby/template/meta/package
+plug/sow/seeds/ruby/template/meta/requires
+plug/sow/seeds/ruby/template/meta/title
+plug/sow/seeds/ruby/template/meta/version
+plug/sow/seeds/ruby/template/setup.rb
+plug/sow/seeds/ruby/template/test
+plug/sow/seeds/ruby/template/test/template.rb
+plug/sow/seeds/testunit
+plug/sow/seeds/testunit/COPY.yml
+plug/sow/seeds/testunit/DATA.yml
+plug/sow/seeds/testunit/USAGE.txt
+plug/sow/seeds/testunit/_SCRIPT.rb
+plug/sow/seeds/testunit/template
+plug/sow/seeds/testunit/template/form
+plug/sow/seeds/testunit/template/form/testunit
+plug/sow/seeds/testunit/template/test
+plug/sow/seeds/testunit/template/test/test_template.rb
+plug/sow/seeds/website
+plug/sow/seeds/website/template
+plug/sow/seeds/website/template/assets
+plug/sow/seeds/website/template/assets/images
+plug/sow/seeds/website/template/assets/scripts
+plug/sow/seeds/website/template/assets/styles
+plug/sow/seeds/website/template/assets/styles/color.css
+plug/sow/seeds/website/template/assets/styles/font.css
+plug/sow/seeds/website/template/assets/styles/index.css
+plug/sow/seeds/website/template/assets/styles/reset.css
+plug/sow/seeds/website/template/assets/styles/struct.css
+plug/sow/seeds/website/template/index.html
+test
+test/features
+test/features/scaffold.feature
+test/features/step_definitions
+test/features/step_definitions/cli_steps.rb
+test/features/step_definitions/fixture_steps.rb
+test/features/support
+test/features/support/env.rb
+test/unit
+test/unit/fixtures
+test/unit/fixtures/README
+test/unit/helper.rb
+test/unit/test_metadata.rb
+test/unit/test_scaffold.rb
+NOTES
+README
+HISTORY
+COPYING

data/NOTES

@@ -0,0 +1,86 @@
+= NOTES ON SOW
+
+==  Commandline Interface of Plugins
+
+=== Option 1
+
+The traditional approach is to allow a plugin to specify any commandline
+arguments and/or options it may want to generate scaffolding.
+For example, we might see something like:
+
+  sow ruby myapp --no-bin --man
+
+Which would scaffold a Ruby project named 'myapp' with a manpage
+entry but no defualt executable. Allowing this flexibility in 
+designatin plugin options, we can make our plugins quite feature
+rich.
+
+We wouldn't want to get too crazy though, as in many cases it would
+just as well to have an additional plugin. For example, we will
+want to have a cucumber plugin so we can create features, thus
+adding --cucumber option to the ruby plugin is purely a convenience.
+One could just as well do:
+
+  $ sow ruby myapp
+  $ sow cucumber myapp
+
+Instead of 
+
+  $ sow ruby --cucumber myapp
+
+(Note I am ignoring the issue of directory creation for the moment.)
+
+This has the benifit of saving the ruby plugin from having to
+support an almost endless steram of possbile options (rcov, flog,
+rake, testunit, rspec, bacon, setup.rb, and so on.), and of which
+one could reasonably argue deserves presence.
+
+=== Option 2
+
+I've noticed that every *particular* scaffolding I can conceive can
+generally be accomplished with a single argument. That being the case
+each plugin could simply be invoked as a commandline switch.
+
+  sow --ruby[=<name>] [pathname]
+
+To copy ruby scaffolding into subdirectory +name+.
+
+  sow --ruby <pathname>
+
+In which case the name of the project and the subdirectory would be
+the same.
+
+This notation allows for multiple plugins to be invoked in the same 
+command. For instance, lets use our cucumber plugin. We could build
+a ruby project with a cucumber test in one go.
+
+  sow --ruby --cucumber <pathname>
+
+The cucumber plugin defaults the name of the feature to the pathname,
+in the same fashion as the ruby project name. To make it different,
+
+  sow --ruby --cucumber=myfeature <pathname>
+
+We could even invoke the cucumber plugin multiple times in one line.
+
+So this brings about the notion of having many small plugins, rather
+then fewer more complex plugins like Option 1 encourages. For example,
+we might have a +bin+ plugin.
+
+  sow --bin=foo
+
+In some respects that is rather nice, in that the units are small and
+tight. The dwonside however, is that we loose a great deal of flexibility
+in building "feature rich" scaffolds.
+
+So the question we must to ask is whether these numerous small scaffolds
+can cover the same range of usecases that larger more complex scaffolds
+can? Can we think of a case that would simply be too severly hampered by
+limited commandline options? Or, on the other hand, is there a way to
+offer some additional flexibity in options when it required?
+
+I like this later appraoch and I am going to rewrite Sow to use it, since
+it certainly will owrk well for most cases. Later I will return to
+question of offering additional option control and see if we can't add
+that capability into the system in some fashion.
+

data/README

@@ -0,0 +1,157 @@
+= Sow 
+
+* http://proutils.github.com/sow
+* http://github.com/proutils/sow
+
+
+== TENDING TO PROJECT ECOLOGY
+
+Sow is a project scaffolding system. The system is pluggable
+and utilizes eRuby templating to make it easy to extend. Sow
+can be used for any kind of file scaffolding, but it is
+designed largely with Ruby project needs in mind.
+
+Sow's plugins are called "seeds". Sowing requires seeds.
+Sow comes with an extra large box of seeds to really get
+those projects blooming!
+
+
+== SYNOPSIS
+
+General usage follws the pattern:
+
+  sow [options] --<plugin>[=arg] --<plugin>.<var>[=arg] ... [destination]
+
+For instance to scaffold a new, basic ruby project with the
+name 'myapp' in the directory 'myapp':
+
+  $ sow --ruby myapp/
+
+By default, Sow's +ruby+ plugin will use the destination path
+as the project name. If we wished to name the project something
+other than the destination path, we can supply that as an argument.
+
+  $ sow --ruby=foo myapp/
+
+Alternately we could make the the directory ourselves and, and
+scaffold it from within.
+
+  $ mkdir myapp
+  $ cd myapp
+  $ sow --ruby=foo
+
+Once you have a project, Sow can be used to generate components
+as well, kind of like script/generate in Rails. For instance,
+to generate a test/unit starter file.
+
+  $ sow --testunit.name=mytest
+
+For more details on how to use Sow, what plugins are available and how
+to build your own cusotm plugins, please see the documentation
+provided on Sow's website.
+
+
+== CURRENT STATUS
+
+Sow is still a little wet behind the ears, and you might come across
+the ocassional odd behavior. Please report on the Protutils
+mailing list (http://googlegroups.com/group/proutils). Usually the
+issue will be some over-looked in a given plugin --since plugins
+have a lot of flexability in their design. It will take some time
+and some widespread usage to work out all the corner cases and
+to bring each plugin to a fine polish.
+
+
+== HOE USERS
+
+*IMPORTANT NOTICE FOR HOE USERS!*
+
+Hoe users will discover that the +sow+ command that comes with Hoe will
+be overwritten by Sow. This may seem a not-so-nice thing to do, but truth
+be told Sow is a slightly older project than Hoe (albeit orginally it was
+a very different program). Since there is no command called +hoe+, I 
+recommend renaming Hoe's +sow+ command.
+
+  sudo mv /usr/bin/sow /usr/bin/hoe
+
+As an alternative, Sow ships with a Hoe plugin, so there is nothing lost even
+if Hoe's +sow+ command is overwritten, simply use:
+
+  $ sow --hoe <name>
+
+Note, that Hoe scaffolding does not support the in-project templating
+system. To get that you need to add a .meta/ directory to your project.
+
+
+== INSTALLATION
+
+=== RubyGems Install
+
+Install using RubyGems as you would expect:
+
+  $ gem install sow
+
+This will install Sow, it's Facets dependency if not alreay installed,
+and a number of built-in plugins. Keep in mind that some plugins
+come from the packages with which they are associated. For example,
+the Reap plugin is distributed with the Reap package.
+
+=== Old School Site Install
+
+Old-fashion site installs require Ruby Setup (see http://proutils.rubyforge.org/setup).
+If you don't have Ruby Setup you can install it via Rubygems:
+
+  $ gem install setup
+
+With Setup in place, download the Sow tarball (.tar.gz) and unpack it,
+then install by invoking setup.rb.
+
+  $ tar -xvvzf sow-1.0.0.tar.gz
+  $ cd sow-1.0.0 
+  $ sudo setup.rb all
+
+If you use Hoe, please see the the important message below before
+installing.
+
+
+== DEVELOPMENT
+
+Sow is being developed on <a href="http://hithub.com">GitHub</a>, as part of the
+ProUtils set of project development tools. You can browse the Sow project here:
+
+  http://github.com/proutils/sow/tree/master
+
+Sow's public repository can be pulled via:
+
+  git://github.com/proutils/sow.git 
+
+Please feel free to fork the project and submit pull requests. Discussion of
+Sow occurs on the TigerOps Community Mailinglist.
+
+  http://groups.google.com/group/tigerops-community?hl=en
+
+Happy hacking!
+
+
+== COPYRIGHT & LICENSE
+
+Copyright (c) 2007, 2009 Thomas Sawyer
+
+Unless other premmited by the author, this software is distributed under
+the terms of the GPL version 3 license.
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see &lt;http://www.gnu.org/licenses/&gt;.
+
+Please see COPYING file for details.
+

data/bin/sow

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'sow/command'
+Sow::Command.execute
+

data/lib/sow.rb

@@ -0,0 +1,12 @@
+# = Sow
+#
+# Sow namespace in which all Sow comppnents are defined.
+#
+# Sow does use a number of core extensions, but these are 
+# all managed by Ruby Facets to help promote standardized
+# in the area and reduce potential name conflicts.
+#
+module Sow
+  VERSION = '1.0.0'  #:till: VERSION = '<%= version %>'
+end
+

data/lib/sow/command.rb

@@ -0,0 +1,201 @@
+require 'sow/manager'
+require 'facets/string/tabto'
+
+module Sow
+
+  # Sow Commandline Utility.
+  #
+  # TODO: Provide help messages for individual plugins.
+  #
+  # TODO: Move the core logic of execture to either Manger or another class.
+  #
+  class Command
+
+    # Initialize and execute command.
+    def self.execute
+      new.execute
+    end
+
+    # Commandline arguments.
+    attr :argv
+
+    # New Command.
+    def initialize(argv=ARGV)
+      @argv = argv.dup
+    end
+
+    # Plugin manger.
+    def manager
+      @manager ||= Manager.new
+    end
+
+    # Run command.
+    #
+    # TODO: Should we look up the directory tree for a .config/sow.yaml
+    # file to determine if this has been previously sowed and maybe
+    # change directory to that location?
+    #
+    def execute
+      arguments, cooptions = *parse_argv(argv)
+
+      # Extract standard commandline options.
+      options, cooptions = standard_options(cooptions)
+
+      if options.help?
+        puts help
+        exit
+      end
+
+      # Ensure only one command type selected.
+      if [options.create?, options.delete?, options.update?].compact.size > 1
+        raise "Conflicting commands. Choose one: create, delete or update."
+      end
+
+      # Path to destination is the last argument, if given. Otherwise it is
+      # the current working path.
+      pathname = (arguments.pop || '.').chomp('/')
+
+      options.destination = pathname
+
+      # All options should appear after plugin/scaffold name.
+      # however, it is able to look past purely flag switches.
+      #name = arguments.find{ |e| e !~ /^\-/ }
+
+      session = Session.new(arguments, options)
+
+      #command = session.mode
+
+      # collect plugin options
+      options = Hash.new{ |h,k| h[k] = {} }
+      cooptions.each do |(name, value)|
+        if name.index('.')
+          name, var = *name.split('.')
+          options[name][var] = value
+        else
+          options[name]['argument'] = value
+        end
+      end
+
+      # collect plugins
+      plugins = options.map do |(name, opts)|
+        # Get plugin by name
+        plugin = manager.plugin(session, name, opts)
+        # Setup the plugin
+        plugin.setup #(command, arguments, options)
+        #
+        plugin
+      end
+
+      # Abort if no scaffold type given.
+      if plugins.empty?
+        $stderr.puts "No scaffold type given."
+        exit
+      end
+
+      # Get copylists from each plugin and combine them into
+      # a single compylist.
+      copylist = plugins.inject([]) do |array, plugin|
+        array.concat(plugin.copylist)
+      end
+
+      begin
+        case session.mode
+        when 'create'
+          generator = Generators::Create.new(session, copylist)
+          generator.generate
+        when 'update'
+          generator = Generators::Update.new(session, copylist)
+          generator.generate
+        when 'delete'
+          generator = Generators::Delete.new(session, copylist)
+          generator.generate
+        else
+          raise "[IMPOSSIBLE] Unknown command type."
+        end
+      rescue => err
+        if options['debug']
+          raise err
+        else
+          puts err
+          puts "try --help or --debug"
+          exit
+        end
+      end
+    end
+
+    # Very simply ARGV parser. In the future we may make
+    # this a bit smarter. We do it manually to preserve the
+    # order of plugin options.
+    def parse_argv(argv)
+      args = []
+      opts = []
+      argv.each_with_index do |arg, idx|
+        case arg
+        when /^-/
+          opts << arg
+        else
+          args << arg
+        end
+      end
+      opts = opts.map{ |o| o.sub(/^\-+/, '').split('=') }
+      return args, opts
+    end
+
+    # Return command type based on option.
+    #def command(options)
+    #  return 'create' if options['create'] #|| options[:c]
+    #  return 'update' if options['update'] #|| options[:u]
+    #  return 'delete' if options['delete'] #|| options[:d]
+    #  nil
+    #end
+
+    STANDARD_OPTIONS = {
+      'create' => 'create', 'c' => 'create',
+      'update' => 'update', 'u' => 'update',
+      'delete' => 'delete', 'd' => 'delete',
+      'quiet'  => 'quiet' , 'q' => 'quiet' ,
+      'prompt' => 'prompt', 'p' => 'prompt',
+      'skip'   => 'skip'  , 's' => 'skip'  ,
+      'force'  => 'force' , 'f' => 'force' ,
+      'trial'  => 'trial' , 't' => 'trial' ,
+      'help'   => 'help'  , 'h' => 'help'  ,
+      'debug'  => 'debug' ,
+    }
+
+    # Returns a hash of standard options and an assoc array
+    # of plugin options.
+    def standard_options(opts)
+      h, o = OpenStruct.new, []
+      opts.each do |(k,v)|
+        if opt = STANDARD_OPTIONS[k]
+          h[opt+'?'] = true
+        else
+          o << [k,v]
+        end
+      end
+      return h, o
+    end
+
+    # General help message.
+    def help
+      <<-END.tabto(0)
+      Usage: sow [options] --<plugin>[=<value>] ... [<path>]
+
+      Options:
+        -c --create         Create scaffolding
+        -u --update         Update scaffolding
+        -d --delete         Delete scaffolding
+        -p --prompt         Prompt on overwrites
+        -s --skip           Skip overwrites
+        -f --force          Force restricted operations
+        -q --quiet          Supress output messages
+        -t --trial          Trial run (won't write to disk)
+           --debug          Provide debuging information
+        -h --help           Show this message
+      END
+    end
+
+  end#class Command
+
+end#module Sow
+