rack-xapper 0.0.1

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ivan Porto Carrero
+
+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,81 @@
+= Rack Xapper
+
+This is a Rack Middleware which will generate Silverlight xap files for DLR projects.
+It mimics the functionality of Chiron the development server for working with Silverlight and the DLR.
+This enables integration of Silverlight in any framework that supports Rack (Merb/Rails/Sinatra/...).
+
+=== Configuration options
+
+By default the middleware makes some decisions on how it thinks your application is structured.
+
+  DEFAULT_OPTIONS= {
+    :assembly_path => ::File.dirname(__FILE__) + '/../assemblies',
+    :xap_path => "sl",
+    :source_path => 'app/silverlight',
+    :extra_app_files => [],
+    :xap_name => 'app',
+    :external_url_prefix => "/dlr-slvx",
+    :root => 'public',
+    :sl_version => :clr2,
+    :languages => LANGUAGES,
+    :app_manifest => APP_MANIFEST_TEMPLATE
+  }
+
+You can override any of these settings and I'll explain them first:
+
+* <tt>:assembly_path</tt>: the place to look for the silverlight and DLR assemblies
+* <tt>:xap_path</tt>: the folder under the root where the xap will be saved
+* <tt>:source_path</tt>: the folder containing the application entry point and source files
+* <tt>:extra_app_files</tt>: extra folders that should be included in the xap file
+* <tt>:xap_name</tt>: the name of the xap file
+* <tt>:root</tt>: the root folder for the xap path
+* <tt>:sl_version</tt>: the silverlight version to use (currently :clr2, :clr3)
+* <tt>:languages</tt>: the supported languages
+* <tt>:app_manifest</tt>: the template used to generate the AppManifest.xaml file
+
+=== Frameworks support
+
+Rack is supported by many frameworks but some are configured differently.
+Here are some examples to get you started
+
+==== Rails configuration
+
+  # in environment.rb
+  config.gem "rack-xapper", :lib => "rack/xapper", :source => "http://gemcutter.org"
+  config.middleware.use "Rack::Xapper", :source_path => "app/silverlight"
+
+==== Sinatra configuration
+
+  require 'rack/xapper'
+
+  class Application < Sinatra::Application
+    use Rack::Xapper, :source_path => "silverlight"
+  end
+
+==== Rack configuration
+
+  # in config.ru
+  require 'rack/xapper' 
+  
+  use Rack::Xapper, :source_path => "silverlight"
+
+== Note
+
+* This is the result of a late night hacking session so the library is a little light on tests.
+
+* This middleware has a dependency on rubyzip2 but unfortunately the gemspec of rubyzip2 is faulty. 
+  It's missing the version.rb file. I've sent a pull request to the owner of that gem so hopefully it will be fixed soon.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* 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. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Ivan Porto Carrero. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,46 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rack-xapper"
+    gem.summary = %Q{Rack middleware for generating xap files}
+    gem.description = %Q{Rack middleware for generating xapfiles that know about the DLR}
+    gem.email = "ivan@flanders.co.nz"
+    gem.homepage = "http://github.com/casualjim/rack-xapper"
+    gem.authors = ["casualjim"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "rubyzip2", ">= 2.0.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rack-xapper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 1
+:major: 0
+:minor: 0

data/lib/rack/xapper.rb

@@ -0,0 +1,301 @@
+require "zip/zip"
+require "time"  # for Time.httpdate
+require 'rack/utils'
+require 'rack/mime'
+require 'rexml/document'
+
+module Rack
+  
+  class XapBuilder
+    
+    F = ::File
+    X = ::REXML
+    
+    class << self
+      
+      def xap_to_memory(root)
+        
+      end
+      
+      def xap_to_disk(options, xap_file="")
+        xap_file = options[:xap_name] if xap_file.to_s.empty?
+        xap_file = "#{xap_file}.xap" if xap_file !~ /\.xap$/
+        
+        collect_metadata(options) unless options.key?(:application_files)
+        
+        Zip::ZipFile.open(F.join(options[:root], options[:xap_path], xap_file), Zip::ZipFile::CREATE) do |zipfile|
+          xap_files(zipfile, options)
+        end
+      end
+    
+      def collect_metadata(options)
+        options[:application_files] = collect_application_files options
+        options[:extra_app_files] = collect_extra_app_files options
+        options[:assembly_files] = Dir.glob(F.join(options[:assembly_path],"**","*"))
+        options[:languages_in_use] = find_languages_in_use options        
+      end
+      
+      private
+      def xap_files(archive, options)       
+        add_dlr_assemblies        archive, options        
+        add_languages             archive, options
+        add_extra_directories     archive, options
+        add_application_files     archive, options
+        generate_languages_config archive, options
+        generate_app_manifest     archive, options        
+      end
+      
+      def generate_app_manifest(archive, options)
+        archive.get_output_stream("AppManifest.xaml") do |f|  
+          doc = X::Document.new(options[:app_manifest]||Xapper::APP_MANIFEST_TEMPLATE)
+          options[:added_assemblies].each do |assembly|
+            ele = X::Element.new "AssemblyPart"
+            ele.attributes['Source'] = assembly
+            doc.root.elements['Deployment.Parts'] << ele
+          end
+          f.puts doc.to_s 
+        end
+      end
+      
+      def generate_languages_config(archive, options)
+        archive.get_output_stream("languages.config") do |f|
+          doc = X::Document.new("<Languages></Languages>")
+          options[:languages_in_use].each do |language|
+            ele = X::Element.new "Language"
+            ele.attributes['names'] = language[:names].join(",")
+            ele.attributes['extensions'] = language[:extensions].join(",")
+            ele.attributes['languageContext'] = language[:context]
+            ele.attributes['assemblies'] = language[:assemblies].join(";")
+            ele.attributes['external'] = language[:external]
+            doc.root << ele
+          end
+          f.puts doc.to_s
+        end
+      end
+      
+      def add_dlr_assemblies(archive, options)
+        add_dlr_assembly archive, options, "Microsoft.Dynamic"
+        add_dlr_assembly archive, options, "Microsoft.Scripting"
+        if [:clr2, :clr3, :sl2, :sl3].include?(options[:sl_version].to_sym)        
+          add_dlr_assembly archive, options, "Microsoft.Scripting.Core"
+          add_dlr_assembly archive, options, "Microsoft.Scripting.ExtensionAttribute"
+        end
+        add_dlr_assembly archive, options, "Microsoft.Scripting.Silverlight" if (ENV['RACK_ENV']||'development') != 'production'
+      end
+      
+      def add_languages(archive, options)
+        options[:languages_in_use].each do |language|
+          language[:assemblies].each do |assembly|
+            add_dlr_assembly archive, options, assembly
+          end
+        end
+      end
+      
+      def add_dlr_assembly(archive, options, name)
+        options[:added_assemblies] ||= []
+        pth = assembly_path(options, name)
+        if F.file?(pth)
+          nm = F.basename pth
+          archive.add nm, pth 
+          options[:added_assemblies] << nm
+        end
+      end
+      
+      def assembly_path(options, name)
+        name = "#{name}.dll" unless /\.dll$/ =~ name
+         F.join(options[:assembly_path], name)
+      end
+      
+      def find_languages_in_use(options)
+        (options[:application_files] +  options[:extra_app_files]).inject([]) do |langs, candidate|
+          lang = options[:languages].find { |lang| lang[:extensions].include?(F.extname(candidate)) }
+          langs << lang if lang
+          langs
+        end
+      end
+      
+      def collect_application_files(options)
+        Dir.glob(F.join(options[:source_path], "**", "*"))
+      end
+            
+      def collect_extra_app_files(options)
+        options[:extra_app_files].collect do |pth|
+          Dir.glob(F.join(pth, "**", "*"))
+        end.flatten
+      end
+      
+      def add_extra_directories(archive, options)
+        options[:extra_app_files].collect do |pth|
+          archive.add F.basename(path), path if F.file?(path)
+        end
+      end
+      
+      def add_application_files(archive, options)
+        options[:application_files].each do |en|
+          archive.add F.basename(en), en if F.file?(en)
+        end
+      end
+    end
+    
+  end
+  
+  class Xapper
+    
+    Rack::Mime::MIME_TYPES.merge!({
+      ".js"      => "application/x-javascript",
+      ".py"      => "application/python",
+      ".rb"      => "application/ruby",
+      ".zip"     => "application/x-zip-compressed",
+      ".slvx"    => "application/x-zip-compressed",
+      ".xaml"    => "application/xaml+xml",
+      ".xap"     => "application/x-zip-compressed"
+    })
+    
+    APP_MANIFEST_TEMPLATE = <<-TEMPLEND
+
+<Deployment xmlns="http://schemas.microsoft.com/client/2007/deployment" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" RuntimeVersion="2.0.31005.0" EntryPointAssembly="Microsoft.Scripting.Silverlight" EntryPointType="Microsoft.Scripting.Silverlight.DynamicApplication" ExternalCallersFromCrossDomain="ScriptableOnly">
+  <!-- Add assembly references here -->
+  <Deployment.Parts>
+    <!-- In the XAP -->
+    <!-- <AssemblyPart Source="Foo.dll" /> -->
+    <!-- Outside the XAP, same domain -->
+    <!-- <AssemblyPart Source="/Foo.dll" /> -->
+    <!-- Outside the XAP, different domain -->
+    <!-- <AssemblyPart Source="http://bar.com/Foo.dll" /> -->
+    
+  </Deployment.Parts>
+  <!-- Add transparent platform extensions (.slvx) references here -->
+  <Deployment.ExternalParts>
+    <!-- Example -->
+    <!-- <ExtensionPart Source="http://bar.com/v1/Foo.slvx" /> -->
+  </Deployment.ExternalParts>
+</Deployment>
+ 
+    TEMPLEND
+    
+    LANGUAGES=[
+      {
+        :names => %w(IronPython Python py),
+        :extensions => %w(.py),
+        :context => "IronPython.Runtime.PythonContext",
+        :assemblies => %w(IronPython.dll IronPython.Modules.dll),
+        :external => "IronPython.slvx"
+      },
+      {
+        :names => %w(IronRuby Ruby rb),
+        :extensions => %w(.rb),
+        :context => "IronRuby.Runtime.RubyContext",
+        :assemblies => %w(IronRuby.dll IronRuby.Libraries.dll),
+        :external => "IronRuby.slvx"
+      }
+    ]
+
+    DEFAULT_OPTIONS= {
+      :assembly_path => ::File.dirname(__FILE__) + '/../assemblies',
+      :xap_path => "sl",
+      :source_path => 'app/silverlight',
+      :extra_app_files => [],
+      :xap_name => 'app',
+      :external_url_prefix => "/dlr-slvx",
+      :root => 'public',
+      :sl_version => :clr2,
+      :languages => LANGUAGES,
+      :app_manifest => APP_MANIFEST_TEMPLATE
+    }
+    
+
+    
+    def initialize(app, options={})
+      @xap_options = DEFAULT_OPTIONS.merge(options)
+      @app = app
+    end
+
+    def call(env)
+      path = env['PATH_INFO']
+      can_serve = /#{@xap_options[:xap_name]}\.xap/ =~ path
+      
+      if can_serve
+        file_server = XapFile.new(@xap_options)
+        file_server.call(env)
+      else
+        @app.call(env)
+      end
+    end
+  end
+
+  class XapFile 
+
+    def initialize(options)
+      @options = options.dup
+      xap_name = "#{@options[:xap_name]}"
+      xap_name = "#{xap_name}.xap" if xap_name !~ /\.xap$/
+      @xap_path = @options[:root] + "/" + @options[:xap_path] + "/" + xap_name
+    end
+    
+    def call(env)
+      dup._call(env)
+    end
+
+    F = ::File
+
+    def _call(env)
+      @path_info = Utils.unescape(env["PATH_INFO"])
+      return forbidden  if @path_info.include? ".."
+
+      if dev_env? or xap_changed?
+        FileUtils.rm(@xap_path) if F.exist?(@xap_path)
+        XapBuilder.xap_to_disk @options
+      end
+
+      begin
+        if F.file?(@xap_path) && F.readable?(@xap_path)
+          [200, {
+            "Date"           => F.mtime(@xap_path).httpdate,
+            "Content-Type"   => Mime.mime_type(F.extname(@xap_path), 'application/x-zip-compressed'),
+            "Cache-Control"  => "no-cache",
+            "Expires"        => "-1",
+            'Pragma'         => "no-cache",
+            "Content-Length" => F.size?(@xap_path).to_s
+          }, self]
+        else
+          raise Errno::EPERM
+        end
+      rescue SystemCallError
+        not_found
+      end
+    end
+    
+    def dev_env?
+      (ENV['RACK_ENV'] || 'development').to_sym != :production
+    end
+    
+    def xap_changed?
+      XapBuilder.collect_metadata(@options)
+      files = @options[:application_files] + @options[:extra_app_files] + @options[:assembly_files]
+      xap_mtime = File.mtime(@xap_path)
+      files.any?{ |f| File.mtime(f) > xap_mtime }      
+    end
+
+    def forbidden
+      body = "Forbidden\n"
+      [403, {"Content-Type" => "text/plain",
+             "Content-Length" => body.size.to_s},
+       [body]]
+    end
+
+    def not_found
+      body = "File not found: #{@path_info}\n"
+      [404, {"Content-Type" => "text/plain",
+         "Content-Length" => body.size.to_s},
+       [body]]
+    end
+
+    def each
+      F.open(@xap_path, "rb") { |file|
+        while part = file.read(8192)
+          yield part
+        end
+      }
+    end
+  end
+end

data/rack-xapper.gemspec

@@ -0,0 +1,68 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rack-xapper}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["casualjim"]
+  s.date = %q{2009-11-28}
+  s.description = %q{Rack middleware for generating xapfiles that know about the DLR}
+  s.email = %q{ivan@flanders.co.nz}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "lib/assemblies/IronPython.Modules.dll",
+     "lib/assemblies/IronPython.dll",
+     "lib/assemblies/IronRuby.Libraries.dll",
+     "lib/assemblies/IronRuby.dll",
+     "lib/assemblies/Microsoft.Dynamic.dll",
+     "lib/assemblies/Microsoft.Scripting.Core.dll",
+     "lib/assemblies/Microsoft.Scripting.Debugging.dll",
+     "lib/assemblies/Microsoft.Scripting.ExtensionAttribute.dll",
+     "lib/assemblies/Microsoft.Scripting.Silverlight.dll",
+     "lib/assemblies/Microsoft.Scripting.dll",
+     "lib/rack/xapper.rb",
+     "rack-xapper.gemspec",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/xapper_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/casualjim/rack-xapper}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rack middleware for generating xap files}
+  s.test_files = [
+    "spec/spec_helper.rb",
+     "spec/xapper_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<rubyzip2>, [">= 2.0.0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<rubyzip2>, [">= 2.0.0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<rubyzip2>, [">= 2.0.0"])
+  end
+end
+

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rack-xapper'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

data/spec/xapper_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "RackXapper" do
+  it "fails" do
+    fail "hey buddy, you should probably rename this file and start specing for real"
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: rack-xapper
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- casualjim
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-28 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rubyzip2
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+description: Rack middleware for generating xapfiles that know about the DLR
+email: ivan@flanders.co.nz
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/assemblies/IronPython.Modules.dll
+- lib/assemblies/IronPython.dll
+- lib/assemblies/IronRuby.Libraries.dll
+- lib/assemblies/IronRuby.dll
+- lib/assemblies/Microsoft.Dynamic.dll
+- lib/assemblies/Microsoft.Scripting.Core.dll
+- lib/assemblies/Microsoft.Scripting.Debugging.dll
+- lib/assemblies/Microsoft.Scripting.ExtensionAttribute.dll
+- lib/assemblies/Microsoft.Scripting.Silverlight.dll
+- lib/assemblies/Microsoft.Scripting.dll
+- lib/rack/xapper.rb
+- rack-xapper.gemspec
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/xapper_spec.rb
+has_rdoc: true
+homepage: http://github.com/casualjim/rack-xapper
+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: Rack middleware for generating xap files
+test_files: 
+- spec/spec_helper.rb
+- spec/xapper_spec.rb