universe_compiler 0.2.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fcdb61ff730d5df5a1e0f6117d0a992efc00e5ca
+  data.tar.gz: 1eb29fbfe6f5bb1b25546e27b874cd952eb86569
+SHA512:
+  metadata.gz: d09a32e939341ab78b41f265efdab69512a5adf29e1abb1be65e87cfa92448823e2bf49007df317fe90a2c4d8d0ec948bfce78c5f0122a53cc11cec3e89f96c8
+  data.tar.gz: 74b250059abf728d8df27ada84439da8025fc2fd1e310e70ff9626eb7ec3c02d67059456f5a846b33274e9346b52d453e01976f28f7258504b96b87b909f85da

data/.gitignore

@@ -0,0 +1,183 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+### Standard Brewlabs Gem template
+### Ruby template
+*.gem
+*.rbc
+/.config
+/InstalledFiles
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/rdoc/
+
+## Environment normalization:
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+### SublimeText template
+# cache files for sublime text
+*.tmlanguage.cache
+*.tmPreferences.cache
+*.stTheme.cache
+
+# workspace files are user-specific
+*.sublime-workspace
+
+# project files should be checked into the repository, unless a significant
+# proportion of contributors will probably not be using SublimeText
+# *.sublime-project
+
+# sftp configuration file
+sftp-config.json
+
+# Package control specific files
+Package Control.last-run
+Package Control.ca-list
+Package Control.ca-bundle
+Package Control.system-ca-bundle
+Package Control.cache/
+Package Control.ca-certs/
+bh_unicode_properties.cache
+
+# Sublime-github package stores a github token in this file
+# https://packagecontrol.io/packages/sublime-github
+GitHub.sublime-settings
+### KDevelop4 template
+*.kdev4
+.kdev4/
+### Linux template
+*~
+
+# temporary files which can be created if a process still has a handle open of a deleted file
+.fuse_hidden*
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+# .nfs files are created when an open file is removed but is still being accessed
+.nfs*
+### Eclipse template
+
+.metadata
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+.recommenders
+
+# Eclipse Core
+.project
+
+# External tool builders
+.externalToolBuilders/
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# PyDev specific (Python IDE for Eclipse)
+*.pydevproject
+
+# CDT-specific (C/C++ Development Tooling)
+.cproject
+
+# JDT-specific (Eclipse Java Development Tools)
+.classpath
+
+# Java annotation processor (APT)
+.factorypath
+
+# PDT-specific (PHP Development Tools)
+.buildpath
+
+# sbteclipse plugin
+.target
+
+# Tern plugin
+.tern-project
+
+# TeXlipse plugin
+.texlipse
+
+# STS (Spring Tool Suite)
+.springBeans
+
+# Code Recommenders
+.recommenders/
+### VisualStudioCode template
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff:
+.idea/
+
+## File-based project format:
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,3 @@
+---
+Metrics/LineLength:
+  Max: 132

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.4
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at lbnetid+gh@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Laurent B.
+
+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,318 @@
+# UniverseCompiler
+
+The goal of this gem is to provide a simple way to manage a consistent highly complex configuration.
+
+The configuration can be split into lot of objects (or `entities`) and complex relations and constraints
+can be defined between them using a-la-ActiveRecord relationships like `has_many` or `is_array` (see 
+complete list in `lib/universe_compiler/entity/field_constraint_management.rb`).
+
+These entities are added to a so-called `universe`.
+See a universe as a kind of sandbox where entities exist.
+
+A `universe` could be _persisted_ to any kind of backend by writing an persistence engine, yet only 
+a yaml persistence engine is available by default in the gem. 
+ 
+A `universe` can be _compiled_ in order to produce a new `universe` where all constraints and relations defined
+by these entities have been resolved.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'universe_compiler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install universe_compiler
+
+
+## Core Concepts
+
+### Entities
+
+#### Overview
+
+Any `entity` you will create will basically inherit from `UniverseCompiler::Entity::Base`. This will allow
+the following kind of code:
+
+```ruby
+class EntityA < UniverseCompiler::Entity::Base
+  entity_type :some_entity
+  
+  field :some_data, :is_hash
+  field :bar, :not_null, should_match: /^Y/
+  field :stupid
+  
+  has_one EntityA, name: :master
+
+end
+
+class EntityB < UniverseCompiler::Entity::Base
+  
+  has_many EntityA, name: :some_entities
+  not_empty :some_entities
+  
+end
+
+```
+The core concept is that every entity has a hash property named `fields`. And any field declared using
+ the declaration mechanism as above just adds some content validations mechanisms and direct accessors 
+ to the internal `fields` hash.
+ 
+For example:
+
+```ruby
+a = EntityA.new fields: { stupid: :foo}
+
+a.stupid # => :foo 
+a.stupid == a[:stupid] # => true
+a.stupid == a.fields[:stupid] # => true
+a.stupid == a['stupid'] # => false, a String is not a Symbol
+```
+
+Therefore the _pseudo schema_ you defined when declaring the class is not limiting... you can always do
+
+```ruby
+a[:non_explicitely_declared_property] = :bar
+a[:non_explicitely_declared_property] # => :bar
+# but
+a.non_explicitely_declared_property # => NoMethodError: undefined method `non_existing_property' for...
+```
+
+Every entity has a `valid?` method which performs various checks. For example here we have said that 
+an instance of `EntityB` has many entities of type `EntityA`. You can really see a `has_many` relationship
+an the definition of an Array which content is validated:
+
+```ruby
+b = EntityB.new
+b.valid? # => false
+b.some_entities << :foo
+b.valid? # => false, :foo is not of the expected type
+b.clear
+b.valid? # => false
+b.some_entities << b
+b.valid? # => false, b is not of the expected type
+b.clear
+b.some_entities << a
+b.valid? # => true, a is ok
+```
+In the same vein:
+```ruby
+a.valid? # => false
+a.some_entity = a
+a.valid? # => false, still false as requiring a non null :bar property
+a.bar = 'hey man'
+a.valid? # => false, not compliant with regexp specified
+a.bar = 'Yo man'
+a.valid? # => true
+```
+#### Special directives
+
+By default every entity has a `type`. It is available using the `#type` instance method or the
+`::entity_type` class method. The default value for the entity type is coming
+from the class name but it can be overridden using the `entity_type` directive:
+```ruby
+EntityA.entity_type # => :some_entity
+EntityB.entity_type # => "entity_b"
+a = EntityA.new # => #<EntityA:47429412219120 composite_key=[:some_entity, nil]>
+a.type # => :some_entity
+b = EntityB.new # => #<EntityB:47429411925900 composite_key=["entity_b", nil]>
+b.type # => "entity_b"
+```
+
+The `name` of an entity can be automatically generated using the `auto_named_entity_type`
+directive optionally providing a seed:
+
+```ruby
+class EntityC < UniverseCompiler::Entity::Base
+  auto_named_entity_type
+end
+class EntityD < UniverseCompiler::Entity::Base
+  auto_named_entity_type :my_seed
+end
+
+EntityC.new # => #<EntityC:46943375076460 composite_key=["entity_c", "entity_c_1"]>
+EntityD.new # => #<EntityD:46943378308720 composite_key=["entity_d", "my_seed_1"]>
+EntityD.new # => #<EntityD:46943375641700 composite_key=["entity_d", "my_seed_2"]>
+```
+
+
+#### Constraints and relationships directives
+
+The generic form to declare a field is the `field` statement. Any constraint can be declared using the `field`
+method. Here is the signature:
+
+```ruby
+def field(field_name, *options)
+```
+
+Then other _constraint_ methods that can be used when describing an entity can be grouped into two. The switches:
+
+* not_null
+* not_empty 
+* is_array
+* is_hash
+
+Then some methods taking parameter:
+
+* should_match 
+* class_name
+
+You have as well relationship methods:
+
+* has_one
+* has_many
+
+So for each of these methods can be used either as "real" methods or as `field` parameter. For example:
+```ruby
+class MyEntity < UniverseCompiler::Entity::Base
+  field :my_field, :not_null, class_name: AClass 
+end
+```
+Is strictly equivalent to:
+```ruby
+class MyEntity < UniverseCompiler::Entity::Base
+  not_null :my_field
+  class_name :my_field, AClass 
+end
+```
+Notice the fact that in the latter form `my_field` is "declared" more than once.  
+ 
+
+### Compilation
+
+The compilation mechanism is related to universes.
+When compiling a universe it actually:
+
+* Creates a __new universe__ containing __deep copies__ of its original entities.
+* Applies entities inheritance defined by the special field `extends`.
+* Applies overrides defined by the `:entity_overide` special entity type.
+
+Here is an example
+```ruby
+u = UniverseCompiler.new_universe
+# Adding entities to universe requires they have a name
+a = EntityA.new fields: { name: :a, bar: 'Yo man', stupid: :yeah } # a is valid
+b = EntityA.new fields: { name: :b, extends: a } # Notice b is not valid but extends a
+u << a << b
+
+v = u.compile # v is a new universe result of the "compilation" of u
+u.name # => "Unnamed Universe"
+v.name # => "Unnamed Universe - COMPILED #47332840258780"
+
+compiled_b = v.get_entity :some_entity, :b
+compiled_b == b # => true, b and compiled_b although different represent the same entity
+compiled_b.eql? b # => false, b and compiled_b are in different universe
+compiled_b.equal? b # => false, b and compiled_b have different object_id
+b.valid? # => false, in the universe u, b is still not valid
+compiled_b.valid? # => true, thanks to the fact b extends a
+a.fields # => {:name=>:a, :bar=>"Yo man", :stupid=>:yeah, :some_data=>{}}
+b.fields # => {:name=>:b, :extends=>#<EntityA:47405166007800 composite_key=[:some_entity, :a], @universe='Unnamed Universe'>, :some_data=>{}}
+compiled_b.fields # => {:name=>:b, :bar=>"Yo man", :stupid=>:yeah, :some_data=>{}, :extends=>#<EntityA:47405171122480 composite_key=[:some_entity, :a], @universe='Unnamed Universe - COMPILED #47405171131080'>}
+```
+And each entity in the new universe will have the flag `compiled` set to `true`.
+
+```ruby
+u.get_entities.map do |entity|
+  {name: entity.name, compiled: entity.compiled}
+end
+# => [{name: :a, compiled: false},{name: :b, compiled: false},{name: :c, compiled: false}]
+v.get_entities.map do |entity|
+  {name: entity.name, compiled: entity.compiled}
+end
+# => [{name: :a, compiled: true},{name: :b, compiled: true},{name: :c, compiled: true}]
+```
+
+### Inheritance
+
+To be clear, here we talk about __entities (instances) inheritance, NOT classes !__
+
+Each entity can potentially extend (using the `extends` field) one entity... which itself could extend 
+as well another entity. __Circular references are detected and compilation may fail.__
+
+When you `extends` another entity, it means that when the universe "compiles", it will perform 
+ some merge operations. e.g. for the the following inheritance definition:
+```
+u1.a --extends--> u1.b --extends--> u1.c
+```
+It means that if you have a universe u1 containing these entities a, b, c and you compile it, the resulting universe,
+ let's call it u2, will contain 3 new entities a, b and c which content will be (all content is 
+ duplicated):
+
+* u2.c content is the __same as u1.c__. 
+* u2.b content will be __the merge of u1.b into u2.c__.
+* u2.a content will be __the merge of u1.a into u2.b__.
+
+Of course the compilation process keeps the initial relationships. 
+
+```
+u2.a --extends--> u2.b --extends--> u2.c
+```
+You can see an example of inheritance in previous paragraph.
+
+### Overrides
+
+Overrides are actually a special type of entities. They have a special array called `overrides`
+which contains a list of entities you want to inject content into.
+
+When you override entity `a` with override `o`, it means that the content (fields) of `o` will be _injected_
+ into `a` (fields). This is why an override can override multiple objects of multiple types, because this
+ is just about content injection. Of course as already said, it occurs during the compilation process and only
+ in the "compiled" universe. The original universe is meant to remain unmodified.
+ 
+Overrides are only applied in the context of a `scenario`
+
+```ruby
+u = UniverseCompiler.new_universe
+a = EntityA.new fields: { name: :a, bar: 'Yo man', stupid: :yeah } 
+b = EntityA.new fields: { name: :b, extends: a } 
+o = UniverseCompiler.new_override fields: { name: :my_override, scenario: :test_overrides, a_new_stuff: :hey, overrides: [a, b] }
+u << a << b << o
+
+o.type # => :entity_override
+v = u.compile scenario: :test_overrides
+v.get_entities.map &:fields
+# => [{:name=>:a,
+#      :bar=>"Yo man",
+#      :stupid=>:yeah,
+#      :some_data=>{},
+#      :a_new_stuff=>:hey},
+#     {:name=>:b,
+#      :bar=>"Yo man",
+#      :stupid=>:yeah,
+#      :some_data=>{},
+#      :extends=>
+#          #<EntityA:47368495795560 composite_key=[:some_entity, :a], @universe='Unnamed Universe - COMPILED #47368495813960'>,
+#          :a_new_stuff=>:hey},
+#     {:name=>:my_override,
+#      :scenario=>:test_overrides,
+#      :a_new_stuff=>:hey,
+#      :overrides=>
+#          [#<EntityA:47368495795560 composite_key=[:some_entity, :a], @universe='Unnamed Universe - COMPILED #47368495813960'>,
+#           #<EntityA:47368495725460 composite_key=[:some_entity, :b], @universe='Unnamed Universe - COMPILED #47368495813960'>]}]
+#
+```
+You can see there that the compiled version of `b` contains both data coming from the inheritance mechanism 
+as well as those coming from the override...
+
+## 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 Gitlab at https://gitlab.com/lbriais/universe_compiler. 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](http://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,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'universe_compiler'
+
+# 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.
+
+require 'pry'
+Pry.start

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/universe_compiler/entity/auto_named.rb

@@ -0,0 +1,31 @@
+
+module UniverseCompiler
+  module Entity
+
+    module AutoNamed
+
+      attr_reader :auto_named_entity_type_seed
+
+      def auto_named_entity_type(seed = nil)
+        @auto_named_entity_type = true
+        @auto_named_entity_type_seed = if seed.nil?
+                                         entity_type.to_s
+                                       else
+                                         seed
+                                       end
+        @entity_type_counter = 0
+      end
+
+      def auto_named_entity_type?
+        @auto_named_entity_type
+      end
+
+      def get_unique_name
+        @entity_type_counter += 1
+        '%s_%u' % [auto_named_entity_type_seed, @entity_type_counter]
+      end
+
+    end
+
+  end
+end