avromatic 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00b29e492064bce7661c64f961e168ebeeee1f4d
-  data.tar.gz: 1fed6c7b78a6000d67b85c279c0a2522af3fc0a2
+  metadata.gz: 0006753e54e4ba4a3b0a5f40fa71810417d1b37f
+  data.tar.gz: 00da3685e121175995d6908a76c23ff0997108fc
 SHA512:
-  metadata.gz: 86395a7cd21081d58234433a33c91f8f9291e49a672d625a1a45f19c0b9ca096e5afdc0c72a23357c5eefa790cf1b378b54adde8e5c95c1109e78e650ef3e898
-  data.tar.gz: 0af78d4a8423308c37faedd6d7baec82950eb19202944adc1beed97300bd838e42233df7d21e87864f6febd6ead44f751b236be686f0fb053e9bf3bbcdc0c9ee
+  metadata.gz: fc9f465e19cb10d935fe191acdb21ad51eb4aa1e9dbe373355672048b32a81b71c2c61afde243c6ac22e6b14a6b33e3b52f6b16350504cf2026a3edebefc9f34
+  data.tar.gz: 6d3acedd8f81a97b065a27d684c95367fa841f3ec78f0e295dc6672e770ddef77cdc9189baa4ddfceb38977bf6d59c266c4fa4d9a65d2db302bc51a49374458a

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # avromatic changelog
 
+## v0.23.0
+- Add mutable option when defining a model.
+
 ## v0.22.0
 - Require `avro_schema_registry_client` v0.3.0 or later to avoid
   using `avro-salsify-fork`.

data/README.md

@@ -118,7 +118,15 @@ end
 ```
 
 Models are generated as [Virtus](https://github.com/solnic/virtus) value
-objects. `Virtus` attributes are added for each field in the Avro schema
+objects by default, but can optionally be defined as mutable:
+
+```ruby
+class MyModel
+  include Avromatic::Model.build(schema_name :my_model, mutable: true)
+end
+```
+
+`Virtus` attributes are added for each field in the Avro schema
 including any default values defined in the schema. `ActiveModel` validations
 are used to define validations on certain types of fields ([see below](#validations)).
 

data/lib/avromatic/model/builder.rb

@@ -42,7 +42,7 @@ module Avromatic
       def inclusions
         [
           ActiveModel::Validations,
-          Virtus.value_object,
+          config.mutable ? Virtus.model : Virtus.value_object,
           Avromatic::Model::Configurable,
           Avromatic::Model::NestedModels,
           Avromatic::Model::Validation,

data/lib/avromatic/model/configuration.rb

@@ -4,7 +4,7 @@ module Avromatic
     # This class holds configuration for a model built from Avro schema(s).
     class Configuration
 
-      attr_reader :avro_schema, :key_avro_schema, :nested_models
+      attr_reader :avro_schema, :key_avro_schema, :nested_models, :mutable
       delegate :schema_store, to: Avromatic
 
       # Either schema(_name) or value_schema(_name), but not both, must be
@@ -18,11 +18,13 @@ module Avromatic
       # @option options [Avro::Schema] :key_schema
       # @option options [String, Symbol] :key_schema_name
       # @option options [Avromatic::ModelRegistry] :nested_models
+      # @option options [Boolean] :mutable, default false
       def initialize(**options)
         @avro_schema = find_avro_schema(**options)
         raise ArgumentError.new('value_schema(_name) or schema(_name) must be specified') unless avro_schema
         @key_avro_schema = find_schema_by_option(:key_schema, **options)
         @nested_models = options[:nested_models]
+        @mutable = options.fetch(:mutable, false)
       end
 
       alias_method :value_avro_schema, :avro_schema

data/lib/avromatic/version.rb

@@ -1,3 +1,3 @@
 module Avromatic
-  VERSION = '0.22.0'.freeze
+  VERSION = '0.23.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: avromatic
 version: !ruby/object:Gem::Version
-  version: 0.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Salsify Engineering
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2017-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: avro