data2ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f661988cfc00ef0950fc24a44ae3d71ea780987b
+  data.tar.gz: 278ef2df7e775ea6374fe537aa4cb2d421c632ec
+SHA512:
+  metadata.gz: 56977e822d77a4e6641444e0fa1fd84ae8ecdf9aef2c1044390e132c11bc463ee981685b0a6ecc3b7e3e42584092054c8154bd9f9a264a4a4e3305aec29ec2eb
+  data.tar.gz: 23519951835fcfbc12653457b2ba1bca6ecbb494485e2f5fe2e8857640c1a9da0d13db80b43eb6efd72c4a65371080a2e0bb5fcafa8960365f9268fee3480a58

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/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 data2ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    data2ruby (0.1.0)
+      activemodel (~> 5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (5.2.1)
+      activesupport (= 5.2.1)
+    activesupport (5.2.1)
+      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.1.1)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    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.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  data2ruby!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Roberto Maestroni
+
+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,86 @@
+# Data2ruby
+
+Convert an heterogeneous tree structure in nested `ActiveModel::Model` objects.
+
+For instance, if you have a JSON object describing a train journey:
+
+```json
+{
+  "id": 987,
+  "connections": [
+    {
+      "start": "London",
+      "finish": "Paris",
+      "departure_time": "2015-07-11T09:23:00+01:00",
+      "arrival_time": "2015-07-11T12:41:00+02:00",
+      "fare": {
+        "currency": "GBP",
+        "value": 159.0
+      }
+    },
+    {
+      "start": "Paris",
+      "finish": "Barcelona",
+      "departure_time": "2015-07-11T13:56:00+02:00",
+      "arrival_time": "2015-07-11T20:17:00+02:00",
+      "fare": {
+        "currency": "GBP",
+        "value": 50.0
+      }
+    }
+  ]
+}
+```
+
+You can define a Ruby class describing it as
+
+```ruby
+class TravelOption
+  include Data2ruby
+
+  has_one :journey do
+    attr_accessor :id
+    validates_numericality_of :id, only_integer: true
+
+    has_many :connections do
+      attr_accessor :start, :finish, :departure_time, :arrival_time
+      validates_presence_of :start, :finish, :departure_time, :arrival_time
+
+      has_one :fare do
+        attr_accessor :currency, :value
+        validates_presence_of :currency
+        validates_numericality_of :value
+      end
+    end
+  end
+end
+```
+
+Then instantiate and validate:
+
+```ruby
+travel_option = TravelOption.new(JSON.parse(json_string))
+
+# run ActiveModel validations
+travel_option.valid_structure? # => true
+travel_option.invalid_items # => []
+
+# navigate the associations
+travel_option.journey.id # => 987
+travel_option.connections[0].start # => "London"
+travel_option.connections[0].fare.currency # => "GBP"
+```
+
+## 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/rmaestroni/data2ruby.
+
+## 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 "data2ruby"
+
+# 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/data2ruby.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "data2ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "data2ruby"
+  spec.version       = Data2ruby::VERSION
+  spec.authors       = ["Roberto Maestroni"]
+  spec.email         = ["r.maestroni@gmail.com"]
+
+  spec.summary       = %q{Define a DSL in Ruby to validate and access any data}
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  spec.homepage      = "https://github.com/rmaestroni/data2ruby"
+  spec.license       = "MIT"
+
+  # 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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'activemodel', '~> 5'
+end

data/lib/data2ruby.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+require 'active_model'
+
+module Data2ruby
+  include Enumerable
+
+  module ClassMethods
+
+    def associations
+      @_associations ||= []
+    end
+
+    def has_one(label, &block)
+      attr_writer(label)
+      associations << label
+      klass = build_assoc_class(&block)
+      assoc_instance_builder = build_assoc_instance_builder(klass)
+      inst_var_memo = "@_has_one_#{label}"
+
+      define_method(label) do
+        memoize(inst_var_memo) { assoc_instance_builder.(data[label]) }
+      end
+    end
+
+    def has_many(label, &block)
+      attr_writer(label)
+      associations << label
+      klass = build_assoc_class(&block)
+      assoc_instance_builder = build_assoc_instance_builder(klass)
+      inst_var_memo = "@_has_many_#{label}"
+
+      define_method(label) do
+        memoize(inst_var_memo) do
+          data[label].map do |item|
+            assoc_instance_builder.(item)
+          end
+        end
+      end
+    end
+
+  private
+
+    def build_assoc_class(&block)
+      Class.new do
+        include ActiveModel::Model
+        include Data2ruby
+        extend ActiveModel::Naming
+
+        def self.name
+          'AnonAssociation'
+        end
+
+        def name
+          self.class.name
+        end
+      end
+        .tap { |klass| klass.class_exec(&block) }
+    end
+
+    def build_assoc_instance_builder(klass)
+      lambda do |data|
+        klass.new(data).tap do |obj|
+          obj.define_singleton_method(:data) { data }
+        end
+      end
+    end
+  end # module ClassMethods
+
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
+  def data
+    raise NotImplementedError, 'Implement in the including class'
+  end
+
+  def each(&block)
+    self.class.associations.each do |assoc_name|
+      object = public_send(assoc_name)
+      object.is_a?(Array) ? object.each(&block) : block.yield(object)
+    end
+  end
+
+  def invalid_items
+    reduce(select { |item| item.errors.any? }) do |sum, item|
+      sum + item.invalid_items
+    end
+  end
+
+  def valid_structure?
+    reduce(respond_to?(:valid?) ? valid? : true) do |sum, item|
+      item.valid_structure? && sum # forces to evaluate validity for all the nodes
+    end
+  end
+
+private
+
+  def memoize(var_name, &block)
+    if instance_variable_defined?(var_name)
+      instance_variable_get(var_name)
+    else
+      instance_variable_set(
+        var_name,
+        instance_exec(&block)
+      )
+    end
+  end
+end

data/lib/data2ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Data2ruby
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: data2ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roberto Maestroni
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-28 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'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: 
+email:
+- r.maestroni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data2ruby.gemspec
+- lib/data2ruby.rb
+- lib/data2ruby/version.rb
+homepage: https://github.com/rmaestroni/data2ruby
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Define a DSL in Ruby to validate and access any data
+test_files: []