smart_properties 1.13.0 → 1.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fbf78f2b4f868f64a7e675336305c7f68579ec33
-  data.tar.gz: 12eeb1777b492bfb56f4d3fe68e0b2fbea222d88
+  metadata.gz: b393bac2287b2fc8bc96acdfe0da75ee774d9193
+  data.tar.gz: f6cc1a80370cdd4d2c361c4eaf6b933841747a10
 SHA512:
-  metadata.gz: 67139c47fcc6da96c64d3d4489cfc16144f5cdb8772ece8b96e493a3aed6b127de5197003d7695f1d61365e7b2154a5983c2653c9b33e9529ac3d5f4702293b1
-  data.tar.gz: 926f1575ffe3723a502ae0f2d427df880d638fafc47ff5870a19df87e81103cf435bf4f2931d583a08e9f7095e1ac41e2d2d7fcab6c54b628b728522f6777b64
+  metadata.gz: f878809a07157695137651ad2a20daf44b7dbbec3beae5685fc05c9512f6c165a366d6cf9b67256912bc8e1e50acb3fff98245997364560e894d35a816f46c0d
+  data.tar.gz: 70571022057eb569d0b0702e25218d99a052be2506fb63d43262ef31ce869a05f462b38e3dbce681f2368b52516f4321328207cb40f9a0311df5cd9989cb8f8b

data/.ruby-version

@@ -0,0 +1 @@
+2.4.1

data/README.md

@@ -220,7 +220,7 @@ class Person
 end
 ```
 
-#### Custom readers
+#### Custom reader naming
 
 In Ruby, predicate methods by convention end with a `?`.
 This convention is violated in the example above, but can easily be fixed by supplying a custom `reader` name:
@@ -235,6 +235,22 @@ end
 To ensure backwards compatibility, boolean properties do not automatically change their reader name.
 It is thus your responsibility to configure the property properly.
 
+#### Custom reader implementation
+
+For convenience, it is possible to use the `super` method to access the original reader when overriding a reader.
+This is recommended over direct access to the instance variable.
+
+```ruby
+class Person
+  property :name
+  property! :address
+
+  def name
+    super || address.name
+  end
+end
+```
+
 ### Constructor argument forwarding
 
 The `SmartProperties` initializer forwards anything to the super constructor

data/dev.yml

@@ -0,0 +1,7 @@
+---
+name: smart-properties
+up:
+- ruby: 2.4.1
+- bundler
+commands:
+  test: bundle exec rake test

data/experiments/initialization_performance.rb

@@ -0,0 +1,34 @@
+require 'benchmark'
+require_relative '../lib/smart_properties'
+
+class A
+  include SmartProperties
+  property :a
+end
+
+class B < A
+  property :b
+end
+
+class C < B
+  property :c
+end
+
+class A2
+  def initialize(**attrs)
+    attrs.each { |k, v| send("#{k}=", v) }
+  end
+  attr_accessor :a
+end
+
+class B2 < A2
+  attr_accessor :b
+end
+
+class C2 < B2
+  attr_accessor :c
+end
+
+puts Benchmark.measure { 1_000_000.times { C.new(a: 1, b: 2, c: 3) } }
+# puts Benchmark.measure { 1_000_000.times { C2.new(a: 1, b: 2, c: 3) } }
+

data/lib/smart_properties/property.rb

@@ -2,22 +2,6 @@ module SmartProperties
   class Property
     MODULE_REFERENCE = :"@_smart_properties_method_scope"
 
-    # Defines the two index methods #[] and #[]=. This module will be included
-    # in the SmartProperties method scope.
-    module IndexMethods
-      def [](name)
-        return if name.nil?
-        name = name.to_sym
-        reader = self.class.properties[name].reader
-        public_send(reader) if self.class.properties.key?(name)
-      end
-
-      def []=(name, value)
-        return if name.nil?
-        public_send(:"#{name.to_sym}=", value) if self.class.properties.key?(name)
-      end
-    end
-
     attr_reader :name
     attr_reader :converter
     attr_reader :accepter
@@ -65,7 +49,13 @@ module SmartProperties
     def convert(scope, value)
       return value unless converter
       return value if null_object?(value)
-      scope.instance_exec(value, &converter)
+
+      case converter
+      when Symbol
+        converter.to_proc.call(value)
+      else
+        scope.instance_exec(value, &converter)
+      end
     end
 
     def default(scope)
@@ -99,7 +89,7 @@ module SmartProperties
         if klass.instance_variable_defined?(MODULE_REFERENCE)
           klass.instance_variable_get(MODULE_REFERENCE)
         else
-          m = Module.new { include IndexMethods }
+          m = Module.new
           klass.send(:include, m)
           klass.instance_variable_set(MODULE_REFERENCE, m)
           m
@@ -132,12 +122,22 @@ module SmartProperties
       scope.instance_variable_get(instance_variable_name)
     end
 
+    def to_h
+      {
+        accepter: @accepter,
+        converter: @converter,
+        default: @default,
+        instance_variable_name: @instance_variable_name,
+        name: @name,
+        reader: @reader,
+        required: @required
+      }
+    end
+
     private
 
     def null_object?(object)
-      return true if object == nil
-      return true if object.nil?
-      false
+      object.nil?
     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

data/lib/smart_properties/version.rb

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

data/lib/smart_properties.rb

@@ -153,6 +153,18 @@ module SmartProperties
 
     raise SmartProperties::InitializationError.new(self, missing_properties) unless missing_properties.empty?
   end
+
+  def [](name)
+    return if name.nil?
+    name = name.to_sym
+    reader = self.class.properties[name].reader
+    public_send(reader) if self.class.properties.key?(name)
+  end
+
+  def []=(name, value)
+    return if name.nil?
+    public_send(:"#{name.to_sym}=", value) if self.class.properties.key?(name)
+  end
 end
 
 require_relative 'smart_properties/property_collection'

data/spec/base_spec.rb

@@ -47,6 +47,13 @@ RSpec.describe SmartProperties do
 
     it { is_expected.to have_smart_property(:title) }
 
+    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),
+        instance_variable_name: :@title, name: :title, reader: :title, required: true
+      )
+    end
+
     context "an instance of this class when initialized with no arguments" do
       subject(:instance) { klass.new }
 
@@ -157,4 +164,34 @@ RSpec.describe SmartProperties do
       end
     end
   end
+
+  context "when used to build a class that has a property called relation for an arbitrary Relation class" do
+    class Relation
+      attr_reader :equality_tested
+
+      def initialize
+        @equality_tested = false
+      end
+
+      def ==(_)
+        @equality_tested = true
+        false
+      end
+    end
+
+    subject(:klass) do
+      DummyClass.new do
+        property :relation, accepts: Relation, required: true
+      end
+    end
+
+    context 'with an instance of Relation' do
+      let(:relation) { Relation.new }
+
+      it 'should not execute #== on the object' do
+        instance = klass.new(relation: relation)
+        expect(relation.equality_tested).to eq(false)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smart_properties
 version: !ruby/object:Gem::Version
-  version: 1.13.0
+  version: 1.13.1
 platform: ruby
 authors:
 - Konstantin Tennhard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-13 00:00:00.000000000 Z
+date: 2017-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -63,11 +63,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - ".yardopts"
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
+- dev.yml
+- experiments/initialization_performance.rb
 - lib/smart_properties.rb
 - lib/smart_properties/errors.rb
 - lib/smart_properties/property.rb
@@ -105,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: SmartProperties – Ruby accessors on steroids