ymdp 0.1.3.1 → 0.1.3.2

data/Rakefile

@@ -21,6 +21,7 @@ begin
     gem.add_development_dependency "bundler", ">= 0"
     gem.add_development_dependency "timer", ">= 0"
     gem.add_development_dependency "serenity", ">= 0"
+    gem.add_development_dependency "ymdp_generator", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.3.1
+0.1.3.2

data/lib/ymdp/commands/generate.rb

@@ -1,3 +1,10 @@
-require 'generator/base'
+require 'translator/base'
 
-YMDP::Generator::Base.generate(ARGV)
+if ARGV[0] == "view"
+  p = {
+    :template_path => File.join(File.dirname(__FILE__), "..", "generator", "templates"),
+    :application_path => APPLICATION_PATH
+  }
+  YMDP::Generator::Base.new(p).generate(ARGV[1])
+  YMDP::Translator::YRB.translate
+end

data/lib/ymdp/compiler/template.rb

@@ -1,3 +1,17 @@
+# Process source files into usable code.
+#
+# Source files can be HTML, Haml, ERB, JavaScript, or CSS files.
+#
+# Files with an extension of ".haml" will be processed with Haml, all others will
+# use ERB.
+#
+# Usage:
+#
+#   YMDP::Template::View.new(params).build
+#   YMDP::Template::JavaScript.new(params).build
+#
+# See YMDP::Template::Base#initialize for details on params.
+#
 module YMDP
   module Template
     # Compiles a single file in a single domain, processing its Haml or ERB and turning
@@ -161,6 +175,14 @@ module YMDP
     end
 
     class View < Base
+      # TODO: Refactor this.  Right now it includes all the YMDP::Base and other helper files
+      # into the same namespace where we're processing the templates.  It does this so it can
+      # send its 'binding' into the ERB or Haml template and the template will be able to 
+      # process methods like "render :partial => 'sidebar'" and so on. 
+      #
+      # All the methods which are meant to be run from inside a view need to be refactored into
+      # their own class, which can be sent into the template as a binding.
+      # 
       include ActionView::Helpers::TagHelper
   
       begin
@@ -207,49 +229,72 @@ module YMDP
         Haml::Engine.new(template, options).render(self)
       end
   
+      # Write this template with the application layout applied.
+      #
+      # Validate the resulting HTML file if that option is turned on.
+      #
       def write_template(result)
         write_template_with_layout(result)
         YMDP::Validator::HTML.validate(destination_path) if CONFIG.validate_html?
       end
     end
 
+    # Process templates for JavaScript files.
+    # 
+    # JavaScript files support ERB tags.
+    #
     class JavaScript < View
-      def compress_js(filename)
-        if compress_js_assets?
-          validate_filename = "#{filename}.min"
-          YMDP::Compressor::JavaScript.compress(filename)
-        end
-      end
-    
+      # Write the processed template without any layout.
+      #
+      # Run the JavaScript compressor on the file if that option is turned on.
+      #
       def write_template(result)
         filename = @file.split("/").last
         tmp_filename = "./tmp/#{filename}"
         save_to_file(result, tmp_filename)
-        result = YMDP::Compressor::JavaScript.compress(tmp_filename) || result
+        result = YMDP::Compressor::JavaScript.compress(tmp_filename) if CONFIG.compress_embedded_js?
         write_template_without_layout(result)
       end
     end
 
+    # Process Yahoo! Resource Bundle format translation files.
+    #
+    # Convert them to a hash and write the hash to a JSON file.
+    #
+    # Each language can have as many YRB translation files (with an extension of ".pres")
+    # as necessary.  The files are concatenated together and translated into a single JSON file
+    # for each language.
+    #
     class YRB < Base
+      # Base directory for translations for this domain.
+      #
       def directory
         directory = "#{BASE_PATH}/servers/#{@domain}/assets/yrb"
         FileUtils.mkdir_p(directory)
         directory
       end
   
+      # The destination of the compiled JSON file.
+      #
       def destination_path
         filename = convert_filename(@file.split("/").last)
         "#{directory}/#{filename}"
       end  
   
+      # JSON values of the compiled translations.
+      #
       def to_json
         processed_template
       end
   
+      # Turn it back into a hash.
+      #
       def to_hash
         JSON.parse(to_json)
       end
   
+      # Convert the hash to Yaml if you should want to do that.
+      #
       def to_yaml
         h = {}
         to_hash.each do |k,v|
@@ -259,32 +304,56 @@ module YMDP
         h.to_yaml
       end
   
+      # This function is the file which is written to the destination--in this
+      # case, the JSON file.
+      #
       def processed_template
         super.to_json
       end
   
+      # Validate the JSON file.
+      #
       def validate
         YMDP::Validator::JSON.validate(destination_path)
       end
   
       private
-  
+      
+      # Strip off the ".pres" extension from original YRB files.
+      #
       def base_filename(filename)    
         filename.gsub(/\.pres/, "")
       end
   
