mack 0.1.0 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,7 @@
+===0.2.0
+* ticket: 3 Render url in Controllers/Views
+* ticket: 5 Render Extension System.
+
 ===0.1.0
 * Added an inflections system. The default inflections are from Jeremy McAnally's great Rails plugin, acts_as_good_speeler. Thanks Jeremy! http://www.jeremymcanally.com/
 * Added a to_params method to Hash to help with testing.

data/lib/errors/errors.rb

@@ -83,5 +83,22 @@ module Mack
       end
     end
     
+    # Potentially raised if a render(:url => "....") is a status other than 200.
+    # This is only raised if :raise_exception is passed in as true to the render options.
+    class UnsuccessfulRenderUrl < StandardError
+      # Takes the uri trying to be rendered the Net::HTTP response object.
+      def initialize(uri, response)
+        super("URI: #{uri}; status: #{response.code}; body: #{response.body}")
+      end
+    end
+    
+    # Raised if an unsupported method, ie post or delete, is used with render url.
+    class UnsupportRenderUrlMethodType < StandardError
+      # Takes the method tried.
+      def initialize(method)
+        super("METHOD: #{method.to_s.upcase} is unsupported by render url.")
+      end
+    end
+    
   end # Errors
 end # Mack

data/lib/generators/plugin_generator/plugin_generator.rb

@@ -11,7 +11,7 @@ class PluginGenerator < Mack::Generator::Base
   
   require_param :name
   
-  def generate
+  def generate # :nodoc:
     plugin_dir = File.join(MACK_ROOT, "vendor", "plugins", param(:name).downcase)
     template_dir = File.join(File.dirname(__FILE__), "templates")
     

data/lib/generators/scaffold_generator/scaffold_generator.rb

@@ -2,16 +2,11 @@
 # 
 # Example:
 #   rake generate:scaffold name=post
-# This will generate the following in your mack application:
-#   vendor/plugins/my_cool_plugin
-#   vendor/plugins/my_cool_plugin/init.rb
-#   vendor/plugins/my_cool_plugin/lib
-#   vendor/plugins/my_cool_plugin/lib/my_cool_plugin.rb
 class ScaffoldGenerator < Mack::Generator::Base
   
   require_param :name
   
-  def generate
+  def generate # :nodoc:
     @name_singular = param(:name).singular
     @name_plural = param(:name).plural
     @name_singular_camel = @name_singular.camelcase

data/lib/initialization/configuration.rb

@@ -40,6 +40,7 @@ module Mack
     # use local memory and store stuff for 5 minutes:
     DEFAULTS_DEVELOPMENT = {
       "mack::cache_classes" => false,
+      "mack::default_domain" => "http://localhost:3000",
       "log::level" => "debug",
       "log::console" => true,
       "cachetastic_default_options" => {
@@ -57,7 +58,10 @@ module Mack
     
     # use local memory and store stuff for 1 hour:
     DEFAULTS_TEST = {
+      "mack::default_domain" => "http://localhost",
+      "mack::default_domain_port" => 6666,
       "log::level" => "error",
+      "run_remote_tests" => true,
       "cachetastic_default_options" => {
         "debug" => false,
         "adapter" => "local_memory",
@@ -73,10 +77,12 @@ module Mack
     
     unless self.const_defined?("DEFAULTS")
       DEFAULTS = {
+        "mack::render_url_timeout" => 5,
         "mack::cache_classes" => true,
         "mack::use_lint" => true,
         "mack::show_exceptions" => true,
         "mack::session_id" => "_mack_session_id",
+        "mack::rendering_systems" => [:action, :text, :partial, :public, :url],
         "mack::cookie_values" => {
           "path" => "/"
         },

data/lib/initialization/initializer.rb

@@ -40,7 +40,7 @@ unless Object.const_defined?("MACK_INITIALIZED")
   fl = File.join(File.dirname(__FILE__), "..")
 
   # Require all the necessary files to make Mack actually work!
-  ["errors", "core_extensions", "utils", "test_extensions", "routing", "sea_level", "tasks", "initialization/server", "generators"].each do |dir|
+  ["errors", "core_extensions", "utils", "test_extensions", "routing", "rendering", "sea_level", "tasks", "initialization/server", "generators"].each do |dir|
     dir_globs = Dir.glob(File.join(fl, dir, "**/*.rb"))
     dir_globs.each do |d|
       require d

data/lib/rendering/base.rb

@@ -0,0 +1,58 @@
+module Mack
+  module Rendering
+    # This is the base class from which all rendering systems need to extend.
+    # 
+    # Example:
+    #   class Mack::Rendering::Pdf < Mack::Rendering::Base
+    #     def render
+    #       # do work to render stuff as a PDF
+    #     end
+    #   end
+    # 
+    # Now add this to the list of available render systems:
+    #   app_config.mack.rendering_systems << :pdf
+    # 
+    # You should now be able to do this in your controller:
+    # 
+    #   class MyAwesomeController < Mack::Controller::Base
+    #     def pdf
+    #       render(:pdf => "my_pdf_template")
+    #     end
+    #   end
+    class Base
+      
+      attr_accessor :view_binder # The Mack::ViewBinder that called this rendering system.
+      attr_accessor :options # The options associated with this render call
+      
+      def initialize(view_binder, options)
+        self.view_binder = view_binder
+        self.options = options
+      end
+      
+      # This is the only method that needs to be implemented by a rendering system.
+      # It should return a String.
+      def render
+        raise MethodNotImplemented.new("render")
+      end
+      
+      private
+      # Used to render a file from disk.
+      def render_file(f, options = {})
+        options = {:is_partial => false, :ext => ".html.erb", :dir => MACK_VIEWS}.merge(options)
+        partial = f.to_s
+        parts = partial.split("/")
+        if parts.size == 1
+          # it's local to this controller
+          partial = "_" << partial if options[:is_partial]
+          partial = File.join(options[:dir], self.view_binder.controller.controller_name, partial + options[:ext])
+        else
+          # it's elsewhere
+          parts[parts.size - 1] = "_" << parts.last if options[:is_partial]
+          partial = File.join(options[:dir], parts.join("/") + options[:ext])
+        end
+        return Mack::ViewBinder.render(File.open(partial).read, self.view_binder.controller, options)
+      end
+      
+    end # Base
+  end # Rendering
+end # Mack

data/lib/rendering/classes/action.rb

@@ -0,0 +1,26 @@
+module Mack
+  module Rendering
+    # Used when someone calls render(:action => "index")
+    class Action < Base
+      
+      def render
+        begin
+          # Try to render the action:
+          return render_file(options[:action], options)
+        rescue Errno::ENOENT => e
+          begin
+            # If the action doesn't exist on disk, try to render it from the public directory:
+            t = render_file(options[:action], {:dir => MACK_PUBLIC, :ext => ".html", :layout => false}.merge(options))
+            # Because it's being served from public don't wrap a layout around it!
+            # self.controller.instance_variable_get("@render_options").merge!({:layout => false})
+            return t
+          rescue Errno::ENOENT => ex
+          end
+          # Raise the original exception because something bad has happened!
+          raise e
+        end
+      end
+      
+    end
+  end
+end

data/lib/rendering/classes/partial.rb

@@ -0,0 +1,12 @@
+module Mack
+  module Rendering
+    # Used when someone calls render(:partial => "latest_news")
+    class Partial < Base
+      
+      def render
+        render_file(options[:partial], {:is_partial => true}.merge(options))
+      end
+      
+    end
+  end
+end

data/lib/rendering/classes/public.rb

@@ -0,0 +1,13 @@
+module Mack
+  module Rendering
+    # Used when someone calls render(:public => "index")
+    # This renders a file from the public directory.
+    class Public < Base
+      
+      def render
+        render_file(options[:public], {:dir => MACK_PUBLIC, :ext => ".html", :layout => false}.merge(options))
+      end
+      
+    end
+  end
+end

data/lib/rendering/classes/text.rb

@@ -0,0 +1,12 @@
+module Mack
+  module Rendering
+    # Used when someone calls render(:text => "Hello World!")
+    class Text < Base
+      
+      def render
+        Mack::ViewBinder.render(options[:text], self.view_binder.controller, options)
+      end
+      
+    end
+  end
+end

data/lib/rendering/classes/url.rb

@@ -0,0 +1,58 @@
+require 'net/http'
+module Mack
+  module Rendering
+    # Used when someone calls render(:url => "http://www.mackframework.com")
+    class Url < Base
+      
+      def render
+        options = {:method => :get, :domain => app_config.mack.default_domain, :raise_exception => false}.merge(self.options)
+        case options[:method]
+        when :get
+          do_render_url(options) do |uri, options|
+            unless options[:parameters].empty?
+              uri = uri.to_s
+              uri << "?"
+              options[:parameters].each_pair do |k,v|
+                uri << URI.encode(k.to_s)
+                uri << "="
+                uri << URI.encode(v.to_s)
+                uri << "&"
+              end
+              uri.gsub!(/&$/, "")
+              uri = URI.parse(uri)
+            end
+            Net::HTTP.get_response(uri)
+          end
+        when :post
+          do_render_url(options) do |uri, options|
+            Net::HTTP.post_form(uri, options[:parameters] || {})
+          end
+        else
+          raise Mack::Errors::UnsupportRenderUrlMethodType.new(options[:method])
+        end
+      end
+      
+      private
+      def do_render_url(options)
+        Timeout::timeout(app_config.mack.render_url_timeout || 5) do
+          url = options[:url]
+          unless url.match(/^[a-zA-Z]+:\/\//)
+            url = File.join(options[:domain], options[:url])
+          end
+          uri = URI.parse(url)
+          response = yield uri, options
+          if response.code == "200"
+            return response.body
+          else
+            if options[:raise_exception]
+              raise Mack::Errors::UnsuccessfulRenderUrl.new(uri, response)
+            else
+              return ""
+            end
+          end
+        end
+      end
+      
+    end
+  end
+end

data/lib/sea_level/controller_base.rb

@@ -148,6 +148,32 @@ module Mack
       #     def latest_news
       #       render(:partial => "some_other/old_news")
       #     end
+      # 
+      #     # This will render a url. If the url does not return a status code of '200',
+      #     # an empty string will be returned by default. The default method for rendering
+      #     # urls is a get.
+      #     def yahoo
+      #       render(:url => "http://www.yahoo.com")
+      #     end
+      # 
+      #     # This will render a url. If the url does not return a status code of '200',
+      #     # a Mack::Errors::UnsuccessfulRenderUrl exception will be raised.
+      #     def idontexist
+      #       render(:url => "http://www.idontexist.com", :raise_exception => true)
+      #     end
+      # 
+      #     # This will render a url with a post.
+      #     def post_to_somewhere
+      #       render(:url => "http://www.mackframework.com/post_to_me", :method => :post, 
+      #              :parameters => {:id => 1, :user => "markbates"})
+      #     end
+      # 
+      #     # This will render a 'local' url. If a domain is not present render url will
+      #     # reach out for the config parameter "mack::default_domain" and prepend that
+      #     # to the url. This can be overridden locally with the :domain option.
+      #     def get_index
+      #       render(:url => "/")
+      #     end
       #   end
       def render(options = {:action => self.action_name})
         raise Mack::Errors::DoubleRender.new if render_performed?

data/lib/sea_level/view_binder.rb

@@ -32,52 +32,22 @@ class Mack::ViewBinder
   #   <%= render(:text => "Hello") %>
   #   <%= render(:action => "show") %>
   #   <%= render(:partial => :latest_news) %>
+  #   <%= render(:url => "http://www.mackframework.com") %>
   def render(options = {})
-    if options[:action]
-      begin
-        # Try to render the action:
-        return render_file(options[:action], options)
-      rescue Errno::ENOENT => e
+    app_config.mack.rendering_systems.each do |render_option|
+      if options[render_option]
         begin
-          # If the action doesn't exist on disk, try to render it from the public directory:
-          t = render_file(options[:action], {:dir => MACK_PUBLIC, :ext => ".html", :layout => false}.merge(options))
-          # Because it's being served from public don't wrap a layout around it!
-          # self.controller.instance_variable_get("@render_options").merge!({:layout => false})
-          return t
-        rescue Errno::ENOENT => ex
+          rc = "Mack::Rendering::#{render_option.to_s.camelcase}".constantize.new(self, options)
+        rescue Exception => e
+          raise Mack::Errors::UnknownRenderOption.new(options)
         end
-        # Raise the original exception because something bad has happened!
-        raise e
+        return rc.render
       end
-    elsif options[:text]
-      return Mack::ViewBinder.render(options[:text], self.controller, options)
-    elsif options[:partial]
-      return render_file(options[:partial], {:is_partial => true}.merge(options))
-    elsif options[:public]
-      t = render_file(options[:public], {:dir => MACK_PUBLIC, :ext => ".html", :layout => false}.merge(options))
-      # self.controller.instance_variable_get("@render_options").merge!({:layout => false})
-      return t
-    else
-      raise Mack::UnknownRenderOption.new(options)
     end
+    raise Mack::Errors::UnknownRenderOption.new(options)
   end
   
   private
-  def render_file(f, options = {})
-    options = {:is_partial => false, :ext => ".html.erb", :dir => MACK_VIEWS}.merge(options)
-    partial = f.to_s
-    parts = partial.split("/")
-    if parts.size == 1
-      # it's local to this controller
-      partial = "_" << partial if options[:is_partial]
-      partial = File.join(options[:dir], self.controller.controller_name, partial + options[:ext])
-    else
-      # it's elsewhere
-      parts[parts.size - 1] = "_" << parts.last if options[:is_partial]
-      partial = File.join(options[:dir], parts.join("/") + options[:ext])
-    end
-    return Mack::ViewBinder.render(File.open(partial).read, self.controller, options)
-  end
   
   # Transfer instance variables from the controller to the view.
   def transfer_vars(x)

data/lib/test_extensions/test_helpers.rb

@@ -3,6 +3,12 @@ require "test/unit"
 module Mack
   
   module TestHelpers
+    
+    def remote_test
+      if (app_config.run_remote_tests)
+        yield
+      end
+    end
 
     # Performs a 'get' request for the specified uri.
     def get(uri, options = {})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mack
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - markbates
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-04 00:00:00 -05:00
+date: 2008-03-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -122,6 +122,12 @@ files:
 - lib/initialization/server/simple_server.rb
 - lib/mack.rb
 - lib/mack_tasks.rb
+- lib/rendering/base.rb
+- lib/rendering/classes/action.rb
+- lib/rendering/classes/partial.rb
+- lib/rendering/classes/public.rb
+- lib/rendering/classes/text.rb
+- lib/rendering/classes/url.rb
 - lib/routing/route_map.rb
 - lib/routing/urls.rb
 - lib/sea_level/controller_base.rb