dao-entity 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42b6d9d9132f8b835b675e81e2b0db4f7671fb72
+  data.tar.gz: 4d2d416595294a9f8f9e7877d0bb333d20e1463c
+SHA512:
+  metadata.gz: f3affef47f0c8dffd5bcd95a43d809cad170047fe962712541a599df12b59bea72c2ea6eea9ee52bfb783873d7f880a53047450b16d6e423d2dd4ef5bd26e85e
+  data.tar.gz: 8e61d2ea6136e356df1989a612584ece23d08ff5a0ee0707bd94d69cb697409b86b884b991210711b657f57678da9a9df602af58237e0efa968b43f49ff70e0c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+.ruby-gemset
+.ruby-version

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 llxff
+
+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,64 @@
+# Dao::Entity
+
+[![Build Status](https://travis-ci.org/dao-rb/dao-entity.svg?branch=master)](https://travis-ci.org/dao-rb/dao-entity)
+[![Code Climate](https://codeclimate.com/github/dao-rb/dao-entity/badges/gpa.svg)](https://codeclimate.com/github/dao-rb/dao-entity)
+[![Test Coverage](https://codeclimate.com/github/dao-rb/dao-entity/badges/coverage.svg)](https://codeclimate.com/github/dao-rb/dao-entity/coverage)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dao-entity'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dao-entity
+
+## Usage
+
+```ruby
+require 'dao/entity'
+
+class CommentEntity < Dao::Entity::Base
+  attribute :body, String
+end
+
+class PostEntity < Dao::Entity::Base
+  attribute :id,       Integer
+  attribute :body,     String
+
+  attribute :comments, Array[CommentEntity]
+end
+
+post = PostEntity.new(id: 1, body: 'Post body', comments: [{ id: 1, body: 'Comment body' }])
+
+post.id # => 1
+post.body # => "Post body"
+post.comments # => [#<CommentEntity:0x007ffdcb923a30>]
+
+post.body = 'New body'
+post.entity_state.body_changed? # => true
+post.entity_state.body_was # => "Post body"
+```
+
+## 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/dao-rb/dao-entity.
+
+
+## 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 "dao/entity"
+
+# 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

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/dao-entity.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dao/entity/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dao-entity'
+  spec.version       = Dao::Entity::VERSION
+  spec.authors       = ['llxff', 'ssnikolay']
+  spec.email         = ['ll.wg.bin@gmail.com']
+
+  spec.summary       = 'Base entity'
+  spec.description   = 'Base entity'
+  spec.homepage      = 'https://github.com/dao-rb/dao-entity'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.2.2'
+
+  spec.add_dependency 'virtus', '~> 1.0'
+  spec.add_dependency 'activemodel', '>= 4.2'
+  spec.add_dependency 'activesupport', '>= 4.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency 'rspec-its'
+end

data/lib/dao/entity.rb

@@ -0,0 +1,12 @@
+require 'dao/entity/version'
+require 'virtus'
+require 'active_support/all'
+require 'active_model/attribute_methods'
+require 'active_model/dirty'
+require 'dao/entity/state'
+require 'dao/entity/base'
+
+module Dao
+  module Entity
+  end
+end

data/lib/dao/entity/base.rb

@@ -0,0 +1,61 @@
+module Dao
+  module Entity
+    class Base
+      include Virtus.model
+
+      attr_accessor :initialized_with
+
+      def initialize(attrs = {})
+        super
+        @initialized_with = []
+        @entity_state = self.class.state_class.new(attributes)
+      end
+
+      def initialized_with=(attrs)
+        @initialized_with = attrs.presence || []
+      end
+
+      def persisted?
+        id.present? if respond_to?(:id)
+      end
+
+      def entity_state
+        @entity_state.tap { |s| s.assign_attributes(attributes) }
+      end
+
+      def to_key
+        key = respond_to?(:id) && id
+        key ? [key] : nil
+      end
+
+      def hash
+        "#{ self.class.name }/#{ identity }".hash
+      end
+
+      def ==(other)
+        hash == other.hash
+      end
+
+      def <=>(other)
+        id <=> other.id
+      end
+
+      alias eql? ==
+      alias equal? eql?
+
+      private
+
+      def self.state_class
+        @state_class ||= State.build_with_attrs(attribute_set.collect(&:name))
+      end
+
+      def identity
+        if respond_to?(:id)
+          id
+        else
+          object_id
+        end
+      end
+    end
+  end
+end

data/lib/dao/entity/state.rb

@@ -0,0 +1,44 @@
+module Dao
+  module Entity
+    class State
+      include ActiveModel::Dirty
+
+      def self.build_with_attrs(attrs)
+        state = Class.new(self)
+
+        state.define_attribute_methods *attrs
+
+        state.send(:attr_accessor, *attrs)
+        attrs.each do |attr|
+          state.send(:define_method, "#{ attr }=") do |val|
+            if public_send(attr) != val
+              attribute_will_change!(attr)
+              instance_variable_set("@#{ attr}", val)
+            end
+          end
+        end
+
+        state
+      end
+
+      def initialize(params={})
+        assign_attributes(params)
+        changes_applied
+      end
+
+      def assign_attributes(params)
+        params.each do |attr, value|
+          self.public_send("#{attr}=", value)
+        end
+      end
+
+      def reload!
+        clear_changes_information
+      end
+
+      def rollback!
+        restore_attributes
+      end
+    end
+  end
+end

data/lib/dao/entity/version.rb

@@ -0,0 +1,5 @@
+module Dao
+  module Entity
+    VERSION = '1.0.0'
+  end
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: dao-entity
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- llxff
+- ssnikolay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Base entity
+email:
+- ll.wg.bin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dao-entity.gemspec
+- lib/dao/entity.rb
+- lib/dao/entity/base.rb
+- lib/dao/entity/state.rb
+- lib/dao/entity/version.rb
+homepage: https://github.com/dao-rb/dao-entity
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Base entity
+test_files: []