typed_struct 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c3375fc3fde1c42faa3d3ab97fd452cbe00bc869928d152a0ea67af139aab30d
+  data.tar.gz: b4981b8264cc69a678dca36c666ee10ee82371e451ba067e558334240621de6a
+SHA512:
+  metadata.gz: e823becbc89695f9e7cd9e6a2c494750b5507ffd6cf6d638089007e4f1294950b140d73f4494e7edc592f1116389f4800312c406913767c2b53076e718dddb56
+  data.tar.gz: 6fd49203aec3eee88359bc7bb94dcc2782387c47c11f3bd4f8c53b20bfec76778061c8632575f526396795098e13d0833cbc23987a28a9667c0b72fd8785438f

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in typed_struct.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    typed_struct (0.1.0)
+      rbs (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (13.0.3)
+    rbs (1.1.1)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  typed_struct!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Joseph Johansen
+
+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,39 @@
+# TypedStruct
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/typed_struct`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'typed_struct'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install typed_struct
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/typed_struct.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "typed_struct"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/typed_struct.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "typed_struct/version"
+require_relative "typed_struct/type_checking"
+require "rbs"
+
+class TypedStruct < Struct
+  include TypeChecking
+
+  class << self
+    def new(**properties)
+      super(*properties.keys, keyword_init: true).tap do |klass|
+        klass.class.instance_eval do
+          include TypeChecking
+          attr_reader :options
+        end
+
+        klass.instance_eval do
+          @options = { types: properties }
+          properties.each_key do |k|
+            define_method :"#{k}=" do |val|
+              prop = properties[k]
+              if val_is_type? val, prop
+                raise "Unexpected type #{val.class} for #{k.inspect} (expected #{prop})"
+              end
+              # it seems that structs behave in such a way that you can't call super here, but it
+              # will still set the value anyway
+            end
+          end
+        end
+      end
+    end
+  end
+
+  def initialize(**attrs)
+    opts = self.class.options
+    opts[:types].each do |prop, expected_type|
+      passed_value = attrs[prop]
+      next if val_is_type? passed_value, expected_type
+
+      raise "Unexpected type #{passed_value.class} for #{prop.inspect} (expected #{expected_type})"
+    end
+
+    super
+  end
+end
+
+def Rbs(type_str)
+  RBS::Parser.parse_type(type_str)
+end

data/lib/typed_struct/type_checking.rb

@@ -0,0 +1,152 @@
+class TypedStruct < Struct
+  module TypeChecking
+    private
+
+    def val_is_type?(val, expected_type)
+      return val_is_rbs_type? val, expected_type if expected_type.class.to_s.start_with? "RBS::Types"
+
+      expected_type === val
+    end
+
+    def get_class(type_name)
+      (@const_cache ||= {})[type_name] ||= begin
+          Object.const_get(type_name.to_s)
+        rescue NameError
+          nil
+        end
+    end
+
+    def each_sample(array, &block)
+      if block
+        if sample_size && array.size > sample_size
+          if sample_size > 0
+            size = array.size
+            sample_size.times do
+              yield array[rand(size)]
+            end
+          end
+        else
+          array.each(&block)
+        end
+      else
+        enum_for :each_sample, array
+      end
+    end
+
+    def val_is_rbs_type?(val, type)
+      case type
+      when RBS::Types::Bases::Any
+        true
+      when RBS::Types::Bases::Bool
+        val.is_a?(TrueClass) || val.is_a?(FalseClass)
+      when RBS::Types::Bases::Top
+        true
+      when RBS::Types::Bases::Bottom
+        false
+      when RBS::Types::Bases::Void
+        true
+      when RBS::Types::Bases::Self
+        val_is_type? val, self.class
+      when RBS::Types::Bases::Nil
+        val_is_type? val, NilClass
+      when RBS::Types::Bases::Class
+        val_is_type? val, Class
+      when RBS::Types::Bases::Instance
+        val_is_type? val, Object
+      when RBS::Types::ClassInstance
+        klass = get_class(type.name) or return false
+        case
+        when klass == ::Array
+          val_is_type?(val, klass) && each_sample(val).all? { |v| val_is_type?(v, type.args[0]) }
+        when klass == ::Hash
+          val_is_type?(val, klass) && each_sample(val.keys).all? do |key|
+            val_is_type?(key, type.args[0]) && val_is_type?(val[key], type.args[1])
+          end
+        when klass == ::Range
+          val_is_type?(val, klass) && val_is_type?(val.begin, type.args[0]) && val_is_type?(val.end, type.args[0])
+        when klass == ::Enumerator
+          if val_is_type? val, klass
+            case val.size
+            when Float::INFINITY
+              values = []
+              ret = self
+              val.lazy.take(10).each do |*args|
+                values << args
+                nil
+              end
+            else
+              values = []
+              ret = val.each do |*args|
+                values << args
+                nil
+              end
+            end
+
+            each_sample(values).all? do |v|
+              if v.size == 1
+                # Only one block argument.
+                val_is_type?(v[0], type.args[0]) || value(v, type.args[0])
+              else
+                val_is_type?(v, type.args[0])
+              end
+            end &&
+              if ret.equal?(self)
+                type.args[1].is_a?(Types::Bases::Bottom)
+              else
+                val_is_type?(ret, type.args[1])
+              end
+          end
+        else
+          val_is_type? val, klass
+        end
+      when RBS::Types::ClassSingleton
+        klass = get_class(type.name) or return false
+        singleton_class = begin
+            klass.singleton_class
+          rescue TypeError
+            return false
+          end
+        val.is_a?(singleton_class)
+      when RBS::Types::Interface
+        methods = Set.new(val.methods)
+        if (definition = builder.build_interface(type.name))
+          definition.methods.each_key.all? do |method_name|
+            methods.member?(method_name)
+          end
+        end
+      when RBS::Types::Variable
+        true
+      when RBS::Types::Literal
+        val == type.literal
+      when RBS::Types::Union
+        type.types.any? { |type| val_is_type?(val, type) }
+      when RBS::Types::Intersection
+        type.types.all? { |type| val_is_type?(val, type) }
+      when RBS::Types::Optional
+        val_is_type?(val, NilClass) || val_is_type?(val, type.type)
+      when RBS::Types::Alias
+        val_is_type? val, builder.expand_alias(type.name)
+      when RBS::Types::Tuple
+        val_is_type?(val, Array) &&
+          type.types.map.with_index { |ty, index| val_is_type?(val[index], ty) }.all?
+      when RBS::Types::Record
+        val_is_type?(val, Hash) &&
+          type.fields.map { |key, type| val_is_type?(val[key], type) }.all?
+      when RBS::Types::Proc
+        val_is_type? val, Proc
+      else
+        false
+      end
+    end
+
+    def builder
+      @builder ||= RBS::DefinitionBuilder.new(
+        env: RBS::Environment.from_loader(RBS::EnvironmentLoader.new).resolve_type_names,
+      )
+    end
+
+    def sample_size
+      100
+    end
+  end
+end

data/lib/typed_struct/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class TypedStruct < Struct
+  VERSION = "0.1.0"
+end

data/typed_struct.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/typed_struct/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "typed_struct"
+  spec.version       = TypedStruct::VERSION
+  spec.authors       = ["Joseph Johansen"]
+  spec.email         = ["joe@stotles.com"]
+
+  spec.summary       = "Lightweight and flexible typed structs"
+  spec.description   = "All the flexibility of a Ruby Struct, but with type checking on its properties. Also benefit from being able to define complex types using RBS type notation."
+  spec.homepage      = "https://github.com/johansenja/typed_struct"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "rbs", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: typed_struct
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Johansen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rbs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: All the flexibility of a Ruby Struct, but with type checking on its properties.
+  Also benefit from being able to define complex types using RBS type notation.
+email:
+- joe@stotles.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/typed_struct.rb
+- lib/typed_struct/type_checking.rb
+- lib/typed_struct/version.rb
+- typed_struct.gemspec
+homepage: https://github.com/johansenja/typed_struct
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/johansenja/typed_struct
+  source_code_uri: https://github.com/johansenja/typed_struct
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Lightweight and flexible typed structs
+test_files: []