typed_struct 0.1.0 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3375fc3fde1c42faa3d3ab97fd452cbe00bc869928d152a0ea67af139aab30d
-  data.tar.gz: b4981b8264cc69a678dca36c666ee10ee82371e451ba067e558334240621de6a
+  metadata.gz: 3b49cf9fe619f10d5b29cd5a25cb5ad6b881c05db4a8de195235a471182e8a93
+  data.tar.gz: d90fbe0ae7d7886208207e12dbd71c99b07238a453fce26469fdef534f7210b5
 SHA512:
-  metadata.gz: e823becbc89695f9e7cd9e6a2c494750b5507ffd6cf6d638089007e4f1294950b140d73f4494e7edc592f1116389f4800312c406913767c2b53076e718dddb56
-  data.tar.gz: 6fd49203aec3eee88359bc7bb94dcc2782387c47c11f3bd4f8c53b20bfec76778061c8632575f526396795098e13d0833cbc23987a28a9667c0b72fd8785438f
+  metadata.gz: 3ee1d309ac25b3b76e03b5acf485c1d7ac6159aaf74adbad3e72db771a153679bfa0a08569f3957df7489cf221bfdd1f11fc0c648c065496cba74bffa7fa15e0
+  data.tar.gz: c30d9b77718eb33435ec5b5995c078db3cf1a99e0d456c1a45f26b06bac57bbc14d255adc070a965b81df7aafb6edd9d0074fd74851c828d1681685a1d375e61

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    typed_struct (0.1.0)
+    typed_struct (0.1.4)
       rbs (~> 1.0)
 
 GEM
@@ -9,7 +9,7 @@ GEM
   specs:
     diff-lcs (1.4.4)
     rake (13.0.3)
-    rbs (1.1.1)
+    rbs (1.5.1)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)

data/README.md

@@ -1,8 +1,37 @@
 # 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.
+A Typed Struct is a lightweight data structure inspired by [Dry Struct](https://github.com/dry-rb/dry-struct), which allows for reading and writing properties while making use of a flexible and powerful type checking system, which also incorporates Ruby's [RBS](https://github.com/ruby/rbs/) for type definitions. 
 
-TODO: Delete this and the text above, and describe your gem
+## Example
+
+```ruby
+require 'typed_struct' # unless using rails
+
+User = TypedStruct.new name: String, # an instance of String
+                       age: Integer, # an instance of Integer
+                       username: /\w{4,}/, # must match given Regexp
+                       rating: (0..5), # must be value from 0 to 5
+                       type: "User", # must by a string with value "User"
+                       interests: Rbs("Array[String]"), # an RBS generic type (an Array of Strings)
+                       preferences: Rbs("{ opt_out_of_emails: bool, additional: untyped }") # RBS record type
+
+clive = User.new name: "Clive",
+                 age: 22,
+                 interests: %w[surfing skiing],
+                 preferences: { opt_out_of_emails: true, additional: { preferred_theme: :dark } },
+                 type: "User",
+                 rating: 4,
+                 username: "cliveabc"
+
+clive.age # 22
+clive.age = '22' # => Error
+clive.preferences = { "opt_out_of_emails" => true, "additional" => nil } # error - type mismatch, not Symbol keys
+clive.freeze # no more changes can be made
+```
+
+Note that a `TypedStruct` inherits from `Struct` directly, so anything from `Struct` is also available in `TypedStruct` - see [Struct docs](https://ruby-doc.org/core-3.0.1/Struct.html) for more info.
+
+**See [RBS reference](https://github.com/ruby/rbs/blob/3c046c77c3006211a1a14eedc35221ac4198f788/docs/syntax.md) for more info on writing RBS types**
 
 ## Installation
 
@@ -20,10 +49,6 @@ 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.
@@ -32,7 +57,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/typed_struct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/johansenja/typed_struct.
 
 ## License
 

data/lib/typed_struct/version.rb

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

data/lib/typed_struct.rb

@@ -4,11 +4,27 @@ require_relative "typed_struct/version"
 require_relative "typed_struct/type_checking"
 require "rbs"
 
+def Rbs(type_str)
+  RBS::Parser.parse_type(type_str)
+end
+
 class TypedStruct < Struct
   include TypeChecking
 
+  OVERRIDING_NATIVE_METHOD_MSG =
+    "*** WARNING *** property %s overrides a native method in #{name}. Consider using something else (called from %s)".freeze
+
+  # any methods which are able to be overridden
+  alias_method :__class__, :class
+
   class << self
-    def new(**properties)
+    def new(opts = Options.new, **properties)
+      properties.each_key do |prop|
+        if method_defined?(prop)
+          $stdout.puts OVERRIDING_NATIVE_METHOD_MSG % [prop.inspect, caller(3).first]
+        end
+      end
+
       super(*properties.keys, keyword_init: true).tap do |klass|
         klass.class.instance_eval do
           include TypeChecking
@@ -16,15 +32,20 @@ class TypedStruct < Struct
         end
 
         klass.instance_eval do
-          @options = { types: properties }
+          @options = { types: properties, options: opts }
+
+          define_method :[]= do |key, val|
+            prop = properties[key]
+            unless val_is_type? val, prop
+              raise "Unexpected type #{val.class} for #{key.inspect} (expected #{prop})"
+            end
+
+            super key, val
+          end
+
           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
+              self[k] = val
             end
           end
         end
@@ -33,18 +54,17 @@ class TypedStruct < Struct
   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})"
+    opts = self.__class__.options
+    vals = opts[:types].to_h do |prop, expected_type|
+      value = attrs.fetch(prop, opts[:options][:default])
+      unless val_is_type? value, expected_type
+        raise "Unexpected type #{value.class} for #{prop.inspect} (expected #{expected_type})"
+      end
+      [prop, value]
     end
 
-    super
+    super **vals
   end
-end
 
-def Rbs(type_str)
-  RBS::Parser.parse_type(type_str)
+  Options = TypedStruct.new({ default: nil }, default: Rbs("untyped"))
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typed_struct
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.4
 platform: ruby
 authors:
 - Joseph Johansen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-21 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rbs