marcinbunsch-quick_serve 0.2.0 → 0.3.1

data/README.rdoc

@@ -1,12 +1,36 @@
-= quick_serve
+== quick_serve
 
 quick_serve is a super-simple way of serving static files for development. It was made mainly for javascript development, but might have other uses.
 
-= usage
+= General usage
 
-Type 'qs' or 'quick_serve'
+Type 'qs' or 'quick_serve'. By default it will use port 5000, but if you run 'qs -p 4000' it will use 4000 (or any other you specify)
 
-By default it will use port 3000, but if you run 'qs 4000' it will use 4000 (or any other you specify)
+*Options:*
+* *-p PORT, --port PORT* Specify port (default: 5000) 
+* *--dir DIRECTORY* Specify directory to act as docroot (default: current directory)
+* *--host HOST* Specify host (default: 0.0.0.0)
+* *-s URL, --snapshot URL* Specify url for snapshot
+* *-q* quit deamon (if present)
+* *-d, --deamon* Run as a deamon process
+
+= 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
  

data/Rakefile

@@ -13,7 +13,8 @@ begin
     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

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.1

data/bin/qs

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

data/bin/quick_serve

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

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,23 @@
+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
+      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 ">> 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,92 @@
+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/snapshot/handler'
+              uri "/", :handler => QuickServe::Snapshot::Handler.new(options[:url])
+            else
+              uri "/", :handler => Mongrel::DirHandler.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/snapshot/handler.rb

@@ -0,0 +1,31 @@
+module QuickServe
+  module Snapshot
+    class Handler < 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.rb

@@ -1,92 +1,17 @@
-begin
-require 'mongrel' 
-rescue LoadError
-  puts "quick_serve requires mongrel. Install it with: gem install mongrel"
-  exit(1)
-end
-
-class QuickServe
-  
-  def initialize
-    @options = { :dir => '.', :port => 3000, :host => '0.0.0.0', :deamon => false }
-    parse
+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
-  
-  
-  def start
-    puts "quick_serve: Mongrel running on port #{@options[:port]} current directory as docroot"
-    begin
-      if @options[:deamon]
-        pid = fork do
-          captured_stdout = StringIO.new
-          old_stdout, $stdout = $stdout, captured_stdout
-          captured_stderr = StringIO.new
-          old_stderr, $stdout = $stdout, captured_stderr
-          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
+else
+  begin
+    require 'mongrel' 
+  rescue LoadError
+    puts "quick_serve requires mongrel. Install it with: gem install mongrel"
+    exit(1)
   end
-  
-  private
 
-    def serve
-      options = @options
-      config = Mongrel::Configurator.new :host => options[:host], :port => options[:port] do
-        listener do
-          uri "/", :handler => Mongrel::DirHandler.new(options[:dir])
-        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") { |value| @options[:port] = value; }
-        opts.on("--dir DIRECTORY", "Specify directory to act as docroot") { |value| @options[:dir] = value; }
-        opts.on("--host HOST", "Specify host") { |value| @options[:host] = value; }
-        # opts.on("quit", "quit deamon (if present)") { quit }
-        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
+  require 'quick_serve/server'
+  require 'quick_serve/snapshot_handler'
+end

data/quick_serve.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{quick_serve}
-  s.version = "0.2.0"
+  s.version = "0.3.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marcin Bunsch"]
-  s.date = %q{2009-09-12}
+  s.date = %q{2009-09-13}
   s.default_executable = %q{qs}
   s.description = %q{}
   s.email = %q{marcin@applicake.com}
@@ -16,17 +16,21 @@ Gem::Specification.new do |s|
      "README.rdoc"
   ]
   s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
+    "LICENSE",
      "README.rdoc",
      "Rakefile",
      "VERSION",
      "bin/qs",
      "bin/quick_serve",
      "lib/quick_serve.rb",
-     "quick_serve.gemspec",
-     "test/test_helper.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",
+     "lib/quick_serve/snapshot/handler.rb",
+     "quick_serve.gemspec"
   ]
   s.homepage = %q{http://github.com/marcinbunsch/quick_serve}
   s.rdoc_options = ["--charset=UTF-8"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: marcinbunsch-quick_serve
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Marcin Bunsch
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-12 00:00:00 -07:00
+date: 2009-09-13 00:00:00 -07:00
 default_executable: qs
 dependencies: []
 
@@ -24,8 +24,6 @@ extra_rdoc_files:
 - LICENSE
 - README.rdoc
 files: 
-- .document
-- .gitignore
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -33,8 +31,14 @@ files:
 - bin/qs
 - bin/quick_serve
 - lib/quick_serve.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
+- lib/quick_serve/snapshot/handler.rb
 - quick_serve.gemspec
-- test/test_helper.rb
 has_rdoc: false
 homepage: http://github.com/marcinbunsch/quick_serve
 licenses: 

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,5 +0,0 @@
-*.sw?
-.DS_Store
-coverage
-rdoc
-pkg