qedproject 0.0.5 → 0.0.8

data/bin/qedproject

@@ -11,6 +11,7 @@ options = {}
 LIBRARIES = QEDProject::Libraries::Base.libs.keys
 OptionParser.new do |opts|
   opts.banner = "Usage: qedproject <projectname> [options]"
+  opts.banner << "\nAvailable Libraries are: #{LIBRARIES.join(",")}"
 
 
   opts.on('-s', '--sass', "Use SASS") do
@@ -28,10 +29,20 @@ OptionParser.new do |opts|
   opts.on('-t', '--testing', "Set up testing with Jasmine") do
     options[:testing] = true
   end
-
-  opts.on("-l", "--libs [LIBRARIES]", "comma-separated list of libraries to include.\nLibraries are: #{LIBRARIES.join(",")}") do |libs|
+  
+  opts.on('-p', '--public-dir [DIR]', 'Specify the name of the public folder') do |dir|
+    options[:public_dir] = dir
+  end
+  
+  opts.on("-l", "--libs [LIBRARIES]", "comma-separated list of libraries to include") do |libs|
     options[:libs] = libs.split(",").collect{ |f| f.to_sym }
   end
+  
+  opts.on('--skip-index', 'Skip creating a default index.html file') do
+    options[:skip_index] = true
+  end
+
+
 end.parse!
 options[:verbose] = true 
 project = ARGV[0]

data/lib/qedproject/helpers.rb

@@ -1,5 +1,26 @@
 module QEDProject
   module Helpers
+    
+    # Copies a file - wraps FileUtils to print a nice message if verbose is on.
+    
+    def cp(source, destination, options = {})
+      verbose = options[:verbose] || false
+      FileUtils.cp source, destination
+      puts "Created #{File.join destination, File.basename(source)}" if verbose
+    end
+    
+    def cp_r(source, destination, options = {})
+      verbose = options[:verbose] || false
+      FileUtils.cp_r source, destination
+      puts "Created #{File.join destination, File.basename(source)}" if verbose
+    end
+    
+    def mkdir_p(destination, options = {})
+      FileUtils.mkdir_p destination
+      puts "Created folder #{destination}" if verbose
+    end
+    
+    
     # Reads a template from the file system,
     # evaluates it with ERB
     # places it in the output folder specified.

data/lib/qedproject/libraries/base.rb

@@ -13,16 +13,33 @@ module QEDProject
         # when creating the adapter.
         # Adds the library and class to QEDProject::Libraries::Base.libs hash
         # and also creates a getter method on the adapter instance
-        def library(name)
+        def library(name, base_path = __FILE__)          
           QEDProject::Libraries::Base.libs ||= {}
           QEDProject::Libraries::Base.libs[name] = self
           class_eval do
             define_method :library do
               name
             end
+            
+            define_method :vendor_root do
+              File.expand_path("../../../../vendor", base_path)
+            end
+            
           end
         end 
         
+        # DSL again, this lets you specify dependencies. 
+        # Creates a dependencies class instance method
+        # we can use later.
+        def depends_on(libraries)
+          m = class << self; self; end
+          m.send :define_method, :dependencies do
+            libraries
+          end
+        end
+        
+        # for the DSL, creates both an instance
+        # method and a class instance method
         def set_js_files(files)
           # define class method
           m = class << self; self; end
@@ -72,7 +89,8 @@ module QEDProject
 
       def initialize(project) 
         @project = project
-        @lib_root = File.join(@project.vendor_root, self.library.to_s)
+        
+        @lib_root = File.join(self.vendor_root, self.library.to_s)
         @template_root = File.join(@lib_root, "templates")
       end
       
@@ -84,19 +102,19 @@ module QEDProject
       
       def copy_images
         self.image_files.each do |lib|
-          ::FileUtils.cp_r File.join(self.lib_root, lib), File.join(self.project.path, self.project.images_path), :verbose => self.project.verbose
+          cp_r File.join(self.lib_root, lib), File.join(self.project.path, self.project.images_path), :verbose => self.project.verbose
         end
       end
       
       def copy_css
         self.css_files.each do |lib|
-          ::FileUtils.cp_r File.join(self.lib_root, lib), File.join(self.project.path, self.project.css_path), :verbose => self.project.verbose
+          cp_r File.join(self.lib_root, lib), File.join(self.project.path, self.project.css_path), :verbose => self.project.verbose
         end
       end
 
       def copy_js
         self.js_files.each do |lib|
-          ::FileUtils.cp_r File.join(self.lib_root, lib), File.join(self.project.path, self.project.js_path), :verbose => self.project.verbose
+         cp_r File.join(self.lib_root, lib), File.join(self.project.path, self.project.js_path), :verbose => self.project.verbose
         end
       end
 

data/lib/qedproject/libraries/jquerymobile.rb

@@ -0,0 +1,24 @@
+module QEDProject
+  module Libraries
+    class Jquerymobile < QEDProject::Libraries::Base
+      library :jquerymobile
+      depends_on [:jquery]
+      set_js_files ["jquery.mobile-1.0b2.js"]
+      set_css_files ["jquery.mobile-1.0b2.css" ] 
+      set_image_files [
+        "ajax-loader.png",
+        "icons-18-black.png",
+        "icons-18-white.png",
+        "icons-36-black.png",
+        "icons-36-white.png",
+        "icon-search-black.png"
+      ]
+
+      def generate!
+        super                                                                                     
+        render_template_to_file "index.html", File.join(self.project.path, self.project.public_dir, "index-mobile.html"), binding
+      end
+
+    end
+  end
+end

data/lib/qedproject/libraries/jquerytmpl.rb

@@ -2,6 +2,7 @@ module QEDProject
   module Libraries
     class JQuerytmpl < QEDProject::Libraries::Base
       library :jquerytmpl
+      depends_on [:jquery]
       set_js_files ["jquery.tmpl.min.js"]
     end
   end

data/lib/qedproject/libraries/skeleton.rb

@@ -13,7 +13,9 @@ module QEDProject
 
       def generate!
         super
-        render_template_to_file "index.html", File.join(self.project.path, "public", "index.html"), binding
+        index_file = File.join(self.project.path, self.project.public_dir, "index.html")
+        FileUtils.rm_rf index_file if File.exist?(index_file)
+        render_template_to_file "index.html", index_file, binding
       end
 
     end

data/lib/qedproject/plugins.rb

@@ -0,0 +1,12 @@
+module QEDProject
+  module Plugins
+    
+    def self.load_plugins
+      Gem.refresh
+      (Gem::Specification.respond_to?(:each) ? Gem::Specification : Gem.source_index.find_name('')).each do |gem|
+        next if gem.name !~ /^qedproject-/
+        require gem.name
+      end
+    end
+  end
+end

data/lib/qedproject/project.rb

@@ -6,8 +6,10 @@ module QEDProject
     
     include QEDProject::Helpers
     
-    attr_accessor :path, :libs, :coffeescript, :sass, :jammit,
-                  :js_path, :css_path, :images_path, :verbose, :testing
+    attr_accessor :path, :libs, :coffeescript, :sass, :jammit, :public_dir,
+                  :js_path, :css_path, :images_path, :verbose, :testing, :skip_index,
+                  :sorted_libs,
+                  :css_assets, :js_assets
     # convenience method to create a new project.
     # Simply call create with the project path and the options.
     def self.create(project_path, options= {})
@@ -32,55 +34,60 @@ module QEDProject
       self.path = project_path
       self.process_options(options)
       self.set_paths
