ymdp 0.1.6 → 0.1.7

data/History.txt

@@ -0,0 +1,21 @@
+== in Git
+  * minor enhancements
+    
+
+== 0.1.7 2010-01-17
+  * minor enhancements
+    * Refactored ApplicationView and the F file support class
+    * improved RDoc coverage
+    * improved test coverage to 89%
+
+== 0.1.6 2010-01-16
+  * major enhancements
+    * YMDP global settings now assigned through YMDP::Base.configure block
+    * Raise exceptions if vital settings like version and server don't exist
+  * minor enhancements
+    * improved RDoc coverage
+    * improved test coverage
+    * YMDP_ROOT is now replaced by BASE_PATH
+    * renamed YMDP::Base to YMDP::ApplicationView
+    * made new YMDP::Base to handle global settings
+    

data/Rakefile

@@ -53,7 +53,7 @@ Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "translator #{version}"
+  rdoc.title = "YMDP #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.1.6
+0.1.7

data/lib/ymdp/application_view.rb

@@ -6,7 +6,6 @@ module YMDP
   # is HTML, JavaScript or CSS.
   #
   module ApplicationView
-    include YMDP::FileSupport
     include YMDP::Compressor
     
     extend self
@@ -125,11 +124,16 @@ module YMDP
     # will find <tt>app/javascripts/shared/sidebar.js</tt> and render its contents into the current
     # view in an inline script block.
     #
-    # === Rendering multiple JavaScript partials
+    # == Rendering a stylesheet partial
+    #
+    # Stylesheets are located at <tt>app/stylesheets</tt> and are named <tt>_filename_.css</tt>
+    #
     #
-    # Pass an array to <tt>render</tt> to combine multiple JavaScript files into a single
+    # === Rendering multiple partials
+    #
+    # Pass an array to <tt>render</tt> to combine multiple files into a single
     # inline block.  This is useful for compression and validation, as it allows a set of 
-    # JavaScript files to be compressed or validated in a single context.
+    # files to be compressed or validated in a single context.
     # 
     #   render :javascript => ['application', 'flash', 'debug']
     #
@@ -139,47 +143,91 @@ module YMDP
     #
     # Pass a <tt>:filename</tt> parameter to set the name of the combined file.  Currently the
     # combined file only exists on disc while it's being compressed and/or validated, but
-    # in the future this may be expanded to save multiple JavaScripts as a single external asset.
+    # in the future this may be expanded to save multiple files as a single external asset.
+    # 
+    #   render :javascript = ['application', 'flash', 'debug'], :filename => 'javascripts'
     #
     # Currently the <tt>:filename</tt> parameter is simply a convenience.
     #
-    # == Rendering a stylesheet partial
+    # Multiple partials of any type can be rendered.
+    # 
+    # For example:
     #
-    # Stylesheets are located at <tt>app/stylesheets</tt> and are named <tt>_filename_.css</tt>
+    #   render :partial => ['header', 'footer', 'sidebar'], :filename => 'html_layouts'
+    #
+    # will find <tt>app/views/_header.html.haml</tt>, <tt>app/views/_footer.html.haml</tt>,
+    # and <tt>app/views/_sidebar.html.haml</tt> and write them to a temporary file called
+    # <tt>tmp/html_layouts</tt> before rendering that file into the current view.
+    #
+    # This feature is intended mainly for JavaScript and CSS.
+    #
+    # For example:
+    #
+    #   render :stylesheet => ['application', 'colors'], :filename => 'styles'
+    #
+    # will render <tt>app/stylesheets/application.css</tt> and <tt>app/stylesheets/colors.css</tt>
+    # as a single temporary file called <tt>tmp/styles</tt> before rendering that file into 
+    # the current view.
+    #
+    # If compression and validation options are turned on, the resulting temporary file will be
+    # compressed and/or validated before being rendered into the current view.  This will result
+    # in a more efficient compression and a more effective validation. 
     #
     def render(params)
       output = []
-      tags = true
-      if params[:tags] == false
-        tags = false
+      
+      unless params.has_key?(:tags)
+        params[:tags] = true
       end
+        
+      output << render_html_partial(params)
+      output << render_javascript_partial(params)
+      output << render_stylesheet_partial(params)
+      
+      output.flatten.join("\n")
+    end
+  
+    private
+    
+    # Renders an HTML, Haml or ERB partial.
+    #    
+    def render_html_partial(params)
+      output = []
+
       if params[:partial]
         params[:partial].to_a.each do |partial|
           output << render_partial(partial)
         end
       end
-      if params[:javascript]
-        output << "<script type='text/javascript'>" if tags
-        output << render_javascripts(params[:javascript].to_a, params[:filename])
-        output << "</script>" if tags
-      end
-      if params[:stylesheet]
-        params[:stylesheet].to_a.each do |stylesheet|
-          output << render_stylesheet(stylesheet, tags)
-        end
-      end
-      output.join("\n")
+      output     
     end
-  
-    private
 
-    # Internal use only. Renders an HTML partial.
+    # Renders an HTML partial.
     #
     def render_partial(filename)
       output = ''
+      path = find_partial(filename)
+
+      if path && File.exists?(path)
+        template = File.read(path)
+        if path =~ /haml$/
+          output = process_haml(template, path)
+        else
+          output = process_template(template)
+        end
+      else
+        raise "Could not find partial: #{filename}"
+      end
+      output    
+    end
+    
+    # Searches all the possible paths to find a match for this partial name.
+    #
+    def find_partial(filename)
       path = nil
-      
       ["views", "views/shared"].each do |dir|
+        
+        # TODO: Refactor this so it doesn't use BASE_PATH
         basic_path = "#{BASE_PATH}/app/#{dir}/_#{filename}.html"
         
         ["", ".haml", ".erb"].each do |extension|
@@ -188,125 +236,114 @@ module YMDP
           end
         end
       end
-
-      if path
       
-        File.open(path) do |f|
-          template = f.read
-          if path =~ /haml$/
-            output = process_haml(template, path)
-          else
-            output = process_template(template)
-          end
-        end
-      else
-        raise "Could not find partial: #{filename}"
-      end
-      output    
+      path
     end
-  
-    # Internal use only. Renders a stylesheet partial.
-    #
-    def render_stylesheet(filename, tags=false)
-      unless filename =~ /\.css$/
-        filename = "#{filename}.css"
-      end
-      path = "#{BASE_PATH}/app/stylesheets/#{filename}"
     
-      output = ''
-      if File.exists?(path)
-        tmp_filename = save_processed_template(path)
-        if CONFIG.compress_css?
-          output = YMDP::Compressor::Stylesheet.compress(tmp_filename)
-        else
-          File.open(path) do |f|
-            template = f.read
-            output = process_template(template)          
-          end
-        end
-    
-        if tags
-          "<style type='text/css'>\n" + output + "\n</style>"
-        else
-          output
+    def render_javascript_partial(params)
+      output = []
+      # Render a JavaScript partial.
+      #
+      if params[:javascript]
+        content = render_javascripts(params[:javascript].to_a, params[:filename])
+        unless content.blank?
+          output << "<script type='text/javascript'>" if params[:tags]
+          output << content
+          output << "</script>" if params[:tags]
         end
-      else
-        ""
       end
+      output
     end
     
-    # Internal use only. Renders a JavaScript partial.
+    # Renders a JavaScript partial.
     #
     def render_javascripts(filenames, combined_filename=nil)
-      output = []
+      filenames_str = combined_filename || filenames.join()
       
-      # concatenate all javascript files into one long string
-      #
-      filenames.each do |filename|
-        output << render_without_compression(filename, false)
+      filenames.map! do |filename|
+        filename.gsub!(/\.js$/, "")
+        "#{BASE_PATH}/app/javascripts/#{filename}.js"
       end
-      output = output.join("\n")
       
-      filenames_str = combined_filename || filenames.join()
+      output = combine_files(filenames)
       tmp_filename = "./tmp/#{filenames_str}.js"
       
-      # use the saved file if it already exists
-      unless File.exists?(tmp_filename)
-        save_to_file(output, tmp_filename)
-        validate_filename = tmp_filename
-      end
-        
-      # return compressed javascript or else don't
-      output = YMDP::Compressor::JavaScript.compress(tmp_filename) || output
+      validate = F.save_to_file(output, tmp_filename)
+
+      output = YMDP::Compressor::JavaScript.compress(tmp_filename) if CONFIG.compress_embedded_js?
       
-      YMDP::Validator::JavaScript.validate(validate_filename) if validate_filename
+      YMDP::Validator::JavaScript.validate(tmp_filename) if validate && CONFIG.validate_embedded_js?
       
       output
     end
     
-    # Internal use only. Renders together a set of JavaScript files without 
-    # compression, so they can be compressed as a single block.
+    # Render a CSS partial.
     #
