sinatra-reloader 0.4.0.a

data/README.md

@@ -0,0 +1,31 @@
+Sinatra::Reloader
+=================
+
+Advanced code reloader for [Sinatra](http://sinatrarb.com). Reloads only files that have
+changed and automatically detects orphaned routes that have to be removed. Most other
+implementations delete all routes and reload all code if one file changed, which takes way
+more time than reloading only one file, especially in larger projects. Files defining
+routes will be added to the reload list per default. Avoid reloading with dont_reload. Add
+other files to the reload list with also_reload.
+
+BigBand
+-------
+
+Sinatra::Reloader is part of the [BigBand](http://github.com/rkh/big_band) stack.
+Check it out if you are looking for other fancy Sinatra extensions.
+
+BigBand will setup the reloader automatically, but only in development mode.
+
+Usage
+-----
+
+    require "sinatra/base"
+    require "sinatra/reloader"
+    
+    class Foo < Sinatra::Base
+      configure(:development) do
+        register Sinatra::Reloader
+        also_reload "app/models/*.rb"
+        dont_reload "lib/**/*.rb"
+      end
+    end

data/lib/sinatra/reloader.rb

@@ -0,0 +1,121 @@
+require "monkey"
+require "sinatra/base"
+require "sinatra/sugar"
+require "sinatra/advanced_routes"
+
+module Sinatra
+  Base.ignore_caller
+
+  # Advanced reloader for sinatra. Reloads only files that have changed and automatically
+  # detects orphaned routes that have to be removed. Files defining routes will be added
+  # to the reload list per default. Avoid reloading with dont_reload. Add other files to
+  # the reload list with also_reload.
+  #
+  # Usage:
+  #
+  #   require "big_band"
+  #   class Foo < Sinatra::Base
+  #     configure(:development) do
+  #       register BigBand::Reloader
+  #       also_reload "app/models/*.rb"
+  #       dont_reload "lib/**/*.rb"
+  #     end
+  #   end
+  #
+  # Per default this will only be acitvated in development mode.
+  module Reloader
+
+    class FileWatcher < Array
+
+      attr_reader :file, :mtime
+
+      extend Enumerable
+      @map ||= {}
+
+      def self.register(route)
+        new(route.file) << route if route.file?
+      end
+
+      def self.new(file)
+        @map[file.expand_path] ||= super
+      end
+
+      class << self
+        alias [] new
+      end
+
+      def self.each(&block)
+        @map.values.each(&block) 
+      end
+
+      def initialize(file)
+        @reload = true
+        @file, @mtime = file, File.mtime(file)
+        super()
+      end
+
+      def changed?
+        !File.exist? file or @mtime != File.mtime(file)
+      end
+
+      def dont_reload!(dont = true)
+        @reload = !dont
+      end
+
+      def reload?
+        @reload and changed?
+      end
+
+      def reload
+        reload! if reload?
+      end
+
+      def reload!
+        each { |route| route.deactivate }
+        $LOADED_FEATURES.delete file
+        clear
+        if File.exist? file
+          @mtime = File.mtime(file)
+          require file
+        end
+      end
+
+    end
+
+    module ClassMethods
+      def dont_reload(*files)
+        if [true, false].include? files.last then dont = files.pop
+        else dont = true
+        end
+        files.flatten.each do |file|
+          Dir.glob(file) { |f| FileWatcher[f].dont_reload! dont }
+        end
+      end
+
+      def also_reload(*files)
+        dont_reload(files, false)
+      end
+    end
+
+    def self.registered(klass)
+      klass.register AdvancedRoutes
+      klass.extend ClassMethods
+      klass.each_route { |route| advanced_route_added(route) }
+      klass.before { Reloader.reload_routes }
+    end
+
+    def self.advanced_route_added(route)
+      FileWatcher.register(route)
+    end
+
+    def self.thread_safe?
+      Thread and Thread.list.size > 1 and Thread.respond_to? :exclusive
+    end
+
+    def self.reload_routes(thread_safe = true)
+      return Thread.exclusive { reload_routes(false) } if thread_safe and thread_safe?
+      FileWatcher.each { |file| file.reload }
+    end
+
+  end
+end

data/spec/sinatra/reloader_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+describe Sinatra::Reloader do
+
+  def app_file(file, content, go_sleeping = true)
+    sleep 1 if go_sleeping
+    file = File.expand_path(file, @temp_dir)
+    File.open(file, "w") { |f| f << "class ExampleApp < Sinatra::Base; #{content}; end" }
+    require file
+    file
+  end
+
+  def app
+    ExampleApp
+  end
+
+  before :all do
+    @temp_dir ||= File.expand_path "../../temp", __FILE__
+    rm_rf @temp_dir
+    mkdir_p @temp_dir
+    class ExampleApp < Sinatra::Base
+      register Sinatra::Reloader
+    end
+  end
+  
+  after :all do
+    rm_rf @temp_dir
+  end
+
+  it "should reload files" do
+    app_file("example_app.rb", "get('/foo') { 'foo' }")
+    browse_route(:get, '/foo').body.should == 'foo'
+    app_file("example_app.rb", "get('/foo') { 'bar' }")
+    browse_route(:get, '/foo').body.should == 'bar'
+  end
+
+  it "should not affact other routes" do
+    app_file("example_app.rb", "get('/foo') { 'foo' }")
+    app_file("example_app2.rb", "get('/bar') { 'bar' }", false)
+    browse_route(:get, '/bar').body.should == 'bar'
+    app_file("example_app.rb", "get('/foo') { 'bar' }")
+    browse_route(:get, '/bar').body.should == 'bar'
+  end
+
+  it "should respect dont_reload" do
+    file = app_file("example_app3.rb", "get('/baz') { 'foo' }", false)
+    app.dont_reload file
+    app_file("example_app3.rb", "get('/baz') { 'bar' }")
+    browse_route(:get, '/baz').body.should == 'foo'
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "sinatra/rspec"
+require "sinatra/reloader"
+require "fileutils"
+require "monkey"
+Sinatra::Base.set :environment, :test
+include FileUtils

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-reloader
+version: &id001 !ruby/object:Gem::Version 
+  version: 0.4.0.a
+platform: ruby
+authors: 
+- Konstantin Haase
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-16 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: monkey-lib
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - *id001
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra-advanced-routes
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - *id001
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra-sugar
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - *id001
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra-test-helper
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - *id001
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.3.0
+    version: 
+description: Smart and fast code reloader for Sinatra (part of BigBand).
+email: konstantin.mailinglists@googlemail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/sinatra/reloader.rb
+- spec/sinatra/reloader_spec.rb
+- spec/spec_helper.rb
+- README.md
+has_rdoc: yard
+homepage: http://github.com/rkh/sinatra-reloader
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: 1.3.1
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Smart and fast code reloader for Sinatra (part of BigBand).
+test_files: []
+