tipsy 0.0.2 → 0.0.3

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 .DS_Store
 .rvmrc
 .sass-cache/*
+old/*

data/Gemfile

@@ -1,14 +1,9 @@
 source "http://rubygems.org"
-gemspec
 
-gem 'facades', :path => '/_Work/gems/facades'
-gem 'thin'
+# Specify your gem's dependencies in tipsy.gemspec
+gemspec
 
-group :test do
-  gem 'jnunemaker-matchy', '~> 0.4.0', :require => 'matchy'
-  gem 'shoulda',           '~> 2.11'
-  gem 'mocha',             '~> 0.9.12'
-  gem 'rack-test'
-  gem 'turn'
-  gem 'minitest'
-end
+gem 'compass', '~> 0.12.alpha0'
+gem 'colored'
+gem 'rspec'
+gem 'rspec-expectations'

data/README.md

@@ -4,7 +4,30 @@ Tipsy is a small Rack-based server inspired by gems like StaticMatic and Serve.
 Rails-esque style templating and helpers. Various template types are supported via the Tilt gem, and assets are served via Sprockets, essentially giving you 
 a miniture Rails "view-only" environment. 
 
+Any template format Tilt provides should work without much hassle. ERB (via Erubis) is provided. Note Erubis is required to make ERB function properly as 
+we've applied some of the same modifications as Rails, allowing things like block style helpers such as
+
+	<%= capture do %>
+		something
+	<% end %>	
+
+which would error normally. By doing so it should make integration with any number of ActionView style helpers fairly simple.
+
+## Usage
+
+**Creating** To create a new site run `tipsy new name_of_site` to generate a new site in the current directory.
+
+**Compiling** To compile the site into a production-ready state, run `tipsy compile` from the site's root directory.
+
+**Serving** Simply run `tipsy` from the site root. Its recommended to add Thin or Mongrel to your Gemfile but Webrick will be used as a fallback.
+
+Running the site generator should provide all of the configuration and setup options you would need to get started. Check out config.rb in the created 
+site's root for more info. 
+
 ### Notes
 
 Tipsy was developed for personal/internal use but feature/pull requests are gladly accepted. It is not designed to function in any kind of production 
-environment. When ready to upload files to a production environment, build the project and upload the result.
+environment. When ready to upload files to a production environment, build the project and upload the result.
+
+By default *most* ActionView compatible helpers should work out of the box... with the exception of helpers extending things like the form builder etc. 
+Right now Tipsy has no form builder, so you would have to provide your own. 

data/Rakefile

@@ -1,11 +1,15 @@
-require 'rake'
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+#!/usr/bin/env rake
+$:.unshift File.expand_path('.', __FILE__)
+
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-Rake::TestTask.new(:test) do |test|
-  test.libs      << 'lib' << 'test'
-  test.pattern   = 'test/**/*_test.rb'
-  test.verbose = true
-end
+require 'rake/testtask'
 
-task :default => :test
+Rake::TestTask.new(:test) do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+  t.libs << 'lib'
+  t.libs << 'test'    
+  t.verbose = true
+end

data/bin/tipsy

@@ -5,6 +5,8 @@ if File.file?(libdir + '/tipsy/version.rb')
   $LOAD_PATH.unshift(libdir)
 end
 
+ENV['TIPSY_ROOT'] ||= File.expand_path('.')
+
 begin
   require 'tipsy'
 rescue LoadError
@@ -17,5 +19,5 @@ if File.exists?(File.join(File.expand_path('.'), 'Gemfile'))
   Bundler.require(:default)
 end
 
-Tipsy.root = File.expand_path('.')
-Tipsy.run_command(ARGV, STDIN)
+require 'tipsy/runner'
+Tipsy::Runner.new(ARGV, STDIN)

data/lib/templates/server/htaccess.erb

@@ -0,0 +1,14 @@
+##################################################################
+# Basic rewriting to avoid file extensions where the
+# result is a basic html page.
+##################################################################
+
+# For IE .htc files
+AddType text/x-component .htc
+
+RewriteEngine on
+RewriteBase /
+
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteCond %{REQUEST_FILENAME} !-d
+RewriteRule ^(.*)$ $1.html [L,QSA]

data/lib/templates/site/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+
+gem "rack", "~> 1.3"
+gem "tilt", "~> 1.3"
+gem "i18n", "~> 0.6"
+gem "sass", "~> 3.1"
+gem "activesupport", ">= 3.1"
+gem "sprockets", "~> 2.0"
+gem "erubis"
+
+# Thin or mongrel are recommended over Webrick
+# gem "thin"
+
+# Uglifier is recommended for javascript compression. If unavailable, Google's online 
+# closure compiler will be used.
+# gem 'uglifier'
+
+# Compass is automatically detected and configured if available
+# gem "compass", "~> 0.11"

data/lib/templates/site/assets/stylesheets/_config.css.scss

@@ -0,0 +1 @@
+// Setup global variables etc here.

data/lib/templates/site/assets/stylesheets/screen.css.scss

@@ -0,0 +1 @@
+@import 'config';

data/lib/templates/site/config.rb

@@ -0,0 +1,52 @@
+# Configure urls where assets are to be served. 
+# In development, assets should be placed under root_path/assets
+# On compile, assets will be stored at these locations (defaults shown)
+#
+asset_path       = "/assets"
+javascripts_path = "/assets"
+images_path      = "/assets"
+css_path         = "/assets"
+
+# Fonts don't really need to be served by sprockets, they should go in your public_path. 
+# This option is mostly provided for using asset_url helpers in Sass
+fonts_path       = "/fonts"
+
+# On compile, use this folder. Accepts either a relative or absolute path
+compile_to  = "compiled"
+
+# Static files and assets will be served from this location
+public_path = "public"
+
+# Configure assets to be compiled at compile-time (default: screen.css and site.js)
+#
+compile.assets << "site.js"
+compile.assets << "screen.css"
+
+# By default template compilation will generate files as they exist in your /views directory. 
+# This allows for rewriting via .htaccess or nginx config to avoid .html extensions in your urls.
+# If you would prefer a folder/index.html structure for the resulting html files, set compile.enable_rewrite to false.
+# Set compile.rewrite_mode to one of :nginx or :htaccess to have a .htaccess/nginx.conf file generated for you.
+# The default configurations are shown below
+# 
+# compile.enable_rewrite = true
+# compile.rewrite_mode   = :htaccess
+
+# Compiling cleans the 'compile_to' path prior to re-building the site. 
+# To ensure certain directories are preserved, add them here. This is primarily useful for scm directories
+#
+# compile.preserve << ".svn"
+# 
+# When compiling, all files and folders found in the 'public_path' are copied. To ignore 
+# specific files or folders, include them here.
+# 
+# compile.skip << "some-path"
+# 
+# 
+# Callbacks:
+# To perform additional tasks either before or after compilation, define either a 
+# before_compile, after_compile, or both. Blocks are passed an instance of the Compiler.
+# See tipsy/runners/compiler.rb for more info.
+# 
+# after_compile do |runner|
+# end
+# 

data/lib/templates/site/deploy.yml

@@ -0,0 +1,27 @@
+# Configure deployment options here.
+# Only the default is required for deployment, specify separate locations as needed to
+# deploy to multiple servers.
+#
+# Options:
+# server_type: Either apache or nginx.
+# scm: One of subversion, git, or simply false. (experimental)
+# deploy_to: Where the deployed files should be placed. 
+# deploy_via: One of ftp, sftp, or ssh. For scm deployments, ssh is required. S3 support coming in a future release
+#
+
+defaults: &defaults
+  server_type: "apache"
+  scm: false
+  deploy_to: ""
+  deploy_via: "ftp"  
+  port: 22
+  username: "deploy"
+
+default:
+  <<: *defaults
+  host: "ftp.somewhere.com"
+
+# setup a second location
+#server2:
+#  <<: *defaults
+  

data/lib/templates/site/layouts/default.html.erb

@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+	<meta charset="utf-8" />
+	<!-- pre-fetch dns info for external sites -->
+	<link rel="dns-prefetch" href="//ajax.googleapis.com" />
+	<!-- force IE to render as IE... weird isn't it? -->
+	<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+	<!-- 'pinned' sites in IE ( see: http://html5boilerplate.com/docs/head-Tips/ ) -->	
+	<meta name="application-name" content="" />
+	<meta name="msapplication-tooltip" content="" />
+	<!-- Facebook open graph ( seff: http://developers.facebook.com/docs/share ) -->
+	<meta property="og:title" content="" />
+	<meta property="og:description" content="" />
+	<meta property="og:image" content="" />	
+	<title><%= page_title %></title>	
+	<meta name="description" content="" />
+	<meta name="author" content="" />
+	<meta name="viewport" content="width=device-width,initial-scale=1,target-densitydpi=device-dpi" />
+	<!--[if lt IE 9]>
+		<script src="//html5shim.googlecode.com/svn/trunk/html5.js"></script>		
+		<%= stylesheet_link_tag 'ie' %>
+	<![endif]-->	
+	<%= stylesheet_link_tag 'screen' %>
+</head>
+<body id="<%= page_id %>">
+	<div id="wrapper">
+		<header>
+
+		</header>
+		<div id="main" role="main">
+			<%= yield %>
+		</div>
+		<footer>
+
+		</footer>
+	</div>
+	<%= javascript_include_tag "//ajax.googleapis.com/ajax/libs/jquery/1.6.2/jquery.min.js" %>
+	<%= javascript_include_tag 'site' %>
+</body>
+</html>

data/lib/templates/site/views/index.html.erb

@@ -0,0 +1,2 @@
+<% page_id('home') %>
+<% page_title('Your Home Page') %>

data/lib/tipsy/compressors/javascript_compressor.rb

@@ -0,0 +1,44 @@
+##
+# Includes an interface to Google's Online Closure Compiler. 
+# Uglifier is recommended (gem install uglifier) however to support environments where Node.js
+# is unavailable this can be used as a fallback.
+# 
+require 'net/http'
+require 'uri'
+
+module Tipsy
+  module Compressors
+    
+    module Closure
+      def compress(js)
+        return js if js.to_s.blank?
+        post_data = {
+          'compilation_level' => 'SIMPLE_OPTIMIZATIONS',
+          'js_code'           => js.to_s,
+          'output_format'     => 'text'
+        }
+        request = Net::HTTP.post_form(URI.parse('http://closure-compiler.appspot.com/compile'), post_data)
+        request.body.to_s
+      end      
+    end
+    
+    module Uglifier
+      def compress(js)
+        ::Uglifier.compile(js, :max_line_length => 500, :squeeze => true, :copyright => false)
+      end
+    end
+    
+    class JavascriptCompressor      
+      def initialize
+        begin 
+          require 'uglifier'
+          self.class.send(:include, Uglifier)
+        rescue LoadError
+          Tipsy.logger.info("Add the Uglifier gem to your gemfile for better javascript support")
+          self.class.send(:include, Closure)
+        end
+      end      
+    end
+    
+  end
+end

data/lib/tipsy/configuration.rb

@@ -0,0 +1,9 @@
+module Tipsy
+  class Configuration < ActiveSupport::OrderedHash
+    
+    def initialize(*args)
+      super(*args)
+    end
+    
+  end
+end

data/lib/tipsy/handler/all.rb

@@ -0,0 +1,4 @@
+Dir.glob(File.dirname(__FILE__) << "/*.rb").each do |path|
+  next if File.basename(path) == __FILE__ 
+  require path
+end

data/lib/tipsy/handler/asset.rb

@@ -0,0 +1,93 @@
+require 'sprockets'
+require 'hike'
+require 'tipsy/handler/sass'
+
+module Tipsy
+  module Handler
+    ##
+    # The AssetHandler is a subclass of Sprockets::Environment resposible for delivering
+    # assets back to the browser. In development assets should be defined under: 
+    # javascripts: /assets/javascripts
+    # images:      /assets/images
+    # stylesheets: /assets/stylesheets
+    # 
+    # Configure delivery urls using Tipsy::Site.asset_path, or Tipsy::Site.type_path where 'type' is the type of asset to configure
+    # Although assets are stored in the /assets folder, when compiled these directories will be used for the final 
+    # output. This way assets can be organized during development, but placed anywhere when deployed
+    # 
+    class AssetHandler < ::Sprockets::Environment
+      attr_reader :asset_env
+      
+      class << self
+        def map!
+          fpaths = [:javascripts_path, :css_path, :images_path].collect{ |p| File.basename(Tipsy::Site.send(p)) }
+          fpaths.inject({}) do |hash, path|
+            hash.merge!("/#{path}" => self.new)
+          end
+        end
+      end
+      
+      def initialize
+        ::Sprockets.register_engine '.scss', Tipsy::Handler::SassHandler
+        super(Tipsy.root) do |env|
+          @asset_env = env
+        end
+        append_path "assets/javascripts"
+        append_path "assets/images"
+        append_path "assets/stylesheets"
+        
+        configure_compass!
+        self
+        
+      end
+      
+      ##
+      # Setup compressors for compilation
+      # 
+      def prepare_compiler
+        asset_env.css_compressor = Tipsy::Compressors::CssCompressor.new
+        asset_env.js_compressor  = Tipsy::Compressors::JavascriptCompressor.new
+      end
+      
+      ##
+      # When exceptions are thrown through Sprockets, ensure that the 
+      # current indexes are expired. This ensures we never receive a CircularDependency error.
+      # 
+      def javascript_exception_response(exception)      
+        expire_index!
+        super(exception)
+      end
+
+      def css_exception_response(exception)      
+        expire_index!
+        super(exception)
+      end
+      
+      private
+      
+      def configure_compass!
+        begin
+          require 'compass'
+          require 'sass/plugin'
+
+          compass_config = ::Compass::Configuration::Data.new("project")
+          compass_config.project_type     = :stand_alone
+          compass_config.project_path     = Tipsy.root
+          compass_config.images_dir       = File.join('assets', 'images')
+          compass_config.sass_dir         = File.join('assets', 'stylesheets')
+          compass_config.http_images_path = "/#{File.basename(Tipsy::Site.images_path)}"
+          compass_config.relative_assets  = false
+          compass_config.line_comments    = false
+
+          Compass.add_project_configuration(compass_config)
+          ::Sass::Plugin.engine_options.merge!(Compass.sass_engine_options)
+          
+        rescue LoadError
+          require 'tipsy/helpers/sass'
+        end
+      end
+      
+    end  
+      
+  end
+end

data/lib/tipsy/handler/erb.rb

@@ -0,0 +1,42 @@
+require "erubis"
+##
+# The ErbHandler hacks erubis in the same manner as Rails.
+# This allows support for Rails view helpers. 
+# 
+module Tipsy
+  module Handler
+    class ErbHandler < ::Tilt::ErubisTemplate
+    end
+  end
+end
+
+class Erubis::Eruby
+  def add_text(src, text)
+    return if text.empty? || text.nil?
+    src << "@output_buffer.concat('" << escape_text(text) << "');"
+  end
+
+  BLOCK_EXPR = /\s+(do|\{)(\s*\|[^|]*\|)?\s*\Z/
+
+  def add_expr_literal(src, code)
+    return if code.nil?
+    if code.to_s =~ BLOCK_EXPR
+      src << '@output_buffer << ' << code.to_s
+    else
+      src << '@output_buffer << (' << code.to_s << ');'
+    end
+  end
+
+  def add_expr_escaped(src, code)
+    return if code.nil?
+    if code.to_s =~ BLOCK_EXPR
+      src << "@output_buffer << " << code.to_s
+    else
+      src << "@output_buffer.concat((" << code.to_s << ").to_s);"
+    end
+  end
+
+  def add_postamble(src)
+    src << '@output_buffer.to_s'
+  end
+end

data/lib/tipsy/handler/php.rb

@@ -0,0 +1,36 @@
+require 'tilt'
+
+module Tipsy
+  module Handler
+    ##
+    # The PHP engine allows processing/rendering of php templates within the server 
+    # environment. To process php templates, use the template.html.php naming syntax.
+    # 
+    class PhpHandler < Tilt::Template
+      
+      self.default_mime_type = 'text/html'
+      
+      def prepare
+        @engine = PhpProcessor.new(data)
+      end
+
+      def evaluate(scope, locals, &block)
+        @output ||= @engine.render
+      end
+    end
+    
+    class PhpProcessor
+      attr_accessor :data
+
+      def initialize(d)
+        @data = d
+      end
+
+      def render        
+      end
+    end
+    
+  end
+end
+
+Tilt.register(Tipsy::Handler::PhpHandler, 'php')

data/lib/tipsy/{sass/template.rb → handler/sass/importer.rb}

@@ -1,39 +1,13 @@
-require 'tilt'
-require 'sass/engine'
-require 'compass'
+begin
+  require 'compass'
+rescue LoadError
+end
 
-##
-# Most of this was extracted and modified from the sass-rails plugin, since most of the 
-# Sprockets functionality is the same.
-# 
 module Tipsy
-  module Sass
-    class Template < Tilt::ScssTemplate
-      self.default_mime_type = 'text/css'
-      
-      class Resolver
-        attr_accessor :context        
-        def initialize(context)
-          @context = context
-        end
-        def resolve(path, content_type = :self)
-          options = {}
-          options[:content_type] = content_type unless content_type.nil?
-          context.resolve(path, options)
-        rescue Sprockets::FileNotFound, Sprockets::ContentTypeMismatch
-          nil
-        end
-        def public_path(path, scope)
-          context.asset_paths.compute_public_path(path, scope)
-        end
-        def process(path)
-          context.environment[path].to_s
-        end
-      end
-      
-      
+  module Handler
+    class SassHandler < ::Tilt::ScssTemplate
       class Importer
-        
+  
         GLOB = /\*|\[.+\]/
         PARTIAL = /^_/
         HAS_EXTENSION = /\.css(.s[ac]ss)?$/
@@ -43,14 +17,14 @@ module Tipsy
               ".sass" => :sass,
               ".scss" => :scss
         }            
-        
+  
         attr_reader :context
 
         def initialize(context)
           @context = context
           @resolver = Resolver.new(context)
         end
-        
+  
         def sass_file?(filename)
           filename = filename.to_s
           SASS_EXTENSIONS.keys.any?{|ext| filename[ext]}
@@ -61,7 +35,7 @@ module Tipsy
           SASS_EXTENSIONS.each {|ext, syntax| return syntax if filename[(ext.size+2)..-1][ext]}
           nil
         end
-        
+  
         def render_with_engine(data, pathname, options = {})
           ::Sass::Engine.new(data, options.merge(:filename => pathname.to_s, :importer => self, :syntax => syntax(pathname)))
         end
@@ -75,7 +49,7 @@ module Tipsy
           partial_name = name.dirname.join("_#{name.basename}")
           @resolver.resolve(name) || @resolver.resolve(partial_name)
         end
-        
+  
         def find_relative(name, base, options)
           base_pathname = Pathname.new(base)
           if pathname = resolve(name, base_pathname.dirname)
@@ -89,7 +63,7 @@ module Tipsy
             nil
           end
         end
-        
+  
         def find(name, options)
           if pathname = resolve(name)
             context.depend_on(pathname)
@@ -112,26 +86,14 @@ module Tipsy
         def key(name, options)
           ["Sprockets:" + File.dirname(File.expand_path(name)), File.basename(name)]
         end
-        
+  
         def resolve_sass_path(name, options = {}, relative = false)
           prefix = ( relative === false ? "" : "./" )
           (context.resolve("#{prefix}#{name}", options) || context.resolve("#{prefix}_#{name}", options))
         end
-        
-      end
-      
-      def prepare        
+  
       end
-      
-      def evaluate(scope, locals, &block)
-        ::Sass::Engine.new(data, {
-          :filename   => eval_file,
-          :line       => line,
-          :syntax     => :scss,
-          :importer   => Importer.new(scope)
-        }.reverse_merge!(::Compass.sass_engine_options)).render
-      end
-      
+
     end
   end
 end

data/lib/tipsy/handler/sass/resolver.rb

@@ -0,0 +1,30 @@
+module Tipsy
+  module Handler
+    class SassHandler < ::Tilt::ScssTemplate
+      
+      class Resolver 
+        attr_accessor :context        
+
+        def initialize(context)
+          @context = context
+        end
+
+        def resolve(path, content_type = :self)
+          options = {}
+          options[:content_type] = content_type unless content_type.nil?
+          context.resolve(path, options)
+        rescue Sprockets::FileNotFound, Sprockets::ContentTypeMismatch
+          nil
+        end
+      
+        def public_path(path, scope)
+          context.asset_paths.compute_public_path(path, scope)
+        end
+
+        def process(path)
+          context.environment[path].to_s
+        end
+      end
+    end
+  end
+end