sow 0.4.0

data/lib/sow/script.rb

@@ -0,0 +1,186 @@
+module Sow
+
+  # A Sow Script provides a simple DSL for specifying
+  # arguments, a copylist and the various specificities
+  # needed to define a scaffold generator proccess.
+  #
+  # Note: This is the old way of building a plugin.
+
+  class Script
+
+    # Script registery/
+
+    def self.registry
+      @registry ||= {}
+    end
+
+    # If inherited, register the script by it's class basename downcased.
+
+    def self.inherited(base)
+      registry[base.basename.downcase] = base
+    end
+
+    # Setup procedure, used to setup metadata.
+
+    def self.setup(&block)
+      define_method(:setup,&block)
+    end
+
+    # Manifest procedure, used to invoke #copy.
+
+    def self.manifest(&block)
+      define_method(:manifest,&block)
+    end
+
+    # Specify a valid option.
+
+    def self.option(name)
+      attr_accessor(name)
+    end
+
+    # Give the main argument a name.
+
+    def self.argument(name)
+      define_method(name){ argument }
+    end
+
+    # Override and setup metadata and validate.
+    # If something does jive, then use #abort to
+    # terminate execution.
+    def setup
+    end
+
+    # Override and place copy statment in this method.
+    #
+    def manifest
+      copy '**/*', '.'
+    end
+
+    # Instance of Session.
+
+    attr :session
+
+    #
+
+    attr :options
+
+    # Copylist contains the a list of transfer operations as 
+    # compiled from the plugin.
+
+    attr :copylist
+
+    #
+    def initialize(session, options)
+      @session = session
+      @options = options
+
+      @copylist  = []
+    end
+
+    # Main argument.
+
+    def argument
+      options.argument
+    end
+
+    # Access to Metadata. When the script is initially executed,
+    # ie. toplevel and argument blocks, this is an OpenStruct.
+    # Use it to assign values to the metadata, which is used to
+    # render the file templates. When the scaffold block is
+    # finally executed, this is reassigned to the destinations
+    # metadata, so that it can be used in the copy calls, if
+    # needed.
+
+    def metadata
+      session.metadata
+    end
+
+    # Destiation pathname. This is used by some plugins,
+    # particularly full-project scaffolds, as a default
+    # package name. It is the basename of the output directory.
+
+    def destination
+      session.destination
+    end
+
+    #def values
+    #  @values
+    #end
+
+    #def location=(path)
+    #  @location = Pathname.new(path)
+    #end
+
+    # Describe the purpose of this generator.
+    def about(text)
+      @about = text
+    end
+
+    # Give a one line usage template.
+    # Eg. '--reap=<name>'
+    # "Usage: sow" is automatically prefixed to this.
+    #def usage(usage)
+    #  @usage = usage
+    #end
+
+    # Define the commandline argument.
+    #def argument(name, desc=nil, &valid)
+    #  @arguments << [name, desc, valid]
+    #  #argv[name] = @arguments[@argc+=1]
+    #  #valid.call(argv[name]) if valid
+    #  #define_method(name) do
+    #  #  @arguments[i]
+    #  #end
+    #end
+
+    #def option(name, desc=nil, &valid)
+    #  @options << [name, desc, valid]
+    #end
+
+    # Designate a copying action.
+    #
+    # call-seq:
+    #   copy(from, opts)
+    #   copy(from, to, opts)
+    #
+    def copy(*from_to_opts)
+      opts = Hash===from_to_opts.last ? from_to_opts.pop : {}
+      from, to = *from_to_opts
+      to = to || '.'
+      @copylist << [from, to, opts.rekey(&:to_s)]
+    end
+
+    # This is to allow Plugin access to the internal state.
+    def [](var)
+      instance_variable_get("@#{var}")
+    end
+
+    # Set ... using a singleton method.
+    def []=(var, val)
+      quaclass = (class << self; self; end)
+      raise "invalid argument name -- #{var}" if quaclass.method_defined?(var)
+      quaclass.class_eval do
+        define_method(var){ val }
+      end
+      #@session[var.to_sym] = val
+    end
+
+    # If method missing, routes the call to +session+.
+    def method_missing(var,*a)
+      if val = @session.__send__(var)
+        return val
+      else
+        super
+      end
+    end
+
+  end#class Script
+
+  #
+  module Plugins
+    # see Sow::Script
+    Script = Sow::Script
+  end
+
+end#module Sow
+

data/lib/sow/session.rb