-    def render_without_compression(filename, tags=true)
-      unless filename =~ /\.js$/
-        filename = "#{filename}.js"
-      end
-      path = "#{BASE_PATH}/app/javascripts/#{filename}"
-  
-      output = ''
-    
-      if File.exists?(path)
-        File.open(path) do |f|
-          template = f.read
-          output = process_template(template)
-        end
-
-        if tags
-          "<script type='text/javascript'>\n" + output + "\n</script>"
-        else
-          output
+    def render_stylesheet_partial(params)
+      output = []
+      if params[:stylesheet]
+        content = render_stylesheets(params[:stylesheet].to_a, params[:filename])
+        unless content.blank?
+          output << "<style type='text/css'>" if params[:tags]
+          output << content
+          output << "</style>" if params[:tags]
         end
-      else
-        ""
       end
+      output      
     end
     
-    # Internal use only. Processes the template (with HAML or ERB) and saves it to the tmp folder
+    # Renders a JavaScript partial.
     #
-    def save_processed_template(path)
-      filename = path.split("/").last
-      tmp_filename = "#{TMP_PATH}/#{filename}"
-
-      unless File.exists?(tmp_filename)      
-        File.open(path) do |f|
-          template = f.read
-          output = process_template(template)
+    def render_stylesheets(filenames, combined_filename=nil)
+      filenames_str = combined_filename || filenames.join()
+      tmp_filename = "./tmp/#{filenames_str}.css"
+      
+      filenames.map! do |filename|
+        filename.gsub!(/\.css$/, "")
+        "#{BASE_PATH}/app/stylesheets/#{filename}.css"
+      end
+      
+      output = combine_files(filenames)
+      
+      validate = F.save_to_file(output, tmp_filename)
 
-          save_to_file(output, tmp_filename)
-        end
+      output = YMDP::Compressor::Stylesheet.compress(tmp_filename) if CONFIG.compress_css?
+      
+      # YMDP::Validator::Stylesheet.validate(tmp_filename) if validate && CONFIG.validate_embedded_css?
+      
+      output
+    end
+    
+    # Concatenates all javascript files into one long string.
+    #
+    def combine_files(filenames)
+      output = []
+      filenames.each do |filename|
+        output << render_without_compression(filename, false)
       end
+      output.join("\n")
+    end
+    
+    # Renders together a set of JavaScript files without 
+    # compression, so they can be compressed as a single block.
+    #
+    def render_without_compression(path, tags=true)
+      output = ""
     
-      tmp_filename      
+      if File.exists?(path)        
+        template = File.read(path)
+        output = process_template(template)
+      end
+      
+      output
     end
   end
+  
+  class View
+    include YMDP::ApplicationView
+
+    def initialize(assets_directory)
+      @assets_directory = assets_directory
+    end    
+  end
 end

data/lib/ymdp/base.rb

@@ -78,7 +78,28 @@ module YMDP
     #
     def paths
       self.class.paths
-    end   
+    end
+    
+    def self.base_path
+      paths[:base_path]
+    end
+    
+    def base_path
+      self.class.base_path
+    end
+    
+    # Parses out the <tt>base_path</tt> setting from a path to display it in a
+    # less verbose way.
+    #
+    def self.display_path(path)
+      path = File.expand_path(path)
+      path.gsub(base_path.to_s, "")
+    end
+    
+    def display_path(path)
+      self.class.display_path(path)
+    end
+    
     
     private
     

data/lib/ymdp/compiler/domains.rb

@@ -46,7 +46,7 @@ module YMDP
       # Commit to git and store the hash of the commit.
       #
       def commit
-        @git = GitHelper.new
+        @git = YMDP::GitHelper.new
         @git.do_commit(@message)
         @git_hash = git.get_hash(options[:branch])    
       end

data/lib/ymdp/compiler/git_helper.rb

@@ -1,23 +1,26 @@
+require 'support/file'
 require 'grit'
 include Grit
 
-class GitHelper
-  def get_hash(branch)
-    branch = get_current_branch || "master"
-    repo = Repo.new("#{BASE_PATH}/.")
-    repo.commits(branch).first.id
-  end
+module YMDP
+  class GitHelper
+    def get_hash(branch)
+      branch = get_current_branch || "master"
+      repo = Repo.new("#{BASE_PATH}/.")
+      repo.commits(branch).first.id
+    end
 
-  def get_current_branch
-    result = `git status`
-    if result =~ /# On branch (.*)/
-      return $1
+    def get_current_branch
+      result = F.execute("git status", :return => true)
+      if result =~ /# On branch (.*)/
+        return $1
+      end
     end
-  end
 
-  def do_commit(message)
-    repo = Repo.new(".")
-    repo.add(".")
-    puts `git commit -am "#{message}"`
+    def do_commit(message)
+      repo = Repo.new(".")
+      repo.add(".")
+      $stdout.puts F.execute("git commit -am \"#{message}\"", :return => true)
+    end
   end
 end