mimi-struct 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ce18d3926ef7a9a05740b35362bd3c8d285f6ea
-  data.tar.gz: 0b668e2e2e2424ccdc1b792aa6c83748a5e6ab54
+  metadata.gz: 8064ab3ebc35af445e5be33a322db6d14a31693e
+  data.tar.gz: f8d1a850531925e12fe0c473647dc519538072f0
 SHA512:
-  metadata.gz: '0478d07e8a60c92362638ae261410d4cb96889958b192920d935ce0a5fa2cbdfd7907c27f0ae495273223bc143bb1850aa8490e3960dbd3f4864bb1baa70ba44'
-  data.tar.gz: 1523ca2197640b826f7b7a524ccd45763bc857c7e53d32620686de912bcc0bc3ebd711166fe5e7c5c33d5919a61a2d8b7ede0b64b73693b5327e18ff72053927
+  metadata.gz: 3d62b706cf2bffafb74bd09ead748382b95e1a4d297c6976832968065f5ecc7c9a6ca65b9daa7baed14f741c46719891ceaa23fcd7fdc921b8a73b0344e90fea
+  data.tar.gz: ad312292e8c75438467baa6754658f26e101040dd9ee1121dc6a4ddf349975c09d72f5ebe72e91566ddc384a33a8e3bd6fe835d982373de8dce817ddc9a8c506

data/.gitignore

@@ -1,11 +1,10 @@
 /.bundle/
 /.yardoc
+/Gemfile.lock
 /_yardoc/
 /coverage/
 /doc/
 /pkg/
 /spec/reports/
 /tmp/
-
-# rspec failure tracking
-.rspec_status
+/.rspec_status

data/bin/console

@@ -6,9 +6,5 @@ require "mimi/struct"
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+require "pry"
+Pry.start

data/examples/nested.rb

@@ -0,0 +1,29 @@
+require "mimi/struct"
+require "json"
+
+class User < Mimi::Struct
+  attribute :id
+  attribute :name, from: :username
+end
+
+class Comment < Mimi::Struct
+  attribute :author, from: :user, using: User
+  attribute :text
+end
+
+class Post < Mimi::Struct
+  attribute :id
+  attribute :author, using: User
+  attribute :text
+  attribute :comments, using: Comment
+end
+
+user1 = { id: 1, username: "Alice", email: "alice@gmail.com" }
+user2 = { id: 2, username: "Bob", email: "bob@gmail.com" }
+comm1 = { user: user1, text: "Mmm?" }
+comm2 = { user: user2, text: "Hi!" }
+post_params = { id: 1, author: user1, text: "Hello, world!", comments: [comm1, comm2] }
+
+# Maps Post including all nested data
+post = Post.new(post_params)
+puts JSON.pretty_generate post.to_h

data/examples/poro.rb

@@ -0,0 +1,23 @@
+require "mimi/struct"
+
+#
+# Mapping a PORO
+#
+
+class User < Mimi::Struct
+  attribute :id
+  attribute :name, from: :username
+end
+
+class UserData
+  attr_reader :id, :username
+
+  def initialize(username)
+    @id = rand(1000)
+    @username = username
+  end
+end
+
+user_data = UserData.new("John")
+
+puts User.new(user_data).to_h

data/examples/simple.rb

@@ -0,0 +1,13 @@
+require "mimi/struct"
+
+# Simple data mapping
+#
+class User < Mimi::Struct
+  attribute :id
+  attribute :name, from: :username
+end
+
+# Maps defined attributes, filters out all the extra attributes:
+user = User.new(id: 1, username: "John", email: "john@gmail.com")
+
+puts user.to_h

data/lib/mimi/struct.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
+require "mimi/core"
+
 module Mimi
   #
-  # A Struct that can be initialized from a Hash or another Struct.
+  # A Struct that can be initialized from a Hash or a PORO.
   #
-  # A Struct declares its attributes and rules, which define how its attrubutes
+  # A Struct declares its attributes and rules, which define how its attributes
   # are mapped from input data.
   #
-  class Struct < ::Struct
-
+  class Struct < Mimi::Core::Struct
+    #
     # Default attribute mapper
     #
     # Maps value of the source attribute to the target attribute.
@@ -16,9 +18,9 @@ module Mimi
     #
     DEFAULT_ATTRIBUTE_MAPPER = -> (o, params) do
       if params.key?(:default)
-        o.to_h.key?(params[:from]) || call_as_proc(params[:default], o, params)
+        o.respond_to?(params[:from]) || call_as_proc(params[:default], o, params)
       else
-        o[params[:from]]
+        o.send(params[:from])
       end
     end
 
@@ -27,7 +29,27 @@ module Mimi
     # Skips the attribute if the source attribute is not set.
     #
     DEFAULT_IF_FOR_OPTIONAL = -> (o, params) do
-      o.to_h.key?(params[:from])
+      o.respond_to?(params[:from])
+    end
+
+    # Creates a mapped Struct object from another object
+    #
+    # @param source [Hash,Object]
+    #
+    def initialize(source)
+      source = Mimi::Core::Struct.new(source) if source.is_a?(Hash)
+      attributes = self.class.transform_attributes(source)
+      super(attributes)
+    rescue StandardError => e
+      raise e.class, "Failed to construct #{self.class}: #{e}", e.backtrace
+    end
+
+    # Fetches an attribute with given name
+    #
+    # @param name [Symbol]
+    #
+    def [](name)
+      @attributes[name.to_sym]
     end
 
     # Presents this Struct as a Hash, deeply converting nested Structs
@@ -35,7 +57,7 @@ module Mimi
     # @return [Hash]
     #
     def to_h
-      super.map do |k, v|
+      attributes.map do |k, v|
         [k, self.class.value_to_h(v)]
       end.to_h
     end
@@ -45,7 +67,7 @@ module Mimi
     # @return [Hash]
     #
     def attributes
-      to_h
+      @attributes
     end
 
     # An attribute definition
@@ -109,7 +131,7 @@ module Mimi
       if obj_or_collection.is_a?(Array)
         obj_or_collection.map { |o| self << o }
       else
-        transform(obj_or_collection)
+        new(obj_or_collection)
       end
     end
 
@@ -141,36 +163,19 @@ module Mimi
       @group_params ||= [{}]
     end
 
-    # Creates a Struct instance from given parameters
-    #
-    # @param source [Struct,Hash]
-    #
-    private_class_method def self.transform(source)
-      if source.is_a?(Struct)
-        # do nothing
-      elsif source.is_a?(Hash)
-        source = Struct.new(*source.to_h.keys).new(*source.to_h.values)
-      else
-        raise ArgumentError, "Struct or Hash is expected as source"
-      end
-      attributes = transform_attributes(source)
-      new(*attributes.keys).new(*attributes.values)
-    rescue StandardError => e
-      raise "Failed to construct #{self}: #{e}"
-    end
-
     # Transform attributes according to rules
     #
     # @param source [Struct]
     # @return [Hash] map of attribute name -> value
     #
-    private_class_method def self.transform_attributes(source)
-      attribute_definitions.map do |k, params|
+    def self.transform_attributes(source)
+      result = attribute_definitions.map do |k, params|
         if params[:if].is_a?(Proc)
           next unless call_as_proc(params[:if], source, params)
         end
         [k, transform_single_attribute(source, k, params)]
       end.compact.to_h
+      result
     end
 
     # Transforms a single attribute value according to rules passed as params
@@ -183,7 +188,7 @@ module Mimi
     private_class_method def self.transform_single_attribute(source, key, params)
       return call_as_proc(params[:using], source, params) if params[:using].is_a?(Proc)
       if params[:using].is_a?(Class) && params[:using] < Mimi::Struct
-        return params[:using] << source[params[:from]]
+        return params[:using] << source.send(params[:from])
       end
       raise "unexpected :using type: #{params[:using].class}"
     rescue StandardError => e

data/lib/mimi/struct/version.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require "mimi/struct"
-
 module Mimi
   class Struct
-    VERSION = "0.1.0"
+    VERSION = "1.0.0"
   end
 end

data/mimi-struct.gemspec

@@ -1,6 +1,6 @@
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "mimi/struct/version"
+require "mimi/struct"
 
 Gem::Specification.new do |spec|
   spec.name          = "mimi-struct"
@@ -30,9 +30,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "mimi-core", "~> 1.0"
+  spec.add_dependency "mimi-core", "~> 1.1"
 
   spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "pry", "~> 0.12"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mimi-struct
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Alex Kukushkin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-23 00:00:00.000000000 Z
+date: 2019-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mimi-core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -78,13 +92,15 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - examples/customer.rb
+- examples/nested.rb
+- examples/poro.rb
+- examples/simple.rb
 - lib/mimi/struct.rb
 - lib/mimi/struct/version.rb
 - mimi-struct.gemspec

data/Gemfile.lock

@@ -1,39 +0,0 @@
-PATH
-  remote: .
-  specs:
-    mimi-struct (0.1.0)
-      mimi-core (~> 1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    diff-lcs (1.3)
-    hashie (3.6.0)
-    mimi-core (1.0.0)
-      hashie (~> 3.6)
-    rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.1)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  mimi-struct!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   2.0.2