+      # Take the base filename and add the ".json" extension.
+      #
       def convert_filename(filename)
         "#{base_filename(filename)}.json"
       end
+      
+      # Is this line a valid comment in YRB?
+      def comment?(line)
+        line =~ /^[\s]*#/
+      end
+      
+      # Is this line valid YRB syntax?
+      #
+      def key_and_value_from_line(line)
+        if line =~ /^([^\=]+)=(.+)/
+          return $1, $2.strip
+        else
+          return nil, nil
+        end
+      end
   
+      # Parse YRB and add it to a hash.  Raise an error if the key already exists in the hash.
+      #
       def process_template(template)
         @hash = {}
         lines = template.split("\n")
         lines.each do |line|
-          unless line =~ /^[\s]*#/
-            line =~ /^([^\=]+)=(.+)/
-            key = $1
-            value = $2
+          unless comment?(line)
+            key, value = key_and_value_from_line(line)
             unless key.blank?
               if @hash.has_key?(key)
                 puts
@@ -305,6 +374,8 @@ module YMDP
         @hash
       end
   
+      # Write JSON file to its destination.
+      #
       def write_template(result)
         puts destination_path if CONFIG.verbose?
         write_template_without_layout(result)

data/lib/ymdp/configuration/constants.rb

@@ -1,5 +1,5 @@
 YMDP_ROOT = BASE_PATH unless defined?(YMDP_ROOT)
 TMP_DIR = TMP_PATH unless defined?(TMP_DIR)
 
-CONFIG = YMDP::Configuration::Config.new
-SERVERS = YMDP::Configuration::Servers.new
+CONFIG = YMDP::Configuration::Config.new unless defined?(CONFIG)
+SERVERS = YMDP::Configuration::Servers.new unless defined?(SERVERS)

data/lib/ymdp/support/file.rb

@@ -2,8 +2,8 @@ module YMDP
   module FileSupport
     def confirm_overwrite(path)
       if File.exists?(path)
-        puts "File exists: #{display_path(path)}"
-        print "  overwrite? (y/n)"
+        $stdout.puts "File exists: #{File.expand_path(path)}"
+        $stdout.print "  overwrite? (y/n)"
         answer = $stdin.gets
         
         answer =~ /^y/i

data/lib/ymdp/support/form_post.rb

@@ -3,7 +3,7 @@
 require 'rubygems'
 require 'mime/types'
 require 'net/http'
-require 'CGI'
+# require 'CGI'
  
 class FormField
   attr_accessor :name, :value

data/lib/ymdp/translator/base.rb

@@ -109,7 +109,7 @@ module YMDP
       end
       
       def self.translate
-        time do
+        Timer.new(:title => "YMDP").time do
           original_translations.each do |path|
             puts "Processing #{display_path(path)}"
             template.new(path).copy
@@ -360,7 +360,7 @@ module YMDP
       end
       
       def parse_template(p)
-        YRBTemplate.new(p).to_hash
+        YMDP::Template::YRB.new(:file => p, :domain => "staging").to_hash
       end
       
       def format(key, value)

data/ymdp.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ymdp}
-  s.version = "0.1.3.1"
+  s.version = "0.1.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jeff Coleman"]
@@ -93,12 +93,10 @@ Gem::Specification.new do |s|
      "lib/ymdp/compiler/template.rb",
      "lib/ymdp/configuration/config.rb",
      "lib/ymdp/configuration/constants.rb",
-     "lib/ymdp/generator/base.rb",
      "lib/ymdp/generator/templates/javascript.js",
      "lib/ymdp/generator/templates/stylesheet.css",
      "lib/ymdp/generator/templates/translation.pres",
      "lib/ymdp/generator/templates/view.html.haml",
-     "lib/ymdp/generator/view.rb",
      "lib/ymdp/helpers.rb",
      "lib/ymdp/processor/compressor.rb",
      "lib/ymdp/processor/processor.rb",
@@ -213,6 +211,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<bundler>, [">= 0"])
       s.add_development_dependency(%q<timer>, [">= 0"])
       s.add_development_dependency(%q<serenity>, [">= 0"])
+      s.add_development_dependency(%q<ymdp_generator>, [">= 0"])
     else
       s.add_dependency(%q<haml>, [">= 0"])
       s.add_dependency(%q<json>, [">= 0"])
@@ -225,6 +224,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<bundler>, [">= 0"])
       s.add_dependency(%q<timer>, [">= 0"])
       s.add_dependency(%q<serenity>, [">= 0"])
+      s.add_dependency(%q<ymdp_generator>, [">= 0"])
     end
   else
     s.add_dependency(%q<haml>, [">= 0"])
@@ -238,6 +238,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<bundler>, [">= 0"])
     s.add_dependency(%q<timer>, [">= 0"])
     s.add_dependency(%q<serenity>, [">= 0"])
+    s.add_dependency(%q<ymdp_generator>, [">= 0"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ymdp
 version: !ruby/object:Gem::Version 
-  version: 0.1.3.1
+  version: 0.1.3.2
 platform: ruby
 authors: 
 - Jeff Coleman
@@ -122,6 +122,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: ymdp_generator
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: Framework for developing applications in the Yahoo! Mail Development Platform.
 email: progressions@gmail.com
 executables: 
@@ -206,12 +216,10 @@ files:
 - lib/ymdp/compiler/template.rb
 - lib/ymdp/configuration/config.rb
 - lib/ymdp/configuration/constants.rb
-- lib/ymdp/generator/base.rb
 - lib/ymdp/generator/templates/javascript.js
 - lib/ymdp/generator/templates/stylesheet.css
 - lib/ymdp/generator/templates/translation.pres
 - lib/ymdp/generator/templates/view.html.haml
-- lib/ymdp/generator/view.rb
 - lib/ymdp/helpers.rb
 - lib/ymdp/processor/compressor.rb
 - lib/ymdp/processor/processor.rb

data/lib/ymdp/generator/base.rb

@@ -1,15 +0,0 @@
-require 'generator/view'
-
-module YMDP
-  module Generator
-    class Base
-      def self.generate(args)
-        @command = args.shift
-        
-        if @command == "view"
-          YMDP::Generator::View.new(args).generate
-        end
-      end
-    end
-  end
-end

data/lib/ymdp/generator/view.rb

@@ -1,170 +0,0 @@
-require 'support/file'
-require 'translator/base'
-require 'erb'
-
-module YMDP
-  module Generator
-    module Snippets
-      def launcher_method(view)
-        view = view.downcase
-        class_name = view.capitalize
-<<-OUTPUT
-
-Launcher.launch#{class_name} = function() {
-  Launcher.launchTab("#{view}", "#{class_name}");
-};
-OUTPUT
-      end
-    end
-    
-    module Templates
-      class Base
-        include YMDP::FileSupport
-        
-        attr_accessor :view
-        
-        def initialize(view)
-          @view = view
-        end
-        
-        def generate
-          write_processed_template
-        end
-        
-        def template_dir
-          "#{APPLICATION_PATH}/generator/templates"
-        end
-  
-        def process_template(template)
-          ERB.new(template, 0, "%<>").result(binding)
-        end
-        
-        def processed_template
-          result = ""
-          File.open(full_template_path) do |f|
-            template = f.read
-            result = process_template(template)
-          end
-          result          
-        end
-        
-        def write_processed_template
-          write_to_file
-        end
-        
-        def destination_path
-          "#{destination_dir}/#{destination_filename}"
-        end
-        
-        def full_template_path
-          "#{template_dir}/#{template_filename}"
-        end
-        
-        def write_processed_template
-          if confirm_overwrite(destination_path)
-            append_to_file(destination_path, processed_template)
-          end
-        end
-        
-        def append_to_file(file, content)
-          File.open(file, "a") do |f|
-            puts "  #{display_path(file)} writing . . ."
-            f.puts content
-          end
-        end
-      end
-      
-      class View < Base
-        def template_filename
-          "view.html.haml"
-        end
-        
-        def destination_filename
-          "#{view}.html.haml"
-        end
-        
-        def destination_dir
-          "#{BASE_PATH}/app/views"
-        end
-      end
-    
-      class JavaScript < Base
-        def template_filename
-          "javascript.js"  
-        end
-        
-        def destination_dir
-          "#{BASE_PATH}/app/javascripts"
-        end
-        
-        def destination_filename
-          "#{view}.js"
-        end
-      end
-    
-      class Stylesheet < Base
-        def template_filename
-          "stylesheet.css"
-        end
-        
-        def destination_dir
-          "#{BASE_PATH}/app/stylesheets"
-        end
-        
-        def destination_filename
-          "#{view}.css"
-        end
-      end
-    
-      class Translation < Base
-        def template_filename
-          "translation.pres"
-        end
-        
-        def destination_dir
-          "#{BASE_PATH}/app/assets/yrb/en-US"
-        end
-        
-        def destination_filename
-          "new_#{view}_en-US.pres"
-        end
-      end
-      
-      class Modifications < Base
-        include Snippets
-        
-        def generate
-          content = launcher_method(view)
-          append_to_file(destination_path, content)
-        end
-        
-        def destination_dir
-          "#{BASE_PATH}/app/javascripts"
-        end
-        
-        def destination_filename
-          "launcher.js"
-        end
-      end
-    end
-    
-    class View
-      attr_accessor :view
-      
-      def initialize(args)
-        @view = args.first
-      end
-      
-      def generate
-        puts "Create a new view: #{view}"
-        
-        Templates::View.new(view).generate
-        Templates::JavaScript.new(view).generate
-        Templates::Stylesheet.new(view).generate
-        Templates::Translation.new(view).generate
-        Templates::Modifications.new(view).generate
-        YMDP::Translator::YRB.translate
-      end
-    end
-  end
-end