dto 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e7ef0812d9d0b60562ca56ddd118e0ee4d206fb
+  data.tar.gz: f960ebf636e780d4cacffb11abdd7d9c02991308
+SHA512:
+  metadata.gz: 4bec3d82ece2c50a52d00fcec87d3346f85f4921cd65608747a4b44e2c1581af417c41137b69021ca6f5a7a3c54a079719574d48b25bf5eb0c29a7c0c370159f
+  data.tar.gz: dcc38b8db0d0a72e0960d03275b6ad4ce22396dc983e21a7c34b6d81177463cb3cced7d7789293d022469a563ce4165adcd4987da231a5275bfd0c360b7f8bea

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/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/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    dto (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.1.0)
+    diff-lcs (1.3)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  dto!
+  rspec
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Nikita Kononov
+
+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,31 @@
+# Ruby DTO
+Dumb ruby object, similar a Hash, but provide access to attributes by isntance methods
+## Instalation
+```ruby
+gem 'dto', git: 'https://github.com/vocrsz/dto'
+```
+
+## Usage
+```ruby
+class UserDTO < DTO::Base
+    attrs :name, :email, :age
+end
+```
+
+```ruby
+user_hash = {
+    name:  'Nikita',
+    email: 'hello@world.com',
+    age:   24,
+    some_other_attribute: 'no matter'
+}
+
+user = UserDTO.new(user_hash) 
+# or UserDTO(name: 'Nikita', email: 'hello@world.com')
+```
+```ruby
+user.name  # "Nikita"
+user.email # "hello@world.ru"
+
+user.name = "Not Nikita" # "Not Nikita"
+```

data/dto.gemspec

@@ -0,0 +1,19 @@
+require_relative 'lib/dto/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'dto'
+  s.version     = DTO::VERSION
+  s.summary     = "Data Transfer Object"
+  s.description = "Ruby simple DTO class"
+  s.authors     = ["Droid Labs", "VocrSz"]
+  s.email       = 'vocrsz@gmail.com'
+  
+  s.files       = `git ls-files`.split($/)
+  s.test_files  = s.files.grep(%r{^(spec)/})
+
+  s.add_development_dependency "byebug"
+  s.add_development_dependency "rspec"
+  
+  s.homepage    = 'https://github.com/vocrsz/dto'
+  s.license     = 'MIT'
+end

data/lib/dto.rb

@@ -0,0 +1,5 @@
+module DTO
+end
+
+require 'dto/version'
+require 'dto/base'

data/lib/dto/base.rb

@@ -0,0 +1,55 @@
+class DTO::Base
+  def initialize(data)
+    @data = data
+  end
+
+  def to_hash
+    @data.dup
+  end
+
+  def self.attrs(*properties)
+    not_allowed_methods = self.public_instance_methods & properties
+
+    raise ArgumentError, "Attribute #{not_allowed_methods} is already in use by any instance of parent class! Use other unreserved name." if not_allowed_methods.any?
+
+    properties.each { |name| define_attribute(name) }
+
+    class_eval %Q(
+      def initialize(data)
+        @data = data.select { |key, _| self.class.properties.include?(key) }
+      end
+    )
+  end
+
+  def self.properties
+    @properties ||= []
+  end
+
+  def self.define_attribute(name)
+    properties.push(name)
+
+    define_method(name) do
+      get_attribute(name)
+    end
+
+    define_method("#{name}=") do |value = nil|
+      set_attribute(name, value)
+    end
+  end
+
+  private
+
+  def get_attribute(name)
+    @data[name]
+  end
+
+  def set_attribute(name, value)
+    raise ArgumentError, "Property #{name} is not defined for #{self.class} class!" unless property_defined?(name)
+
+    @data[name] = value
+  end
+
+  def property_defined?(name)
+    @data.keys.include?(name)
+  end
+end

data/lib/dto/version.rb

@@ -0,0 +1,3 @@
+module DTO
+  VERSION = '0.0.1'
+end

data/spec/dto/base_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+
+describe DTO::Base do
+  let(:dto_class) {
+    Class.new(DTO::Base) do
+      attrs :test, :example, :sample
+    end
+  }
+  let(:dto) { dto_class.new(test: 'test', example: 1, sample: false) }
+  let(:dto_hash) { { test: 'test', hello: :world } }
+
+  context ':attrs' do
+    context 'for methods already in use' do
+      it 'raises ArgumentError' do
+        expect {
+          dto_class.attrs :class
+        }.to raise_error(ArgumentError, "Attribute [:class] is already in use by any instance of parent class! Use other unreserved name.")
+      end
+    end
+  end
+  
+  context '#initialize' do
+    context 'from keyword arguments' do
+      it 'init new instance with passed attributes' do
+        expect(dto.test).to eq('test')
+        expect(dto.example).to eq(1)
+        expect(dto.sample).to be(false)
+      end
+    end
+
+    context 'from hash' do
+      let(:dto_from_hash) { dto_class.new(dto_hash) }
+      
+      it 'uses only allowed params' do
+        expect(dto_from_hash.test).to eq('test')
+      end
+
+      it 'returns nil from unset params' do
+        expect(dto_from_hash.example).to be_nil
+      end
+
+      it 'not affect to other instances of class' do
+        dto_from_hash.example
+        
+        expect(dto.example).to eq(1)
+      end
+    end
+  end
+
+  context 'when update attributes' do
+    it 'not raises error' do
+      expect { dto.test = 'new_value' }.to_not raise_error
+    end
+
+    it 'sets new values' do
+      dto.test = 'new_value'
+      
+      expect(dto.test).to eq('new_value')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift(File.join(__dir__, '..', 'lib'))
+$LOAD_PATH.unshift(__dir__)
+
+require 'dto'
+require 'byebug'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: dto
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Droid Labs
+- VocrSz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Ruby simple DTO class
+email: vocrsz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- dto.gemspec
+- lib/dto.rb
+- lib/dto/base.rb
+- lib/dto/version.rb
+- spec/dto/base_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/vocrsz/dto
+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.14
+signing_key: 
+specification_version: 4
+summary: Data Transfer Object
+test_files:
+- spec/dto/base_spec.rb
+- spec/spec_helper.rb