auto 0.1.0 → 0.1.1

data/README.markdown

@@ -1,35 +1,109 @@
-Automaton
-=========
+Auto
+====
 
 Automate everything!
 
 Notice
 ------
 
-This gem is in development. Functionality updates will show up in this file.
+This gem is currently under development. Some of what you see below is a fantasy.
 
-Goals
+Install
+-------
+
+<pre>
+sudo gem install auto --source http://gemcutter.org
+</pre>
+
+Introduction
+------------
+
+Auto is a framework for writing automation scripts and plugins for those scripts.
+
+<pre>
+require 'rubygems'
+require 'auto'
+
+question :name => "What is your name?"
+question :delete => "Delete file when finished? (y/n)"
+
+file "#{@name}.txt" do |f|
+  f &lt;&lt; 'Append to text file'
+  f = 'Overwrite text file'
+end
+
+file("#{@name}.txt").delete if @delete
+</pre>
+
+Save it and run it like you would any other Ruby script.
+
+In this example, <code>question</code> and <code>file</code> are both methods provided by the plugins <code>auto-question</code> and <code>auto-file</code>, respectively. They are included when you install the <code>auto</code> gem, but other plugins can be obtained via Rubygems.
+
+Tasks
 -----
 
-* Writing automation scripts should be simple
-  * Global namespace
-  * A library of simple methods that do complex things
-* Adding outside scripts and script functionality should be simple
-  * Obvious plugin structure
-  * Automated installation/updates
-* Running tasks should be simple
-  * Everything available via "auto task" command
-  * Easy to ask questions
-* Sessions
-  * Record input for any number of questions
-  * Replay using "auto session" command
-* Or, use the web interface
-  * Make it easy for novices to use and extend
+Auto has a tasks system similar to Capistrano or Rake. In the previous example, if you had saved your script to <code>~/.auto/my/name.rb</code>, you would be able to run it by executing <code>auto my:name</code> in Terminal.
 
-Install
--------
+Tasks may also be included via plugin. See the **Authoring Plugins** section for more information.
+
+Sessions
+--------
+
+Installing the <code>auto</code> gem also installs <code>auto-session</code>, which allows you to record the input to your Auto scripts and replay them later.
+
+To save a session, run your script or task with the <code>SESSION</code> environment variable:
 
 <pre>
-gem sources -a http://gems.github.com
-sudo gem install winton-automaton
-</pre>
+SESSION=name ruby my_name.rb
+SESSION=name auto my:name
+</pre>
+
+This session would be saved in <code>~/.auto/session/name.rb</code> (run it by executing <code>auto session:name</code>). It might look like this:
+
+<pre>
+answer :name => 'Joe'
+answer :delete => false
+run 'my:name'
+</pre>
+
+The session script is executed as any other Auto script. This is cool because you can modify your session files to get custom input for certain questions.
+
+<pre>
+question :name => "What is your last name?"
+answer :delete => false
+run 'my:name'
+</pre>
+
+You also could have deleted the <code>:name</code> answer to ask that question upon running the session.
+
+Authoring Plugins
+-----------------
+
+Plugins have a lib directory just like any other gem. Here is how the lib file for the Foo plugin might look:
+
+<pre>
+# lib/foo.rb
+module Auto
+  module Foo
+
+    def foo(*args)
+      Foo.instance args
+    end
+
+    class Foo
+      class &lt;&lt;self
+      
+        def instance(args)
+          # Do something
+        end
+      end
+    end
+  end
+end
+</pre>
+
+Auto uses the gem name (<code>auto-foo</code>) to find <code>lib/foo.rb</code> and include <code>Auto::Foo</code> into the environment. Now you can call the <code>foo</code> method in any of your Auto scripts.
+
+Auto plugins must have gem names with <code>auto-</code> as a prefix to be automatically required.
+
+Include Auto tasks with your plugin by adding a <code>.auto</code> directory to your gem, just as you do with your home directory (<code>~/.auto</code>).

data/Rakefile

@@ -2,28 +2,13 @@ require 'rubygems'
 require 'rake'
 require 'rake/gempackagetask'
 require 'spec/rake/spectask'
