konstructor 0.4.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60d74b10c2dc765e0f410b9aaedb1380fc95d99e
-  data.tar.gz: 1a49238ace7f7abc0650f34703eee2131e3f534a
+  metadata.gz: 2b25aee9c2f472261bbcca0e6089870ac86288c7
+  data.tar.gz: 7189a66fc0ee859892a97a9534ad10ca02280af1
 SHA512:
-  metadata.gz: befc712f9fc03b0b31c21b96c0fb0d8878240888fd409b72d1442d23c54589baf3e94698584236527322543996d6c552a7fea255c9e7b668dbba34f2e3302d52
-  data.tar.gz: c653555abe700f34d8f3edd41fa60727fb0aa44163bc2063881b028613bdd845339fc2c7d00731841f0aebafe6f74df25064783b6d677d3f1382e1295b394739
+  metadata.gz: 19e2dd031b428fba484ad91b2f187ccb73453ddca97448ebe3d3c68884f1f569474515103abc66fe8af3234a08fe972f897f5ff80ba9b7b8098202ae9f70092a
+  data.tar.gz: 76f25aa0a032a26ed7246c27e6cd51a9390f3b770d6540bb6b795f0d622c3e65fdb5a01e203d00d89a67835535a0e3a0e5a0ea85163894b6f182b73d0b97bcdd

data/README.md

@@ -1,10 +1,14 @@
 [![Gem Version](http://img.shields.io/gem/v/konstructor.svg)][gem]
 [![Build Status](https://travis-ci.org/snovity/konstructor.svg?branch=master)][travis]
 [![Coverage Status](https://coveralls.io/repos/github/snovity/konstructor/badge.svg?branch=master)][coveralls]
+[![Code Climate](https://codeclimate.com/github/snovity/konstructor/badges/gpa.svg)][codeclimate]
+[![Dependency Status](https://gemnasium.com/badges/github.com/snovity/konstructor.svg)][gemnasium]
 
 [gem]: https://rubygems.org/gems/konstructor
 [travis]: http://travis-ci.org/snovity/konstructor
 [coveralls]: https://coveralls.io/github/snovity/konstructor
+[gemnasium]: https://gemnasium.com/snovity/konstructor
+[codeclimate]: https://codeclimate.com/github/snovity/konstructor
 
 # Konstructor
 
@@ -116,7 +120,7 @@ and two additional ones.
 ```
  
 If you decide to remove the default Ruby constructor for some reason,
-you can effectively do it by marking it as private using Ruby 
+you can achieve the effect by marking it private with Ruby 
 method `private_class_method`:
  
 ```ruby
@@ -187,6 +191,9 @@ class SomeClass
     @number = some_number
   end
 end    
+
+obj0 = SomeClass.create(3)
+obj1 = SomeClass.create("three") # raises contract exception
 ```
   
 If you stumble upon a metaprogramming gem that 
@@ -195,19 +202,20 @@ conflicts with Konstructor, please
   
 ## Details
 
-Ruby constructor is a pair consisting of public factory method defined
-on a class and a private instance method. Therefore, to achieve 
-its goal `konstructor` marks instance method as private and defines a 
+The default Ruby constructor is a pair consisting of public
+class method `new` and a private instance 
+method `initialize`. To create an additional one `konstructor`
+marks given instance method as private and defines a 
 corresponding public class method with the same name.
 
 #### Performance
  
-Konstructor does all its work when class is being defined. Once class
-has been defined, it's just standard Ruby instance creation.
-Therefore, there is no runtime performance penalty. 
+Using `konstructor` declaration has no runtime perfomance penalty, 
+since all work is done during class definition and then it's just 
+standard Ruby instance creation. 
 
-As for the cost of declaring a constructor at initial load time, 
-it's roughly the same as declaring 3 properties with `attr_accessor`.
+Cost of `konstructor` declaration at initial load time is roughly the 
+same as declaring 3 properties with `attr_accessor`.
 ```ruby
   attr_accessor :one, :two, :three
   
@@ -219,9 +227,10 @@ it's roughly the same as declaring 3 properties with `attr_accessor`.
 See [Benchmarks page](https://github.com/snovity/konstructor/wiki/Benchmarks)
 for details.
 
-#### Dependencies
+#### Dependencies and requirements
 
-Konstructor doesn't depend on other gems.
+Konstructor doesn't depend on other gems. 
+Requires Ruby `2.0.0` or higher. 
   
 #### Thread safety
   

data/lib/konstructor/version.rb

@@ -1,3 +1,3 @@
 module Konstructor
-  VERSION = '0.4.7'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: konstructor
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Dima Lashkov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-23 00:00:00.000000000 Z
+date: 2017-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -185,7 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Multiple constructors in Ruby.