auto 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2009 Winton Welsh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of 
+this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 
+the Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,35 @@
+Automaton
+=========
+
+Automate everything!
+
+Notice
+------
+
+This gem is in development. Functionality updates will show up in this file.
+
+Goals
+-----
+
+* 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
+
+Install
+-------
+
+<pre>
+gem sources -a http://gems.github.com
+sudo gem install winton-automaton
+</pre>

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+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
+end
+
+desc "Install gem"
+task :install do
+  Rake::Task['gem'].invoke
+  `sudo gem uninstall #{GEM_NAME} -x`
+  `sudo gem install pkg/#{GEM_NAME}*.gem`
+  `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)
+  end
+end
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.rcov = true
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/config/externals.yml

@@ -0,0 +1,6 @@
+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

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

data/lib/automaton/alias.rb

@@ -0,0 +1,44 @@
+class Module
+  
+  # Encapsulates the common pattern of:
+  #
+  #   alias_method :foo_without_feature, :foo
+  #   alias_method :foo, :foo_with_feature
+  #
+  # With this, you simply do:
+  #
+  #   alias_method_chain :foo, :feature
+  #
+  # And both aliases are set up for you.
+  #
+  # Query and bang methods (foo?, foo!) keep the same punctuation:
+  #
+  #   alias_method_chain :foo?, :feature
+  #
+  # is equivalent to
+  #
+  #   alias_method :foo_without_feature?, :foo?
+  #   alias_method :foo?, :foo_with_feature?
+  #
+  # so you can safely chain foo, foo?, and foo! with the same feature.
+  def alias_method_chain(target, feature)
+    # Strip out punctuation on predicates or bang methods since
+    # e.g. target?_without_feature is not a valid method name.
+    aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
+    yield(aliased_target, punctuation) if block_given?
+
+    with_method, without_method = "#{aliased_target}_with_#{feature}#{punctuation}", "#{aliased_target}_without_#{feature}#{punctuation}"
+
+    alias_method without_method, target
+    alias_method target, with_method
+
+    case
+      when public_method_defined?(without_method)
+        public target
+      when protected_method_defined?(without_method)
+        protected target
+      when private_method_defined?(without_method)
+        private target
+    end
+  end
+end

data/lib/automaton/class.rb

@@ -0,0 +1,46 @@
+class Class
+  
+  def cattr_reader(*syms)
+    syms.flatten.each do |sym|
+      next if sym.is_a?(Hash)
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}  # unless defined? @@hair_colors
+          @@#{sym} = nil          #   @@hair_colors = nil
+        end                       # end
+                                  #
+        def self.#{sym}           # def self.hair_colors
+          @@#{sym}                #   @@hair_colors
+        end                       # end
+                                  #
+        def #{sym}                # def hair_colors
+          @@#{sym}                #   @@hair_colors
+        end                       # end
+      EOS
+    end
+  end
+
+  def cattr_writer(*syms)
+    syms.flatten.each do |sym|
+      class_eval(<<-EOS, __FILE__, __LINE__)
+        unless defined? @@#{sym}                       # unless defined? @@hair_colors
+          @@#{sym} = nil                               #   @@hair_colors = nil
+        end                                            # end
+                                                       #
+        def self.#{sym}=(obj)                          # def self.hair_colors=(obj)
+          @@#{sym} = obj                               #   @@hair_colors = obj
+        end                                            # end
+                                                       #
+        #{"                                            #
+        def #{sym}=(obj)                               # def hair_colors=(obj)
+          @@#{sym} = obj                               #   @@hair_colors = obj
+        end                                            # end
+        "}
+      EOS
+    end
+  end
+
+  def cattr_accessor(*syms)
+    cattr_reader(*syms)
+    cattr_writer(*syms)
+  end
+end

data/lib/automaton/plugins.rb

@@ -0,0 +1,108 @@
+require 'rubygems'
+
+module Automaton
+  class Plugins
+    
+    @@directories = [
+      Gem.dir + "/gems",
+      "~/.auto",
+      "#{File.dirname(__FILE__)}/../../vendor/plugins"
+    ]
+    @@plugins = nil
+    
+    cattr_accessor :directories
+    
+    class <<self
+      
+      # Add a directory to the plugin load paths.
+      def add(path)
+        @@directories = [] if $TESTING
+        @@directories << path
+        @@directories.uniq!
+        @@plugins = nil
+      end
+      
+      # Returns an array of Plugin instances.
+      def plugins
+        return @@plugins if @@plugins
+        directories = @@directories.collect do |d|
+          File.expand_path("#{d}/*automaton-*/")
+        end
+        @@plugins = Dir[*directories].collect do |d|
+          Plugin.new(d)
+        end
+        @@plugins.compact!
+        @@plugins
+      end
+      
+      # Returns an array of library file paths.
+      def libraries
+        collector { |plugin| plugin.library }
+      end
+      
+      # Returns an array of modules.
+      def modules
+        collector { |plugin| plugin.module }
+      end
+      
+      # Returns a sorted array of hashes that describe tasks.
+      # Returns a specific task with an optional task parameter (string, 'task:name').
+      def tasks(task=nil)
+        if task
+          tasks.select { |t| t[:name] == task.downcase }.first
+        else
+          t = collector { |plugin| plugin.tasks }
+          t = t.flatten
+          t.sort do |a, b|
+            a[:name].gsub(':', '0') <=> b[:name].gsub(':', '0')
+          end
+        end
+      end
+      
+    private
+      
+      # A quick way to get an array of @@plugins attributes.
+      def collector(&block)
+        self.plugins.collect { |plugin| block.call(plugin) }.compact
+      end
+    end
+    
+    # Stores a plugin's name, library, and tasks.
+    class Plugin
+
+      attr_reader :name
+      attr_reader :library
+      attr_reader :module
+      attr_reader :tasks
+      
+      # Assigns attributes using a plugin directory path.
+      def initialize(directory)
+        name = File.basename(directory)
+        name = name.split('-')
+        
+        return nil unless name.include?('automaton')
+        @name = name[name.index('automaton') + 1]
+        
+        # ~/.auto/automaton-plugin/lib/plugin.rb
+        @library = "#{directory}/lib/#{@name}.rb"
+        @library = nil unless File.exists?(@library)
+        
+        # Automaton::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/", '')
+          {
+            :name => relative[0..-4].split('/').join(':').downcase,
+            :path => path
+          }
+        end
+      end
+    end
+  end
+end

data/lib/automaton/require.rb

@@ -0,0 +1,8 @@
+# By default, <tt>require 'automaton'</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"
+require File.dirname(__FILE__) + "/class"
+require File.dirname(__FILE__) + "/plugins"
+require File.dirname(__FILE__) + "/runner"
+require File.dirname(__FILE__) + "/string"

data/lib/automaton/runner.rb

@@ -0,0 +1,38 @@
+module Automaton
+  class Runner
+    
+    def initialize(path_or_task=nil, &block)
+      self.class.require!
+      run(path_or_task, &block)
+    end
+    
+    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)
+          @path = path_or_task
+        end
+        self.instance_eval(File.read(@path), @path) if @path
+      end
+      self
+    end
+    
+    class <<self
+
+      def require!
+        Plugins.plugins.each do |plugin|
+          if plugin.library
+            require plugin.library
+          end
+          begin
+            include eval(plugin.module)
+          rescue
+          end
+        end
+      end
+    end
+  end
+end

data/lib/automaton/string.rb

@@ -0,0 +1,12 @@
+class String
+  
+  def camelize
+    lower_case_and_underscored_word = self
+    first_letter_in_uppercase = true
+    if first_letter_in_uppercase
+      lower_case_and_underscored_word.to_s.gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    else
+      lower_case_and_underscored_word.first.downcase + lower_case_and_underscored_word.camelize[1..-1]
+    end
+  end
+end

data/spec/automaton/plugins_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+module Automaton
+  describe Automaton::Plugins do
+    
+    before(:all) do
+      Plugins.add @fixtures = "#{SPEC}/plugins"
+      @libraries = Plugins.libraries
+      @modules = Plugins.modules
+      @tasks = Plugins.tasks
+      # debug @libraries
+      # debug @modules
+      # debug @tasks
+    end
+    
+    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"
+      ]
+    end
+    
+    it "should provide an array of module strings" do
+      @modules.should == [ 'Plugin2', 'Plugin' ]
+    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",
+          :name => "plugin:task"
+        },
+        {
+          :path => "#{@fixtures}/automaton-plugin2/auto/plugin2/task.rb",
+          :name => "plugin2:task"
+        },
+        {
+          :path => "#{@fixtures}/automaton-plugin2/auto/plugin2/task2.rb",
+          :name => "plugin2:task2"
+        }
+      ]
+    end
+  end
+end

data/spec/automaton/runner_spec.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+module Automaton
+  describe Automaton::Runner do
+
+    before(:all) do
+      Plugins.add @fixtures = "#{SPEC}/plugins"
+      @runner = Runner.new
+    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
+    end
+
+    it 'should include all plugin library modules' do
+      @runner.public_methods.include?('plugin').should == true
+      @runner.public_methods.include?('plugin2').should == true
+    end
+  end
+end

data/spec/plugins/automaton-plugin2/lib/plugin2.rb

@@ -0,0 +1,7 @@
+module Automaton
+  module Plugin2
+    def plugin2
+      true
+    end
+  end
+end

data/spec/plugins/user-automaton-plugin-0.0.0/lib/plugin.rb

@@ -0,0 +1,7 @@
+module Automaton
+  module Plugin
+    def plugin
+      true
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: auto
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Winton Welsh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-06 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mail@wintoni.us
+executables: []
+
+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
+- 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/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/winton/automaton
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Automate everything!
+test_files: []
+