ymdp 0.1.6 → 0.1.7

data/lib/ymdp/compiler/template.rb

@@ -31,19 +31,19 @@ module YMDP
           @verbose = params[:verbose]
           @domain = params[:domain]
           
-          @file = params[:file]
-          @assets_directory = "/om/assets/#{servers[@domain]['assets_id']}"
-          @hash = params[:git_hash]
-          @message = params[:message]
-          
           server_settings = servers[@domain]
           if server_settings
             @server = server_settings["server"]
           else
-            raise StandardError.new("server name is required")
+            raise StandardError.new("Server settings are required.")
           end
           
-          raise StandardError.new("server name is required") unless @server
+          raise StandardError.new("Server name does not exist in server settings.") unless @server
+          
+          @file = params[:file]
+          @assets_directory = "/om/assets/#{servers[@domain]['assets_id']}"
+          @hash = params[:git_hash]
+          @message = params[:message]
           
           set_content_variables
           
@@ -73,12 +73,13 @@ module YMDP
         # If the filename begins with a _ it's a partial.
         #
         def partial?
-          @file =~ /#{paths[:base_path]}\/app\/views\/_/
+          File.basename(@file) =~ /^_/
         end
 
         # Compile this view unless it is a partial.
         #
         def build
+          # puts "Base build"
           unless partial?
             write_template(processed_template)
           end
@@ -87,17 +88,20 @@ module YMDP
         # Returns the compiled template code after its Haml or ERB has been processed.
         #
         def processed_template
+          # "Base processed_template"
           result = ""
-          File.open(@file) do |f|
-            template = f.read
-            if @file =~ /\.haml$/
-              result = process_haml(template, @file)
-            else
-              result = process_template(template)
-            end
+          template = File.read(@file)
+          if @file =~ /\.haml$/
+            result = process_haml(template, @file)
+          else
+            result = process_template(template)
           end
           result
         end
+        
+        def base_filename(filename)
+          raise "Define in child"
+        end
       
         # Implemented in child classes, this defines what must be done to process a template.
         #
@@ -153,11 +157,15 @@ module YMDP
         #
         def write_template_without_layout(result)
           path = destination_path
-    
+          
+          # puts "\n\n\nBase write_template_without_layout: #{result}, #{path}"
+          
           File.open(path, "w") do |f|
             f.write(result)
           end
           verbose "Finished writing #{path}.\n"
+          
+          result
         end
   
         # Writes the input string to the destination file, passing it through the
@@ -166,21 +174,16 @@ module YMDP
         # The application layout can be either Haml or ERB.
         #
         def write_template_with_layout(result)
+          # puts "Base write_template_with_layout"
           @content = result
+          layout = result
+          
           application_layout = "#{paths[:base_path]}\/app\/views\/layouts\/application.html"
           haml_layout = application_layout + ".haml"
-          erb_layout = application_layout + ".erb"
         
           if File.exists?(haml_layout)
-            layout = File.open(haml_layout) do |f|
-              template = f.read
-              process_haml(template, haml_layout)
-            end
-          elsif File.exists?(erb_layout)
-            layout = File.open(erb_layout) do |f|
-              template = f.read
-              process_template(erb_layout)
-            end
+            template = File.read(haml_layout)
+            layout = process_haml(template, haml_layout)
           end
         
           write_template_without_layout(layout)
@@ -192,6 +195,7 @@ module YMDP
         # uses a template or not.
         #
         def write_template(result)
+          # puts "Base write_template"
           write_template_with_layout(result)
         end
         
@@ -211,10 +215,7 @@ module YMDP
         # 
         include ActionView::Helpers::TagHelper
   
-        begin
-          include ApplicationHelper
-        rescue NameError
-        end
+        include ApplicationHelper if defined?(ApplicationHelper)
     
         include YMDP::ApplicationView
         include YMDP::AssetTagHelper
@@ -242,12 +243,14 @@ module YMDP
         # Process this template with ERB.
         #
         def process_template(template)
+          # puts "View process_template"
           ERB.new(template, 0, "%<>").result(binding)
         end
   
         # Process this template with Haml.
         #
         def process_haml(template, filename=nil)
+          # puts "View process_haml"
           options = {}
           if filename
             options[:filename] = filename
@@ -260,8 +263,11 @@ module YMDP
         # Validate the resulting HTML file if that option is turned on.
         #
         def write_template(result)
-          write_template_with_layout(result)
+          # puts "View write_template"
+          result = super(result)
           YMDP::Validator::HTML.validate(destination_path) if CONFIG.validate_html?
+          
+          result
         end
       end
 
@@ -277,7 +283,7 @@ module YMDP
         def write_template(result)
           filename = @file.split("/").last
           tmp_filename = "./tmp/#{filename}"
