typed_struct 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c314d5e68394fa4ae9465f421cd0d0a36c1b1aa08c011113a6be80236779fddb
-  data.tar.gz: 9f29964aaee3d86cc0ba773cf54977d95ced2df7c8bb98955099e5681cd6bfd3
+  metadata.gz: 8b464562db650de5a4d3026ca8806d85b993c8f6bfcf3e86d1988c859432a427
+  data.tar.gz: a6d38114357f8657b675074a36cbfba6129695eb80bc1b9333219f241cc44b79
 SHA512:
-  metadata.gz: dfd2ce5fac539dd38780925f2771476acdd71ffd18bb2945f65377f6603556764a38633a311b531a3c5e808dc89f5e93b7ab3ac3a6f3d82f7aa2f769d38d3294
-  data.tar.gz: 9a39c71af23167b16280c61f0ff1ee1adcb7f01e7dd8e35a80433def24bfb7f3086dd14022f0bc69f54fb6a22b208e833671f0bf92b5ea368e3eac801f5735e5
+  metadata.gz: b280075f73bf18618ea3ab207b9d3f632928d69a364902b3374ab4b4a728ba791874247a7d36502fd4c83e00f980e4e35e7b777d8e80a40223377a207a03432c
+  data.tar.gz: 9ba0515a1401a4be3d0feaa4bd79fe1dee3c7d20c1d84990485c0eb411df88df16d3bb86a5703f13fca71299e925c6b0e157932a1691efdb10987be536cd1d2d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    typed_struct (0.1.1)
+    typed_struct (0.1.2)
       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

@@ -9,6 +9,8 @@ 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
@@ -17,7 +19,9 @@ clive = User.new name: "Clive",
                  age: 22,
                  interests: %w[surfing skiing],
                  preferences: { opt_out_of_emails: true, additional: { preferred_theme: :dark } },
-                 type: "User"
+                 type: "User",
+                 rating: 4,
+                 username: "cliveabc"
 
 clive.age # 22
 clive.age = '22' # => Error
@@ -27,7 +31,7 @@ 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**
+**See [RBS reference](https://github.com/ruby/rbs/blob/3c046c77c3006211a1a14eedc35221ac4198f788/docs/syntax.md) for more info on writing RBS types**
 
 ## Installation
 
@@ -53,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.1"
+  VERSION = "0.1.2"
 end

data/lib/typed_struct.rb

@@ -7,8 +7,20 @@ require "rbs"
 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)
+      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
@@ -38,7 +50,7 @@ class TypedStruct < Struct
   end
 
   def initialize(**attrs)
-    opts = self.class.options
+    opts = self.__class__.options
     opts[:types].each do |prop, expected_type|
       passed_value = attrs[prop]
       next if val_is_type? passed_value, expected_type

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typed_struct
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 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