smart_properties 1.14.0 → 1.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 845948d63c5a647048b44f96e405808bdf3697430323a9ebf29b57c13ed157c9
-  data.tar.gz: be7cc4c03ab7bcba3dbdaea8a04676ada44f50f07d3f5a323926098af6560c97
+  metadata.gz: 3d970dbdc63b4c78e01ec7f569bd00d9c37a61c672f97d084a5a01b205c80159
+  data.tar.gz: 0db3dca56f41fafc8c96cef4c2ebd54068ce505101a3f949549724522b88bf3f
 SHA512:
-  metadata.gz: fc5370fce67258915440c7e6fe3b02b1207d04ab1716be3f22b478f7ebf1d22807115b2f7aa7639b82030ad4309a69941606b20d6a64815e9afacd4fb48cdafb
-  data.tar.gz: 003da1d3daab182873e5ccd4ba6359707309fc06161f095c52803cfd6e1d3cb055c0baa59886aaed8b51f3eb5d05d4c6efdfc6188445a6e6de8d4c48a607b8ec
+  metadata.gz: 186ffbca4f484bd2dcf39fef28bf49523323d195c515567266dfe1c1166b513a426b8da3548a350025d11ca4188984ad312302198ec8d365de00d120b93921a5
+  data.tar.gz: dffb5d926bc985cf751d654782d152acb38ef1a9b1febd9ccec9bb2589fb61e55b6f471d83d82f106d2f504b1276c2f00166ff18b2f3ea48fc550687d60cf5de

data/.github/workflows/testing.yml

@@ -0,0 +1,24 @@
+name: Testing
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+  workflow_dispatch:
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.ruby-version

@@ -1 +1 @@
-2.6.2
+2.6.6

data/README.md

@@ -177,7 +177,7 @@ often. These validations can be found in the `SmartProperties::Validations` modu
 
 ```ruby
 class Article
-  property :view_count, accepts: Ancestor.must_be(Number)
+  property :view_count, accepts: Ancestor.must_be(type: Number)
 end
 ```
 

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, Module].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)
@@ -151,12 +157,19 @@ module SmartProperties
     rescue NoMethodError => error
       # BasicObject does not respond to #nil? by default, so we need to double
       # check if somebody implemented it and it fails internally or if the
-      # error occured because the method is actually not present. In the former
-      # case, we want to raise the exception because there is something wrong
-      # with the implementation of object#nil?. In the latter case we treat the
-      # object as truthy because we don't know better.
-      raise error if (class << object; self; end).public_instance_methods.include?(:nil?)
-      false
+      # error occured because the method is actually not present.
+      
+      # This is a workaround for the fact that #singleton_class is defined on Object, but not BasicObject.
+      the_singleton_class = (class << object; self; end)
+      
+      if the_singleton_class.public_instance_methods.include?(:nil?)
+        # object defines #nil?, but it raised NoMethodError,
+        # something is wrong with the implementation, so raise the exception.
+        raise error 
+      else
+        # treat the object as truthy because we don't know better.
+        false 
+      end
     end
   end
 end

data/lib/smart_properties/property_collection.rb

@@ -5,18 +5,19 @@ module SmartProperties
     attr_reader :parent
 
     def self.for(scope)
-      parent = scope.ancestors[1..-1].find do |ancestor|
+      parents = scope.ancestors[1..-1].select do |ancestor|
         ancestor.ancestors.include?(SmartProperties) &&
           ancestor != scope &&
           ancestor != SmartProperties
       end
 
-      if parent.nil?
-        new
-      else
-        parent.properties.register(collection = new)
-        collection
+      collection = new
+
+      parents.reverse.each do |parent|
+        parent.properties.register(collection)
       end
+
+      collection
     end
 
     def initialize
@@ -75,7 +76,7 @@ module SmartProperties
     end
 
     def refresh(parent_collection)
-      @collection_with_parent_collection = parent_collection.merge(collection)
+      @collection_with_parent_collection.merge!(parent_collection)
       notify_children
       nil
     end

data/lib/smart_properties/version.rb

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

data/lib/smart_properties.rb

@@ -91,6 +91,13 @@ module SmartProperties
     protected :property!
   end
 
+  module ModuleMethods
+    def included(target)
+      super
+      target.include(SmartProperties)
+    end
+  end
+
   class << self
     private
 
@@ -102,6 +109,7 @@ module SmartProperties
     #
     def included(base)
       base.extend(ClassMethods)
+      base.extend(ModuleMethods) if base.is_a?(Module)
     end
   end
 

data/smart_properties.gemspec

@@ -12,6 +12,10 @@ Gem::Specification.new do |gem|
   gem.summary       = %q{SmartProperties – Ruby accessors on steroids}
   gem.homepage      = ""
 
+  gem.metadata = {
+    "source_code_uri" => "https://github.com/t6d/smart_properties"
+  }
+
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
@@ -20,6 +24,6 @@ Gem::Specification.new do |gem|
   gem.version       = SmartProperties::VERSION
 
   gem.add_development_dependency "rspec", "~> 3.0"
-  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "rake", "~> 13.0"
   gem.add_development_dependency "pry"
 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,38 @@ 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 accept default values that can't be mutated" do
+      valid_property_definition = lambda do
+        klass.class_eval do
+          property :proc, default: -> { }
+          property :numeric_float, default: 1.23
+          property :numeric_int, default: 456
+          property :string, default: "abc"
+          property :range, default: 123...456
+          property :bool_true, default: true
+          property :bool_false, default: false
+          property :nil, default: nil
+          property :symbol, default: :abc
+          property :module, default: Integer
+        end
+      end
+
+      expect(&valid_property_definition).not_to raise_error
+    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

data/spec/inheritance_spec.rb

@@ -225,4 +225,68 @@ RSpec.describe SmartProperties, 'intheritance' do
       end
     end
   end
+
+  context "through modules" do
+    let(:m) do
+      m = Module.new do
+        include SmartProperties
+        property :m, default: 1
+      end
+    end
+
+    let(:n) do
+      n = Module.new do
+        include SmartProperties
+        property :n, default: 2
+      end
+    end
+
+    it "is supported" do
+      n = self.n
+      m = self.m
+      o = Module.new {}
+
+      klass = Class.new do
+        include m
+        include o
+        include n
+      end
+
+      n.module_eval do
+        property :p, default: 3
+      end
+
+      instance = klass.new
+
+      expect(instance.m).to eq(1)
+      expect(instance.n).to eq(2)
+      expect(instance.p).to eq(3)
+
+      expect { klass.new(m: 4, n: 5, p: 6) }.to_not raise_error
+    end
+
+    it "yields properly ordered properties – child properties have higher precedence than parent properties" do
+      n = self.n
+      m = self.m
+
+      parent = Class.new do
+        include m
+        include n
+      end
+      expect(parent.new.m).to eq(1)
+
+      child = Class.new(parent) do
+        property :m, default: 0
+      end
+      expect(child.new.m).to eq(0)
+
+      grandchild = Class.new(child)
+      expect(grandchild.new.m).to eq(0)
+
+      grandgrandchild = Class.new(grandchild) do
+        property :m, default: 1000
+      end
+      expect(grandgrandchild.new.m).to eq(1000)
+    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.16.2
 platform: ruby
 authors:
 - Konstantin Tennhard
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-13 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -62,6 +62,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/testing.yml"
 - ".gitignore"
 - ".ruby-version"
 - ".yardopts"
@@ -95,8 +96,9 @@ files:
 - spec/writable_spec.rb
 homepage: ''
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/t6d/smart_properties
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -111,8 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.20
+signing_key:
 specification_version: 4
 summary: SmartProperties – Ruby accessors on steroids
 test_files: