attr_coerced 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c709d08d8b9359589eeb00ffcac0c7dac9b20b07
-  data.tar.gz: 709a619645efd382ad5f64da0653549c7e42b3e7
+  metadata.gz: 1c7d8d7c5757b03eff6ce66fd33d7f950538ac79
+  data.tar.gz: adf7da5e4929b7dd5a19018657ce96b9b84dd1f1
 SHA512:
-  metadata.gz: b96f6ca645ca651e93e7e1b0699da0b4d2cc4e4e53f6cae129c4619e3dadd220b33962b752ac8f08ebb6db39a468418f2ec129a54c170e979392969691ad4b19
-  data.tar.gz: 2bfa88ee0e7f23554c9f4c6a8b765a1858cec1641302d076738f50f73147cba34711cec14982f783dbecc5ac4a368e77b0c96a9bc598bdf17361d1ef6c5c095a
+  metadata.gz: b6e2550b927bb5ddbad0da11e937405bad95234a3bde4c7f637b9812e61662b58af5d2592c7aeb7de141742d3224633b805a6d595e253cbce28f0bac3eb15d1e
+  data.tar.gz: 5f75acb026ccabc72cc05fd4f5ae8f33907cd4c8c8bd960959cd61ab8f0fa0f2cc420c3318c6e207e9f958e562131629552ecda764b075a156569ed2bfad5e28

data/README.md

@@ -21,54 +21,77 @@ Usage
 -----
 
 ```ruby
-class MyModel
+class Foo
   extend AttrCoerced
+  attr_coerced :bar, Bar, default: :baz
+end
+
+class Bar < SimpleDelegator
 
-  # @!attribute name ("foo")
-  # @return [Name]
-  attr_coerced :name, Name, default: "foo"
+  def initialize(value)
+    super value.to_s
+  end
+  # ... methods extending the string
 end
 ```
 
-This provides coerced attribute `name` (both getter and setter), defined in a following manner:
+Ensure the constructor to accept instances of its own - this is necessary for the getter.
+
+After this both the getter and setter will be redefined:
 
 ```ruby
-class MyModel
+foo = Foo.new
 
-  # coerced getter
-  def name
-    Name.new(@name ||= "foo")
-  end
+# Coerced default value is used
+foo.bar.class    # => Bar
+foo.bar == "baz" # => true
 
-  # coerced setter
-  def name=(value)
-    @name = Name.new(value)
-  end
+# Assigned value is coerced
+foo.bar = :bar
+foo.bar.class    # => Bar
+foo.bar == "bar" # => true
 
-end
+# Reset to coerced default value
+foo.bar = nil
+foo.bar.class    # => Bar
+foo.bar == "baz" # => true
 ```
 
