entity_schema 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2ae5d5a58cb59d7bc39c1461dcb1f6bed390d665ff00e2493234b5a4e1149b66
+  data.tar.gz: 637d69c9e038d9080453f93b5cbe0b716ae40a59153657f73512d6961577b486
+SHA512:
+  metadata.gz: 3dcd2b61052f0ceaa9b1fd815edb9762081ff6aca02abb1ab5096e03eebb911826d1424587246b7e26964c26f327f18d31ef2d3feea833c90267b32d5eb77abc
+  data.tar.gz: d9224aa835f73858ef679c85c71bcfe79ea159cd0c91fbdab5c69a5bd9418a6ce08ff7e8ff25ad961a82935679fc564d519b1ee177addfd0f9f567abc16a01c6

data/.gitignore

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

data/.overcommit.yml

@@ -0,0 +1,37 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/brigade/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/brigade/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/brigade/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+
+PrePush:
+  RSpec:
+    enabled: true
+#
+#  TrailingWhitespace:
+#    enabled: true
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,56 @@
+Metrics/LineLength:
+  Max: 95
+  IgnoredPatterns:
+    - '^ *#.*$'
+
+Naming/UncommunicativeMethodParamName:
+  AllowedNames: io, id, to, by, on, in, at, fk, pk
+
+Style/LambdaCall:
+  Enabled: false
+
+Naming/ConstantName:
+  Exclude:
+    - 'lib/entity_schema.rb'
+
+Style/Documentation:
+  Exclude:
+    - 'lib/entity_schema.rb'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'entity_schema.gemspec'
+
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/entity_schema/dsl_helper.rb'
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/entity_schema/dsl_helper.rb'
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - 'lib/entity_schema/dsl_helper.rb'
+
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/entity_schema/dsl_helper.rb'
+
+Style/Documentation:
+  Exclude:
+    - 'lib/entity_schema.rb'
+    - 'lib/entity_schema/class_methods.rb'
+    - 'lib/entity_schema/dsl_helper.rb'
+    - 'lib/entity_schema/fields/abstract.rb'
+    - 'lib/entity_schema/fields/builders/abstract.rb'
+    - 'lib/entity_schema/fields/builders/belongs_to.rb'
+    - 'lib/entity_schema/fields/builders/collection.rb'
+    - 'lib/entity_schema/fields/builders/fk_belongs_to.rb'
+    - 'lib/entity_schema/fields/builders/object.rb'
+    - 'lib/entity_schema/fields/builders/object_belongs_to.rb'
+    - 'lib/entity_schema/fields/builders/property.rb'
+    - 'lib/entity_schema/fields/collection.rb'
+    - 'lib/entity_schema/fields/object.rb'
+    - 'lib/entity_schema/fields/property.rb'
+    - 'lib/entity_schema/instance_methods.rb'

data/.rubocop_todo.yml

@@ -0,0 +1,26 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-08-20 00:34:58 +0300 using RuboCop version 0.55.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 14
+Style/Documentation:
+  Exclude:
+    - 'lib/entity_schema.rb'
+    - 'lib/entity_schema/class_methods.rb'
+    - 'lib/entity_schema/dsl_helper.rb'
+    - 'lib/entity_schema/fields/abstract.rb'
+    - 'lib/entity_schema/fields/builders/abstract.rb'
+    - 'lib/entity_schema/fields/builders/belongs_to.rb'
+    - 'lib/entity_schema/fields/builders/collection.rb'
+    - 'lib/entity_schema/fields/builders/fk_belongs_to.rb'
+    - 'lib/entity_schema/fields/builders/object.rb'
+    - 'lib/entity_schema/fields/builders/object_belongs_to.rb'
+    - 'lib/entity_schema/fields/builders/property.rb'
+    - 'lib/entity_schema/fields/collection.rb'
+    - 'lib/entity_schema/fields/object.rb'
+    - 'lib/entity_schema/fields/property.rb'
+    - 'lib/entity_schema/instance_methods.rb'

data/.ruby-gemset

@@ -0,0 +1 @@
+entity_schema

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.2

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [0.1.0]
+### Added
++ All base functionality with main specs (141 example)
++ .property
++ .property?
++ .object
++ .collection
++ .has_one
++ .has_many
++ .belongs_to
++ Inheritable

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ph-s@mail.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,92 @@
+PATH
+  remote: .
+  specs:
+    entity_schema (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.2)
+    childprocess (0.9.0)
+      ffi (~> 1.0, >= 1.0.11)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    ffi (1.9.25)
+    formatador (0.2.5)
+    guard (2.14.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-bundler (2.1.0)
+      bundler (~> 1.0)
+      guard (~> 2.2)
+      guard-compat (~> 1.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    iniparse (1.4.4)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.13)
+    method_source (0.9.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    overcommit (0.45.0)
+      childprocess (~> 0.6, >= 0.6.3)
+      iniparse (~> 1.4)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.9.10)
+      ffi (>= 0.5.0, < 2)
+    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.1)
+      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)
+    ruby_dep (1.5.0)
+    shellany (0.0.1)
+    thor (0.20.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug
+  entity_schema!
+  guard
+  guard-bundler
+  guard-rspec
+  overcommit
+  pry
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.3

data/Guardfile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :rspec, cmd: 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})    { 'spec/dsl' }
+  watch(%r{^lib/(.+)\.rb$})    { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { 'spec' }
+end
+
+guard :bundler do
+  watch('Gemfile')
+  watch('entity_schema.gemspec')
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Captain Philipp
+
+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,114 @@
+# EntitySchema
+Class-level DSL for mapping Hash with object-like structure to Object (as Entity), and then return it into Hash.
+
+Focused on quick, minimal, lazy interaction with source Hash.
+
+#### Describe entity structure:
+```ruby
+class Product
+  property  :id
+  property  :title
+  property? :enabled
+  property? :new,        key: :is_new
+  property? :sale,       key: :is_sale
+  property? :bestseller, key: :is_bestseller
+  timestamps
+
+  object :size, map_to: Values::Size
+
+  belongs_to :color, { color_uid: :uid }, map_to: Color
+  has_many   :seasons,                    map_to: Season
+end
+```
+
+#### Create entity from hash:
+```ruby
+raw_hash = {
+  id: 42,
+  title: 'Perfect product',
+  enabled: true,
+  is_new: false,
+  is_sale: false,
+  is_bestseller: true,
+  created_at: '2018-08-16 20:17:55 UTC',
+  updated_at: '2018-08-16 20:17:55 UTC',
+  size: { ... size params ... },
+  color_uid: 7,
+  seasons: [{ ... season params ... }, {...}, ...]
+}
+
+product = Product.new(raw_hash)
+product.title
+product.sale?
+product.size            # => <Values::Size ... >
+product.seasons         # => [<Season ... >, <Season ... >, ...]
+
+product.color           # => <Color @uid=7 ... >
+product.color_uid       # => 7
+product.color = nil     # => nil
+product.color_uid       # => nil
+```
+
+#### Return entity to hash:
+```ruby
+product.to_h
+# => {
+# =>   id: 42,
+# =>   title: 'Perfect product',
+# =>   enabled: true,
+# =>   is_new: false,
+# =>   is_sale: false,
+# =>   is_bestseller: true,
+# =>   created_at: '2018-08-16 20:17:55 UTC',
+# =>   updated_at: '2018-08-16 20:17:55 UTC',
+# =>   size: { ... size params ... },
+# =>   color_uid: nil,
+# =>   seasons: [{ ... seasons params ... }, {...}, ...]
+# => }
+```
+
+## Validations, and coercions
+
+No. Entity assumes that given data already validated and coerced.
+
+## DSL
+
+#### property
+
+_TODO_
+
+#### property?
+
+_TODO_
+
+#### timestamps
+
+It is sugar, that expanded to:
+```ruby
+property :created_at, **opts
+property :updated_at, **opts
+```
+
+#### object
+
+_TODO_
+
+#### has_one
+
+Just alias for `object`
+
+#### collection
+
+_TODO_
+
+#### has_many
+
+Just alias for `collection`
+
+#### belongs_to
+
+_TODO_
+
+## Instance methods
+
+_TODO_