auto_attr_init 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2aff008f5f68ce853e809db91a3be15f4616dd4e
+  data.tar.gz: c6a56fc95e7089d1e604eb05c084ac2f343f11df
+SHA512:
+  metadata.gz: b4edca0530af404b454a6d7c0f74faecd2556e90ad207a48e7a56ef88ac7a5e3670775581a24675ba93dc8bda490e657ab5e186c93c41e555d8e7551b1865170
+  data.tar.gz: 028c09f6142746b50a9dfc45f995104198220ae4b57fdbb468faf2c4d8d36672c42b4a7ed6b6a93cc7fea4df3b6cdea056d3f5993b060d9c40fa37e7f0b629c2

data/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+end_of_line = lf
+charset = utf-8
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.rb]
+indent_style = space
+indent_size = 2

data/.gitignore

@@ -0,0 +1,20 @@
+.bundle/
+vendor/
+*.swp
+*.swo
+*.gem
+*.rbc
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.markdown

@@ -0,0 +1,49 @@
+<pre>LICENSE: Public Domain
+AUTHOR: ne_Sachirou &lt;utakata.c4se@gmail.com&gt;
+DATE: 2013-09-23</pre>
+
+AutoAttrInit
+============
+
+Dart and CoffeeScript like "automatic field initialization" in Ruby.
+
+Dart has automatic field initialization.
+
+```dart
+class Point {
+  num x, y;
+  Point(this.x, this.y);
+}
+```
+
+CoffeeScript has a same function.
+
+```coffeescript
+class Point
+  constructor: (@x, @y) ->
+```
+
+With this gem, you can do like this.
+
+```ruby
+class Point
+  def initialize x, y; end
+  attr_reader :x, :y
+  auto_attr_init
+end
+```
+
+Or like this.
+
+```ruby
+class Point
+  def initialize ＠x, ＠y; end
+  attr_reader :x, :y
+end
+```
+
+_cf._ [Idiomatic Dart | Dart: Structured web apps](https://www.dartlang.org/articles/idiomatic-dart/#automatic-field-initialization) Dart's "automatic field initialization".
+
+_cf._ [CoffeeScript Classes, Inheritance, and Super](http://jashkenas.github.io/coffee-script/#classes) CoffeeScript has same function.
+
+_cf._ [Dart風のautomatic field initializationをRubyで - c4se記：さっちゃんですよ☆](http://c4se.hatenablog.com/entry/2013/09/23/075129) My blog entry.

data/Rakefile

@@ -0,0 +1,13 @@
+# coding=utf-8
+
+require 'bundler/gem_tasks'
+
+desc 'Run tests and show the results.'
+task :test do
+  require './lib/auto_attr_init.rb'
+  require 'test/unit'
+  require './test/helper.rb'
+  Test::Unit::AutoRunner.run true
+end
+
+task :default

data/auto_attr_init.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'auto_attr_init/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'auto_attr_init'
+  spec.version       = AutoAttrInit::VERSION
+  spec.authors       = ['ne_Sachirou']
+  spec.email         = ['utakata.c4se@gmail.com']
+  spec.description   = %q{Auto attribute initialization.}
+  spec.summary       = %q{Dart and CoffeeScript like "automatic field initialization" in Ruby.}
+  spec.homepage      = 'https://github.com/ne-sachirou/AutoAttrInit.rb'
+  spec.license       = 'Public Domain'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.add_dependency 'aspectr'
+  spec.add_dependency 'sorcerer'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'test-unit'
+end

data/lib/auto_attr_init.rb

@@ -0,0 +1,3 @@
+# coding=utf-8
+
+require "#{__dir__}/auto_attr_init/main.rb"

data/lib/auto_attr_init/assign_params.rb

@@ -0,0 +1,93 @@
+# coding=utf-8
+
+using AutoAttrInit::Refinments
+
+module AutoAttrInit
+  class AssignParams
+    # @param object [Object]
+    def initialize object
+      @object = object
+    end
+
+    # @param args [Array]
+    # @param params [Array] [param type, param name, default value | nil][]
+    # @return [Hash] { param name => value }
+    def assign args, params
+      param_args = {}
+      key_params, params =
+        *params.partition{|param| [:key, :keyrest].include? param[0] }
+      unless key_params.empty?
+        key_args = args.last.is_a?(Hash) ? args.pop : {}
+        param_args = param_args.merge assign_key_params(key_args, key_params)
+      end
+      if params.any?{|param| param[0] == :rest }
+        param_args = param_args.merge assign_rest_params(args, params)
+      else
+        param_args = param_args.merge assign_req_params(args, params)
+      end
+      param_args
+    end
+
+    private
+    # @param args [Array] value[]
+    # @param param [Array] [:req|:opt, param name, default value|nil][]
+    # @return [Hash] { param name => value }
+    def assign_rest_params args, params
+      param_args = {}
+      rest_index = params.find_index{|param| param[0] == :rest }
+      param_args =
+        param_args.merge assign_req_params(
+                           args[0 .. (rest_index - 1)],
+                           params[0 .. (rest_index - 1)])
+      param_args =
+        param_args.merge assign_req_params(
+                           args[(params.length - args.length) .. -1],
+                           params[(rest_index + 1) .. -1])
+      param_args[params[rest_index][1]] =
+        args[rest_index .. (args.length - params.length + 1)]
+      param_args
+    end
+
+    # req paramとopt paramのみ存在すると仮定して、paramsをassignする。
+    # @param args [Array] value[]
+    # @param param [Array] [:req|:opt, param name, default value|nil][]
+    # @return [Hash] { param name => value }
+    def assign_req_params args, params
+      param_args = {}
+      params.each_with_index do |param, i|
+        type, name, value = *param
+        param_args[name] =
+          case type
+          when :req
+            args[i]
+          when :opt
+            args[i] || @object.instance_eval(value)
+          end
+      end
+      param_args
+    end
+
+    # @param key_args [Hash] { param name => value }
+    # @param params [Array] [:key|:keyrest, param name, default value|nil][]
+    # @return [Hash] { param name => value }
+    def assign_key_params key_args, params
+      param_args = {}
+      params.select{|param| param[0] == :key }.
+        each do |param|
+          type, name, value = *param
+          param_args[name] =
+            key_args.has_key?(name) ?
+            key_args[name] :
+            @object.instance_eval(value)
+        end
+      if keyrest_param = params.find{|param| param[0] == :keyrest }
+        keyrest_arg = {}
+        key_args.each do |name, value|
+          keyrest_arg[name] = value unless param_args.has_key?(name)
+        end
+        param_args[keyrest_param[1]] = keyrest_arg
+      end
+      param_args
+    end
+  end
+end

data/lib/auto_attr_init/auto_ai.rb

@@ -0,0 +1,35 @@
+# coding=utf-8
+
+module AutoAttrInit
+  module AutoAi
+    # @params names [String[]]
+    def auto_attr_init *names
+      aspect = AutoAiAspect.new self, names
+      aspect.wrap self, :pre_initialize, nil, :initialize
+    end
+  end
+
+  # RubyistたちのDRY症候群との戦い
+  # http://melborne.github.io/2013/09/27/auto-attr-set-in-ruby/
+  module AutoAiAutoSetter
+    @@auto_attr_init_finished = false
+
+    def new *args, &block
+      unless @@auto_attr_init_finished
+        names = self.instance_method(:initialize).parameters.
+          collect{|param| param[1] }.
+          select{|name| name.to_s =~ /^＠/ }
+        unless names.empty?
+          auto_attr_init *names
+          @@auto_attr_init_finished = true
+        end
+      end
+      super *args, &block
+    end
+  end
+end
+
+class Class
+  include AutoAttrInit::AutoAi
+  prepend AutoAttrInit::AutoAiAutoSetter
+end

data/lib/auto_attr_init/auto_ai_aspect.rb

@@ -0,0 +1,22 @@
+# coding=utf-8
+
+module AutoAttrInit
+  # initialize methodのaspect。
+  # See AutoAttrInit::AutoAi
+  class AutoAiAspect < AspectR::Aspect
+    # @params klass [Class]
+    # @params names [Symbol[]]
+    def initialize klass, names = []
+      @params = DetectParams.new(klass).detect
+      @names = names
+      @names = @params.collect{|param| param[1] } if @names.empty?
+    end
+
+    def pre_initialize method, object, exitstatus, *args
+      param_args = AssignParams.new(object).assign args, @params
+      @names.each{|name|
+        object.instance_variable_set :"@#{name.to_s.sub /^＠/, ''}", param_args[name]
+      }
+    end
+  end
+end

data/lib/auto_attr_init/detect_params.rb

@@ -0,0 +1,58 @@
+# coding=utf-8
+
+using AutoAttrInit::Refinments
+
+module AutoAttrInit
+  # classを静的解析して、initializeのparamsを抽出する。
+  class DetectParams
+    # @param klass [Class]
+    def initialize klass
+      @klass = klass
+    end
+
+    # @return [Array] [param type, param name, default value|nil][]
+    def detect
+      initialize_method = @klass.instance_method :initialize
+      if initialize_method
+        params = initialize_method.parameters
+        params = analyze_opt_params initialize_method, params
+        params = params.select{|param| param[0] != :block }
+      else
+        params = []
+      end
+      params
+    end
+
+    private
+    # opt paramとkey paramのdefault値を解析し、其れを含めたparamsを返却。
+    def analyze_opt_params method, params
+      params_sexp = detect_params_sexp method
+      params_sexp.zip params do |sexp, param|
+        next unless [:opt, :key].include?(param[0])
+        param << sorcerer(sexp)
+      end
+      params
+    end
+
+    # methodの、params部のS式 (SExp) を取得する。
+    def detect_params_sexp method
+      params_sexp =
+        Ripper.sexp_raw(method.source_code).
+        find_deep{|sexp| sexp.has_method?(:[]) && sexp[0] == :params }.
+        select{|sexp| sexp != nil }
+      params_sexp = params_sexp[1..-1].inject [] do |accm, sexp|
+        if sexp[0].is_a? Symbol
+          accm << sexp
+        else
+          accm += sexp
+        end
+        accm
+      end
+    end
+
+    # S式からsource code文字列を復元する。
+    def sorcerer sexp
+      Sorcerer.source sexp[1]
+    end
+  end
+end

data/lib/auto_attr_init/main.rb

@@ -0,0 +1,10 @@
+# coding=utf-8
+
+require 'ripper'
+require 'sorcerer'
+require 'aspectr'
+require "#{__dir__}/refinments.rb"
+require "#{__dir__}/detect_params.rb"
+require "#{__dir__}/assign_params.rb"
+require "#{__dir__}/auto_ai_aspect.rb"
+require "#{__dir__}/auto_ai.rb"

data/lib/auto_attr_init/refinments.rb

@@ -0,0 +1,49 @@
+# coding=utf-8
+
+module AutoAttrInit
+  # Utility refinments for this AutoAttrInit.
+  module Refinments
+    refine Object do
+      # @param name [Stirng]
+      # @return [Boolean]
+      def has_method? name
+        methods.any?{|m| m.to_s == name.to_s }
+      end
+    end
+
+    refine UnboundMethod do
+      # method本体のsource codeを文字列で取得する。
+      # @return [String]
+      def source_code
+        source = ''
+        File.open source_location[0], 'r:utf-8' do |f|
+          lines = f.read.each_line.to_a
+          source = lines[source_location[1] - 1]
+          (source_location[1] .. lines.length - 1).each do |i|
+            break if Ripper.sexp_raw(source, source_location[0], source_location[1])
+            source += lines[i]
+          end
+        end
+        source
+      end
+    end
+
+    refine Array do
+      # Array#detect のdeep search版。
+      # @return [Object|nil]
+      def detect_deep ifnone = ->{ nil }, &p
+        target = nil
+        each do |elm|
+          (target = elm; break) if p.call(elm)
+          next unless elm.has_method?(:find_deep)
+          v = elm.detect_deep ifnone, &p
+          (target = v; break) if v != nil
+          nil
+        end
+        target
+      end
+
+      alias find_deep detect_deep
+    end
+  end
+end

data/lib/auto_attr_init/version.rb

@@ -0,0 +1,5 @@
+# license: Public Domain
+
+module AutoAttrInit
+  VERSION = "0.0.1"
+end

data/test/auto_attr_init/test_auto_ai.rb

@@ -0,0 +1,129 @@
+# coding=utf-8
+
+class TestAutoAttrInit < Test::Unit::TestCase
+  def test_AutoAttrInit_can_set_instance_variables
+    creq = Class.new do
+      attr_reader :a, :b, :c
+      def initialize a, b, c
+      end
+      auto_attr_init :a, :c
+    end
+    c_req = creq.new 4, 5, 6
+    assert_equal 4, c_req.a
+    assert_nil c_req.b
+    assert_equal 6, c_req.c
+
+    creq = Class.new do
+      attr_reader :a, :b
+      def initialize a, b, &p
+      end
+      auto_attr_init
+    end
+    c_req = creq.new(2, 3){|q| q }
+    assert_equal 2, c_req.a
+    assert_equal 3, c_req.b
+  end
+
+  def test_AutoAttrInit_can_work_for_optional_params
+    copt = Class.new do
+      attr_reader :a, :b
+      def initialize a = 2, b = 3
+      end
+      auto_attr_init
+    end
+    c_opt = copt.new 4
+    assert_equal 4, c_opt.a
+    assert_equal 3, c_opt.b
+    c_opt = copt.new
+    assert_equal 2, c_opt.a
+    assert_equal 3, c_opt.b
+  end
+
+  def test_AutoAttrInit_can_work_for_rest_param
+    crest = Class.new do
+      attr_reader :r
+      def initialize *r
+      end
+      auto_attr_init
+    end
+    c_rest = crest.new 2, 3
+    assert_equal [2, 3], c_rest.r
+    c_rest = crest.new
+    assert_equal [], c_rest.r
+
+    crest = Class.new do
+      attr_reader :a, :b, :r
+      def initialize a, *r, b
+      end
+      auto_attr_init
+    end
+    c_rest = crest.new 2, 3, 4, 5
+    assert_equal 2, c_rest.a
+    assert_equal [3, 4], c_rest.r
+    assert_equal 5, c_rest.b
+  end
+
+  def test_AutoAttrInit_can_work_for_hash_param
+    chash = Class.new do
+      attr_reader :h
+      def initialize h = {}
+      end
+      auto_attr_init
+    end
+    c_hash = chash.new p1: 'p1', p2: 'p2'
+    assert_equal({ p1: 'p1', p2: 'p2' }, c_hash.h)
+  end
+
+  def test_AutoAttrInit_can_work_on_keyword_params
+    ckey = Class.new do
+      attr_reader :p1, :p2
+      def initialize *, p1: 'p1d', p2: 'p2d'
+      end
+      auto_attr_init
+    end
+    c_key = ckey.new p1: 'p1', p2: 'p2'
+    assert_equal 'p1', c_key.p1
+    assert_equal 'p2', c_key.p2
+    c_key = ckey.new p2: 'p2'
+    assert_equal 'p1d', c_key.p1
+    assert_equal 'p2', c_key.p2
+
+    ckey = Class.new do
+      attr_reader :p1, :p2
+      def initialize *, p1: 'p1d', p2: 'p2d', **opt
+      end
+      auto_attr_init
+      def method_missing name, *args, &p
+        @opt[name]
+      end
+    end
+    c_key = ckey.new p1: 'p1', p3: 'p3'
+    assert_equal 'p1', c_key.p1
+    assert_equal 'p2d', c_key.p2
+    assert_equal 'p3', c_key.p3
+  end
+
+  def test_AutoAttrInit_can_work_on_keyword_params_with_opt_params
+    ckeyopt = Class.new do
+      attr_reader :a, :p1
+      def initialize a = 3, p1: 'p1d'
+      end
+      auto_attr_init
+    end
+    c_keyopt = ckeyopt.new
+    assert_equal 3, c_keyopt.a
+    assert_equal 'p1d', c_keyopt.p1
+  end
+
+  # https://github.com/ne-sachirou/AutoAttrInit.rb/issues/3
+  def test_AutoAttrInit_by_atmark_prefix
+    cat = Class.new do
+      attr_reader :a, :b, :c
+      def initialize ＠a, b, ＠c = 9; end
+    end
+    c_at = cat.new 2, 3
+    assert_equal 2, c_at.a
+    assert_nil c_at.b
+    assert_equal 9, c_at.c
+  end
+end

data/test/auto_attr_init/test_refinments.rb

@@ -0,0 +1,10 @@
+# coding=utf-8
+
+using AutoAttrInit::Refinments
+
+class TestArray < Test::Unit::TestCase
+  def test_find_deep
+    assert_equal 4, [2, 3, [4]].find_deep{|e| e == 4 }
+    assert_nil [2, 3, [4]].find_deep{|e| e == 5 }
+  end
+end

data/test/helper.rb

@@ -0,0 +1 @@
+# coding=utf-8

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: auto_attr_init
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ne_Sachirou
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aspectr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sorcerer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Auto attribute initialization.
+email:
+- utakata.c4se@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .editorconfig
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- auto_attr_init.gemspec
+- lib/auto_attr_init.rb
+- lib/auto_attr_init/assign_params.rb
+- lib/auto_attr_init/auto_ai.rb
+- lib/auto_attr_init/auto_ai_aspect.rb
+- lib/auto_attr_init/detect_params.rb
+- lib/auto_attr_init/main.rb
+- lib/auto_attr_init/refinments.rb
+- lib/auto_attr_init/version.rb
+- test/auto_attr_init/test_auto_ai.rb
+- test/auto_attr_init/test_refinments.rb
+- test/helper.rb
+homepage: https://github.com/ne-sachirou/AutoAttrInit.rb
+licenses:
+- Public Domain
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Dart and CoffeeScript like "automatic field initialization" in Ruby.
+test_files:
+- test/auto_attr_init/test_auto_ai.rb
+- test/auto_attr_init/test_refinments.rb
+- test/helper.rb