-You can use `attr_coerced_reader` and `attr_coerced_writer` to define only getter or setter. (Notice, the `attr_coerced_writer` doesn't use the `:default` option).
-
-The type of the attribute can be defined somehow like:
+You can redefine getter and setter only with `attr_coerced_reader` and `attr_coerced_writer`.
 
 ```ruby
-class Name < String
+class Foo
+  extend AttrCoerced
+  attr_coerced_writer :bar, Bar, default: :baz
+end
 
-  def self.new(value)
-    super unless value.blank? # returns nil except for ""
-  end
+foo = Foo.new
 
-  def initialize(value)
-    super value.to_s
-  end
+# By default value is not coerced
+foo.bar # => nil
 
-  # ... additional methods extending the string
+# The setter assigns coerced default value instead of nil
+foo.bar = nil
+foo.bar.class    # => Bar
+foo.bar == "baz" # => true
+```
 
+Notice, that if a default values isn't set or is set to `nil`, no `nil` values are coerced, because `nil` stands for nothing, not something.
+
+```ruby
+class Foo
+  extend AttrCoerced
+  att_coerced :bar, Bar
 end
-```
 
-Ensure the constructor to accept instances of its own - this is necessary for the getter.
+foo = Foo.new
+# The getter doesn't coerce nil
+foo.bar # => nil
+
+# Neither the setter does
+foo.bar = nil
+foo.bar # => nil
+```
 
 Focus
 -----
@@ -112,6 +135,14 @@ Or add it manually:
 gem install attr_coerced
 ```
 
+Changelog
+---------
+
+### v1.0.0
+
+* All methods makes `nil` not coerced because it always stands for nothing.
+* `#attr_coerced_writer` makes attribute setter to assign default value instead of `nil`. 
+
 ## Compatibility
 
 Tested under rubies compatible to API 2.0+:

data/config/metrics/roodi.yml

@@ -7,9 +7,9 @@ ClassNameCheck:
   pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
 ClassVariableCheck:
 CyclomaticComplexityBlockCheck:
-  complexity: 2
+  complexity: 3
 CyclomaticComplexityMethodCheck:
-  complexity: 2
+  complexity: 3
 EmptyRescueBodyCheck:
 ForLoopCheck:
 MethodLineCountCheck:

data/lib/attr_coerced.rb

@@ -1,10 +1,12 @@
 # encoding: utf-8
 
 require_relative "attr_coerced/version"
+require_relative "attr_coerced/coercer"
 
 # Namespace for the code of the 'attr_coerced' gem
 module AttrCoerced
 
+  # @!method attr_coerced(name, type, default: nil)
   # Defines both value getter and setter for a coercible attribute
   #
   # @example
@@ -18,11 +20,8 @@ module AttrCoerced
   #   The default value for the attribute. The value will be coerced as well
   #
   # @return [Symbol] name of the attribute
-  def attr_coerced(name, type, default: nil)
-    [
-      attr_coerced_reader(name, type, default: default),
-      attr_coerced_writer(name, type)
-    ]
+  def attr_coerced(*args)
+    [attr_coerced_reader(*args), attr_coerced_writer(*args)]
   end
 
   # Defines value getter for a coercible attribute
@@ -35,7 +34,10 @@ module AttrCoerced
   #
   # @return (see #attr_coerced)
   def attr_coerced_reader(name, type, default: nil)
-    define_method(name) { type.new(instance_eval("@#{ name }") || default) }
+    define_method name do
+      value = instance_variable_get "@#{ name }"
+      Coercer.get value, default, type
+    end
 
     name.to_sym
   end
@@ -43,17 +45,19 @@ module AttrCoerced
   # Defines value setter for a coercible attribute
   #
   # @example
-  #   attr_coerced_writer :name, Name
+  #   attr_coerced_writer :name, Name, default: "foo"
   #
   # @param  (see #attr_coerced)
+  # @option (see #attr_coerced)
   #
   # @return (see #attr_coerced)
-  def attr_coerced_writer(name, type)
+  def attr_coerced_writer(name, type, default: nil)
     define_method "#{ name }=" do |value|
-      instance_eval "@#{ name } = #{ type }.new(value)"
+      new_value = Coercer.get value, default, type
+      instance_variable_set "@#{ name }", new_value
     end
 
-    "#{ name }=".to_sym
+    :"#{ name }="
   end
 
 end # module AttrCoerced

data/lib/attr_coerced/coercer.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module AttrCoerced
+
+  # @private
+  Coercer = Struct.new(:value, :default, :type) do
+
+    def self.get(*args)
+      new(*args).get
+    end
+
+    def get
+      coerce(value) || coerce(default)
+    end
+
+    private
+
+    def coerce(something)
+      something.nil? ? nil : type.new(something)
+    end
+
+  end # class Coercer
+
+end # module AttrCoerced

data/lib/attr_coerced/version.rb

@@ -4,6 +4,6 @@ module AttrCoerced
 
   # The semantic version of the module.
   # @see http://semver.org/ Semantic versioning 2.0
-  VERSION = "0.0.1".freeze
+  VERSION = "1.0.0".freeze
 
 end # module AttrCoerced

data/spec/tests/attr_coerced_spec.rb

@@ -16,88 +16,146 @@ describe AttrCoerced do
 
   describe "#attr_coerced_reader" do
 
-    let!(:result) { test_class.attr_coerced_reader :foo, Foo, default: "bar" }
+    context "without a default value" do
 
-    it "defines the getter" do
-      expect(subject).to respond_to :foo
-    end
+      let!(:result) { test_class.attr_coerced_reader :foo, Foo }
 
-    it "makes the getter to return the default value" do
-      value = subject.foo
+      it "defines the getter" do
+        expect(subject).to respond_to :foo
+      end
 
-      expect(value).to be_kind_of Foo
-      expect(value).to eq "bar"
-    end
+      it "makes the getter to coerce the value" do
+        subject.instance_eval "@foo = \"baz\""
+        value = subject.foo
 
-    it "makes the getter to coerce the value" do
-      subject.instance_eval "@foo = \"baz\""
-      value = subject.foo
+        expect(value).to be_kind_of Foo
+        expect(value).to eq "baz"
+      end
 
-      expect(value).to be_kind_of Foo
-      expect(value).to eq "baz"
-    end
+      it "makes the getter not to coerce nil" do
+        subject.instance_eval "@foo = nil"
+        value = subject.foo
 
-    it "returns the name of the attribute" do
-      expect(result).to eq :foo
-    end
+        expect(value).to be_nil
+      end
+
+      it "returns the name of the attribute" do
+        expect(result).to eq :foo
+      end
+
+    end # context
+
+    context "with a default value" do
+
+      let!(:result) { test_class.attr_coerced_reader :foo, Foo, default: "bar" }
+
+      it "defines the getter" do
+        expect(subject).to respond_to :foo
+      end
+
+      it "makes the getter to return the default value" do
+        value = subject.foo
+
+        expect(value).to be_kind_of Foo
+        expect(value).to eq "bar"
+      end
+
+      it "makes the getter to coerce the value" do
+        subject.instance_eval "@foo = \"baz\""
+        value = subject.foo
+
+        expect(value).to be_kind_of Foo
+        expect(value).to eq "baz"
+      end
+
+      it "returns the name of the attribute" do
+        expect(result).to eq :foo
+      end
+
+    end # context
 
   end # describe #attr_coerced_reader
 
   describe "#attr_coerced_writer" do
 
-    let!(:result) { test_class.attr_coerced_writer :foo, Foo }
+    context "without a default value" do
 
-    it "defines the setter" do
-      expect(subject).to respond_to :foo=
-    end
+      let!(:result) { test_class.attr_coerced_writer :foo, Foo }
+
+      it "defines the setter" do
+        expect(subject).to respond_to :foo=
+      end
 
-    it "makes the setter to coerce the value" do
-      subject.foo = "baz"
-      value = subject.instance_eval "@foo"
+      it "makes the setter to coerce the value" do
+        subject.foo = "baz"
+        value = subject.instance_eval "@foo"
 
-      expect(value).to be_kind_of Foo
-      expect(value).to eq "baz"
-    end
+        expect(value).to be_kind_of Foo
+        expect(value).to eq "baz"
+      end
 
-    it "returns the name of the attribute" do
-      expect(result).to eq :foo=
-    end
+      it "makes the setter not to coerce nil" do
+        subject.foo = nil
+        value = subject.instance_eval "@foo"
 
-  end # describe #attr_coerced_writer
+        expect(value).to be_nil
+      end
 
-  describe "#attr_coerced" do
+      it "returns the name of the attribute" do
+        expect(result).to eq :foo=
+      end
 
-    let!(:result) { test_class.attr_coerced :foo, Foo, default: "bar" }
+    end # context
 
-    it "defines the getter" do
-      expect(subject).to respond_to :foo
-    end
+    context "with a default value" do
 
-    it "makes the getter to return the default value" do
-      value = subject.foo
+      let!(:result) { test_class.attr_coerced_writer :foo, Foo, default: "bar" }
 
-      expect(value).to be_kind_of Foo
-      expect(value).to eq "bar"
-    end
+      it "defines the setter" do
+        expect(subject).to respond_to :foo=
+      end
 
-    it "makes the getter to coerce the value" do
-      subject.instance_eval "@foo = \"baz\""
-      value = subject.foo
+      it "makes the setter to coerce the value" do
+        subject.foo = "baz"
+        value = subject.instance_eval "@foo"
 
-      expect(value).to be_kind_of Foo
-      expect(value).to eq "baz"
-    end
+        expect(value).to be_kind_of Foo
+        expect(value).to eq "baz"
+      end
 
-    it "defines the setter" do
-      expect(subject).to respond_to :foo=
-    end
+      it "makes the setter to use default instead of nil" do
+        subject.foo = nil
+        value = subject.instance_eval "@foo"
+
+        expect(value).to be_kind_of Foo
+        expect(value).to eq "bar"
+      end
+
+      it "returns the name of the attribute" do
+        expect(result).to eq :foo=
+      end
+
+    end # context
 
-    it "makes the setter to coerce the value" do
-      subject.foo = "baz"
-      value = subject.instance_eval "@foo"
+  end # describe #attr_coerced_writer
+
+  describe "#attr_coerced" do
+
+    let(:options) { [:foo, Foo, default: "bar"] }
+    let(:result)  { test_class.attr_coerced(*options) }
+
+    it "calls #attr_coerced_reader" do
+      expect(test_class)
+        .to receive(:attr_coerced_reader)
+        .with(*options)
+      result
+    end
 
-      expect(value).to be_kind_of Foo
-      expect(value).to eq "baz"
+    it "calls #attr_coerced_writer" do
+      expect(test_class)
+        .to receive(:attr_coerced_writer)
+        .with(*options)
+      result
     end
 
     it "returns the names of the methods" do

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: attr_coerced
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-30 00:00:00.000000000 Z
+date: 2015-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hexx-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
 description: Coerced attributes for PORO models.
@@ -32,13 +32,13 @@ extra_rdoc_files:
 - README.md
 - LICENSE
 files:
-- .coveralls.yml
-- .gitignore
-- .metrics
-- .rspec
-- .rubocop.yml
-- .travis.yml
-- .yardopts
+- ".coveralls.yml"
+- ".gitignore"
+- ".metrics"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
 - Guardfile
 - LICENSE
@@ -57,6 +57,7 @@ files:
 - config/metrics/simplecov.yml
 - config/metrics/yardstick.yml
 - lib/attr_coerced.rb
+- lib/attr_coerced/coercer.rb
 - lib/attr_coerced/version.rb
 - spec/spec_helper.rb
 - spec/tests/attr_coerced_spec.rb
@@ -70,12 +71,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ~>
+  - - "~>"
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []