smart_properties 1.13.1 → 1.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b393bac2287b2fc8bc96acdfe0da75ee774d9193
-  data.tar.gz: f6cc1a80370cdd4d2c361c4eaf6b933841747a10
+SHA256:
+  metadata.gz: 845948d63c5a647048b44f96e405808bdf3697430323a9ebf29b57c13ed157c9
+  data.tar.gz: be7cc4c03ab7bcba3dbdaea8a04676ada44f50f07d3f5a323926098af6560c97
 SHA512:
-  metadata.gz: f878809a07157695137651ad2a20daf44b7dbbec3beae5685fc05c9512f6c165a366d6cf9b67256912bc8e1e50acb3fff98245997364560e894d35a816f46c0d
-  data.tar.gz: 70571022057eb569d0b0702e25218d99a052be2506fb63d43262ef31ce869a05f462b38e3dbce681f2368b52516f4321328207cb40f9a0311df5cd9989cb8f8b
+  metadata.gz: fc5370fce67258915440c7e6fe3b02b1207d04ab1716be3f22b478f7ebf1d22807115b2f7aa7639b82030ad4309a69941606b20d6a64815e9afacd4fb48cdafb
+  data.tar.gz: 003da1d3daab182873e5ccd4ba6359707309fc06161f095c52803cfd6e1d3cb055c0baa59886aaed8b51f3eb5d05d4c6efdfc6188445a6e6de8d4c48a607b8ec

data/.gitignore

@@ -15,6 +15,7 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea/
 
 .rspec
-.rvmrc
+.rvmrc

data/.ruby-version

@@ -1 +1 @@
-2.4.1
+2.6.2

data/README.md

