typed_struct 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3375fc3fde1c42faa3d3ab97fd452cbe00bc869928d152a0ea67af139aab30d
-  data.tar.gz: b4981b8264cc69a678dca36c666ee10ee82371e451ba067e558334240621de6a
+  metadata.gz: c314d5e68394fa4ae9465f421cd0d0a36c1b1aa08c011113a6be80236779fddb
+  data.tar.gz: 9f29964aaee3d86cc0ba773cf54977d95ced2df7c8bb98955099e5681cd6bfd3
 SHA512:
-  metadata.gz: e823becbc89695f9e7cd9e6a2c494750b5507ffd6cf6d638089007e4f1294950b140d73f4494e7edc592f1116389f4800312c406913767c2b53076e718dddb56
-  data.tar.gz: 6fd49203aec3eee88359bc7bb94dcc2782387c47c11f3bd4f8c53b20bfec76778061c8632575f526396795098e13d0833cbc23987a28a9667c0b72fd8785438f
+  metadata.gz: dfd2ce5fac539dd38780925f2771476acdd71ffd18bb2945f65377f6603556764a38633a311b531a3c5e808dc89f5e93b7ab3ac3a6f3d82f7aa2f769d38d3294
+  data.tar.gz: 9a39c71af23167b16280c61f0ff1ee1adcb7f01e7dd8e35a80433def24bfb7f3086dd14022f0bc69f54fb6a22b208e833671f0bf92b5ea368e3eac801f5735e5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    typed_struct (0.1.0)
+    typed_struct (0.1.1)
       rbs (~> 1.0)
 
 GEM

data/README.md

@@ -1,8 +1,33 @@
 # 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
+                       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"
+
+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 my info on writing RBS types**
 
 ## Installation
 
@@ -20,10 +45,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.

data/lib/typed_struct.rb

@@ -17,14 +17,19 @@ class TypedStruct < Struct
 
         klass.instance_eval do
           @options = { types: properties }
+
+          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

data/lib/typed_struct/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typed_struct
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Joseph Johansen