-    end
-       
-       
-    # Convenience method for showing all of the JavaScript files that 
-    # the project should contain. Good for creating asset lists
-    # and loading files in rendered templates                                    
-    def js_assets
-      libs.inject([]) do |original, lib|
-        if QEDProject::Libraries::Base.libs[lib].respond_to?(:js_files)
-           original += QEDProject::Libraries::Base.libs[lib].js_files 
-        else
-          original
+    end                          
+
+    def collect_libraries
+      
+      self.css_assets = []
+      self.js_assets = []
+      self.sorted_libs = []
+      
+      self.libs.each do |requested_library|
+        raise QEDProject::BadLibraryError, "#{requested_library} is not a valid library" unless QEDProject::Libraries::Base.libs.include? requested_library
+        library = QEDProject::Libraries::Base.libs[requested_library]   
+        
+        if library.respond_to? :dependencies
+          dependencies = library.dependencies
+          dependencies.each do |d|
+            unless self.sorted_libs.include?(d)
+              self.sorted_libs << d
+            end
+          end
         end
-      end 
-    end
-    
-    # Convenience method for showing all of the css files that 
-    # the project should contain. Good for creating asset lists
-    # and loading files in rendered templates
-    def css_assets
-      libs.inject([]) do |original, lib|
-        if QEDProject::Libraries::Base.libs[lib].respond_to?(:css_files)
-          original += QEDProject::Libraries::Base.libs[lib].css_files 
-        else
-          original
+        
+        unless self.sorted_libs.include?(requested_library)
+          self.sorted_libs << requested_library
         end
       end
-    end                                     
-
+      
+      self.sorted_libs.each do |lib|
+        library = QEDProject::Libraries::Base.libs[lib]   
+        self.js_assets += library.js_files if library.respond_to?(:js_files)
+        self.css_assets += library.css_files if library.respond_to?(:css_files)
+      end
+      
+    end
+    
     # Sets instance methods with values from the options hash.
     def process_options(options)
+
       self.libs = options[:libs] || []
       
-      libs.each do |lib|
-        raise QEDProject::BadLibraryError, "#{lib} is not a valid library" unless QEDProject::Libraries::Base.libs.include? lib
-      end
-      
+      collect_libraries
+      self.public_dir = options[:public_dir] || "public"
       self.jammit = options[:jammit]
       self.sass = options[:sass]
       self.coffeescript = options[:coffeescript]
       self.verbose = options[:verbose]
       self.testing = options[:testing]
+      self.skip_index = options[:skip_index]
     end
 
     # Set up the basic paths we'll use throughout
     def set_paths
-       self.images_path = File.join("public", "images")
-       self.js_path = self.jammit ? "javascripts" : File.join("public", "javascripts")
-       self.css_path = self.jammit ? "stylesheets" : File.join("public", "stylesheets")
+       self.images_path = File.join(self.public_dir, "images")
+       self.js_path = self.jammit ? "javascripts" : File.join(self.public_dir, "javascripts")
+       self.css_path = self.jammit ? "stylesheets" : File.join(self.public_dir, "stylesheets")
     end
 
     # We need a guardfile if the user is using jammit, sass, or coffeescript.
@@ -101,7 +108,7 @@ module QEDProject
     # create a guardfile if needed
     def generate
       self.create_project_skeleton
-      self.create_index                             
+      self.create_index unless self.skip_index                         
       self.get_libraries if self.libs
       self.create_asset_file if self.jammit
       self.add_testing if self.testing
@@ -111,8 +118,8 @@ module QEDProject
 
     # includes the Jasmine BDD framework for javascript testing
     def add_testing
-      FileUtils.mkdir_p File.join(self.path, "spec"), :verbose => self.verbose
-      FileUtils.cp_r File.join(self.vendor_root, "jasmine", "lib"), 
+      mkdir_p File.join(self.path, "spec"), :verbose => self.verbose
+      cp_r File.join(self.vendor_root, "jasmine", "lib"), 
                      File.join(self.path, "spec", "lib"), :verbose => self.verbose
     
 
@@ -139,22 +146,22 @@ module QEDProject
     #   spec/               * optional
     #   Guardfile           * optional
     def create_project_skeleton