+require 'gemspec'
 
-GEM_NAME = 'automaton'
-PKG_FILES = FileList['**/*'] - FileList['coverage', 'coverage/**/*', 'pkg', 'pkg/**/*']
-
-spec = Gem::Specification.new do |s|
-  s.author = "Winton Welsh"
-  s.email = "mail@wintoni.us"
-  s.extra_rdoc_files = [ "README.markdown" ]
-  s.files = PKG_FILES.to_a
-  s.has_rdoc = false
-  s.homepage = "http://github.com/winton/#{GEM_NAME}"
-  s.name = 'auto'
-  s.platform = Gem::Platform::RUBY
-  s.require_path = "lib"
-  s.summary = "Automate everything!"
-  s.version = "0.1.0"
-end
-
-
-desc "Package gem"
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
+desc "Generate gemspec"
+task :gemspec do
+  File.open("#{Dir.pwd}/#{GEM_NAME}.gemspec", 'w') do |f|
+    f.write(GEM_SPEC.to_ruby)
+  end
 end
 
 desc "Install gem"
@@ -34,10 +19,28 @@ task :install do
   `rm -Rf pkg`
 end
 
-desc "Generate gemspec"
-task :gemspec do
-  File.open("#{File.dirname(__FILE__)}/#{GEM_NAME}.gemspec", 'w') do |f|
-    f.write(spec.to_ruby)
+desc "Package gem"
+Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+  pkg.gem_spec = GEM_SPEC
+end
+
+desc "Rename project"
+task :rename do
+  name = ENV['NAME'] || File.basename(Dir.pwd)
+  begin
+    dir = Dir['**/gem_template*']
+    from = dir.pop
+    if from
+      rb = from.include?('.rb')
+      to = File.dirname(from) + "/#{name}#{'.rb' if rb}"
+      FileUtils.mv(from, to)
+    end
+  end while dir.length > 0
+  Dir["**/*"].each do |path|
+    next if path.include?('Rakefile')
+    if File.file?(path)
+      `sed -i "" 's/gem_template/#{name}/g' #{path}`
+    end
   end
 end
 

data/gemspec.rb

@@ -0,0 +1,18 @@
+GEM_NAME = 'auto'
+GEM_FILES = FileList['**/*'] - FileList['coverage', 'coverage/**/*', 'pkg', 'pkg/**/*']
+GEM_SPEC = Gem::Specification.new do |s|
+  # == CONFIGURE ==
+  s.author = "Winton Welsh"
+  s.email = "mail@wintoni.us"
+  s.homepage = "http://github.com/winton/#{GEM_NAME}"
+  s.summary = "Automate everything!"
+  # == CONFIGURE ==
+  s.add_dependency('auto-terminal', '=0.0.1')
+  s.extra_rdoc_files = [ "README.markdown" ]
+  s.files = GEM_FILES.to_a
+  s.has_rdoc = false
+  s.name = GEM_NAME
+  s.platform = Gem::Platform::RUBY
+  s.require_path = "lib"
+  s.version = "0.1.1"
+end

data/lib/auto.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + "/auto/require"
+
+module Auto
+  Runner.new { terminal($0) }
+  exit
+end

data/lib/{automaton → auto}/plugins.rb

@@ -1,6 +1,6 @@
 require 'rubygems'
 
