typerb 0.1.8 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ee985e57292c037f842de48682659f4fb90e6f18d26811e065c4b32983a5bbb
-  data.tar.gz: f4960c88faa5d885690405c70a514cbcea191e12964f7e83b50d925bb0848911
+  metadata.gz: 540b60be5aed7792e525d276c23d892343db1ea43db239d5c4b6df3664011d65
+  data.tar.gz: 9176075161a22f47297e406854b58f7420832630a8792c70b8dd0c49a0049860
 SHA512:
-  metadata.gz: c816163ee5396ecfcd09234b9e2590b8a75bc06ef6ea839897da6bc2722c44bbe9bdbc3c1aef75858be28ae6df118ad834e6548b68449a140381d3188b3d9684
-  data.tar.gz: 84a1286086584e24305f1816f93cf573bef0a257f7fb541e223986e260697c780ea14d6c22fe9cc59857df95e99f1be4f4a438a9b48265072b055d3823dc5819
+  metadata.gz: 68ab68e33e41b5f07790814d387bd74f6924445ee44b5faf78d4a80077466ffd8c323fdff4850e746cb2ed8a08bfc3b11c576fdd6ad29014a7f116d0b758bf2e
+  data.tar.gz: 4bc5f3c347f2a61006e3097af2a96684a80fcc8b3471957be016466844667083092b050a2bebe564ded578365ec901ef5f11a9a1d14dfb86e21a331a2cb97c6a

data/.github/workflows/tests.yml

@@ -0,0 +1,24 @@
+name: CI RSpec & Rubocop
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: [2.5.3, 2.6.0, 2.7.4, 3.0.1, 3.1.0]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Run Rubocop
+        run: bundle exec rubocop -DP
+      - name: Run tests
+        run: bundle exec rspec

data/.gitignore

@@ -11,3 +11,5 @@
 
 # rspec failure tracking
 .rspec_status
+
+.ruby-version

data/.rubocop.yml

@@ -1,5 +1,7 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 3.1
+  NewCops: enable
+  SuggestExtensions: false
   Exclude:
     - 'bin/**/*'
     - 'Guardfile'
@@ -17,5 +19,17 @@ Style/Documentation:
 Style/Semicolon:
   Enabled: false
 
-Metrics/LineLength:
+Style/StringConcatenation:
+  Enabled: false
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/LineLength:
   Max: 170
+
+Gemspec/RequireMFA:
+  Enabled: false

data/Gemfile.lock

@@ -1,24 +1,24 @@
 PATH
   remote: .
   specs:
-    typerb (0.1.7)
+    typerb (0.4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    awesome_print (1.8.0)
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    ffi (1.9.25)
-    formatador (0.2.5)
-    guard (2.15.0)
+    ast (2.4.2)
+    awesome_print (1.9.2)
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    ffi (1.15.5)
+    formatador (0.3.0)
+    guard (2.18.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
       nenv (~> 0.1)
       notiffany (~> 0.0)
-      pry (>= 0.9.12)
+      pry (>= 0.13.0)
       shellany (~> 0.0)
       thor (>= 0.18.1)
     guard-compat (1.2.1)
@@ -26,57 +26,58 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    jaro_winkler (1.5.1)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    lumberjack (1.0.13)
-    method_source (0.9.2)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.8)
+    method_source (1.0.0)
     nenv (0.3.0)
-    notiffany (0.1.1)
+    notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    parallel (1.12.1)
-    parser (2.5.3.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rainbow (3.0.0)
-    rake (12.3.2)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.9.10)
-      ffi (>= 0.5.0, < 2)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rb-fsevent (0.11.0)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.61.1)
-      jaro_winkler (~> 1.5.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.24.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    ruby_dep (1.5.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
     shellany (0.0.1)
     super_awesome_print (0.2.5)
       awesome_print
-    thor (0.20.3)
-    unicode-display_width (1.4.0)
+    thor (1.2.1)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
@@ -93,4 +94,4 @@ DEPENDENCIES
   typerb!
 
 BUNDLED WITH
-   1.17.2
+   2.3.5

data/README.md

@@ -1,5 +1,5 @@
 [![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)
+[![CI RSpec & Rubocop](https://github.com/olegantonyan/typerb/actions/workflows/tests.yml/badge.svg)](https://github.com/olegantonyan/typerb/actions/workflows/tests.yml)
 
 # Typerb
 
@@ -17,10 +17,19 @@ class A
     some_arg.respond_to!(:strip)
   end
 
+  def call_with_enum(arg)
+    arg.enum!(:one, :two)
+  end
+
+  def call_with_subset(arg)
+    arg.subset_of!([: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'
+A.new.call_with_subset([:one, :three]) #=> TypeError: 'Array (`arg`) should be subset of: [:one, :two], not [:one, :three]'
 ```
 
 This is equivalent to:
@@ -52,6 +61,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:
@@ -100,7 +114,7 @@ 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!()` and `not_nil!` methods to `Object` class so you can call it on almost much any object (except those inherited from `BasicObject`, but these are rare).
+This refinement adds `type!()` and `not_nil!` methods to `BasicObject` class so you can call it on any object.
 
 The method will raise an exception if `self` is not an instance of one of the classes passed as arguments. The tricky part, however, is to get the variable name on which it's called. You need this to get a nice error message telling you exactly which variable has wrong type, not just an abstract `TypeError`. That's why we need Ruby 2.6 with its new `RubyVM::AST` (https://ruby-doc.org/core-2.6.0.preview3/RubyVM/AST.html).
 

data/lib/typerb/exceptional.rb

@@ -10,6 +10,14 @@ module Typerb
       def methods_text(methods)
         methods.join(', ')
       end
+
+      def elements_text(elements)
+        '[' + elements.join(', ') + ']'
+      end
+
+      def superset_text(enumerable)
+        enumerable.to_s
+      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.4.0'
 end

data/lib/typerb.rb

@@ -5,7 +5,7 @@ require 'typerb/variable_name'
 require 'typerb/exceptional'
 
 module Typerb
-  refine Object do
+  refine BasicObject do
     def type!(*klasses)
       raise ArgumentError, 'provide at least one class' if klasses.empty?
       return self if klasses.any? { |kls| is_a?(kls) }
@@ -45,5 +45,34 @@ 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
+
+    def subset_of!(superset)
+      raise ArgumentError, 'superset must be Enumerable' unless superset.is_a?(Enumerable)
+      raise ArgumentError, 'provide at least one superset element' if superset.empty?
+      return self if (self - superset).empty?
+
+      superset_text = Typerb::Exceptional.superset_text(superset)
+      exception_text = if (var_name = Typerb::VariableName.new(caller_locations(1, 1)).get)
+                         "#{self.class} (`#{var_name}`) should be subset of: #{superset_text}, not #{self}"
+                       else
+                         "#{self.class} expected subset of: #{superset_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.4.0
 platform: ruby
 authors:
 - Oleg Antonyan
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2018-12-12 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,11 +129,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".ruby-version"
-- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -152,7 +151,7 @@ homepage: https://github.com/olegantonyan/typerb
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -167,9 +166,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 3.0.0.beta3
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Typecheck sugar for Ruby.
 test_files: []

data/.ruby-version

@@ -1 +0,0 @@
-2.6.0-rc1

data/.travis.yml

@@ -1,14 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-before_install: gem install bundler
-
-rvm:
-  - 2.4.0
-  - 2.5.3
-  - 2.6.0-rc1
-
-script:
-  - bundle exec rubocop -DP
-  - bundle exec rspec