quick_serve 0.3.4

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Marcin Bunsch
+
+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.rdoc

@@ -0,0 +1,37 @@
+= quick_serve
+
+quick_serve is a super-simple way of serving static files for development. It was made mainly for javascript and css development, but might have other uses.
+
+=== General usage
+
+Type 'qs' or 'quick_serve'. It will start a mongrel web server using the current directory as docroot. By default it will use port 5000, but if you run 'qs -p 4000' it will use 4000 (or any other you specify). Type 'qs -h' for more options.
+
+=== Snapshot mode usage
+
+When evoked with -s trailed with an url, quick_serve will fetch the url and serve it regardless of the path you call. It's useful for testing js/css as it serves the snapshot from memory, minimizing cpu/memory usage leaving the browser with reloading js/css.
+
+=== Rails usage
+
+quick_serve has a Rails adapter which can be called by adding this in environment.rb:
+
+ require 'quick_serve'
+
+It's aimed at giving you a boost of speed on resource hungry pages when you're working on js/css.
+It will store all generated pages requested with GET and having no flash on it and free the snapshot collection when:
+
+* Any object is saved or destroyed in ActiveRecord
+* Any file is changed in the app/ directory 
+
+Keep in mind, it will run only in development mode.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request.
+
+== Copyright
+
+Copyright (c) 2009 Marcin Bunsch . See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "quick_serve"
+    gem.summary = %Q{Super simple web server mainly for javascript development}
+    gem.description = %Q{}
+    gem.email = "marcin@applicake.com"
+    gem.homepage = "http://github.com/marcinbunsch/quick_serve"
+    gem.authors = ["Marcin Bunsch"]
+    gem.bindir = 'bin'
+    gem.executables = ['quick_serve', 'qs']
+    gem.default_executable = 'qs'
+    gem.files = []
+    gem.files = FileList['*', '{bin,lib,images,spec}/**/*']
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "quick_serve #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.4

data/bin/qs

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'quick_serve'
+QuickServe::Server.new.start

data/bin/quick_serve

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'quick_serve'
+QuickServe::Server.new.start

data/lib/quick_serve/handlers/directory.rb

