detroit 0.1.0 → 0.2.0

data/.ruby

@@ -1,45 +1,43 @@
---- 
-name: detroit
-version: 0.1.0
-title: Detroit
-summary: Software Production Mangement
-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.
-loadpath: 
-- lib
-manifest: Manifest
-requires: 
+---
+authors:
+- name: Trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Thomas Sawyer
+  year: '2007'
+  license: GPL3
+replacements: []
+conflicts: []
+requirements:
 - name: facets
-  version: 0+
-  group: []
-
 - name: pom
-  version: 0+
-  group: []
-
 - name: qed
-  version: 0+
-  group: 
+  groups:
   - test
-conflicts: []
-
-replaces: []
-
-engine_check: []
-
-organization: Rubyworks
-contact: Trans <transfire@gmail.com>
-created: 2007-10-10
-copyright: Copyright (c) 2007 Thomas Sawyer
-licenses: 
-- GPL3
-authors: 
-- Thomas Sawyer
-maintainers: []
-
-resources: 
+  development: true
+dependencies: []
+repositories:
+- uri: http://github.com/proutils/detroit.git
+  scm: git
+  name: upstream
+resources:
   home: http://rubyworks.github.com/detroit
   code: http://github.com/rubyworks/detroit
   mail: http://groups.google.com/rubyworks-mailinglist
-repositories: 
-  public: http://github.com/proutils/detroit.git
-spec_version: 1.0.0
+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'
+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

data/COPYING.rdoc

@@ -2,18 +2,22 @@
 
 == Detroit
 
-Copyright (c) 2011 Thomas Sawyer
+Copyright:: (c) 2011 Thomas Sawyer, Rubyworks
+License:: GPL3
+Website:: http://detroit.github.com
 
-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.
+  Copyright (c) 2011 Thomas Sawyer
 
-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.
+  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.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+  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 <http://www.gnu.org/licenses/>.
 

data/HISTORY.rdoc

@@ -1,5 +1,25 @@
 = RELEASE HISTORY
 
+== 0.2.0 / 2011-10-19
+
+The big news here is that Detroit configuration files are now
+called _assembly_ files, and no longer _schedule_ files. The
+new term is much more fitting the general design and overall
+nomenclature of the system. In addition a few general improvements
+and bug fixes have been applied. In effect, this is probabaly the
+first really usable public release of Detroit.
+
+Changes:
+
+* Schedule was renamed to Assembly.
+* Add help system using man-pages.
+* Put install phase before verify.
+* Add custom method for Ruby-style assemblies.
+* Rename ServiceWrapper to Service.
+* Firm up standard IO API for tools.
+* Fix --config output.
+
+
 == 0.1.0 / 2011-06-29
 
 Detroit is a lifecycle build system for Ruby. Detroit was originally

data/QED.rdoc

@@ -0,0 +1,87 @@
+## initialize
+
+Load schedule text written in Ruby DSL.
+
+    check do |ruby|
+      Detroit::Schedule.new(ruby)
+    end
+
+    ok <<-HERE
+      Email :myself do |s|
+        s.mailto = 'transfire@gmail.com'
+        s.active = true
+      end
+
+      Syntax do |s|
+        s.exclude = ['lib/plugins']
+        s.active  = false
+      end
+    HERE
+
+Load schedule from a file written in Ruby DSL.
+
+    check do |file|
+      path = File.join(root_dir, file)
+      Detroit::Schedule.new(File.new(path))
+    end
+
+    ok 'samples/example_schedule.rb'
+
+Load schedule text written in YAML"
+
+    check do |yaml|
+      Detroit::Schedule.new(yaml)
+    end
+
+    ok <<-HERE
+      ---
+      myself:
+        service: email
+        mailto : transfire@gmail.com
+        active : true
+      end
+
+      syntax:
+        exclude: [lib/plugins]
+        active : false
+    HERE
+
+Load schedule from a file written in YAML.
+
+    check do |file|
+      path = File.join(root_dir, file)
+      Detroit::Schedule.new(File.new(path))
+    end
+
+    ok 'samples/example_schedule.yml'
+
+
+= RDoc Plugin
+
+The RDoc plugin should generate rdoc doumentation according
+to the parameters provided.
+
+Given a suitable project.
+
+  Dir.chdir 'sample'
+
+Now if we run 'syckle document' on the sample project.
+
+  `detroit document`
+
+The documentation should be generated as expected.
+
+  File.assert.directory?('doc/rdoc')
+
+Lets clean up after ourselves.
+
+  FileUtils.rm_r 'doc'
+  Dir.chdir '..'
+
+
+
+
+
+
+
+

