RubyGems - bahuvrihi-tap - Versions diffs - 0.10.7 → 0.10.8 - Mend

bahuvrihi-tap 0.10.7 → 0.10.8

Files changed (90) hide show

data/MIT-LICENSE +0 -2
data/README +20 -31
data/bin/rap +18 -8
data/cgi/run.rb +47 -37
data/cmd/console.rb +1 -1
data/cmd/destroy.rb +3 -3
data/cmd/generate.rb +3 -3
data/cmd/manifest.rb +61 -53
data/cmd/run.rb +1 -1
data/doc/Class Reference +119 -110
data/doc/Command Reference +76 -123
data/doc/Syntax Reference +290 -0
data/doc/Tutorial +307 -237
data/lib/tap.rb +1 -12
data/lib/tap/app.rb +46 -71
data/lib/tap/constants.rb +1 -1
data/lib/tap/declarations.rb +110 -100
data/lib/tap/env.rb +141 -173
data/lib/tap/exe.rb +5 -5
data/lib/tap/file_task.rb +2 -2
data/lib/tap/generator/base.rb +0 -4
data/lib/tap/generator/destroy.rb +8 -12
data/lib/tap/generator/generate.rb +19 -14
data/lib/tap/generator/generators/command/command_generator.rb +1 -1
data/lib/tap/generator/generators/config/config_generator.rb +3 -3
data/lib/tap/generator/generators/file_task/file_task_generator.rb +1 -1
data/lib/tap/generator/generators/generator/generator_generator.rb +27 -0
data/lib/tap/generator/generators/generator/templates/task.erb +27 -0
data/lib/tap/generator/generators/root/root_generator.rb +12 -12
data/lib/tap/generator/generators/root/templates/Rakefile +1 -2
data/lib/tap/generator/generators/root/templates/tapfile +11 -8
data/lib/tap/generator/generators/task/task_generator.rb +1 -3
data/lib/tap/generator/generators/task/templates/test.erb +1 -3
data/lib/tap/root.rb +4 -2
data/lib/tap/support/aggregator.rb +16 -3
data/lib/tap/support/assignments.rb +10 -9
data/lib/tap/support/audit.rb +58 -62
data/lib/tap/support/class_configuration.rb +32 -43
data/lib/tap/support/combinator.rb +7 -7
data/lib/tap/support/configurable.rb +13 -14
data/lib/tap/support/configurable_class.rb +6 -30
data/lib/tap/support/configuration.rb +36 -9
data/lib/tap/support/constant.rb +75 -13
data/lib/tap/support/constant_manifest.rb +115 -0
data/lib/tap/support/dependencies.rb +27 -67
data/lib/tap/support/dependency.rb +44 -0
data/lib/tap/support/executable.rb +78 -109
data/lib/tap/support/executable_queue.rb +1 -1
data/lib/tap/support/gems.rb +6 -0
data/lib/tap/support/gems/rack.rb +197 -84
data/lib/tap/support/instance_configuration.rb +29 -3
data/lib/tap/support/intern.rb +46 -0
data/lib/tap/support/join.rb +67 -11
data/lib/tap/support/joins.rb +2 -0
data/lib/tap/support/joins/fork.rb +1 -0
data/lib/tap/support/joins/merge.rb +3 -1
data/lib/tap/support/joins/sequence.rb +2 -2
data/lib/tap/support/joins/switch.rb +3 -1
data/lib/tap/support/joins/sync_merge.rb +6 -0
data/lib/tap/support/lazy_attributes.rb +16 -1
data/lib/tap/support/lazydoc.rb +21 -21
data/lib/tap/support/lazydoc/comment.rb +59 -55
data/lib/tap/support/lazydoc/definition.rb +36 -0
data/lib/tap/support/lazydoc/document.rb +37 -13
data/lib/tap/support/manifest.rb +120 -131
data/lib/tap/support/minimap.rb +90 -0
data/lib/tap/support/node.rb +4 -6
data/lib/tap/support/parser.rb +63 -6
data/lib/tap/support/schema.rb +11 -2
data/lib/tap/support/shell_utils.rb +3 -5
data/lib/tap/support/string_ext.rb +60 -0
data/lib/tap/support/tdoc.rb +2 -2
data/lib/tap/support/templater.rb +29 -15
data/lib/tap/support/validation.rb +22 -11
data/lib/tap/task.rb +155 -156
data/lib/tap/tasks/load.rb +95 -8
data/lib/tap/test/extensions.rb +2 -1
data/lib/tap/test/script_tester.rb +7 -1
data/template/index.erb +39 -32
metadata +13 -13
data/lib/tap/generator/generators/root/templates/test/tapfile_test.rb +0 -15
data/lib/tap/patches/rake/rake_test_loader.rb +0 -8
data/lib/tap/patches/rake/testtask.rb +0 -57
data/lib/tap/patches/ruby19/backtrace_filter.rb +0 -51
data/lib/tap/patches/ruby19/parsedate.rb +0 -16
data/lib/tap/spec.rb +0 -42
data/lib/tap/spec/adapter.rb +0 -25
data/lib/tap/spec/inheritable_class_test_root.rb +0 -9
data/lib/tap/support/constant_utils.rb +0 -127
data/lib/tap/support/summary.rb +0 -30

data/lib/tap/support/executable_queue.rb CHANGED

@@ -71,7 +71,7 @@ module Tap
       protected
-      attr_accessor :queue
+      attr_accessor :queue # :nodoc:
       # Checks if the input method is extended with Executable
       def check_method(method) # :nodoc:

data/lib/tap/support/gems.rb CHANGED

@@ -2,6 +2,9 @@ require 'rubygems'
 module Tap
   module Support
+    # Methods for working with {RubyGems}[http://www.rubygems.org/]
+    # and other gems frequently used by Tap.
     module Gems
       module_function
@@ -23,6 +26,9 @@ module Tap
         Gem.loaded_specs[name]
       end
+      # Selects gem specs for which the block returns true.  If
+      # latest is specified, only the latest version of each
+      # gem will be passed to the block.
       def select_gems(latest=true)
         index = latest ?
           Gem.source_index.latest_specs :

data/lib/tap/support/gems/rack.rb CHANGED

@@ -1,81 +1,159 @@
 require 'rack'
-require 'cgi'
 require 'yaml'
+# in a future release, it looks like this will be changed
+require 'rack/file'
+#require 'rack/mime'
 module Tap
   module Support
     module Gems
-      Tap::Env.manifest(:cgis, "cgi") do |search_path|
-        Dir.glob(File.join(search_path, "**/*.rb")).collect do |path|
-          ["/" + Tap::Root.relative_filepath(search_path, path), path]
+      Tap::Env.manifest(:cgis) do |env|
+        entries = []
+        env.root.glob(:cgi, "**/*.rb").each do |path|
+          env.root.relative_filepath(:cgi, path)
         end
+        entries = entries.sort_by {|path| File.basename(path) }
+        Support::Manifest.intern(entries) {|path| "/" + path }
       end
+      # = UNDER CONSTRUCTION
+      # Support for a Tap::Server, built on {Rack}[http://rack.rubyforge.org/].
+      #
+      # Tap::Support::Gems::Rack is intended to extend a Tap::Env
       module Rack
+        # The handler for the server (ex Rack::Handler::WEBrick)
         attr_accessor :handler
-        def call(env)
-          path = env['PATH_INFO']
+        # The default error template used by response
+        # when an error occurs.
+        DEFAULT_ERROR_TEMPLATE = %Q{
+<html>
+<body>
+# Error handling request: <%= error.message %></br>
+# <%= error.backtrace.join("<br/># ") %>
+<code><pre>
+<%= cgi.to_yaml %>
+<%= rack.to_yaml %>
+</pre></code>
+</body>
+</html>
+}
+        # Creates a [status, headers, body] response using the result of the
+        # block as the body.  The status and headers the defaults for
+        # {Rack::Response}[http://rack.rubyforge.org/doc/classes/Rack/Response.html].
+        # If an error occurs, a default error message is generated using the
+        # DEFAULT_ERROR_TEMPLATE.
+        def response(rack_env)
+          ::Rack::Response.new.finish do |res|
+            res.write begin
+              yield(res)
+            rescue
+              template(DEFAULT_ERROR_TEMPLATE, env_attrs(rack_env).merge(:error => $!))
+            end
+          end
+        end
+        # The {Rack}[http://rack.rubyforge.org/doc/] interface method.  Call
+        # routesrequests (with preference) to:
+        # * static pages
+        # * cgi scripts
+        # * default responses
+        #
+        # === Static pages
+        # Static pages may be served from any env in self.  A static page is
+        # served if a file with the request path exists under the 'public'
+        # directory for any env.
+        #
+        # Envs are searched in order, using the Env#search_path method.
+        #
+        # === CGI scripts
+        # Like static pages, cgi scripts may be served from any env in self.
+        # Scripts are discovered using a search of the cgi manifest.  See
+        # cgi_response for more details.
+        #
+        # === Default responses
+        # The default response is path-dependent:
+        #
+        #   path            action
+        #   /, /index       render the manifest.
+        #   all others      render a 404 response
+        #
+        # The manifest may be refreshed by setting a query string:
+        #
+        #   /?refresh=true
+        #   /index?refresh=true
+        #
+        def call(rack_env)
+          path = rack_env['PATH_INFO']
           case
-          when public_page = known_path(:public, path)
+          when static_path = search_path(:public, path) {|file| File.file?(file) }
             # serve named static pages
-            response(env) { File.read(public_page) }
+            file_response(static_path, rack_env)
+          when cgi_path = search(:cgis, path)
+            # serve cgis
+            cgi_response(cgi_path, rack_env)
+          # when task_path = search(:tasks, path)
+          #   # serve tasks
+          #   cgi_response('task', rack_env)
-          when cgi_page = search(:cgis, path)
-            # serve cgis relative to a cgi path
-            run_cgi(cgi_page, env)
           when path == "/" || path == "/index"
             # serve up the homepage
-            if env["QUERY_STRING"] == "refresh=true"
-              reset(:cgis) do |key, path|
-                Support::Lazydoc[path].resolved = false
-              end
+            if rack_env["QUERY_STRING"] == "refresh=true"
+              # reset(:cgis) do |key, path|
+              #   Support::Lazydoc[path].resolved = false
+              # end
             end
-            template_response('index', env)
-          when config[:development] && template_page = known_path(:template, path)
-            response(env) { template(File.read(template_page), env) }
+            render_response('index.erb', rack_env)
           else
             # handle all other requests as errors
-            template_response('404', env)
+            render_response('404.erb', rack_env)
           end
         end
-        def known_path(dir, path)
-          each do |env|
-            directory = env.root.filepath(dir)
-            file = env.root.filepath(dir, path)
+        # Generates a [status, headers, body] response for the specified file.
+        # Patterned after {Rack::File#._call}[http://rack.rubyforge.org/doc/classes/Rack/File.html].
+        def file_response(path, rack_env)
+          response(rack_env) do |res|
+            content = File.read(path)
+            res.headers.merge!(
+              "Last-Modified" => File.mtime(path).httpdate,
+              "Content-Type" => ::Rack::File::MIME_TYPES[File.extname(path)] || "text/plain", # Rack::Mime.mime_type(File.extname(path), 'text/plain'),
+              "Content-Length" => content.size.to_s)
-            if file != directory && file.index(directory) == 0 && File.exists?(file)
-              return file
-            end
+            content
           end
-          nil
         end