@@ -0,0 +1,74 @@
+module QuickServe
+  module Handlers
+    class Directory < Mongrel::DirHandler
+
+      STYLESHEET = <<-stylesheet
+      html, body {
+        font-family: "Lucida Grande", Verdana, sans-serif;
+        font-size: 90%;
+        font-weight: normal;
+        line-height: auto;
+      }
+      html {
+        background-color: #F0F0F0;
+      }
+      #body {
+        -moz-border-radius-bottomleft:10px;
+        -moz-border-radius-bottomright:10px;
+        -moz-border-radius-topleft:10px;
+        -moz-border-radius-topright:10px;
+        background-color: #fff;
+        border:1px solid #E1E1E1;
+        color:-moz-fieldtext;
+        width: 70%;
+        margin:4em auto;
+        padding:3em;
+      }
+      h1 {
+        font-size: 130%;
+        border-bottom: 1px solid #999;
+        padding: 3px;
+      }
+      a {
+        color: #666;
+        text-decoration: none
+      }
+      a:hover { color: #000 }
+      h3 { 
+        font-size: 115%;
+        margin-bottom: 10px; 
+      }
+      stylesheet
+      
+      def send_dir_listing(base, dir, response)
+        # take off any trailing / so the links come out right
+        base = Mongrel::HttpRequest.unescape(base)
+        base.chop! if base[-1] == "/"[-1]
+
+        if @listing_allowed
+          response.start(200) do |head,out|
+            head[Mongrel::Const::CONTENT_TYPE] = "text/html"
+            
+            out << "<html><head><title>Directory Listing for #{dir}</title><style type=\"text/css\">#{STYLESHEET}</style></head><body><div id=\"body\"><h1>Directory Listing for #{dir}</h1>"
+            entries = Dir.entries(dir)
+            entries = entries - ['..']
+            out << "<h3><a href=\"#{base}/..\">Up to higher level directory</a></h3>"
+            entries.each do |child|
+              next if child == "."
+              out << "<a href=\"#{base}/#{ Mongrel::HttpRequest.escape(child)}\">"
+              out << child
+              out << "</a><br/>"
+            end
+            out << "</div></body></html>"
+          end
+        else
+          response.start(403) do |head,out|
+            out.write("Directory listings not allowed")
+          end
+        end
+      end
+      
+    end
+  end
+end
+

data/lib/quick_serve/handlers/snapshot.rb

@@ -0,0 +1,31 @@
+module QuickServe
+  module Handlers
+    class Snapshot < Mongrel::HttpHandler
+  
+      def initialize(url)
+        @url = url
+        @https = (url.match('https:') ? true : false)
+        @host = url.gsub(/(http)(s*)(\:\/\/)/, '').split('/').first
+        @snapshot = nil
+        fetch
+        super()
+      end
+  
+      def fetch
+        require 'open-uri'
+        @snapshot = open(@url).read
+        host_root = (@https ? 'https://' : 'http://') + @host + '/'
+        @snapshot.gsub!(/(href=|src=)(['"])(\/)/, "\\1\\2#{host_root}\\4")
+      end
+  
+      def process(request, response)
+        response.start do |head,out|
+          puts "quick_serve: served snapshot of #{@url}"
+          head["Content-Type"] = "text/html"
+          out << @snapshot
+        end
+      end
+  
+    end
+  end
+end

data/lib/quick_serve/rails/ext/mongrel.rb

@@ -0,0 +1,27 @@
+# Here we hack mongrel do jump in front of the handler
+module Mongrel
+  module Rails
+    class RailsHandler 
+    
+      alias_method :original_process, :process
+      
+      def process(request, response)
+        # only serve GET
+        return original_process(request, response) if request.params['REQUEST_METHOD'] != 'GET'
+        url = 'http://' + request.params["HTTP_HOST"] + request.params["REQUEST_URI"]
+        snapshot = QuickServe::Rails::Snapshot.fetch(url)
+        if snapshot
+          response.start do |head,out|
+            puts "quick_serve: served snapshot of #{url}"
+            head["Content-Type"] = "text/html"
+            out << snapshot
+          end
+        else
+          original_process(request, response)
+        end
+      end
+      
+    end
+    
+  end
+end

data/lib/quick_serve/rails/ext/rails.rb

@@ -0,0 +1,27 @@
+module ActionController
+  class Base
+    after_filter :store_snapshot
+    def store_snapshot
+      puts "quick_serve: stored snapshot as #{request.url}"
+      # do not store redirects or pages with flash
+      QuickServe::Rails::Snapshot.store(request.url, response.body) if !response.redirected_to and flash == {}
+    end
+  end
+end
+
+module ActiveRecord
+  class Base
+    
+    after_save :free_snapshots
+    after_destroy :free_snapshots
+    
+    def free_snapshots
+      # if rails uses active_record store, it changes with each request, making quick_serve unusable
+      # this probably should be a config option (somehow)
+      return if self.class.to_s == 'CGI::Session::ActiveRecordStore::Session'
+      puts "quick_serve: detected change in #{self.class}"
+      QuickServe::Rails::Snapshot.reset
+    end
+    
+  end
+end

data/lib/quick_serve/rails/listener.rb

@@ -0,0 +1,81 @@
+require 'find'
+#
+# QuickServe::Listener
+#
+# The generic Listener, which polls the files after a specific interval
+#
+module QuickServe
+  module Rails
+    class Listener
+        attr_accessor :files, :interval
+      
+        # constructor
+        def initialize
+          self.interval = 2 # decrease the CPU load by increasing the interval
+        end 
+      
+        # find files and start the listener
+        def start
+          puts "** quick_serve: scanning for files... "
+          # build a file collection
+          find_files
+          puts "** quick_serve: watching #{files.size} files for changes... "
+          wait  
+        end
+      
+        # wait for a specified interval and check files for changes
+        # source: ZenTest/autotest.rb
+        def wait
+          Kernel.sleep self.interval until check_files
+        end
+      
+        # check files to find these that have changed
+        def check_files
+          updated = []
+          files.each do |filename, mtime| 
+            begin
+              current_mtime = File.stat(filename).mtime
+            rescue Errno::ENOENT
+              # file was not found and was probably deleted
+              # remove the file from the file list 
+              files.delete(filename)
+              next
+            end
+            if current_mtime != mtime  
+              updated << filename
+              # update the mtime in file registry so we it's only send once
+              files[filename] = current_mtime
+              puts "quick_serve: spotted change in #{filename}"
+            end
+          end
+          QuickServe::Rails::Snapshot.reset if updated != []
+          false
+        end
+       
+        ##
+        # Find the files to process, ignoring temporary files, source
+        # configuration management files, etc., and return a Hash mapping
+        # filename to modification time.
+        # source: ZenTest/autotest.rb
+        def find_files
+          result = {}
+          targets = ['app'] # start simple
+          targets.each do |target|
+            order = []
+            Find.find(target) do |f|
+              next if test ?d, f
+              next if f =~ /(swp|~|rej|orig)$/ # temporary/patch files
+              next if f =~ /(\.svn|\.git)$/ # subversion/git
+              next if f =~ /\/\.?#/ # Emacs autosave/cvs merge files
+              filename = f.sub(/^\.\//, '')
+
+              result[filename] = File.stat(filename).mtime rescue next
+            end
+          end
+        
+          self.files = result
+        end
+  
+    end    
+  end
+end

data/lib/quick_serve/rails/snapshot.rb

@@ -0,0 +1,28 @@
+# Storage for snapshots of pages generated by rails
+module QuickServe
+  module Rails
+    class Snapshot
+      @@snapshots = {}
+    
+      # return collection
+      def self.dump
+        @@snapshots
+      end
+    
+      # remove all snapshots
+      def self.reset
+        @@snapshots = {}
+      end
+    
+      # store a snapshot under specified key
+      def self.store(key, snapshot)
+        @@snapshots[key] = snapshot
+      end
+    
+      # fetch a snapshot stored under specified key
+      def self.fetch(key)
+        @@snapshots[key]
+      end
+    end
+  end
+end

data/lib/quick_serve/rails.rb

@@ -0,0 +1,6 @@
+require 'quick_serve/rails/snapshot'
+require 'quick_serve/rails/listener'
+require 'quick_serve/rails/ext/mongrel'
+require 'quick_serve/rails/ext/rails'
+puts "** quick_serve: attaching rails snapshot handler"
+Thread.new { QuickServe::Rails::Listener.new.start }

data/lib/quick_serve/server.rb

@@ -0,0 +1,93 @@
+module QuickServe
+  class Server
+  
+    def initialize
+      @options = { :dir => '.', :port => 5000, :host => '0.0.0.0', :deamon => false, :url => nil }
+      parse
+    end
+
+    def start
+      if @options[:url]
+        puts "quick_serve: running in snapshot mode using #{@options[:url]} as source"
+      else
+        puts "quick_serve: mongrel running on port #{@options[:port]} with current directory as docroot"
+      end
+      begin
+        if @options[:deamon]
+          pid = fork do
+            $stderr, $stdout = StringIO.new, StringIO.new
+            serve
+          end
+          File.open(pidfile, 'w') {|f| f.write(pid) }      
+        else
+          serve
+        end
+      rescue Errno::EADDRINUSE
+        puts "quick_serve: port #{@options[:port]} is used by another process. Please specify other port using the -p option"
+      end
+    end
+  
+    private
+
+      def serve
+        options = @options
+        config = Mongrel::Configurator.new :host => options[:host], :port => options[:port] do
+          listener do
+            if options[:url]
+              require 'quick_serve/handlers/snapshot'
+              uri "/", :handler => QuickServe::Handlers::Snapshot.new(options[:url])
+            else
+              require 'quick_serve/handlers/directory'
+              uri "/", :handler => QuickServe::Handlers::Directory.new(options[:dir])
+            end  
+          end
+          trap("INT") { stop }
+          run
+        end
+        config.join
+      end
+    
+      def parse
+        require 'optparse'
+        OptionParser.new do |opts|
+          opts.banner = "Usage: qs [options]"
+
+          opts.on("-p PORT", "--port PORT", "Specify port (default: 5000)") { |value| @options[:port] = value; }
+          opts.on("--dir DIRECTORY", "Specify directory to act as docroot (default: current directory)") { |value| @options[:dir] = value; }
+          opts.on("--host HOST", "Specify host (default: 0.0.0.0)") { |value| @options[:host] = value; }
+          opts.on("-s URL", "--snapshot URL", "Specify url for snapshot") { |value| @options[:url] = value; }
+          opts.on("-q", "quit deamon (if present)") { quit }
+          opts.on("-d", "--deamon", "Run as a deamon process") { @options[:deamon] = true; }
+          opts.on_tail("-h", "--help", "Show this message") do
+            puts opts
+            exit
+          end
+        end.parse!
+      end
+    
+      def quit
+      
+        print "Stopping quick serve... "
+        die(" pid file not found") if !File.exists?(pidfile)
+        pid = File.read(pidfile)
+        begin
+          if Process.kill("INT", pid.to_i) == 1
+            puts ' ok'
+            File.delete(pidfile) if File.exist?(pidfile)
+          end
+        rescue Errno::ESRCH
+          puts ' not found'
+        end
+        exit
+      end
+  
+      def pidfile
+        File.join(@options[:dir], "qs.#{@options[:port]}.pid")
+      end
+    
+      def die(msg)
+        puts msg
+        exit(1)
+      end
+  end
+end

data/lib/quick_serve.rb

@@ -0,0 +1,15 @@
+if defined?(RAILS_ENV)
+  if RAILS_ENV == 'development'
+    require 'quick_serve/rails'
+  else
+    puts "** quick_serve: quick_serve rails adapter can run only in development environment"
+  end
+else
+  begin
+    require 'mongrel' 
+  rescue LoadError
+    puts "quick_serve requires mongrel. Install it with: gem install mongrel"
+    exit(1)
+  end
+  require 'quick_serve/server'
+end

data/quick_serve.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{quick_serve}
+  s.version = "0.3.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marcin Bunsch"]
+  s.date = %q{2009-09-17}
+  s.default_executable = %q{qs}
+  s.description = %q{}
+  s.email = %q{marcin@applicake.com}
+  s.executables = ["quick_serve", "qs"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/qs",
+     "bin/quick_serve",
+     "lib/quick_serve.rb",
+     "lib/quick_serve/handlers/directory.rb",
+     "lib/quick_serve/handlers/snapshot.rb",
+     "lib/quick_serve/rails.rb",
+     "lib/quick_serve/rails/ext/mongrel.rb",
+     "lib/quick_serve/rails/ext/rails.rb",
+     "lib/quick_serve/rails/listener.rb",
+     "lib/quick_serve/rails/snapshot.rb",
+     "lib/quick_serve/server.rb",
+     "quick_serve.gemspec"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/marcinbunsch/quick_serve}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Super simple web server mainly for javascript development}
+  s.test_files = [
+    "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'quick_serve'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: quick_serve
+version: !ruby/object:Gem::Version 
+  version: 0.3.4
+platform: ruby
+authors: 
+- Marcin Bunsch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-25 00:00:00 +02:00
+default_executable: qs
+dependencies: []
+
+description: ""
+email: marcin@applicake.com
+executables: 
+- quick_serve
+- qs
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/qs
+- bin/quick_serve
+- lib/quick_serve.rb
+- lib/quick_serve/handlers/directory.rb
+- lib/quick_serve/handlers/snapshot.rb
+- lib/quick_serve/rails.rb
+- lib/quick_serve/rails/ext/mongrel.rb
+- lib/quick_serve/rails/ext/rails.rb
+- lib/quick_serve/rails/listener.rb
+- lib/quick_serve/rails/snapshot.rb
+- lib/quick_serve/server.rb
+- quick_serve.gemspec
+has_rdoc: true
+homepage: http://github.com/marcinbunsch/quick_serve
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Super simple web server mainly for javascript development
+test_files: 
+- test/test_helper.rb