-      ::FileUtils.mkdir_p( self.path, :verbose => self.verbose)
-      ::FileUtils.mkdir_p( File.join(self.path, "public"), :verbose => self.verbose)
-      ::FileUtils.mkdir_p( File.join(self.path, self.images_path), :verbose => self.verbose)
-      ::FileUtils.mkdir_p( File.join(self.path, "tmp"), :verbose => self.verbose)
-      ::FileUtils.mkdir_p( File.join(self.path, self.js_path), :verbose => self.verbose)
-      ::FileUtils.mkdir_p( File.join(self.path, self.css_path), :verbose => self.verbose)
-      ::FileUtils.mkdir_p( File.join(self.path, "config"), :verbose => self.verbose) if self.needs_config_folder?
-      ::FileUtils.mkdir_p( File.join(self.path, "coffeescripts"), :verbose => self.verbose) if self.coffeescript
-      ::FileUtils.mkdir_p( File.join(self.path, "sass"), :verbose => self.verbose) if self.sass
+      mkdir_p( self.path, :verbose => self.verbose)
+      mkdir_p( File.join(self.path, self.public_dir), :verbose => self.verbose)
+      mkdir_p( File.join(self.path, self.images_path), :verbose => self.verbose)
+      mkdir_p( File.join(self.path, "tmp"), :verbose => self.verbose)
+      mkdir_p( File.join(self.path, self.js_path), :verbose => self.verbose)
+      mkdir_p( File.join(self.path, self.css_path), :verbose => self.verbose)
+      mkdir_p( File.join(self.path, "config"), :verbose => self.verbose) if self.needs_config_folder?
+      mkdir_p( File.join(self.path, "coffeescripts"), :verbose => self.verbose) if self.coffeescript
+      mkdir_p( File.join(self.path, "sass"), :verbose => self.verbose) if self.sass
     end
 
     # Loop through the libraries the user added
     # and run their generate methods
     # which pulls in the additional optional files.
     def get_libraries
-      libs.each do |lib|
+      self.sorted_libs.each do |lib|
         library = QEDProject::Libraries::Base.libs[lib]
         l = library.new(self)
         l.generate!
@@ -173,8 +180,8 @@ module QEDProject
     
     def create_index
       @project = self
-      render_template_to_file "index.html", File.join(self.path, "public", "index.html"), binding
-      puts "Created #{ File.join(self.path, "public", "index.html")}" if self.verbose
+      render_template_to_file "index.html", File.join(self.path, self.public_dir, "index.html"), binding
+      puts "Created #{ File.join(self.path, self.public_dir, "index.html")}" if self.verbose
     end
         
     def create_rakefile

data/lib/qedproject/version.rb

@@ -1,3 +1,3 @@
 module QEDProject
-  VERSION = "0.0.5"
+  VERSION = "0.0.8"
 end

data/lib/qedproject.rb

@@ -5,10 +5,14 @@ require "qedproject/libraries/jquery"
 require "qedproject/libraries/backbone"
 require "qedproject/libraries/knockout"
 require "qedproject/libraries/jquerytmpl"
+require "qedproject/libraries/jquerymobile"
 require "qedproject/libraries/skeleton"
 require "qedproject/project"
+require "qedproject/plugins"
 
 module QEDProject
   class BadLibraryError < RuntimeError
   end
 end
+
+QEDProject::Plugins::load_plugins

data/templates/assets.yml

@@ -1,11 +1,11 @@
 stylesheets:
-  style.css:
+  app:
   <% self.css_assets.each do |lib| -%>
   - <%=File.join(self.css_path, lib) %>
   <% end -%>
   
 javascripts:
-  app.js:
+  app:
   <% self.js_assets.each do |lib| -%>
   - <%=File.join(self.js_path, lib) %>
   <% end -%>

data/templates/sampleSpec.coffee

@@ -0,0 +1,3 @@
+describe "A sample spec", ->
+  it "performs addition", ->
+    (expect 1+1).toEqual 3