ymdp 0.1.4 → 0.1.6

data/lib/ymdp/commands/build.rb

@@ -3,12 +3,6 @@ YMDP_ENV = "build"
 require 'compiler/options'
 require 'compiler/domains'
 
-YMDP::Compiler::Template::Base.base_path = BASE_PATH
-YMDP::Compiler::Template::Base.servers = SERVERS
-
-YMDP::Compiler::Domains.base_path = BASE_PATH
-YMDP::Compiler::Domains.servers = SERVERS
-
 @options = YMDP::Compiler::Options.parse
 YMDP::Compiler::Domains.new(@options).compile
 

data/lib/ymdp/compiler/base.rb

@@ -1,6 +1,6 @@
 # Compiles the source code for an individual domain.
 #
-# Usage:
+# ==== Examples
 #
 #   @compiler = YMDP::Compiler::Base.new('staging', 'asdfh23rh2fas', :base_path => ".", :server => {
 #     "server" => "staging", "application_id" => "12345", "assets_id" => "abcdefg_1" })
@@ -10,8 +10,8 @@
 #   @compiler.build
 #
 module YMDP
-  module Compiler
-    class Base
+  module Compiler #:nodoc:
+    class Base 
       attr_accessor :domain, :git_hash, :options, :base_path, :server
   
       # A TemplateCompiler instance covers a single domain, handling all the processing necessary to 
@@ -24,6 +24,9 @@ module YMDP
         @base_path = options[:base_path]
         @server = options[:server]
         
+        raise ArgumentError.new("domain is required") unless @domain
+        raise ArgumentError.new("server is required") unless @server
+        
         raise ArgumentError.new("base_path is required") unless @base_path
       end
       
@@ -43,7 +46,6 @@ module YMDP
 
       # Do all the processing necessary to convert all the application source code from the given path
       # into usable destination files ready for upload to the server:
-      #
       # - create server directory if necessary,
       # - for each file in the source path, build the file, and
       # - copy the images from the source to the destination directory.
@@ -62,8 +64,8 @@ module YMDP
       end
   
       # Build this file if it's either:
-      #   - a view, but not a partial or layout, or
-      #   - a JavaScript file.
+      # - a view, but not a partial or layout, or
+      # - a JavaScript file.
       #
       def build_file(file)
         params = {
@@ -88,7 +90,7 @@ module YMDP
       #
       def process_all_translations
         $stdout.puts "Processing ./app/assets/yrb/ for #{domain}"
-        YMDP::Base.supported_languages.each do |lang|
+        YMDP::ApplicationView.supported_languages.each do |lang|
           process_each_yrb(lang)
         end
       end
@@ -96,7 +98,7 @@ module YMDP
       # Convert the YRB translation files of a single language for this domain into a single JSON file.
       #
       def process_each_yrb(lang)
-        tmp_file = "#{TMP_DIR}/keys_#{lang}.pres"
+        tmp_file = "#{TMP_PATH}/keys_#{lang}.pres"
     
         # Concatenate together all the YRB ".pres" files for this language into one file in the tmp dir.
         #
@@ -117,8 +119,8 @@ module YMDP
         FileUtils.rm_rf("#{dir}/assets/javascripts")
         FileUtils.rm_rf("#{dir}/assets/stylesheets")
         FileUtils.rm_rf("#{dir}/assets/yrb")
-        FileUtils.rm_rf("#{TMP_DIR}/")
-        FileUtils.mkdir_p(TMP_DIR)
+        FileUtils.rm_rf("#{TMP_PATH}/")
+        FileUtils.mkdir_p(TMP_PATH)
       end
 
       # Format text in a standard way for output to the screen.

data/lib/ymdp/compiler/domains.rb

@@ -14,7 +14,7 @@ module YMDP
   module Compiler
     # Covers all the domains and the actions that are taken on all domains at once.
     #
-    class Domains
+    class Domains < YMDP::Base
       attr_accessor :git, :git_hash, :message, :domains, :options
   
       def initialize(options=nil)
@@ -26,35 +26,7 @@ module YMDP
 
         commit if @options[:commit]
       end
-      
-      # Class Methods to handle global stuff like base path and server settings
-      
-      def self.base_path= base_path
-        @@base_path = base_path
-      end
-      
-      def self.base_path
-        @@base_path
-      end
-      
-      def self.servers= servers
-        @@servers = servers
-      end
-      
-      def self.servers
-        @@servers
-      end
-      
-      # Instance Methods to access global stuff like base path and server settings
-      
-      def servers
-        @@servers
-      end
-      
-      def base_path
-        @@base_path
-      end
-  
+        
       # Compile the source code for all domains into their usable destination files.
       #
       def compile
@@ -83,6 +55,8 @@ module YMDP
       #
       def process_domains
         domains.each do |domain|
+          params = options
+          params[:server] = servers[domain]["server"]
           compiler = YMDP::Compiler::Base.new(domain, git_hash, options)
           
           compiler.process_all
@@ -92,11 +66,11 @@ module YMDP
       # Perform a block, starting with a clean 'tmp' directory and ending with one.
       #
       def clean_tmp_dir
-        system "rm -rf #{TMP_DIR}"
-        system "mkdir #{TMP_DIR}"
+        system "rm -rf #{TMP_PATH}"
+        system "mkdir #{TMP_PATH}"
         yield
-        system "rm -rf #{TMP_DIR}"
-        system "mkdir #{TMP_DIR}"
+        system "rm -rf #{TMP_PATH}"
+        system "mkdir #{TMP_PATH}"
       end
     end
   end

data/lib/ymdp/compiler/template.rb

@@ -1,36 +1,30 @@
-# 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::Compiler::Template::View.new(params).build
-#   YMDP::Compiler::Template::JavaScript.new(params).build
-#
-# See YMDP::Compiler::Template::Base#initialize for details on params.
-#
 module YMDP
-  module Compiler
-    module Template
-      # Compiles a single file in a single domain, processing its Haml or ERB and turning
-      # it into usable destination files in the 'servers' directory.
+  module Compiler #:nodoc:
+    module Template #:nodoc:
+      # Process source files into usable code.
       #
-      class Base
-        # Usage:
-        # 
-        #   @template = YMDP::Compiler::Template::Base.new(params)
-        #
-        # Arguments:
-        #
-        #   - verbose: boolean value, output verbose notices,
-        #   - domain: string, indicates which domain the template is compiling to,
-        #   - file: filename of the template in question,
-        #   - hash: git hash of the latest commit,
-        #   - message: commit message of the latest commit.
-        #
+      # 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.
+      #
+      # ==== Examples
+      #
+      #   YMDP::Compiler::Template::View.new(params).build
+      #
+      #   YMDP::Compiler::Template::JavaScript.new(params).build
+      # 
+      #   @template = YMDP::Compiler::Template::Base.new(params)
+      #
+      # ==== Options
+      #
+      #   verbose: boolean value, output verbose notices,
+      #   domain: string, indicates which domain the template is compiling to,
+      #   file: filename of the template in question,
+      #   hash: git hash of the latest commit,
+      #   message: commit message of the latest commit.
+      #
+      class Base < YMDP::Base
         attr_accessor :domain, :server, :file, :assets_directory, :hash, :message
         
         def initialize(params)
@@ -41,9 +35,18 @@ module YMDP
           @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")
+          end
+          
+          raise StandardError.new("server name is required") unless @server
+          
           set_content_variables
-    
+          
           @view = base_filename(@file.split("/").last)
           Application.current_view = @view
         end
@@ -58,17 +61,19 @@ module YMDP
         # an instance variable, so they will be available inside the template.
         #
         def set_content_variables
-          content = YAML.load_file("#{CONFIG_PATH}/content.yml")
-          content.each do |key, value|
+          content_variables.each do |key, value|
             attribute = "@#{key}"
             instance_variable_set(attribute, value) unless instance_variable_defined?(attribute)
+            class_eval %(
+              attr_accessor :#{key}
+            )
           end
         end
       
         # If the filename begins with a _ it's a partial.
         #
         def partial?
-          @file =~ /#{base_path}\/app\/views\/_/
+          @file =~ /#{paths[:base_path]}\/app\/views\/_/
         end
 
         # Compile this view unless it is a partial.
@@ -103,10 +108,15 @@ module YMDP
         # Produces the destination path of this template, in the servers directory for
         # the given domain.
         #
-        # For example:
+        # ==== Examples
+        #
+        # If the source file is:
+        # 
+        #   app/views/authorize.html.haml
+        #
+        # The destination file will be:
         #
-        #   source: app/views/authorize.html.haml
-        #   destination: servers/staging/views/authorize.html.haml
+        #   servers/staging/views/authorize.html.haml
         #
         def destination_path
           # just the file, with no directory
@@ -119,7 +129,7 @@ module YMDP
           directory = File.dirname(@file)
         
           # replace the app directory with the server directory
-          relative_directory = directory.gsub!("#{base_path}/app", server_path)
+          relative_directory = directory.gsub!("#{paths[:base_path]}/app", server_path)
         
           # make the directory if it doesn't exist
           FileUtils.mkdir_p(relative_directory)
@@ -127,10 +137,7 @@ module YMDP
           "#{relative_directory}/#{filename}"
         end
       
-        # Path to the servers directory for the current domain:
-        #
-        # - "./servers/staging"
-        # - "./servers/alpha"
+        # Path to the servers directory for the current domain.
         #
         def server_path
           "#{servers_path}/#{@domain}"
@@ -160,7 +167,7 @@ module YMDP
         #
         def write_template_with_layout(result)
           @content = result
-          application_layout = "#{base_path}\/app\/views\/layouts\/application.html"
+          application_layout = "#{paths[:base_path]}\/app\/views\/layouts\/application.html"
           haml_layout = application_layout + ".haml"
           erb_layout = application_layout + ".erb"
         
@@ -181,54 +188,20 @@ module YMDP
   
         # Write this processed template to its destination file.
         #
-        # Overwrite in child class to define whether the class uses a template or not.
+        # Overwrite this method in child class to define whether the class 
+        # uses a template or not.
         #
         def write_template(result)
           write_template_with_layout(result)
         end
         
         def servers_path
-          "#{base_path}/servers"
+          "#{paths[:base_path]}/servers"
         end
-
-
-
-
-      
-      # Class Methods to handle global stuff like base path and server settings
-      
-      def self.base_path= base_path
-        @@base_path = base_path
-      end
-      
-      def self.base_path
-        @@base_path
-      end
-      
-      def self.servers= servers
-        @@servers = servers
-      end
-      
-      def self.servers
-        @@servers
-      end
-      
-      # Instance Methods to access global stuff like base path and server settings
-      
-      def servers
-        @@servers
-      end
-      
-      def base_path
-        @@base_path
-      end
-  
-
-        
       end
 
       class View < Base
-        # TODO: Refactor this.  Right now it includes all the YMDP::Base and other helper files
+        # TODO: Refactor this.  Right now it includes all the YMDP::ApplicationView 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. 
@@ -243,7 +216,7 @@ module YMDP
         rescue NameError
         end
     
-        include YMDP::Base
+        include YMDP::ApplicationView
         include YMDP::AssetTagHelper
         include YMDP::FormTagHelper
         include YMDP::LinkTagHelper
@@ -322,7 +295,7 @@ module YMDP
         # Base directory for translations for this domain.
         #
         def directory
-          directory = "#{base_path}/servers/#{@domain}/assets/yrb"
+          directory = "#{paths[:base_path]}/servers/#{@domain}/assets/yrb"
           FileUtils.mkdir_p(directory)
           directory
         end

data/lib/ymdp/configuration/config.rb

@@ -1,43 +1,85 @@
 require 'serenity'
+require 'yaml'
 
 module YMDP
-  module Configuration
-    module Helpers
-      def self.included(klass)
-        klass.send :extend, ClassMethods
-        klass.send :include, InstanceMethods
-      end
+  module Configuration #:nodoc:
+    # Provides an interface to set global configuration variables inside a block.
+    #
+    # Used by the YMDP::Base <tt>configure</tt> method.
+    #
+    # == Examples
+    #
+    # In the following example, the <tt>config</tt> variable inside the block is an
+    # instance of YMDP::Configuration::Setter.
+    #
+    #   YMDP::Base.configure do |config|
+    #     config.username = 'malreynolds'
+    #     config.load_content_variables('content')
+    #   end
+    #
+    # It is then up to YMDP::Base.configure to take the Setter instance and set all the 
+    # appropriate options based on its settings.
+    #
+    class Setter
+      # String value containing the login used to communicate with the Yahoo! Mail Development
+      # Platform to deploy the application.
+      attr_accessor :username
       
-      module ClassMethods
-        # Class Methods to handle global stuff like base path and server settings
+      # String value containing the password used to communicate with the Yahoo! Mail Development
+      # Platform to deploy the application.
+      attr_accessor :password
       
-        def self.base_path= base_path
-          @@base_path = base_path
-        end
+      # String value containing the default_server name. Matches the related entry in the 
+      # <tt>servers</tt> hash to define which server is the default for rake tasks such as 
+      # <tt>deploy</tt>.
+      attr_accessor :default_server
       
-        def self.base_path
-          @@base_path
-        end
+      # Boolean value which sets whether Growl notifications should be used when compiling 
+      # and deploying the application.
+      attr_accessor :growl
       
-        def self.servers= servers
-          @@servers = servers
-        end
+      # Hash value containing settings which tell the application when to compress CSS and JavaScript.
+      attr_accessor :compress
       
-        def self.servers
-          @@servers
-        end
+      # Hash value containing settings which tell the application when to validate HTML and JavaScript.
+      attr_accessor :validate
+      
+      # Boolean value which sets whether to output verbose messages or not.
+      attr_accessor :verbose
+      
+      # Hash value containing content variables which are made available to the views at build time.
+      attr_accessor :content_variables
+      
+      # Hash value containing application data about the servers, such as their asset and application IDs.
+      attr_accessor :servers
+      
+      # Hash value containing paths used by the application to locate its files. This can be used to
+      # overwrite default settings.
+      attr_accessor :paths
+      
+      def initialize #:nodoc:
+        @paths = {}
+        @content_variables = {}
       end
       
-      module InstanceMethods      
-        # Instance Methods to access global stuff like base path and server settings
+      # Adds an entry to the <tt>paths</tt> hash. 
+      #
+      def add_path(name, value)
+        @paths[name] = value
+      end
       
-        def servers
-          send :class_attribute_get, "#@@servers"
-        end
+      # Adds an entry to the <tt>content_variables</tt> hash.
+      #
+      def add_content_variable(name, value)
+        @content_variables[name] = value
+      end
       
-        def base_path
-          @@base_path
-        end
+      # Loads the <tt>content_variables</tt> hash from a Yaml file.
+      #
+      def load_content_variables(filename)
+        path = "#{CONFIG_PATH}/#{filename}".gsub(/\.yml$/, "")
+        path = "#{path}.yml"
+        @content_variables = YAML.load_file(path)
       end
     end