smart_properties 1.10.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51973702fc038f8cc5e9ebd3f324096da3cd7a1f
-  data.tar.gz: 503b028e51034731838313d04197abbae91eecb2
+  metadata.gz: bc7370198b5c366256110bdf6dc2589491047c26
+  data.tar.gz: 149815152075ee2e125c4f55bb9b8916a1be631d
 SHA512:
-  metadata.gz: 4107bbacae8c70445914acbacfa7b294fab58e81aecdf83fc3084aa57f5448bfcd0be73d5ad1a13e29da0a99498d188c8499bb740e05a7f501cb66bc21d37cfc
-  data.tar.gz: 1cb798b2e0c8a984f5a4779d16e2c0f20fb35228b5de80c4e0926bb9cb5700d5b08944447b77cd7ed47d77fdfd2d5317f630d42226743d18dfe3550ed6caf277
+  metadata.gz: aa4d68dfabfd0b6cedbb2f2caa6a2105bd3ddd101bde45d3d2fef0fd52527b2ec2a3556c7b58bdf95dcf8075fc6917197e8cfda4d31795c630b6ed6a4a17f6f8
+  data.tar.gz: 895e03d0ad7aa8d96a76ce9c92e2cf72cd1ad558aeb99aaa644dc7c32fcff87f0f7db10631addf71b2193996a63b5ecf8d41a9ee66401cc6c56819fedebc042c

data/README.md

@@ -212,6 +212,21 @@ class Person
 end
 ```
 
+#### Custom readers
+
+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:
+
+```ruby
+class Person
+  property :name, required: lambda { not anonymous }
+  property :anonymous, required: true, default: true, accepts: [true, false], reader: :anonymous?
+end
+```
+
+To ensure backwards compatibility, boolean properties do not automatically change their reader name.
+It is thus your responsibility to configure the property properly.
+
 ### Constructor argument forwarding
 
 The `SmartProperties` initializer forwards anything to the super constructor

data/lib/smart_properties/errors.rb

@@ -43,7 +43,7 @@ module SmartProperties
           sender.class.name,
           value.inspect,
           property.name,
-          acceptor_message(sender, property)
+          accepter_message(sender, property)
         ]
       )
     end
@@ -54,12 +54,12 @@ module SmartProperties
 
     private
 
-    def acceptor_message(sender, property)
-      acceptor = sender.class.properties[property.name].accepter
-      if acceptor.is_a?(Proc)
-        return "Values passing lambda defined in #{acceptor.source_location.join(' at line ')}"
+    def accepter_message(sender, property)
+      accepter = property.accepter
+      if accepter.is_a?(Proc)
+        return "Values passing lambda defined in #{accepter.source_location.join(' at line ')}"
       end
-      acceptor
+      accepter
     end
   end
 

data/lib/smart_properties/property.rb

@@ -7,8 +7,9 @@ module SmartProperties
     module IndexMethods
       def [](name)
         return if name.nil?
-        name &&= name.to_sym
-        public_send(name) if self.class.properties.key?(name)
+        name = name.to_sym
+        reader = self.class.properties[name].reader
+        public_send(reader) if self.class.properties.key?(name)
       end
 
       def []=(name, value)
@@ -20,6 +21,7 @@ module SmartProperties
     attr_reader :name
     attr_reader :converter
     attr_reader :accepter
+    attr_reader :reader
     attr_reader :instance_variable_name
 
     def self.define(scope, name, options = {})
@@ -34,6 +36,8 @@ module SmartProperties
       @converter = attrs.delete(:converts)
       @accepter  = attrs.delete(:accepts)
       @required  = attrs.delete(:required)
+      @reader    = attrs.delete(:reader)
+      @reader    ||= @name
 
       @instance_variable_name = :"@#{name}"
 
@@ -101,7 +105,9 @@ module SmartProperties
           m
         end
 
-      scope.send(:attr_reader, name)
+      scope.send(:define_method, reader) do
+        property.get(self)
+      end
       scope.send(:define_method, :"#{name}=") do |value|
         property.set(self, value)
       end

data/lib/smart_properties/version.rb

@@ -1,3 +1,3 @@
 module SmartProperties
-  VERSION = "1.10.1"
+  VERSION = "1.11.0"
 end

data/spec/reader_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+RSpec.describe SmartProperties, 'reader' do
+  context "when defining a class with a property with a custom reader" do
+    subject(:klass) do
+      DummyClass.new do
+        property :new, default: false, accepts: [true, false], reader: :new?
+      end
+    end
+
+    context "an instance of this class" do
+      subject(:instance) { klass.new }
+
+      it "should read the property using a custom reader" do
+        instance = klass.new new: true
+        expect(instance.new?).to eq(true)
+
+        instance.new = false
+        expect(instance.new?).to eq(false)
+      end
+
+      it "should still read the property with the property name when using the #[] syntax" do
+        instance = klass.new new: true
+        expect(instance[:new]).to eq(true)
+
+        instance = klass.new new: false
+        expect(instance[:new]).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.10.1
+  version: 1.11.0
 platform: ruby
 authors:
 - Konstantin Tennhard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-28 00:00:00.000000000 Z
+date: 2016-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -81,6 +81,7 @@ files:
 - spec/default_values_spec.rb
 - spec/inheritance_spec.rb
 - spec/property_collection_caching_spec.rb
+- spec/reader_spec.rb
 - spec/required_values_spec.rb
 - spec/spec_helper.rb
 - spec/support/dummy_class.rb
@@ -116,8 +117,8 @@ test_files:
 - spec/default_values_spec.rb
 - spec/inheritance_spec.rb
 - spec/property_collection_caching_spec.rb
+- spec/reader_spec.rb
 - spec/required_values_spec.rb
 - spec/spec_helper.rb
 - spec/support/dummy_class.rb
 - spec/support/smart_property_matcher.rb
-has_rdoc: