eqq 0.0.5 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d6619f43d14ad7f0519f68caabc8cf3128ebc3898608aaad753adb81c929201
-  data.tar.gz: ef9edac7cfd62cc0ba23f55e86ad9194a5396550ec9b9d1ec17614f36a0f21c4
+  metadata.gz: dbc7af119664c115468e578edb51c0702530299538f1b067520295b41a150f7d
+  data.tar.gz: e47dbde377b0ca22a2e92a620c3cb5f87b4b09a061833416ebb4ffc88c311521
 SHA512:
-  metadata.gz: a48164a2c1cea62810b4930fa92ca3ebb0b5a2a1b4877f743f1902de52b4ec429d590333437e54eae41ee917463ee5b3166f5c77394369bf2402ff6122cb4ee9
-  data.tar.gz: 880f51dbce3e27f845b05a520decd8c9a17b7c400837d29cb1ad0597ae00279d888c708632dd64eb5457f7ed9d023c9e71951e5b5c4a28c04252727043852f0f
+  metadata.gz: c43cd582ac38023b1bc1521abc9dd1f15ec56e7bd2608553e1c7cddccecbf1765f331863c1e1ffabff4a9016698776aec99da16d6bc11ac63758e19af273e9da
+  data.tar.gz: b1f5c8d9868a02bc159b6a7eb18f3f8d7c1894af2f9b0f093867f30e73083add427ab4d79bb707381fe883317f8abb3c9cd8dcef79a36cf2a077ace202a4f295

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.1.1'
 ```
 
 ### Overview
@@ -24,7 +24,7 @@ require 'eqq'
 [42, nil, true, false, '', 0].grep(Eqq.BOOLEAN) #=> [true, false]
 [42, [], {}, 'string', Object.new, nil].grep(Eqq.CAN(:to_h)) #=> [[], {}, nil]
 
-pattern = Eqq.define do
+pattern = Eqq.build do
   OR(AND(Float, 20..50), Integer)
 end
 
@@ -107,20 +107,44 @@ Reuse as you wish!
 * SAME(object) - Product returns `true` when matched with `#equal?`
 * SEND(name, pattern) - Basically provided for Enumerable
 * BOOLEAN() - Product returns `true` when matched to `true` or `false`
+* NIL() - Product returns `true` when matched to `nil` (Not consider `nil?`)
 * ANYTHING() - Product returns `true`, always `true`
 * NEVER() - Product returns `false`, always `false`
 * XOR(pattern1, pattern2) - Product returns `true` when matched one of the pattern, when matched both returns `false`
 * 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.
 
-* `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
+```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.build(&block)` - In the block scope, all builder methods can be used without receiver
+* `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
 
@@ -129,4 +153,4 @@ This gem provides [ruby/rbs](https://github.com/ruby/rbs) signatures
 
 ## NOTE
 
-* [`eqq` is the implementation name of `#===` in CRuby](https://github.com/ruby/ruby/blob/2a685da1fcd928530509e99f5edb4117bc377994/range.c#L1859)
+* ["eqq" is the implementation name of "#===" in CRuby](https://github.com/ruby/ruby/blob/2a685da1fcd928530509e99f5edb4117bc377994/range.c#L1859)

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
@@ -256,37 +256,46 @@ module Eqq
       product
     end
 
-    ANYTHING = ->_v { true }
-    define_inspect_on(ANYTHING, name: 'ANYTHING', arguments: [])
-    private_constant :ANYTHING
+    EQQ_BUILTIN_ANYTHING = ->_v { true }
+    define_inspect_on(EQQ_BUILTIN_ANYTHING, name: 'ANYTHING', arguments: [])
 
     # Product returns `true`, always `true`
     #
     # @return [Proc]
     def ANYTHING
-      ANYTHING
+      EQQ_BUILTIN_ANYTHING
     end
 
-    NEVER = ->_v { false }
-    define_inspect_on(NEVER, name: 'NEVER', arguments: [])
-    private_constant :NEVER
+    EQQ_BUILTIN_NEVER = ->_v { false }
+    define_inspect_on(EQQ_BUILTIN_NEVER, name: 'NEVER', arguments: [])
 
     # Product returns `false`, always `false`
     #
     # @return [Proc]
     def NEVER
-      NEVER
+      EQQ_BUILTIN_NEVER
     end
 
-    BOOLEAN = ->v { true.equal?(v) || false.equal?(v) }
-    define_inspect_on(BOOLEAN, name: 'BOOLEAN', arguments: [])
-    private_constant :BOOLEAN
+    EQQ_BUILTIN_BOOLEAN = ->v { true.equal?(v) || false.equal?(v) }
+    define_inspect_on(EQQ_BUILTIN_BOOLEAN, name: 'BOOLEAN', arguments: [])
 
     # Product returns `true` when matched to `true` or `false`
     #
     # @return [Proc]
     def BOOLEAN
-      BOOLEAN
+      EQQ_BUILTIN_BOOLEAN
     end
+
+    EQQ_BUILTIN_NIL = ->v { nil.equal?(v) }
+    define_inspect_on(EQQ_BUILTIN_NIL, name: 'NIL', arguments: [])
+
+    # Product returns `true` when matched to `nil` (Not consider `nil?`)
+    #
+    # @return [Proc]
+    def NIL
+      EQQ_BUILTIN_NIL
+    end
+
+    private_constant(:EQQ_BUILTIN_ANYTHING, :EQQ_BUILTIN_NEVER, :EQQ_BUILTIN_BOOLEAN, :EQQ_BUILTIN_NIL)
   end
 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.1.1'
 end

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,20 @@ module Eqq
       end
     end
 
-    # @return [#===]
-    # @raise [InvalidProductError] if the return value is invalid as a pattern object
-    def define(&block)
+    # @api private
+    def satisfy?(object)
+      (Proc === object) && object.lambda? && (object.arity == 1) && object.respond_to?(:inspect)
+    end
+
+    # In the block scope, all builder methods can be used without receiver
+    #
+    # @return [Proc]
+    # @raise [InvalidProductError] if the return value is not looks to be built with builders
+    def build(&block)
+      raise ArgumentError, 'might be mis used the `Eqq.build` in your code' unless block
+
       pattern = DSLScope.new.instance_exec(&block)
-      raise InvalidProductError unless valid?(pattern)
+      raise InvalidProductError, 'might be mis used the `Eqq.build` in your code' unless satisfy?(pattern)
 
       pattern
     end
@@ -47,5 +56,5 @@ module Eqq
   class DSLScope
     include Buildable
   end
-  private_constant :DSLScope
+  private_constant(:DSLScope)
 end

data/sig/eqq.rbs

@@ -17,13 +17,16 @@ module Eqq
     type product = patternable_lambda & _Inspectable
 
     # A private constant. Should not be used in your code.
-    ANYTHING: product
+    EQQ_BUILTIN_ANYTHING: product
 
     # A private constant. Should not be used in your code.
-    NEVER: product
+    EQQ_BUILTIN_NEVER: product
 
     # A private constant. Should not be used in your code.
-    BOOLEAN: product
+    EQQ_BUILTIN_BOOLEAN: product
+
+    # A private constant. Should not be used in your code.
+    EQQ_BUILTIN_NIL: product
 
     # A private API. Should not be used in your code.
     def self.safe_inspect_for: (untyped object)-> String
@@ -78,6 +81,9 @@ module Eqq
 
     # Product returns `true` when matched to `true` or `false`
     def BOOLEAN: () -> product
+
+    # Product returns `true` when matched to `nil` (Not consider `nil?`)
+    def NIL: () -> product
   end
 
   extend Buildable
@@ -98,8 +104,12 @@ module Eqq
   VERSION: String
 
   # Returns `true` when given object has patternable signature
-  def self.valid?: (untyped object) -> bool
+  def self.pattern?: (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
+  def self.build:  { () -> _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.1.1
 platform: ruby
 authors:
 - Kenichi Kamiya
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2022-05-09 00:00:00.000000000 Z
 dependencies: []
 description: |2
       Pattern objects builder.
@@ -38,7 +38,8 @@ metadata:
   homepage_uri: https://github.com/kachick/eqq
   source_code_uri: https://github.com/kachick/eqq
   bug_tracker_uri: https://github.com/kachick/eqq/issues
-post_install_message:
+  rubygems_mfa_required: 'true'
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -53,8 +54,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: Pattern objects builder
 test_files: []