-          save_to_file(result, tmp_filename)
+          F.save_to_file(result, tmp_filename)
           result = YMDP::Compressor::JavaScript.compress(tmp_filename) if CONFIG.compress_embedded_js?
           write_template_without_layout(result)
         end
@@ -382,14 +388,14 @@ module YMDP
               key, value = key_and_value_from_line(line)
               unless key.blank?
                 if @hash.has_key?(key)
-                  puts
-                  puts "Duplicate value in #{destination_path}"
-                  puts "  #{key}=#{@hash[key]}"
-                  puts "  #{key}=#{value}"
-                  puts
+                  $stdout.puts
+                  $stdout.puts "Duplicate value in #{destination_path}"
+                  $stdout.puts "  #{key}=#{@hash[key]}"
+                  $stdout.puts "  #{key}=#{value}"
+                  $stdout.puts
                   if @hash[key] == value
-                    puts "  Values are the same but duplicate values still should not exist!"
-                    puts
+                    $stdout.puts "  Values are the same but duplicate values still should not exist!"
+                    $stdout.puts
                   end
                   raise "Duplicate key error"
                 end
@@ -403,7 +409,7 @@ module YMDP
         # Write JSON file to its destination.
         #
         def write_template(result)
-          puts destination_path if CONFIG.verbose?
+          $stdout.puts destination_path if CONFIG.verbose?
           write_template_without_layout(result)
         end
       end

data/lib/ymdp/configuration/config.rb

@@ -110,9 +110,9 @@ module YMDP
       end
       
       def file_not_found(filename)
-        puts
-        puts "Create #{filename} with the following command:\n\n  ./script/config" 
-        puts
+        $stdout.puts
+        $stdout.puts "Create #{filename} with the following command:\n\n  ./script/config" 
+        $stdout.puts
   
         raise "File not found: #{filename}"  
       end      

data/lib/ymdp/processor/compressor.rb

@@ -1,20 +1,54 @@
+require 'rubygems'
+require 'ymdp/base'
+require 'active_support'
 require 'support/file'
 
 module YMDP
-  module Compressor
-    class Base
-      extend YMDP::FileSupport
-  
+  module Compressor #:nodoc:
+    # Compresses a file using the specified compressor/minifier (currently YUI Compressor 2.4.2).
+    #
+    # === Usage
+    #
+    #   YMDP::Compressor::Base.compress("filename.js", "type" => "js")
+    #
+    #   YMDP::Compressor::Base.compress("filename.css", "type" => "css")
+    #
+    # Outputs the compressed file to <tt>_path_.min.</tt>
+    #
+    # === Options
+    # 
+    #   "type"::              "js" or "css". Identifies the file type.
+    #
+    #   "obfuscate"::         true or false. Change internal variable names within the code.
+    #                         
+    #   "verbose"::           true or false. Output warnings about code quality.
+    #
+    #   "preserve_semi"::     true or false. Preserve unnecessary semicolons.
+    #
+    # TODO: Make it support multiple compressors.
+    #
+    # TODO: Convert it to an object, so you instantiate the Compressor class and then call it
+    # on a file or a string.
+    #
+    # TODO: Get some stringify_keys! action going so you can send in symbols or strings.
+    #
+    class Base < YMDP::Base
       def self.compress(path, options={})
+        options.stringify_keys!
         compressed_display_path = display_path(path)
         compressed_path = "#{path}.min"
       
         options["type"] ||= "js"
-      
+        options["type"] = options["type"].to_s
+        
+        # if the compressed_file exists, don't create it again
+        #
         unless File.exists?(compressed_path)
           $stdout.print "   #{compressed_display_path}  compressing . . . "
           compressed = ''
         
+          # set options and defaults
+          #
           if options.delete("obfuscate")
             options["nomunge"] = ""
           end
@@ -27,21 +61,26 @@ module YMDP
             options["preserve-semi"] = ""
           end
         
+          # join the options together for appending to the command line
+          #
           options_string = options.map {|k,v| "--#{k} #{v}"}.join(" ")
       
-          result = `java -jar ./script/yuicompressor-2.4.2.jar #{options_string} #{path} -o #{compressed_path} 2>&1`
+          # call the compressor
+          #
+          command = "java -jar ./script/yuicompressor-2.4.2.jar #{options_string} #{path} -o #{compressed_path} 2>&1"
+          result = F.execute(command, :return => true)
         
           result.split("\n").each do |line|
             if line =~ /\[ERROR\] (\d+):(\d+):(.*)/
               line_number = $1.to_i
               error = "Error at #{compressed_display_path} line #{line_number} character #{$2}: #{$3}"
-              error += get_line_from_file(path, line_number)
+              error += F.get_line_from_file(path, line_number)
         
               $stdout.puts error
-              growl(error)
+              g(error)
             end
           end
-        
+          
           if result =~ /ERROR/
             raise "JavaScript errors in #{compressed_display_path}"
           else
@@ -49,10 +88,10 @@ module YMDP
           end
         end
 
+        # The compressed file should exist now. If it does, use it. If not, raise an error.
+        #
         if File.exists?(compressed_path)
-          File.open(compressed_path) do |c|
-            compressed = c.read
-          end
+          compressed = File.read(compressed_path)
         else
           raise "File does not exist: #{compressed_display_path}"
         end
@@ -61,13 +100,27 @@ module YMDP
       end
     end
     
+    # Compresses a CSS file using the specified compressor/minifier (currently YUI Compressor 2.4.2).
+    #
+    # === Usage
+    #
+    #   YMDP::Compressor::Stylesheet.compress("filename.css")
+    #
     class Stylesheet < Base
+      # TODO: Add options hash
       def self.compress(path)
         super(path, "type" => "css")
       end
     end
     
-    class JavaScript < Base      
+    # Compresses a JavaScript file using the specified compressor/minifier (currently YUI Compressor 2.4.2).
+    #
+    # === Usage
+    #
+    #   YMDP::Compressor::JavaScript.compress("filename.js")
+    #
+    class JavaScript < Base
+      # TODO: Add options hash   
       def self.compress(filename)
         super(filename, "type" => "js")
       end

data/lib/ymdp/processor/form_post.rb

@@ -4,9 +4,9 @@ require 'rubygems'
 require 'mime/types'
 require 'net/http'
 begin
-  require 'CGI'
+  require 'CGI' 
 rescue StandardError => e
-  puts e.message
+  # puts e.message
 end
  
 class FormField

data/lib/ymdp/processor/validator.rb

@@ -1,37 +1,51 @@
+require 'ymdp/base'
 require 'support/file'
 require 'processor/w3c'
 require 'processor/form_post'
 
 module YMDP
   module Validator
-    class Base
-      extend YMDP::FileSupport
+    class Base < YMDP::Base
     end
     
     class HTML < Base
       def self.validate(path)
         html_display_path = display_path(path)
+        log_path = "#{TMP_PATH}/#{File.basename(path)}_errors.html"
 
+        log_path = validation_errors(path)
+        if log_path
+          g("HTML validation errors found")
+          F.execute "open #{log_path}"
+          raise "Invalid HTML"
+        else
+          $stdout.puts "   #{html_display_path}  validating . . . OK"
+        end
+      end
+      
+      def self.validation_errors(path)
+        html_display_path = display_path(path)
         doctype = CONFIG["doctype"] || "HTML 4.0 Transitional"
 
-        resp = post_file_to_w3c_validator(path, doctype)
+        resp = W3CPoster.post_file_to_w3c_validator(path, doctype)
         html = resp.read_body
         if html.include? "[Valid]"
-          $stdout.puts "   #{html_display_path}  validating . . . OK"
-        else 
+          false
+        else
           log_path = "#{TMP_PATH}/#{File.basename(path)}_errors.html"
           $stdout.puts "   #{html_display_path} is not valid HTML, writing to #{display_path(log_path)}"
           $stdout.puts
           $stdout.puts "     To view errors:"
           $stdout.puts "     open #{display_path(log_path)}"
           $stdout.puts
-          File.open(log_path,'w') { |f| f.puts html }
-          $stdout.puts "     Viewing errors..."
-  
-          g("HTML validation errors found")
-          system "open #{log_path}"
-          raise "Invalid HTML"
-        end
+          
+          File.open(log_path,'w') do |f|
+             f.puts html
+           end
+           
+          $stdout.puts "     Viewing errors..."    
+          log_path
+        end  
       end
     end
     
@@ -79,7 +93,7 @@ JSLINT
             f.puts output
           end
 
-          results = `java org.mozilla.javascript.tools.shell.Main ./script/jslint.js #{js_fragment_path}`
+          results = F.execute("java org.mozilla.javascript.tools.shell.Main ./script/jslint.js #{js_fragment_path}", :return => true)
 
           if results =~ /jslint: No problems found/
             $stdout.puts "OK"
@@ -89,12 +103,12 @@ JSLINT
               if result =~ /line (\d+) character (\d+): (.*)/
                 line_number = $1.to_i
                 error = "Error at #{fragment_display_path} line #{line_number-jslint_settings_count} character #{$2}: #{$3}"
-                error += get_line_from_file(js_fragment_path, line_number)
+                error += F.get_line_from_file(js_fragment_path, line_number)
           
                 $stdout.puts error
               end
             end
-            message = "Javascript Errors embedded in #{display}"
+            message = "JavaScript Errors embedded in #{display}"
             g(message)
             raise message
           end
@@ -103,12 +117,18 @@ JSLINT
     end
     
     class JSON < JavaScript
-      def pre_process(output)
+      def self.pre_process(output)
         output
       end
       
       def self.jslint_settings
       end
     end
+    
+    class Stylesheet < Base
+      def self.validate(filename)
+        true
+      end
+    end
   end
 end