def_initialize 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da9558b590f6a5b33da3f9871f016f3407be482fc9897da72f2161943d12aebd
-  data.tar.gz: 6bf1414cd27b93b2cdbcb45a813bbe6516f2cce65c28ae5d70a85710e0aa1249
+  metadata.gz: baa0280d5bf1bcf38f202c06e1504b5fdd365977a7ec6695c579349ef0006b65
+  data.tar.gz: 3768cfd27fc19807146acf23403aa07c438398acb41e1bb7bb36ed1113a23150
 SHA512:
-  metadata.gz: dba72131210affed9c9eb65d5e7397295cfcd4eda192c0fb87af25402d1d83016a7ff98caed26aac48a152b8254dfd6b9bf121c2ced1406c56b50c833447fa8f
-  data.tar.gz: 3ef56b6df19bd719dec4d92a2780ea8145c7bb3f3c303bc5685b20121331ef97864f90930d51ee3bb8e3470f8c77096a2fd32b562e5275e5f65d5cd4f5584c0a
+  metadata.gz: fc0fdec0a482a0bf7429f59a97bd280e293da25c544f9570f88fc1bc39545188964ccc055c10ca7b95aaf158647877b5172d8edd38c3cb15f595bbc5082d6e27
+  data.tar.gz: f2f19e386c0809565eaf97d3c75163d0951b551a11ee92ee92c6263728e9dbec041752872289cdca64d5e5a0e6dfc9868977ade3f0a3972615d1064f732dd1e9

data/.travis.yml

@@ -3,5 +3,8 @@ sudo: false
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.3
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
 before_install: gem install bundler -v 2.0.1

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://travis-ci.org/antoshalee/def_initialize.svg?branch=master)](https://travis-ci.org/antoshalee/def_initialize)
+
 # DefInitialize (WIP)
 
 Another approach to reduce initialization boilerplate
@@ -23,26 +25,96 @@ Or install it yourself as:
 
 ```ruby
 class Employee
-  include DefInitialize.with("name, uuid = SecureRandom.uuid, age, position: 'manager'")
+  include DefInitialize.with("name, uuid = SecureRandom.uuid, age:, position: 'manager'")
 end
 
 # is the same as:
 
 class Employee
-  attr_reader :name, :uuid, :age, :position
-
   def initialize(name, uuid = SecureRandom.uuid, age:, position: 'manager')
     @name = name
     @uuid = uuid
     @age = age
     @position = position
   end
+
+  private
+
+  attr_reader :name, :uuid, :age, :position
+end
+```
+
+By convention, parameters starting with underscore symbol `'_'` are ignored:
+
+```ruby
+class Point
+  include DefInitialize.with("x, y, _c")
+end
+
+# transforms to:
+
+class Point
+  def initialize(x, y, _c) # Note that `_c` is still required to pass
+    @x = x
+    @y = y
+  end
+
+  private
+
+  attr_reader :x, :y
 end
 ```
 
+### DSL
+
+Alternatively, you can extend a class with `DefInitialize::DSL` and use `def_initialize` method. Note, how close it looks to the native declaration!
+
+```ruby
+class Base
+  extend DefInitialize::DSL
+end
+
+class Circle < Base
+  def_initialize("radius")
+end
+
+class Rectangle < Base
+  def_initialize("length, width")
+end
+```
+
+### Access control
+
+You can specify level of access for your readers and writers:
+
+```ruby
+class Person < Base
+  def_initialize("name", readers: :public, writers: :private)
+end
+
+# transforms to:
+
+class Person
+  def initialize(name)
+    @name = name
+  end
+  
+  attr_reader :name
+
+  private
+
+  attr_writer :name
+end
+
+```
+Allowed values are `:public`, `:private`, `:protected` and `nil`. If value is `nil`, accessors won't be defined at all.
+
+default value for `readers` is `private`, default value for `writers` is `nil`
+
+
 ### What should I do in more complex cases?
 
-Just write old plain `def initialize`
+Just write plain old `def initialize`.
 
 
 ## Development

data/def_initialize.gemspec

@@ -6,10 +6,10 @@ require 'def_initialize/version'
 Gem::Specification.new do |spec|
   spec.name          = 'def_initialize'
   spec.version       = DefInitialize::VERSION
-  spec.authors       = ['Anton Lee']
-  spec.email         = ['antoshalee@gmail.com']
+  spec.authors       = ['Anton Lee', 'Vladimir Kochnev']
+  spec.email         = ['antoshalee@gmail.com', 'hashtable@yandex.ru']
 
-  spec.summary       = 'Define your initializer along with attribute readers in one line'
+  spec.summary       = 'Define an initializer along with attribute accessors in one line'
   spec.homepage      = 'https://github.com/antoshalee/def_initialize'
   spec.license       = 'MIT'
 

