detroit 0.2.0 → 0.3.0

data/EXAMPLE.md

@@ -1,18 +1,18 @@
 # Detroit
 
-Detroit's main configuration file is called a *Pitfile*. Pitfiles define the 
+Detroit's main configuration file is called an *assembly*. Assemblies define the 
 <i>service instances</i> that a project will utilize. 
 
-Pitfiles can be written in a few different formats thanks to the flexibility
+Assemblies can be written in a few different formats thanks to the flexibility
 of Ruby. All formats are equivalent. Which format you use is strictly a regard
 of your personal preference.
 
 ## Ruby-based Detroit
 
-### Traditional Format
+### Service Method Notation
 
-Traditionally a Ruby-based Detroit is dominated by calls to the `service` method
-with an optional service instance name and a setter block.
+Traditionally a Ruby-based assembly file is dominated by calls to the `service`
+method with an optional service instance name and a setter block.
 
 ```ruby
   service :myself do |s|
@@ -31,8 +31,9 @@ If no `service` setting is given, it is assumed to be same as the service instan
 In the above example `rdoc` is taken to be both the service desired and the name of
 this particular instance.
 
-A few years ago, Sinatra came along and popularized the use of the `#set` method. A simple addition
-to the the Detroit parser now allows for the slightly cleaner notation:
+A few years ago, Sinatra came along and popularized the use of the `#set` method.
+A simple addition to Detroit's assembly file parser now allows for the slightly
+cleaner notation:
 
 ```ruby
   service :myself do
@@ -71,12 +72,12 @@ definition to be written as simply as:
   service :rdoc
 ```
 
-### Modern Notation
+### Service Name Notation
 
-Thanks to some straight-forward meta-programming, a Ruby-based Detroit can
-be written in a more concisely notation by using the name of the service class as a
+Thanks to some straight-forward meta-programming, a Ruby-based assembly file can
+be written in a more concise notation by using the name of the service class as a
 method. This can be followed by a settings block, as with the above examples,
-or passed a <i>settings hash</i>. In which case a Detroit can look like this:
+or passed a <i>settings hash</i>. In which case an assembly file can look like this:
 
 ```ruby
   Announce   :mailto   => "ruby-talk@ruby-lang.org",
@@ -113,16 +114,16 @@ need to define service instances. With Ruby 1.9 it can be even more conisce
 using the new Hash syntax.
 
 ```ruby
-  Announce  :myself,
-             mailto:   "transfire@gmail.com",
-             priority: -1
-             active:   true
+  Announce :myself,
+    mailto:   "transfire@gmail.com",
+    priority: -1
+    active:   true
 ```
 
-But you might want to hold off on that a couple of years until Ruby 1.8 is pretty much
-shot and buried ;)
+But you might want to hold off on that a couple of years until Ruby 1.8 is pretty
+much shot and buried ;)
 
-## YAML-based Detroit
+## YAML-based Assembly Files
 
 We have saved the most concise notation for last. The YAML format is
 essentially the same as the traditional Ruby format except that
@@ -132,7 +133,7 @@ setting which defaults to the name. Also, notice the start document indicator
 recognized as YAML, rather than Ruby.
 
 ```yaml
-  --- !detroit
+  ---
 
   announce:
     mailto: "transfire@gmail.com"
@@ -172,17 +173,16 @@ recognized as YAML, rather than Ruby.
     sitemap:
       site: <% name %>
     active: false
-```
 
 As we can see in the last entry, the YAML format also supports ERB and provides
 access to project metadata via the ERB's binding.
 
-With the Ruby format it is easy enough to load external Detroit plugins using
+With the Ruby format it is easy enough to load external library using
 standard `require` and `load` methods. Since the YAML format supports ERB
 it can be used to achieve the same effect.
 
-```ruby
-  --- !detroit
-  <% require 'some/detroit/plugin' %>
+```yaml
+  ---
+  <% require 'some/external/library' %>
 ```
 

data/HISTORY.rdoc

