konstructor 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8450249cb7a42cc6608c42e20d66d897c73779b6
-  data.tar.gz: cf0e8b2bdb6643b4debcb2cc67c11ba5c07b159f
+  metadata.gz: 44c51074d47f8b7b6fef07e36772b81c4fc5de71
+  data.tar.gz: 840b1dea7dee69bceb9595d73d76a9722bc87455
 SHA512:
-  metadata.gz: 23c32f2916a283b9ce2d26098dc2d13159bea35f3db0b109d01e4d92a43c7b50471b3b5a5c7f7d128fc1d821b5945ca5155f1f2095e1f4569dd88518a2b1f821
-  data.tar.gz: 47987108eb3206829bb5cb26f4d38c692edc1ced8da0a64cbbe46e66adeb833ec871b899a665838cb59a330713e0b526771f8a1be28287760e6756dc48623517
+  metadata.gz: 6b245d765c1dde3f18b88e4efe57f597cb9057d63eaebf100c04d94fa22cfbb2dd2890260590fed106a3a88a301f83b1a5bbca659fb2d86367ee977313291e9d
+  data.tar.gz: f7e2d3ff8a3382fdf764829e32cda532a27257c57f12d6391fe5eaebf1852b493bd12db5afdf6d6f129528639bb5c0e856fc162b7d1d52e776db3834db588b77

data/README.md

@@ -1,10 +1,10 @@
 [![Gem Version](http://img.shields.io/gem/v/konstructor.svg)][gem]
-[![Build Status](http://img.shields.io/travis/snovity/konstructor.svg)][travis]
-[![Coverage Status](http://img.shields.io/coveralls/snovity/konstructor.svg)][coveralls]
+[![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]
 
 [gem]: https://rubygems.org/gems/konstructor
 [travis]: http://travis-ci.org/snovity/konstructor
-[coveralls]: https://coveralls.io/r/snovity/konstructor
+[coveralls]: https://coveralls.io/github/snovity/konstructor
 
 # Konstructor
 
@@ -54,7 +54,7 @@ keyword in your classes only when you need it, see
 In its simplest form `konstructor` declaration creates a 
 constructor from the next method.
 
- ```ruby
+```ruby
   konstructor
   def create
   end
@@ -62,15 +62,15 @@ constructor from the next method.
   konstructor
   def recreate
   end
- ```
+```
  
 When method names are given, it creates constructors from 
 those methods without affecting the next method.
  
- ```ruby
+```ruby
   konstructor :create, :recreate
  
-  def not_constructor
+  def not_a_constructor
   end
  
   def create
@@ -78,12 +78,12 @@ those methods without affecting the next method.
  
   def recreate
   end
- ```
+```
  
- Declaration with method names can be placed anywhere in 
- class definition.
+Declaration with method names can be placed anywhere in 
+class definition.
  
- ```ruby
+```ruby
   def create
   end
   konstructor :create
@@ -91,26 +91,39 @@ those methods without affecting the next method.
   konstructor
   def recreate
   end
- ```
+```
+ 
+Several declarations may be used, 
+all declarations add up without overwriting each other. 
+```ruby     
+  def create
+  end
+   
+  konstructor :recreate
+  konstructor :create
+   
+  def recreate
+  end
+``` 
  
- In all above cases `SomeClass` will have the default constructor 
- and two additional ones.
+In all above cases `SomeClass` will have the default constructor 
+and two additional ones.
  
- ```ruby
+```ruby
  obj0 = SomeClass.new
  obj1 = SomeClass.create
  obj2 = SomeClass.recreate
- ```
+```
  
- If you decide to remove the default Ruby constructor for some reason,
- you can effectively do it by marking it as private using Ruby 
- method `private_class_method`:
+If you decide to remove the default Ruby constructor for some reason,
+you can effectively do it by marking it as private using Ruby 
+method `private_class_method`:
  
- ```ruby
+```ruby
  class SomeClass
    private_class_method :new
  end   
- ```
+```
   
 #### Same as default constructor
  
@@ -198,7 +211,7 @@ it's roughly the same as declaring 3 properties with `attr_accessor`.
 ```ruby
   attr_accessor :one, :two, :three
   
-  # following declaration take the same time as above declaration
+  # following declaration takes the same time as above declaration
   konstructor
   def create
   end
@@ -206,6 +219,8 @@ 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
+
 Konstructor doesn't depend on other gems.
   
 #### Thread safety

data/lib/konstructor/exceptions.rb

@@ -1,24 +1,31 @@
 module Konstructor
 
-  class ReservedNameError < StandardError
+  class Error < StandardError
+  end
+
+  # Raised if reserved names <code>new</code> or <code>initialize</code>
+  # are used in declaration.
+  class ReservedNameError < Error
     def initialize(name)
       super "Custom constructor can't have name '#{name}', "
             "it is reserved for default constructor."
     end
   end
 
-  class IncludeInModuleError < StandardError
-    def initialize(base)
-      super "Konstructor can't be included in module '#{base.name}' directly, " +
-            "please, use ActiveSupport::Concern or standard included hook."
-    end
-  end
-
-  class DeclaringInheritedError < StandardError
+  # Raised if declaring inherited method as constructor.
+  class DeclaringInheritedError < Error
     def initialize(name)
       super "You are declaring an inherited method '#{name}' as konstructor, "
             "this is not allowed."
     end
   end
 
+  # Raised if <code>konstructor</code> is used inside module.
+  class IncludingInModuleError < Error
+    def initialize(base)
+      super "Konstructor can't be included in module '#{base.name}' directly, " +
+            "please, use ActiveSupport::Concern or standard included hook."
+    end
+  end
+
 end

data/lib/konstructor/main.rb

@@ -8,9 +8,57 @@ module Konstructor
   module KonstructorMethod
     private
 
-    # TODO: ADD DOCS
-    def konstructor(*new_names)
-      Konstructor.declare(self, new_names)
+    # konstructor                 -> nil
+    # konstructor(symbol, ...)    -> nil
+    # konstructor(string, ...)    -> nil
+    #
+    # If used without params, declares next method as constructor.
+    #
+    #   module SomeClass
+    #     attr_reader :val
+    #
+    #     konstructor
+    #     def create(val)
+    #       @val = val
+    #     end
+    #   end
+    #
+    # If names are given, call can be placed anywhere, only methods with
+    # those names will be declared as constructors.
+    #
+    #   module SomeClass
+    #     attr_reader :val
+    #
+    #     def create(val)
+    #       @val = val
+    #     end
+    #
+    #     konstructor :create, :recreate
+    #
+    #     def recreate(val)
+    #       @val = val * 2
+    #     end
+    #   end
+    #
+    # <em>then:</em>
+    #
+    #   SomeClass.new.val
+    #   => nil
+    #   SomeClass.create(3).val
+    #   => 3
+    #   SomeClass.recreate(3).val
+    #   => 6
+    #
+    # Can be used multiple times with various arguments,
+    # all calls add up without overwriting each other.
+    #
+    # Can raise several errors inheriting from <code>Konstructor::Error</code>
+    #   ReservedNameError
+    #   DeclaringInheritedError
+    #   IncludingInModuleError
+    def konstructor(*several_variants)
+      Konstructor.declare(self, several_variants)
+      nil
     end
   end
 
@@ -72,7 +120,7 @@ module Konstructor
     # It adds only one method 'konstructor'.
     def append_features(klass)
       unless klass.is_a? Class
-        raise IncludeInModuleError, klass
+        raise IncludingInModuleError, klass
       end
 
       klass.extend(KonstructorMethod)

data/lib/konstructor/version.rb

@@ -1,3 +1,3 @@
 module Konstructor
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: konstructor
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Dima Lashkov