eqq 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22307661e329771fea7efcd7c282d17eda0130d0edb7aec3088257b21b73e4ba
-  data.tar.gz: ebc3138ade59e38f9bc34a42a93654d3a6ab1564a48b47df13d65ed7227c7488
+  metadata.gz: 53f4f6ec548d800742874bd0d98b015891227be295c9b22a0a3cb89eafce301b
+  data.tar.gz: 58d3f0a0513a7a4eff20d5aea9d60682d415e1582bc7fd9f39166894d03c75da
 SHA512:
-  metadata.gz: 16ae2b50b3c81291028946ec6ddb8753c06bc7fc472f29ab00b3f69b9136540f26079b8c23f983d0bf1482f93543744f2fae557bb0ef71f6fdcc73f115df9455
-  data.tar.gz: eced8529614ce3b1b8a4cc4087d58943bdbaabd0637a86bb10bcafe472ccdece82bae71d390fde84e95176318961e4ef74207ab4debc6e117411608f2e074176
+  metadata.gz: 0eb69ecb3e22473df10aa8256191d03d02cfbd0cc7243d096c574d56f3d00e1932bda1b5d58fe3504b5da7cd68cdd0fb5c59ca91bba94bdef60a9e65d21eaf6e
+  data.tar.gz: 8d0393dc91eef5a40e144ab72e374e422f75302ca3b187bb8b24014ff074eca187c84ddd060e9344e3d5b75d56ed34b75e8869ed5d3cb5812f7a59a3080500b1

data/README.md

@@ -12,7 +12,7 @@ Require Ruby 2.6 or later
 Add below code into your Gemfile
 
 ```ruby
-gem 'eqq', '0.0.3'
+gem 'eqq', '0.0.4'
 ```
 
 ### Overview
@@ -63,6 +63,15 @@ ret_in_case = (
 )
 
 p ret_in_case #=> Should be matched here! :)
+
+class MyClass
+  include Eqq::Buildable
+
+  def example
+    [4.2, 42, 42.0, 420].grep(OR(AND(Float, 20..50), Integer))
+  end
+end
+MyClass.new.example #=> [42, 42.0, 420]
 ```
 
 ### Explanation
@@ -86,34 +95,36 @@ They can take this interface as the `pattern`.
 And you already saw. All of patterns can be mixed with other patterns as a parts.
 Reuse as you wish!
 
-Major builders as below
+### Builders
 
-* OR(*patterns) - Product returns true when matched even one pattern
-* AND(*patterns) - Product returns true when matched all patterns
-* NOT(pattern) - Product returns true when not matched the pattern
-* CAN(*method_names) - Product returns true when it has all of the methods (checked with `respond_to?`)
-* RESCUE(exception_class/module, pattern) - Product returns true when the pattern raises the exception
-* QUIET(*patterns) - Product returns true when all patterns did not raise any exception
-* EQ(object) - Product returns true when matched with `#==`
-* 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
-* ANYTHING() - Product returns true, always true
+* OR(*patterns) / {Eqq::Buildable#OR} - Product returns `true` when matched even one pattern
+* AND(*patterns) / {Eqq::Buildable#AND} - Product returns `true` when matched all patterns
+* NOT(pattern) / {Eqq::Buildable#NOT} - Product returns `true` when not matched the pattern
+* CAN(*method_names) / {Eqq::Buildable#CAN} - Product returns `true` when it has all of the methods (checked with `respond_to?`)
+* RESCUE(exception_class/module, pattern) / {Eqq::Buildable#RESCUE} - Product returns `true` when the pattern raises the exception
+* QUIET(*patterns) / {Eqq::Buildable#QUIET} - Product returns `true` when all patterns did not raise any exception
+* EQ(object) / {Eqq::Buildable#EQ} - Product returns `true` when matched with `#==`
+* SAME(object) / {Eqq::Buildable#SAME} - Product returns `true` when matched with `#equal?`
+* SEND(name, pattern) / {Eqq::Buildable#SEND} - Basically provided for Enumerable
+* BOOLEAN() / {Eqq::Buildable#BOOLEAN} - Product returns `true` when matched to `true` or `false`
+* ANYTHING() / {Eqq::Buildable#ANYTHING} - Product returns `true`, always `true`
+* XOR(pattern1, pattern2) / {Eqq::Buildable#XOR} - Product returns `true` when matched one of the pattern, when matched both returns `false`
+* NAND(*patterns) / {Eqq::Buildable#NAND} - Product is inverted {Eqq::Buildable#AND}
+* NOR(*patterns) / {Eqq::Buildable#NOR} - Product is inverted {Eqq::Buildable#OR}
 
-Minor builders as below, please see [API documents](https://kachick.github.io/eqq) for them.
+### Additional information
 
-* NAND
-* NOR
-* XOR
+When you feel annoy to write `Eqq` in many place, 2 ways exist.
 
-When you feel annoy to write `Eqq` in many place, please use `Eqq.define`.
-In the block scope, all builder methods can be used without receiver specifying.
+* `Eqq.define` - 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
 
-This gem provide [ruby/rbs](https://github.com/ruby/rbs) signature
+This gem provides [ruby/rbs](https://github.com/ruby/rbs) signatures
 
 ## Links
 
 * [Repository](https://github.com/kachick/eqq)
+* [API documents](https://kachick.github.io/eqq)
 
 ## NOTE
 

data/lib/eqq.rb

@@ -6,8 +6,12 @@
 
 require_relative 'eqq/version'
 
+# Pattern objects builder
 module Eqq
+  # Base error of this library
   class Error < StandardError; end
+
+  # Raised when found some products are invalid as a pattern object
   class InvalidProductError < Error; end
 
   class << self
@@ -25,6 +29,7 @@ module Eqq
     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)
@@ -42,4 +47,5 @@ module Eqq
   class DSLScope
     include Buildable
   end
+  private_constant :DSLScope
 end

data/lib/eqq/buildable.rb

@@ -2,10 +2,11 @@
 # frozen_string_literal: true
 
 module Eqq
+  # Actually having definitions for the pattern builders
   module Buildable
-    extend self
-
     class << self
+      # When the inspection is failed some unexpected reasons, it will fallback to this value
+      # This value is not fixed as a spec, might be changed in future
       INSPECTION_FALLBACK = 'UninspectableObject'
 
       # @api private
@@ -43,6 +44,8 @@ module Eqq
       end
     end
 
+    # Product returns `true` when matched all patterns
+    #
     # @param pattern1 [Proc, Method, #===]
     # @param pattern2 [Proc, Method, #===]
     # @param patterns [Array<Proc, Method, #===>]
@@ -60,6 +63,8 @@ module Eqq
       product
     end
 
+    # Product is inverted {#AND}
+    #
     # @param pattern1 [Proc, Method, #===]
     # @param pattern2 [Proc, Method, #===]
     # @param patterns [Array<Proc, Method, #===>]
@@ -68,6 +73,8 @@ module Eqq
       NOT(AND(pattern1, pattern2, *patterns))
     end
 
+    # Product returns `true` when matched even one pattern
+    #
     # @param pattern1 [Proc, Method, #===]
     # @param pattern2 [Proc, Method, #===]
     # @param patterns [Array<Proc, Method, #===>]
@@ -84,6 +91,8 @@ module Eqq
       product
     end
 
+    # Product is inverted {#OR}
+    #
     # @param pattern1 [Proc, Method, #===]
     # @param pattern2 [Proc, Method, #===]
     # @param patterns [Array<Proc, Method, #===>]
@@ -92,6 +101,8 @@ module Eqq
       NOT(OR(pattern1, pattern2, *patterns))
     end
 
+    # Product returns `true` when matched one of the pattern, when matched both returns `false`
+    #
     # @param pattern1 [Proc, Method, #===]
     # @param pattern2 [Proc, Method, #===]
     # @return [Proc]
@@ -107,6 +118,8 @@ module Eqq
       product
     end
 
+    # Product returns `true` when not matched the pattern
+    #
     # @param pattern [Proc, Method, #===]
     # @return [Proc]
     def NOT(pattern)
@@ -119,6 +132,8 @@ module Eqq
       product
     end
 
+    # Product returns `true` when matched with `#==`
+    #
     # @param obj [#==]
     # @return [Proc]
     def EQ(obj)
@@ -127,6 +142,8 @@ module Eqq
       end
     end
 
+    # Product returns `true` when matched with `#equal?`
+    #
     # @param obj [#equal?]
     # @return [Proc]
     def SAME(obj)
@@ -135,6 +152,8 @@ module Eqq
       end
     end
 
+    # Product returns `true` when it has all of the methods (checked with `respond_to?`)
+    #
     # @param message1 [Symbol, String, #to_sym]
     # @param messages [Array<Symbol, String, #to_sym>]
     # @return [Proc]
@@ -162,6 +181,8 @@ module Eqq
       product
     end
 
+    # Product returns `true` when all patterns did not raise any exception
+    #
     # @param pattern1 [Proc, Method, #===]
     # @param patterns [Array<Proc, Method, #===>]
     # @return [Proc]
@@ -186,6 +207,8 @@ module Eqq
       product
     end
 
+    # Product returns `true` when the pattern raises the exception
+    #
     # @param mod [Module]
     # @param pattern [Proc, Method, #===]
     # @return [Proc]
@@ -209,6 +232,8 @@ module Eqq
       product
     end
 
+    # Basically provided for Enumerable
+    #
     # @param name [Symbol, String, #to_sym]
     # @param pattern [Proc, Method, #===]
     # @return [Proc]
@@ -235,15 +260,20 @@ module Eqq
     Buildable.set_inspect(name: 'ANYTHING', product: ANYTHING, arguments: [])
     private_constant :ANYTHING
 
-    # @return [ANYTHING]
+    # Product returns `true`, always `true`
+    #
+    # @return [Proc]
     def ANYTHING
       ANYTHING
     end
 
-    BOOLEAN = OR(SAME(true), SAME(false))
+    BOOLEAN = ->v { true.equal?(v) || false.equal?(v) }
+    Buildable.set_inspect(name: 'BOOLEAN', product: BOOLEAN, arguments: [])
     private_constant :BOOLEAN
 
-    # @return [BOOLEAN]
+    # Product returns `true` when matched to `true` or `false`
+    #
+    # @return [Proc]
     def BOOLEAN
       BOOLEAN
     end

data/lib/eqq/version.rb

@@ -2,5 +2,6 @@
 # frozen_string_literal: true
 
 module Eqq
-  VERSION = '0.0.3'
+  # This will be same as latest published gem version
+  VERSION = '0.0.4'
 end

data/sig/eqq.rbs

@@ -30,7 +30,6 @@ module Eqq
     # A private API. Should not be used in your code.
     def self.validate_patterns: (*untyped) -> void
 
-    extend Buildable
     def OR: (_Patternable, _Patternable, *_Patternable) -> product
     def AND: (_Patternable, _Patternable, *_Patternable) -> product
     def NAND: (_Patternable, _Patternable, *_Patternable) -> product

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eqq
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kenichi Kamiya
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-02 00:00:00.000000000 Z
+date: 2021-06-03 00:00:00.000000000 Z
 dependencies: []
 description: "    [4.2, 42, 42.0, 420].grep(Eqq.AND(Integer, 20..50)) #=> [42]\n"
 email: