dry-struct-setters 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8dc0293695e70153ec3cc1146c0cc0955e6d9f94
+  data.tar.gz: 99ee5bca887c5804c12ddd0a13866b6106967346
+SHA512:
+  metadata.gz: 68d5b060ac2c4e100f38839f991d0c070c4245051653d94f6aeb4c4f8186e23a15ba41fbd0bce35ee805220d403512c2a231b52bdebf01914f5ada26b33b68cf
+  data.tar.gz: b73fd70f8d6c0a1a0dc14d55cfee89624a06c7c4092a77dd9040ec7227ef48a78ab086b95a61933820a4ef19c7d784b19cd774d2c90a8d064b2454704c1ded58

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/.travis.yml

@@ -0,0 +1,13 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+before_install: gem install bundler -v 1.15.1
+script: bin/rspec

data/Gemfile

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

data/README.md

@@ -0,0 +1,97 @@
+# Dry::Struct::Setters
+
+[![Gem Version](https://badge.fury.io/rb/dry-struct-setters.svg)](http://badge.fury.io/rb/dry-struct-setters) [![Build Status](https://travis-ci.org/tbuehlmann/dry-struct-setters.svg?branch=master)](https://travis-ci.org/tbuehlmann/dry-struct-setters)
+
+Dry::Struct::Setters is an extension to the [Dry::Struct](https://github.com/dry-rb/dry-struct) library. Subclasses of Dry::Struct only define getter methods for its attributes by design (or preference). This library extends subclasses so they also provide setter methods.
+
+## Usage
+
+By including the Dry::Struct::Setters module into your Dry::Struct subclass every defined attribute will get a corresponding setter method:
+
+```ruby
+module Types
+  include Dry::Types.module
+end
+
+class Project < Dry::Struct
+  include Dry::Struct::Setters
+
+  attribute :name, Types::String
+end
+
+project = Project.new(name: 'some-project')
+project.name = 'some-project-new'
+
+project.name # => 'some-project-new'
+```
+
+### Mass Assignment
+
+Including the Dry::Struct::Setters module into you Dry::Struct subclass will only define setter methods, mass assigning attributes won't work with this. If you want to be able to mass assign attributes, just include the Dry::Struct::Setters::MassAssignment module, which will provide an assign_attributes method:
+
+```ruby
+module Types
+  include Dry::Types.module
+end
+
+class Project < Dry::Struct
+  include Dry::Struct::Setters
+  include Dry::Struct::Setters::MassAssignment
+
+  attribute :name, Types::String
+  attribute :description, Types::String
+end
+
+project = Project.new(name: 'some-project', description: 'some-description')
+
+project.assign_attributes(name: 'some-project-new', description: 'some-description-new')
+
+project.name # => 'some-project-new'
+project.description # => 'some-description-new'
+```
+
+### Convenience Class
+
+Instead of including modules you can also just use the Dry::Struct::WithSetters class which inherits from Dry::Struct and includes both modules. Note that you'll need to explicitly require it:
+
+```ruby
+require 'dry/struct/with_setters'
+
+module Types
+  include Dry::Types.module
+end
+
+class Project < Dry::Struct::WithSetters
+  attribute :name, Types::String
+end
+```
+
+Hint: You can also require directly via your Gemfile:
+
+```ruby
+gem 'dry-struct-setters', require: 'dry/struct/with_setters'
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dry-struct-setters'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dry-struct-setters
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tbuehlmann/dry-struct-setters.

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,11 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'dry/struct/setters'
+require 'pry'
+
+D   = Dry
+DS  = Dry::Struct
+DSS = Dry::Struct::Setters
+
+Pry.start

data/bin/rspec

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+load Gem.bin_path('rspec-core', 'rspec')

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/dry-struct-setters.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/dry/struct/setters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dry-struct-setters'
+  spec.version       = Dry::Struct::Setters::VERSION
+  spec.authors       = ['Tobias Bühlmann']
+  spec.email         = ['tobias@xn--bhlmann-n2a.de']
+  spec.licenses      = ['MIT']
+
+  spec.summary       = 'Setter methods for Dry::Struct subclasses'
+  spec.description   = 'This gem adds the ability to add setter methods to otherwise setter-method-less Dry::Struct subclasses.'
+  spec.homepage      = 'https://github.com/tbuehlmann/dry-struct-setters'
+
+  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.required_ruby_version = '>= 2.1'
+
+  spec.add_runtime_dependency 'dry-struct', '>= 0.3.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.6'
+end

data/lib/dry/struct/setters.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'dry/struct'
+
+require 'dry/struct/setters/mass_assignment'
+require 'dry/struct/setters/version'
+
+module Dry
+  class Struct
+    module Setters
+      def self.included(struct)
+        struct.extend(ClassMethods)
+
+        struct.schema.each do |attribute, type|
+          Dry::Struct::Setters.define_setter_for(struct: struct, attribute: attribute, type: type)
+        end
+      end
+
+      module ClassMethods
+        def attributes(new_schema)
+          super.tap do
+            new_schema.each do |attribute, type|
+              Dry::Struct::Setters.define_setter_for(struct: self, attribute: attribute, type: type)
+            end
+          end
+        end
+      end
+
+      def self.define_setter_for(struct:, attribute:, type:)
+        setter = "#{attribute}=".to_sym
+
+        struct.class_eval do
+          unless instance_methods.include?(setter)
+            define_method(setter) do |value|
+              instance_variable_set("@#{attribute}", type.call(value))
+            end
+
+            setter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/struct/setters/mass_assignment.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Dry
+  class Struct
+    module Setters
+      module MassAssignment
+        def assign_attributes(attributes = {})
+          attributes.each do |attribute, value|
+            public_send("#{attribute}=", value)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dry/struct/setters/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Dry
+  class Struct
+    module Setters
+      VERSION = '0.1.0'
+    end
+  end
+end

data/lib/dry/struct/with_setters.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'dry/struct/setters'
+
+module Dry
+  class Struct
+    class WithSetters < Dry::Struct
+      include Dry::Struct::Setters
+      include Dry::Struct::Setters::MassAssignment
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: dry-struct-setters
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tobias Bühlmann
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+description: This gem adds the ability to add setter methods to otherwise setter-method-less
+  Dry::Struct subclasses.
+email:
+- tobias@xn--bhlmann-n2a.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- dry-struct-setters.gemspec
+- lib/dry/struct/setters.rb
+- lib/dry/struct/setters/mass_assignment.rb
+- lib/dry/struct/setters/version.rb
+- lib/dry/struct/with_setters.rb
+homepage: https://github.com/tbuehlmann/dry-struct-setters
+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.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Setter methods for Dry::Struct subclasses
+test_files: []