bixbite 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Richard Herrera
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,49 @@
+# Bixbite Project Initializer
+
+Bixbite creates a project structure optimal for client-side development.
+
+* Downloads the latest versions of [Google Ajax API Libraries](http://code.google.com/apis/ajaxlibs/)
+* Uses [LABjs](http://labjs.com/) for parallelized script management
+* Allows full use of PHP includes for shared module management
+* Bundles a customized [PHP Minify](http://code.google.com/p/minify/) package for on-the-fly compression tests
+* Dynamic to static publishing eliminates server-side dependencies on delivery
+
+Additionally, Bixbite includes rake tasks to automatically:
+
+* Create new page templates & associated JS/CSS files
+* Prepare files for deployment
+* Generate NaturalDocs-compliant documentation
+* Compress PNG files using [PNGout](http://advsys.net/ken/utils.htm)
+* Gracefully degrade 24-bit PNG files for Internet Explorer 6
+* Deliver compressed versions of CSS & JavaScript files
+* Add new files, remove outdated files from Subversion
+* Generate diff reports for each delivery
+
+## Links
+
+ * [Wiki](http://wiki.github.com/doctyper/bixbite)
+ * [Bugs](http://github.com/doctyper/bixbite/issues)
+
+## Installing
+
+# Install the gem:
+    gem install bixbite
+
+# Usage
+
+# Generating a Bixbite template
+
+Run the Bixbite gem to generate a new template:
+
+    bixbite "The Foo Project" FOO
+
+This command will generate a template with a project name of "The Foo Project" and support files (JS/PHP) using the FOO namespace.
+
+You may also specify arguments when invoked. Via `bixbite --help`:
+
+ * --js-lib [ARG]: use specified JavaScript library (options: jQuery, YUI, MooTools)
+ * --source-directory [ARG]: override bundled template with user-defined template
+
+# Wiki
+
+See the [Bixbite wiki](http://wiki.github.com/doctyper/bixbite) for details on how to utilize the generated template. It also contains details on how to use a customized template if you so wish.

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/bixbite

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+require "bixbite"
+require "optparse"
+require "yaml"
+require "fileutils"
+require "net/http"
+require "highline/import"
+
+# Argument defaults
+options = {
+  :source => File.expand_path(File.dirname(__FILE__) + "/../template/"),
+  :destination => File.expand_path(Dir.getwd),
+  :lib => 'jQuery'
+}
+
+USER_TEMPLATE = File.expand_path(File.dirname(__FILE__) + "/../user-defined-template")
+options[:source] = USER_TEMPLATE if File.exists?(USER_TEMPLATE)
+
+# Config YAML File
+options[:config] = YAML.load_file(File.join(options[:source], "src", "yaml", "config.yml"));
+
+# Get arguments
+opts = OptionParser.new do |o|
+  o.banner = 'Usage: bixbite "Project Title" PROJECTNAMESPACE [source] [destination]'
+  o.separator ""
+
+  o.on("-l", "--js-lib [ARG]", "Use specified JavaScript library (options: jQuery, YUI, MooTools)") do |lib|
+    options[:lib] = lib
+  end
+  
+  o.on_tail("-s", "--source-directory [ARG]", "Override bundled template with user-defined template") do |path|
+    override = ask("Override bundled template with #{File.expand_path(path)} (admin privileges required)? [Y/n]  ")
+    
+    if (override.downcase == "y")
+      system %(sudo rm -rf #{USER_TEMPLATE}) if File.exists?(USER_TEMPLATE)
+      system %(sudo cp -r #{File.expand_path(path)} #{USER_TEMPLATE})
+    end
+    
+    exit
+  end
+  
+  o.separator ""
+
+  # Help
+  o.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+  
+  o.separator ""
+
+  # Version
+  o.on_tail("-v", "--version", "Show version") do
+    puts "bixbite " + Bixbite.version
+    exit
+  end
+end
+
+opts.parse! # Parse arguments into `options` hash
+
+# Get source and destintation from command line
+if (ARGV.size >= 2)
+  options[:title] = ARGV[0]
+  options[:namespace] = ARGV[1]
+  options[:source] = ARGV[2] if ARGV[2]
+  options[:destination] = ARGV[3] if ARGV[3]
+else
+  puts opts
+  exit
+end
+
+Bixbite::Command.new(options).run!

data/lib/bixbite.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'yaml'
+require 'fileutils'
+
+require 'bixbite/command'
+require 'bixbite/create'
+
+module Bixbite
+  def self.version
+    File.read(File.join(File.dirname(__FILE__), '..', 'VERSION')).strip
+  end
+end

data/lib/bixbite/command.rb

@@ -0,0 +1,14 @@
+module Bixbite
+  class Command
+    attr_accessor :options
+
+    def initialize options
+      @config = options[:config]
+      @options = options
+    end
+
+    def run!
+      Bixbite::Create.new(@options)
+    end
+  end
+end

data/lib/bixbite/create.rb

@@ -0,0 +1,76 @@
+module Bixbite
+  class Create
+    attr_accessor :source, :destination, :options
+
+    def initialize options
+      @options = options
+      @config = @options[:config]
+      
+      copy @options[:source], @options[:destination]
+      download @options[:lib], @options[:destination]
+      parse @config["parse"], @options[:destination], @options[:title], @options[:namespace]
+    end
+
+    def parse list, source, name, namespace
+      puts "Building project..."
+      list.each do |glob|
+        files = Dir[File.join(source, "template", glob)]
+        files.each do |file|
+          File.open(file, "r+") do |f|
+              lines = f.readlines
+              lines.each do |line|
+                line.gsub!(/__PROJECT_NAME__/, name);
+                line.gsub!(/__PROJECT_NAMESPACE__/, namespace);
+                line.gsub!(/__JS_LIB__/, @options[:lib]);
+                line.gsub!(/__JS_LIB_LOWERCASE__/, @options[:lib].downcase);
+              end
+              f.pos = 0
+              f.print lines
+              f.truncate(f.pos)
+          end unless File.directory?(file)
+          
+          File.rename(file, file.gsub(/__PROJECT_NAME__/, name)) if file.match(/__PROJECT_NAME__/)
+          File.rename(file, file.gsub(/__JS_LIB_LOWERCASE__/, @options[:lib].downcase)) if file.match(/__JS_LIB_LOWERCASE__/)
+        end
+      end
+      puts "All done!"
+    end
+    
+    def copy source, destination
+      puts "Copying to #{destination}..."
+      FileUtils.cp_r(source, destination)
+      puts "Done!"
+    end
+    
+    def download lib, destination
+      require 'net/http'
+      
+      def get domain, source, destination
+        Net::HTTP.start(domain) { |http|
+          resp = http.get(source)
+          open(destination, "wb") { |file|
+            file.write(resp.body)
+            puts "Done!"
+          }
+        }
+      end
+      
+      google = 'ajax.googleapis.com'
+      file = '__JS_LIB_LOWERCASE__-latest.js'
+      dest = File.join(destination, "template", @config["directories"]["src"]["html"][0], "js/cmn/lib", file)
+      
+      puts "Downloading #{lib} from #{google}"
+      
+      case lib
+        when 'jQuery'
+          get google, '/ajax/libs/jquery/1/jquery.js', dest
+        when 'YUI'
+          get google, '/ajax/libs/yui/2/build/yuiloader/yuiloader.js', dest
+        when 'MooTools'
+          get google, '/ajax/libs/mootools/1.2/mootools.js', dest
+        else
+      end
+    end
+    
+  end
+end

data/template/Rakefile

@@ -0,0 +1,25 @@
+require 'assets/bixbite/Rakefile'
+
+###############################################################################
+# 
+#	 __PROJECT_NAME__ Build Tasks
+#  See assets/bixbite/Rakefile for more information
+# 
+#	 Tasks for pages:
+#		 - Update deploy directory: rake prep
+# 
+#	 How the delivery is assembled from source:
+#		 - The source of the project is kept in src/html
+#		 - The directory src/yaml contains a "deploy.yml" file
+#		 - The deploy file contains arrays of global patterns for copying files 
+#			 (files:) and rendering files through the PHP command line interface (render:)
+#		 - Run rake prep from the root of trunk.
+#			 This will wipe out the existing files in the deploy 
+#			 folder before copying/rendering files back again. This allows you to 
+#			 run "svn status" to check to see if files were removed.
+#		 - Committing the deploy folder lets you see how the stable, deploy-
+#			 ready project changes over time, making changelogs easier to write
+#		 - The task will also output/update NaturalDocs-compatible JavaScript documentation
+#			 The documentation can be found in documentation/js
+#
+###############################################################################

data/template/assets/bixbite/Rakefile.rb

@@ -0,0 +1,297 @@
+#!/usr/bin/ruby
+
+require "yaml"
+require "fileutils"
+require "highline/import"
+  
+# YAML Files
+@config = YAML.load_file(File.join("src", "yaml", "config.yml"))
+@deploy = YAML.load_file(File.join("src", "yaml", "deploy.yml"))
+
+@dirs = @config["directories"]
+@project = File.expand_path(File.dirname(__FILE__)).split(@dirs["assets"]["root"][0])[0]
+
+# Globals
+@globs = {
+  :project => @project,
+  :utilities => @dirs["assets"]["utilities"][0],
+  :deploy => @dirs["deploy"]["public_html"]["root"][0],
+  :source => @dirs["src"][0],
+  :html => @dirs["src"]["html"][0],
+  :yaml => @dirs["src"]["yaml"][0],
+  :template_path => @dirs["src"]["templates"][0],
+  :name => @config["name"][0],
+  :namespace => @config["namespace"][0],
+  :natdocs => @dirs["assets"]["natural-docs"][0],
+  :jsdocs => @dirs["documentation"]["js-docs"][0]
+}
+
+@globs[:files] = Dir[File.join(@globs[:project], @globs[:template_path], "**/*.*")]
+
+desc "Prep deploy files"
+task :prep => ["files:generate", "documentation:generate", "svn:prep"] do
+  puts "Ready for commit!"
+end
+
+namespace :bixbite do
+  
+  desc "Generates a new HTML page and its associated CSS/JS files"
+  task :page do
+    
+    def make_new_files
+      name = @globs[:page_name]
+      fname = @globs[:page_filename]
+
+      @globs[:files].each do |file|
+        new_file = File.join(@globs[:html], file.split(@globs[:template_path])[1].gsub(/template/, fname))
+        dest = File.dirname(new_file)
+        
+        puts "Creating #{new_file}"
+        
+        FileUtils.mkpath(dest)
+        FileUtils.cp(file, new_file) unless File.directory?(file)
+        
+        caps = name.split(" ").each{|word| word.capitalize!}.join(" ")
+        File.open(new_file, "r+") do |f|
+          lines = f.readlines
+          lines.each do |line|
+            line.gsub!(/__PAGE_TEMPLATE_UPPERCASE__/, fname.upcase);
+            line.gsub!(/__PAGE_TEMPLATE_LOWERCASE__/, fname.downcase);
+            line.gsub!(/__PAGE_TEMPLATE_CAPITALIZE__/, fname.capitalize);
+            line.gsub!(/__PAGE_NAME_CAPITALIZE__/, caps);
+            line.gsub!(/__PROJECT_NAME__/, @globs[:name]);
+            line.gsub!(/__PROJECT_NAMESPACE__/, @globs[:namespace]);
+          end
+          f.pos = 0
+          f.print lines
+          f.truncate(f.pos)
+        end
+      end
+      
+      puts "Done!"
+    end
+    
+    @globs[:page_name] = ask('Name of page? (i.e. "Foo Page")  ')
+    @globs[:page_filename] = ask('Page file name? (i.e. foo-page)  ')
+    
+    make_new_files
+  end
+end
+
+namespace :svn do
+  
+  desc "Prepares directory for svn commit"
+  task :prep => [:add, :remove, :diff]
+  
+  desc "Adds files with an svn status flag of '?'"
+  task :add do
+    puts "Adding new files to version control..."
+    system %(svn status | awk '/\\?/ {print $2}' | xargs svn add)
+  end
+
+  desc "Removes files with an svn status flag of '!'"
+  task :remove do
+    puts "Removing missing files from version control..."
+    system %(svn status | awk '/\\!/ {print $2}' | xargs svn remove)
+  end
+  
+  desc "Generates diff file with current committed revision"
+  task :diff do
+    puts "Generating diff..."
+    diff = File.join(@globs[:deploy], @globs[:name] + ".diff")
+    system %(svn diff -r COMMITTED #{@globs[:deploy]} > '#{diff}')
+  end
+end
+
+namespace :documentation do
+  desc "Render NaturalDocs documentation"
+  task :generate do
+    def render_documentation(executable, input, output, project_path)
+      system %(#{executable} -i #{input} -o HTML #{output} -p #{project_path})
+    end
+
+    puts "Parsing JavaScript documentation..."
+    render_documentation File.join(@globs[:natdocs], "NaturalDocs", "NaturalDocs"), File.join(@globs[:deploy], "js"), @globs[:jsdocs], @globs[:natdocs]
+  end
+end
+
+namespace :png do
+  desc "Compresses PNGs with pngout"
+  task :compress do
+    pngs = Dir[File.join(@globs[:html], "**/*.png")]
+    original_total = new_total = 0
+    pngs.each do |png|
+      original = File.size(png)
+      original_total += original
+      system %(#{File.join(@globs[:utilities], "pngout")} #{png} -kbKGD -y)
+      new_size = File.size(png)
+      new_total += new_size
+      puts "\n"
+    end
+    puts %(Original Size: #{original_total})
+    puts %(New Size: #{new_total})
+    puts %(Change: #{original_total - new_total})
+  end
+  
+  desc "Adds a white background fallback for < IE 6 support. Files render with full transparency in all other browsers."
+  task :ie6 do
+    error = "This task requires ImageMagick. Download at http://www.imagemagick.org/"
+    pngs = Dir[File.join(@globs[:html], "**/*.png")]
+    pngs.each do |png|
+      result = system "convert #{png} -background 'rgb(255,255,255)' #{png}"
+      if result
+        puts "Converted #{png}"
+      else
+        raise Exception.new(error)
+      end
+    end
+    
+    puts "All PNGs converted."
+  end
+end
+
+namespace :files do
+  
+  desc "Generate files for delivery"
+  task :generate => [:empty, :copy, :render] do
+    puts "All files generated!"
+  end
+
+  desc "Copy files"
+  task :copy do
+    puts "Copying static files..."
+    
+    def copy_files list, parent, from, to
+      list.each do |glob|
+        filelist = Dir[File.join(parent, from, glob)]
+
+        filelist.each do |file|
+          new_file = parent + to + file.split(from)[1];
+          dest = File.dirname(new_file)
+          FileUtils.mkpath(dest)
+          FileUtils.cp file, new_file unless File.directory?(file)
+        end
+      end unless !list
+    end
+
+    copy_files @deploy["files"], @globs[:project], @globs[:html], @globs[:deploy]
+    
+  end
+
+  desc "Render files"
+  task :render do
+    puts "Rendering dynamic files..."
+    
+    def render_php_file file, output
+      system %(php -f #{file} true > #{output})
+    end
+    
+    def render_files list, from, to
+      list.each do |glob|
+        filelist = Dir[File.join(from, glob)]
+
+        filelist.each do |file|
+          new_file = to + file.gsub(from, "");
+          dest = File.dirname(new_file)
+          
+          FileUtils.mkpath(dest)
+          render_php_file file, new_file unless File.directory?(file)
+        end
+      end unless !list
+    end
+    
+    render_files @deploy["render"], @globs[:html], @globs[:deploy]
+    
+  end
+
+  desc "Empty folders"
+  task :empty do
+    puts "Emptying delivery folder..."
+    
+    def remove_files directory
+      all = Dir[File.join(directory, "**/**")]
+      all.each do |entry|
+        unless File.directory?(entry)
+          FileUtils.rm entry
+        end
+      end
+      
+    end
+    
+    remove_files @globs[:deploy]
+  end
+
+  desc "Compress files"
+  task :compress do
+    require "closure-compiler"
+    require "yui/compressor"
+    
+    JS_FILES = @deploy["compress"]["js"]
+    CSS_FILES = @deploy["compress"]["css"]
+    
+    PUB = @dirs["deploy"]["public_html"]
+    
+    JS_DIR = File.join(@globs[:deploy], JS_FILES["min-dir"][0]).sub(PUB["js"][0], "")
+    CSS_DIR = File.join(@globs[:deploy], CSS_FILES["min-dir"][0]).sub(PUB["css"][0], "")
+    
+    JS_FILES.delete("min-dir")
+    CSS_FILES.delete("min-dir")
+    
+    def minify parse
+      code = String.new
+      files = Dir[File.join(@globs[:deploy], parse)]
+      files.each do |file|
+        if file.include?(".js")
+          code << Closure::Compiler.new.compile(File.open(file, "r"))
+        else
+          code << YUI::CssCompressor.new.compress(File.open(file, "r"))
+        end
+      end
+      code
+    end
+    
+    def combine files, destination
+      code = String.new
+      files.each do |file|
+        code << minify(file)
+      end
+      write code, destination
+    end
+    
+    def write code, destination
+      FileUtils.mkpath(File.dirname(destination))
+      new_file = File.new(destination, "w")
+      new_file.puts(code)
+      puts "Compressed #{destination}"
+    end
+    
+    def compress type, array, dir
+      array.each_pair do |key, value|
+        case key
+          when "standalone"
+            value.each do |parse|
+              files = Dir[File.join(@globs[:deploy], parse)]
+              files.each do |file|
+                if type.include?("js")
+                  code = Closure::Compiler.new.compile(File.open(file, "r"))
+                else
+                  code = YUI::CssCompressor.new.compress(File.open(file, "r"))
+                end
+                  
+                dest =  File.join(PUB[type][0], dir, file.split(PUB[type][0])[1])
+                write code, dest
+              end
+            end
+          else combine value, File.join(PUB[type][0], dir, key)
+        end
+      end
+    end
+    
+    puts "Compressing JavaScript files (might take a bit)"
+    compress "js", JS_FILES, JS_DIR
+    
+    puts "Compressing CSS files"
+    compress "css", CSS_FILES, CSS_DIR
+    
+  end
+end