alba 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a21e18114f54b4039fc354a92a248e3bb6d1d67680c086d8d7827ef201ffec0
-  data.tar.gz: 507160ee7625df8bfb18955cca17b1eef804be1783ce4c61fac8f383eeac6301
+  metadata.gz: 62d87c709e80629fa4f9373e113a141da7489703d309fd1ed6b9b411e427a101
+  data.tar.gz: 3aacb3b018632b50cd2c71052c783e6aae97d6d79c2d1f0bb107ba07cc0d5bbd
 SHA512:
-  metadata.gz: e97a450e7cbfaea63a048d20c396b6abfaae1cc55957e2e07cc1170fe4be5cc4174d807c1c398fb2534d120e9c3fa0cbb6f8cc9dd5c7026ddb448577a66ddf0f
-  data.tar.gz: '08e02980bbe0ae8c9dc355f483399a87b120c3817bb3d7ddbfaec4ccd584c76d08825bca81088a3004636b14373d675c3ca861ce82fd41efabc0669b1ab701f8'
+  metadata.gz: 3eb9360c0f0a608252d521b89911308b45584c4456040579d844cc7cf09fc839f12f8a908cd20c9f6fd421123f17ca6248948d80e7d36e82adb5a6a42e82b460
+  data.tar.gz: d5ec4be5ede9d7cd359ed5f50af51d37c6926b99d5130f679655fec3949962c57d4c215dc212413e76f85ef20b74aa036e2b1955837ff113bcf41d3dc6f180bc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    alba (0.0.1)
+    alba (0.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -21,12 +21,36 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-# If you don't bundle 'oj', that's file
-Alba.serialize({foo: 42}) # => '{"foo":42}'
-
-# bundle 'oj' in your Gemfile, then
-Alba.backend = :oj
-Alba.serialize({foo: 42}) # => '{"foo":42}'
+class User
+  attr_accessor :id, :name, :email, :created_at, :updated_at
+  def initialize(id, name, email)
+    @id = id
+    @name = name
+    @email = email
+    @created_at = Time.now
+    @updated_at = Time.now
+  end
+end
+
+class UserResource
+  include Alba::Resource
+
+  attributes :id, :name
+
+  attribute :name_with_email do |resource|
+    "#{resource.name}: #{resource.email}"
+  end
+end
+
+class SerializerWithKey
+  include Alba::Serializer
+
+  set key: :user
+end
+
+user = User.new(1, 'Masafumi OKURA', 'masafumi@example.com')
+UserResource.new(user).serialize
+# => "{\"id\":1,\"name\":\"Masafumi OKURA\",\"name_with_email\":\"Masafumi OKURA: masafumi@example.com\"}"
 ```
 
 ## Development

data/lib/alba.rb

@@ -1,16 +1,17 @@
 require 'alba/version'
+require 'alba/resource'
 require 'json'
 
 # Core module
 module Alba
   class Error < StandardError; end
 
-  def self.backend=(backend)
-    @backend = backend&.to_sym
+  class << self
+    attr_reader :backend
   end
 
-  def self.backend
-    @backend
+  def self.backend=(backend)
+    @backend = backend&.to_sym
   end
 
   def self.serialize(object)

data/lib/alba/attribute.rb

@@ -0,0 +1,19 @@
+module Alba
+  # This class represents an attribute, which is serialized
+  # by either sending message or calling a Proc.
+  class Attribute
+    def initialize(name:, method:)
+      @name = name
+      @method = method
+    end
+
+    def serialize(target)
+      case @method
+      when Symbol, String
+        target.public_send(@method)
+      when Proc
+        @method.call(target)
+      end
+    end
+  end
+end

data/lib/alba/resource.rb

@@ -0,0 +1,67 @@
+require 'alba/serializer'
+require 'alba/attribute'
+require 'alba/serializers/default_serializer'
+
+module Alba
+  # This module represents what should be serialized
+  module Resource
+    def self.included(base)
+      base.include InstanceMethods
+      base.extend ClassMethods
+    end
+
+    # Instance methods
+    module InstanceMethods
+      def initialize(resource)
+        @_resource = resource
+        @_attributes = self.class._attributes
+        @_serializer_class = self.class._serializer_class
+      end
+
+      def serialize(with: nil)
+        serializer_class = case with
+                           when ->(obj) { obj.is_a?(Class) && obj.ancestors.include?(Alba::Serializer) }
+                             with
+                           when Symbol
+                             const_get(with.to_s.capitalize)
+                           when String
+                             const_get(with)
+                           when nil
+                             @_serializer_class || Alba::Serializers::DefaultSerializer
+                           end
+        # opts = serializer.opts
+        serialiable_hash = @_attributes.map do |name, attribute|
+          [name, attribute.serialize(@_resource)]
+        end.to_h
+        serializer_class.new(serialiable_hash).serialize
+      end
+    end
+
+    # Class methods
+    module ClassMethods
+      attr_accessor :_attributes, :_serializer_class
+
+      def inherited(subclass)
+        @_attributes = {} unless defined?(@_attributes)
+        @_serializer_class = nil unless defined?(@_serializer_class)
+        subclass._attributes = @_attributes
+        subclass._serializer_class = @_serializer_class
+      end
+
+      def attributes(*attrs)
+        @_attributes = {} unless defined? @_attributes
+        attrs.each { |attr_name| @_attributes[attr_name] = Attribute.new(name: attr_name, method: attr_name) }
+      end
+
+      def attribute(name, &block)
+        raise ArgumentError, 'No block given in attribute method' unless block
+
+        @_attributes[name] = Attribute.new(name: name, method: block)
+      end
+
+      def serializer(name)
+        @_serializer_class = name.ancestors.include?(Alba::Serializer) ? name : nil
+      end
+    end
+  end
+end

data/lib/alba/serializer.rb

@@ -0,0 +1,45 @@
+module Alba
+  # This module represents how a resource should be serialized.
+  #
+  module Serializer
+    def self.included(base)
+      base.include InstanceMethods
+      base.extend ClassMethods
+    end
+
+    # Instance methods
+    module InstanceMethods
+      def initialize(resource)
+        @_resource = resource
+        @_opts = self.class._opts || {}
+        key = @_opts[:key]
+        @_resource = {key.to_sym => @_resource} if key
+      end
+
+      def serialize
+        fallback = -> { @_resource.to_json }
+        case Alba.backend
+        when :oj
+          begin
+            require 'oj'
+            -> { Oj.dump(@_resource) }
+          rescue LoadError
+            fallback
+          end
+        else
+          fallback
+        end.call
+      end
+    end
+
+    # Class methods
+    module ClassMethods
+      attr_reader :_opts
+
+      def set(key: false)
+        @_opts ||= {}
+        @_opts[:key] = key
+      end
+    end
+  end
+end

data/lib/alba/serializers/default_serializer.rb

@@ -0,0 +1,9 @@
+module Alba
+  module Serializers
+    # DefaultSerializer class is used when a user doesn't specify serializer opt.
+    # It's basically an alias of Alba::Serializer, but since it's a module this class simply include it.
+    class DefaultSerializer
+      include Alba::Serializer
+    end
+  end
+end

data/lib/alba/version.rb

@@ -1,3 +1,3 @@
 module Alba
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alba
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - OKURA Masafumi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-21 00:00:00.000000000 Z
+date: 2020-02-11 00:00:00.000000000 Z
 dependencies: []
 description: Fast and flexible JSON serializer
 email:
@@ -30,6 +30,10 @@ files:
 - bin/console
 - bin/setup
 - lib/alba.rb
+- lib/alba/attribute.rb
+- lib/alba/resource.rb
+- lib/alba/serializer.rb
+- lib/alba/serializers/default_serializer.rb
 - lib/alba/version.rb
 homepage: https://github.com/okuramasafumi/alba
 licenses: