rake-pipeline-typescript 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dcd4ae5c843ad3ce3171d433fe9db603b3e96e11
+  data.tar.gz: 033e0a0412fbc7a28b216b042e4d42df842bcf02
+SHA512:
+  metadata.gz: 09405205ef6984c603fcac9e072b13cbeb1f81c2b50385262f954a20ce4e636669855a94cb45aa480efe66098d79c73cea7648fc9a58393f3f625d8f7b7c254d
+  data.tar.gz: b675949a295c43acda4e5cb06059debe35537e8914479d86af8c17c3b2b03a7b64cb3eda02aa4c810c2ed5eceb8ccb1ec25f2333385f8bbf5a1bd568ab50f803

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+node_modules
+.project

data/.rspec

@@ -0,0 +1 @@
+-cfs -r spec_helper.rb

data/.yardopts

@@ -0,0 +1,2 @@
+--readme README.yard
+

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem "rake-pipeline", :git => "git://github.com/livingsocial/rake-pipeline.git"
+
+# Specify your gem's dependencies in rake-pipeline-typescript.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) <2013> <Taylor Brown and YouNeedABudget.com>
+
+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.markdown

@@ -0,0 +1,28 @@
+# Rake::Pipeline::Typescript
+
+This is a typescript filter to compile Tyescript files in the Rake Pipeline.
+Probably not ready for production. It appears to be quite slow, and my hunch is
+that it's due to spawning a separate Node process for each file that needs to be
+compiled. However, [typescript-rails](https://github.com/klaustopher/typescript-rails) is
+using the typescript-node-ruby library as well without complaint, so maybe
+the TS compiler is slow. I'm publishing it anyway. Please feel free to send pull
+requests.
+
+(I shamelessly forked [rake-pipeline-web-filters](https://github.com/wycats/rake-pipeline-web-filters)
+since this is my first Gem)
+
+Here's how you'd use it in your Assetfile:
+
+```ruby
+# Assetfile
+require 'rake-pipeline-typescript'
+
+#Other stuff up here (CoffeeScript, etc)
+
+match "**/*.ts" do
+  type_script
+end
+
+#More stuff down here...
+
+```

data/README.yard

@@ -0,0 +1,20 @@
+= Rake::Pipeline::Typescript
+
+Rake::Pipeline::Typescript is a typescript filter to compile Tyescript
+files in the Rake Pipeline.
+
+= Usage
+
+In your +Assetfile+:
+
+  !!!ruby
+  require "rake-pipeline-typescript"
+
+  input "assets"
+  output "public"
+
+  # Take all TS inputs and compiles them to JS
+  match "*.ts" do
+    type_script
+  end
+

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "bundler/setup"
+
+desc "run the specs"
+task :spec do
+  sh "rspec -cfs spec"
+end
+
+task :default => :spec

data/lib/rake-pipeline-typescript.rb

@@ -0,0 +1,13 @@
+require "rake-pipeline"
+
+module Rake
+  class Pipeline
+    module Typescript
+    end
+  end
+end
+
+require "rake-pipeline-typescript/version"
+require "rake-pipeline-typescript/filter_with_dependencies"
+require "rake-pipeline-typescript/type_script_filter"
+require "rake-pipeline-typescript/helpers"

data/lib/rake-pipeline-typescript/filter_with_dependencies.rb

@@ -0,0 +1,29 @@
+module Rake::Pipeline::Typescript
+  #Taken from Rake::Pipeline::Web::Filters
+
+  # A mixin for filters that have dependencies on external
+  # libraries. Include this module in the filter class and
+  # declare a private `external_dependencies` method that
+  # returns an array of strings. Each one will be passed
+  # to `Kernel#require` when an instance of the filter
+  # is created.
+  module FilterWithDependencies
+
+    def initialize(*args, &block)
+      require_dependencies!
+      super(*args, &block)
+    end
+
+    private
+
+    def require_dependencies!
+      external_dependencies.each do |d|
+        begin
+          require d
+        rescue LoadError => error
+          raise error, "#{self.class} requires #{d}, but it is not available."
+        end
+      end
+    end
+  end
+end

data/lib/rake-pipeline-typescript/helpers.rb

@@ -0,0 +1,21 @@
+module Rake::Pipeline::Typescript
+  # Extends the Rake::Pipeline DSL to include shortcuts
+  # for adding filters to the pipeline.
+  #
+  # You can do:
+  #   !!!ruby
+  #   match("*.ts") do
+  #     type_script
+  #   end
+  module PipelineHelpers
+    # Add a new {TypeScriptFilter} to the pipeline.
+    # @see TypeScriptFilter#initialize
+    def type_script(*args, &block)
+      filter(Rake::Pipeline::Typescript::TypeScriptFilter, *args, &block)
+    end
+  end
+end
+
+require "rake-pipeline/dsl"
+
+Rake::Pipeline::DSL::PipelineDSL.send(:include, Rake::Pipeline::Typescript::PipelineHelpers)

data/lib/rake-pipeline-typescript/type_script_filter.rb

@@ -0,0 +1,56 @@
+require "execjs"
+
+module Rake::Pipeline::Typescript
+  # A filter that compiles TypeScript to JavaScript.
+  class TypeScriptFilter < Rake::Pipeline::Filter
+    include Rake::Pipeline::Typescript::FilterWithDependencies
+
+    # @return [Hash] a hash of options to pass to CoffeeScript when
+    #   rendering.
+    attr_reader :options
+
+    # By default, the CoffeeScriptFilter converts inputs
+    # with the extension +.coffee+ to +.js+.
+    #
+    # @param [Hash] options options to pass to the CoffeeScript
+    #   compiler.
+    # @param [Proc] block the output name generator block
+    def initialize(options = {}, &block)
+      block ||= proc { |input| input.sub(/\.ts$/, '.js') }
+      super(&block)
+      @options = options
+    end
+
+    # The body of the filter. Compile each input file into
+    # a CoffeeScript compiled output file.
+    #
+    # @param [Array] inputs an Array of FileWrapper objects.
+    # @param [FileWrapper] output a FileWrapper object
+    def generate_output(inputs, output)
+      inputs.each do |input|
+        begin
+          if (input.respond_to?(:read))
+            script = input.read
+          else
+            script = input
+          end
+          #script = input.read if input.respond_to?(:read)
+
+          result = TypeScript::Node::compile(script)
+          output.write(result)
+          # if result.success?
+          #     output.write(result.js)
+          # else
+          #   raise result.stderr
+          #end
+        rescue ExecJS::Error => error
+          raise error, "Error compiling #{input.path}. #{error.message}"
+        end
+      end
+    end
+
+    def external_dependencies
+      [ "typescript-node" ]
+    end
+  end
+end

data/lib/rake-pipeline-typescript/version.rb

@@ -0,0 +1,7 @@
+module Rake
+  class Pipeline
+    module Typescript
+	  VERSION = "0.1.0"
+    end
+  end
+end

data/rake-pipeline-typescript.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rake-pipeline-typescript/version.rb', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Taylor Brown"]
+  gem.email         = ["taylor@youneedabudget.com"]
+  gem.description   = %q{A typescript web filter for rake-pipeline}
+  gem.summary       = %q{Contains a Typescript to Javascript filter for use in rake-pipeline}
+  gem.homepage      = "http://github.com/taytay/rake-pipeline-typescript"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "rake-pipeline-typescript"
+  gem.require_paths = ["lib"]
+  gem.version       = Rake::Pipeline::Typescript::VERSION
+  gem.license       = "MIT License"
+
+  gem.add_dependency "rake-pipeline", "~> 0.6"
+  gem.add_dependency "rack"
+  gem.add_dependency "typescript-node"
+  gem.add_dependency "typescript-src", "~> 0.9.0"
+  gem.add_dependency "execjs"
+
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "therubyracer"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,28 @@
+require "rake-pipeline"
+require "rake-pipeline-typescript"
+
+require "support/spec_helpers/file_utils"
+require "support/spec_helpers/filters"
+require "support/spec_helpers/input_helpers"
+require "support/spec_helpers/memory_file_wrapper"
+require "support/spec_helpers/memory_manifest"
+
+RSpec.configure do |config|
+  original = Dir.pwd
+
+  config.include Rake::Pipeline::SpecHelpers::FileUtils
+
+  def tmp
+    File.expand_path("../tmp", __FILE__)
+  end
+
+  config.before do
+    rm_rf(tmp)
+    mkdir_p(tmp)
+    Dir.chdir(tmp)
+  end
+
+  config.after do
+    Dir.chdir(original)
+  end
+end

data/spec/support/spec_helpers/file_utils.rb

@@ -0,0 +1,33 @@
+class Rake::Pipeline
+  module SpecHelpers
+
+    # TODO: OS agnostic modules
+    module FileUtils
+      def mkdir_p(dir)
+        system "mkdir", "-p", dir
+      end
+
+      def touch(file)
+        system "touch", file
+      end
+
+      def rm_rf(dir)
+        system "rm", "-rf", dir
+      end
+
+      def touch_p(file)
+        dir = File.dirname(file)
+        mkdir_p dir
+        touch file
+      end
+
+      def age_existing_files
+        old_time = Time.now - 10
+        Dir[File.join(tmp, "**/*.js")].each do |file|
+          File.utime(old_time, old_time, file)
+        end
+      end
+    end
+
+  end
+end

data/spec/support/spec_helpers/filters.rb

@@ -0,0 +1,37 @@
+class Rake::Pipeline
+  module SpecHelpers
+
+    module Filters
+      ConcatFilter = Rake::Pipeline::ConcatFilter
+
+      class StripAssertsFilter < Rake::Pipeline::Filter
+        def generate_output(inputs, output)
+          inputs.each do |input|
+            output.write input.read.gsub(%r{^\s*assert\(.*\)\s*;?\s*$}m, '')
+          end
+        end
+      end
+
+      class DynamicImportFilter < Rake::Pipeline::Filter
+        def additional_dependencies(input)
+          includes(input)
+        end
+
+        def includes(input)
+          input.read.scan(/^@import\(\"(.*)\"\)$/).map(&:first).map do |inc|
+            File.join(input.root, "#{inc}.import")
+          end
+        end
+
+        def generate_output(inputs, output)
+          inputs.each do |input|
+            output.write input.read
+            includes(input).each do |inc|
+              output.write File.read(inc)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/spec_helpers/input_helpers.rb

@@ -0,0 +1,23 @@
+class Rake::Pipeline
+  module SpecHelpers
+    module InputHelpers
+      def input_file(path, root=File.join(tmp, "app/assets"))
+        Rake::Pipeline::FileWrapper.new root, path
+      end
+
+      def output_file(path, root=File.join(tmp, "public"))
+        input_file(path, root)
+      end
+
+      def create_files(files)
+        Array(files).each do |file|
+          mkdir_p File.dirname(file.fullpath)
+
+          File.open(file.fullpath, "w") do |file|
+            file.write "// This is #{file.path}\n"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/support/spec_helpers/memory_file_wrapper.rb

@@ -0,0 +1,38 @@
+class Rake::Pipeline
+  module SpecHelpers
+    class MemoryFileWrapper < Struct.new(:root, :path, :encoding, :body)
+      @@files = {}
+      @@data = {}
+
+      def self.files
+        @@files
+      end
+
+      def self.data
+        @@data
+      end
+
+      def with_encoding(new_encoding)
+        self.class.new(root, path, new_encoding, body)
+      end
+
+      def fullpath
+        File.join(root, path)
+      end
+
+      def create
+        @@files[fullpath] = self
+        self.body = ""
+        yield
+      end
+
+      def read
+        body || @@data[fullpath] || ""
+      end
+
+      def write(contents)
+        self.body << contents
+      end
+    end
+  end
+end

data/spec/support/spec_helpers/memory_manifest.rb

@@ -0,0 +1,19 @@
+class Rake::Pipeline
+  module SpecHelpers
+    class MemoryManifest
+      def initialize
+        @entries = {}
+      end
+
+      # Look up an entry by filename.
+      def [](key)
+        @entries[key]
+      end
+
+      # Set an entry
+      def []=(key, value)
+        @entries[key] = value
+      end
+    end
+  end
+end

data/spec/type_script_filter_spec.rb

@@ -0,0 +1,118 @@
+describe "TypeScriptFilter" do
+  TypeScriptFilter ||= Rake::Pipeline::Typescript::TypeScriptFilter
+  MemoryFileWrapper ||= Rake::Pipeline::SpecHelpers::MemoryFileWrapper
+  MemoryManifest ||= Rake::Pipeline::SpecHelpers::MemoryManifest
+
+  let(:typescript_input) { <<-TYPESCRIPT }
+class Student {
+    fullname : string;
+    middleInitial : string;
+    constructor(public firstname, public middleinitial, public lastname) {
+        this.middleInitial = middleinitial;
+        this.fullname = firstname + " " + this.middleInitial + " " + lastname;
+    }
+}
+
+interface Person {
+    firstname: string;
+    lastname: string;
+}
+
+function greeter(person : Person) {
+    return "Hello, " + person.firstname + " " + person.lastname;
+}
+
+var user = new Student("Jane", "M.", "User");
+
+alert(greeter(user));
+
+  TYPESCRIPT
+
+  let(:expected_typescript_output) { <<-HTML }
+var Student = (function () {
+    function Student(firstname, middleinitial, lastname) {
+        this.firstname = firstname;
+        this.middleinitial = middleinitial;
+        this.lastname = lastname;
+        this.middleInitial = middleinitial;
+        this.fullname = firstname + " " + this.middleInitial + " " + lastname;
+    }
+    return Student;
+})();
+
+function greeter(person) {
+    return "Hello, " + person.firstname + " " + person.lastname;
+}
+
+var user = new Student("Jane", "M.", "User");
+
+alert(greeter(user));
+
+  HTML
+
+  def input_file(name, content)
+    MemoryFileWrapper.new("/path/to/input", name, "UTF-8", content)
+  end
+
+  def output_file(name)
+    MemoryFileWrapper.new("/path/to/output", name, "UTF-8")
+  end
+
+  def should_match(expected, output)
+    "#{expected}\n".gsub(/\n+/, "\n").should == "#{output}\n".gsub(/\n+/, "\n")
+  end
+
+  def setup_filter(filter)
+    filter.file_wrapper_class = MemoryFileWrapper
+    filter.manifest = MemoryManifest.new
+    filter.last_manifest = MemoryManifest.new
+    filter.input_files = [input_file("input.ts", typescript_input)]
+    filter.output_root = "/path/to/output"
+    filter.rake_application = Rake::Application.new
+    filter
+  end
+
+  it "generates output" do
+    filter = setup_filter TypeScriptFilter.new
+
+    filter.output_files.should == [output_file("input.js")]
+
+    tasks = filter.generate_rake_tasks
+    tasks.each(&:invoke)
+
+    file = MemoryFileWrapper.files["/path/to/output/input.js"]
+    normalized_output = file.body.gsub(/\r\n?/, "\n")
+    should_match normalized_output, expected_typescript_output
+    file.encoding.should == "UTF-8"
+  end
+
+  describe "naming output files" do
+    it "translates .ts extensions to .js by default" do
+      filter = setup_filter TypeScriptFilter.new
+      filter.output_files.first.path.should == "input.js"
+    end
+
+    it "accepts a block to customize output file names" do
+      filter = setup_filter(TypeScriptFilter.new { |input| "octopus" })
+      filter.output_files.first.path.should == "octopus"
+    end
+  end
+
+  describe "invalid input" do
+    let(:typescript_input) { <<-TYPESCRIPT }
+var y = function(param : badtype){
+  return "This won't compile"
+}
+    TYPESCRIPT
+
+    it "has a useful error message including the input file name" do
+      filter = setup_filter TypeScriptFilter.new
+      tasks = filter.generate_rake_tasks
+      lambda {
+        tasks.each(&:invoke)
+      }.should raise_error(RuntimeError, /ts\(1,26\): error TS2095: Could not find symbol 'badtype'/i)
+    end
+  end
+
+end
+

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: rake-pipeline-typescript
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Taylor Brown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake-pipeline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typescript-node
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: typescript-src
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: therubyracer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A typescript web filter for rake-pipeline
+email:
+- taylor@youneedabudget.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- LICENSE
+- README.markdown
+- README.yard
+- Rakefile
+- lib/rake-pipeline-typescript.rb
+- lib/rake-pipeline-typescript/filter_with_dependencies.rb
+- lib/rake-pipeline-typescript/helpers.rb
+- lib/rake-pipeline-typescript/type_script_filter.rb
+- lib/rake-pipeline-typescript/version.rb
+- rake-pipeline-typescript.gemspec
+- spec/spec_helper.rb
+- spec/support/spec_helpers/file_utils.rb
+- spec/support/spec_helpers/filters.rb
+- spec/support/spec_helpers/input_helpers.rb
+- spec/support/spec_helpers/memory_file_wrapper.rb
+- spec/support/spec_helpers/memory_manifest.rb
+- spec/type_script_filter_spec.rb
+homepage: http://github.com/taytay/rake-pipeline-typescript
+licenses:
+- MIT License
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Contains a Typescript to Javascript filter for use in rake-pipeline
+test_files:
+- spec/spec_helper.rb
+- spec/support/spec_helpers/file_utils.rb
+- spec/support/spec_helpers/filters.rb
+- spec/support/spec_helpers/input_helpers.rb
+- spec/support/spec_helpers/memory_file_wrapper.rb
+- spec/support/spec_helpers/memory_manifest.rb
+- spec/type_script_filter_spec.rb