typerb 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b684a861507b2c491d213388d490af7b7543146dc3938f6817a8c1c909a359b5
-  data.tar.gz: 53160641ff2410235cc25b73c37a57d81d14b4b322a6e7fabe68f424e076907c
+  metadata.gz: 19f90a93082e4acdb25f5750c9de2880bf0c613cb414800a7ce8beb275d2ee54
+  data.tar.gz: 10e47702b997c0f4b54b416c7f77c800ee50343b391a0f41b33ff6bd4b379dc2
 SHA512:
-  metadata.gz: b2bde15804ce81dd7ddf94eefba526ca8ae24bb2880a628163d11068ea6c2fa8527dd4e6ef9be1ccba9689ed4b7a7cb6874be4dd7a9c7bd8eaebfc6f1457311b
-  data.tar.gz: 563e93c1cd6b3787d8876da94ac612af27be1accb3300012f5eb7bac9fdbb3ebdc7f68e6efe5b2d15126ca14cec5d55d1769990fe7e387d793e91321a12df9d7
+  metadata.gz: 4c3a3d1dbc81a742d08c3e68413a70a7aa8858e473bf46a78dcdec452e862421bf85b02354ad70d203600ea1031ac85dbfc08758ea1bc79145ce03542bc92b6c
+  data.tar.gz: 55ffd3b8d1ed4fc33141a9345baaf3f7380336bfa7a4135630e24009607d7d3554b8d5892a887676a24a38a70ca7acfa351293b31f8d3f77e13ba31558cdcf5a

data/.rubocop.yml

@@ -0,0 +1,15 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/Semicolon:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 170

data/.travis.yml

@@ -2,6 +2,8 @@
 sudo: false
 language: ruby
 cache: bundler
-rvm:
-  - 2.6.0
-before_install: gem install bundler -v 1.17.1
+before_install: gem install bundler
+
+script:
+  - bundle exec rubocop -DP
+  - bundle exec rspec

data/Gemfile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
-git_source(:github) { |repo_name| 'https://github.com/#{repo_name}' }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in typerb.gemspec
 gemspec

data/Gemfile.lock

@@ -1,18 +1,25 @@
 PATH
   remote: .
   specs:
-    typerb (0.1.2)
+    typerb (0.1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.0)
     awesome_print (1.8.0)
     coderay (1.1.2)
     diff-lcs (1.3)
+    jaro_winkler (1.5.1)
     method_source (0.9.1)
+    parallel (1.12.1)
+    parser (2.5.3.0)
+      ast (~> 2.4.0)
+    powerpack (0.1.2)
     pry (0.12.0)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    rainbow (3.0.0)
     rake (10.5.0)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
@@ -27,8 +34,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-support (3.8.0)
+    rubocop (0.60.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
     super_awesome_print (0.2.5)
       awesome_print
+    unicode-display_width (1.4.0)
 
 PLATFORMS
   ruby
@@ -38,6 +55,7 @@ DEPENDENCIES
   pry
   rake (>= 10.0)
   rspec (>= 3.0)
+  rubocop
   super_awesome_print
   typerb!
 

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/typerb.svg)](https://badge.fury.io/rb/typerb)
+[![Build Status](https://travis-ci.org/olegantonyan/typerb.svg?branch=master)](https://travis-ci.org/olegantonyan/typerb)
+
 # Typerb
 
 Proof of concept type-checking library for Ruby 2.6.
@@ -11,7 +14,7 @@ class A
   end
 end
 
-A.new.call(1) #=> TypeError: '`some_arg` should be String or Symbol, not Integer'
+A.new.call(1) #=> TypeError: `some_arg` should be String or Symbol, not Integer
 ```
 
 This is equivalent to:
@@ -25,6 +28,20 @@ end
 
 But without boilerplate.
 
+It also has `not_nil!` method, similar to Crystal language.
+
+```ruby
+class A
+  using Typerb
+
+  def call(some_arg)
+    some_arg.not_nil!
+  end
+end
+
+A.new.call(nil) #=> TypeError: expected not nil, but got nil
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -58,6 +75,19 @@ gem 'typerb', github: 'olegantonyan/typerb'
 2. Call `.type!()` on any object to assert its type.
 3. PROFIT! No more "NoMethodError for nil" 10 methods up the stack. You'll know exactly where this nil came from.
 
+```ruby
+class A
+  using Typerb
+
+  attr_reader :param, :another_param
+
+  def initialize(param, another_param)
+    @param = param.type!(String)
+    @another_param = another_param.not_nil!
+  end
+end
+```
+
 If you're unfamiliar with `using` keyword - this is refinement - a relatively new feature in Ruby (since 2.0). It's kind of monkey-patch, but with strict scope. Learn more about [refinements](https://ruby-doc.org/core-2.5.3/doc/syntax/refinements_rdoc.html).
 
 This refinement adds `type!()` method to `Object` class so you can call it on almost much any object (except those inherited from `BasicObject`, but these are rare).

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/typerb/version.rb

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

data/lib/typerb.rb

@@ -6,27 +6,52 @@ module Typerb
   refine Object do
     def type!(*klasses)
       raise ArgumentError, 'provide at least one class' if klasses.empty?
-      return if klasses.any? { |kls| is_a?(kls) }
+      return self if klasses.any? { |kls| is_a?(kls) }
 
-      kls_text = klasses.size > 1 ? klasses.map(&:name).join(' or ') : klasses.first.name
+      exception_text = if (var_name = VariableNameUtil.get(caller_locations(1, 1)))
+                         "`#{var_name}` should be #{VariableNameUtil.klasses_text(klasses)}, not #{self.class} (#{self})"
+                       else
+                         "expected #{VariableNameUtil.klasses_text(klasses)}, got #{self.class} (#{self})"
+                       end
 
-      # error message when multiple calls on the same line, or in a console - can't extract variable name
-      exception_text = "expected #{kls_text}, got #{self.class} (#{to_s})"
+      exception = TypeError.new(exception_text)
+      exception.set_backtrace(caller)
+      raise exception
+    end
+
+    def not_nil!
+      return self unless self.nil? # rubocop: disable Style/RedundantSelf
+
+      exception_text = if (var_name = VariableNameUtil.get(caller_locations(1, 1)))
+                         "`#{var_name}` should not be nil"
+                       else
+                         'expected not nil, but got nil'
+                       end
 
-      where = caller_locations(1, 1)[0]
-      file = where.path
-      line = where.lineno
-      if File.exist?(file)
-        code = File.read(file).lines[line - 1].strip
-        node = RubyVM::AST.parse(code)
-        if node.children.last.children.size == 3 && node.children.last.children[1] == :type!
-          var_name = node.children.last.children.first.children.first
-          exception_text = "`#{var_name}` should be #{kls_text}, not #{self.class} (#{to_s})"
-        end
-      end
       exception = TypeError.new(exception_text)
       exception.set_backtrace(caller)
       raise exception
     end
   end
+
+  module VariableNameUtil
+    module_function
+
+    def get(c_loc) # rubocop: disable Metrics/AbcSize screw this
+      where = c_loc[0]
+      file = where.path
+      line = where.lineno
+      return unless File.exist?(file)
+
+      code = File.read(file).lines[line - 1].strip
+      node = RubyVM::AST.parse(code)
+      if node.children.last.children.size == 3 && %i[type! not_nil!].include?(node.children.last.children[1]) # rubocop: disable Style/IfUnlessModifier, Style/GuardClause
+        node.children.last.children.first.children.first
+      end
+    end
+
+    def klasses_text(klasses)
+      klasses.size > 1 ? klasses.map(&:name).join(' or ') : klasses.first.name
+    end
+  end
 end

data/typerb.gemspec

@@ -1,4 +1,6 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'typerb/version'
 
@@ -8,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Oleg Antonyan']
   spec.email         = ['oleg.b.antonyan@gmail.com']
 
-  spec.summary       = %q(Typecheck sugar for Ruby.)
-  spec.description   = %q(Typecheck sugar for Ruby.)
+  spec.summary       = 'Typecheck sugar for Ruby.'
+  spec.description   = 'Typecheck sugar for Ruby.'
   spec.homepage      = 'https://github.com/olegantonyan/typerb'
   spec.license       = 'MIT'
 
@@ -23,10 +25,11 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '>= 1.17'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'rspec', '>= 3.0'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'super_awesome_print'
-  spec.add_development_dependency 'pry'
 
   spec.required_ruby_version = '>= 2.6.0-preview3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typerb
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Oleg Antonyan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-09 00:00:00.000000000 Z
+date: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -53,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: super_awesome_print
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: super_awesome_print
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -89,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md