generic_view_mapper 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7cd69f82ed2905739322dab386bad226697a2249
+  data.tar.gz: a30c9c77dd9b2731ac30ceda9576361a1b94c415
+SHA512:
+  metadata.gz: 7eb564142523e36bc029d277e72c7cb28eb4345c132a2c225a78887d49ebf3eb304b46990ecbe8c3224f99359117127cf0bfe810880d43c6f9b380078ba879db
+  data.tar.gz: 1d845354fa2714988ecc849a0bb240795ba14a60fcf3ca05a6f3b40f8df1247ba1911c36c77433b38a080a5807355e032ace436b77b3bf3dd97f680f0509d877

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
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.0.pre.2
+script:
+  - bundle exec rake spec

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

data/Gemfile.lock

@@ -0,0 +1,89 @@
+PATH
+  remote: .
+  specs:
+    generic_view_mapper (0.1.1)
+      activesupport (~> 5)
+      descendants_tracker (~> 0.0.4)
+      dry-container (~> 0.6)
+      multi_json (~> 1)
+      virtus (~> 1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    byebug (9.1.0)
+    coderay (1.1.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    concurrent-ruby (1.0.5)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    diff-lcs (1.3)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    dry-container (0.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    equalizer (0.0.11)
+    given_core (3.8.0)
+      sorcerer (>= 0.3.7)
+    i18n (0.8.6)
+    ice_nine (0.11.2)
+    method_source (0.8.2)
+    minitest (5.10.3)
+    multi_json (1.12.2)
+    pry (0.11.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+    pry-byebug (3.5.0)
+      byebug (~> 9.1)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-given (3.8.0)
+      given_core (= 3.8.0)
+      rspec (>= 2.14.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    sorcerer (1.0.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+    virtus (1.0.5)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0, >= 0.0.3)
+      equalizer (~> 0.0, >= 0.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16.a)
+  generic_view_mapper!
+  pry-byebug (~> 3.5)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rspec-given (~> 3.8)
+
+BUNDLED WITH
+   1.16.0.pre.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Cainã Costa
+
+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,42 @@
+# GenericViewMapper
+
+[![Build Status](https://travis-ci.org/cfcosta/generic_view_mapper.svg)](https://travis-ci.org/cfcosta/generic_view_mapper)
+[![Code Climate](https://codeclimate.com/github/cfcosta/generic_view_mapper.svg)](https://codeclimate.com/github/cfcosta/generic_view_mapper)
+
+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/generic_view_mapper`. 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 'generic_view_mapper'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install generic_view_mapper
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/[USERNAME]/generic_view_mapper.
+
+## 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 "generic_view_mapper"
+
+# 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/generic_view_mapper.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "generic_view_mapper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "generic_view_mapper"
+  spec.version       = GenericViewMapper::VERSION
+  spec.authors       = ["Cainã Costa"]
+  spec.email         = ["cacosta@redhat.com"]
+
+  spec.summary       = %q{Generalistic view layer to match and present incoming data}
+  spec.homepage      = "https://github.com/cfcosta/match_view"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 5"
+  spec.add_dependency "multi_json", "~> 1"
+  spec.add_dependency "virtus", "~> 1"
+  spec.add_dependency "dry-container", "~> 0.6"
+  spec.add_dependency "descendants_tracker", "~> 0.0.4"
+
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-given", "~> 3.8"
+  spec.add_development_dependency "pry-byebug", "~> 3.5"
+end

data/lib/generic_view_mapper.rb

@@ -0,0 +1,23 @@
+require 'generic_view_mapper/version'
+require 'generic_view_mapper/view'
+require 'generic_view_mapper/entity'
+require 'generic_view_mapper/registry'
+require 'generic_view_mapper/registry_matcher'
+
+if defined?(Rails::Railtie)
+  require 'generic_view_mapper/rails/autoregister'
+  require 'generic_view_mapper/railtie'
+end
+
+module GenericViewMapper
+  extend self
+
+  def registry
+    Thread.current[:gvm_registry] ||= Registry.new.tap(&:register_all)
+  end
+
+  def render(data)
+    matcher = RegistryMapper.new(registry)
+    matcher.find_view_for(matcher.find_entity_for(data))
+  end
+end

data/lib/generic_view_mapper/entity.rb

@@ -0,0 +1,13 @@
+require 'virtus'
+require 'descendants_tracker'
+
+module GenericViewMapper
+  class Entity
+    include Virtus.model
+    extend DescendantsTracker
+
+    def self.applicable?(_)
+      raise NotImplementedError, 'should be implemented by subclasses'
+    end
+  end
+end

data/lib/generic_view_mapper/rails/autoregister.rb

@@ -0,0 +1,16 @@
+module GenericViewMapper
+  module AutoReload
+    def extended(base)
+      super(base)
+      GenericViewMapper.registry.reload
+    end
+  end
+
+  class View
+    extend AutoReload
+  end
+
+  class Entity
+    extend AutoReload
+  end
+end

data/lib/generic_view_mapper/railtie.rb

@@ -0,0 +1,9 @@
+require 'rails'
+
+module MatchView
+  class Railtie < Rails::Railtie
+    initializer 'generic_view_mapper.setup_registry' do
+      GenericViewMapper.registry.reload
+    end
+  end
+end

data/lib/generic_view_mapper/registry.rb

@@ -0,0 +1,64 @@
+require 'active_support/inflector'
+
+module GenericViewMapper
+  class Registry
+    attr_reader :data
+
+    TRACKED_CLASSES = [
+      Entity,
+      View
+    ].freeze
+
+    def initialize
+      @data = Hash.new { |h,k| h[k] = [] }
+    end
+
+    def [](val)
+      @data[val]
+    end
+
+    def reload
+      data.clear
+      register_all
+    end
+
+    def register(*classes)
+      classes.each do |klass|
+        name = class_name_for(klass)
+        @data[name] << [klass, ancestors_count_for(klass)]
+      end
+    end
+
+    def registered?(klass)
+      @data.any? { |(_,k)| k.map(&:first).include?(klass) }
+    end
+
+    def register_all
+      TRACKED_CLASSES.each do |klass|
+        klass.descendants.each { |k| register(k) }
+      end
+    end
+
+    private
+
+    def class_name_for(klass)
+      klass
+        .ancestors
+        .find { |x| TRACKED_CLASSES.include?(x) }
+        .name
+        .underscore
+        .split('/')
+        .last
+        .pluralize
+        .to_sym
+    end
+
+    def ancestors_count_for(klass)
+      klass
+        .ancestors
+        .reverse
+        .drop_while { |x| !TRACKED_CLASSES.include?(x) }
+        .count
+    end
+  end
+end

data/lib/generic_view_mapper/registry_matcher.rb

@@ -0,0 +1,25 @@
+module GenericViewMapper
+  class RegistryMatcher
+    attr_reader :registry
+
+    def initialize(registry)
+      @registry = registry
+    end
+
+    def find_entity_for(data)
+      get_list_for(:entities)
+        .find { |x| x.applicable?(data) }
+    end
+
+    def find_view_for(entity)
+      get_list_for(:views)
+        .find { |x| x.applies_to?(entity) }
+    end
+
+    private def get_list_for(key)
+      registry[key]
+        .sort { |a,b| b.last <=> a.last }
+        .map { |x| x.first }
+    end
+  end
+end

data/lib/generic_view_mapper/version.rb

@@ -0,0 +1,3 @@
+module GenericViewMapper
+  VERSION = "0.1.1"
+end

data/lib/generic_view_mapper/view.rb

@@ -0,0 +1,33 @@
+require_relative 'view/schema_definition'
+require_relative 'view/import'
+require_relative 'view/attribute'
+require_relative 'view/section'
+
+require 'descendants_tracker'
+
+module GenericViewMapper
+  class View
+    extend DescendantsTracker
+    include SchemaDefinition
+    include Import
+
+    def self.applies_to(*classes)
+      @applies_to ||= classes
+    end
+
+    def self.applies_to?(object)
+      klass = object.is_a?(Class) ? object : object.class
+      @applies_to.include?(klass)
+    end
+
+    attr_reader :target
+
+    def initialize(target)
+      @target = target
+    end
+
+    def as_json(*)
+      render(target, self)
+    end
+  end
+end

data/lib/generic_view_mapper/view/attribute.rb

@@ -0,0 +1,34 @@
+require 'active_support/inflector'
+
+module GenericViewMapper
+  class Attribute
+    attr_reader :name, :options
+
+    def initialize(name, options)
+      @name = name
+      @options = options
+    end
+
+    def field_name
+      options
+        .fetch(:as) { name }
+        .to_s
+        .camelize(:lower)
+        .to_sym
+    end
+
+    def send_to(target, view_context)
+      name.to_s.split('.').inject(target) do |obj, method|
+        if view_context.respond_to?(method)
+          view_context.public_send(method)
+        else
+          obj.public_send(method)
+        end
+      end
+    end
+
+    def render(target, view_context)
+      { field_name => send_to(target, view_context) }
+    end
+  end
+end

data/lib/generic_view_mapper/view/import.rb

@@ -0,0 +1,41 @@
+require 'yaml'
+
+require 'multi_json'
+require 'active_support/core_ext/hash/keys'
+
+module GenericViewMapper
+  module Import
+    def self.included(base)
+      base.extend DSL
+    end
+
+    module DSL
+      def json(source)
+        import(MultiJson.decode(source, symbolize_keys: true))
+      end
+
+      def from_json(source)
+        Class.new(self) { json(source) }
+      end
+
+      def yaml(source)
+        import(YAML.safe_load(source).deep_symbolize_keys)
+      end
+
+      def from_yaml(source)
+        Class.new(self) { yaml(source) }
+      end
+
+      def import(hash)
+        hash.each do |(k, v)|
+          case v
+          when Hash
+            attribute(v[:name], v)
+          when Array
+            section(k) { v.each { |f| attribute(f[:name], f) } }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generic_view_mapper/view/schema_definition.rb

@@ -0,0 +1,43 @@
+module GenericViewMapper
+  module SchemaDefinition
+    module DSL
+      def attributes
+        @attributes ||= if is_a?(Class) && superclass.respond_to?(:attributes)
+                          superclass.attributes.clone
+                        else
+                          []
+                        end
+      end
+
+      def attributes=(value)
+        @attributes = value
+      end
+
+      def attribute(name, options = {})
+        attributes << Attribute.new(name, options)
+      end
+
+      def section(name, &block)
+        section = Section.new(name)
+
+        if (old_section = attributes.find { |x| x.name == name })
+          attributes.delete(old_section)
+          section.attributes += old_section.attributes
+        end
+
+        section.instance_eval(&block)
+        attributes << section
+      end
+    end
+
+    def self.included(base)
+      base.extend(DSL)
+    end
+
+    def render(target, view_context)
+      self.class.attributes.inject({}) do |accum, el|
+        accum.merge(el.render(target, view_context))
+      end
+    end
+  end
+end

data/lib/generic_view_mapper/view/section.rb

@@ -0,0 +1,27 @@
+module GenericViewMapper
+  class Section
+    include SchemaDefinition::DSL
+    include Import::DSL
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def field_name
+      name
+        .to_s
+        .camelize(:lower)
+        .to_sym
+    end
+
+    def render(target, view_context)
+      {
+        field_name => attributes.inject({}) do |accum, el|
+          accum.merge(el.render(target, view_context))
+        end
+      }
+    end
+  end
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: generic_view_mapper
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Cainã Costa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: descendants_tracker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !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: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: 
+email:
+- cacosta@redhat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- generic_view_mapper.gemspec
+- lib/generic_view_mapper.rb
+- lib/generic_view_mapper/entity.rb
+- lib/generic_view_mapper/rails/autoregister.rb
+- lib/generic_view_mapper/railtie.rb
+- lib/generic_view_mapper/registry.rb
+- lib/generic_view_mapper/registry_matcher.rb
+- lib/generic_view_mapper/version.rb
+- lib/generic_view_mapper/view.rb
+- lib/generic_view_mapper/view/attribute.rb
+- lib/generic_view_mapper/view/import.rb
+- lib/generic_view_mapper/view/schema_definition.rb
+- lib/generic_view_mapper/view/section.rb
+homepage: https://github.com/cfcosta/match_view
+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.11
+signing_key: 
+specification_version: 4
+summary: Generalistic view layer to match and present incoming data
+test_files: []