nested_struct 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e20230e4bbc23eee451104b684a2d23f4b7b7b01
+  data.tar.gz: 4e18420e5346de8da7b71db5d49b7c22362950c4
+SHA512:
+  metadata.gz: 97e10af76a774ed5c2a6e8fddb922912d07a22756793d103b5a9fddf3daaaba9e4865b5f0f08063f67d9224db300d5e080eab9e565c2ea3e10229444632528d2
+  data.tar.gz: 943170d3ca5ac6e4a27210dfe1f3a78b0e403f48ad95a18f4a6e394a2b096c2fc15f40a1f70d768e5323eea2a559971ce41cfeba7ff32325596c4455c0575d64

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,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nested_struct.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Krzysztof Buszewicz
+
+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,60 @@
+# NestedStruct
+
+Build nested structs from hash/array structures.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nested_struct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nested_struct
+
+## Usage
+
+```ruby
+class AddressForm
+  include NestedStruct::Interface
+
+  field :street
+end
+
+class SkillForm
+  include NestedStruct::Interface
+
+  field :name
+end
+
+class UserForm
+  include NestedStruct::Interface
+
+  field :name
+  field :address, AddressForm
+  field :skills, [SkillForm]
+end
+
+attributes = {
+  name: 'Tom',
+  address: { street: 'Long' },
+  skills: [{ name: 'Jumping' }, { name: 'Kicking' }, {}]
+}
+
+form = UserForm.new(attributes)
+#=> #<UserForm:0x0055cceb5c9438 @name="Tom", @address=#<AddressForm:0x0055cceb5c9320 @street="Long">, @skills=[#<SkillForm:0x0055cceb5c91e0 @name="Jumping">, #<SkillForm:0x0055cceb5c9118 @name="Kicking">, #<SkillForm:0x0055cceb5c90a0 @name=nil>]>
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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 "nested_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/lib/nested_struct/coercer.rb

@@ -0,0 +1,44 @@
+module NestedStruct
+  class Coercer
+    attr_reader :type, :target
+
+    def initialize(expression)
+      if expression.is_a?(Class)
+        @type = :single
+        @target = expression
+      elsif expression.is_a?(Array)
+        raise Errors::InvalidCoercerExpression if expression.size != 1
+        @type = :multiple
+        @target = expression.first
+      else
+        raise Errors::InvalidCoercerExpression
+      end
+
+      raise Errors::InvalidCoercerTarget if !valid_target?
+    end
+
+    def coerce(value)
+      if multiple?
+        raise Errors::InvalidCoercerValue if !value.is_a?(Array)
+        value.map { |e| single_coercion(e) }
+      else
+        single_coercion(value)
+      end
+    end
+
+    def multiple?
+      type == :multiple
+    end
+
+    private
+
+    def valid_target?
+      target.ancestors.include?(NestedStruct::Interface)
+    end
+
+    def single_coercion(hash)
+      raise Errors::InvalidCoercerValue if !hash.is_a?(Hash)
+      target.new(hash)
+    end
+  end
+end

data/lib/nested_struct/errors/invalid_coercer_expression.rb

@@ -0,0 +1,9 @@
+module NestedStruct
+  module Errors
+    class InvalidCoercerExpression < StandardError
+      def initialize
+        super('Coercer expression should be a class or an array containing class.')
+      end
+    end
+  end
+end

data/lib/nested_struct/errors/invalid_coercer_target.rb

@@ -0,0 +1,9 @@
+module NestedStruct
+  module Errors
+    class InvalidCoercerTarget < StandardError
+      def initialize
+        super('Coercer target\'s ancestors must include NestedStruct::Interface.')
+      end
+    end
+  end
+end

data/lib/nested_struct/errors/invalid_coercer_value.rb

@@ -0,0 +1,9 @@
+module NestedStruct
+  module Errors
+    class InvalidCoercerValue < StandardError
+      def initialize
+        super('Coercer value must be an array for multiple coercion or a hash for single one.')
+      end
+    end
+  end
+end

data/lib/nested_struct/field.rb

@@ -0,0 +1,20 @@
+module NestedStruct
+  class Field
+    attr_reader :name, :coercer
+
+    def initialize(name, coercer_expression = nil)
+      @name = name
+      @coercer = Coercer.new(coercer_expression) if coercer_expression
+    end
+
+    def with(value)
+      return value if value.nil?
+      return value if !coerced?
+      coercer.coerce(value)
+    end
+
+    def coerced?
+      !coercer.nil?
+    end
+  end
+end

data/lib/nested_struct/interface.rb

@@ -0,0 +1,52 @@
+module NestedStruct
+  module Interface
+    def self.included(base)
+      base.class_eval do
+        @field_names ||= []
+        @fields ||= []
+
+        class << self
+          attr_reader :field_names, :fields
+
+          def field(name, coercer_expression = nil)
+            if !field_names.include?(name)
+              @field_names << name
+              @fields << Field.new(name, coercer_expression)
+              attr_accessor(name)
+            end
+          end
+        end
+      end
+    end
+
+    def initialize(attributes = {})
+      assign_field_values(attributes)
+    end
+
+    def to_hash
+      Hash[
+        self.class.fields.map do |field|
+          [field.name.to_sym, primitivize(public_send(field.name))]
+        end
+      ]
+    end
+
+    private
+
+    def assign_field_values(attributes = {})
+      self.class.fields.each do |field|
+        instance_variable_set(
+          "@#{field.name}",
+          field.with(attributes[field.name])
+        )
+      end
+    end
+
+    def primitivize(value)
+      return nil if value.nil?
+      return value.map(&:to_hash) if value.is_a?(Array)
+      return value.to_hash if value.respond_to?(:to_hash)
+      value
+    end
+  end
+end

data/lib/nested_struct/version.rb

@@ -0,0 +1,3 @@
+module NestedStruct
+  VERSION = '1.0.0'
+end

data/lib/nested_struct.rb

@@ -0,0 +1,13 @@
+require 'nested_struct/version'
+
+require 'nested_struct/errors/invalid_coercer_expression'
+require 'nested_struct/errors/invalid_coercer_target'
+require 'nested_struct/errors/invalid_coercer_value'
+
+require 'nested_struct/coercer'
+require 'nested_struct/field'
+
+require 'nested_struct/interface'
+
+module NestedStruct
+end

data/nested_struct.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nested_struct/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nested_struct"
+  spec.version       = NestedStruct::VERSION
+  spec.authors       = ["Krzysztof Buszewicz"]
+  spec.email         = ["krzysztof.buszewicz@gmail.com"]
+
+  spec.summary       = "Compose nested structs from hash/array structures."
+  spec.homepage      = "https://github.com/buszu/nested_struct"
+  spec.license       = "MIT"
+
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: nested_struct
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Krzysztof Buszewicz
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: 
+email:
+- krzysztof.buszewicz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nested_struct.rb
+- lib/nested_struct/coercer.rb
+- lib/nested_struct/errors/invalid_coercer_expression.rb
+- lib/nested_struct/errors/invalid_coercer_target.rb
+- lib/nested_struct/errors/invalid_coercer_value.rb
+- lib/nested_struct/field.rb
+- lib/nested_struct/interface.rb
+- lib/nested_struct/version.rb
+- nested_struct.gemspec
+homepage: https://github.com/buszu/nested_struct
+licenses:
+- MIT
+metadata: {}
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Compose nested structs from hash/array structures.
+test_files: []