@@ -1,5 +1,21 @@
 = RELEASE HISTORY
 
+== 0.3.0 / 2012-04-02
+
+This significant release changes the interface for tools to tap
+into the assembly line. Where as before specially named methods
+in the form of `station_{stop}` were used, now two special methods
+are expected `#assemble?` and `#assemble`. The first checks to see
+if a particular stop is supported and the later is used to execute
+it if it does.
+
+Changes:
+
+* Simplify the assembly interface for tools.
+* Tool classes ending in Base are abstract base class.
+* Add #on as alias from #track.
+
+
 == 0.2.0 / 2011-10-19
 
 The big news here is that Detroit configuration files are now

data/README.rdoc

@@ -1,8 +1,8 @@
 = Detroit
 
-Author:: Thomas Sawyer
-License:: GPL v.3
-Copyright:: (c) 2011 Rubyworks, Thomas Sawyer
+{Homepage}[http://rubyworks.github.com/detroit] /
+{Development}[http://github.com/rubyworks/detroit] /
+{Mailing List}[http://googlegroups.com/group/rubyworks-mailinglist]
 
 
 == DESCRIPTION
@@ -12,13 +12,6 @@ Detroit utilizes a life-cycle methodology to help developers prepare and
 release Ruby software in a clear, repeatable, linear fashion.
 
 
-== RESOURCES
-
-* {Homepage}[http://rubyworks.github.com/detroit]
-* {Development}[http://github.com/rubyworks/detroit]
-* {Mailing List}[http://googlegroups.com/group/rubyworks-mailinglist]
-
-
 == HOW IT WORKS
 
 Detroit defines development processions which consist of a set of named 

data/lib/detroit.rb

@@ -13,7 +13,7 @@ module Detroit
   end
 
   # TODO: Only here b/c of bug in Ruby 1.8.x
-  #VERSION = "0.2.0"
+  #VERSION = "0.3.0"
 end
 
 # Erb is used to to script YAML-based schedule files.

data/lib/detroit.yml

@@ -1,4 +1,7 @@
 ---
+source:
+- PROFILE
+- meta
 authors:
 - name: Trans
   email: transfire@gmail.com
@@ -6,8 +9,6 @@ copyrights:
 - holder: Thomas Sawyer
   year: '2007'
   license: GPL3
-replacements: []
-conflicts: []
 requirements:
 - name: facets
 - name: pom
@@ -16,6 +17,8 @@ requirements:
   - test
   development: true
 dependencies: []
+alternatives: []
+conflicts: []
 repositories:
 - uri: http://github.com/proutils/detroit.git
   scm: git
@@ -24,20 +27,18 @@ resources:
   home: http://rubyworks.github.com/detroit
   code: http://github.com/rubyworks/detroit
   mail: http://groups.google.com/rubyworks-mailinglist
+extra: {}
 load_path:
 - lib
-extra: {}
-source:
-- PROFILE
-alternatives: []
 revision: 0
-version: 0.2.0
-date: '2011-10-18'
-name: detroit
-title: Detroit
-summary: Software Production Mangement
 created: '2007-10-10'
+summary: Software Production Mangement
+title: Detroit
+version: 0.3.0
+name: detroit
+suite: detroit
 description: Detroit is an advanced lifecycle build system. With Detroit, build tasks
   are user defined service instances tied to stops along a track. Whenever the detroit
   console command is run, a track is followed from beginning to designated destination.
-organization: Detroit
+organization: rubyworks
+date: '2012-04-01'

data/lib/detroit/application.rb

@@ -233,6 +233,8 @@ module Detroit
 
       @destination = stop
 
+      # TODO: Using #preconfigure as part of the protocol should probably change.
+
       # prime the services (so as to fail early)
       active_services.each do |srv|
         srv.preconfigure if srv.respond_to?("preconfigure")
@@ -256,12 +258,13 @@ module Detroit
       puts "\nFinished in #{stop_time - start_time} seconds." unless quiet?
     end
 
-    # Execute service hook for given track and destination.
-    #--
     # TODO: Deprecate service hooks?
+
+    #
+    # Execute service hook for given track and destination.
+    #
+    # @todo Currently only stop counts, maybe add track subdirs.
     #
-    # TODO: Currently only stop counts, maybe add track subdirs.
-    #++
     def service_hooks(track, stop)
        #hook = dir + ("#{track}/#{stop}.rb".gsub('_', '-'))
        dir  = hook_directory
@@ -321,11 +324,13 @@ module Detroit
       end
     end
 
-    # Run a service given the service, track name and stop name.
+    #
+    # Run a service given the service, track and stop name.
+    #
     def run_a_service(srv, track, stop)
       # run if the service supports the track and stop.
       #if srv.respond_to?("#{track}_#{stop}")
-      if srv.stop?(stop)
+      if srv.stop?(stop, @destination)
         if options[:trace] #options[:verbose]
           #status_line("#{srv.key.to_s} (#{srv.class}##{track}_#{stop})", stop.to_s.gsub('_', '-').capitalize)
           status_line("#{srv.key.to_s} (#{srv.class}##{stop})", stop.to_s.gsub('_', '-').capitalize)

data/lib/detroit/custom.rb

@@ -21,10 +21,12 @@ module Detroit
     # Plural alias for #track.
     alias_accessor :tracks, :track
 
+    alias_accessor :on, :track
+
     private
 
     SPECIAL_OPTIONS = %w{
-      service track tracks active priority project 
+      service track tracks on active priority project 
       trial trace verbose force quiet
     }
 
@@ -59,22 +61,42 @@ module Detroit
 
     #
     def method_missing(s, *a, &b)
-      if @context.respond_to?(s)
-        @context.__send__(s,*a,&b)
+      if s.to_s.end_with?('=')
+      #  stop = s.to_s.chomp('=')
+      #  if !SPECIAL_OPTIONS.include?(stop)
+      #   (class << self; self; end).module_eval %{
+      #      def station_#{stop}
+      #        #{a.first}
+      #      end
+      #    }
+      #  end
       else
-        super(s, *a, &b)
+        if @context.respond_to?(s)
+          @context.__send__(s,*a,&b)
+        else
+          super(s, *a, &b)
+        end
       end
     end
 
-    public
-
-    #
-    #def respond_to?(name)
-    #  r = super(name)
-    #  return r if r
-    #  @context.respond_to?(s)
+    # @todo should only respond to stop names and special options.
+    #def respond_to?(s)
+    #  return true if SPECIAL_OPTIONS.include?(s.to_s)
+    #  return true
     #end
 
+    # RUBY 1.9
+    def respond_to_missing?(name, privy)
+      #return true if name.to_s.start_with?('station_')
+      return true if name.to_s.end_with?('=')
+      return true if @context.respond_to?(name)
+      false
+    end
+
+    def inspect
+      "#<Custom @on=#{track.join(',')}>"
+    end
+
   end
 
 end

data/lib/detroit/service.rb

@@ -1,14 +1,9 @@
 module Detroit
 
-  #
-  #def self.services
-  #  @registry ||= {}
-  #end
- 
-  # Service class wraps a Tool instance when it is made
-  # part of an assembly.
-  #
   # TODO: Need to work on how to limit a service's tracks per-assembly.
+
+  # Service class wraps a Tool instance when it is made part of an assembly.
+  #
   class Service
     attr :key
     attr :tracks
@@ -17,23 +12,31 @@ module Detroit
     attr :service
     #attr :options
 
+    #
     # Set the priority. Priority determines the order which
     # services on the same stop are run.
+    #
     def priority=(integer)
       @priority = integer.to_i
     end
 
+    #
     # Set the tracks a service will be available on.
+    #
     def tracks=(list)
       @tracks = list.to_list
     end
 
+    #
+    #
     #
     def active=(boolean)
       @active = !!boolean
     end
 
+    #
     # Create new ServiceWrapper.
+    #
     def initialize(key, service_class, options)
       @key      = key
 
@@ -49,147 +52,27 @@ module Detroit
       @service = service_class.new(options)
     end
 
-    # Does the service support the given stop.
-    def stop?(name)
-      @service.respond_to?("station_#{name}")
-    end
-
-    # Run the service stop procedure.
-    def invoke(name, stop=nil)
-      sm = @service.method("station_#{name}")  # public_send
-      sm.arity == 0 ? sm.call : sm.call(stop)
-    end
-
     #
-    def inspect
-      "<#{self.class}:#{object_id} @key='#{key}'>"
+    # Does the service support the given assembly station?
+    #
+    def stop?(station, stop=nil)
+      @service.assemble?(station.to_sym, :destination=>stop.to_sym)
     end
 
     #
-    #def self.assemble(name, method=nil)
-    #  define_method("assembly_#{name}") do
-    #    __send__(method || name)  # public_send
-    #  end
-    #end
-  end
-
-end
-
-
-
-=begin
-  # Mixin module is added to Service and Tool.
-  module Serviceable
-
+    # Run the service assembly station procedure.
     #
-    def self.included(base)
-      base.extend ClassRegistry
-      base.extend DomainLanguage
-    end
-
-    # Register new instance of the Service class.
-    module ClassRegistry
-
-      # Class-level attribute of registered Service subclasses.
-      # 
-      # Returns a Hash.
-      def registry
-        Detroit.services
-      end
-
-      # TODO: Probably should make a named registry instead.
-      def inherited(base)
-        return if base.name.to_s.empty?
-        if base.name !~ /Service$/
-          registry[base.basename.downcase] = base
-        end
-      end
-
-      # Returns a Class which is a new subclass of the current class.
-      def factory(&block)
-        Class.new(self, &block)
-      end
-
-      #
-      def options(service_class=self)
-        service_class.instance_methods.
-          select{ |m| m.to_s =~ /\w+=$/ && !%w{taguri=}.include?(m.to_s) }.
-          map{ |m| m.to_s.chomp('=') }
-      end
-
-    end
-
-    # Service Domain language. This module extends the Service class,
-    # to provide a convenience interface for defining stops.
-    module DomainLanguage
-      ## TODO: Err.. Is this being used?
-      #def init(&block)
-      #  define_method(:init, &block)
-      #end
-
-      # Override the `tracks` method to limit the lines a service
-      # will work with by default. Generally this is not used,
-      # and a return value of +nil+ means all lines apply.
-      def tracks
-      end
-
-      # TODO: Perhaps deprecate this in favor of just defining an `availabe?`
-      # class method.
-      def available(&block)
-        @available = block if block
-        @available ||= nil
-      end
-
-      #
-      def available?(project)
-        return true unless available
-        @available.call(project)
-      end
+    def invoke(station, stop=nil)
+      @service.assemble(station.to_sym, :destination=>stop.to_sym)
     end
 
-    #attr_reader :service_name
-
     #
-    def service_title
-      self.class.name
-    end
-
-    # TODO: Is this being used?
-    #def service_actions
-    #  self.class.service_actions
-    #end
-
     #
-    #def inspect
-    #  "<#{self.class}:#{object_id}>"
-    #end
-  end
-
-  # The Service class is the base class for defining basic or delgated services.
-  class Service
-    include Serviceable
-
     #
-    attr :options
-
-    def initialize(options={})
-      @options = options
+    def inspect
+      "<#{self.class}:#{object_id} @key='#{key}'>"
     end
-  end
-
 
-end #module Detroit
+  end
 
-# Provides a clean namespace for creating services.
-module Detroit::Plugins
-  Service = Detroit::Service
-  Tool    = Detroit::Tool
 end
-
-=end
-
-# TOPLEVEL DSL?
-#def service(name, &block)
-#  #Detroit.services[name] = Service.factory(&block)
-#  Detroit::Service.registry[name.to_s] = Detroit::Service.factory(&block)
-#end