nake 0.0.7 → 0.0.8.pre

data/CHANGELOG

@@ -29,3 +29,20 @@
 
 = Version 0.0.7
   * Added Task#boot method for setting some stuff after other tasks boot
+  * Added DSL helper desc
+  * Removed task aliases
+
+= Version 0.0.8
+  * Added Nake::Template & template helper
+  * Added Nake::ErbTemplate & erb helper
+  * Added bin/snake for system-wide tasks
+  * Added AbstractTask base class
+  * Exit with the status of the spec command to help CI stuff out some
+  * "nake --H build" can provide more informations about given task
+  * Task.description can use %{foo} and it will be replaced by values from its config hash
+  * Task.description can be a callable object
+
+= Version 0.0.9
+  * Thanks to Task#config=, the configuration can be shared between multiple tasks
+  * Reworked rule, added Rule class
+  * Added --coloring & --no-coloring options

data/README.textile

@@ -8,7 +8,7 @@ Sounds terrible? Well and it's not all! Let's take a look at this "example":http
 
 h1. Features
 
-- Tasks can have a *name*, *description*, *dependencies*, *aliases* and *blocks* which will be executed when the task is called. Task can be also hidden if you don't want to list it in the list of available tasks.
+- Tasks can have a *name*, *description*, *dependencies*, and *blocks* which will be executed when the task is called. Task can be also hidden if you don't want to list it in the list of available tasks.
 - You can use `nake` in *shebang*, so you can use your file with tasks as a runner.
 - *Arguments parsing*, everything what start with @--@ will be passed into options hash and everything other will be treated as an arguments. Both arguments and options will be passed as a block arguments for task, so you don't have to learn any new API, just use normal Ruby expressions as you are used to. Options are parsed into Ruby data types, so if you have @--without-mysql@, you'll get @{mysql: false}@, if you have @--name=botanicus@, you'll get @{name: "botanicus"}@ etc.
 - *Configuration support*, so you don't have to use bunch of constants as in Rake. Example: @Task[:clean].config[:files] = Dir.glob("*.gem")@
@@ -16,48 +16,24 @@ h1. Features
 - Two level of API for defining tasks. @task@ helper is useful for defining simple tasks and if you need something more complicated, you can use @Task.new@
 - *Interactive session* if you run @nake -i@ or @nake -i task@ you get an interactive nake session.
 
-h1. Usage
-
-First of all there is a bunch of "examples":github.com/botanicus/nake/tree/master/examples, so you can try them. All these scripts are executable, so just run @./executable/basic.rb -T@ and that's it!
-
-h1. Documentation
-
-h2. Tasks
-
-h3. Options parsing
-
-h2. File Tasks
-
-h2. Task Helpers
-
-h2. Available Tasks
+h1. Installation
 
-h3. Built-in Tasks
+_Before installation, please ensure that you are running on Ruby 1.9 or higher, Ruby 1.8 isn't supported!_
 
-- @-T@
-- @-H@
-- @-i@
+* From Gemcutter: @gem install nake@
+* JRuby: @jruby --1.9 -S gem install nake@
+* Install edge version via "Rip":http://hellorip.com: @rip install git://github.com/botanicus/nake.git@
+* Install tagged version via "Rip":http://hellorip.com: @rip install git://github.com/botanicus/nake.git 0.1@
 
-h3. File @nake/tasks/bundle@
-
-This file contains only @bundle@ task which will load bundler @--no-cached@
-
-h3. File @nake/tasks/clean@
-
-h3. File @nake/tasks/gem@
-
-h3. File @nake/tasks/release@
-
-h3. File @nake/tasks/rip@
+h1. Usage
 
-h3. File @nake/tasks/spec@
+First of all there is a bunch of "examples":github.com/botanicus/nake/tree/master/examples, so you can try them. All these scripts are executable, so just run @./executable/basic.rb -T@ and that's it!
 
 h1. Links
 
+* "Nake Wiki":http://wiki.github.com/botanicus/nake
 * "RDoc.info API Docs":http://rdoc.info/projects/botanicus/nake
 * "Yardoc.org API Docs":http://yardoc.org/docs/botanicus-nake
 * "Examples":http://github.com/botanicus/nake/tree/master/examples
 * "Bug reporting":http://github.com/botanicus/nake/issues
 * "Caliper Code Metrics":http://devver.net/caliper/project?repo=git%3A%2F%2Fgithub.com%2Fbotanicus%2Fnake.git
-
-* http://github.com/botanicus/filelist

data/TODO.txt