data/lib/def_initialize.rb

@@ -1,51 +1,43 @@
-require "def_initialize/version"
+# frozen_string_literal: true
 
 module DefInitialize
-  # Simply parses input string as a method parameter string
-  # It raises an exception, If it fails
-  # Otherwise returns all argument names including keyword arguments
-  class Parser
-    VAR_RE    = /(\w+)/
-    ARG_RE    = /#{VAR_RE}(?:\s=\s.+?)*/
-    ARGS_RE   = /#{ARG_RE}(?:, #{ARG_RE})*/
-    KWARG_RE  = /#{VAR_RE}:(?:\s.+?)*/
-    KWARGS_RE = /#{KWARG_RE}(?:, #{KWARG_RE})*/
-    RE        = /\A#{ARGS_RE}(?:, #{KWARGS_RE})?\z/
-
-    class << self
-      def parse(str)
-        if(match_data = str.match(RE))
-          match_data.captures
-        else
-          raise ArgumentError, 'Failed to parse arguments'
-        end
-      end
-    end
-  end
+  require 'def_initialize/version'
+  require 'def_initialize/dsl'
+  require 'def_initialize/accessors_builder'
 
   class Mixin < Module
-    def initialize(args_str)
-      args = Parser.parse(args_str)
+    def initialize(args_str, readers: :private, writers: nil)
+      accessors_options = { readers_mode: readers, writers_mode: writers }
+
+      # Create empty method just to inspect its parameters.
+      module_eval <<-CODE, __FILE__, __LINE__ + 1
+        def initialize(#{args_str}); end
+      CODE
 
-      readers = args.map { |a| ":#{a}"}.join(", ")
+      parameters = instance_method(:initialize).parameters
 
-      body = args.reduce(''.dup) do |acc, arg|
-        acc << "@#{arg} = #{arg}\n"
-      end
+      accessors, rows = [], []
+
+      parameters
+        .each do |(_type, name)|
+          next if !name || name.to_s.start_with?('_')
+          accessors << ":#{name}"
+          rows << "@#{name} = #{name}"
+        end
 
       module_eval <<-CODE, __FILE__, __LINE__ + 1
         def initialize(#{args_str})
-          #{body}
+          #{rows.join("\n")}
         end
 
-        attr_reader #{readers}
+        #{AccessorsBuilder.build(accessors, accessors_options)}
       CODE
     end
   end
 
   class << self
-    def with(args_str)
-      Mixin.new(args_str)
+    def with(args_str, **opts)
+      Mixin.new(args_str, **opts)
     end
   end
 end

data/lib/def_initialize/accessors_builder.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module DefInitialize
+  module AccessorsBuilder
+    class << self
+      def build(accessors, readers_mode:, writers_mode:)
+        check_option!(readers_mode)
+        check_option!(writers_mode)
+
+        result = ''.dup
+
+        if readers_mode
+          result << "#{readers_mode}\n"
+          result << "attr_reader #{accessors.join(', ')}\n"
+        end
+
+        if writers_mode
+          result << "#{writers_mode}\n"
+          result << "attr_writer #{accessors.join(', ')}\n"
+        end
+
+        result
+      end
+
+      private
+
+      def check_option!(value)
+        return unless value
+        return if %w[private public protected].include?(value.to_s)
+
+        raise ArgumentError,
+              "Uknown value #{value}. Must be :private, :public, :protected or nil"
+      end
+    end
+  end
+end

data/lib/def_initialize/dsl.rb

@@ -0,0 +1,7 @@
+module DefInitialize
+  module DSL
+    def def_initialize(args_str, **opts)
+      include(DefInitialize.with(args_str, **opts))
+    end
+  end
+end

data/lib/def_initialize/version.rb

@@ -1,3 +1,3 @@
 module DefInitialize
-  VERSION = "0.0.1".freeze
+  VERSION = "0.1.0".freeze
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: def_initialize
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Anton Lee
+- Vladimir Kochnev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2019-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,6 +56,7 @@ dependencies:
 description: 
 email:
 - antoshalee@gmail.com
+- hashtable@yandex.ru
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -71,6 +73,8 @@ files:
 - bin/setup
 - def_initialize.gemspec
 - lib/def_initialize.rb
+- lib/def_initialize/accessors_builder.rb
+- lib/def_initialize/dsl.rb
 - lib/def_initialize/version.rb
 homepage: https://github.com/antoshalee/def_initialize
 licenses:
@@ -94,5 +98,5 @@ requirements: []
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Define your initializer along with attribute readers in one line
+summary: Define an initializer along with attribute accessors in one line
 test_files: []