@@ -0,0 +1,150 @@
+require 'sow/metadata'
+
+module Sow
+
+  # Session provides a central store of commandline
+  # options and system state related to invocation
+  # the +sow+ command. This includes the destination
+  # directory, it's metadata and any special sow
+  # configurations.
+  #
+  class Session
+
+    # Create a new session instance.
+
+    def initialize(arguments, options)
+      @arguments = arguments
+      @options   = options
+
+      @trial  = options.trial?
+      @debug  = options.debug?
+      @quiet  = options.quiet?
+      @force  = options.force?
+      @prompt = options.prompt?
+      @skip   = options.skip?
+
+      @create = options.create?
+      @update = options.update?
+      @delete = options.delete?
+
+      @destination = Pathname.new(options.destination || Dir.pwd)
+
+      if file = Dir.glob(File.join(destination, '{,.}config/sow.{yml,yaml}')).first
+        @config = YAML.load(File.new(file))
+        @sowed = true
+      else
+        @config = {}
+        @sowed = false
+      end
+    end
+
+  public
+
+    # Destination for generated scaffolding.
+
+    attr :destination
+
+    # DEPREICATE: Is "output" too generic a name for a tool like Sow?
+
+    alias_method :output, :destination
+
+    # Tiral run? (Also know as a +noop+.)
+
+    def trial?  ; @trial  ; end
+
+    # Provide debugging information?
+
+    def debug?  ; @debug  ; end
+
+    # Run silently?
+
+    def quiet?  ; @quiet  ; end
+
+    # Override protected operations.
+
+    def force?  ; @force  ; end
+
+    # Prompot the user for options?
+
+    def prompt? ; @prompt ; end
+
+    # Skip overwrites?
+
+    def skip?   ; @skip   ; end
+
+    # Return command mode based on command options.
+    # Defaults to +:create+.
+    #--
+    # TODO: Are their circumstances where mode should defualt to update?
+    #++
+
+    def mode
+      return 'create' if @create
+      return 'update' if @update
+      return 'delete' if @delete
+      return 'create' #sowed? ? :update : :create
+    end
+
+    # Creation mode?
+
+    def create? ; @create ; end
+
+    # Update mode?
+
+    def update? ; @update ; end
+
+    # Delete mode?
+
+    def delete? ; @delete ; end
+
+    #
+    #def scaffold?
+    #  mode == :create && !sowed? #|| force? instad of delete and update?
+    #end
+
+    # Sow configuration.
+
+    def config ; @config ; end
+
+    # Previously sowed?
+
+    def sowed? ; @sowed ; end
+
+    # Does the destination contain any files?
+
+    def empty?
+      @empty ||= Dir[destination + '*'].empty?
+    end
+
+    # Alias for #empty?
+
+    alias_method :new?, :empty?
+
+    # Metadata for destination, if any.
+    #--
+    # TODO: Use POM::Metadata in future?
+    #++
+
+    def metadata
+      @metadata ||= Metadata.new(destination)
+    end
+
+    # Destination has metadata?
+
+    def metadata?
+      metadata.exist?
+    end
+
+    # What is the destinations meta directory (+meta+ or +.meta+)?
+    # If none then defaults to +.meta+.
+
+    def metadir
+      @meta_directory ||= (Dir[File.join(destination, '{.meta,meta}/')].first || '.meta/').chomp('/')
+    end
+
+    # Alias for meta_directory
+    #alias_method :metadir, :meta_directory
+
+  end
+
+end

data/meta/authors

@@ -0,0 +1 @@
+trans <transfire@gmail.com>

data/meta/contact

@@ -0,0 +1 @@
+tigerops-community@rubyforge.org

data/meta/description

@@ -0,0 +1 @@
+Sow is a flexible and straightforward project file generation system.

data/meta/homepage

@@ -0,0 +1 @@
+http://sow.rubyforge.org

data/meta/loadpath

@@ -0,0 +1,2 @@
+lib
+plug

data/meta/package

@@ -0,0 +1 @@
+sow

data/meta/project

@@ -0,0 +1 @@
+proutils

data/meta/repository

@@ -0,0 +1 @@
+git://github.com/proutils/sow.git

data/meta/requires

@@ -0,0 +1,2 @@
+facets >=2.4.3
+xdg

data/meta/ruby

@@ -0,0 +1,2 @@
+- 1.8.6
+- 1.8.7

data/meta/version

@@ -0,0 +1 @@
+0.4.0

data/plug/sow/seeds/bin/.meta/created

@@ -0,0 +1 @@
+<%= Time.now.strftime("%Y-%M-%D") %>

data/plug/sow/seeds/bin/.meta/description

@@ -0,0 +1 @@
+<%= package %> is a __FIX__.

data/plug/sow/seeds/bin/.meta/license

@@ -0,0 +1 @@
+GPL

data/plug/sow/seeds/bin/.meta/package

@@ -0,0 +1 @@
+<%= package %>

data/plug/sow/seeds/bin/.meta/requires

@@ -0,0 +1 @@
+

data/plug/sow/seeds/bin/.meta/title

@@ -0,0 +1 @@
+<%= package.capitalize %>

data/plug/sow/seeds/bin/.meta/version

@@ -0,0 +1 @@
+1.0.0

data/plug/sow/seeds/bin/SCRIPT.rb

@@ -0,0 +1,22 @@
+module Sow::Plugins
+
+  # Scaffold a ruby bin/ file.
+  #
+  class Bin < Script
+
+    option :name
+
+    setup do
+      @name = argument || destination
+      abort "Exectuable name is required." unless name
+      abort "Executable name must be a single word." if /\w/ !~ name
+    end
+
+    manifest do
+      copy 'bin/command.rb', "bin/#{@name}", :chmod => 0754
+    end
+
+  end
+
+end
+

data/plug/sow/seeds/bin/template/bin/command.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+#
+#  Created <%= "by #{author} " if author %>on <%= (now = Time.now).year %>-<%= now.month %>-<%= now.day %>.
+#  Copyright (c) <%= now.year %>. All rights reserved.
+#
+# TODO: write executable
+#
+# It might be something like the following.
+
+require '<%= package %>/command.rb'
+<%= title %>::Command.execute
+

data/plug/sow/seeds/hoe/SCRIPT.rb

@@ -0,0 +1,28 @@
+# How plugin, to make up for the fact the Sow clobber's
+# Hoe's +sow+ command.
+#
+# It's silly for Hoe to have a command called +sow+ when
+# it could just as well used +hoe+ andyway.
+
+module Sow::Plugins
+
+  # Scaffold a new Hoe-ready project
+  #
+  class Hoe < Script
+
+    option :name
+
+    setup do
+      name = name() || argument
+      abort "Project name argument required." unless name
+      metadata.name = name
+    end
+
+    manifest do
+      copy "**/*", '.'
+    end
+
+  end
+
+end
+