konstructor 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 38789189bfb0b4e7adc76b863632efa957a746ca
-  data.tar.gz: 3f39bd9d6e2a9a5fe687d244d8ffa967681cb6c0
+  metadata.gz: c470538008607d588c03a3f68fefb7800a88f83b
+  data.tar.gz: 6517dba98cd9ad1f387d9410dcbbc7d04b19accb
 SHA512:
-  metadata.gz: a91c8148355e831f46d1660a682629f232a4cf2aefae16ddf43051ffcef46ed5b5c53ce81cabdc5c6aebe95ffb23c26a46e5038f6279afaa99cd9545144d519d
-  data.tar.gz: 47fa9923f1ff942536926e74c128c294715db18f9c370252b11ed08780c897ea4fc3695a2b7288e6f34436fa640d16d366324c709390f24df6ada94ee41014a8
+  metadata.gz: 0f4bcbf89a42a476af95f78bc08f33d314696f8da99f7c2120f059931d693c4eee149fd39bc64fbec79897d626f2c720a5a85d4def50ddedeae31422492f25d8
+  data.tar.gz: 0ff11473769c2673730bf80222699ee2501067c7cc4e37432a3ab14882ad005a45f75fd4188a6499998ae47460d8d626c80f93a8b2084df2db4e136f36433d5a

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in konstructor.gemspec
 gemspec

data/README.md

@@ -1,9 +1,17 @@
+[![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]
+
+[gem]: https://rubygems.org/gems/konstructor
+[travis]: http://travis-ci.org/snovity/konstructor
+[coveralls]: https://coveralls.io/r/snovity/konstructor
+
 # Konstructor
 
 Konstructor is a small gem that gives you multiple
 constructors in Ruby.
 
-To define custom constructors use `konstructor` keyword:
+Use `konstructor` keyword to define constructors additional to the defaul one:
 ```ruby
 class SomeClass
   konstructor
@@ -27,21 +35,21 @@ It's similar to having overloaded constructors in other languages.
 Via Gemfile:
 
 ```ruby
-gem 'konstructor' #, require: 'konstructor/core_ext' 
+gem 'konstructor' 
 ```
 
 and then execute `bundle`. 
 
-Uncomment require option to skip adding 
-`include Konstructor` every time you want to use `konstructor` keyword. 
-
 You can also install it without Bundler:
 
     $ gem install konstructor
 
+If you wish to manually include Konstructor in your classes only when
+you need it, see [Manual include](https://github.com/snovity/konstructor/wiki/Manual-include) page.
+   
 ## Usage
 
-When no names are given `konstructor` just affects the next method:
+In simplest form `konstructor` creates a constructor from the next method.
 
  ```ruby
  konstructor
@@ -53,11 +61,15 @@ When no names are given `konstructor` just affects the next method:
  end
  ```
  
- When names are given, it makes those methods konstructors:
+When method names are given, it creates constructors from 
+those methods without affecting the next method.
  
  ```ruby
  konstructor :create, :recreate
  
+ def not_constructor
+ end
+ 
  def create
  end
  
@@ -65,7 +77,7 @@ When no names are given `konstructor` just affects the next method:
  end
  ```
  
- Call with names can be placed anywhere in class definition:
+ Call with method names can be placed anywhere in class definition.
  
  ```ruby
   def create
@@ -78,7 +90,7 @@ When no names are given `konstructor` just affects the next method:
  ```
  
  In all above cases the class will have the default constructor 
- and two custom ones:
+ and two additional ones.
  
  ```ruby
  obj0 = SomeClass.new
@@ -88,8 +100,10 @@ When no names are given `konstructor` just affects the next method:
  
 ### Same as default constructor
  
-Konstructors work exactly the same way as built-in Ruby constructor.
-You can pass blocks to them: 
+Additional constructors work exactly the same way as 
+built-in Ruby constructor. 
+
+You can pass blocks to them. 
 
 ```ruby
 konstructor
@@ -101,7 +115,26 @@ obj = SomeClass.create(3) { |v| v*3 }
 obj.val # 9
 ```
 
-You can override konstructors in subclasses and call `super`. 
+You can override them in subclasses and call `super`.
+```ruby
+class SomeClass
+  konstructor
+  def create(val)
+    @val = val
+  end
+  
+  attr_reader :val
+end
+
+class SomeSubclass < SomeClass
+  def create(val1, val2)
+    super(val1 * val2)
+  end
+end
+
+obj = SomeSubclass.create(2, 3)
+obj.val # 6
+``` 
 Once method is a marked as konstructor in hierarchy, 
 it is always a konstructor.
                                    
@@ -111,8 +144,8 @@ mark it as konstructor and call the inherited one.
 
 ### Reserved names
 
-Using reserved method names `new` and `initialize` for custom 
-constructor definition will raise an error:
+Using reserved method names `new` and `initialize` for additional 
+constructor declaration will raise an error:
 ```ruby
 konstructor
 def initialize # raises Konstructor::ReservedNameError
@@ -133,9 +166,9 @@ define konstructor in `included` block.
 ### Using with other gems
 
 Konstructor doesn't affect other gems, including those
-that depend on metaprogramming, such as rake, thor, contracts, etc.
+that depend on metaprogramming, such as [rake](https://github.com/ruby/rake), [thor](https://github.com/erikhuda/thor), [contracts](https://github.com/egonSchiele/contracts.ruby), etc.
 
-For instnace, Konstructor works with contracts gem:
+For instnace, this is how Konstructor works with contracts gem:
 ```ruby
   class SomeClass
     konstructor
@@ -147,11 +180,11 @@ For instnace, Konstructor works with contracts gem:
 ```
   
 If you stumble upon a metaprogramming gem that 
-conflicts with Konstructor, please open an issue.
+conflicts with Konstructor, please [open an issue](https://github.com/snovity/konstructor/issues/new).
 
 ### Removing default constructor
 
-You can effectively remove default Ruby construtor
+You can effectively remove default Ruby constructor
 by marking it as private:
 ```ruby
 class SomeClass
@@ -163,10 +196,9 @@ end
  
 Konstructor does all its work when class is being defined. Once class
 has been defined, it's just standard Ruby instance creation.
-Therefore, it's as fast as standard Ruby constructor. 
+Therefore, there is no runtime performance penalty. 
 
-If there is a slowdown during startup, it should be comparable 
-to the one of `attr_accessor` or `ActiveSupport::Concern`. 
+Konstructor doesn't depend on other gems.
   
 ## Thread safety
   
@@ -175,8 +207,8 @@ Konstructor is thread safe.
 ## Details
 
 Ruby constructor is a pair consisting of public factory method defined
-on a class and a private instance method. Therefore, 
-`konstructor` marks instance method as private and defines a 
+on a class and a private instance method. Therefore, to achieve 
+its goal `konstructor` marks instance method as private and defines a 
 corresponding public class method with the same name.
 
 You can check if certain instance method name has been declared as 
@@ -188,7 +220,7 @@ Konstructor.is?(SomeClass, :recreate) # true
 Konstructor.is?(SomeClass, :something_else) # false
 ``` 
  
-It will return true even if there is not such constructor has 
+It will return true even if no such constructor has 
 been defined yet. Like:
 ```ruby
 class SomeClass

data/bin/console

@@ -2,10 +2,5 @@
 
 require 'bundler/setup'
 require 'konstructor'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
 require 'pry'
-Pry.start
+Pry.start

data/konstructor.gemspec

@@ -31,6 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry-byebug', '~> 3.4'
   spec.add_development_dependency 'activesupport', '~> 4.2'
+  spec.add_development_dependency 'coveralls', '~> 0.8.19'
 
   # to test conflicts, specifying precise versions since below version 1 and no semver guarantees
   spec.add_development_dependency 'thor', '0.19.4'

data/lib/konstructor.rb

@@ -1,82 +1,2 @@
-require 'konstructor/version'
-require 'konstructor/exceptions'
-require 'konstructor/simple_method_hook'
-require 'konstructor/factory'
-
-module Konstructor
-
-  module KonstructorMethod
-    private
-
-    # TODO: ADD DOCS
-    def konstructor(*new_names)
-      Konstructor.declare(self, new_names)
-    end
-  end
-
-  DEFAULT_NAMES = [:initialize]
-  RESERVED_NAMES = [:new, :initialize]
-
-  class << self
-    def reserved?(name)
-      RESERVED_NAMES.include?(name.to_sym)
-    end
-
-    def default?(name)
-      DEFAULT_NAMES.include?(name.to_sym)
-    end
-
-    def declared?(klass, name)
-      konstructor = get_factory(klass)
-      if konstructor
-        konstructor.declared?(name.to_sym)
-      else
-        false
-      end
-    end
-
-    def declare(klass, new_names)
-      setup_method_added_hook(klass)
-      get_or_init_factory(klass).declare(new_names)
-    end
-
-    def method_added_to_klass(klass, name)
-      get_or_init_factory(klass).method_added_to_klass(name)
-    end
-
-    def is?(klass, name)
-      default?(name) || declared?(klass, name)
-    end
-
-    private
-
-    def get_factory(klass)
-      klass.instance_variable_get(:@konstructor)
-    end
-
-    def init_factory(klass)
-      # using variable @konstructor to minimize footprint, although saving factory there
-      klass.instance_variable_set(:@konstructor, Factory.new(klass))
-    end
-
-    def get_or_init_factory(klass)
-      get_factory(klass) || init_factory(klass)
-    end
-
-    def setup_method_added_hook(klass)
-      SimpleMethodHook.setup(klass)
-    end
-
-    # Overriden append_features prevents default behavior
-    # of including all the constants, variables to the base class.
-    # It adds only one method 'konstructor'.
-    def append_features(klass)
-      unless klass.is_a? Class
-        raise IncludeInModuleError, klass
-      end
-
-      klass.extend(KonstructorMethod)
-    end
-  end
-
-end
+require 'konstructor/main'
+require 'konstructor/core_ext'

data/lib/konstructor/core_ext.rb

@@ -1,4 +1,3 @@
-require_relative '../konstructor'
 
 class Class
 

data/lib/konstructor/main.rb

@@ -0,0 +1,82 @@
+require 'konstructor/version'
+require 'konstructor/exceptions'
+require 'konstructor/simple_method_hook'
+require 'konstructor/factory'
+
+module Konstructor
+
+  module KonstructorMethod
+    private
+
+    # TODO: ADD DOCS
+    def konstructor(*new_names)
+      Konstructor.declare(self, new_names)
+    end
+  end
+
+  DEFAULT_NAMES = [:initialize]
+  RESERVED_NAMES = [:new, :initialize]
+
+  class << self
+    def reserved?(name)
+      RESERVED_NAMES.include?(name.to_sym)
+    end
+
+    def default?(name)
+      DEFAULT_NAMES.include?(name.to_sym)
+    end
+
+    def declared?(klass, name)
+      konstructor = get_factory(klass)
+      if konstructor
+        konstructor.declared?(name.to_sym)
+      else
+        false
+      end
+    end
+
+    def declare(klass, new_names)
+      setup_method_added_hook(klass)
+      get_or_init_factory(klass).declare(new_names)
+    end
+
+    def method_added_to_klass(klass, name)
+      get_or_init_factory(klass).method_added_to_klass(name)
+    end
+
+    def is?(klass, name)
+      default?(name) || declared?(klass, name)
+    end
+
+    private
+
+    def get_factory(klass)
+      klass.instance_variable_get(:@konstructor)
+    end
+
+    def init_factory(klass)
+      # using variable @konstructor to minimize footprint, although saving factory there
+      klass.instance_variable_set(:@konstructor, Factory.new(klass))
+    end
+
+    def get_or_init_factory(klass)
+      get_factory(klass) || init_factory(klass)
+    end
+
+    def setup_method_added_hook(klass)
+      SimpleMethodHook.setup(klass)
+    end
+
+    # Overriden append_features prevents default behavior
+    # of including all the constants, variables to the base class.
+    # It adds only one method 'konstructor'.
+    def append_features(klass)
+      unless klass.is_a? Class
+        raise IncludeInModuleError, klass
+      end
+
+      klass.extend(KonstructorMethod)
+    end
+  end
+
+end

data/lib/konstructor/no_core_ext.rb

@@ -0,0 +1 @@
+require 'konstructor/main'

data/lib/konstructor/version.rb

@@ -1,3 +1,3 @@
 module Konstructor
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: konstructor
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Dima Lashkov
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.19
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.19
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +160,8 @@ files:
 - lib/konstructor/exceptions.rb
 - lib/konstructor/factory.rb
 - lib/konstructor/konstructor_method_hook.rb
+- lib/konstructor/main.rb
+- lib/konstructor/no_core_ext.rb
 - lib/konstructor/simple_method_hook.rb
 - lib/konstructor/version.rb
 homepage: https://github.com/snovity/konstructor