dry-struct 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e8ad25e8537c7c9b1762fa73ff25103adddc4b45
+  data.tar.gz: 1a2be7946a5fc0b70f9b40157ce8c0f6f57fcec0
+SHA512:
+  metadata.gz: 9d3aace8acda03bd17706d3b1e3b0ad14584639b8783cee401e2e91ee30f91a55130d99bac7b8994b6eb980ef15b42c772b346387dfb807b6933a0bd67b7c5d3
+  data.tar.gz: b36ba76069268bf7f849de3a38102072229f99264d967df36a63dba09ffc90e394a9d034e8369ca0bad0486284d0cdab62e0146a7382bd27177c9ce2dcf56c1e

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require ./spec/spec_helper

data/.travis.yml

@@ -0,0 +1,32 @@
+language: ruby
+sudo: false
+cache: bundler
+bundler_args: --without benchmarks tools
+script:
+  - bundle exec rake spec
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - rbx-2
+  - jruby-9000
+  - ruby-head
+env:
+  global:
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  include:
+    - rvm: jruby-head
+      before_install: gem install bundler --no-ri --no-rdoc
+notifications:
+  email: false
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/19098b4253a72c9796db
+    on_success: change  # options: [always|never|change] default: always
+    on_failure: always  # options: [always|never|change] default: always
+    on_start: false     # default: false

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'codeclimate-test-reporter', platform: :rbx, require: false
+end
+
+group :tools do
+  gem 'byebug', platform: :mri
+  gem 'mutant'
+  gem 'mutant-rspec'
+end
+
+group :benchmarks do
+  gem 'sqlite3'
+  gem 'activerecord'
+  gem 'benchmark-ips'
+  gem 'virtus'
+  gem 'fast_attributes'
+  gem 'attrio'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013-2016 Piotr Solnica
+
+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,13 @@
+# dry-struct [![Join the chat at https://gitter.im/dry-rb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/dry-rb/chat)
+
+WIP extraction from dry-types
+
+## 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/dry-rb/dry-struct.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/benchmarks/basic.rb

@@ -0,0 +1,57 @@
+require 'dry/struct'
+require 'virtus'
+require 'fast_attributes'
+require 'attrio'
+require 'ostruct'
+
+require 'benchmark/ips'
+
+class VirtusUser
+  include Virtus.model
+
+  attribute :name, String
+  attribute :age, Integer
+end
+
+class FastUser
+  extend FastAttributes
+
+  define_attributes initialize: true, attributes: true do
+    attribute :name, String
+    attribute :age,  Integer
+  end
+end
+
+class AttrioUser
+  include Attrio
+
+  define_attributes do
+    attr :name, String
+    attr :age, Integer
+  end
+
+  def initialize(attributes = {})
+    self.attributes = attributes
+  end
+
+  def attributes=(attributes = {})
+    attributes.each do |attr,value|
+      self.send("#{attr}=", value) if self.respond_to?("#{attr}=")
+    end
+  end
+end
+
+class DryStructUser < Dry::Struct
+  attributes(name: 'string', age: 'form.int')
+end
+
+puts DryStructUser.new(name: 'Jane', age: '21').inspect
+
+Benchmark.ips do |x|
+  x.report('virtus') { VirtusUser.new(name: 'Jane', age: '21') }
+  x.report('fast_attributes') { FastUser.new(name: 'Jane', age: '21') }
+  x.report('attrio') { AttrioUser.new(name: 'Jane', age: '21') }
+  x.report('dry-struct') { DryStructUser.new(name: 'Jane', age: '21') }
+
+  x.compare!
+end

data/benchmarks/constrained.rb

@@ -0,0 +1,37 @@
+require 'dry/struct'
+
+require 'active_record'
+require 'benchmark/ips'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+
+ActiveRecord::Schema.define do
+  create_table :users do |table|
+    table.column :name, :string
+    table.column :age, :integer
+  end
+end
+
+class ARUser < ActiveRecord::Base
+  self.table_name = :users
+end
+
+module Types
+  include Dry::Types.module
+end
+
+class DryStructUser < Dry::Struct
+  attribute :id, Types::Form::Int
+  attribute :name, Types::Strict::String.constrained(size: 3..64)
+  attribute :age, Types::Form::Int.constrained(gt: 18)
+end
+
+puts ARUser.new(id: 1, name: 'Jane', age: '21').inspect
+puts DryStructUser.new(id: 1, name: 'Jane', age: '21').inspect
+
+Benchmark.ips do |x|
+  x.report('active record') { ARUser.new(id: 1, name: 'Jane', age: '21') }
+  x.report('dry-struct') { DryStructUser.new(id: 1, name: 'Jane', age: '21') }
+
+  x.compare!
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'dry/struct'
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dry-struct.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dry-struct'
+  spec.version       = '0.0.1'
+  spec.authors       = ['Piotr Solnica']
+  spec.email         = ['piotr.solnica@gmail.com']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Typed structs and value objects.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/dryrb/dry-struct'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  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.add_runtime_dependency 'dry-equalizer', '~> 0.2'
+  spec.add_runtime_dependency 'dry-configurable', '~> 0.1'
+  spec.add_runtime_dependency 'dry-logic', '~> 0.2', '>= 0.2.3'
+  spec.add_runtime_dependency 'dry-types', '~> 0.8', '>= 0.8.1'
+  spec.add_runtime_dependency 'ice_nine', '~> 0.11'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 11.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+end

data/lib/dry-struct.rb

@@ -0,0 +1 @@
+require 'dry/struct'

data/lib/dry/struct.rb

@@ -0,0 +1,28 @@
+require 'dry-types'
+
+require 'dry/struct/version'
+require 'dry/struct/errors'
+require 'dry/struct/class_interface'
+require 'dry/struct/hashify'
+require 'dry/struct/value'
+
+module Dry
+  class Struct
+    extend ClassInterface
+
+    def initialize(attributes)
+      attributes.each { |key, value| instance_variable_set("@#{key}", value) }
+    end
+
+    def [](name)
+      public_send(name)
+    end
+
+    def to_hash
+      self.class.schema.keys.each_with_object({}) do |key, result|
+        result[key] = Hashify[self[key]]
+      end
+    end
+    alias_method :to_h, :to_hash
+  end
+end

data/lib/dry/struct/class_interface.rb

@@ -0,0 +1,105 @@
+module Dry
+  class Struct
+    module ClassInterface
+      include Dry::Types::Builder
+
+      attr_accessor :constructor
+
+      attr_accessor :equalizer
+
+      attr_writer :constructor_type
+
+      protected :constructor=, :equalizer=, :constructor_type=
+
+      def inherited(klass)
+        super
+
+        klass.equalizer = Equalizer.new(*schema.keys)
+        klass.constructor_type = constructor_type
+        klass.send(:include, klass.equalizer)
+
+        unless klass == Value
+          klass.constructor = Types['coercible.hash']
+          Types.register(Types.identifier(klass), klass)
+        end
+
+        klass.attributes({}) unless equal?(Struct)
+      end
+
+      def attribute(name, type)
+        attributes(name => type)
+      end
+
+      def attributes(new_schema)
+        check_schema_duplication(new_schema)
+
+        prev_schema = schema
+
+        @schema = prev_schema.merge(new_schema)
+        @constructor = Types['coercible.hash'].public_send(constructor_type, schema)
+
+        attr_reader(*new_schema.keys)
+        equalizer.instance_variable_get('@keys').concat(new_schema.keys)
+
+        self
+      end
+
+      def check_schema_duplication(new_schema)
+        shared_keys = new_schema.keys & schema.keys
+
+        fail Types::RepeatedAttributeError, shared_keys.first if shared_keys.any?
+      end
+      private :check_schema_duplication
+
+      def constructor_type(type = nil)
+        if type
+          @constructor_type = type
+        else
+          @constructor_type || :strict
+        end
+      end
+
+      def schema
+        super_schema = superclass.respond_to?(:schema) ? superclass.schema : {}
+        super_schema.merge(@schema || {})
+      end
+
+      def new(attributes = default_attributes)
+        if attributes.instance_of?(self)
+          attributes
+        else
+          super(constructor[attributes])
+        end
+      rescue Types::SchemaError, Types::SchemaKeyError => error
+        raise Struct::Error, "[#{self}.new] #{error}"
+      end
+      alias_method :call, :new
+      alias_method :[], :new
+
+      def default_attributes
+        schema.each_with_object({}) { |(name, type), result|
+          result[name] = type.default? ? type.evaluate : type[nil]
+        }
+      end
+
+      def try(input)
+        Types::Result::Success.new(self[input])
+      rescue Struct::Error => e
+        failure = Types::Result::Failure.new(input, e.message)
+        block_given? ? yield(failure) : failure
+      end
+
+      def maybe?
+        false
+      end
+
+      def default?
+        false
+      end
+
+      def valid?(value)
+        self === value
+      end
+    end
+  end
+end

data/lib/dry/struct/errors.rb

@@ -0,0 +1,15 @@
+module Dry
+  class Struct
+    extend Dry::Configurable
+
+    setting :namespace, self
+
+    Error = Class.new(TypeError)
+
+    class RepeatedAttributeError < ArgumentError
+      def initialize(key)
+        super("Attribute :#{key} has already been defined")
+      end
+    end
+  end
+end

data/lib/dry/struct/hashify.rb

@@ -0,0 +1,17 @@
+# Converts value to hash recursively
+
+module Dry
+  class Struct
+    module Hashify
+      def self.[](value)
+        if value.respond_to?(:to_hash)
+          value.to_hash
+        elsif value.respond_to?(:map)
+          value.map { |item| self[item] }
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/lib/dry/struct/value.rb

@@ -0,0 +1,13 @@
+require 'ice_nine'
+
+require 'dry/struct'
+
+module Dry
+  class Struct
+    class Value < self
+      def self.new(*)
+        IceNine.deep_freeze(super)
+      end
+    end
+  end
+end

data/lib/dry/struct/version.rb

@@ -0,0 +1,5 @@
+module Dry
+  class Struct
+    VERSION = '0.0.1'.freeze
+  end
+end

metadata

@@ -0,0 +1,188 @@
+--- !ruby/object:Gem::Specification
+name: dry-struct
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Piotr Solnica
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-equalizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: dry-logic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: ice_nine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Typed structs and value objects.
+email:
+- piotr.solnica@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- benchmarks/basic.rb
+- benchmarks/constrained.rb
+- bin/console
+- bin/setup
+- dry-struct.gemspec
+- lib/dry-struct.rb
+- lib/dry/struct.rb
+- lib/dry/struct/class_interface.rb
+- lib/dry/struct/errors.rb
+- lib/dry/struct/hashify.rb
+- lib/dry/struct/value.rb
+- lib/dry/struct/version.rb
+homepage: https://github.com/dryrb/dry-struct
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.3
+signing_key: 
+specification_version: 4
+summary: Typed structs and value objects.
+test_files: []