typescript-monkey 0.9.0

data/lib/typescript/monkey/configuration.rb

@@ -0,0 +1,49 @@
+require 'typescript/monkey/package'
+
+module Typescript::Monkey
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure(&block)
+    self.configuration ||= Configuration.new
+    block.call(configuration) if block_given?
+  end
+
+  class Configuration
+
+    attr_accessor :options
+    attr_accessor :logger
+
+    def initialize
+      @_default_options = [
+        "--target es5",
+        "--outFile /dev/stdout",
+        "--noResolve",
+        "--removeComments",
+        "--typeRoots ['#{File.expand_path("../lib", Typescript::Monkey::Package.metadata_path())}']"
+      ]
+      @options = @_default_options.to_set
+      @compile = false;
+      @logger = nil;
+    end
+
+    def default_options
+      @_default_options.to_enum
+    end
+
+    def compile=(value)
+      unless (!!value == value)
+        raise TypeError, "#{method(__method__).owner}.#{__method__}: value parameter must be type Bool"
+      end
+
+      if value == true
+        @options.delete("--noResolve")
+        @compile = true
+      else
+        @options.add("--noResolve")
+        @compile = false
+      end
+    end
+  end
+end

data/lib/typescript/monkey/engine.rb

@@ -0,0 +1,18 @@
+require 'rails/engine'
+require 'rails/generators'
+require 'typescript/monkey/js_hook'
+
+class Typescript::Monkey::Engine < Rails::Engine
+  # To become the default generator...
+  # config.app_generators.javascript_engine :typescript
+
+  if config.respond_to?(:annotations)
+    config.annotations.register_extensions(".ts") { |annotation| /#\s*(#{annotation}):?\s*(.*)$/ }
+  end
+
+  initializer 'override js_template hook' do |app|
+    if app.config.generators.rails[:javascript_engine] == :typescript
+      ::Rails::Generators::NamedBase.send :include, Typescript::Monkey::JsHook
+    end
+  end
+end

data/lib/typescript/monkey/js_hook.rb

@@ -0,0 +1,15 @@
+module Typescript
+  module Monkey
+    module JsHook
+      extend ActiveSupport::Concern
+
+      included do
+        no_tasks do
+          redefine_method :js_template do |source, destination|
+            template(source + '.ts', destination + '.ts')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/typescript/monkey/package.rb

@@ -0,0 +1,239 @@
+module Typescript::Monkey
+  require 'pathname'
+  require_relative 'cli'
+
+  #
+  # The Package class.
+  #
+  # A class that implements an interface to the Typescript node installation.
+  #
+  class Package
+    # Returns path to Typescript compiler executable
+    #
+    # The executable compiler can be used to transform Typescript to Javascript
+    # and is used during the asset pipeline compilation stage.
+    #
+    # @return [Pathname] path to Typescript compiler executable
+    #
+    def self.compiler_bin_path
+      compiler_bin_path = npm_bin_path()
+
+      if compiler_bin_path
+        compiler_bin_path = compiler_bin_path.join("tsc")
+        unless (compiler_bin_path && compiler_bin_path.file? && compiler_bin_path.executable?)
+          compiler_bin_path = nil
+        end
+      end
+
+      compiler_bin_path
+    end
+
+    # @TODO: REMOVE compiler_js_path()
+    # Returns path to Typescript compiler source
+    #
+    # The compiler can be included with web content to transform embedded
+    # Typescript wrapped in <script type="text/typescript"></script> tags.
+    #
+    # @return [Pathname] path to Typescript javascript compiler source
+    #
+    def self.compiler_js_path
+      compiler_js_path = npm_root_path()
+
+      if compiler_js_path
+        compiler_js_path = compiler_js_path.join("typescript/lib/typescriptServices.js")
+        unless compiler_js_path.file? && compiler_js_path.readable?
+          compiler_js_path = nil
+        end
+      end
+
+      compiler_js_path
+    end
+
+    # @TODO: REMOVE compiler_js()
+    # Returns content for Typescript compiler source
+    #
+    # The compiler can be included with web content to transform embedded
+    # Typescript wrapped in <script type="text/typescript"></script> tags.
+    #
+    # @return [String] javascript Typescript compiler source
+    #
+    def self.compiler_js
+      compiler_js = ""
+      compiler_js_path = self.compiler_js_path()
+
+      unless compiler_js_path.nil?
+        compiler_js = compiler_js_path.read()
+      end
+
+      compiler_js
+    end
+
+    # Returns package version for Typescript installation
+    #
+    # @return [String] version information
+    #
+    def self.compiler_version
+      compiler_version = "unknown"
+      metadata = self.metadata()
+
+      unless metadata.empty? || !metadata.has_key?('version')
+        compiler_version = metadata['version']
+      end
+
+      compiler_version
+    end
+
+    # Returns path to package metadata file for Typescript installation
+    #
+    # The package metadata file is the package.json file.
+    #
+    # @return [Pathname] path to Typepackage information file
+    #
+    def self.metadata_path
+      metadata_path = npm_root_path()
+
+      if metadata_path
+        metadata_path = metadata_path.join("typescript/package.json")
+        unless metadata_path.file? && metadata_path.readable?
+          metadata_path = nil
+        end
+      end
+
+      metadata_path
+    end
+
+
+    # Returns package metadata contents for Typescript installation
+    #
+    # @return [Hash] hash representation of package metadata contents
+    #
+    def self.metadata
+      metadata = {}
+      metadata_path = self.metadata_path()
+
+      unless metadata_path.nil?
+        metadata = JSON.parse(metadata_path.read())
+        metadata ||= {}
+      end
+
+      metadata
+    end
+
+    # Returns path to Typescript services javascript source
+    #
+    # The Typescript services can be included with web content to provide
+    # embedded Typescript functionality. This Typescript::Monkey::Transpiler
+    # leverages services to transpile <script type="text/typescript"> tags
+    # at runtime.
+    #
+    # @return [Pathname] path to Typescript service javascript source
+    #
+    def self.services_js_path
+      services_js_path = npm_root_path()
+
+      if services_js_path
+        services_js_path = services_js_path.join("typescript/lib/typescriptServices.js")
+        unless services_js_path.file? && services_js_path.readable?
+          services_js_path = nil
+        end
+      end
+
+      services_js_path
+    end
+
+    # Returns content for Typescript services javascript source
+    #
+    # The Typescript services can be included with web content to provide
+    # embedded Typescript functionality. This Typescript::Monkey::Transpiler
+    # leverages services to transpile <script type="text/typescript"> tags
+    # at runtime.
+    #
+    # @return [String] Typescript services javascript source
+    #
+    def self.services_js
+      services_js = ""
+      services_js_path = self.services_js_path()
+
+      unless services_js_path.nil?
+        services_js = services_js_path.read()
+      end
+
+      services_js
+    end
+
+    class << self
+      # Returns path to Typescript compiler executable
+      #
+      alias compiler_bin compiler_bin_path
+
+      private
+
+        # Returns closest path for npm directory
+        #
+        # The directory is the npm directory to resolve. Must be a value of:
+        #   + root      - effective node_modules root directory
+        #   + bin       - effective node_modules bin directory
+        #
+        # The resolution process favors a local node_modules directory over a
+        # global installation.
+        #
+        # @param directory [String] directory to discover
+        #
+        # @return [Pathname] path to directory on success, otherwise nil
+        #
+        # @raise [ArgumentError] raises this exception if directory has not been
+        #   supplied or is invalid.
+        #
+        def npm_path_for(directory)
+          if directory.empty? || directory.nil?
+            raise ArgumentError, "directory parameter required but not supplied"
+          end
+          if !["bin", "root"].include?(directory)
+            raise ArgumentError, "invalid directory specified: #{directory}"
+          end
+
+          npm_path, stderr, status = Typescript::Monkey::CLI.run_command("npm", [directory])
+          unless status.success? && File.directory?(npm_path.chomp!)
+            # try again with global resolution
+            npm_path, stderr, status = Typescript::Monkey::CLI.run_command("npm", ["--global", directory])
+            unless status.success? && File.directory?(npm_path.chomp!)
+              npm_path = ""
+            end
+          end
+
+          ((npm_path_obj = Pathname.new(npm_path)).to_s.empty?) ? nil : npm_path_obj
+        end
+
+        # Returns closest path for npm root directory
+        #
+        # The resolution process favors a local node_modules directory over a
+        # global installation.
+        #
+        # Results are memoized.
+        #
+        # @return [Pathname] path to directory on success, otherwise nil
+        #
+        # @see Typescript::Monkey::Package.npm_path_for
+        #
+        def npm_root_path
+          @npm_root_path ||= npm_path_for("root")
+        end
+
+        # Returns closest path for npm bin directory
+        #
+        # The resolution process favors a local node_modules directory over a
+        # global installation.
+        #
+        # Results are memoized.
+        #
+        # @return [Pathname] path to directory on success, otherwise nil
+        #
+        # @see Typescript::Monkey::Packags.npm_path_for
+        #
+        def npm_bin_path
+          @npm_bin_path ||= npm_path_for("bin")
+        end
+    end
+
+  end
+end

data/lib/typescript/monkey/railtie.rb

@@ -0,0 +1,20 @@
+require 'typescript/monkey'
+
+class Typescript::Monkey::Railtie < ::Rails::Railtie
+  config.before_initialize do |app|
+    if ::Rails::VERSION::MAJOR >= 4 || app.config.assets.enabled
+      require 'typescript/monkey/template'
+      require 'typescript/monkey/transformer'
+      require 'sprockets'
+
+      if Sprockets.respond_to?(:register_engine)
+        Sprockets.register_engine '.ts', Typescript::Monkey::Template, silence_deprecation: true
+      end
+
+      if Sprockets.respond_to?(:register_transformer)
+        Sprockets.register_mime_type 'text/typescript', extensions: ['.ts']
+        Sprockets.register_transformer 'text/typescript', 'application/javascript', Typescript::Monkey::Transformer
+      end
+    end
+  end
+end

data/lib/typescript/monkey/template.rb

@@ -0,0 +1,32 @@
+require 'typescript/monkey'
+require 'tilt/template'
+
+class Typescript::Monkey::Template < ::Tilt::Template
+  self.default_mime_type = 'application/javascript'
+
+  # @!scope class
+  class_attribute :default_bare
+
+  def self.engine_initialized?
+    defined? ::Typescript::Monkey::Compiler
+  end
+
+  def initialize_engine
+    require_template_library 'typescript/monkey/compiler'
+  end
+
+  def prepare
+    if !options.key?(:bare) and !options.key?(:no_wrap)
+      options[:bare] = self.class.default_bare
+    end
+  end
+
+  def evaluate(context, locals, &block)
+    @output ||= ::Typescript::Monkey::Compiler.compile(file, data, context)
+  end
+
+  # @override
+  def allows_script?
+    false
+  end
+end

data/lib/typescript/monkey/template_handler.rb

@@ -0,0 +1,24 @@
+require 'typescript/monkey/compiler'
+
+class Typescript::Monkey::TemplateHandler
+  class << self
+    def erb_handler
+      @erb_handler ||= ActionView::Template.registered_template_handler(:erb)
+    end
+
+    def call(template)
+      compiled_source = erb_handler.call(template)
+      path = template.identifier.gsub(/['\\]/, '\\\\\&') # "'" => "\\'", '\\' => '\\\\'
+      <<-EOS
+        ::Typescript::Monkey::Compiler.compile('#{path}', (begin;#{compiled_source};end))
+      EOS
+    end
+  end
+end
+
+# Register template handler for .ts files, enable digest for .ts files
+ActiveSupport.on_load(:action_view) do
+  ActionView::Template.register_template_handler :ts, Typescript::Monkey::TemplateHandler
+  require 'action_view/dependency_tracker'
+  ActionView::DependencyTracker.register_tracker :ts, ActionView::DependencyTracker::ERBTracker
+end

data/lib/typescript/monkey/transformer.rb

@@ -0,0 +1,20 @@
+require 'typescript/monkey'
+
+class Typescript::Monkey::Transformer
+  def self.instance
+    @instance ||= new
+  end
+
+  def self.call(input)
+    instance.call(input)
+  end
+
+  def call(input)
+    filename = input[:filename]
+    source   = input[:data]
+    context  = input[:environment].context_class.new(input)
+
+    result = ::Typescript::Monkey::Compiler.compile(filename, source, context)
+    { data: result }
+  end
+end

data/lib/typescript/monkey/transpiler.rb

@@ -0,0 +1,256 @@
+module Typescript::Monkey
+  require 'pathname'
+
+  #
+  # The Transpiler class.
+  #
+  # A class that implements an interface to a dynamic runtime Typescript to
+  # javascript transpiler.
+  #
+  # The scripts that are returned by this class are dependent upon Typescript
+  # Services to be available.
+  #
+  # @see Typescript::Monkey::Package.services_js
+  #
+  class Transpiler
+
+    # Returns path to dynamic runtime transpiler
+    #
+    # The transpiler can be included with web content to transform embedded
+    # Typescript wrapped in <script type="text/typescript"></script> tags.
+    #
+    # @return [Pathname] path to dyrt source
+    #
+    def self.dyrt_js_path
+      transpiler_js_path = gem_javascripts_path()
+
+      if transpiler_js_path
+        transpiler_js_path = transpiler_js_path.join("dyrt.js")
+        unless transpiler_js_path.file? && transpiler_js_path.readable?
+          transpiler_js_path = nil
+        end
+      end
+
+      transpiler_js_path
+    end
+
+    # Returns content for dynamic runtime transpiler
+    #
+    # The transpiler can be included with web content to transform embedded
+    # Typescript wrapped in <script type="text/typescript"></script> tags.
+    #
+    # @return [String] dyrt source
+    #
+    def self.dyrt_js
+      transpiler_js = ""
+      transpiler_js_path = self.dyrt_js_path()
+
+      unless transpiler_js_path.nil?
+        transpiler_js = transpiler_js_path.read()
+      end
+
+      transpiler_js
+    end
+
+    # Returns path to dynamic runtime transpiler
+    #
+    # The transpiler can be included with web content to transform embedded
+    # Typescript wrapped in <script type="text/typescript"></script> tags.
+    #
+    # The "once" compilers include an immediately invoked function expression
+    # (IIFE) that triggers transpile exactly once. Add this script to the
+    # bottom of the body in an HTML page; ideally, this should run last. The
+    # script does not, and probably should not, be run after DOM ready; however
+    # the Typescript objects in your page can wait for DOM ready.
+    #
+    # @return [Pathname] path to dyrt source
+    #
+    def self.dyrt_once_js_path
+      transpiler_js_path = gem_javascripts_path()
+
+      if transpiler_js_path
+        transpiler_js_path = transpiler_js_path.join("dyrt_once.js")
+        unless transpiler_js_path.file? && transpiler_js_path.readable?
+          transpiler_js_path = nil
+        end
+      end
+
+      transpiler_js_path
+    end
+
+    # Returns content for dynamic runtime transpiler
+    #
+    # The transpiler can be included with web content to transform embedded
+    # Typescript wrapped in <script type="text/typescript"></script> tags.
+    #
+    # The "once" compilers include an immediately invoked function expression
+    # (IIFE) that triggers transpile exactly once. Add this script to the
+    # bottom of the body in an HTML page; ideally, this should run last. The
+    # script does not, and probably should not, be run after DOM ready; however
+    # the Typescript objects in your page can wait for DOM ready.
+    #
+    # @return [String] dyrt source
+    #
+    def self.dyrt_once_js
+      transpiler_js = ""
+      transpiler_js_path = self.dyrt_once_js_path()
+
+      unless transpiler_js_path.nil?
+        transpiler_js = transpiler_js_path.read()
+      end
+
+      transpiler_js
+    end
+
+    # Returns path to dynamic runtime transpiler (pre-transpiled version)
+    #
+    # The transpiler can be included with web content to transform embedded
+    # Typescript wrapped in <script type="text/typescript"></script> tags.
+    #
+    # @return [Pathname] path to dyrt source (pre-transpiled version)
+    #
+    def self.dyrt_ts_path
+      transpiler_ts_path = gem_typescripts_path()
+
+      if transpiler_ts_path
+        transpiler_ts_path = transpiler_ts_path.join("transpiler.ts")
+        unless transpiler_ts_path.file? && transpiler_ts_path.readable?
+          transpiler_ts_path = nil
+        end
+      end
+
+      transpiler_ts_path
+    end
+
+    # Returns content for dynamic runtime transpiler (pre-transpiled version)
+    #
+    # The transpiler can be included with web content to transform embedded
+    # Typescript wrapped in <script type="text/typescript"></script> tags.
+    #
+    # @return [String] typescript transpiler source (pre-transpiled version)
+    #
+    def self.dyrt_ts
+      transpiler_ts = ""
+      transpiler_ts_path = self.dyrt_ts_path()
+
+      unless transpiler_ts_path.nil?
+        transpiler_ts = transpiler_ts_path.read()
+      end
+
+      transpiler_ts
+    end
+
+    class << self
+
+      # Returns path to transpiler source
+      #
+      alias runner_js dyrt_js
+      alias runner_ts dyrt_ts
+
+      # private
+
+        # Returns path for gem directory
+        #
+        # The directory is the gem directory to resolve. Must be a value of:
+        #   + root          - gem root directory
+        #   + lib           - gem lib directory
+        #   + assets        - gem lib/assets directory
+        #   + javascripts   - gem lib/assets/javascripts directory
+        #   + typescripts   - gem lib/assets/typescripts directory
+        #
+        # Results are memoized.
+        #
+        # @param directory [String] directory to discover
+        #
+        # @return [Pathname] path to directory on success, otherwise nil
+        #
+        # @raise [ArgumentError] raises this exception if directory has not been
+        #   supplied or is invalid.
+        #
+        def gem_path_for(directory)
+          if directory.empty? || directory.nil?
+            raise ArgumentError, "directory parameter required but not supplied"
+          end
+          if !["root", "lib", "assets", "javascripts", "typescripts"].include?(directory)
+            raise ArgumentError, "invalid directory specified: #{directory}"
+          end
+
+          directory_sym = directory.downcase.to_sym
+          @gem_paths ||= {}
+          return @gem_paths[directory_sym] if @gem_paths.has_key?(directory_sym)
+
+          # resolve gem root (top directory of this gem)
+          gem_root = Pathname.new(File.expand_path("../../../../", __FILE__))
+
+          # process shortcuts
+          case directory_sym
+          when :lib
+            gem_path = gem_root.join("lib")
+          when :assets
+            gem_path = gem_root.join("lib/assets")
+          when :javascripts
+            gem_path = gem_root.join("lib/assets/javascripts")
+          when :typescripts
+            gem_path = gem_root.join("lib/assets/typescripts")
+          when :root
+            gem_path = gem_root
+          else
+            gem_path = Pathname.new("")
+          end
+
+          @gem_paths[directory_sym] = ((gem_path.directory?) ? gem_path : nil)
+        end
+
+        # Returns top directory for this gem
+        #
+        # @return [Pathname] path to directory on success, otherwise nil
+        #
+        # @see Typescript::Monkey::Transpiler.gem_path_for
+        #
+        def gem_root_path
+          gem_path_for("root")
+        end
+
+        # Returns lib directory for this gem
+        #
+        # @return [Pathname] path to directory on success, otherwise nil
+        #
+        # @see Typescript::Monkey::Transpiler.gem_path_for
+        #
+        def gem_lib_path
+          gem_path_for("lib")
+        end
+
+        # Returns assets directory for this gem
+        #
+        # @return [Pathname] path to directory on success, otherwise nil
+        #
+        # @see Typescript::Monkey::Transpiler.gem_path_for
+        #
+        def gem_assets_path
+          gem_path_for("assets")
+        end
+
+        # Returns javascripts directory for this gem
+        #
+        # @return [Pathname] path to directory on success, otherwise nil
+        #
+        # @see Typescript::Monkey::Transpiler.gem_path_for
+        #
+        def gem_javascripts_path
+          gem_path_for("javascripts")
+        end
+
+        # Returns typescripts directory for this gem
+        #
+        # @return [Pathname] path to directory on success, otherwise nil
+        #
+        # @see Typescript::Monkey::Transpiler.gem_path_for
+        #
+        def gem_typescripts_path
+          gem_path_for("typescripts")
+        end
+    end
+
+  end
+end