pattern_matchable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8232bcf22e17e7d55079ab42f11af82f9f612a55f8e9c2506a796bcd67da1116
-  data.tar.gz: f45d869e1679fe340a5f8e73139ed3de6f00038c9813fae20bb5e0d3d7b510d5
+  metadata.gz: e959ed23b722f0cf3e64745093f1cd6952d60265154eebb65357fca9742b8401
+  data.tar.gz: 48e3ec0052c4ec762fa0850f100195ed25146183dc4389813d963e30484d6824
 SHA512:
-  metadata.gz: 01c18ccf82903a74f7346f6858668ffb4d5a33d23b829cba43ade37dbce0be91c7c85515c1e7115b8af2346c5bd6064d02d6bdd72a48a424537966b7e5f00713
-  data.tar.gz: f21aa128c4329d7ec59978cba5ce931f47cbac4a29e6927e11351e3f5f1bd02ab1dacbebc363db9f2eac995fa9aef088cffdc75ff69a50a4993a679b9558c258
+  metadata.gz: 818c7f81876bd43f1e7e7f2a6f962cb48397a7b27d722ba7281c923a0ddbe7144aaefee4ee96b8a6909be0adbd49e1a2ad24f76965ee7ccf4bb4f8bc70d384a0
+  data.tar.gz: a61c65e11de5e9c72482b98f60d82b5cc8e76710c1b5c0f15607cb9ee93983d9c30f552656851d40c2f6a9c02ea6996def8536534286b04b0fb83ea1a40ac03e

data/.github/workflows/main.yml

@@ -0,0 +1,28 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - master
+
+  pull_request:
+
+jobs:
+  pattern_matchable:
+    name: >-
+      pattern_matchable ${{ matrix.os }} ${{ matrix.ruby }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest, macos-latest, windows-latest ]
+        ruby: [ 'head', '3.2', '3.1', '3.0' ]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/README.md

@@ -23,62 +23,31 @@ Or install it yourself as:
 ```ruby
 require "pattern_matchable"
 
-class Array
-  # defined #deconstruct_keys
-  include PatternMatchable
-end
+using PatternMatchable Array
 
 case [1, 2, 3]
 in first:, last:
   pp "OK : #{first}, #{last}"
   # => "OK : 1, 3"
 end
-
-
-class Time
-  include PatternMatchable
-
-  def to_four_seasons
-    case self
-    in month: (3..5)
-      "spring"
-    in month: (6..8)
-      "summer"
-    in month: (9..11)
-      "autumn"
-    in { month: (1..2) } | { month: 12 }
-      "winter"
-    end
-  end
-end
-
-p Time.local(2019, 1, 1).to_four_seasons   # => "winter"
-p Time.local(2019, 3, 1).to_four_seasons   # => "spring"
-p Time.local(2019, 5, 1).to_four_seasons   # => "spring"
-p Time.local(2019, 8, 1).to_four_seasons   # => "summer"
-p Time.local(2019, 10, 1).to_four_seasons  # => "autumn"
-p Time.local(2019, 12, 1).to_four_seasons  # => "winter"
 ```
 
-### 1. `include PatternMatchable`
+### 1. `using PatternMatchable {class names}`
 
-`include` and add `#deconstruct_keys` to any class / module.
+Use Refinements to add `{class names}#deconstruct_keys`.
 
 ```ruby
 require "pattern_matchable"
 
-# mixin PatternMatchable to Array
-# defined Array#deconstruct_keys
-class Array
-  include PatternMatchable
-end
+# define Array#deconstruct_keys
+using PatternMatchable Array
 
-[1, 2, 3, 4, 5] in { first:, last: }
+[1, 2, 3, 4, 5] => { first:, last: }
 p first  # => 1
 p last   # => 5
 
-# error: NoMatchingPatternError
 "Homu" in { downcase:, upcase: }
+# => false
 ```
 
 ### 2. `using PatternMatchable`
@@ -91,16 +60,46 @@ require "pattern_matchable"
 # defined Object#deconstruct_keys
 using PatternMatchable
 
-[1, 2, 3, 4, 5] in { first:, last: }
+case [1, 2, 3, 4, 5]
+in { first:, last: }
+end
 p first  # => 1
 p last   # => 5
 
-"Homu" in { downcase:, upcase: }
+case "Homu"
+in { downcase:, upcase: }
+end
 p downcase   # => "homu"
 p upcase     # => "HOMU"
 ```
 
-### 3. `using PatternMatchable.refining klass`
+### 3. `include PatternMatchable`
+
+`include` and add `#deconstruct_keys` to any class / module.
+
+```ruby
+require "pattern_matchable"
+
+# mixin PatternMatchable to Array
+# defined Array#deconstruct_keys
+class Array
+  include PatternMatchable
+end
+
+# OK: assigned `first` `last` variables
+case [1, 2, 3, 4, 5]
+in { first:, last: }
+end
+p first  # => 1
+p last   # => 5
+
+# error: NoMatchingPatternError
+case "Homu"
+in { downcase:, upcase: }
+end
+```
+
+### 4. `using PatternMatchable.refining klass`
 
 Add `#deconstruct_keys` to any class / module using Refinements.
 
