no_sltd 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d65fa0f57aa1ac91c26b613bca068bd6cc4e2154
+  data.tar.gz: 12deadde6d42302b9ead771df100fd279ac31d77
+SHA512:
+  metadata.gz: f08747e36f3f3b1cacc2bdae42c64b10a6b72ccae9ab7c5cfd405ef57f18cdc24599a649b28279b60bef52172560ae90210e53eb9db80a23de667543ce67859d
+  data.tar.gz: 52b7f4af1e8cb7626d82c194cbeacc1a51732625113161111eff16f876e16b313b9315d7670bac641a8defe5d937b0b1d9e7abbf288686291c5ab3e54febef71

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+  - 2.4.0
+before_install: gem install bundler -v 1.13.7

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 tompng
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,110 @@
+# No Stack Level Too Deep
+
+[![Build Status](https://travis-ci.org/tompng/no_sltd.svg?branch=master)](https://travis-ci.org/tompng/no_sltd)
+
+Simple way to avoid `stack level too deep`
+
+## Installation
+
+```ruby
+# Gemfile
+gem 'no_sltd'
+```
+
+```sh
+$ gem install no_sltd
+```
+
+## Usage
+
+```ruby
+def my_recursive_func
+  ...
+end
+
+# ↓ just add `no_sltd` before `def`
+
+require 'no_sltd'
+no_sltd def my_recursive_func
+  ...
+end
+```
+
+or
+
+```ruby
+def my_recursive_func
+  ...
+  my_recursive_func
+  ...
+end
+
+# ↓ wrap the recursive function call with `no_sltd { }`
+
+require 'no_sltd'
+def my_recursive_func
+  ...
+  no_sltd { my_recursive_func }
+  ...
+end
+```
+
+### examples
+
+```ruby
+def sum_up n
+  return 1 if n == 1
+  sum_up(n-1) + n
+end
+sum_up 100000 #=> stack level too deep
+
+# ↓↓↓↓
+
+no_sltd def sum_up n
+  return 1 if n == 1
+  sum_up(n-1) + n
+end
+sum_up 100000 #=> 5000050000
+```
+
+```ruby
+def fibonacci a, memo={0 => 0, 1 => 1}
+  return memo[a] if memo[a]
+  memo[a] = fibonacci(a-1, memo) + fibonacci(a-2, memo)
+end
+fibonacci 100000 #=> stack level too deep
+
+# ↓↓↓↓
+
+no_sltd def fibonacci a, memo={0 => 0, 1 => 1}
+  return memo[a] if memo[a]
+  memo[a] = fibonacci(a-1, memo) + fibonacci(a-2, memo)
+end
+fibonacci 100000 #=> 2597406934722172......
+```
+
+```ruby
+fact = lambda do |n|
+  n.zero? ? 1 : n * fact.call(n-1)
+end
+fact.call 10000 #=> stack level too deep
+
+# pass the proc to `no_sltd`
+fact = no_sltd ->(n) {
+  n.zero? ? 1 : n * fact.call(n-1)
+}
+fact.call 10000 #=> 2846259680917054......
+
+# or wrap the recursive call with `no_sltd { }`
+fact = lambda do |n|
+  n.zero? ? 1 : n * no_sltd { fact.call(n-1) }
+end
+fact.call 10000 #=> 2846259680917054......
+```
+
+### Pros
+- simple & easy
+
+### Cons
+- memory eater
+- slow

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "no_sltd"
+
+# 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
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/no_sltd/version.rb

@@ -0,0 +1,3 @@
+module NoSLTD
+  VERSION = "0.1.0"
+end

data/lib/no_sltd.rb

@@ -0,0 +1,81 @@
+require "no_sltd/version"
+
+module NoSLTD
+  CONTINUE = Object.new
+  THREAD_LOCAL_KEY = :no_sltd_runner
+
+  class Runner
+    attr_reader :result
+    def initialize
+      @fibers = []
+      @stack_level = 0
+    end
+
+    def << fiber
+      @fibers << fiber
+    end
+
+    def start &block
+      self << Fiber.new { block.call }
+      until @fibers.empty? do
+        f = @fibers.last
+        next unless f
+        res = f.resume
+        if res != CONTINUE
+          @result = res
+          @fibers.pop
+        end
+      end
+      @result
+    end
+
+    def direct_callable?
+      if @stack_level < 64
+        @stack_level += 1
+        true
+      else
+        @stack_level = 0
+        false
+      end
+    end
+
+    def self.execute &block
+      runner = Runner.new
+      Thread.current.thread_variable_set(THREAD_LOCAL_KEY, runner)
+      runner.start(&block)
+    ensure
+      Thread.current.thread_variable_set(THREAD_LOCAL_KEY, nil)
+    end
+
+    def self.current
+      Thread.current.thread_variable_get(THREAD_LOCAL_KEY)
+    end
+  end
+
+  def self.recursive &block
+    runner = Runner.current
+    return Runner.execute(&block) unless runner
+    return yield if runner.direct_callable?
+    runner << Fiber.new(&block)
+    Fiber.yield CONTINUE
+    runner.result
+  end
+end
+
+def no_sltd method_or_proc=nil, &block
+  raise '`no_sltd def func end`, `block = no_sltd -> {}` or `no_sltd { block.call }`' unless block_given? ^ !!method_or_proc
+  if block_given?
+    NoSLTD.recursive(&block)
+  elsif Proc === method_or_proc
+    lambda do |*a, &b|
+      NoSLTD.recursive { method_or_proc.call(*a, &b) }
+    end
+  else
+    receiver = respond_to?(:instance_method) ? self : self.class
+    original = receiver.instance_method method_or_proc
+    receiver.send :remove_method, method_or_proc
+    receiver.send :define_method, method_or_proc do |*a, &b|
+      NoSLTD.recursive { original.bind(self).call(*a, &b) }
+    end
+  end
+end

data/no_sltd.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'no_sltd/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "no_sltd"
+  spec.version       = NoSLTD::VERSION
+  spec.authors       = ["tompng"]
+  spec.email         = ["tomoyapenguin@gmail.com"]
+
+  spec.summary       = %q{Simple way to avoid stack level too deep}
+  spec.description   = %q{Provides a simple way to avoid stack level too deep for recursive functions}
+  spec.homepage      = "https://github.com/tompng/no_sltd"
+  spec.license       = "MIT"
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: no_sltd
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tompng
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Provides a simple way to avoid stack level too deep for recursive functions
+email:
+- tomoyapenguin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/no_sltd.rb
+- lib/no_sltd/version.rb
+- no_sltd.gemspec
+homepage: https://github.com/tompng/no_sltd
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Simple way to avoid stack level too deep
+test_files: []