eqq 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d6619f43d14ad7f0519f68caabc8cf3128ebc3898608aaad753adb81c929201
-  data.tar.gz: ef9edac7cfd62cc0ba23f55e86ad9194a5396550ec9b9d1ec17614f36a0f21c4
+  metadata.gz: d0645f6178f68b0a105efa1bcf389bd3c0b1f056cd94a6c6684b0d18bc9284f8
+  data.tar.gz: a93f3a7df8098fbb1e7bdb61b5ad36c29a67e4471e563c63bb562b7896cfa60d
 SHA512:
-  metadata.gz: a48164a2c1cea62810b4930fa92ca3ebb0b5a2a1b4877f743f1902de52b4ec429d590333437e54eae41ee917463ee5b3166f5c77394369bf2402ff6122cb4ee9
-  data.tar.gz: 880f51dbce3e27f845b05a520decd8c9a17b7c400837d29cb1ad0597ae00279d888c708632dd64eb5457f7ed9d023c9e71951e5b5c4a28c04252727043852f0f
+  metadata.gz: a5d02720dfa28fc5aefed2907008e14e76dc00fd087eb83eb6c89bbf8c976b0258410d554592fc1368938bfcda8e96efc99ae2a811f285dfba33b210bf795ba5
+  data.tar.gz: e8077c6bd4ab3c5e363abeaa5154dca3bf8154140a73f75d238883cefe92855fb8da843ba46037c12ffb9bc710b9449b1d121a6e2119dc774520bd237f71d564

data/README.md

@@ -12,7 +12,7 @@ Require Ruby 2.6 or later
 Add below code into your Gemfile
 
 ```ruby
-gem 'eqq', '>= 0.0.5', '< 0.1.0'
+gem 'eqq', '>= 0.0.6', '< 0.1.0'
 ```
 
 ### Overview
@@ -113,14 +113,37 @@ Reuse as you wish!
 * NAND(*patterns) - Product is an inverted `AND`
 * NOR(*patterns) - Product is an inverted `OR`
 
-### Additional information
+### Best fit for RSpec's `satisfy` matcher too
 
-When you feel annoy to write `Eqq` in many place, 2 ways exist.
+All builders actually generate a `Proc (lambda)` instance.
+The signature will fit for RSpec's built-in [`satisfy` matcher](https://relishapp.com/rspec/rspec-expectations/v/3-10/docs/built-in-matchers/satisfy-matcher) too.
+
+```ruby
+RSpec.describe RSpec::Matchers::BuiltIn::Satisfy do
+  let(:product) { Eqq.AND(Integer, 24..42) }
+
+  it 'perfectly works' do
+    expect(23).not_to satisfy(&product)
+    expect(24).to satisfy(&product)
+    expect(24.0).not_to satisfy(&product)
+    expect(42).to satisfy(&product)
+    expect(42.0).not_to satisfy(&product)
+    expect(43).not_to satisfy(&product)
+  end
+end
+```
+
+### Use builders without receiver specifying
+
+When you felt annoy to write `Eqq` in many place, some ways exist.
 
 * `Eqq.define(&block)` - In the block scope, all builder methods can be used without receiver
-* `include Eqq::Buildable` - In the class/module, all builders can be used as own method
+* `extend Eqq::Buildable` - In the class/module, all builders can be used as class methods
+* `include Eqq::Buildable` - In the class/module, all builders can be used as instance methods
+
+### Signature
 
-This gem provides [ruby/rbs](https://github.com/ruby/rbs) signatures
+* This gem provides [ruby/rbs](https://github.com/ruby/rbs) signature file
 
 ## Links
 

data/lib/eqq.rb

@@ -15,7 +15,7 @@ module Eqq
   class InvalidProductError < Error; end
 
   class << self
-    def valid?(object)
+    def pattern?(object)
       case object
       when Proc, Method
         object.arity == 1
@@ -28,11 +28,21 @@ module Eqq
       end
     end
 
+    # @deprecated Use {pattern?} instead. This will be dropped since `0.1.0`
+    def valid?(object)
+      pattern?(object)
+    end
+
+    # @api private
+    def satisfy?(object)
+      (Proc === object) && object.lambda? && (object.arity == 1)
+    end
+
     # @return [#===]
     # @raise [InvalidProductError] if the return value is invalid as a pattern object
     def define(&block)
       pattern = DSLScope.new.instance_exec(&block)
-      raise InvalidProductError unless valid?(pattern)
+      raise InvalidProductError unless satisfy?(pattern)
 
       pattern
     end

data/lib/eqq/buildable.rb

@@ -38,7 +38,7 @@ module Eqq
       # @api private
       # @return [void]
       def validate_patterns(*patterns)
-        invalids = patterns.reject { |pattern| Eqq.valid?(pattern) }
+        invalids = patterns.reject { |pattern| Eqq.pattern?(pattern) }
         invalid_inspections = invalids.map { |invalid| safe_inspect_for(invalid) }.join(', ')
         raise ArgumentError, "given `#{invalid_inspections}` are invalid as pattern objects" unless invalids.empty?
       end

data/lib/eqq/version.rb

@@ -3,5 +3,5 @@
 
 module Eqq
   # This will be same as latest published gem version
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/sig/eqq.rbs

@@ -98,8 +98,15 @@ module Eqq
   VERSION: String
 
   # Returns `true` when given object has patternable signature
+  def self.pattern?: (untyped object) -> bool
+
+  # Alias of `pattern?`. But deperecated. Do not use in your code anymore.
   def self.valid?: (untyped object) -> bool
 
+  # Returns `true` when given object has correct signature as a product of builders
+  # Basically this is a private API. Should not be used in your code.
+  def self.satisfy?: (untyped object) -> bool
+
   # In the block scope, all builder methods can be used without receiver
   def self.define:  { () -> _Patternable } -> _Patternable
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eqq
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Kenichi Kamiya
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2021-06-06 00:00:00.000000000 Z
 dependencies: []
 description: |2
       Pattern objects builder.