memory_record 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a31161518612170878b45f58d9952e75403826b6ed1a3345e3a116b81b8b24c
-  data.tar.gz: d0c23e8933f7576c00608b5cc1f5fe233b3f609db3371d22b5ac25e08d198d02
+  metadata.gz: a4e8c3d1cda033561e441032be32332be1327c9876a4a62d0d64cac44b024f99
+  data.tar.gz: 2b9fed19a0944263ac9d0895677018537557c5f4d2d5bba9b4536f02c97f517c
 SHA512:
-  metadata.gz: 830f15f5f99178dc80e2f142d10aa4dd7f23431aca3ede47bb3591624d1e98e190485500742eb2622487f929cecd56f5507252b7b4941727e83315bc00ff4cad
-  data.tar.gz: bd185cef177836f31268c760225e7df2935f5f42921420168819f4007543d8108046b0d4f7bd76d3e5fb41d61ed83ff726d6d3bf3973f06e6c382278129e6d29
+  metadata.gz: 8412d6ec55aaea46004a97a34d111e66c0a5fc5901ad975f2714842087f5a5168935920f752f426930fa1967816950c742a4a4f14c9e03951d9fdf248e372565
+  data.tar.gz: 3d994cce8445425741eb6245b65dfac26d7dae8253062ea8b9a5694f32baab72be36d4b1b167c29cc8fe26c68b662ce4a1d96ab345aee008b145a767e429175e

data/README.md

@@ -171,7 +171,7 @@ Foo.first.y rescue $! # => 1
 Foo.first.z rescue $! # => #<NoMethodError: undefined method `z' for #<Foo:0x007fcc861ff108>>
 ```
 
-*** How to decide **code** yourself?
+### How to decide **code** yourself?
 
 ```ruby
 class Foo
@@ -187,3 +187,33 @@ Foo.collect(&:code) # => [1, 2]
 
 It is not recommended to specify it explicitly.
 It is useful only when refactoring legacy code with compatibility in mind.
+
+### Convert to JSON
+
+Similar to ActiveModel's serialization, there is an `only` `except` `methods` `include` method.
+
+```ruby
+class ColorInfo
+  include MemoryRecord
+  memory_record [
+    { key: :blue, rgb: [  0, 0, 255], },
+    { key: :red,  rgb: [255, 0,   0], },
+  ]
+
+  def hex
+    "#" + rgb.collect { |e| "%02X" % e }.join
+  end
+
+  def children
+    [
+      {foo: 1, bar: 3},
+      {foo: 2, bar: 4},
+    ]
+  end
+end
+
+ColorInfo.first.as_json(only: :key)              # => {:key => :blue}
+ColorInfo.first.as_json(except: [:rgb, :code])   # => {:key => :blue}
+ColorInfo.first.as_json(only: [], methods: :hex) # => {:hex => "#0000FF"}
+ColorInfo.first.as_json(only: [], include: {children: {only: :foo}} ).should == {:children => [{"foo" => 1}, {"foo" => 2}]}
+```

data/examples/0320_as_json.rb

@@ -0,0 +1,42 @@
+$LOAD_PATH.unshift '../lib'
+require 'memory_record'
+
+if true
+  require "active_model"
+
+  class Person
+    include ActiveModel::Model
+    include ActiveModel::Serializers::JSON
+
+    attr_accessor :a
+
+    def attributes
+      {'a' => a}
+    end
+  end
+end
+
+class ColorInfo
+  include MemoryRecord
+  memory_record [
+    { key: :blue, rgb: [  0, 0, 255], a: 1},
+    { key: :red,  rgb: [255, 0,   0], a: 2},
+  ]
+
+  def hex
+    "#" + rgb.collect { |e| "%02X" % e }.join
+  end
+
+  def children
+    [
+      {a: 1, b: 2},
+      Person.new(a: 1),
+      ColorInfo[:blue],
+    ]
+  end
+end
+
+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"}
+ColorInfo.first.as_json(only: [], include: {children: {only: :a}} ) # => {:children=>[{"a"=>1}, {"a"=>1}, {:a=>1}]}

data/lib/memory_record/memory_record/serialization.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "active_support/core_ext/hash/except"
+require "active_support/core_ext/hash/slice"
+
+module MemoryRecord
+  # Reference: ActiveModel::Serializers::JSON
+  # https://github.com/rails/rails/blob/0605f45ab323331b06dde3ed16838f56f141ca3f/activemodel/lib/active_model/serialization.rb
+  # The original code and the implementation are slightly different
+  module Serialization
+    def serializable_hash(options = nil)
+      options ||= {}
+
+      keys = attributes.keys
+      if only = options[:only]
+        keys &= Array(only)
+      elsif except = options[:except]
+        keys -= Array(except)
+      end
+      keys += Array(options[:methods])
+
+      hash = {}
+      keys.each { |e| hash[e] = send(e) }
+      Array(options[:methods]).each { |e| hash[e] = send(e) }
+
+      serializable_add_includes(options) do |association, records, opts|
+        hash[association] = -> {
+          if records.respond_to?(:to_ary)
+            records.to_ary.map { |a| a.as_json(opts) }
+          else
+            records.as_json(opts)
+          end
+        }.call
+      end
+
+      hash
+    end
+
+    def as_json(**options)
+      serializable_hash(options)
+    end
+
+    private
+
+    # Add associations specified via the <tt>:include</tt> option.
+    #
+    # Expects a block that takes as arguments:
+    #   +association+ - name of the association
+    #   +records+     - the association record(s) to be serialized
+    #   +opts+        - options for the association records
+    def serializable_add_includes(options = {}) #:nodoc:
+      return unless includes = options[:include]
+
+      unless includes.is_a?(Hash)
+        includes = Hash[Array(includes).flat_map { |n| n.is_a?(Hash) ? n.to_a : [[n, {}]] }]
+      end
+
+      includes.each do |association, opts|
+        if records = send(association)
+          yield association, records, opts
+        end
+      end
+    end
+  end
+end

data/lib/memory_record/memory_record.rb

@@ -4,6 +4,10 @@ require 'active_support/core_ext/module/concerning'
 require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/module/delegation'
 
+# json serialization
+require 'active_support/core_ext/object/json' # as_json
+require 'memory_record/memory_record/serialization'
+
 module MemoryRecord
   extend ActiveSupport::Concern
 
@@ -33,6 +37,7 @@ module MemoryRecord
 
       extend Enumerable
       include ::MemoryRecord::SingletonMethods
+      include ::MemoryRecord::Serialization
 
       class_attribute :memory_record_options
       self.memory_record_options = {

data/lib/memory_record/version.rb

@@ -1,3 +1,3 @@
 module MemoryRecord
-  VERSION = '0.0.12'
+  VERSION = '0.0.13'
 end

data/memory_record.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'activemodel'
 
   spec.add_dependency 'activesupport'
 end

data/spec/memory_record_spec.rb

@@ -235,4 +235,46 @@ RSpec.describe MemoryRecord do
     h[a] = true
     h[b].should == true
   end
+
+  context 'as_json' do
+    require "active_model"
+
+    class Person
+      include ActiveModel::Model
+      include ActiveModel::Serializers::JSON
+
+      attr_accessor :a
+
+      def attributes
+        {'a' => a}
+      end
+    end
+
+    class ColorInfo
+      include MemoryRecord
+      memory_record [
+        { key: :blue, rgb: [  0, 0, 255], a: 1},
+        { key: :red,  rgb: [255, 0,   0], a: 2},
+      ]
+
+      def hex
+        "#" + rgb.collect { |e| "%02X" % e }.join
+      end
+
+      def children
+        [
+          {a: 1, b: 2},
+          Person.new(a: 1),
+          ColorInfo[:blue],
+        ]
+      end
+    end
+
+    it "as_json(options)" do
+      ColorInfo.first.as_json(only: :key).should                                 == {:key => :blue}
+      ColorInfo.first.as_json(except: [:rgb, :code, :a]).should                  == {:key => :blue}
+      ColorInfo.first.as_json(only: [], methods: :hex).should                    == {:hex => "#0000FF"}
+      ColorInfo.first.as_json(only: [], include: {children: {only: :a}} ).should == {:children => [{"a" => 1}, {"a" => 1}, {:a => 1}]}
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: memory_record
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - akicho8
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-17 00:00:00.000000000 Z
+date: 2018-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -102,8 +116,10 @@ files:
 - examples/0290_eql_behavior.rb
 - examples/0300_use_as_hash_key.rb
 - examples/0310_same_if_dup.rb
+- examples/0320_as_json.rb
 - lib/memory_record.rb
 - lib/memory_record/memory_record.rb
+- lib/memory_record/memory_record/serialization.rb
 - lib/memory_record/version.rb
 - memory_record.gemspec
 - spec/memory_record_spec.rb