-module Automaton
+module Auto
   class Plugins
     
     @@directories = [
@@ -16,7 +16,7 @@ module Automaton
       
       # Add a directory to the plugin load paths.
       def add(path)
-        @@directories = [] if $TESTING
+        @@directories = [] if $testing
         @@directories << path
         @@directories.uniq!
         @@plugins = nil
@@ -26,7 +26,7 @@ module Automaton
       def plugins
         return @@plugins if @@plugins
         directories = @@directories.collect do |d|
-          File.expand_path("#{d}/*automaton-*/")
+          File.expand_path("#{d}/*auto-*/")
         end
         @@plugins = Dir[*directories].collect do |d|
           Plugin.new(d)
@@ -80,23 +80,23 @@ module Automaton
         name = File.basename(directory)
         name = name.split('-')
         
-        return nil unless name.include?('automaton')
-        @name = name[name.index('automaton') + 1]
+        return nil unless name.include?('auto')
+        @name = name[name.index('auto') + 1]
         
-        # ~/.auto/automaton-plugin/lib/plugin.rb
+        # ~/.auto/auto-plugin/lib/plugin.rb
         @library = "#{directory}/lib/#{@name}.rb"
         @library = nil unless File.exists?(@library)
         
-        # Automaton::Plugin
+        # Auto::Plugin
         if @library
           @module = File.basename(@library, '.rb').camelize
         else
           @module = nil
         end
         
-        # ~/.auto/automaton-plugin/auto/task.rb
-        @tasks = Dir["#{directory}/auto/**/*.rb"].sort.collect do |path|
-          relative = path.gsub("#{directory}/auto/", '')
+        # ~/.auto/auto-plugin/auto/task.rb
+        @tasks = Dir["#{directory}/.auto/**/*.rb"].sort.collect do |path|
+          relative = path.gsub("#{directory}/.auto/", '')
           {
             :name => relative[0..-4].split('/').join(':').downcase,
             :path => path

data/lib/{automaton → auto}/require.rb

@@ -1,4 +1,4 @@
-# By default, <tt>require 'automaton'</tt> uses Runner to re-evaluate the script.
+# By default, <tt>require 'auto'</tt> uses Runner to re-evaluate the script.
 # If you don't want the environment (just the classes), require this file.
 
 require File.dirname(__FILE__) + "/alias"

data/lib/{automaton → auto}/runner.rb

@@ -1,4 +1,4 @@
-module Automaton
+module Auto
   class Runner
     
     def initialize(path_or_task=nil, &block)
@@ -9,11 +9,10 @@ module Automaton
     def run(path_or_task=nil, &block)
       self.instance_eval(&block) if block
       if path_or_task
-        task = Plugins.tasks(path_or_task)
-        if task
-          @path = task[:path]
-        elsif File.exists?(path_or_task)
+        if File.exists?(path_or_task)
           @path = path_or_task
+        elsif task = Plugins.tasks(path_or_task)
+          @path = task[:path]
         end
         self.instance_eval(File.read(@path), @path) if @path
       end

data/spec/{automaton → auto}/plugins_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
 
-module Automaton
-  describe Automaton::Plugins do
+module Auto
+  describe Auto::Plugins do
     
     before(:all) do
       Plugins.add @fixtures = "#{SPEC}/plugins"
@@ -15,27 +15,27 @@ module Automaton
     
     it "should provide an array of plugin library files" do
       @libraries.should == [
-        "#{@fixtures}/automaton-plugin2/lib/plugin2.rb",
-        "#{@fixtures}/user-automaton-plugin-0.0.0/lib/plugin.rb"
+        "#{@fixtures}/auto-plugin-0.0.0/lib/plugin.rb",
+        "#{@fixtures}/auto-plugin2/lib/plugin2.rb"
       ]
     end
     
     it "should provide an array of module strings" do
-      @modules.should == [ 'Plugin2', 'Plugin' ]
+      @modules.should == [ 'Plugin', 'Plugin2' ]
     end
     
     it "should provide a hash of plugin task information" do
       @tasks.should == [
         {
-          :path => "#{@fixtures}/user-automaton-plugin-0.0.0/auto/plugin/task.rb",
+          :path => "#{@fixtures}/auto-plugin-0.0.0/.auto/plugin/task.rb",
           :name => "plugin:task"
         },
         {
-          :path => "#{@fixtures}/automaton-plugin2/auto/plugin2/task.rb",
+          :path => "#{@fixtures}/auto-plugin2/.auto/plugin2/task.rb",
           :name => "plugin2:task"
         },
         {
-          :path => "#{@fixtures}/automaton-plugin2/auto/plugin2/task2.rb",
+          :path => "#{@fixtures}/auto-plugin2/.auto/plugin2/task2.rb",
           :name => "plugin2:task2"
         }
       ]

data/spec/{automaton → auto}/runner_spec.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
 
-module Automaton
-  describe Automaton::Runner do
+module Auto
+  describe Auto::Runner do
 
     before(:all) do
       Plugins.add @fixtures = "#{SPEC}/plugins"
@@ -9,8 +9,8 @@ module Automaton
     end
 
     it 'should require plugin library files' do
-      $".include?("#{@fixtures}/user-automaton-plugin-0.0.0/lib/plugin.rb").should == true
-      $".include?("#{@fixtures}/automaton-plugin2/lib/plugin2.rb").should == true
+      $".include?("#{@fixtures}/auto-plugin-0.0.0/lib/plugin.rb").should == true
+      $".include?("#{@fixtures}/auto-plugin2/lib/plugin2.rb").should == true
     end
 
     it 'should include all plugin library modules' do

data/spec/plugins/{user-automaton-plugin-0.0.0 → auto-plugin-0.0.0}/lib/plugin.rb

@@ -1,4 +1,4 @@
-module Automaton
+module Auto
   module Plugin
     def plugin
       true

data/spec/plugins/{automaton-plugin2 → auto-plugin2}/lib/plugin2.rb

@@ -1,4 +1,4 @@
-module Automaton
+module Auto
   module Plugin2
     def plugin2
       true

data/spec/spec_helper.rb

@@ -1,15 +1,16 @@
-$TESTING=true
+$testing = true
 SPEC = File.dirname(__FILE__)
 $:.unshift File.expand_path("#{SPEC}/../lib")
 
-require 'automaton/require'
+require 'auto/require'
 require 'pp'
 
 Spec::Runner.configure do |config|
 end
 
+# For use with rspec textmate bundle
 def debug(object)
   puts "<pre>"
   puts object.pretty_inspect.gsub('<', '&lt;').gsub('>', '&gt;')
   puts "</pre>"
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: auto
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Winton Welsh
@@ -9,10 +9,19 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-06 00:00:00 -08:00
+date: 2009-11-15 00:00:00 -08:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: auto-terminal
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.0.1
+    version: 
 description: 
 email: mail@wintoni.us
 executables: []
@@ -22,28 +31,25 @@ extensions: []
 extra_rdoc_files: 
 - README.markdown
 files: 
-- config/externals.yml
-- lib/automaton/alias.rb
-- lib/automaton/class.rb
-- lib/automaton/plugins.rb
-- lib/automaton/require.rb
-- lib/automaton/runner.rb
-- lib/automaton/string.rb
-- lib/automaton.rb
+- gemspec.rb
+- lib/auto/alias.rb
+- lib/auto/class.rb
+- lib/auto/plugins.rb
+- lib/auto/require.rb
+- lib/auto/runner.rb
+- lib/auto/string.rb
+- lib/auto.rb
 - MIT-LICENSE
 - Rakefile
 - README.markdown
-- spec/automaton/plugins_spec.rb
-- spec/automaton/runner_spec.rb
-- spec/plugins/automaton-plugin2/auto/plugin2/task.rb
-- spec/plugins/automaton-plugin2/auto/plugin2/task2.rb
-- spec/plugins/automaton-plugin2/lib/plugin2.rb
-- spec/plugins/user-automaton-plugin-0.0.0/auto/plugin/task.rb
-- spec/plugins/user-automaton-plugin-0.0.0/lib/plugin.rb
+- spec/auto/plugins_spec.rb
+- spec/auto/runner_spec.rb
+- spec/plugins/auto-plugin-0.0.0/lib/plugin.rb
+- spec/plugins/auto-plugin2/lib/plugin2.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: http://github.com/winton/automaton
+homepage: http://github.com/winton/auto
 licenses: []
 
 post_install_message: 

data/config/externals.yml

@@ -1,6 +0,0 @@
-automaton-questions:
-  repo: git@github.com:winton/automaton-questions.git
-  path: vendor/plugins
-automaton-terminal:
-  repo: git@github.com:winton/automaton-terminal.git
-  path: vendor/plugins

data/lib/automaton.rb

@@ -1,8 +0,0 @@
-require File.dirname(__FILE__) + "/automaton/require"
-
-module Automaton
-  Runner.new do
-    terminal($0)
-  end
-  exit
-end