typerb 0.1.6 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ce9f42a58f215a179f850016e0f647a4e16b4f23b3021d7cd17a43960857439
-  data.tar.gz: 9bb4dc2cb1f2396c7ccfd773d27a2d85e0d11f3a66ef54537e9c809594795d5a
+  metadata.gz: 0d36da771caf7376c9ade13b380b77ae20cd50ac03172c86e6d54f3c54af5414
+  data.tar.gz: 1bb04d2199a1384049168302010c8a8d0e5114301e26108167d8d54810f4c79a
 SHA512:
-  metadata.gz: a35899b9f7f7cc045725241d6eef0d312470016e2945edea86c67696c67f3ba69bbc52743fd51cb0253b6b7bc4f3be30ac9567784269a6f382d46484b9bc2476
-  data.tar.gz: 58c8a8839809ff2c87801388cca35dca300a565616645a01d9bd59fdea6e6986c74763250093400aaca8d2b91a47cfad8b24b0060b24ae0215a3bdb846617568
+  metadata.gz: 79fa49f81f729c9e760afe1cd4abf5e2d259b1ed48a711ff64732a1411219c2d6c6fd2154dc5386e3b12d4f7cd607d4f612e06908938802ae6890c2cfd0029be
+  data.tar.gz: 5f405c7242a53f27925df6981944cc31f57b7bad60077aa36c9f7c08fd6a6a428998caca93ddf3f124829c5b40254f840bcbdf183d20ce19b41caf7b2438ebfa

data/.gitignore

@@ -6,7 +6,10 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
 *.gem
 
 # rspec failure tracking
 .rspec_status
+
+.ruby-version

data/.rubocop.yml

@@ -2,6 +2,7 @@ AllCops:
   TargetRubyVersion: 2.4
   Exclude:
     - 'bin/**/*'
+    - 'Guardfile'
 
 inherit_mode:
   merge:

data/.ruby-version

@@ -1 +1 @@
-2.6.0-preview3
+2.6.6

data/.travis.yml

@@ -7,7 +7,8 @@ before_install: gem install bundler
 rvm:
   - 2.4.0
   - 2.5.3
-#  - 2.6.0-preview3 travis does not support it yet
+  - 2.6.0
+  - 2.6.1
 
 script:
   - bundle exec rubocop -DP

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    typerb (0.1.6)
+    typerb (0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -10,48 +10,79 @@ GEM
     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)
+    ffi (1.11.1)
+    formatador (0.2.5)
+    guard (2.15.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)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    jaro_winkler (1.5.3)
+    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)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    parallel (1.17.0)
+    parser (2.6.3.0)
       ast (~> 2.4.0)
-    powerpack (0.1.2)
-    pry (0.12.0)
+    pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (12.3.2)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
     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-core (3.8.1)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    rubocop (0.60.0)
+    rspec-support (3.8.2)
+    rubocop (0.72.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
+      parser (>= 2.6)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
     super_awesome_print (0.2.5)
       awesome_print
-    unicode-display_width (1.4.0)
+    thor (0.20.3)
+    unicode-display_width (1.6.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (>= 1.17)
+  guard
+  guard-rspec
   pry
   rake (>= 10.0)
   rspec (>= 3.0)
@@ -60,4 +91,4 @@ DEPENDENCIES
   typerb!
 
 BUNDLED WITH
-   1.17.1
+   1.17.2

data/Guardfile

@@ -0,0 +1,36 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+
+  # watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  # watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+end

data/README.md

@@ -3,7 +3,7 @@
 
 # Typerb
 
-Proof of concept type-checking library for Ruby 2.6.
+Proof of concept type-checking library for Ruby 2.6. Works with previous versions too with some limitation (see below).
 
 ```ruby
 class A
@@ -12,9 +12,19 @@ class A
   def call(some_arg)
     some_arg.type!(String, Symbol)
   end
+
+  def call_with_respond_checks(some_arg)
+    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:
@@ -23,6 +33,10 @@ class A
   def call(some_arg)
     raise TypeError, "`some_arg` should be String or Symbol, not #{some_arg.class}" unless [String, Symbol].include?(some_arg.class)
   end
+
+  def call_with_respond_checks(some_arg)
+    raise TypeError, "#{some_arg.class} should respond to all methods: strip" unless [:strip].all{|meth| some_arg.respond_to?(meth)}
+  end
 end
 ```
 
@@ -42,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:
@@ -90,13 +109,13 @@ 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).
+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).
 
 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).
 
 ## Limitations
 
-It requires Ruby 2.6.0-preview3. Relies on `RubyVM::AST` which may change in release version. So, expect breaking changes in Ruby.
+Full functionality Ruby 2.6.0-preview3. Relies on `RubyVM::AST` which may change in release version. So, expect breaking changes in Ruby. Previous versions also supported, but without variable name in exception message.
 
 Known limitations:
 
@@ -107,8 +126,9 @@ class A
 
   def call(some_arg)
     some_arg.
-            type!(String) # this won't work. type!() call must be on the same line with the variable it's called on - raise error message without variable name
-                          # some_arg.    type!(String) is ok though
+            type!(String)
+    # this won't work. type!() call must be on the same line with the variable it's called on - raise error message without variable name
+    # some_arg.    type!(String) is ok though
   end
 end
 ```
@@ -119,10 +139,11 @@ end
 [1] pry(main)*   using Typerb
 [1] pry(main)*   def call(a)
 [1] pry(main)*     a.type!(Hash)
-[1] pry(main)*   end  
-[1] pry(main)* end  
+[1] pry(main)*   end
+[1] pry(main)* end
 [2] pry(main)> A.new.call(1)
-TypeError: expected Hash, got Integer  # here we cannot get the source code for a line containing "a.type!(Hash)", so cannot see the variable name
+TypeError: expected Hash, got Integer
+# here we cannot get the source code for a line containing "a.type!(Hash)", so cannot see the variable name
 ```
 
 3. Multiple arguments on the same line:
@@ -131,7 +152,9 @@ class A
   using Typerb
 
   def initialize(arg1, arg2)
-    arg1.type!(Integer); arg2.type!(String) # no way to tell the variable - raise error message without variable name
+    arg1.type!(Integer); arg2.type!(String)
+    # no way to tell the variable - raise error message without variable name
+    # same error will be raised on Ruby < 2.6.0 because there is no RubyVM::AST
   end
 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) }
@@ -31,5 +31,33 @@ module Typerb
 
       Typerb::Exceptional.new.raise_with(caller, exception_text)
     end
+
+    def respond_to!(*methods)
+      raise ArgumentError, 'provide at least one method' if methods.empty?
+      return self if methods.all? { |meth| respond_to?(meth) }
+
+      methods_text = Typerb::Exceptional.methods_text(methods)
+      exception_text = if (var_name = Typerb::VariableName.new(caller_locations(1, 1)).get)
+                         "#{self.class} (`#{var_name}`) should respond to all methods: #{methods_text}"
+                       else
+                         "#{self.class} should respond to all methods: #{methods_text}"
+                       end
+
+      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

data/lib/typerb/exceptional.rb

@@ -6,6 +6,14 @@ module Typerb
       def klasses_text(klasses)
         klasses.size > 1 ? klasses.map(&:name).join(' or ') : klasses.first.name
       end
+
+      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
@@ -21,7 +21,7 @@ module Typerb
 
     def from_ast(caller_method) # rubocop: disable Metrics/AbcSize not worth fixing
       code = File.read(file).lines[line - 1].strip
-      node = RubyVM::AST.parse(code)
+      node = RubyVM::AbstractSyntaxTree.parse(code)
       if node.children.last.children.size == 3 && node.children.last.children[1] == caller_method # rubocop: disable Style/IfUnlessModifier, Style/GuardClause
         node.children.last.children.first.children.first
       end

data/lib/typerb/version.rb

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

data/typerb.gemspec

@@ -25,6 +25,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'bundler', '>= 1.17'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'rspec', '>= 3.0'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: typerb
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Oleg Antonyan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-13 00:00:00.000000000 Z
+date: 2021-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-rspec
+  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: pry
   requirement: !ruby/object:Gem::Requirement
@@ -109,6 +137,7 @@ files:
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -138,8 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 3.0.0.beta2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Typecheck sugar for Ruby.