mimi-struct 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4ce18d3926ef7a9a05740b35362bd3c8d285f6ea
+  data.tar.gz: 0b668e2e2e2424ccdc1b792aa6c83748a5e6ab54
+SHA512:
+  metadata.gz: '0478d07e8a60c92362638ae261410d4cb96889958b192920d935ce0a5fa2cbdfd7907c27f0ae495273223bc143bb1850aa8490e3960dbd3f4864bb1baa70ba44'
+  data.tar.gz: 1523ca2197640b826f7b7a524ccd45763bc857c7e53d32620686de912bcc0bc3ebd711166fe5e7c5c33d5919a61a2d8b7ede0b64b73693b5327e18ff72053927

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.6
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alex@kukushk.in. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mimi-struct.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Alex Kukushkin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# WIP: Mimi::Struct
+
+Object to Object mapper.
+
+Allows you to map a PORO, Struct, OpenStruct or a Hash into a simple Ruby object
+with predefined schema and transformation rules.
+
+## Usage
+
+```ruby
+require "mimi/struct"
+
+class Customer < Mimi::Struct
+  attribute :id
+  attribute :type, using: -> (o) { o.type.to_s.upcase }
+
+  group if: -> (o) { o.type == :person } do
+    attribute :first_name, from: :firstName
+    attribute :last_name, from: :lastName
+  end
+
+  group if: -> (o) { o.type == :company } do
+    attribute :company_name
+  end
+
+  attribute :created_at, default: -> { Time.now.utc }
+  attribute :updated_at, default: -> { Time.now.utc }
+end
+
+customer = Customer << { id: "person1", type: :person, firstName: "John", lastName: "Smith" }
+
+puts customer.to_h
+# {
+#   :id=>"person1", :type=>"PERSON", :first_name=>"John", :last_name=>"Smith",
+#   :created_at=>2019-06-23 16:07:30 UTC, :updated_at=>2019-06-23 16:07:30 UTC
+# }
+```
+
+## Defining your Mimi::Struct schema
+
+### :from
+### :using
+### :default
+### :if
+### :optional
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kukushkin/mimi-struct. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mimi::Struct project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kukushkin/mimi-struct/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+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__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples/customer.rb

@@ -0,0 +1,22 @@
+require "mimi/struct"
+
+class Customer < Mimi::Struct
+  attribute :id
+  attribute :type, using: -> (o) { o.type.to_s.upcase }
+
+  group if: -> (o) { o.type == :person } do
+    attribute :first_name, from: :firstName
+    attribute :last_name, from: :lastName
+  end
+
+  group if: -> (o) { o.type == :company } do
+    attribute :company_name
+  end
+
+  attribute :created_at, default: -> { Time.now.utc }
+  attribute :updated_at, default: -> { Time.now.utc }
+end
+
+customer = Customer << { id: "person1", type: :person, firstName: "John", lastName: "Smith" }
+
+puts customer.to_h

data/lib/mimi/struct.rb

@@ -0,0 +1,224 @@
+# frozen_string_literal: true
+
+module Mimi
+  #
+  # A Struct that can be initialized from a Hash or another Struct.
+  #
+  # A Struct declares its attributes and rules, which define how its attrubutes
+  # are mapped from input data.
+  #
+  class Struct < ::Struct
+
+    # Default attribute mapper
+    #
+    # Maps value of the source attribute to the target attribute.
+    # Calculates a default value if the source attribute is not set.
+    #
+    DEFAULT_ATTRIBUTE_MAPPER = -> (o, params) do
+      if params.key?(:default)
+        o.to_h.key?(params[:from]) || call_as_proc(params[:default], o, params)
+      else
+        o[params[:from]]
+      end
+    end
+
+    # Default :if block for an optional attribute
+    #
+    # Skips the attribute if the source attribute is not set.
+    #
+    DEFAULT_IF_FOR_OPTIONAL = -> (o, params) do
+      o.to_h.key?(params[:from])
+    end
+
+    # Presents this Struct as a Hash, deeply converting nested Structs
+    #
+    # @return [Hash]
+    #
+    def to_h
+      super.map do |k, v|
+        [k, self.class.value_to_h(v)]
+      end.to_h
+    end
+
+    # Returns attributes of this Structs as a Hash
+    #
+    # @return [Hash]
+    #
+    def attributes
+      to_h
+    end
+
+    # An attribute definition
+    #
+    # Possible params:
+    #   from: <Symbol>
+    #   using: <proc,Mimi::Struct>
+    #   if: <proc>
+    #   default: <proc,Object>
+    #   optional: <true,false>
+    #
+    # @param name [Symbol]
+    # @param params [Hash]
+    #
+    def self.attribute(name, params = {})
+      name = name.to_sym
+      raise "Attribute '#{name}' is already declared" if attribute_definitions.key?(name)
+      defaults = group_params.reduce(:merge).merge(
+        from: name,
+        using: DEFAULT_ATTRIBUTE_MAPPER
+      )
+      params = defaults.merge(params)
+      if params.key?(:if) && params.key?(:optional)
+        raise ArgumentError, "Keys :if and :optional cannot be used together"
+      end
+      params[:if] = DEFAULT_IF_FOR_OPTIONAL if params[:optional]
+      add_attribute_definition(name, params)
+    end
+
+    # Declare a group of parameters with common options
+    #
+    # E.g.
+    #   Class User < Mimi::Struct
+    #     attribute :id
+    #     attribute :type
+    #     attribute :name
+    #     group if: -> (o) { o.type == 'ADMIN' } do
+    #       attribute :admin_role
+    #       attribute :admin_domain
+    #     end
+    #     group default: -> { Time.now.utc } do
+    #       attribute :created_at
+    #       attribute :updated_at
+    #     end
+    #   end
+    #
+    # NOTE: Not reentrable.
+    #
+    # @param params [Hash]
+    #
+    def self.group(params, &block)
+      group_params << params
+      yield
+      group_params.pop
+    end
+
+
+    # Converts a single object or collection to Struct.
+    #
+    def self.<<(obj_or_collection)
+      if obj_or_collection.is_a?(Array)
+        obj_or_collection.map { |o| self << o }
+      else
+        transform(obj_or_collection)
+      end
+    end
+
+    # Returns a Hash of attribute definitions
+    #
+    # @return [Hash]
+    #
+    private_class_method def self.attribute_definitions
+      @attribute_definitions ||= {}
+      # merge with base class
+      defined?(super) ? super.merge(@attribute_definitions) : @attribute_definitions
+    end
+
+    # Adds a new attribute definition
+    #
+    # @param name [Symbol]
+    # @param params [Hash]
+    #
+    private_class_method def self.add_attribute_definition(name, params)
+      @attribute_definitions ||= {}
+      @attribute_definitions[name] = params.dup
+    end
+
+    # Returns current stack of group parameters
+    #
+    # @return [Array<Hash>]
+    #
+    private_class_method def self.group_params
+      @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|
+        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
+    end
+
+    # Transforms a single attribute value according to rules passed as params
+    #
+    # @param source [Struct]
+    # @param key [Symbol]
+    # @param params [Hash] transformation rules
+    # @return [Object]
+    #
+    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]]
+      end
+      raise "unexpected :using type: #{params[:using].class}"
+    rescue StandardError => e
+      raise "Failed to transform attribute :#{key} : #{e}"
+    end
+
+    # Calls a lambda as a proc, not caring about the number of arguments
+    #
+    # @param proc_or_lambda [Proc]
+    # @param *args
+    #
+    private_class_method def self.call_as_proc(proc, *args)
+      raise ArgumentError, "Proc is expected as proc" unless proc.is_a?(Proc)
+      if proc.lambda?
+        proc.call(*args.first(proc.arity))
+      else
+        proc.call(*args)
+      end
+    end
+
+    # Map value or values to Hash
+    #
+    # @param value [Object]
+    #
+    def self.value_to_h(value)
+      case value
+      when Struct
+        value.to_h
+      when Array
+        value.map { |v| value_to_h(v) }
+      else
+        value
+      end
+    end
+  end # class Struct
+end # module Mimi
+
+require "mimi/struct/version"

data/lib/mimi/struct/version.rb

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

data/mimi-struct.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mimi/struct/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mimi-struct"
+  spec.version       = Mimi::Struct::VERSION
+  spec.authors       = ["Alex Kukushkin"]
+  spec.email         = ["alex@kukushk.in"]
+
+  spec.summary       = %q{Simple Object-to-Object mapper}
+  spec.description   = %q{Simple Object-to-Object mapper}
+  spec.homepage      = "https://github.com/kukushkin/mimi-struct"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mimi-core", "~> 1.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: mimi-struct
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Kukushkin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mimi-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Simple Object-to-Object mapper
+email:
+- alex@kukushk.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/customer.rb
+- lib/mimi/struct.rb
+- lib/mimi/struct/version.rb
+- mimi-struct.gemspec
+homepage: https://github.com/kukushkin/mimi-struct
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/kukushkin/mimi-struct
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.4
+signing_key: 
+specification_version: 4
+summary: Simple Object-to-Object mapper
+test_files: []