screw_server 0.1.4

data/lib/screw_server/app.rb

@@ -0,0 +1,197 @@
+require 'sinatra/base'
+
+require 'screw_server/jslint_suite'
+require "screw_server/spec_file"
+
+module ScrewServer
+  class App < Sinatra::Base
+
+    SPEC_BASE_URL = "___screw_specs___"
+    ASSET_BASE_URL = "___screw_assets___"
+    VIEW_PATH = File.join(File.dirname(__FILE__), "..", "..", "views")
+
+    set :views, VIEW_PATH
+
+    get "/run/:name" do
+      run_specs([SpecFile.new(params[:name])])
+    end
+
+    get "/run" do
+      run_specs(SpecFile.all)
+    end
+
+    get "/bisect/:victim/:begin/:end" do
+      victim = params[:victim]
+      suspects = SpecFile.all.map { |spec| spec.name } - [victim]
+
+      subset = suspects[params[:begin].to_i..(params[:end].to_i - 1)]
+
+      puts "suspects: #{subset.length}"
+
+      specs_to_run = (subset + [victim]).map {|name| SpecFile.new(name) }
+      run_specs(specs_to_run)
+    end
+
+    get "/" do
+      @specs = SpecFile.all
+      if @specs.empty?
+        render_setup_tutorial(:no_specs)
+      else
+        haml :index
+      end
+    end
+
+    get "/monitor" do
+      spec = SpecFile.latest
+      @include_monitor_code = true
+      run_specs([spec]);
+    end
+
+    get "/has_changes_since/:spec/:timestamp" do
+      if SpecFile.latest.name != params[:spec]
+        "true"
+      else
+        spec = SpecFile.new(params[:spec])
+        if spec.last_dependency_change > params[:timestamp].to_i
+          "true"
+        else
+          "false"
+        end
+      end
+    end
+
+    get "/#{SPEC_BASE_URL}/*" do
+      send_file(file_from_base_dir(Base.spec_base_dir, params[:splat]))
+    end
+
+    get "/#{ASSET_BASE_URL}/*" do
+      send_file(file_from_base_dir(asset_base_dir, params[:splat]))
+    end
+
+    helpers do
+      def cache_busting_url(url)
+        "#{url}?#{rand}"
+      end
+
+      def jslint_suites
+        jslint_file = File.join(Base.spec_base_dir, "jslint.rb")
+        if !File.exists?(jslint_file)
+          []
+        else
+          JslintSuite.suites_from(jslint_file).map do |suite|
+            {
+              :file_list => suite.file_list.map { |file| url_for_source_file(file) },
+              :options => suite.options_with_defaults
+            }
+          end
+        end
+      end
+
+      def url_for_screw_asset(file)
+        "/#{ASSET_BASE_URL}/#{file}"
+      end
+
+      def url_for_spec(file)
+        "/#{SPEC_BASE_URL}/#{file}"
+      end
+
+      def fixture_html
+        @specs.inject({}) { |result, spec| result.merge(spec.fixture_hash) }
+      end
+
+      def required_files
+        @specs.map(&:required_scripts).flatten.uniq
+      end
+
+      def monitor_code
+      spec = SpecFile.latest
+      <<-EOS
+        Screw.check_for_change = function() {
+          Screw.ajax({
+            url: "/has_changes_since/#{spec.name}/#{spec.last_dependency_change}",
+            cache: false,
+            success: function(answer) {
+              if (answer === "true") {
+                location.reload();
+              }
+              else {
+                setTimeout(Screw.check_for_change, 1000);
+              }
+            }
+          });
+        };
+        Screw.check_for_change();
+      EOS
+      end
+
+      def screw_assets
+        %w{
+          vendor/fulljslint.js
+          vendor/screw-unit/lib/jquery.fn.js
+          vendor/screw-unit/lib/jquery.print.js
+          vendor/screw-unit/lib/screw.builder.js
+          vendor/screw-unit/lib/screw.matchers.js
+          vendor/screw-unit/lib/screw.events.js
+          vendor/screw-unit/lib/screw.behaviors.js
+          vendor/smoke/lib/smoke.core.js
+          vendor/smoke/lib/smoke.mock.js
+          vendor/smoke/lib/smoke.stub.js
+          vendor/smoke/plugins/screw.mocking.js
+          screw-server.js
+        }
+      end
+
+      def sample_spec_file
+        "\n"+File.read(File.join(VIEW_PATH, "sample_spec.js"))
+      end
+
+      def sample_spec_helper
+        "\n"+File.read(File.join(VIEW_PATH, "sample_spec_helper.js"))
+      end
+    end
+
+    def self.run!(*args)
+      set(:public, Base.code_base_dir)
+      super(*args)
+    end
+
+    private
+
+    def file_from_base_dir(base_dir, file)
+      File.expand_path(File.join(base_dir, file)).tap do |result|
+        unless result.start_with?(base_dir)
+          raise Sinatra::NotFound, "Forbidden Access out of base directory"
+        end
+      end
+    end
+
+    def url_for_source_file(filename)
+      file = File.expand_path(filename)
+      if file.start_with?(Base.code_base_dir)
+        file[Base.code_base_dir.length..-1]
+      elsif file.start_with?(Base.spec_base_dir)
+        url_for_spec(file[(Base.spec_base_dir.length + 1)..-1])
+      else
+        raise "file #{file} cannot be checked by jslint since it it not inside the spec or code path"
+      end
+    end
+
+    def run_specs(specs)
+      if File.exists?(SpecFile.spec_helper_file)
+        @specs = specs
+        haml :run_spec
+      else
+        render_setup_tutorial(:missing_spec_helper)
+      end
+    end
+
+    def asset_base_dir
+      @assert_base_dir ||= File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "assets"))
+    end
+
+    def render_setup_tutorial(template)
+      @spec_base_dir = Base.spec_base_dir
+      haml template
+    end
+  end
+end

data/lib/screw_server/base.rb

@@ -0,0 +1,21 @@
+module ScrewServer
+  module Base
+    def self.spec_base_dir=(d)
+      raise "expected a directory with javascript specs under #{d}" unless File.exists?(d)
+      @spec_base_dir = d
+    end
+
+    def self.spec_base_dir
+      @spec_base_dir
+    end
+
+    def self.code_base_dir=(d)
+      raise "expected a directory with javascript code under #{d}" unless File.exists?(d)
+      @code_base_dir = d
+    end
+
+    def self.code_base_dir
+      @code_base_dir
+    end
+  end
+end

data/lib/screw_server/fixture_file.rb

@@ -0,0 +1,17 @@
+module ScrewServer
+  class FixtureFile
+    attr_reader :name
+
+    def self.base_dir
+      File.join(Base.spec_base_dir, "fixtures")
+    end
+
+    def initialize(name)
+      @name = name
+    end
+
+    def filename
+      "#{Base.spec_base_dir}/fixtures/#{name}.html"
+    end
+  end
+end

data/lib/screw_server/jslint_suite.rb

@@ -0,0 +1,51 @@
+module ScrewServer
+  class JslintSuite
+
+    DEFAULT_OPTIONS = {
+        # true
+      "bitwise" => true,
+      "browser" => true,
+      "eqeqeq" => true,
+      "immed" => true,
+      "newcap" => true,
+      "nomen" => true,
+      "regexp" => true,
+      "undef" => true,
+      # false
+      "plusplus" => false,
+      "indent" => false,
+      "onevar" => false,
+      "white" => false,
+      "regexp" => false,
+      "nomen" => false
+    }
+
+    attr_accessor :name, :file_list, :options
+
+    def initialize(n)
+      @name = n
+    end
+
+    def file_list=(v)
+      @file_list = v.map { |file| File.expand_path(file) }
+    end
+
+    def self.suites_from(file)
+      @suites = []
+      eval(IO.read(file), binding, file)
+      @suites
+    end
+
+    def options_with_defaults
+      DEFAULT_OPTIONS.merge(self.options || {})
+    end
+
+    private
+
+    def self.jslint(name)
+      suite = JslintSuite.new(name)
+      yield suite
+      @suites << suite
+    end
+  end
+end

data/lib/screw_server/spec_file.rb

@@ -0,0 +1,76 @@
+require "screw_server/base"
+require "screw_server/fixture_file"
+
+module ScrewServer
+  class SpecFile
+    def self.all
+      Dir.glob(File.join(Base.spec_base_dir, "*_spec.js")).sort.map do |file|
+        SpecFile.new(file.gsub("#{Base.spec_base_dir}/", "").gsub("_spec.js", ""))
+      end
+    end
+
+    def self.latest
+      SpecFile.all.sort{ |a, b| a.last_changed <=> b.last_changed }.last
+    end
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def filename
+      File.join(Base.spec_base_dir, full_name)
+    end
+
+    def full_name
+      name + "_spec.js"
+    end
+
+    def used_fixtures
+      scan_for_statement("use_fixture", filename).map {|name| FixtureFile.new(name) }
+    end
+
+    def fixture_hash
+      used_fixtures.inject({}) do |result, fixture|
+        result.merge(fixture.name => File.read(fixture.filename))
+      end
+    end
+
+    def required_scripts
+      required_files_in(SpecFile.spec_helper_file) + required_files_in(filename)
+    end
+
+    def last_dependency_change
+      used_files.map do |file|
+        File.mtime(file).to_i rescue 0
+      end.max
+    end
+
+    def last_changed
+      @last_changed ||= File.mtime(filename).to_i
+    end
+
+    def used_files
+      [filename, SpecFile.spec_helper_file] +
+        used_fixtures.map(&:filename) +
+        required_scripts.map {|script| File.join(Base.code_base_dir, script)}
+    end
+
+    def self.spec_helper_file
+      File.join(Base.spec_base_dir, "spec_helper.js")
+    end
+
+    protected
+
+    def scan_for_statement(statement, filename)
+      File.read(filename).scan(/#{statement}\(["']\/?(.+)['"]\)/).map { |groups| groups[0] }
+    end
+
+    def required_files_in(filename)
+      files = scan_for_statement("require", filename)
+      files = files.reject { |file| file == "spec_helper.js" }
+      files = files.map { |file| file.gsub("../../public", "") }
+    end
+  end
+end

data/lib/screw_server.rb

@@ -0,0 +1,2 @@
+require "screw_server/base"
+require "screw_server/app"

data/screw_server.gemspec

@@ -0,0 +1,28 @@
+Gem::Specification.new do |s|
+  s.name = %q{screw_server}
+  s.version = "0.1.4"
+  s.authors = ["Kristian Hanekamp", "Infopark AG"]
+  s.description = %q{Screw Server - easy javascript unit tests}
+  s.email = %q{kristian.hanekamp@infopark.de}
+  s.files =
+    Dir.glob("{lib,assets,views}/**/*") +
+    ["bin/screw_server", "Gemfile.run", "Gemfile.run.lock", "screw_server.gemspec"]
+  s.summary = %q{Screw Server}
+
+  s.add_dependency("json", "=1.4.3")
+  s.add_dependency("haml", "= 3.0.13")
+  s.add_dependency("bundler", "= 1.0.7")
+
+  # sinatra and dependencies
+    s.add_dependency("rack", "= 1.1.0")
+  s.add_dependency("sinatra", "= 1.0")
+
+  # thin and dependencies
+    s.add_dependency("daemons", "= 1.0.10")
+    # eventmachine 0.12.[7-10] has a bug when running without native extensions
+    # http://groups.google.com/group/eventmachine/browse_thread/thread/29fef72ee865ed6d
+    s.add_dependency("eventmachine", "= 0.12.6")
+  s.add_dependency("thin", "= 1.2.7")
+
+  s.executables  = ['screw_server']
+end

data/views/index.haml

@@ -0,0 +1,13 @@
+%html
+  %head
+    %link{:rel => "stylesheet", :href => url_for_screw_asset("screw.css"), :type => "text/css"}
+
+  %body
+    %h1 Screw Server
+    %div{:style => "margin: 20px;"}
+      %div{:style => "margin: 20px;"}
+        %a{:href => "/run"} RUN ALL
+        %a{:href => "/monitor"} MONITOR
+      -@specs.each do |spec|
+        %li
+          %a{:href => "/run/#{spec.name}"}= spec.name

data/views/missing_spec_helper.haml

@@ -0,0 +1,12 @@
+%html
+  %head
+    %link{:rel => "stylesheet", :href => url_for_screw_asset("screw.css"), :type => "text/css"}
+
+  %body
+    %p Cannot find #{@spec_base_dir}/spec_helper.js.
+    %br
+    %p Please create that file and use it for global test helpers.
+    %p Initially the file should at least require jQuery like this:
+    %br
+    %pre
+      = sample_spec_helper

data/views/no_specs.haml

@@ -0,0 +1,11 @@
+%html
+  %head
+    %link{:rel => "stylesheet", :href => url_for_screw_asset("screw.css"), :type => "text/css"}
+
+  %body
+    %p The directory #{@spec_base_dir} does not contain any specs.
+    %br
+    %p Create a file #{@spec_base_dir}/foo_spec.js with the following content
+    %br
+    %pre
+      = sample_spec_file

data/views/run_spec.haml

@@ -0,0 +1,30 @@
+%html
+  %head
+    %link{:rel => "stylesheet", :href => url_for_screw_asset("screw.css"), :type => "text/css"}
+
+    - required_files.each do |required_file|
+      %script{:type => "text/javascript", :src => cache_busting_url("/#{required_file}")}
+
+    - screw_assets.each do |asset|
+      %script{:type => "text/javascript", :src => url_for_screw_asset(asset)}
+
+    %script{:type => "text/javascript", :src => url_for_spec("spec_helper.js")}
+
+    %script{:type => "text/javascript"}
+      = "fixture_container = #{fixture_html.to_json}"
+      = "Screw.jslint_suites = #{jslint_suites.to_json};"
+  %body
+    %h3#screw_server_loading{:class => "status"}
+      Loading...
+    #fixture_container
+    - @specs.each do |spec|
+      %script{:type => "text/javascript", :src => cache_busting_url(url_for_spec(spec.full_name))}
+
+    %script{:type => "text/javascript", :src => url_for_screw_asset("screw-jslint.js")}
+
+    :javascript
+      $("#screw_server_loading").remove();
+
+    - if @include_monitor_code
+      %script{:type => "text/javascript"}
+        = monitor_code

data/views/sample_spec.js

@@ -0,0 +1,7 @@
+Screw.Unit(function(){
+  describe("Simple Test", function() {
+    it("should be simple to write", function() {
+      expect(2 * 2).to(equal, 4);
+    });
+  });
+});

data/views/sample_spec_helper.js

@@ -0,0 +1,2 @@
+// adjust the url below to match your application's jquery url
+require("/javascripts/jquery.js");