typerb 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ee985e57292c037f842de48682659f4fb90e6f18d26811e065c4b32983a5bbb
-  data.tar.gz: f4960c88faa5d885690405c70a514cbcea191e12964f7e83b50d925bb0848911
+  metadata.gz: 0c844da90032caf4ef3ad3b5e14ab417c8bda85c0d876028b075d1f8b154cfae
+  data.tar.gz: 2ba22c2934fcdda11f528e9032ee759712374b4ee06be867335e9539534ddd36
 SHA512:
-  metadata.gz: c816163ee5396ecfcd09234b9e2590b8a75bc06ef6ea839897da6bc2722c44bbe9bdbc3c1aef75858be28ae6df118ad834e6548b68449a140381d3188b3d9684
-  data.tar.gz: 84a1286086584e24305f1816f93cf573bef0a257f7fb541e223986e260697c780ea14d6c22fe9cc59857df95e99f1be4f4a438a9b48265072b055d3823dc5819
+  metadata.gz: 8a8b01b03026e99f4387f98c0f326c2ad2a97149421704c60f904e21932a90925f085fac0455a4261ff4db6e8ea4d0978fd38667ad09c42b529c87882b68499b
+  data.tar.gz: 6cbdabf0eae0724331d8d253b32e3a9c5f71748eb9217213b65d45f38db674676795c94c34405287f38b52f24d129a2238ce1ae7971a1dc7d73278e36ad69b0d

data/.ruby-version

@@ -1 +1 @@
-2.6.0-rc1
+2.6.1

data/.travis.yml

@@ -7,7 +7,8 @@ before_install: gem install bundler
 rvm:
   - 2.4.0
   - 2.5.3
-  - 2.6.0-rc1
+  - 2.6.0
+  - 2.6.1
 
 script:
   - bundle exec rubocop -DP

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    typerb (0.1.7)
+    typerb (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -17,10 +17,14 @@ class A
     some_arg.respond_to!(:strip)
   end
 
+  def call_with_enum(arg)
+    arg.enum!(:one, :two)
+  end
 end
 
 A.new.call(1) #=> TypeError: `some_arg` should be String or Symbol, not Integer
 A.new.call_with_respond_checks(1) #=> TypeError: 'Integer should respond to all methods: strip'
+A.new.call_with_enum(:three) #=> TypeError: 'Symbol (`arg`) should be one of: [one, two], not three'
 ```
 
 This is equivalent to:
@@ -52,6 +56,11 @@ end
 A.new.call(nil) #=> TypeError: expected not nil, but got nil
 ```
 
+## Why?
+
+1. Catch error as early as possible (especially nils);
+2. Additional documentation: you're telling other people more about interfaces.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/typerb/exceptional.rb

@@ -10,6 +10,10 @@ module Typerb
       def methods_text(methods)
         methods.join(', ')
       end
+
+      def elements_text(elements)
+        '[' + elements.join(', ') + ']'
+      end
     end
 
     def raise_with(backtrace, exception_text)

data/lib/typerb/variable_name.rb

@@ -10,7 +10,7 @@ module Typerb
     end
 
     def get
-      return if RUBY_VERSION < '2.6.0'
+      return unless defined?(RubyVM::AbstractSyntaxTree)
       return unless File.exist?(file)
 
       caller_method = caller_locations(1, 1)[0].label.to_sym

data/lib/typerb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Typerb
-  VERSION = '0.1.8'
+  VERSION = '0.2.0'
 end

data/lib/typerb.rb

@@ -45,5 +45,19 @@ module Typerb
 
       Typerb::Exceptional.new.raise_with(caller, exception_text)
     end
+
+    def enum!(*elements)
+      raise ArgumentError, 'provide at least one enum element' if elements.empty?
+      return self if elements.include?(self)
+
+      elements_text = Typerb::Exceptional.elements_text(elements)
+      exception_text = if (var_name = Typerb::VariableName.new(caller_locations(1, 1)).get)
+                         "#{self.class} (`#{var_name}`) should be one of: #{elements_text}, not #{self}"
+                       else
+                         "#{self.class} expected one of: #{elements_text}, got #{self}"
+                       end
+
+      Typerb::Exceptional.new.raise_with(caller, exception_text)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typerb
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Oleg Antonyan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-12 00:00:00.000000000 Z
+date: 2019-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -167,8 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 3.0.0.beta3
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: Typecheck sugar for Ruby.