smart_properties 1.14.0 → 1.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 845948d63c5a647048b44f96e405808bdf3697430323a9ebf29b57c13ed157c9
-  data.tar.gz: be7cc4c03ab7bcba3dbdaea8a04676ada44f50f07d3f5a323926098af6560c97
+  metadata.gz: 0466754454ac7feba9fa836c5b84ffaf04d2502084d6b385b6756f44cb119b34
+  data.tar.gz: 47c46bfcce7352943062ac9be2f25a04ce1c3adbeb86d251a5b0aa20f012ddfa
 SHA512:
-  metadata.gz: fc5370fce67258915440c7e6fe3b02b1207d04ab1716be3f22b478f7ebf1d22807115b2f7aa7639b82030ad4309a69941606b20d6a64815e9afacd4fb48cdafb
-  data.tar.gz: 003da1d3daab182873e5ccd4ba6359707309fc06161f095c52803cfd6e1d3cb055c0baa59886aaed8b51f3eb5d05d4c6efdfc6188445a6e6de8d4c48a607b8ec
+  metadata.gz: 38f90027d577a4f7eca3e799980408aa6cb179af1d221f9b7c3212ba4385fa636057cfd620e4908c2f3c116c0475f04d9763a3fc00d2fd7a5349468b517f0095
+  data.tar.gz: 3c4feb78a07b067ce593822861afa858ea29003354b8427c8bab12a2782de51f54a5027393b51c1817785a6b8ba57a2afa5dac54381dc58e7756d10e3bd7a3ad

data/lib/smart_properties/property.rb

@@ -1,6 +1,7 @@
 module SmartProperties
   class Property
     MODULE_REFERENCE = :"@_smart_properties_method_scope"
+    ALLOWED_DEFAULT_CLASSES = [Proc, Numeric, String, Range, TrueClass, FalseClass, NilClass, Symbol].freeze
 
     attr_reader :name
     attr_reader :converter
@@ -27,6 +28,11 @@ module SmartProperties
 
       @instance_variable_name = :"@#{name}"
 
+      unless ALLOWED_DEFAULT_CLASSES.any? { |cls| @default.is_a?(cls) }
+        raise ConfigurationError, "Default attribute value #{@default.inspect} cannot be specified as literal, "\
+          "use the syntax `default: -> { ... }` instead."
+      end
+
       unless attrs.empty?
         raise ConfigurationError, "SmartProperties do not support the following configuration options: #{attrs.keys.map { |m| m.to_s }.sort.join(', ')}."
       end
@@ -66,7 +72,7 @@ module SmartProperties
     end
 
     def default(scope)
-      @default.kind_of?(Proc) ? scope.instance_exec(&@default) : @default
+      @default.kind_of?(Proc) ? scope.instance_exec(&@default) : @default.dup
     end
 
     def accepts?(value, scope)

data/lib/smart_properties/version.rb

@@ -1,3 +1,3 @@
 module SmartProperties
-  VERSION = "1.14.0"
+  VERSION = "1.15.0"
 end

data/spec/base_spec.rb

@@ -41,7 +41,7 @@ RSpec.describe SmartProperties do
       default_title = double(to_title: 'chunky')
 
       DummyClass.new do
-        property :title, converts: :to_title, accepts: String, required: true, default: default_title
+        property :title, converts: :to_title, accepts: String, required: true, default: -> { default_title }
       end
     end
 
@@ -49,7 +49,7 @@ RSpec.describe SmartProperties do
 
     it "should return a property's configuration with #to_h" do
       expect(klass.properties.values.first.to_h).to match(
-        accepter: String, converter: :to_title, default: an_instance_of(RSpec::Mocks::Double),
+        accepter: String, converter: :to_title, default: an_instance_of(Proc),
         instance_variable_name: :@title, name: :title, reader: :title, required: true
       )
     end

data/spec/configuration_error_spec.rb

@@ -13,5 +13,19 @@ RSpec.describe SmartProperties, 'configuration error' do
 
       expect(&invalid_property_definition).to raise_error(SmartProperties::ConfigurationError, "SmartProperties do not support the following configuration options: invalid_option_1, invalid_option_2, invalid_option_3.")
     end
+
+    it "should not accept default values that may be mutated" do
+      invalid_property_definition = lambda do
+        klass.class_eval do
+          property :title, default: []
+        end
+      end
+
+      expect(&invalid_property_definition).to(
+        raise_error(SmartProperties::ConfigurationError,
+          "Default attribute value [] cannot be specified as literal, "\
+            "use the syntax `default: -> { ... }` instead.")
+      )
+    end
   end
 end

data/spec/default_values_spec.rb

@@ -48,4 +48,72 @@ RSpec.describe SmartProperties, 'default values' do
       end
     end
   end
+
+  context "when defining a new property with a literal default value" do
+    context 'with a numeric default' do
+      subject(:klass) { DummyClass.new { property :var, default: 123 } }
+
+      it 'accepts the default and returns it' do
+        instance = klass.new
+        expect(instance.var).to(be(123))
+      end
+    end
+
+    context 'with a string default' do
+      DEFAULT_VALUE = 'a string'
+      subject(:klass) { DummyClass.new { property :var, default: DEFAULT_VALUE } }
+
+      it 'accepts the default and returns it' do
+        instance = klass.new
+        expect(instance.var).to(eq(DEFAULT_VALUE))
+      end
+
+      it 'returns a copy of the string' do
+        instance = klass.new
+        expect(instance.var).to_not(be(DEFAULT_VALUE))
+      end
+
+      it 'mutating the instance variable does not mutate the original' do
+        instance = klass.new
+        instance.var[0] = 'o'
+        expect(DEFAULT_VALUE).to(eq('a string'))
+      end
+    end
+
+    context 'with a range default' do
+      subject(:klass) { DummyClass.new { property :var, default: 1..2 } }
+
+      it 'accepts the default and returns it' do
+        instance = klass.new
+        expect(instance.var).to(eq(1..2))
+      end
+    end
+
+    context 'with a true default' do
+      subject(:klass) { DummyClass.new { property :var, default: true } }
+
+      it 'accepts the default and returns it' do
+        instance = klass.new
+        expect(instance.var).to(be(true))
+      end
+    end
+
+    context 'with a false default' do
+      subject(:klass) { DummyClass.new { property :var, default: false } }
+
+      it 'accepts the default and returns it' do
+        instance = klass.new
+        expect(instance.var).to(be(false))
+      end
+    end
+
+    context 'with a symbol default' do
+      subject(:klass) { DummyClass.new { property :var, default: :foo } }
+
+      it 'accepts the default and returns it' do
+        instance = klass.new
+        expect(instance.var).to(be(:foo))
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_properties
 version: !ruby/object:Gem::Version
-  version: 1.14.0
+  version: 1.15.0
 platform: ruby
 authors:
 - Konstantin Tennhard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-13 00:00:00.000000000 Z
+date: 2019-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec