reference.rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 575fb0531323489e5058f79f595cb839126afe92
+  data.tar.gz: 77d6d8827153866de510069deba9c67a60b9c8ed
+SHA512:
+  metadata.gz: 65bc14a7a2faf5d2bee36d6fb355e4b09ea8a5f38398061efec8e455a6fcbb64795b3cfeaad7559ec2a51f43d6b6dc6ab15f83fc1a0cdbf88ef0219a9ec1d99b
+  data.tar.gz: dee886219161facdda8475b6ee2c549f40684269d465ac9519f55897ce649cb1e3bb18002098f79f02bfad46b6e70e739bd49b62750eecb3f90d37a98be02065

data/.gitignore

@@ -0,0 +1,35 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 2.2.0
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - 1.8.7

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    reference.rb (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.6.1)
+    diff-lcs (1.2.1)
+    multi_json (1.7.2)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  awesome_print
+  rake
+  reference.rb!
+  rspec
+  simplecov
+
+BUNDLED WITH
+   1.10.5

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Keith Kim
+
+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,4 @@
+# reference.rb
+## A value holder. Like pointers in other languages, or a mutable Optional.
+
+[![Build Status](https://travis-ci.org/karmakaze/reference.rb.png?branch=master)](https://travis-ci.org/karmakaze/reference.rb)

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => :spec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new

data/lib/reference.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+
+class Reference
+  Error = Class.new(RuntimeError)
+
+  attr_reader :state, :value, :reason
+
+  def initialize
+    @state = :pending
+    @on_fulfill_callbacks = []
+    @on_reject_callbacks = []
+    @backtrace
+  end
+
+  def pending?
+    @state.equal?(:pending)
+  end
+
+  def fulfilled?
+    @state.equal?(:fulfilled)
+  end
+
+  def rejected?
+    @state.equal?(:rejected)
+  end
+
+  def on_fulfill(&callback)
+    @on_fulfill_callbacks << callback
+    if fulfilled?
+      run_fulfill_callback(callback)
+    end
+  end
+
+  def on_reject(&callback)
+    @on_reject_callbacks << callback
+    if rejected?
+      run_reject_callback(callback)
+    end
+  end
+
+  def fulfill(value = nil, backtrace = nil)
+    return unless pending?
+
+    @state = :fulfilled
+    @value = value
+    @backtrace = backtrace
+
+    run_fulfill_callbacks
+    value
+  end
+
+  def reject(reason = nil, backtrace = nil)
+    return unless pending?
+
+    @state = :rejected
+    @reason = reason || Error
+    @backtrace = backtrace
+
+    run_reject_callbacks
+    reason
+  end
+
+  private
+
+  def run_fulfill_callbacks
+    @on_fulfill_callbacks.each { |callback| run_fulfill_callback(callback) }
+  end
+
+  def run_reject_callbacks
+    @on_reject_callbacks.each { |callback| run_reject_callback(callback) }
+  end
+
+  def run_fulfill_callback(callback)
+    callback.call(@value)
+  end
+
+  def run_reject_callback(callback)
+    callback.call(@reason)
+  end
+end

data/reference.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'reference.rb'
+  spec.version       = '0.1.0'
+  spec.date          = '2015-09-13'
+  spec.summary       = "A value holder. Like pointers in other languages, or a mutable Optional."
+  spec.description   = "A value holder. Like pointers in other languages, or a mutable Optional."
+  spec.authors       = ["Keith Kim"]
+  spec.email         = ['keith.karmakaze@gmail.com']
+  spec.files         = `git ls-files`.split($\)
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.homepage      = 'http://github.com/karmakaze/reference.rb'
+  spec.license       = 'MIT'
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "awesome_print"
+end

data/spec/reference_spec.rb

@@ -0,0 +1,141 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Reference do
+  subject { Reference.new }
+
+  let(:value) { double('value') }
+  let(:other_value) { double('other_value') }
+
+  let(:backtrace) { caller }
+  let(:reason) do
+    StandardError.new('reason').tap { |ex| ex.set_backtrace(backtrace) }
+  end
+  let(:other_reason) do
+    StandardError.new('other_reason').tap { |ex| ex.set_backtrace(backtrace) }
+  end
+
+  describe '3.1.1 pending' do
+    it 'transitions to fulfilled' do
+      subject.fulfill(value)
+      expect(subject).to be_fulfilled
+    end
+
+    it 'transitions to rejected' do
+      subject.reject(reason)
+      expect(subject).to be_rejected
+    end
+  end
+
+  describe '3.1.2 fulfilled' do
+    it 'does not transition to other states' do
+      subject.fulfill(value)
+      subject.reject(reason)
+      expect(subject).to be_fulfilled
+    end
+
+    it 'has a value' do
+      subject.fulfill(value)
+      expect(subject.value).to eq(value)
+
+      subject.fulfill(other_value)
+      expect(subject.value).to eq(value)
+    end
+  end
+
+  describe '3.1.3 rejected' do
+    it 'does not transition to other states' do
+      subject.reject(reason)
+      subject.fulfill(value)
+      expect(subject).to be_rejected
+    end
+
+    it 'has a reason' do
+      subject.reject(reason)
+      expect(subject.reason).to eq(reason)
+
+      subject.reject(other_reason)
+      expect(subject.reason).to eq(reason)
+    end
+  end
+
+  describe '3.2.5' do
+    it 'calls multiple on_fulfill callbacks in order of definition' do
+      order = []
+
+      subject.on_fulfill do |val|
+        order << 1
+        expect(val).to eq(value)
+      end
+
+      subject.on_fulfill do |val|
+        order << 2
+        expect(val).to eq(value)
+      end
+
+      subject.fulfill(value)
+
+      subject.on_fulfill do |val|
+        order << 3
+        expect(val).to eq(value)
+      end
+
+      expect(order).to eq([1, 2, 3])
+    end
+
+    it 'calls multiple on_reject callbacks in order of definition' do
+      order = []
+      on_reject = lambda do |i|
+        order << i
+
+        return lambda do |reas|
+                 expect(reas).to eq(reason)
+               end
+      end
+
+      subject.on_reject do |reas|
+        order << 1
+        expect(reas).to eq(reason)
+      end
+
+      subject.on_reject do |reas|
+        order << 2
+        expect(reas).to eq(reason)
+      end
+
+      subject.reject(reason)
+
+      subject.on_reject do |reas|
+        order << 3
+        expect(reas).to eq(reason)
+      end
+
+      expect(order).to eq([1, 2, 3])
+    end
+  end
+
+  describe 'extras' do
+    describe '#fulfill' do
+      it 'does not return anything' do
+        expect(subject.fulfill(nil)).to eq(nil)
+      end
+
+      it 'does not require a value' do
+        subject.fulfill
+        expect(subject.value).to be(nil)
+      end
+    end
+
+    describe '#reject' do
+      it 'does not return anything' do
+        expect(subject.reject(nil)).to eq(nil)
+      end
+
+      it 'does not require a reason' do
+        subject.reject
+        expect(subject.reason).to be(Reference::Error)
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec:unit'
+
+    add_filter 'config'
+    add_filter 'spec'
+  end
+end
+
+require 'reference'
+
+require 'awesome_print'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: reference.rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Keith Kim
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-13 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  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: simplecov
+  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: awesome_print
+  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: A value holder. Like pointers in other languages, or a mutable Optional.
+email:
+- keith.karmakaze@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/reference.rb
+- reference.gemspec
+- spec/reference_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/karmakaze/reference.rb
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A value holder. Like pointers in other languages, or a mutable Optional.
+test_files:
+- spec/reference_spec.rb
+- spec/spec_helper.rb
+has_rdoc: