tree_struct 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba7a5b878999f86027b70eca32ec20f4f3061e5f
+  data.tar.gz: 948f42ea822698c5b92ab642be21c419233e60a7
+SHA512:
+  metadata.gz: d791041412fc353dffcd70186af5d9309b2d36c1933c6b2fe995f3646ee467ac07a17e72db0b53ad5ca144e892fa9627debe6fdcebe3852d27b7dd413981381a
+  data.tar.gz: 6efbf12c034ee9bbaabcf87c30ac01f9267c65dbb0ff1c936f2401bb9e3ef5e5d717ffc89037b7f8693c8c8de46f4e139971f80eef54006d4bee6dbcf1abd660

data/.gitignore

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

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.2.8
+before_install: gem install bundler -v 1.16.1

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 tree_struct.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    tree_struct (1.0.0)
+      activesupport (>= 3.2)
+      typed_array (>= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    thread_safe (0.3.6)
+    typed_array (1.0.1)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  tree_struct!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Alexander Koltun
+
+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,223 @@
+# TreeStruct
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tree_struct`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tree_struct'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tree_struct
+
+## Usage
+
+### Table of Contents
+
+1. [Definition](#1-definition)
+   1. [Nested TreeStruct](11-nested-tree-struct)
+   2. [Array of TreeStruct](12-array-of-tree-struct)
+2. [Serialize to Hash](2-serialize-to-hash)
+   1. [Nested TreeStruct](21-nested-tree-struct)
+   2. [Array of TreeStruct](22-array-of-tree-struct)
+3. [Reference Guide](3-reference-guide-attribute-parameters)
+
+### 1. Definition
+
+Inherit your class from `TreeStruct` and define its attributes.
+
+```ruby
+class SimpleTreeStruct < TreeStruct
+  attribute :name
+  attribute :year
+end
+```
+
+Access attributes via dot notation.
+
+```ruby
+simple_tree_struct = SimpleTreeStruct.new
+simple_tree_struct.name = 'Ferrari'         # => "Ferrari"
+simple_tree_struct.year = 1950              # => 1950
+```
+
+#### 1.1. Nested TreeStruct Objects
+
+Use blocks to define nested TreeStruct.
+
+```ruby
+class NestedTreeStruct < TreeStruct
+  attribute :name
+  attribute :year
+  attribute :car do
+    attribute :model
+    attribute :driver
+    attribute :engine do
+      attribute :power
+      attribute :volume
+    end
+  end
+end
+```
+
+Or explicitly define nested TreeStruct classes.
+
+```ruby
+class EngineTreeStruct < TreeStruct
+  attribute :power
+  attribute :volume
+end
+class CarTreeStruct < TreeStruct
+  attribute :model
+  attribute :driver
+  attribute :engine, class: EngineTreeStruct
+end
+class NestedTreeStruct < TreeStruct
+  attribute :name
+  attribute :year
+  attribute :car, class: CarTreeStruct
+end
+```
+
+Access attributes via dot notation.
+
+```ruby
+nested_tree_struct = NestedTreeStruct.new
+nested_tree_struct.name = 'Ferrari'         # => "Ferrari"
+nested_tree_struct.year = 1950              # => 1950
+nested_tree_struct.car.model = '340 F1'     # => "340 F1"
+nested_tree_struct.car.driver = 'Ascari'    # => "Ascari"
+nested_tree_struct.car.engine.power = 335   # => 335
+nested_tree_struct.car.engine.volume = 4.1  # => 4.1
+```
+
+#### 1.2. Array of TreeStruct Objects
+
+Specify attribute parameter `array: true` in order to define an array of TreeStruct objects
+
+```ruby
+class ArrayTreeStruct < TreeStruct
+  attribute :name
+  attribute :year
+  attribute :cars, array: true do
+    attribute :model
+    attribute :driver
+    attribute :engine do
+      attribute :power
+      attribute :volume
+    end
+  end
+end
+```
+
+or
+
+```ruby
+class EngineTreeStruct < TreeStruct
+  attribute :power
+  attribute :volume
+end
+class CarTreeStruct < TreeStruct
+  attribute :model
+  attribute :driver
+  attribute :engine, class: EngineTreeStruct
+end
+class ArrayTreeStruct < TreeStruct
+  attribute :name
+  attribute :year
+  attribute :cars, array: true, class: CarTreeStruct
+end
+```
+
+Add new elements in the array by using method :create which adds a new it.
+
+```ruby
+array_tree_struct = ArrayTreeStruct.new
+array_tree_struct.name = 'Ferrari'              # => "Ferrari"
+array_tree_struct.year = 1950                   # => 1950
+array_tree_struct.size 				            # => 0
+array_tree_struct.cars.create
+array_tree_struct.size 				            # => 1
+array_tree_struct.cars[0].model = '340 F1'      # => "340 F1"
+array_tree_struct.cars[0].driver = 'Ascari'     # => "Ascari"
+array_tree_struct.cars[0].engine.power = 335    # => 335
+array_tree_struct.cars[0].engine.volume = 4.1   # => 4.1
+```
+
+### 2. Serialize to Hash
+
+Call `to_hash` method in order to get hash representation of the TreeStruct object
+
+```ruby
+simple_tree_struct.to_hash      # => {
+                                # =>    :name => "Ferrari",
+                                # =>    :year => 1950  
+                                # => }
+```
+
+#### 2.1. Nested TreeStruct Objects
+
+```ruby
+nested_tree_struct.to_hash      # => {
+                                # =>    :name => "Ferrari",
+                                # =>    :year => 1950,
+                                # =>    :car  => {
+                                # =>      :model => "340 F1",
+                                # =>      :driver => "Ascari",
+                                # =>      :engine => {
+                                # =>        :power => 335,
+                                # =>        :volume => 4.1
+                                # =>      }   
+                                # =>    }
+                                # => }
+```
+
+#### 3.2. Array of TreeStruct Objects
+
+```ruby
+array_tree_struct.to_hash       # => {
+                                # =>    :name => "Ferrari",
+                                # =>    :year => 1950,
+                                # =>    :cars => [{
+                                # =>      :model => "340 F1",
+                                # =>      :driver => "Ascari",
+                                # =>      :engine => {
+                                # =>        :power => 335,
+                                # =>        :volume => 4.1
+                                # =>      }
+                                # =>    }] 
+                                # => }
+```
+
+### 3. Reference Guide: `attribute` parameters
+
+| Parameter | Condition | Default value | Description |
+| --- |:---:|:---:| --- |
+| array | block* or `:class`** | `false` | This attribute is an array of TreeStruct objects. The structure of array element is described either in the block or in the separate class referenced by `:class` parameter |
+| class | - | - | This attribute is either nested TreeStruct object or an array of TreeStruct objects. The value of this parameter is a class or a name of a class of this TreeStruct object. |
+\* block - means that there is block definition for the attribute
+
+\** `:class` - means that this attribute has `:class` parameter specified
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/akoltun/tree_struct.
+
+## 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 "tree_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/tree_struct/array.rb

@@ -0,0 +1,14 @@
+require 'typed_array'
+
+class TreeStruct
+  class Array < TypedArray
+    def create
+      self << (item = item_class.new)
+      item
+    end
+
+    def to_hash
+      self.map(&:to_hash)
+    end
+  end
+end

data/lib/tree_struct/attribute.rb

@@ -0,0 +1,59 @@
+require 'tree_struct'
+
+class TreeStruct
+  class Attribute
+    attr_reader :name
+
+    def initialize(name, array: false, class: nil, default: nil, parent:, &block)
+      @name = name.to_sym
+      @array = array
+      @default_value = default
+      @parent = parent
+
+      @nested_class = binding.local_variable_get(:class)
+      @nested_class = Class.new(@parent.nested_class, &block) if !@nested_class && block_given?
+
+      raise ArgumentError.new('Nested structure has to be defined (either with :class parameter or with block) for arrays if :default parameter is not specified') if @array && @nested_class.nil? && @default_value.nil?
+    end
+
+    def subform?
+      !@nested_class.nil?
+    end
+
+    def validate_value!(value)
+      if @nested_class
+        if @array
+          unless value.class == @parent.array_class
+            raise ArgumentError.new(":#{@name} attribute value should be of class #{@parent.nested_class.name}::Array while attempt to assign value of class #{value.class.name}")
+          end
+          unless value.item_class == @nested_class
+            raise ArgumentError.new(":#{@name} attribute value should be an array with items of class #{@nested_class.name} while attempt to assign an array with items of class #{value.item_class.name}")
+          end
+
+        else
+          unless value.class == @nested_class
+            raise ArgumentError.new(":#{@name} attribute value should be of class #{@nested_class.name} while attempt to assign value of class #{value.class.name}")
+          end
+        end
+      end
+    end
+
+    def default_value
+      if @default_value.nil?
+        if @nested_class
+          if @array
+            @parent.array_class.new(@nested_class)
+          else
+            @nested_class.new
+          end
+        end
+
+      elsif @default_value.is_a? Proc
+        @default_value.call(@parent, self)
+
+      else
+        @default_value
+      end
+    end
+  end
+end

data/lib/tree_struct/attributes.rb

@@ -0,0 +1,15 @@
+class TreeStruct
+  class Attributes
+    def initialize(items = [])
+      @items = items
+    end
+
+    def add(attribute)
+      self.class.new(@items + [attribute])
+    end
+
+    def map(*args, &block)
+      @items.map(*args, &block)
+    end
+  end
+end

data/lib/tree_struct/version.rb

@@ -0,0 +1,3 @@
+class TreeStruct
+  VERSION = "1.0.0"
+end

data/lib/tree_struct.rb

@@ -0,0 +1,67 @@
+require "tree_struct/version"
+require "tree_struct/array"
+require "tree_struct/attribute"
+require "tree_struct/attributes"
+require 'active_support/core_ext/class/attribute'
+
+class TreeStruct
+  private
+
+  class_attribute :_attributes, instance_predicate: false, instance_reader: false, instance_writer: false
+  self._attributes = Attributes.new
+
+  def self._define_attribute_getter(attribute)
+    define_method attribute.name do
+      _get_attribute_value(attribute)
+    end
+  end
+
+  def self._define_attribute_setter(attribute)
+    define_method "#{attribute.name}=" do |value|
+      _set_attribute_value(attribute, value)
+    end
+  end
+
+  public
+
+  def self.array_class
+    Array
+  end
+
+  def self.nested_class
+    ::TreeStruct
+  end
+
+  def self.attribute_class
+    Attribute
+  end
+
+  def self.attribute(name, opts = {}, &block)
+    attr = self.attribute_class.new(name, opts.merge(parent: self), &block)
+    self._attributes = self._attributes.add(attr)
+    self._define_attribute_getter(attr)
+    self._define_attribute_setter(attr)
+    self
+  end
+
+  def self.attributes
+    self._attributes.map(&:name)
+  end
+
+  def to_hash
+    Hash[self.class._attributes.map { |attribute| [attribute.name, attribute.subform? ? send(attribute.name).to_hash : send(attribute.name)] }]
+  end
+
+  private
+
+  def _get_attribute_value(attribute)
+    value = instance_variable_get("@#{attribute.name}")
+    value = instance_variable_set("@#{attribute.name}", attribute.default_value) if value.nil?
+    value
+  end
+
+  def _set_attribute_value(attribute, value)
+    attribute.validate_value!(value)
+    instance_variable_set("@#{attribute.name}", value)
+  end
+end

data/tree_struct.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tree_struct/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tree_struct"
+  spec.version       = TreeStruct::VERSION
+  spec.authors       = ["Alexander Koltun"]
+  spec.email         = ["alexander.koltun@gmail.com"]
+
+  spec.summary       = %q{Similar to Ruby Struct class but allows to describe nested and arrayed structures}
+  spec.description   = %q{TreeStruct allows to describe a structure with nested TreeStruct and with arrays of TreeStruct.
+The level of nesting is not limited.}
+  spec.homepage      = "https://github.com/akoltun/tree_struct"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  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.files         = `git ls-files -z`.split("\x0").reject do |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 "typed_array", ">= 1.0.0"
+  spec.add_dependency "activesupport", ">= 3.2"
+
+  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,133 @@
+--- !ruby/object:Gem::Specification
+name: tree_struct
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alexander Koltun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typed_array
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !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: |-
+  TreeStruct allows to describe a structure with nested TreeStruct and with arrays of TreeStruct.
+  The level of nesting is not limited.
+email:
+- alexander.koltun@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tree_struct.rb
+- lib/tree_struct/array.rb
+- lib/tree_struct/attribute.rb
+- lib/tree_struct/attributes.rb
+- lib/tree_struct/version.rb
+- tree_struct.gemspec
+homepage: https://github.com/akoltun/tree_struct
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.4.5.3
+signing_key: 
+specification_version: 4
+summary: Similar to Ruby Struct class but allows to describe nested and arrayed structures
+test_files: []