@@ -110,15 +109,17 @@ require "pattern_matchable"
 # define Array#deconstruct_keys
 using PatternMatchable.refining Array
 
-[1, 2, 3, 4, 5] in { first:, last: }
+[1, 2, 3, 4, 5] => { first:, last: }
 p first  # => 1
 p last   # => 5
 
 # error: NoMatchingPatternError
-"Homu" in { downcase:, upcase: }
+case "Homu"
+in { downcase:, upcase: }
+end
 ```
 
-### 4. `using PatternMatchable::#{class name}`
+### 5. `using PatternMatchable::#{class name}`
 
 Use `Refinements` using `const_missing`.
 
@@ -128,7 +129,9 @@ require "pattern_matchable"
 # define Array#deconstruct_keys
 using PatternMatchable::Array
 
-[1, 2, 3, 4, 5] in { first:, last: }
+case [1, 2, 3, 4, 5]
+in { first:, last: }
+end
 p first  # => 1
 p last   # => 5
 
@@ -136,14 +139,71 @@ p last   # => 5
 # defined Enumerator::Lazy
 using PatternMatchable::Enumerator::Lazy
 
-(1..10).lazy.map { _1 * 2 } in { first:, count: }
+(1..10).lazy.map { _1 * 2 } => { first:, count: }
 p first  # => 2
 p count  # => 10
 
-# error: NoMatchingPatternError
 "Homu" in { downcase:, upcase: }
+# => false
+```
+
+## NOTE: Classes with `#deconstruct_keys` or `#respond_to?` defined will not work with `using PatternMatchable`.
+
+```ruby
+require "pattern_matchable"
+
+class X
+  def respond_to?(...)
+    super
+  end
+end
+
+using PatternMatchable
+
+# NoMatchingPatternKeyError
+case { name: "homu", age: 14 }
+in { first:, count: }
+else
+end
+
+
+# NoMatchingPatternKeyError
+case X.new
+in { __id__: }
+else
+end
 ```
 
+For example, `ActiveRecord::Base`.
+In this case, you must use `using PatternMatchable X`.
+
+```ruby
+require "pattern_matchable"
+
+class X
+  def respond_to?(...)
+    super
+  end
+end
+
+using PatternMatchable Hash
+using PatternMatchable X
+
+case { name: "homu", age: 14 }
+in { first:, count: }
+  pp "ok: #{first}: #{count}"
+  # => "ok: [:name, \"homu\"]: 2"
+else
+end
+
+
+case X.new
+in { __id__: }
+  pp "ok: #{__id__}"
+  # => "ok: 880"
+else
+end
+```
 
 ## Development
 

data/lib/pattern_matchable/version.rb

@@ -1,3 +1,3 @@
 module PatternMatchable
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/pattern_matchable.rb

@@ -1,4 +1,4 @@
-require "pattern_matchable/version"
+require_relative "pattern_matchable/version"
 
 module PatternMatchable
   def deconstruct_keys(keys)
@@ -6,18 +6,36 @@ module PatternMatchable
   end
 
   refine Object do
-    include PatternMatchable
+    if defined?(import_methods)
+      import_methods PatternMatchable
+    else
+      include PatternMatchable
+    end
   end
 
-  def self.refining(klass)
+  def self.refining(*klasses)
     Module.new {
-      refine klass do
-        include PatternMatchable
-      end
+      klasses.each do |klass|
+        refine klass do
+          def deconstruct_keys(keys)
+            if defined? super
+              super.then { |result|
+                result.merge((keys - result.keys).to_h { [_1, public_send(_1)] })
+              }
+            else
+              keys.to_h { [_1, public_send(_1)] }
+            end
+          end
+
+          def respond_to?(name, ...)
+            name == :deconstruct_keys || super
+          end
+        end
 
-      define_singleton_method(:const_missing) { |nested_name|
-        PatternMatchable.refining Object.const_get("#{klass.name}::#{nested_name}")
-      }
+        define_singleton_method(:const_missing) { |nested_name|
+          PatternMatchable.refining Object.const_get("#{klass.name}::#{nested_name}")
+        }
+      end
     }
   end
 
@@ -25,3 +43,7 @@ module PatternMatchable
     self.refining(Object.const_get(klass_name))
   end
 end
+
+def PatternMatchable(*klasses)
+  PatternMatchable.refining *klasses
+end

data/pattern_matchable.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{call method with pattern match.}
   spec.description   = %q{call method with pattern match.}
-  spec.homepage      = ""
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.homepage      = "https://github.com/osyo-manga/gem-pattern_matchable"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pattern_matchable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - manga_osyo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-11 00:00:00.000000000 Z
+date: 2023-11-16 00:00:00.000000000 Z
 dependencies: []
 description: call method with pattern match.
 email:
@@ -17,6 +17,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -28,7 +29,7 @@ files:
 - lib/pattern_matchable.rb
 - lib/pattern_matchable/version.rb
 - pattern_matchable.gemspec
-homepage: ''
+homepage: https://github.com/osyo-manga/gem-pattern_matchable
 licenses: []
 metadata: {}
 post_install_message: 
@@ -39,14 +40,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.4.6
 signing_key: 
 specification_version: 4
 summary: call method with pattern match.