wizard 0.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.rdb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# v0.0.1 (Prof of concept)
+
+* Common heleprs 
+* Generator (supporting actions: touch, mkfile, mkdir, compile, cp, append, 
+  prepend, inject)

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "wizard"
+    gem.summary = %Q{Projects generator and recipes compiler.}
+    gem.description = <<-DESCR
+      Projects generator...
+    DESCR
+    gem.email = "chris@nu7hat.ch"
+    gem.homepage = "http://github.com/nu7hatch/wizard"
+    gem.authors = ["Kriss 'nu7hatch' Kowalik"]
+    gem.add_development_dependency "rspec", "~> 2.0"
+    gem.add_development_dependency "mocha", "~> 0.9"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = %q[--colour --backtrace]
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov = true
+  t.rspec_opts = %q[--colour --backtrace]
+  t.rcov_opts = %q[--exclude "spec" --text-report]
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Wizard #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/wizard.rb

@@ -0,0 +1,12 @@
+require 'fileutils'
+
+module Wizard
+
+  require 'wizard/helpers'
+
+  extend Helpers
+
+  require 'wizard/formula'
+  require 'wizard/spells'
+
+end # Wizard

data/lib/wizard/formula.rb

@@ -0,0 +1,23 @@
+module Wizard
+  class Formula
+  
+    include Helpers
+  
+    COLORIZERS = {
+      :success => :green,
+      :error   => :red,
+    }
+    
+    def self.colorizers
+      COLORIZERS
+    end
+  
+    def render(spell)
+      line = " "
+      line += a(spell.to_s, console_width-spell.status.to_s.size-3) + " " 
+      line += c(spell.status.to_s, self.class.colorizers[spell.status], true)
+      say! line
+    end
+    
+  end # Formula
+end # Ryori

data/lib/wizard/helpers.rb

@@ -0,0 +1,63 @@
+module Wizard
+  module Helpers
+  
+    COLORS = {
+      :black  => 30,
+      :red    => 31,
+      :green  => 32,
+      :yellow => 33,
+      :blue   => 34,
+      :purple => 35,
+      :cyan   => 36,
+      :white  => 37,
+    }
+    
+    # Display colorized output (no new line at the end).
+    def say(text, color=nil, bold=false)
+      print(color ? colorize(text, color, bold) : text)
+    end
+    
+    # Writes given text to <tt>$stdout</tt>.
+    def print(*args)
+      res = $stdout.write(*args)
+      $stdout.flush
+      return res
+    end
+    
+    # Display colorized output. 
+    def say!(text, color=nil, bold=false)
+      say(text+"\n", color, bold)
+    end
+    
+    # Colorize specified text with given color. 
+    def colorize(text, color=:white, bold=false)
+      color = COLORS[color] || COLORS[:white]
+      return "\e[#{bold ? 1 : 0};#{color}m#{text}\e[0m"
+    end
+    alias :c :colorize
+    
+    # Display given text adjusted to the desired length.
+    #
+    #   adjust("This", 30, "-")
+    #   adjust("is", 30, "-")
+    #   adjust("SPARTA!", 30, "-")
+    #
+    # will produce:
+    #
+    #   This -------------------------
+    #   is ---------------------------
+    #   SPARTA! ----------------------
+    def adjust(text, size=nil, delim=".")
+      size ||= console_width
+      delims = size-text.size
+      delims > 0 ? text+" "+(c(delim*(delims-1), :black)) : text 
+    end
+    alias :a :adjust
+    
+    # Returns actual width of console line. 
+    def console_width
+      `stty size`.split.last.to_i
+    end
+    
+  end # Helpers
+end # Wizard

data/lib/wizard/spells.rb

@@ -0,0 +1,12 @@
+module Wizard
+  module Spells
+  
+    require "wizard/spells/base"
+    require "wizard/spells/make_dir"
+    require "wizard/spells/make_file"
+    require "wizard/spells/update_file"
+    require "wizard/spells/compile_template"
+    require "wizard/spells/execute_shell"
+    
+  end # Spells
+end # Wizard

data/lib/wizard/spells/base.rb

@@ -0,0 +1,84 @@
+module Wizard
+  module Spells
+    class Base
+
+      include Helpers
+
+      class << self
+        # Should all actions be performed in force mode?
+        def all_forced?
+          defined?(@@force_all) and !!@@force_all
+        end
+        
+        # Set force mode for all apps. 
+        # XXX. deadlocks can raise here. 
+        def force_all!
+          @@force_all = true
+        end
+        
+        # Creates shortcuts for given statuses:
+        #
+        #   attr_status :my_status
+        #
+        # will produce methods:
+        #
+        #   my_status! # => status!(:my_status)
+        #   my_status? # => status?(:my_status)
+        #
+        def attr_status(*statuses)
+          statuses.each do |status|
+            define_method("#{status}!".to_sym) { status!(status.to_sym) }
+            define_method("#{status}?".to_sym) { status?(status.to_sym) }
+            protected "#{status}!".to_sym
+          end
+        end
+      end
+      
+      # Shortcuts for the most commonly used statuses. We are creating 
+      # <tt>success</tt> and <tt>error</tt> shortcuts by default. 
+      attr_status :success, :error
+      
+      # Returns status of currently performed operation. 
+      def status
+        @status
+      end
+      
+      # Returns +true+ when actual status equals the given one.
+      #
+      #   status!(:success)
+      #   status?(:success) # => true
+      #   status?(:error)   # => false
+      #
+      def status?(status)
+        self.status == status.to_sym
+      end
+      
+      # Should be forced performing of current action?
+      def forced?
+        @force || self.class.all_forced?
+      end
+      
+      # See Ryori::Makers::Base.force_all! for details.
+      def force_all!
+        self.class.force_all!
+      end
+      
+      # Set force mode for current action.
+      def force!
+        @force = true
+      end
+      
+      protected
+
+      # Set given status for actual operation.
+      #
+      #   status!(:success)
+      #   status!(:error)
+      #
+      def status!(status)
+        @status = status.to_sym
+      end
+      
+    end # Base
+  end # Spells
+end # Wizard

data/lib/wizard/spells/compile_template.rb

@@ -0,0 +1,27 @@
+require 'wizard/spells/make_file'
+require 'erb'
+
+module Wizard
+  module Spells
+    class CompileTemplate < MakeFile
+    
+      attr_reader :template
+    
+      def initialize(filename, template, options={})
+        super(filename, nil, options)
+        @template = template
+      end
+    
+      def perform_with_template_compilation
+        @content = ERB.new(File.read(template)).result(binding)
+        perform_without_template_compilation
+      rescue Object
+        error!
+      end
+      
+      alias_method :perform_without_template_compilation, :perform
+      alias_method :perform, :perform_with_template_compilation
+      
+    end # CompileTemplate
+  end # Spells
+end # Wizard

data/lib/wizard/spells/execute_shell.rb

@@ -0,0 +1,22 @@
+module Wizard
+  module Spells
+    class ExecuteShell < Base
+    
+      attr_reader :command, :output
+      attr_status :executed, :failed
+      
+      def initialize(command, options={})
+        @command = command
+        @output = nil
+      end
+    
+      def perform
+        return executed! if @output = `#{command} 2>&1` and $?.exitstatus == 0
+        failed!
+      rescue Object
+        error!
+      end
+      
+    end # CompileTemplate
+  end # Spells
+end # Wizard

data/lib/wizard/spells/make_dir.rb

@@ -0,0 +1,47 @@
+module Wizard
+  class Formula
+    
+    colorizers.merge!(
+      :created  => :green,
+      :exist    => :cyan,
+      :noaccess => :red, 
+    )
+    
+    def make_dir(dirname, options={})
+      spell = Spells::MakeDir.new(dirname, options)
+      spell.perform
+      render(spell)
+    end
+    alias_method :dir, :make_dir
+    alias_method :directory, :make_dir
+    alias_method :mkdir, :make_dir
+    alias_method :create_dir, :make_dir
+    
+  end # Formula
+
+  module Spells
+    class MakeDir < Base
+    
+      attr_reader :dirname, :chmod
+      attr_status :created, :exist, :noaccess
+    
+      def initialize(dirname, options={})
+        @dirname = dirname
+        @chmod   = options[:mode]
+      end
+    
+      def perform
+        return exist!   if File.exist?(dirname)
+        return created! if FileUtils.mkdir_p(dirname, :mode => chmod) == dirname
+        error!
+      rescue Errno::EACCES
+        noaccess!
+      rescue Object
+        error!
+      end
+      
+      alias_method :to_s, :dirname
+      
+    end # MakeDir
+  end # Spells
+end # Wizard

data/lib/wizard/spells/make_file.rb

@@ -0,0 +1,69 @@
+module Wizard
+  class Formula
+    
+    colorizers.merge!(
+      :created   => :green,
+      :noaccess  => :red,
+      :identical => :cyan,
+      :conflict  => :yellow,
+      :updated   => :green,
+      :skipped   => :yellow
+    )
+    
+    def make_file(filename, content=nil, options={})
+      spell = Spells::MakeFile.new(filename, content, options)
+      spell.perform
+      render(spell)
+    end
+    alias_method :file, :make_file
+    alias_method :mkfile, :make_file
+    alias_method :create_file, :make_file
+    
+  end # Formula
+
+  module Spells
+    class MakeFile < Base
+    
+      attr_reader :filename, :chmod, :content
+      attr_status :created, :noaccess, :identical, :conflict, :updated, :skipped
+    
+      def initialize(filename, content=nil, options={})
+        @filename = filename
+        @content  = content 
+        @chmod    = options[:mode]
+        
+        force! if options[:force]
+      end
+    
+      def perform
+        if File.exist?(filename)
+          return identical! if identical_content?
+          return status     if conflict! and !forced?
+        end
+        return conflict? ? updated! : created! if create_file!
+        error!
+      rescue Errno::EACCES
+        noaccess!
+      rescue Object
+        error!
+      end
+      
+      # Create current performed file, write its content and set proper chmod. 
+      def create_file!
+        if File.open(filename, "w+") {|f| f.write(content) if content }
+          FileUtils.chmod(chmod, filename) if chmod
+          return true
+        end
+      end
+      
+      # Returns +true+ when current file already exists and have the same 
+      # content as given in initializer.  
+      def identical_content?
+        File.read(filename) == content
+      end
+      
+      alias_method :to_s, :filename
+      
+    end # MakeFile
+  end # Spells
+end # Wizard