@@ -1,5 +1,22 @@
-- Task#setup
+=== 0.1 ===
+- README
+- update examples
+- features
+
+- rework rule
+- check if everything works
+- specs
+- update benchmarks
 - yardoc
-- specs & features
-- better argv parsing maybe, task(:spec) do |*paths, options| is fine, but task(:spec) do |path, options| will fail if no path specified ... but actually task(:spec) do |path = "spec", options| might be fine, try it ... BTW task(["-i", "--interactive"]) do |task, *args, options| doesn't work ... putting options as a first argument should solve everything, but it's not very intuitive :/
-- how to solve args inheriting (like if we have task release which depends on task build which takes a gemspec as an argument)
+- refactor bin/nake
+
+=== 0.2 ===
+Task.new(:test) do |task|
+  task.options[:optional] = [:force] # maybe {force: :boolean}
+  task.options[:required] = [:name]
+end
+=> better -T list + validations
+
+=== 0.3 ===
+- nrake & nake/rake for running rake tasks in nake
+- rake2nake

data/bin/nake

@@ -61,3 +61,6 @@ rescue SystemExit => exception
 rescue Exception => exception
   print_exception_with_backtrace_and_abort(exception)
 end
+
+# exit with exit status of the last command
+exit $? ? $?.exitstatus : 0

data/bin/nrake

@@ -0,0 +1,4 @@
+#!/usr/bin/env nake
+
+# Run rake tasks with nake
+require "nake/rake"

data/bin/rake2nake

@@ -0,0 +1 @@
+#!/usr/bin/env ruby

data/bin/snake

@@ -0,0 +1,41 @@
+#!/usr/bin/env nake
+
+# Snake is similar to sake http://www.rubyinside.com/sake-system-wide-rake-tasks-543.html
+
+# tasks
+
+# snake get db_tasks.rb
+# snake get http://gist.github.com/raw/266818/7239049c59b32d07a8af7e26f89190b61e0a7860/snake.rb
+Task.new(:get) do |task|
+  task.description = "Add tasks from given file or URL to your %{task_file}"
+
+  task.define do |path|
+    require "open-uri"
+    begin
+      open(path) do |stream|
+        File.open(self.config[:task_file], "a") do |file|
+          file.puts(stream.read, "")
+        end
+      end
+    rescue Exception => exception
+      abort exception.message
+    end
+  end
+end
+
+Task.new(:edit) do |task|
+  task.config = Task[:get].config
+  task.description = "Edit %{task_file} in your editor"
+
+  task.define do
+    exec((ENV["EDITOR"] || "vim"), task.config[:task_file])
+  end
+end
+
+# setup
+Task[:get].config[:task_file] = File.expand_path("~/.tasks.rb")
+
+# run
+if File.exist?(Task[:get].config[:task_file])
+  load Task[:get].config[:task_file]
+end

data/bm/Rakefile

@@ -0,0 +1,28 @@
+desc "Simple task"
+task :simple do
+  puts "Hello World!"
+end
+
+desc "Namespaced task"
+task "a:b:c:d:e:f:g:h:i:j:k:l:m:n:o:p:q:r:s:t:u:v:w:x:y:z" do
+  # do nothing
+end
+
+desc "Task with arguments"
+task :arguments
+
+desc "Task with dependencies"
+task :dependencies
+
+directory "tmp/www"
+
+desc "Generate tmp/www/index.html"
+file "tmp/www/index.html" => "tmp/www" do |task|
+  File.open(task.name, "w") do |file|
+    file.puts("<html>Hello World!</html>")
+  end
+end
+
+rule ".o" => [".c"] do |task|
+  sh "gcc #{task.source} -c -o #{task.name}"
+end

data/bm/bms.rb

@@ -10,13 +10,47 @@ nake = "./bin/nake"
 abort "You have to install Rake!" if rake.empty?
 puts "Using nake from #{nake} and rake from #{rake}\n\n"
 
+def run(command)
+  system("#{command} &> /dev/null") || abort("Problem during running #{command}")
+end
+
 # Make sure you are running both Rake and Nake on the same Ruby version!
 RBench.run(10) do
   column :rake
   column :nake
 
   report "list tasks" do
-    rake { system("#{rake} -T &> /dev/null") || abort("Problem during running #{rake} -T") }
-    nake { system("#{nake} -T &> /dev/null") || abort("Problem during running #{nake} -T") }
+    rake { run "#{rake} -T" }
+    nake { run "#{nake} -T" }
+  end
+
+  report "simple task" do
+    rake { run "#{rake} simple" }
+    nake { run "#{nake} simple" }
+  end
+
+  report "namespaced task" do
+    rake { run "#{rake} a:b:c:d:e:f:g:h:i:j:k:l:m:n:o:p:q:r:s:t:u:v:w:x:y:z" }
+    nake { run "#{nake} a:b:c:d:e:f:g:h:i:j:k:l:m:n:o:p:q:r:s:t:u:v:w:x:y:z" }
   end
+
+  #report "task with arguments" do
+  #  rake { run "#{rake} arguments" }
+  #  nake { run "#{nake} arguments" }
+  #end
+  #
+  #report "task with dependencies" do
+  #  rake { run "#{rake} dependencies" }
+  #  nake { run "#{nake} dependencies" }
+  #end
+
+  report "file task" do
+    rake { run "#{rake} tmp/www/index.html" }
+    nake { run "#{nake} tmp/www/index.html" }
+  end
+
+  #report "rule" do
+  #  rake { run "#{rake} tmp/test.o" }
+  #  nake { run "#{nake} tmp/test.o" }
+  #end
 end

data/bm/tasks.rb

@@ -0,0 +1,21 @@
+#!../bin/nake
+
+task :simple do
+  puts "Hello World!"
+end
+
+task "a:b:c:d:e:f:g:h:i:j:k:l:m:n:o:p:q:r:s:t:u:v:w:x:y:z" do
+  # do nothing
+end
+
+directory "tmp/www"
+
+file "tmp/www/index.html", "tmp/www" do |path|
+  File.open(path, "w") do |file|
+    file.puts("<html>Hello World!</html>")
+  end
+end
+
+#rule ".o" => [".c"] do |task|
+#  sh "gcc #{task.source} -c -o #{task.name}"
+#end

data/deps.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env rip install
+
+# Syntax:
+# repository [tag or commit to install]
+git://github.com/flori/term-ansicolor

data/deps.rip

@@ -0,0 +1,5 @@
+#!/usr/bin/env rip install
+
+# Syntax:
+# repository [tag or commit to install]
+git://github.com/flori/term-ansicolor

data/examples/description.rb

@@ -0,0 +1,33 @@
+desc :release, "Create a new release"
+task(:release) do
+  # ...
+end
+
+task = task(:release) do
+  # ...
+end
+task.description = "Create a new release"
+
+task(:release) do
+  # ...
+end
+Task[:release].description = "Create a new release"
+
+task = task(:release)
+task.description = "Create a new release"
+task.define do
+  # ...
+end
+
+task(:release)
+Task[:release].description = "Create a new release"
+task(:release) do
+  # ...
+end
+
+Task.new(:release) do |task|
+  task.description = "Create a new release"
+  task.define do
+    # ...
+  end
+end

data/lib/nake.rb

@@ -1,9 +1,7 @@
 # encoding: utf-8
 
-require "nake/task"
-
 module Nake
-  VERSION ||= "0.0.7"
+  VERSION ||= "0.0.8"
   def self.verbose
     @@verbose
   rescue NameError
@@ -24,6 +22,16 @@ module Nake
     @@debug = boolean
   end
 
+  def self.coloring
+    @@coloring
+  rescue NameError
+    @@coloring = STDIN.tty?
+  end
+
+  def self.coloring=(boolean)
+    @@coloring = boolean
+  end
+
   # I was drunk so you might found this code not very clear. But it's clear for me and it works.
   def self.args
     @@args ||= begin
@@ -92,5 +100,4 @@ module Nake
   end
 end
 
-require "nake/dsl"
-require "nake/helpers"
+require "nake/task"

data/lib/nake/abstract_task.rb

@@ -0,0 +1,175 @@
+# encoding: utf-8
+
+require "nake/colors"
+require "nake/argv"
+
+module Nake
+  TaskNotFound ||= Class.new(StandardError)
+  ConfigurationError ||= Class.new(StandardError)
+
+  class AbstractTask
+    def self.[](name)
+      self.tasks[name.to_s]
+    end
+
+    def self.[]=(name, task)
+      self.tasks[name.to_s] = task
+    end
+
+    # @protected use Task[name] resp. Task[name] = task
+    def self.tasks
+      @@tasks ||= Hash.new
+    end
+
+    def self.boot
+      self.tasks.each do |name, task|
+        task.boot!
+      end
+    end
+
+    # return existing task if task with given name already exist
+    def self.new(name, *dependencies, &block)
+      task = self[name]
+      task && task.setup(*dependencies, &block) || super(name, *dependencies, &block)
+    end
+
+    attr_accessor :name, :dependencies, :hidden, :original_args
+    attr_reader :blocks
+    def initialize(name, *dependencies, &block)
+      @hidden = false
+      @name, @blocks = name.to_sym, Array.new
+      @dependencies  = Array.new
+      self.register
+      self.setup(*dependencies, &block)
+    end
+
+    attr_writer :description
+    def description
+      if @description.respond_to?(:call)
+        # task.description = lambda { "Edit #{self.config[:task_file]}" }
+        @description.call
+      elsif @description
+        # task.description = "Edit %{task_file}"
+        @description % self.config
+      else
+        nil
+      end
+    end
+
+    attr_writer :config # don't use this if you don't have to!
+    def config
+      @config ||= begin
+        Hash.new do |hash, key|
+          raise ConfigurationError, "Configuration key #{key} in task #{name} doesn't exist"
+        end.tap do |hash|
+          hash.define_singleton_method(:declare) do |*keys|
+            keys.each { |key| self[key] = nil unless self.has_key?(key) }
+          end
+        end
+      end
+    end
+
+    def setup(*dependencies, &block)
+      self.dependencies.push(*dependencies)
+      self.instance_exec(self, &block) if block
+      return self
+    end
+
+    def define(&block)
+      @blocks.push(block)
+    end
+
+    def hidden?
+      @hidden
+    end
+
+    def run(args)
+      self.original_args = args
+      options = ArgvParser.extract!(args)
+      self.call(args, options)
+    end
+
+    # NOTE: the reason why we don't have splat for args is that when we have Task["-T"]
+    # which doesn't have any args and options, we wall just call it without any arguments,
+    # but when we use splat, then we will have to call it at least with Hash.new for options
+    def call(args = Array.new, options = Hash.new)
+      unless self.dependencies.empty?
+        info "Invoking task #{name}"
+        self.invoke_dependencies(*args, options)
+      end
+      unless self.blocks.empty?
+        note "Executing task #{name} with arguments #{args.inspect} and options #{options.inspect}"
+        debug "Config #{self.config.inspect}"
+        self.blocks.each do |block|
+          block.call(*args, options)
+        end
+        ## we can't use arity, because it returns 0 for lambda { |options = Hash.new| }.arity
+        ## if we define method with one optional argument, it will returns -1
+        #
+        ## better argv parsing maybe, task(:spec) do |*paths, options| is fine, but task(:spec) do |path, options| will fail if no path specified ... but actually task(:spec) do |path = "spec", options| might be fine, try it ... BTW task(["-i", "--interactive"]) do |task, *args, options| doesn't work ... putting options as a first argument should solve everything, but it's not very intuitive :/
+        #if RUBY_VERSION >= "1.9.2"
+        #  raise ArgumentError, "Task can't take block arguments" if args.length + 1 > block.parameters.select { |type, name| type.eql?(:req) || type.eql?(:opt) }.length
+        #  raise ArgumentError, "Task can't take block arguments" if block.parameters.any? { |type, name| type.eql?(:block) }
+        #end
+        #
+        #if RUBY_VERSION >= "1.9.2" && block.parameters.empty?
+        #  block.call
+        #else
+        #  block.call(*args, options)
+        #end
+      end
+    end
+
+    def bootloaders
+      @bootloaders ||= Array.new
+    end
+
+    def boot_dependencies
+      @boot_dependencies ||= Array.new
+    end
+
+    def boot(*dependencies, &block)
+      self.boot_dependencies.push(*dependencies)
+      self.bootloaders.push(block)
+    end
+
+    def boot!
+      unless self.boot_dependencies.empty? && self.bootloaders.empty?
+        note "Booting #{self.name}"
+      end
+      while dependency = self.boot_dependencies.shift
+        self.class[dependency].tap do |task|
+          if task.nil?
+            raise TaskNotFound, "Task #{dependency} doesn't exist!"
+          end
+          task.boot!
+        end
+      end
+      while block = self.bootloaders.shift
+        block.call
+      end
+    end
+
+    def booted?
+      self.bootloaders.empty? && self.boot_dependencies.empty?
+    end
+
+    def reset!
+      self.dependencies.clear
+      self.blocks.clear
+    end
+
+    protected
+    def invoke_dependencies(*args, options)
+      self.dependencies.each do |name|
+        task = self.class[name]
+        raise TaskNotFound, "Task with name #{name} doesn't exist" if task.nil?
+        task.call(*args, options) # TODO: what about arguments?
+      end
+    end
+
+    def register
+      self.class[self.name] = self
+    end
+  end
+end