smart_properties 1.2.3 → 1.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ad423c03336ecabd1643f2cfea0faacc7e74f68
+  data.tar.gz: 5b1f77117faaa6314f0a4fe62952367cf3f13fcd
+SHA512:
+  metadata.gz: cb13998cb8ca5404110a2596dbc58442a13554d75026d44668759a35b7c3a942de99b3c80f32465917e5e4ff3c7a414f194768dc78ceb49a8eea89901e14c905
+  data.tar.gz: 61d44649397e83afb2c1abb20af45c01e7aac716e73089720d210b5faeb798c6d6695cc627287c564cb9b41f642c1383e72a52df7bb656cea3c38ce7040dbbda

data/README.md

@@ -1,4 +1,4 @@
-# SmartProperties
+# Smartproperties
 
 Ruby accessors on steroids.
 
@@ -6,15 +6,21 @@ Ruby accessors on steroids.
 
 Add this line to your application's Gemfile:
 
-    gem 'smart_properties'
+```ruby
+gem 'smart_properties'
+```
 
 And then execute:
 
-    $ bundle
+```plain
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install smart_properties
+```plain
+$ gem install smart_properties
+```
 
 ## Usage
 
@@ -45,32 +51,45 @@ The example below shows how to implement a class called `Message` which has
 three properties: `subject`, `body`, and `priority`. The two properties,
 `subject` and `priority`, are required whereas `body` is optional.
 Furthermore, all properties use input conversion. The `priority` property also
-uses validation and has a default value.
-
-    class Message
-      property :subject,  :converts => :to_s
-      
-      property :body,     :converts => :to_s
-      
-      property :priority, :converts => :to_sym, 
-                          :accepts  => [:low, :normal, :high],
-                          :default  => :normal
-                          :required => true
-    end
-    
+uses validation and has a default value so if it is not set during initialization
+it will be set according to the default value.
+
+```ruby
+require 'rubygems'
+require 'smart_properties'
+
+class Message
+  include SmartProperties
+
+  property :subject,  :converts => :to_s,
+                      :required => true
+
+  property :body,     :converts => :to_s
+
+  property :priority, :converts => :to_sym,
+                      :accepts  => [:low, :normal, :high],
+                      :default  => :normal,
+                      :required => true
+end
+```
+
 Creating an instance of this class without specifying any attributes will
 result in an `ArgumentError` telling you to specify the required property
 `subject`.
 
-    Message.new # => raises ArgumentError, "Message requires the property subject to be set"
+```ruby
+Message.new # => raises ArgumentError, "Message requires the property subject to be set"
+```
 
 Providing the constructor with a title but with an invalid value for the
 property `priority` will also result in an `ArgumentError` telling you to
 provide a proper value for the property `priority`.
 
-    m = Message.new :subject => 'Lorem ipsum'
-    m.priority # => :normal
-    m.priority = :urgent # => raises ArgumentError, Message does not accept :urgent as value for the property priority
+```ruby
+m = Message.new :subject => 'Lorem ipsum'
+m.priority # => :normal
+m.priority = :urgent # => raises ArgumentError, Message does not accept :urgent as value for the property priority
+```
 
 Next, we discuss the various configuration options `SmartProperties` provide.
 
@@ -89,9 +108,11 @@ the result of this method call as value instead. The example below shows how
 to implement a property that automatically converts all given input to a
 `String` by calling `#to_s` on the object provided as input.
 
-    class Article
-      property :title, :converts => :to_s
-    end
+```ruby
+class Article
+  property :title, :converts => :to_s
+end
+```
 
 If you need more fine-grained control, you can use a lambda statement to
 specify how the conversion should be done. The statement will be evaluated in
@@ -99,9 +120,11 @@ the context of the class defining the property and takes the given value as
 input. The example below shows how to implement a property that automatically
 converts all given input to a slug representation.
 
-    class Article
-      property :slug, :converts => lambda { |slug| slug.downcase.gsub(/\s+/, '-').gsub(/\W/, '') }
-    end
+```ruby
+class Article
+  property :slug, :converts => lambda { |slug| slug.downcase.gsub(/\s+/, '-').gsub(/\W/, '') }
+end
+```
 
 #### Input validation
 
@@ -111,17 +134,21 @@ automatic validation whenever the setter for a certain property is called. The
 example below shows how to implement a property which only accepts instances
 of type `String` as input.
 
-    class Article
-      property :title, :accepts => String
-    end
+```ruby
+class Article
+  property :title, :accepts => String
+end
+```
 
 Instead of using a class, you can also use a list of permitted values. The
 example below shows how to implement a property that only accepts `true` or
 `false` as values.
 
-    class Article
-      property :published, :accepts => [true, false]
-    end
+```ruby
+class Article
+  property :published, :accepts => [true, false]
+end
+```
 
 You can also use a `lambda` statement for input validation if a more complex
 validation procedure is required. The `lambda` statement is evaluated in the
@@ -129,9 +156,11 @@ context of the class that defines the property and receives the given value as
 input. The example below shows how to implement a property called title that
 only accepts values which match the given regular expression.
 
-    class Article
-      property :title, :accepts => lambda { |title| /^Lorem \w+$/ =~ title }
-    end
+```ruby
+class Article
+  property :title, :accepts => lambda { |title| /^Lorem \w+$/ =~ title }
+end
+```
 
 #### Default values
 
@@ -140,20 +169,39 @@ configuration parameter to configure a default value for a certain property.
 The example below demonstrates how to implement a property that has 42 as
 default value.
 
-    class Article
-      property :id, :default => 42
-    end
+```ruby
+class Article
+  property :id, :default => 42
+end
+```
+
+Default values can also be specified using blocks which are evaluated at
+runtime.
 
 #### Presence checking
 
-To ensure that a property is always set set and never `nil`, you can use the
+To ensure that a property is always set and never `nil`, you can use the
 `:required` configuration parameter. If present, this parameter will instruct
 the setter of a property to not accept nil as input. The example below shows
 how to implement a property that may not be `nil`.
 
-    class Article
-      property :title, :required => true
-    end
+```ruby
+class Article
+  property :title, :required => true
+end
+```
+
+The decision whether or not a property is required can also be delayed and
+evaluated at runtime by providing a block instead of a boolean value. The
+example below shows how to implement a class that has two properties, `name`
+and `anonoymous`. The `name` is only required if `anonymous` is set to `false`.
+
+```ruby
+class Person
+  property :name, required: lambda { not anonymous }
+  property :anonymous, required: true, default: true, accepts: [true, false]
+end
+```
 
 ## Contributing
 

data/lib/smart_properties.rb

@@ -22,7 +22,7 @@
 #
 module SmartProperties
 
-  VERSION = "1.2.3"
+  VERSION = "1.3.0"
 
   class Property
 
@@ -37,19 +37,15 @@ module SmartProperties
       @default   = attrs.delete(:default)
       @converter = attrs.delete(:converts)
       @accepter  = attrs.delete(:accepts)
-      @required  = !!attrs.delete(:required)
+      @required  = attrs.delete(:required)
 
       unless attrs.empty?
         raise ArgumentError, "SmartProperties do not support the following configuration options: #{attrs.keys.map { |m| m.to_s }.sort.join(', ')}."
       end
     end
 
-    def required=(value)
-      @required = !!value
-    end
-
-    def required?
-      @required
+    def required?(scope)
+      @required.kind_of?(Proc) ? scope.instance_exec(&@required) : !!@required
     end
 
     def convert(value, scope)
@@ -84,7 +80,7 @@ module SmartProperties
     end
 
     def prepare(value, scope)
-      if required? && value.nil?
+      if required?(scope) && value.nil?
         raise ArgumentError, "#{scope.class.name} requires the property #{self.name} to be set"
       end
 
@@ -94,7 +90,7 @@ module SmartProperties
         raise ArgumentError, "#{scope.class.name} does not accept #{value.inspect} as value for the property #{self.name}"
       end
 
-      @value = value
+      value
     end
 
     def define(klass)
@@ -259,7 +255,7 @@ module SmartProperties
     block.call(self) if block
 
     # Check presence of all required properties
-    faulty_properties = properties.select { |_, property| property.required? && send(property.name).nil? }
+    faulty_properties = properties.select { |_, property| property.required?(self) && send(property.name).nil? }
     unless faulty_properties.empty?
       raise ArgumentError, "#{self.class.name} requires the following properties to be set: #{faulty_properties.map { |_, property| property.name }.sort.join(' ')}"
     end

data/spec/smart_properties_spec.rb

@@ -11,7 +11,7 @@ describe SmartProperties do
     end
 
     it "should add a .property method" do
-      subject.should respond_to(:property)
+      subject.respond_to?(:property, true).should be_true
     end
 
     context "and defining a property with invalid configuration options" do
@@ -620,6 +620,39 @@ describe SmartProperties do
 
   end
 
+  context "when building a class that has a property which is required depending on the value of another property" do
+
+    subject(:klass) do
+      described_class = self.described_class
+
+      Class.new do
+        include described_class
+        property :name, :required => lambda { not anonymous }
+        property :anonymous, accepts: [true, false], default: true
+        def self.name; "Dummy"; end
+      end
+    end
+
+    context "when created with no arguments" do
+      it "should not raise an error" do
+        expect { klass.new }.to_not raise_error
+      end
+    end
+
+    context "when created with no name and anonymous being set to false" do
+      it "should raise an error indicating that a required property was not specified" do
+        expect { klass.new anonymous: false }.to raise_error(ArgumentError, "Dummy requires the following properties to be set: name")
+      end
+    end
+
+    context "when created with a name and anonymous being set to false" do
+      it "should not raise an error" do
+        expect { klass.new name: "John Doe", anonymous: false }.to_not raise_error
+      end
+    end
+
+  end
+
   context "when building a class that has a property which is required and has false as default" do
 
     subject(:klass) do

metadata

@@ -1,67 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: smart_properties
 version: !ruby/object:Gem::Version
-  prerelease: 
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Konstantin Tennhard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-27 00:00:00.000000000 Z
+date: 2013-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.12'
-  name: rspec
+  type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.12'
 - !ruby/object:Gem::Dependency
-  type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
-  name: rake
+  type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
-  type: :development
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
-  name: guard-rspec
+  type: :development
   prerelease: false
-  requirement: !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.7'
-description: ! "  SmartProperties are a more flexible and feature-rich alternative
-  to\n  traditional Ruby accessors. They provide support for input conversion,\n  input
-  validation, specifying default values and presence checking.\n"
+description: |2
+    SmartProperties are a more flexible and feature-rich alternative to
+    traditional Ruby accessors. They provide support for input conversion,
+    input validation, specifying default values and presence checking.
 email:
 - me@t6d.de
 executables: []
@@ -83,33 +77,26 @@ files:
 - spec/support/smart_property_matcher.rb
 homepage: ''
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: -4042209003338815638
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      segments:
-      - 0
-      hash: -4042209003338815638
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: SmartProperties – Ruby accessors on steroids
 test_files:
 - spec/smart_properties_spec.rb