dry-struct 1.2.0 → 1.3.0

data/.gitignore

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

data/.rspec

@@ -1,4 +0,0 @@
---color
---require spec_helper
---order random
-

data/.rubocop.yml

@@ -1,95 +0,0 @@
-# this file is managed by dry-rb/devtools project
-
-AllCops:
-  TargetRubyVersion: 2.4
-
-Style/EachWithObject:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: single_quotes
-
-Style/Alias:
-  Enabled: false
-
-Style/LambdaCall:
-  Enabled: false
-
-Style/StabbyLambdaParentheses:
-  Enabled: false
-
-Style/FormatString:
-  Enabled: false
-
-Style/Documentation:
-  Enabled: false
-
-Layout/SpaceInLambdaLiteral:
-  Enabled: false
-
-Layout/MultilineMethodCallIndentation:
-  Enabled: true
-  EnforcedStyle: indented
-
-Metrics/LineLength:
-  Max: 100
-
-Metrics/MethodLength:
-  Max: 22
-
-Metrics/ClassLength:
-  Max: 150
-
-Metrics/AbcSize:
-  Max: 20
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/CyclomaticComplexity:
-  Enabled: true
-  Max: 10
-
-Lint/BooleanSymbol:
-  Enabled: false
-
-Style/AccessModifierDeclarations:
-  Enabled: false
-
-Style/BlockDelimiters:
-  Enabled: false
-
-Layout/IndentFirstArrayElement:
-  EnforcedStyle: consistent
-
-Style/ClassAndModuleChildren:
-  Exclude:
-    - "spec/**/*_spec.rb"
-
-Lint/HandleExceptions:
-  Exclude:
-    - "spec/spec_helper.rb"
-
-Naming/FileName:
-  Exclude:
-    - "lib/dry-*.rb"
-
-Style/SymbolArray:
-  Exclude:
-    - "spec/**/*_spec.rb"
-
-Style/ConditionalAssignment:
-  Enabled: false
-
-Naming/MethodName:
-  Enabled: false
-
-Style/AsciiComments:
-  Enabled: false
-
-Style/DateTime:
-  Enabled: false
-
-Style/IfUnlessModifier:
-  Enabled: false

data/.yardopts

@@ -1,4 +0,0 @@
---title 'dry-struct'
---markup markdown
---readme README.md
-lib/**/*.rb

data/CODE_OF_CONDUCT.md

@@ -1,13 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
-
-Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
-
-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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
-
-This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.4.0, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct)

data/CONTRIBUTING.md

@@ -1,29 +0,0 @@
-# Issue Guidelines
-
-## Reporting bugs
-
-If you found a bug, report an issue and describe what's the expected behavior versus what actually happens. If the bug causes a crash, attach a full backtrace. If possible, a reproduction script showing the problem is highly appreciated.
-
-## Reporting feature requests
-
-Report a feature request **only after discussing it first on [discourse.dry-rb.org](https://discourse.dry-rb.org)** where it was accepted. Please provide a concise description of the feature, don't link to a discussion thread, and instead summarize what was discussed.
-
-## Reporting questions, support requests, ideas, concerns etc.
-
-**PLEASE DON'T** - use [discourse.dry-rb.org](http://discourse.dry-rb.org) instead.
-
-# Pull Request Guidelines
-
-A Pull Request will only be accepted if it addresses a specific issue that was reported previously, or fixes typos, mistakes in documentation etc.
-
-Other requirements:
-
-1) Do not open a pull request if you can't provide tests along with it. If you have problems writing tests, ask for help in the related issue.
-2) Follow the style conventions of the surrounding code. In most cases, this is standard ruby style.
-3) Add API documentation if it's a new feature
-4) Update API documentation if it changes an existing feature
-5) Bonus points for sending a PR to [github.com/dry-rb/dry-rb.org](github.com/dry-rb/dry-rb.org) which updates user documentation and guides
-
-# Asking for help
-
-If these guidelines aren't helpful, and you're stuck, please post a message on [discourse.dry-rb.org](https://discourse.dry-rb.org) or join [our chat](https://dry-rb.zulipchat.com).

data/Gemfile

@@ -1,28 +0,0 @@
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-gemspec
-
-group :test do
-  gem 'codeclimate-test-reporter', platform: :mri, require: false
-  gem 'dry-monads'
-  gem 'simplecov', require: false
-  gem 'warning'
-end
-
-group :tools do
-  gem 'pry'
-  gem 'pry-byebug', platform: :mri
-  gem 'ossy', git: 'https://github.com/solnic/ossy.git', branch: 'master'
-end
-
-group :benchmarks do
-  gem 'sqlite3'
-  gem 'activerecord'
-  gem 'benchmark-ips'
-  gem 'virtus'
-  gem 'fast_attributes'
-  gem 'attrio'
-  gem 'hotch'
-end

data/Rakefile

@@ -1,10 +0,0 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
-
-require 'yard'
-require 'yard/rake/yardoc_task'
-YARD::Rake::YardocTask.new(:doc)

data/benchmarks/basic.rb

@@ -1,57 +0,0 @@
-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: 'strict.string', age: 'params.integer')
-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

@@ -1,37 +0,0 @@
-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
-end
-
-class DryStructUser < Dry::Struct
-  attribute :id, Types::Params::Integer
-  attribute :name, Types::Strict::String.constrained(size: 3..64)
-  attribute :age, Types::Params::Integer.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/benchmarks/profile_instantiation.rb

@@ -1,19 +0,0 @@
-require_relative 'setup'
-
-ATTR_NAMES = [:attr0, :attr1, :attr2, :attr3, :attr4, :attr5, :attr6, :attr7, :attr8, :attr9]
-
-class Integers < Dry::Struct
-  ATTR_NAMES.each do |name|
-    attribute? name, 'coercible.integer'
-  end
-end
-
-integers = {attr0: 0, attr1: 1, attr2: 2, attr3: 3, attr4: 4, attr5: 5, attr6: 6, attr7: 7, attr8: 8, attr9: 9}
-
-require 'pry-byebug'
-
-profile do
-  1_000_000.times do
-    Integers.new(integers)
-  end
-end

data/benchmarks/setup.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-require 'benchmark/ips'
-require 'hotch'
-ENV['HOTCH_VIEWER'] ||= 'open'
-
-require 'dry-struct'
-
-def profile(&block)
-  Hotch(filter: 'Dry', &block)
-end

data/bin/console

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'dry/struct'
-
-require 'irb'
-
-module Types
-  include Dry.Types()
-end
-
-binding.irb

data/bin/setup

@@ -1,7 +0,0 @@
-#!/bin/bash
-set -euo pipefail
-IFS=$'\n\t'
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/docsite/source/index.html.md

@@ -1,103 +0,0 @@
----
-title: Introduction
-layout: gem-single
-type: gem
-name: dry-struct
-sections:
- - nested-structs
- - recipes
----
-
-`dry-struct` is a gem built on top of `dry-types` which provides virtus-like DSL for defining typed struct classes.
-
-### Basic Usage
-
-You can define struct objects which will have readers for specified attributes using a simple dsl:
-
-``` ruby
-require 'dry-struct'
-
-module Types
-  include Dry.Types()
-end
-
-class User < Dry::Struct
-  attribute :name, Types::String.optional
-  attribute :age, Types::Coercible::Integer
-end
-
-user = User.new(name: nil, age: '21')
-
-user.name # nil
-user.age # 21
-
-user = User.new(name: 'Jane', age: '21')
-
-user.name # => "Jane"
-user.age # => 21
-```
-
-### Value
-
-:warning: `Dry::Struct::Value` is deprecated in 1.2.0. Structs are already meant to be immutable, freezing them doesn't add any value (no pun intended) beyond a bad example of defensive programming.
-
-You can define value objects which will behave like structs but will be *deeply frozen*:
-
-``` ruby
-class Location < Dry::Struct::Value
-  attribute :lat, Types::Float
-  attribute :lng, Types::Float
-end
-
-loc1 = Location.new(lat: 1.23, lng: 4.56)
-loc2 = Location.new(lat: 1.23, lng: 4.56)
-
-loc1.frozen? # true
-loc2.frozen? # true
-
-loc1 == loc2
-# true
-```
-
-### Hash Schemas
-
-`Dry::Struct` out of the box uses [hash schemas](/gems/dry-types/1.0/hash-schemas) from `dry-types` for processing input hashes. `with_type_transform` and `with_key_transform` are exposed as `transform_types` and `transform_keys`:
-
-```ruby
-class User < Dry::Struct
-  transform_keys(&:to_sym)
-
-  attribute :name, Types::String.optional
-  attribute :age, Types::Coercible::Integer
-end
-
-User.new('name' => 'Jane', 'age' => '21')
-# => #<User name="Jane" age=21>
-```
-
-This plays nicely with inheritance, you can define a base struct for symbolizing input and then reuse it:
-
-```ruby
-class SymbolizeStruct < Dry::Struct
-  transform_keys(&:to_sym)
-end
-
-class User < SymbolizeStruct
-  attribute :name, Types::String.optional
-  attribute :age, Types::Coercible::Integer
-end
-```
-
-### Validating data with dry-struct
-
-Please don't. Structs are meant to work with valid input, it cannot generate error messages good enough for displaying them for a user etc. Use [`dry-validation`](/gems/dry-validation) for validating incoming data and then pass its output to structs.
-
-### Differences between dry-struct and virtus
-
-`dry-struct` look somewhat similar to Virtus but there are few significant differences:
-
-* Structs don't provide attribute writers and are meant to be used as "data objects" exclusively
-* Handling of attribute values is provided by standalone type objects from `dry-types`, which gives you way more powerful features
-* Handling of attribute hashes is provided by standalone hash schemas from `dry-types`, which means there are different types of constructors in `dry-struct`
-* Structs are not designed as swiss-army knifes, specific constructor types are used depending on the use case
-* Struct classes quack like `dry-types`, which means you can use them in hash schemas, as array members or sum them