document_serializable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e159598f8b640d262643ee4b08e96219d853bb78
+  data.tar.gz: 9739d792e201b54b906f3557057adb52a5956fc5
+SHA512:
+  metadata.gz: 543eba20857ad0ecf565ee6c42fc15b26ac4522b501106ba06e7908ddfb411c068864373afed42caacf5b844720f622e1290213430f2e6001cacb571ca34868b
+  data.tar.gz: d72a1d0271c2187423c992d9eff3c1a36117560187a801a66b7cfdce16e98c42ec170227f594836c6fda9d49a780b71aca9b2e8e618bdb81b4f6b51801887860

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in document_serializable.gemspec
+gemspec
+
+
+gem "bundler"
+gem "rake"
+gem "rspec", "~> 3.0"
+gem "pry-byebug"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Alex
+
+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,77 @@
+# DocumentSerializable
+
+[![CircleCI](https://circleci.com/gh/nerdgeschoss/document_serializable/tree/master.svg?style=svg)](https://circleci.com/gh/nerdgeschoss/document_serializable/tree/master)
+
+Serialize your object hierarchy in a document based style to your relational database via virtus.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'document_serializable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install document_serializable
+
+## Usage
+
+Define your model:
+
+```bash
+rails g model Invoice properties:jsonb:index
+```
+
+```ruby
+class Address
+  include Virtus.model
+
+  attribute :name
+  attribute :city
+end
+
+class Invoice < ApplicationRecord
+  include DocumentSerializable	
+
+  attribute address, Address
+  attribute subject
+end
+```
+
+Then initialize it with content and access attributes directly from your model:
+
+```ruby
+invoice = Invoice.new subject: "Pay me!", address: { name: "Jon Doe", city: "New York" }
+invoice.address.name # Jon Doe
+invoice.subject # Pay me!
+invoice.save!
+```
+
+This works for all models that have a serialized attribute named `properties` (e.g. json column in MySQL or jsonb in Postgres).
+
+You can also query for properties (in Postgres):
+
+```ruby
+Invoice.where("properties @> ?", { address: { city: "New York" } }.to_json)
+```
+
+## 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/Alex/document_serializable.
+
+
+## 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "document_serializable"
+
+# 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/document_serializable.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'document_serializable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "document_serializable"
+  spec.version       = DocumentSerializable::VERSION
+  spec.authors       = ["Alex"]
+  spec.email         = ["aleksandra@nerdgeschoss.de"]
+
+  spec.summary       = "Document serializer"
+  spec.homepage      = "https://github.com/nerdgeschoss/document_serializable"
+  spec.license       = "MIT"
+
+  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 "activesupport"
+  spec.add_dependency "virtus"
+end

data/lib/document_serializable.rb

@@ -0,0 +1,48 @@
+require "document_serializable/version"
+require "active_support"
+require "active_support/core_ext"
+require "virtus"
+
+module DocumentSerializable
+  extend ActiveSupport::Concern
+
+  included do
+    def attributes
+      property_object.attributes.merge(super)
+    end
+
+    def reload(options = nil)
+      super
+      @property_object = nil
+      self
+    end
+
+    private
+
+    def property_object
+      @property_object ||= begin
+        properties = self.properties
+        properties = JSON.parse(properties) if properties.is_a? String
+        self.class.property_class.new(properties || {})
+      end
+    end
+
+    before_validation do
+      self.properties = property_object.attributes
+    end
+  end
+
+  class_methods do
+    def property_class
+      @property_class ||= begin
+        Class.new(superclass.try(:property_class) || Object) { include Virtus.model(nullify_blank: true) }
+      end
+    end
+
+    def attribute(name, type = String, options = {})
+      property_class.send :attribute, name, type, options
+      delegate name, to: :property_object
+      delegate "#{name}=".to_sym, to: :property_object
+    end
+  end
+end

data/lib/document_serializable/version.rb

@@ -0,0 +1,3 @@
+module DocumentSerializable
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: document_serializable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- aleksandra@nerdgeschoss.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- document_serializable.gemspec
+- lib/document_serializable.rb
+- lib/document_serializable/version.rb
+homepage: https://github.com/nerdgeschoss/document_serializable
+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.8
+signing_key: 
+specification_version: 4
+summary: Document serializer
+test_files: []