memory_record 0.0.15 → 0.0.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5782c36c4656fbfea525ca83150171f5e7d72ef6e12c4a3bc5bb0c9cbebf999d
-  data.tar.gz: ae386371adb57bc10e97a3ec86c732eeb343fa53912ae7fc75fe6ddb41d15ae0
+  metadata.gz: b1ff4966063583e1b982805aaa2cb70ca4a4489498892280850e43b608def31a
+  data.tar.gz: 3efe77744703e2765bcc77f8e5888ba568ac5ba88ce29f7c1afaa13059e9fe86
 SHA512:
-  metadata.gz: 2c93d3d610e960a3a6b8da1041e8e6814de11ea93f5b341a18c39d8f80cf502b7bb05f1b07f1fa32fe575270809df31de441928bb0ec123cde3d0c02c7335a04
-  data.tar.gz: fb32e99ced614b0dc378662072f769e59d2bf28578537d48f734a078d793fc2b861f99bd96dff1496ed62ce80ddf10717ef4a861beff64a794ce4b00fd739866
+  metadata.gz: 34edd3b363bc9fe46aea07e9ea3626ece155a7cd5aefbafb90319a49a2d8c9a48dc7b23940478b40a19ea364a38ebe99e383ba9e620894dfa281e9f8c642b4ed
+  data.tar.gz: 371a5cd5f00281683650b9614b036b0bb70d964e8cd24b5bd147ef62de988be36ebc8887bc54a8b60bc019d7389fcd05b85697cbaea7258eca03389252500a12

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 /*.html
+*.ruby-version

data/README.md

@@ -27,7 +27,44 @@ $ bundle install
 
 ## Examples
 
-### Basic usage
+### Basic usage 1
+
+```ruby
+class Palette
+  include MemoryRecord
+  memory_record [
+    { key: :coral,  },
+    { key: :tomato, },
+    { key: :gold,   },
+  ]
+end
+
+Palette[:tomato].key   # => :tomato
+Palette[:tomato].name  # => "tomato"
+Palette[:tomato].code  # => 1
+```
+
+### Basic usage 2
+
+```ruby
+class Palette
+  include MemoryRecord
+  memory_record [
+    { key: :coral,  r: 255, g: 127, b:   0 },
+    { key: :tomato, r: 255, g:  99, b:  71 },
+    { key: :gold,   r: 255, g: 215, b:   0 },
+  ]
+end
+
+Palette[:tomato].key   # => :tomato
+Palette[:tomato].name  # => "tomato"
+Palette[:tomato].code  # => 1
+Palette[:tomato].r     # => 255
+Palette[:tomato].g     # => 99
+Palette[:tomato].b     # => 71
+```
+
+### Basic usage 3
 
 ```ruby
 class Palette
@@ -53,6 +90,7 @@ end
 
 Palette[:tomato].key   # => :tomato
 Palette[:tomato].name  # => "Tomato"
+Palette[:tomato].code  # => 1
 Palette[:tomato].rgb   # => [255, 99, 71]
 Palette[:tomato].hex   # => "#FF6347"
 Palette.collect(&:hex) # => ["#FF7F00", "#FF6347", "#FFD700"]
@@ -127,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
@@ -217,6 +275,7 @@ class ColorInfo
 end
 
 color_info = ColorInfo.first
+color_info.as_json                          # => {:key=>:blue, :rgb=>[0, 0, 255], :a=>1, :code=>0}
 color_info.as_json(only: :key)              # => {:key => :blue}
 color_info.as_json(except: [:rgb, :code])   # => {:key => :blue}
 color_info.as_json(only: [], methods: :hex) # => {:hex => "#0000FF"}
@@ -224,6 +283,7 @@ color_info.as_json(only: [], include: {children: {only: :x}} ) # => {:children =
 
 ColorInfo.as_json(only: :key)               # => [{:key=>:blue}, {:key=>:red}]
 ColorInfo.to_json(only: :key)               # => "[{\"key\":\"blue\"},{\"key\":\"red\"}]"
+```
 
 #### Case of ActiveModelSerializers
 

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/0320_as_json.rb

@@ -38,6 +38,7 @@ end
 
 ColorInfo.first.key             # => :blue
 
+ColorInfo.first.as_json                                             # => {:key=>:blue, :rgb=>[0, 0, 255], :a=>1, :code=>0}
 ColorInfo.first.as_json(only: :key)                                 # => {:key=>:blue}
 ColorInfo.first.as_json(except: [:rgb, :code, :a])                  # => {:key=>:blue}
 ColorInfo.first.as_json(only: [], methods: :hex)                    # => {:hex=>"#0000FF"}

data/examples/0330_active_model_serializers.rb

@@ -2,7 +2,7 @@ require "bundler/inline"
 
 gemfile do
   gem "memory_record", path: ".."
-  gem "active_model_serializers"
+  gem "active_model_serializers", "0.10.7" # It does not work with version 0.10.10
 end
 
 class ColorInfo
@@ -18,5 +18,5 @@ class ColorInfoSerializer < ActiveModel::Serializer
 end
 
 pp ActiveModelSerializers::SerializableResource.new(ColorInfo.first).as_json # => {:key=>:blue, :name=>"blue"}
-# >> [active_model_serializers] Rendered ColorInfoSerializer with ActiveModelSerializers::Adapter::Attributes (0.14ms)
+# >> [active_model_serializers] Rendered ColorInfoSerializer with ActiveModelSerializers::Adapter::Attributes (0.12ms)
 # >> {:key=>:blue, :name=>"blue"}

data/examples/0360_sub_class.rb

@@ -4,21 +4,21 @@ require 'memory_record'
 class A
   include MemoryRecord
   memory_record [
-    { key: :a, x: 1, y: 2 },
+    { key: :foo },
   ]
 
-  def z
-    x + y
+  def name
+    super.to_s.upcase
   end
 end
 
 class B < A
   memory_record_reset superclass.collect(&:attributes)
 
-  def z
-    super * 2
+  def name
+    "(#{super})"
   end
 end
 
-B.values # => [#<B:0x00007feea40395b8 @attributes={:key=>:a, :x=>1, :y=>2, :code=>0}>]
-B.first.z                       # => 6
+A.first.name                    # => "FOO"
+B.first.name                    # => "(FOO)"

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/serialization.rb

@@ -36,7 +36,7 @@ module MemoryRecord
       hash
     end
 
-    def as_json(**options)
+    def as_json(options = {})
       serializable_hash(options)
     end
 

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.15'
+  VERSION = '0.0.19'
 end

data/spec/memory_record_spec.rb

@@ -166,7 +166,7 @@ RSpec.describe MemoryRecord do
     def element(options)
       Class.new {
         include MemoryRecord
-        memory_record options do
+        memory_record **options do
           [
             {x: 1, y: 1, z: 1},
           ]
@@ -298,22 +298,38 @@ RSpec.describe MemoryRecord do
     end
   end
 
-  context 'active_model_serializers' do
-    require "active_model_serializers"
-
-    class ColorInfo
-      include MemoryRecord
-      memory_record [
-        { key: :blue, },
-      ]
-    end
-
-    class ColorInfoSerializer < ActiveModel::Serializer
-      attributes :key
-    end
-
+  # broken with version 0.10.10
+  # context 'active_model_serializers' do
+  #   require "active_model_serializers"
+  #
+  #   class ColorInfo
+  #     include MemoryRecord
+  #     memory_record [
+  #       { key: :blue, },
+  #     ]
+  #   end
+  #
+  #   class ColorInfoSerializer < ActiveModel::Serializer
+  #     attributes :key
+  #   end
+  #
+  #   it do
+  #     assert { ActiveModelSerializers::SerializableResource.new(ColorInfo.first).as_json == {:key => :blue} }
+  #   end
+  # end
+
+  describe "valid_key" do
     it do
-      assert { ActiveModelSerializers::SerializableResource.new(ColorInfo.first).as_json == {:key => :blue} }
+      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.15
+  version: 0.0.19
 platform: ruby
 authors:
 - akicho8
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-25 00:00:00.000000000 Z
+date: 2022-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -135,6 +135,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
@@ -146,7 +147,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -161,9 +162,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.4
+signing_key:
 specification_version: 4
 summary: A simple library that handles a few records easily
 test_files: