mack 0.2.0.1 → 0.3.0

data/CHANGELOG

@@ -1,3 +1,10 @@
+===0.3.0
+* Ticket: #8 Xml Builder Support
+* Ticket: #7 Ability to drive certain content based on 'format'
+* Ticket: #9 Added a global encryption system to make encrypting/decrypting of strings easy to use.
+* gem: builder 2.1.2
+* gem: crypt 1.1.4
+
 ===0.2.0.1
 * gem: cachetastic 1.4.1
 * gem: application_configuration 1.2.1

data/bin/mack

@@ -1,3 +1,4 @@
+#!/usr/local/bin/ruby
 require 'fileutils'
 require 'optparse'
 require 'optparse/time'

data/lib/core_extensions/kernel.rb

@@ -0,0 +1,15 @@
+module Kernel
+  
+  # A helper method that calls Mack::Utils::Crypt::Keeper with the specified worker
+  # and calls the encrypt method on that worker.
+  def _encrypt(value, worker = :default)
+    Mack::Utils::Crypt::Keeper.instance.worker(worker).encrypt(value)
+  end
+  
+  # A helper method that calls Mack::Utils::Crypt::Keeper with the specified worker
+  # and calls the decrypt method on that worker.
+  def _decrypt(value, worker = :default)
+    Mack::Utils::Crypt::Keeper.instance.worker(worker).decrypt(value)
+  end
+  
+end

data/lib/core_extensions/string.rb

@@ -35,4 +35,22 @@ class String
     Mack::Utils::Inflector.instance.singularize(self)
   end
   
+  # Maps to Kernel _encrypt
+  # 
+  # Examples:
+  #   "Hello World".encrypt
+  #   "Hello World".encrypt(:my_crypt)
+  def encrypt(worker = :default)
+    _encrypt(self, worker)
+  end
+  
+  # Maps to Kernel _decrypt
+  # 
+  # Examples:
+  #   some_encrypted_string.decrypt
+  #   some_encrypted_string.decrypt(:my_crypt)
+  def decrypt(worker = :default)
+    _decrypt(self, worker)
+  end
+  
 end

data/lib/initialization/configuration.rb

@@ -82,7 +82,7 @@ module Mack
         "mack::use_lint" => true,
         "mack::show_exceptions" => true,
         "mack::session_id" => "_mack_session_id",
-        "mack::rendering_systems" => [:action, :text, :partial, :public, :url],
+        "mack::rendering_systems" => [:action, :text, :partial, :public, :url, :xml],
         "mack::cookie_values" => {
           "path" => "/"
         },

data/lib/initialization/initializer.rb

@@ -6,6 +6,8 @@ require 'application_configuration'
 require 'cachetastic'
 require 'fileutils'
 require 'log4r'
+require 'crypt/rijndael'
+require 'singleton'
 
 # Set up Mack constants, if they haven't already been set up.
 unless Object.const_defined?("MACK_ENV")

data/lib/mack.rb

@@ -119,7 +119,7 @@ module Mack
       url = route[:redirect_to]
       options = self.request.all_params
       options.merge!(route)
-      options - [:controller, :action, :redirect_to, :method, :status]
+      options - [:controller, :action, :redirect_to, :method, :status, :format]
       url = url_for_pattern(url, options)
       self.response.status = status
       self.response[:location] = url

data/lib/rendering/base.rb

@@ -35,10 +35,15 @@ module Mack
         raise MethodNotImplemented.new("render")
       end
       
+      # Maps to the view_binder's param method. See also Mack::ViewBinder params.
+      def params(key)
+        self.view_binder.params(key)
+      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)
+        options = {:is_partial => false, :ext => ".#{self.params(:format)}.erb", :dir => MACK_VIEWS}.merge(options)
         partial = f.to_s
         parts = partial.split("/")
         if parts.size == 1

data/lib/rendering/classes/action.rb

@@ -10,7 +10,7 @@ module Mack
         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))
+            t = render_file(options[:action], {:dir => MACK_PUBLIC, :ext => ".#{params(:format)}", :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

data/lib/rendering/classes/xml.rb

@@ -0,0 +1,24 @@
+module Mack
+  module Rendering
+    # Used when someone calls render(:xml => "rss_feed")
+    class Xml < Base
+      
+      def render
+        begin
+          # Try to render the action:
+          return render_file(options[:xml], options.merge(:format => :xml, :ext => ".xml.erb"))
+        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[:xml], {:dir => MACK_PUBLIC, :ext => ".xml.erb", :layout => false}.merge(options.merge(:format => :xml)))
+            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/routing/route_map.rb

@@ -223,6 +223,12 @@ module Mack
         end
         s = segs.join("/")
         s = "/" if s.blank?
+        if s.match(".:format")
+          s.gsub!(/\.:format/, "(\\..+|$)")
+        else
+          s << "(\\..+|$)"
+        end
+        
         rx = /^#{s}$/
         rx
       end # regex_from_pattern
@@ -249,7 +255,13 @@ module Mack
         end
         
         def options_with_embedded_parameters(uri)
-          opts = self.options
+          opts = {:format => :html}.merge(self.options)
+          m = uri.match(/\..+$/)
+          if m
+            m = m.to_s
+            opts[:format]= m[1..m.size].to_sym
+            uri.gsub!(/\..+$/, "")
+          end
           split_uri = uri.split("/")
           self.embedded_parameters.each_with_index do |val, ind|
             unless val.nil?

data/lib/routing/urls.rb

@@ -18,12 +18,20 @@ module Mack
       def url_for_pattern(url, options = {})
         u = url.dup
         unused_params = []
+        format = nil
         options.each_pair do |k, v|
-          vp = Rack::Utils.escape(v.to_param)
-          if u.gsub!(":#{k}", vp).nil?
-            unused_params << "#{Rack::Utils.escape(k)}=#{vp}"
+          unless k.to_sym == :format
+            vp = Rack::Utils.escape(v.to_param)
+            if u.gsub!(":#{k}", vp).nil?
+              unused_params << "#{Rack::Utils.escape(k)}=#{vp}"
+            end
+          else
+            format = v
           end
         end
+        if format
+          u << ".#{format}"
+        end
         unless unused_params.empty?
           u << "?" << unused_params.sort.join("&")
         end

data/lib/sea_level/controller_base.rb

@@ -31,6 +31,7 @@ module Mack
         @controller_name = params(:controller)
         @action_name = params(:action)
         @cookies = cookies
+        @wants_list = []
       end
       
       # Gives access to all the parameters for this request.
@@ -198,6 +199,36 @@ module Mack
         render(:text => redirect_html(request.path_info, url, options[:status]))
       end
       
+      # In an action wants will run blocks of code based on the content type that has
+      # been requested.
+      # 
+      # Examples:
+      #   class MyAwesomeController < Mack::Controller::Base
+      #     def hello
+      #       wants(:html) do
+      #         render(:text => "<html>Hello World</html>")
+      #       end
+      #       wants(:xml) do
+      #         render(:text => "<xml><greeting>Hello World</greeting></xml>")
+      #       end
+      #     end
+      #   end
+      # 
+      # If you were to go to: /my_awesome/hello you would get:
+      #   "<html>Hello World</html>"
+      # 
+      # If you were to go to: /my_awesome/hello.html you would get:
+      #   "<html>Hello World</html>"
+      # 
+      # If you were to go to: /my_awesome/hello.xml you would get:
+      #   "<xml><greeting>Hello World</greeting></xml>"
+      def wants(header_type, &block)
+        header_type = header_type.to_sym
+        if header_type == params(:format).to_sym
+          yield
+        end
+      end
+      
       # Returns true/false depending on whether the render action has been called yet.
       def render_performed?
         @render_performed
@@ -237,7 +268,13 @@ module Mack
             end
           else layout
             # use the layout specified by the layout method
-            return Mack::ViewBinder.new(self).render(@render_options.merge({:action => "layouts/#{layout}"}))
+            begin
+              return Mack::ViewBinder.new(self).render(@render_options.merge({:action => "layouts/#{layout}"}))
+            rescue Errno::ENOENT => e
+              # if the layout doesn't exist, we don't care.
+            rescue Exception => e
+              raise e
+            end
           end
         # end
         @content_for_layout

data/lib/sea_level/helpers/view_helpers/html_helpers.rb

@@ -28,6 +28,14 @@ module Mack
         Mack::Utils::Html
       end
       
+      # A wrapper to Mack::Utils::Html rss method.
+      # 
+      # Example:
+      #   <%= rss_tag(posts_index_url(:format => :xml)) %>
+      def rss_tag(url)
+        Mack::Utils::Html.rss(url)
+      end
+      
     end # HtmlHelpers
   end # ViewHelpers
 end # Mack

data/lib/sea_level/view_binder.rb

@@ -1,3 +1,4 @@
+require 'builder'
 # require 'erubis'
 # This class is used to do all the view level bindings.
 # It allows for seperation between the controller and the view levels.
@@ -10,6 +11,8 @@ class Mack::ViewBinder
     self.controller = cont
     self.options = {:locals => {}}.merge(opts)
     transfer_vars(@controller)
+    @xml_output = ""
+    @xml = Builder::XmlMarkup.new(:target => @xml_output, :indent => 1)
   end
   
   # Returns the binding for this class.
@@ -23,6 +26,15 @@ class Mack::ViewBinder
     self.options[:locals][sym]
   end
   
+  # Maps to the controller's param method. See also Mack::Controller::Base params.
+  def params(key)
+    self.controller.params(key)
+  end
+  
+  def xml
+    @xml
+  end
+  
   # Handles rendering calls both in the controller and in the view.
   # For full details of render examples see Mack::Controller::Base render.
   # Although the examples there are all in controllers, they idea is still
@@ -62,7 +74,12 @@ class Mack::ViewBinder
     # and returns a String. The io can be either an IO object or a String.
     def render(io, controller, options = {})
       vb = Mack::ViewBinder.new(controller, options)
-      return ERB.new(io).result(vb.view_binding)
+      # TODO: find a nicer way of doing this:
+      if ((controller.params(:format).to_sym == :xml) || options[:format] == :xml) && (options[:action] || options[:xml])
+        return eval(io, vb.view_binding)
+      else
+        return ERB.new(io).result(vb.view_binding)
+      end
       # return Erubis::Eruby.new(io).result(vb.view_binding)
     end
     

data/lib/utils/crypt/default_worker.rb

@@ -0,0 +1,28 @@
+module Mack
+  module Utils # :nodoc:
+    module Crypt # :nodoc:
+      # The default worker is one that is used when no other worker is specified or the 
+      # specified worker does not exist. It uses the Crypt::Rijndael library and get's 
+      # it's secret key from app_config.default_secret_key
+      class DefaultWorker
+        
+        def initialize
+          @aes_key = ::Crypt::Rijndael.new(app_config.default_secret_key || (String.randomize(40)))
+        end
+        
+        # Encrypts a string using the Crypt::Rijndael library and the secret key found in
+        # app_config.default_secret_key
+        def encrypt(x)
+          @aes_key.encrypt_string(x)
+        end
+        
+        # Decrypts a string using the Crypt::Rijndael library and the secret key found in
+        # app_config.default_secret_key
+        def decrypt(x)
+          @aes_key.decrypt_string(x)
+        end
+        
+      end # DefaultWorker
+    end # Crypt
+  end # Utils
+end # Mack

data/lib/utils/crypt/keeper.rb

@@ -0,0 +1,46 @@
+module Mack
+  module Utils
+    module Crypt
+      # A singleton class that holds/manages all the workers for the system.
+      # 
+      # A worker must be defined as Mack::Utils::Crypt::<name>Worker and must
+      # define an encrypt(value) method and a decrypt(value) method.
+      # 
+      # Example:
+      #  class Mack::Utils::Crypt::ReverseWorker
+      #    def encrypt(x)
+      #      x.reverse
+      #    end
+      #
+      #    def decrypt(x)
+      #      x.reverse
+      #    end
+      #  end
+      class Keeper
+        include Singleton
+      
+        def initialize
+          @crypt_workers_cache = {}
+        end
+        
+        # Returns a worker object to handle the encrytion/decryption.
+        # If the specified worker doesn't exist then Mack::Utils::Crypt::DefaultWorker
+        # is returned.
+        def worker(key = :default)
+          worker = @crypt_workers_cache[key.to_sym]
+          if worker.nil?
+            worker_klass = key.to_s.camelcase + "Worker"
+            if Mack::Utils::Crypt.const_defined?(worker_klass)
+              worker = "Mack::Utils::Crypt::#{worker_klass}".constantize.new
+            else
+              worker = Mack::Utils::Crypt::DefaultWorker.new
+            end
+            @crypt_workers_cache[key.to_sym] = worker
+          end
+          worker
+        end
+      
+      end # Keeper
+    end # Crypt
+  end # Utils
+end # Mack

data/lib/utils/html.rb

@@ -46,6 +46,14 @@ module Mack
         
         alias_method :a, :href
         
+        # A wrapper to generate an auto discovery tag so browsers no the page contains an RSS feed.
+        # 
+        # Example:
+        #   <%= Mack::Utils::Html.rss(posts_index_url(:format => :xml)) %>
+        def rss(url)
+          "<link rel=\"alternate\" type=\"application/rss+xml\" title=\"RSS\" href=\"#{url}\">"
+        end
+        
         # Wraps the content_tag method.
         # 
         # Examples:

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mack
 version: !ruby/object:Gem::Version 
-  version: 0.2.0.1
+  version: 0.3.0
 platform: ruby
 authors: 
 - markbates
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-14 00:00:00 -04:00
+date: 2008-03-19 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,6 +66,24 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.7.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: crypt
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 1.1.4
+    version: 
 description: "mack was developed by: markbates"
 email: mark@mackframework.com
 executables: 
@@ -94,6 +112,7 @@ files:
 - bin/templates/public/stylesheets/scaffold.css.template
 - bin/templates/Rakefile.template
 - lib/core_extensions/hash.rb
+- lib/core_extensions/kernel.rb
 - lib/core_extensions/module.rb
 - lib/core_extensions/nil.rb
 - lib/core_extensions/object.rb
@@ -128,6 +147,7 @@ files:
 - lib/rendering/classes/public.rb
 - lib/rendering/classes/text.rb
 - lib/rendering/classes/url.rb
+- lib/rendering/classes/xml.rb
 - lib/routing/route_map.rb
 - lib/routing/urls.rb
 - lib/sea_level/controller_base.rb
@@ -148,6 +168,8 @@ files:
 - lib/tasks/test_tasks.rake
 - lib/test_extensions/test_assertions.rb
 - lib/test_extensions/test_helpers.rb
+- lib/utils/crypt/default_worker.rb
+- lib/utils/crypt/keeper.rb
 - lib/utils/html.rb
 - lib/utils/inflections.rb
 - lib/utils/inflector.rb