selfies 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ba49d8320ff6acedb3e41fb564e3566333b50ca
-  data.tar.gz: 2ab1f3809213567f3509b864670d349ea1d35d09
+  metadata.gz: 47550e2d9e6da031803c5ba23ef7d4336f0e3076
+  data.tar.gz: c05c0beae48f5d515d65d41c1fab06752cbcf5fe
 SHA512:
-  metadata.gz: 6fe532606d20e991b83d8eed8240b91fdfbfde4db16fa096b270fa933539331407a753f324daaef7912387561743b81d953a9ff15ea547c179ee5c628b6c2bfc
-  data.tar.gz: 29e8d0793f74a06ffc3a138aa94ef67a50f2632d93bc32fd9eab06c1cf8dc6ab681fb6dbd3c8d19bee557903afd2ac05e1f5afd78c7be7c55c823914e03b4d50
+  metadata.gz: 26ecd3374676bb10adc4e4c0e2f01dcd5cb1201fcd2212b0f7fa8dc3b48ab9ea753a3371642eb88c5961996a9fab593a82cc64daa1838f94143887e95e0def4b
+  data.tar.gz: c1516a43e5384a7809a99e13d4ced86091034afbd01f52fd5bb2b36bb2faf851e3d8e71c290402db569f1f774130a291340849ced93818686638394b7584f81f

data/README.md

@@ -1,4 +1,4 @@
-[![CircleCI](https://circleci.com/gh/mariodarco/selfies/tree/master.svg?style=shield)](https://circleci.com/gh/mariodarco/selfies/tree/master)
+[![Gem Version](https://badge.fury.io/rb/selfies.svg)](https://badge.fury.io/rb/selfies) [![CircleCI](https://circleci.com/gh/mariodarco/selfies/tree/master.svg?style=shield)](https://circleci.com/gh/mariodarco/selfies/tree/master)
 
 # Selfies
 **A collection of macros for quicker development**
@@ -38,12 +38,12 @@ $ gem install selfies
 
 ## Usage
 
-***self_init***: can be used to automatically generate an initialiser for your class
+***attr_reader_init***: can be used to automatically generate an initialiser for your class
 
 This code:
 ```ruby
 class Search
-  self_init :term, :page, :limit
+  attr_reader_init :term, :page, :limit
 end
 ```
 
@@ -60,6 +60,28 @@ class Search
 end
 ```
 
+***attr_accessor_init***: same as ```attr_reader_init```, but generates accessors for the given attributes
+
+This code:
+```ruby
+class Search
+  attr_accessor_init :term, :page, :limit
+end
+```
+
+Is equivalent to:
+```ruby
+class Search
+  attr_accessor :term, :page, :limit
+
+  def initialize(term, page, limit)
+    @term = term
+    @page = page
+    @limit = limit
+  end
+end
+```
+
 ***selfie***: can be used to automatically create a class method that reference to the instance method of the same class
 
 This code:
@@ -94,7 +116,7 @@ end
 Can be written as:
 ```ruby
 class Search
-  self_init :term, :page, :limit
+  attr_reader_init :term, :page, :limit
 
   def execute!
     # does something
@@ -130,7 +152,7 @@ end
 You write this:
 ```ruby
 class Rectangle
-  self_init :width, :height
+  attr_accessor_init :width, :height
   selfie :area, :perimeter
 
   def area
@@ -153,13 +175,10 @@ You get this:
 
 ## Next Steps
 
-***self_init:*** 
+***attr_reader_init*** and ***attr_accessor_init:***
 - Implement the possibility to pass defaults;
-- Specify which parameters will get an attr_reader, attr_accessor or none;
-- Specify wich parameters on attr_reader are to consider private;
 
 ***selfie:***
-- Allow the possibility to declare all selfies at the top (if possible);
 - Find a suitable syntax that would allow to 'selfie' an instance method that has arguments;
 
 ***more?:***

data/lib/kernel.rb

@@ -1,8 +1,19 @@
 # Open the Kernel modul to define methods for any class.
 module Kernel
+  extend Gem::Deprecate
+
+  def attr_accessor_init(*variable_names)
+    Selfies.generate_initializer(self, true, *variable_names)
+  end
+
+  def attr_reader_init(*variable_names)
+    Selfies.generate_initializer(self, false, *variable_names)
+  end
+
   def self_init(*variable_names)
-    Selfies.generate_initializer(self, *variable_names)
+    attr_reader_init(*variable_names)
   end
+  deprecate :self_init, :attr_reader_init, 2017, 7
 
   def selfie(*method_names)
     Selfies.generate_class_methods(self, *method_names)

data/lib/selfies/self_init.rb

@@ -1,23 +1,29 @@
 module Selfies
   class SelfInit
-    def self.generate(class_name, *variable_names)
+    def self.generate(class_name, accessor, *variable_names)
       return false unless variable_names.any?
 
-      class_name.class_eval do        
-        attr_reader *variable_names
+      class_name.class_eval do
+        if accessor
+          attr_accessor *variable_names
+        else
+          attr_reader *variable_names
+        end
 
         define_method(:initialize) do |*args|
-          argument_check(variable_names.count, args.count)
+          SelfInit.argument_check(variable_names.count, args.count)
 
           variable_names.each_with_index do |variable, index|
             instance_variable_set("@#{variable}", args[index])
           end
         end
-
-        def argument_check(expected, given)
-          raise ArgumentError, "wrong number of arguments (given #{given}, expected #{expected})" unless given == expected
-        end
       end
     end
+
+    private_class_method
+
+    def self.argument_check(expected, given)
+      raise ArgumentError, "wrong number of arguments (given #{given}, expected #{expected})" unless given == expected
+    end
   end
 end

data/lib/selfies/selfie.rb

@@ -1,4 +1,5 @@
 module Selfies
+  # Generates a class method for any described instance methods.
   class Selfie
     def self.generate(class_name, *method_names)
       class_name.class_eval do

data/lib/selfies/version.rb

@@ -1,3 +1,3 @@
 module Selfies
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/selfies.rb

@@ -5,8 +5,8 @@ require 'selfies/version'
 
 # Index of the Selfies utilities
 module Selfies
-  def self.generate_initializer(class_name, *variable_names)
-    SelfInit.generate(class_name, *variable_names)
+  def self.generate_initializer(class_name, accessor, *variable_names)
+    SelfInit.generate(class_name, accessor, *variable_names)
   end
 
   def self.generate_class_methods(class_name, *method_names)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: selfies
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mario D’Arco
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2017-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler