memory_record 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd17d93951ecd00a25da9401976fd6001479b0a259064154d5871459b9d28f86
-  data.tar.gz: b14110ba80d0173912f0cfc75ea7f1ff8c193f07b5ffb87e7886bf23f91482e9
+  metadata.gz: 398cef71aad0b7039708dc1384634c230d52686183cfdc97f4b89fc9eac151c1
+  data.tar.gz: 246e934baa307893bf03ca5bf9784f1dc33fb8171f489956c736820ab4665cd6
 SHA512:
-  metadata.gz: 1500621e070dcce0990e6a51b72aece8cdd85fb127f27bf50f0622f770db76d3beabac8ec851e28f0f04bb1e147fd9a52c59d96f706a8b236a20ddd34356310c
-  data.tar.gz: c5560f63361c6770e9f3e0d79e61fa547930112a2cf61250ba8dd846d1b212d7666f4fa7122fcd6a2e9cd7ea125eefd46f5921a5ad1cac035a5dac6e3bab5dab
+  metadata.gz: 8ccc73b6b361000a2225f2f5afe0c1e311379ac176da62678fc1b08e6897dfb6c981d3baa830b52deee9b47917a4b41d2ea471d8ab8c2c2ba3522cd20697a112
+  data.tar.gz: 97f19afba6b7455bf82779794338d97a457028802ca093cd1b0aa766a1a62c8e1596ae9aa536834946bd0c47c7c63d5ffe04da9bd99cb866017d983eb0f05881

data/.ruby-version

@@ -0,0 +1 @@
+2.6.5

data/README.md

@@ -165,6 +165,26 @@ Palette.fetch_if(:tomato)        # => #<Palette:... @attributes={...}>
 Palette.fetch_if(:xxx)           # => <KeyError: ...>
 ```
 
+### Key validation
+
+```ruby
+Palette.valid_key(:tomato)          # => :tomato
+Palette.valid_key("tomato")         # => :tomato
+Palette.valid_key(1)                # => :tomato
+Palette.valid_key(:xxx)             # => nil
+Palette.valid_key(:xxx, :tomato)    # => :tomato
+Palette.valid_key(:xxx) { :tomato } # => :tomato
+
+Palette.valid_key(:xxx, :tomato)          # => :tomato
+Palette.valid_key(:xxx, :black) rescue $! # => #<KeyError: Palette.fetch(:black) does not match anything
+```
+
+#### A common example in Rails
+
+```ruby
+palette_key = Palette.valid_key(params[:palette_key], :tomato)
+```
+
 ### How to refer to other keys
 
 ```ruby

data/examples/0100_basic.rb

@@ -27,3 +27,13 @@ Palette[:tomato].name       # => "Tomato"
 Palette[:tomato].rgb        # => [255, 99, 71]
 Palette[:tomato].hex        # => "#FF6347"
 Palette.collect(&:hex)      # => ["#FF7F00", "#FF6347", "#FFD700"]
+
+Palette.valid_key(:tomato)          # => :tomato
+Palette.valid_key("tomato")         # => :tomato
+Palette.valid_key(1)                # => :tomato
+Palette.valid_key(:xxx)             # => nil
+Palette.valid_key(:xxx, :tomato)    # => :tomato
+Palette.valid_key(:xxx) { :tomato } # => :tomato
+
+Palette.valid_key(:xxx, :tomato) # => :tomato
+Palette.valid_key(:xxx, :black) rescue $! # => #<KeyError: Palette.fetch(:black) does not match anything

data/examples/0370_valid_key.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift '../lib'
+require 'memory_record'
+
+class Color
+  include MemoryRecord
+  memory_record [
+    { key: :blue },
+  ]
+end
+
+Color.valid_key(:blue)                       # => :blue
+Color.valid_key(:unknown)                    # => nil
+Color.valid_key(:unknown, :blue)             # => :blue
+Color.valid_key(:unknown) { :blue }          # => :blue
+Color.valid_key(:unknown) { :xxx } rescue $! # => #<KeyError: Color.fetch(:xxx) does not match anything

data/lib/memory_record/memory_record.rb

@@ -15,16 +15,16 @@ module MemoryRecord
     # Example
     #
     #   memory_record [
-    #     {id: 1, name: "alice"},
-    #     {id: 2, name: "bob"  },
+    #     { id: 1, name: "alice" },
+    #     { id: 2, name: "bob"   },
     #   ], attr_reader: false
     #
     # or
     #
     #   memory_record(attr_reader: false) do
     #     [
-    #       {id: 1, name: "alice"},
-    #       {id: 2, name: "bob"  },
+    #       { id: 1, name: "alice" },
+    #       { id: 2, name: "bob"   },
     #     ]
     #   end
     #
@@ -152,6 +152,25 @@ module MemoryRecord
         end
       end
 
+      # Color.valid_key(:blue)              # => :blue
+      # Color.valid_key(:unknown)           # => nil
+      # Color.valid_key(:unknown, :blue)    # => :blue
+      # Color.valid_key(:unknown) { :blue } # => :blue
+      # Color.valid_key(:unknown) { :xxx  } # => KeyError Exception
+      def valid_key(key, default = nil, &block)
+        if block_given? && default
+          raise ArgumentError, "Can't use default and block together"
+        end
+
+        if e = lookup(key)
+          e.key
+        elsif block_given?
+          fetch(yield).key
+        elsif default
+          fetch(default).key
+        end
+      end
+
       delegate :each, to: :values
 
       def keys

data/lib/memory_record/version.rb

@@ -1,3 +1,3 @@
 module MemoryRecord
-  VERSION = '0.0.17'
+  VERSION = '0.0.18'
 end

data/spec/memory_record_spec.rb

@@ -317,4 +317,19 @@ RSpec.describe MemoryRecord do
   #     assert { ActiveModelSerializers::SerializableResource.new(ColorInfo.first).as_json == {:key => :blue} }
   #   end
   # end
+
+  describe "valid_key" do
+    it do
+      model = class_new [
+        { key: :blue },
+      ]
+      assert { model.valid_key(:blue)              ==  :blue }
+      assert { model.valid_key(:unknown)           ==  nil   }
+      assert { model.valid_key(:unknown, :blue)    ==  :blue }
+      assert { model.valid_key(:unknown) { :blue } ==  :blue }
+      assert { model.valid_key(:unknown) { :blue } ==  :blue }
+      assert_raises(KeyError) { model.valid_key(:unknown) { :xxx } }
+      assert_raises(KeyError) { model.valid_key(:unknown, :xxx) }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memory_record
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - akicho8
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-30 00:00:00.000000000 Z
+date: 2020-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -103,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -135,6 +136,7 @@ files:
 - examples/0340_comparable.rb
 - examples/0350_power_assert.rb
 - examples/0360_sub_class.rb
+- examples/0370_valid_key.rb
 - lib/memory_record.rb
 - lib/memory_record/memory_record.rb
 - lib/memory_record/memory_record/serialization.rb