tscheck 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c65c1c519d31eaa7e9e282fd15a1c254b50c319c1b809eed23cb7e34f50f3cc0
+  data.tar.gz: 2981cc4576df0e093575d09c7b0e0933cc553efa31bf2f2d8673df33f27e68fb
+SHA512:
+  metadata.gz: 1fe2236102b3d723c02499a4318fc316214fa1bc3ca726cf35e2e8b285e1dc8a1b8a675807a2111c019016ce99e21a49bf1a1403d63d9f73913a849e1fe3f483
+  data.tar.gz: fc4dda95fc66695290d03c203702424044c2b3d4be262beb727680a1d4fdced9a4227134210e68e3df1d4aa53d77a79db032a4a7b458dae4fa2907faf464a64b

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+example/Gemfile.lock
+example/.bundle
+*.log

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+## 0.0.1 - initial experimental release

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tscheck.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Leonid Shevtsov
+
+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.md

@@ -0,0 +1,11 @@
+# TSCheck - validate Ruby hashes against TypeScript types
+
+If you are making a Ruby API that is consumed by a TypeScript client, and you would like to ensure that the objects you return match the types you expect in TypeScript, this gem is for you.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/leonid-shevtsov/tscheck.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/tscheck.rb

@@ -0,0 +1,5 @@
+require "tscheck/version"
+
+module TScheck
+  class Error < StandardError; end
+end

data/lib/tscheck/rspec.rb

@@ -0,0 +1,27 @@
+require 'tscheck/tsserver'
+require 'tscheck/rspec/matchers'
+
+module TSCheck
+  module RSpec
+
+    def self.setup(options = {})
+      @server = TSServer.new(options)
+
+      ::RSpec.configure do |config|
+        config.before(:suite) do
+          TSCheck::RSpec.server.start_server
+        end
+
+        config.after(:suite) do
+          TSCheck::RSpec.server.stop_server
+        end
+
+        config.include TSCheck::RSpec::Matchers
+      end
+    end
+
+    def self.server
+      @server
+    end
+  end
+end

data/lib/tscheck/rspec/matchers.rb

@@ -0,0 +1,12 @@
+require 'tscheck/rspec/matchers/ts_type_matcher'
+
+module TSCheck
+  module RSpec
+    module Matchers
+
+      def match_ts_type(type, options = {})
+        TSCheck::RSpec::Matchers::TSTypeMatcher.new(type, options)
+      end
+    end
+  end
+end

data/lib/tscheck/rspec/matchers/ts_type_matcher.rb

@@ -0,0 +1,30 @@
+module TSCheck
+  module RSpec
+    module Matchers
+      class TSTypeMatcher
+        def initialize(type, options)
+          @type = type
+          @options = options
+        end
+
+        def description
+          "match TypeScript type #{@type}"
+        end
+
+        def matches?(actual)
+          @actual_string = actual.is_a?(String) ? actual : actual.to_json
+          @ts_error = TSCheck::RSpec.server.check_type(@actual_string, type: @type, **@options)
+          @ts_error.nil?
+        end
+
+        def failure_message
+          "expected #{@actual_string} to be of TypeScript type #{@type}, but type check failed with error:\n#{@ts_error}"
+        end
+
+        def failure_message_when_negated
+          "expected #{@actual_string} not to be of TypeScript type #{@type}, but type check succeeded"
+        end
+      end
+    end
+  end
+end

data/lib/tscheck/tsserver.rb

@@ -0,0 +1,101 @@
+require 'json'
+
+module TSCheck
+  class TSServer
+
+    def initialize(options = {})
+      @ts_base_path = options.fetch(:ts_base_path) { Dir.pwd }
+      @ts_types_file_path = options.key?(:ts_types_file_path) ? File.join(@ts_base_path, options[:ts_types_file_path]) : nil
+      @tsconfig_path = options[:tsconfig_path] && File.join(@ts_base_path, options[:tsconfig_path])
+      @dummy_file_path = "#{@ts_base_path}/__typescript_schema_validator.ts"
+    end
+
+    def start_server
+      @tsserver_out, cwrite = IO.pipe
+      cread, @tsserver_in = IO.pipe
+
+      @tsserver_pid = Process.spawn(
+        # { 'TSS_LOG' => '-level verbose -logToFile true -file tsserver.log' },
+        'tsserver',
+        in: cread,
+        out: cwrite,
+        err: File::NULL
+      )
+      cwrite.close
+      cread.close
+
+      @seq = 0
+    end
+
+    def stop_server
+      Process.kill('TERM', @tsserver_pid)
+    end
+
+    def check_type(json_string, type:, path: nil, default: false)
+      import_statement =
+        if path
+          import_reference = default ? type : "{ #{type} }"
+          fullpath = File.join(@ts_base_path, path)
+          "import #{import_reference} from '#{fullpath}';"
+        elsif @ts_types_file_path
+          "import { #{type} } from '#{@ts_types_file_path}';"
+        else
+          ''
+        end
+
+      test_file_content = <<~TS
+        #{import_statement}
+
+        const actual: #{type} = #{json_string};
+      TS
+
+      open_arguments = { file: @dummy_file_path, fileContent: test_file_content }
+      open_arguments[:projectFileName] = @tsconfig_path if @tsconfig_path
+      send_command('open', open_arguments)
+      seq = send_command('semanticDiagnosticsSync', file: @dummy_file_path)
+      read_response(seq)
+    end
+
+    private
+
+    def send_command(command, arguments)
+      this_seq = @seq
+
+      payload = {
+        seq: this_seq,
+        type: 'request',
+        command: command,
+        arguments: arguments
+      }.to_json
+
+      @tsserver_in.write(payload)
+      @tsserver_in.write("\n")
+      @seq += 1 # increment for the next request
+
+      this_seq
+    end
+
+    def read_response(seq)
+      content_length_line = @tsserver_out.readline
+      unless content_length_line.start_with? 'Content-Length:'
+        raise TSCheck::Error, "tsserver: unexpected response, wanted content-length, got: #{content_length_line}"
+      end
+
+      @tsserver_out.readline
+      response_line = @tsserver_out.readline
+
+      response = JSON.parse(response_line, symbolize_names: true)
+
+      unless response[:request_seq] == seq
+        return read_response(seq) # discard and read next response
+      end
+
+      unless response[:success]
+        raise TSCheck::Error, "tsserver: error: #{response[:message]}"
+      end
+
+
+      response[:body].empty? ? nil : response[:body].map { |report| report[:text] }.join("\n")
+    end
+  end
+end

data/lib/tscheck/version.rb

@@ -0,0 +1,3 @@
+module TSCheck
+  VERSION = "0.0.1"
+end

data/tscheck.gemspec

@@ -0,0 +1,23 @@
+require_relative 'lib/tscheck/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tscheck'
+  spec.version       = TSCheck::VERSION
+  spec.authors       = ['Leonid Shevtsov']
+  spec.email         = ['leonid@shevtsov.me']
+
+  spec.summary     = 'Validate Ruby hashes against TypeScript types.'
+  spec.description = 'If you are making a Ruby API that is consumed by a TypeScript client, and you would like to ensure that the objects you return match the types you expect in TypeScript, this gem is for you.'
+  spec.homepage      = 'https://github.com/leonid-shevtsov/tscheck-rb'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/leonid-shevtsov/tscheck-rb'
+  spec.metadata['changelog_uri'] = 'https://github.com/leonid-shevtsov/tscheck-rb/blob/master/CHANGELOG.md'
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|example)/}) }
+  end
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: tscheck
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Leonid Shevtsov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-03-29 00:00:00.000000000 Z
+dependencies: []
+description: If you are making a Ruby API that is consumed by a TypeScript client,
+  and you would like to ensure that the objects you return match the types you expect
+  in TypeScript, this gem is for you.
+email:
+- leonid@shevtsov.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/tscheck.rb
+- lib/tscheck/rspec.rb
+- lib/tscheck/rspec/matchers.rb
+- lib/tscheck/rspec/matchers/ts_type_matcher.rb
+- lib/tscheck/tsserver.rb
+- lib/tscheck/version.rb
+- tscheck.gemspec
+homepage: https://github.com/leonid-shevtsov/tscheck-rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/leonid-shevtsov/tscheck-rb
+  source_code_uri: https://github.com/leonid-shevtsov/tscheck-rb
+  changelog_uri: https://github.com/leonid-shevtsov/tscheck-rb/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Validate Ruby hashes against TypeScript types.
+test_files: []