@@ -171,6 +171,16 @@ class Article
 end
 ```
 
+There are also a set of common validation helpers you may use. These common
+cases are provided to help avoid rewriting validation logic that occurs
+often. These validations can be found in the `SmartProperties::Validations` module.
+
+```ruby
+class Article
+  property :view_count, accepts: Ancestor.must_be(Number)
+end
+```
+
 #### Default values
 
 There is also support for default values. Simply use the `:default`

data/lib/smart_properties.rb

@@ -171,3 +171,4 @@ require_relative 'smart_properties/property_collection'
 require_relative 'smart_properties/property'
 require_relative 'smart_properties/errors'
 require_relative 'smart_properties/version'
+require_relative 'smart_properties/validations'

data/lib/smart_properties/property.rb

@@ -7,6 +7,7 @@ module SmartProperties
     attr_reader :accepter
     attr_reader :reader
     attr_reader :instance_variable_name
+    attr_reader :writable
 
     def self.define(scope, name, options = {})
       new(name, options).tap { |p| p.define(scope) }
@@ -21,6 +22,7 @@ module SmartProperties
       @accepter  = attrs.delete(:accepts)
       @required  = attrs.delete(:required)
       @reader    = attrs.delete(:reader)
+      @writable  = attrs.delete(:writable)
       @reader    ||= @name
 
       @instance_variable_name = :"@#{name}"
@@ -46,6 +48,11 @@ module SmartProperties
       !null_object?(get(scope))
     end
 
+    def writable?
+      return true if @writable.nil?
+      @writable
+    end
+
     def convert(scope, value)
       return value unless converter
       return value if null_object?(value)
@@ -98,8 +105,11 @@ module SmartProperties
       scope.send(:define_method, reader) do
         property.get(self)
       end
-      scope.send(:define_method, :"#{name}=") do |value|
-        property.set(self, value)
+
+      if writable?
+        scope.send(:define_method, :"#{name}=") do |value|
+          property.set(self, value)
+        end
       end
     end
 

data/lib/smart_properties/property_collection.rb

@@ -6,7 +6,9 @@ module SmartProperties
 
     def self.for(scope)
       parent = scope.ancestors[1..-1].find do |ancestor|
-        ancestor.ancestors.include?(SmartProperties) && ancestor != SmartProperties
+        ancestor.ancestors.include?(SmartProperties) &&
+          ancestor != scope &&
+          ancestor != SmartProperties
       end
 
       if parent.nil?

data/lib/smart_properties/validations.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module SmartProperties
+  module Validations
+  end
+end
+
+require_relative 'validations/ancestor'

data/lib/smart_properties/validations/ancestor.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module SmartProperties
+  module Validations
+    class Ancestor
+      include SmartProperties
+
+      property! :type, accepts: ->(type) { type.is_a?(Class) }
+
+      def validate(klass)
+        klass.is_a?(Class) && klass < type
+      end
+
+      def to_proc
+        validator = self
+        ->(klass) { validator.validate(klass) }
+      end
+
+      def to_s
+        "subclasses of #{type.to_s}"
+      end
+
+      class << self
+        alias_method :must_be, :new
+      end
+    end
+  end
+end

data/lib/smart_properties/version.rb

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

data/spec/property_collection_caching_spec.rb

@@ -26,4 +26,14 @@ RSpec.describe SmartProperties, "property collection caching:" do
     expect(subsubclass.properties.keys - expected_names).to be_empty
     expect(subsubclass.properties.to_hash.keys - expected_names).to be_empty
   end
+
+  specify "a SmartProperty enabled object should not check itself for properties if prepended" do
+    expect do
+      base_class = DummyClass.new {
+        prepend Module.new
+        property :title
+      }
+      expect(base_class.new).to have_smart_property(:title)
+    end.not_to raise_error(SystemStackError)
+  end
 end

data/spec/validations/ancestor_validation_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+require 'spec_helper'
+require 'smart_properties/validations/ancestor'
+
+RSpec.describe SmartProperties::Validations::Ancestor, 'validates ancestor' do
+  context 'used to validate the ancestor of a smart_properties value' do
+    let!(:test_base) do
+      Class.new do
+        def self.to_s
+          'TestBase'
+        end
+      end
+    end
+
+    subject(:klass) do
+      test_base_ref = test_base
+
+      DummyClass.new do
+        property :visible, accepts: SmartProperties::Validations::Ancestor.must_be(type: test_base_ref)
+      end
+    end
+
+    it 'should return an error for any non Class based value' do
+      expect { subject.new(visible: true) }
+        .to raise_error(SmartProperties::InvalidValueError, /Only accepts: subclasses of TestBase/)
+    end
+
+    it 'should return an error for any Class instance instead of a class type' do
+      non_ancestor_class = Class.new
+
+      expect { subject.new(visible: non_ancestor_class.new) }
+        .to raise_error(SmartProperties::InvalidValueError, /Only accepts: subclasses of TestBase/)
+    end
+
+
+    it 'should return an error for any Class instance instead of a class type even if it is a child' do
+      test_base_child = Class.new(test_base)
+
+      expect { subject.new(visible: test_base_child.new) }
+        .to raise_error(SmartProperties::InvalidValueError, /Only accepts: subclasses of TestBase/)
+    end
+
+    it 'should return an error for a Class type that is not a child of the required ancestor' do
+      non_ancestor_class = Class.new
+
+      expect { subject.new(visible: non_ancestor_class) }
+        .to raise_error(SmartProperties::InvalidValueError, /Only accepts: subclasses of TestBase/)
+    end
+
+    it 'should return an error if the class is the ancestor itself' do
+      expect { subject.new(visible: test_base) }
+        .to raise_error(SmartProperties::InvalidValueError, /Only accepts: subclasses of TestBase/)
+    end
+
+    it 'should succeed if the given class is a subtype ' do
+      test_valid_class = Class.new(test_base)
+
+      expect { subject.new(visible: test_valid_class) }
+        .not_to raise_error
+    end
+  end
+end

data/spec/writable_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe SmartProperties, 'writable properties' do
+  context 'when a property is defined as not writable there should be no accessor for the property' do
+    subject(:klass) { DummyClass.new { property :id, writable: false } }
+
+    it "should throw a no method error when trying to set the property" do
+      new_class_instance = klass.new(id: 42)
+
+      expect(new_class_instance.id).to eq(42)
+      expect { new_class_instance.id = 50 }.to raise_error(NoMethodError)
+      expect(new_class_instance.id).to eq(42)
+    end
+  end
+
+  context 'when a property is defined as writable there should be an accessor available' do
+    subject(:klass) { DummyClass.new { property :id, writable: true } }
+
+    it "should allow changing of the property" do
+      new_class_instance = klass.new(id: 42)
+
+      new_class_instance.id = 50
+      expect(new_class_instance.id).to eq(50)
+    end
+  end
+
+  context 'when writable is not defined on the property it should default to being writable' do
+    subject(:klass) { DummyClass.new { property :id } }
+
+    it "should allow changing of the property" do
+      new_class_instance = klass.new(id: 42)
+
+      new_class_instance.id = 50
+      expect(new_class_instance.id).to eq(50)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_properties
 version: !ruby/object:Gem::Version
-  version: 1.13.1
+  version: 1.14.0
 platform: ruby
 authors:
 - Konstantin Tennhard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-29 00:00:00.000000000 Z
+date: 2019-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -75,6 +75,8 @@ files:
 - lib/smart_properties/errors.rb
 - lib/smart_properties/property.rb
 - lib/smart_properties/property_collection.rb
+- lib/smart_properties/validations.rb
+- lib/smart_properties/validations/ancestor.rb
 - lib/smart_properties/version.rb
 - smart_properties.gemspec
 - spec/acceptance_checking_spec.rb
@@ -89,6 +91,8 @@ files:
 - spec/spec_helper.rb
 - spec/support/dummy_class.rb
 - spec/support/smart_property_matcher.rb
+- spec/validations/ancestor_validation_spec.rb
+- spec/writable_spec.rb
 homepage: ''
 licenses: []
 metadata: {}
@@ -107,8 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: SmartProperties – Ruby accessors on steroids
@@ -125,3 +128,5 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/dummy_class.rb
 - spec/support/smart_property_matcher.rb
+- spec/validations/ancestor_validation_spec.rb
+- spec/writable_spec.rb