data/README.rdoc

@@ -1,14 +1,14 @@
 = Detroit
 
 Author:: Thomas Sawyer
-Licence:: GPL v.3
+License:: GPL v.3
 Copyright:: (c) 2011 Rubyworks, Thomas Sawyer
 
 
 == DESCRIPTION
 
 Detroit is a software production management aid for Ruby developers.
-Detroit utilizes a lifecycle methodology to help developers prepare and
+Detroit utilizes a life-cycle methodology to help developers prepare and
 release Ruby software in a clear, repeatable, linear fashion.
 
 
@@ -124,10 +124,10 @@ and give Detroit a try please let us know of any issues you encounter.
 
 == HISTORY
 
-Detroit is actaully the offspring of Reap v.10, and was called Syckle for 
+Detroit is actaully the offspring of Reap v10, and was called Syckle for 
 a number of years as it matured. It represents many years of design considerations
-(and reconsiderations), that evolved Reap from its simple Rake extension origins,
-which pre-dated Hoe, to the lifecycle system it is today.
+(and reconsiderations) that evolved Reap from its simple Rake extension origins,
+which pre-dated Hoe, to the life-cycle system it is today.
 
 
 == COPYRIGHT & LICENSE

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.1.0"
+  #VERSION = "0.2.0"
 end
 
 # Erb is used to to script YAML-based schedule files.
@@ -29,7 +29,7 @@ require 'yaml'
 require 'ansi/terminal'
 require 'ansi/code'
 
-# The parallel gem is used to (optionally) to multitask services.
+# The parallel gem is used to (optionally) multitask services.
 begin
   require 'parallel'
 rescue LoadError
@@ -38,30 +38,27 @@ end
 # POM is used to access project metadata.
 require 'pom'
 
-# Redtools provides the standard services.
-require 'redtools'
-
 # And all the rest is Detroit, baby.
 if RUBY_VERSION > '1.9'
   require_relative 'detroit/core_ext'
   require_relative 'detroit/config'
   require_relative 'detroit/service'
   require_relative 'detroit/tool'
-  require_relative 'detroit/assembly'
+  require_relative 'detroit/assembly_system'
   require_relative 'detroit/standard_assembly'
   require_relative 'detroit/control'
   require_relative 'detroit/application'
-  require_relative 'detroit/schedule'
+  require_relative 'detroit/assembly'
   require_relative 'detroit/custom'
 else
   require 'detroit/core_ext'
   require 'detroit/config'
   require 'detroit/service'
   require 'detroit/tool'
-  require 'detroit/assembly'
+  require 'detroit/assembly_system'
   require 'detroit/standard_assembly'
   require 'detroit/control'
   require 'detroit/application'
-  require 'detroit/schedule'
+  require 'detroit/assembly'
   require 'detroit/custom'
 end

data/lib/detroit.yml

@@ -1,45 +1,43 @@
---- 
-name: detroit
-version: 0.1.0
-title: Detroit
-summary: Software Production Mangement
-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.
-loadpath: 
-- lib
-manifest: Manifest
-requires: 
+---
+authors:
+- name: Trans
+  email: transfire@gmail.com
+copyrights:
+- holder: Thomas Sawyer
+  year: '2007'
+  license: GPL3
+replacements: []
+conflicts: []
+requirements:
 - name: facets
-  version: 0+
-  group: []
-
 - name: pom
-  version: 0+
-  group: []
-
 - name: qed
-  version: 0+
-  group: 
+  groups:
   - test
-conflicts: []
-
-replaces: []
-
-engine_check: []
-
-organization: Rubyworks
-contact: Trans <transfire@gmail.com>
-created: 2007-10-10
-copyright: Copyright (c) 2007 Thomas Sawyer
-licenses: 
-- GPL3
-authors: 
-- Thomas Sawyer
-maintainers: []
-
-resources: 
+  development: true
+dependencies: []
+repositories:
+- uri: http://github.com/proutils/detroit.git
+  scm: git
+  name: upstream
+resources:
   home: http://rubyworks.github.com/detroit
   code: http://github.com/rubyworks/detroit
   mail: http://groups.google.com/rubyworks-mailinglist
-repositories: 
-  public: http://github.com/proutils/detroit.git
-spec_version: 1.0.0
+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'
+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

data/lib/detroit/application.rb

@@ -1,7 +1,7 @@
 module Detroit
 
-  #
-  DEFAULT_ASSEMBLY = :standard
+  # The default assembly system to use.
+  DEFAULT_ASSEMBLY_SYSTEM = :standard
 
   # Application class is the main controller class for running
   # a session of Detroit.
@@ -17,48 +17,75 @@ module Detroit
     def initialize(options)
       @options = options
       #load_standard_plugins
+
+      self.skip       = options[:skip]
+      self.quiet      = options[:quiet]
+      self.system     = options[:system]
+      self.multitask  = options[:multitask]
+      self.assemblies = options[:assemblies]
     end
 
-#    # Load standard plugins.
-#    def load_standard_plugins
-#      #::Plugin.find("detroit/*.rb").each do |file|
-#      Detroit.standard_plugins.each do |file|
-#        begin
-#          require(file)
-#        rescue => err
-#          $stderr.puts err if $DEBUG
-#        end
-#      end
-#    end
+    # Quiet mode?
+    def quiet?
+      @quiet
+    end
+
+    # Set quiet mode.
+    def quiet=(boolean)
+      @quiet = !!boolean
+    end
+
+    # List of service names to skip.
+    def skip
+      @skip
+    end
+
+    # Set skip list.
+    def skip=(list)
+      @skip = list.to_list.map{ |s| s.downcase }
+    end
 
     # The selected assembly system.
-    def assembly
-      options[:assembly] || DEFAULT_ASSEMBLY
+    def system
+      @system
     end
 
-    # Quiet mode?
-    def quiet?
-      options[:quiet]
+    # Set assembly system to use.
+    def system=(name)
+      @system = (name || DEFAULT_ASSEMBLY_SYSTEM)
     end
 
+    # Alias for #system.
+    alias :assembly_system :system
+
     # Multitask mode?
     def multitask?
-      options[:multitask] && defined?(Parallel)
+      @multitask      
     end
 
-    # Returns a list of services to skip as specificed on the commandline.
-    def skip
-      @skip ||= options[:skip].to_list.map{ |s| s.downcase }
+    # Set multi-task mode.
+    def multitask=(boolean)
+      if boolean && !defined?(Parallel)
+        puts "Parallel gem must be installed to multitask."
+        @multitask = false
+      else
+        @multitask = boolean
+      end
+    end
+
+    # List of assembly files to use.
+    def assemblies
+      @assemblies
     end
 
     #
-    def schedules
-      @schedules ||= options[:schedules]
+    def assemblies=(files)
+      @assemblies = files
     end
 
     # Detroit configuration.
     def config
-      @config ||= Detroit::Config.new(schedules)
+      @config ||= Detroit::Config.new(assemblies)
     end
 
     # Provides access to the Project instance via `Detroit.project` class method.
@@ -73,14 +100,38 @@ module Detroit
       config.defaults
     end
 
-    # Generates a configuration template for particular tool or all tools.
-    # This is only used for reference purposes.
-    def config_template(name=nil)
-      if name
-        list = [name, Detroit.tools[name]]
+#    # Load standard plugins.
+#    def load_standard_plugins
+#      #::Plugin.find("detroit/*.rb").each do |file|
+#      Detroit.standard_plugins.each do |file|
+#        begin
+#          require(file)
+#        rescue => err
+#          $stderr.puts err if $DEBUG
+#        end
+#      end
+#    end
+
+    # Display detailed help for a given tool.
+    def display_help(name)
+      if not Detroit.tools.key?(name)
+        config.load_plugin(name)
+      end
+      tool = Detroit.tools[name]
+      if tool.respond_to?(:man_page)
+        Kernel.system "man #{tool.man_page}"
       else
-        list = Detroit.tools
+        puts "Sorry, no detailed help available for `#{name}'."
       end
+    end
+
+    # Generates a configuration template for particular tool.
+    # This is only used for reference purposes.
+    def config_template(name)
+      if not Detroit.tools.key?(name)
+        config.load_plugin(name)
+      end
+      list = {name => Detroit.tools[name]}
       cfg = {}
       list.each do |srv_name, srv_class|
         attrs = srv_class.options #instance_methods.select{ |m| m.to_s =~ /\w+=$/ && !%w{taguri=}.include?(m.to_s) }
@@ -92,21 +143,28 @@ module Detroit
       cfg
     end
 
-    # Active services are services defined in schedule files and do not
+    # TODO: Setup all services, then ween out inactive ones?
+    #def services
+    #end
+
+    # Active services are services defined in assembly files and do not
     # have their active setting turned off.
     #
     # Returns Array of active services.
     def active_services
       @active_services ||= (
-        activelist = []
+        list = []
 
         config.each do |key, opts|
-          next unless opts && opts['active'] != false
-
-          # omit any service in the skip list
+          next unless opts
+          next unless opts['active'] != false
           next if skip.include?(key.to_s)
 
-          tool_name = (opts.delete('tool') || opts.delete('service') || key).to_s.downcase
+          tool_name = (
+            opts.delete('tool')    ||
+            opts.delete('service') ||
+            key
+          ).to_s.downcase
 
           unless Detroit.tools.key?(tool_name)
             config.load_plugin(tool_name)
@@ -121,39 +179,21 @@ module Detroit
             options = defaults[tool_name.downcase].to_h
             options = options.merge(common_tool_options)
             options = options.merge(opts)
-            #activelist << tool_class.new(key, options) #script,
-            ## remove any services specified by the --skip option on the comamndline
-            activelist << ServiceWrapper.new(key, tool_class, options) #script,
+
+            list << Service.new(key, tool_class, options) #script,
           #else
           #  warn "Service #{tool_class} is not available."
           end
         end
 
         # sorting here trickles down to processing later
-        activelist = activelist.sort_by{ |s| s.priority || 0 }
+        #list = list.sort_by{ |s| s.priority || 0 }
 
-        activelist
+        list
       )
     end
 
-    #alias_method :services, :active_services
-
-    # Service configuration, from project's schedule file(s).
-    #
-    # Returns Hash of service name and settings.
-    #def service_configs
-    #  config.services
-    #end
-
-    # Run individual detroit scripts.
-    #def runscript(script, stop)
-    #  @config.services.clear
-    #  @config.load_schedule_file(script)
-    #  #@service_configs = load_service_configs(script)
-    #  run(stop)
-    #end
-
-    # Start the run.
+    # Change direectory to project root and run.
     def start(stop)
       Dir.chdir(project.root) do       # change into project directory
         run(stop)
@@ -175,9 +215,9 @@ module Detroit
       name = name.to_sym
       stop = stop.to_sym if stop
 
-      assm = Detroit.assemblies[assembly]
+      assm = Detroit.assembly_systems[system]
 
-      raise "Unkown assembly `#{assembly}'" unless assm
+      raise "Unkown assembly system `#{system}'" unless assm
 
       track = assm.get_track(name, stop)
 
@@ -191,17 +231,14 @@ module Detroit
         exit 0
       end
 
+      @destination = stop
+
       # prime the services (so as to fail early)
       active_services.each do |srv|
         srv.preconfigure if srv.respond_to?("preconfigure")
       end
 
-      if multitask?
-        h = ["#{project.metadata.title} v#{project.metadata.version}   [M]", "#{project.root}"]
-      else
-        h = ["#{project.metadata.title} v#{project.metadata.version}", "#{project.root}"]
-      end
-      status_header(*h)
+      status_header(*header_message)
 
       start_time = Time.now
 
@@ -239,7 +276,7 @@ module Detroit
 
     # Returns a project's Detroit hooks directory.
     def hook_directory
-      dir  = project.root.glob("{.,}detroit/hooks").first
+      project.root.glob("{.,}detroit/hooks").first
     end
 
     #
@@ -260,9 +297,12 @@ module Detroit
     end
 
     # Make service calls.
+    #
+    # This groups services by priority b/c groups of the same priority can be run
+    # in parallel if the multitask option is on.
     def service_calls(track, stop)
       prioritized_services = active_services.group_by{ |srv| srv.priority }.sort_by{ |k,v| k }
-      prioritized_services.each do |(priority, services)|
+      prioritized_services.each do |priority, services|
         ## remove any services specified by the --skip option on the comamndline
         #services = services.reject{ |srv| skip.include?(srv.key.to_s) }
         ## only servies that are on the track
@@ -286,36 +326,27 @@ module Detroit
       # run if the service supports the track and stop.
       #if srv.respond_to?("#{track}_#{stop}")
       if srv.stop?(stop)
-        if options[:verbose]
+        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)
         else
           status_line("#{srv.key.to_s}", stop.to_s.gsub('_', '-').capitalize)
         end
         #srv.__send__("#{track}_#{stop}")
-        srv.invoke(stop)
+        srv.invoke(stop, @destination)
       end
     end
 
-    # Returns a list of all terminal stops, i.e. stops at a tracks end.
-    # FIXME: stop_map is not defined.
-    def end_stops
-      (stop_map.keys - stop_map.values).compact
-    end
+    # --- Print Methods -------------------------------------------------------
 
-    # Give an overview of stops this track supports.
-    # FIXME: end_stops blows up.
-    def overview
-      end_stops.each do |stop_name|
-        action_plan(stop_name).each do |act|
-          display_action(act)
-        end
-        puts
+    def header_message
+      if multitask?
+        ["#{project.metadata.title} v#{project.metadata.version}   [M]", "#{project.root}"]
+      else
+        ["#{project.metadata.title} v#{project.metadata.version}", "#{project.root}"]
       end
     end
 
-    # --- Print Methods ------------------------------------------------------
-
     # Print a status header, which consists of project name and version on the
     # left and stop location on the right.
     #
@@ -355,7 +386,7 @@ module Detroit
 
     #
     def print_header(left, right)
-      if ANSI::SUPPORTED
+      if $ansi #ANSI::SUPPORTED
         printline('', '', :pad=>1, :sep=>' ', :style=>[:negative, :bold], :left=>[:bold], :right=>[:bold])
         printline(left, right, :pad=>2, :sep=>' ', :style=>[:negative, :bold], :left=>[:bold], :right=>[:bold])
         printline('', '', :pad=>1, :sep=>' ', :style=>[:negative, :bold], :left=>[:bold], :right=>[:bold])
@@ -366,7 +397,7 @@ module Detroit
 
     #
     def print_phase(left, right)
-      if ANSI::SUPPORTED
+      if $ansi #ANSI::SUPPORTED
         printline(left, right, :pad=>2, :sep=>' ', :style=>[:on_white, :black, :bold], :left=>[:bold], :right=>[:bold])
       else
         printline(left, right, :pad=>2, :sep=>'-')