array_decay 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca265f3e30041bce50dc010403aeb4274305f8dd
+  data.tar.gz: 7c28602e80839d54b226841b463b446afcf9482f
+SHA512:
+  metadata.gz: ed52f5e6d46cec06b6f7f9890b701fc89e656fdf1bfe54676966e29e5b29e8ee10e68a8467f0da02cb0a116a28c932229e3db7f64e935f7546127fbc2047e168
+  data.tar.gz: 5b0b9b1a3d89ba5c3350c8c71e394bf85a61a76169322c81a46db1adf94270a41535b31d4a0a58265953bd0358cc4d03e63e37739658e33eda62a90fbcf6b5b4

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - '2.0.0'
+  - '1.9.3'
+  - '1.9.2'

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 sonnym
+
+MIT License
+
+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,44 @@
+# Array Decay
+
+[![Build Status](https://travis-ci.org/sonnym/array_decay.png?branch=master)](https://travis-ci.org/sonnym/array_decay)
+[![Code Climate](https://codeclimate.com/github/sonnym/array_decay.png)](https://codeclimate.com/github/sonnym/array_decay)
+
+A simple way to prevent increasing memory usage when iterating over objects
+that grow during their method calls, e.g. batch processing ActiveRecord objects
+that require lots of associated data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'array_decay'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install array_decay
+
+## Usage
+
+Simply call the `#decay!` method on your array before enumerating. This
+instantiates and returns an enumerable `ArrayDecay::Enumerator` which
+will unshift elements of the array.
+
+```ruby
+moribund_objects.decay!.each do |item|
+  item.perform_expensive_operation!
+end
+
+moribund_objects.count # 0
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/array_decay'
+  t.test_files = FileList['test/lib/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/array_decay.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'array_decay/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'array_decay'
+  spec.version       = ArrayDecay::VERSION
+  spec.authors       = ['sonnym']
+  spec.email         = ['michaud.sonny@gmail.com']
+  spec.description   = 'Discard array elements during enumeration to free memory.'
+  spec.summary       = spec.description
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  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.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/array_decay.rb

@@ -0,0 +1,25 @@
+require_relative 'array_decay/version'
+
+class Array
+  def decay!
+    ArrayDecay::Enumerator.new(self)
+  end
+end
+
+module ArrayDecay
+  class Enumerator
+    include Enumerable
+
+    attr_accessor :enumerator
+
+    def initialize(enumerator)
+      self.enumerator = enumerator
+    end
+
+    def each(&block)
+      until enumerator.empty?
+        block.call(enumerator.shift)
+      end
+    end
+  end
+end

data/lib/array_decay/version.rb

@@ -0,0 +1,3 @@
+module ArrayDecay
+  VERSION = '1.0.0'
+end

data/test/lib/array_decay_test.rb

@@ -0,0 +1,13 @@
+require_relative '../test_helper'
+
+describe ArrayDecay do
+  it 'should create a new method on Array' do
+    assert_respond_to [], :decay!
+  end
+
+  it 'should cause the array to mutate when iterated over' do
+    original = [:foo, :bar, :baz]
+    original.decay!.map(&:to_s)
+    assert_empty original
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+
+require File.expand_path('../../lib/array_decay.rb', __FILE__)

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: array_decay
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- sonnym
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-12 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Discard array elements during enumeration to free memory.
+email:
+- michaud.sonny@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- array_decay.gemspec
+- lib/array_decay.rb
+- lib/array_decay/version.rb
+- test/lib/array_decay_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '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: Discard array elements during enumeration to free memory.
+test_files:
+- test/lib/array_decay_test.rb
+- test/test_helper.rb