-        #--
-        # Runs a cgi and returns an array as demanded by rack.
-        def run_cgi(cgi_path, env)
+        # Generates a [status, headers, body] response for the specified cgi.
+        # The cgi will be run with ENV set as specified in rack_env.
+        def cgi_response(cgi_path, rack_env)
+          # setup standard ios for capture
           current_input = $stdin
           current_output = $stdout
-          cgi_input = env['rack.input']
+          cgi_input = rack_env['rack.input']
           cgi_output = StringIO.new("")
           begin
             $stdin = cgi_input
             $stdout = cgi_output
+            # run the cgi
+            with_ENV(rack_env) { load(cgi_path) }
-            with_env(env) { load(cgi_path) }
-            # collect the headers and body from the cgi output
+            # collect the headers and body from the output
             headers, body = cgi_output.string.split(/\r?\n\r?\n/, 2)
             raise "missing headers from: #{cgi_path}" if headers == nil
@@ -87,65 +165,81 @@ module Tap
               hash
             end
+            # generate the response
             [headers.delete('Status') || 200, headers, body]
           rescue(Exception)
             # when an error occurs, return a standard cgi error with backtrace
             [500, {'Content-Type' => 'text/plain'}, %Q{#{$!.class}: #{$!.message}\n#{$!.backtrace.join("\n")}}]
           ensure
             $stdin = current_input
             $stdout = current_output
           end
         end
-        # Executes block with ENV set to the specified hash.  Non-string env variables are not set.
-        def with_env(env)
-          current_env = {}
-          ENV.each_pair {|key, value| current_env[key] = value }
-          begin
-            ENV.clear
-            env.each_pair {|key, value| ENV[key] = value if value.kind_of?(String)}
-            yield
-          ensure
-            ENV.clear
-            current_env.each_pair {|key, value| ENV[key] = value }
-          end
-        end
-        DEFAULT_ERROR_TEMPLATE = %Q{
-<html>
-<body>
-# Error handling request: <%= error.message %></br>
-# <%= error.backtrace.join("<br/># ") %>
-<code><pre>
-<%= cgi.to_yaml %>
-<%= rack.to_yaml %>
-</pre></code>
-</body>
-</html>
-}
-        def response(env)
-          ::Rack::Response.new.finish do |res|
-            res.write begin
-              yield(res)
-            rescue
-              template(DEFAULT_ERROR_TEMPLATE, env, :error => $!)
+        # def cgi_template(name, attributes={})
+        #   path = root.filepath(:template, "#{name}.erb")
+        #   Templater.new( File.read(path), {:server => self}.merge(attributes) ).build
+        # end
+        # Generates a [status, headers, body] response using the first existing
+        # template matching path (as determined by Env#search_path) and the
+        # specified rack_env.
+        def render_response(path, rack_env)
+          # partition and sort the env variables into
+          # cgi and rack variables.
+          rack, cgi = rack_env.to_a.partition do |(key, value)|
+            key =~ /^rack/
+          end.collect do |part|
+            part.sort_by do |key, value|
+              key
+            end.inject({}) do |hash, (key,value)|
+              hash[key] = value
+              hash
             end
           end
+          response(rack_env) do
+            render(path, env_attrs(rack_env))
+          end
         end
-        def cgi_template(name, attributes={})
-          path = root.filepath(:template, "#{name}.erb")
-          Templater.new( File.read(path), {:server => self}.merge(attributes) ).build
+        module Render
+          def renderer(path)
+            template = env.search_path(:template, path) {|file| File.file?(file) }
+            raise("no such template: #{path}") if template == nil
+            Tap::Support::Templater.new(File.read(template), marshal_dump).extend(Render)
+          end
+          def render(path, attrs={})
+            renderer(path).build(attrs)
+          end
         end
+        # Builds the specified template using the rack_env and additional
+        # attributes. The rack_env is partitioned into rack-related and
+        # cgi-related hashes (all rack_env entries where the key starts
+        # with 'rack' are rack-related, the others are cgi-related).
+        #
+        # The template is built with the following standard locals:
+        #
+        #   server   self
+        #   cgi      the cgi-related hash
+        #   rack     the rack-related hash
+        #
+        # Plus the attributes.
+        def render(path, attributes={}) # :nodoc:
+          path = search_path(:template, path) {|file| File.file?(file) }
+          raise("no such template: #{path}") if path == nil
-        def template(template, env, attributes={})
+          template(File.read(path) , attributes)
+        end
+        def env_attrs(rack_env)
           # partition and sort the env variables into
           # cgi and rack variables.
-          rack, cgi = env.to_a.partition do |(key, value)|
+          rack, cgi = rack_env.to_a.partition do |(key, value)|
             key =~ /^rack/
           end.collect do |part|
             part.sort_by do |key, value|
@@ -155,14 +249,33 @@ module Tap
               hash
             end
           end
-          Templater.new( template , {:server => self, :env => env, :cgi => cgi, :rack => rack}.merge(attributes) ).build
+          {:env => self, :cgi => cgi, :rack => rack}
         end
-        def template_response(name, env)
-          path = known_path(:template, "#{name}.erb")
-          response(env) { template(File.read(path), env) }
+        def template(template, attributes={}) # :nodoc:
+          Templater.new(template, attributes).extend(Render).build
         end
+        protected
+        # Executes block with ENV set to the specified hash.
+        # Non-string values in hash are skipped.
+        def with_ENV(hash) # :nodoc:
+          current_env = {}
+          ENV.each_pair {|key, value| current_env[key] = value }
+          begin
+            ENV.clear
+            hash.each_pair {|key, value| ENV[key] = value if value.kind_of?(String)}
+            yield
+          ensure
+            ENV.clear
+            current_env.each_pair {|key, value| ENV[key] = value }
+          end
+        end
       end
     end
   end

data/lib/tap/support/instance_configuration.rb CHANGED

@@ -47,11 +47,24 @@ module Tap
         @class_config = class_config
       end
+      # Updates self to ensure that each class_config key
+      # has a value in self; the config.default value is
+      # set if a value does not already exist.
+      #
+      # Returns self.
+      def update(class_config=self.class_config)
+        class_config.each_pair do |key, config|
+          self[key] ||= config.default
+        end
+        self
+      end
       # Binds self to the specified receiver.  Mapped keys are
       # removed from store and sent to their writer method on
       # receiver.
       def bind(receiver)
-        raise ArgumentError.new("receiver cannot be nil") if receiver == nil
+        raise "already bound to: #{@receiver}" if bound?
+        raise ArgumentError, "receiver cannot be nil" if receiver == nil
         class_config.each_pair do |key, config|
           receiver.send(config.writer, store.delete(key)) if config.writer
@@ -88,7 +101,7 @@ module Tap
       # Associates the value the key.  If bound? and the key
       # is a class_config key, then the value will be forwarded
-      # to the class_config.writer method on the receiver.
+      # to the config.writer method on the receiver.
       def []=(key, value)
         case
         when bound? && config = class_config.map[key.to_sym]
@@ -99,7 +112,7 @@ module Tap
       # Retrieves the value corresponding to the key. If bound?
       # and the key is a class_config key, then the value is
-      # obtained from the :key method on the receiver.
+      # obtained from the config.reader method on the receiver.
       def [](key)
         case
         when bound? && config = class_config.map[key.to_sym]
@@ -138,6 +151,19 @@ module Tap
         hash
       end
+      def to_yaml(opts)
+        hash = {}
+        store.each_pair do |key, value|
+          hash[key.to_s] = value
+        end
+        class_config.each_pair do |key, config|
+          hash[key.to_s] = bound? ? self[key] : config.default
+        end
+        hash.to_yaml(opts)
+      end
       # Overrides default inspect to show the to_hash values.
       def inspect
         "#<#{self.class}:#{object_id} to_hash=#{to_hash.inspect}>"