enumerator-traits-kit 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2YyNWIyMmRlYzU1YmVhZDk0YjVlNDljYTdmMmY2ODI4OWYyZDY0Yg==
+  data.tar.gz: !binary |-
+    ZDg2MmNiMGZlODA5Y2FmMGMxY2E2YjJmZTUyYTI4MTNlYjRjZDMyMQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OTNiMmY1NzYzZDI2YjcxYzM5YTRjMzJlYzg1MzZhMjVjMjYzNmJmNWVkNzZm
+    YjRiYTVkM2RjYmNmMGIwMzFhODZlNzA3OWY4MmMwNDM5MzFmMjBlZjk5YWE3
+    OTc3YTI5NzAzZWNjOWJjN2RlNzhmNWFlYjEzZmRjMTJjYzcyZGY=
+  data.tar.gz: !binary |-
+    ZGI3ZDE2MjE5NzE5YWQ5MDY1NjNlNmMxYjg4NGVkMjA1M2Y2Yzk0Njg1NTE5
+    YzllMjI5MmVlMjY4YzAwN2NkNzFjNmQwODM5Mjg1MzA5MjEyNTU4NDUyNDI3
+    YzUwYjcwZjU1YmZiZjBjZjg2NWJlNjUwYTQ4NmVhOTE1N2MyMTc=

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/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in enumerator_traits_kit.gemspec
+gemspec
+
+group :development do
+  gem 'enumerator-comparable'
+  gem 'rake', '>= 10'
+  gem 'rspec', '~> 2.12'
+  gem 'debugger'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bill
+
+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,29 @@
+# EnumeratorTraitsKit
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'enumerator_traits_kit'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enumerator_traits_kit
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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 @@
+require "bundler/gem_tasks"

data/enumerator_traits_kit.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enumerator_traits_kit/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "enumerator-traits-kit"
+  gem.version       = EnumeratorTraitsKit::VERSION
+  gem.authors       = ["Bill"]
+  gem.email         = ["bill.burcham@gmail.com"]
+  gem.description   = %q{a collection of useful Ruby sequence traits and operations}
+  gem.summary       = %q{Leverages a family of monotonic traits to build an intersection operator (&) on sequences}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'enumerator-traits'
+end

data/lib/enumerator_traits_kit.rb

@@ -0,0 +1,4 @@
+require 'enumerator_traits'
+require 'enumerator_traits_kit/version'
+require 'enumerator_traits_kit/monotonic'
+require 'enumerator_traits_kit/initializers'

data/lib/enumerator_traits_kit/initializers.rb

@@ -0,0 +1 @@
+require_relative 'initializers/enumerator'

data/lib/enumerator_traits_kit/initializers/enumerator.rb

@@ -0,0 +1,45 @@
+class Enumerator
+
+  # Returns a sequence that is the intersection of two sequences.
+  # Assumes this sequence (and the other):
+  #  1. both produce comparable and orderable objects
+  #  2. both sequences are monotonically increasing or monotonically decreasing
+  def &(other)
+    # we have to be monotonic and we have to already know our direction
+    # and we have to agree on our direction
+    ensure_trait(EnumeratorTraitsKit::Monotonic)
+    other.ensure_trait(EnumeratorTraitsKit::Monotonic)
+    raise EnumeratorTraitsKit::MonotonicityConflict \
+      if self.direction.nil? || self.direction != other.direction
+    direction = self.direction
+
+    # TODO: make this lazy!
+    Enumerator.new do |yielder|
+      # Look at front of both sequences
+      # allow StopIteration to be raised if either is at end
+      mine   = self.next
+      theirs = other.next
+      loop do
+        case mine <=> theirs
+        when  0
+          yielder << mine
+          mine   = self.next
+          theirs = other.next
+        when -1
+          if direction == EnumeratorTraitsKit::MonotonicIncreasing
+            mine = self.next while mine < theirs
+          else # direction == MonotonicDecreasing
+            theirs = other.next while theirs < mine
+          end
+        when  1
+          if direction == EnumeratorTraitsKit::MonotonicIncreasing
+            theirs = other.next while theirs < mine
+          else # direction == MonotonicDecreasing
+            mine = self.next while mine < theirs
+          end
+        end # case
+      end # loop
+    end.declare_trait(direction) # we have same direction as our inputs
+  end
+
+end

data/lib/enumerator_traits_kit/monotonic.rb

@@ -0,0 +1,95 @@
+# see also Enumerator#declare_trait, ensure_trait
+
+module EnumeratorTraitsKit
+
+  # The intersection operator (&) requires both self and the other sequence
+  # to be monotonically increasing and to agree on the direction: either
+  # both are monotonically increasing, or both are monotonically decreasing.
+  # If they disagree, then intersection will raise this exception.
+  class MonotonicityConflict < Exception;end
+
+
+  module Monotonic
+    def self.ensure_with; EnsureMonotonic; end
+
+    def direction; nil; end
+  end
+
+  module MonotonicIncreasing # < Monotonic
+    include Monotonic
+
+    def self.ensure_with; EnsureMonotonicIncreasing; end
+
+    def direction; MonotonicIncreasing; end
+  end
+
+  module MonotonicDecreasing # < Monotonic
+    include Monotonic
+
+    def self.ensure_with; EnsureMonotonicDecreasing; end
+
+    def direction; MonotonicDecreasing; end
+  end
+
+  class NonMonotonic < Exception;end
+  class NonMonotonicIncreasing < Exception;end
+  class NonMonotonicDecreasing < Exception;end
+
+  # A mixin for an enumerator instance. This enumerator passes through the value stream
+  # from the other enumerator while determining the "direction" of the values
+  # i.e. monotonically increasing (1) or monotonically decreasing (-1) and throws
+  # an exception if the direction changes.
+  # Call like: some_enumerator.extend(Enumerator::Monotonic)
+  module EnsureMonotonic # < Monotonic
+    include Monotonic
+
+    def next
+      super.tap do |val|
+        if defined?(@previous)
+          case val <=> @previous
+          when  1 then new_direction = MonotonicIncreasing
+          # when  0 @direction remains undefined
+          when -1 then new_direction = MonotonicDecreasing
+          end
+          if defined?(@direction) && defined?(new_direction)
+            raise NonMonotonic,
+              "direction changed from #{@direction} to #{new_direction} with value #{val}" \
+              if new_direction != @direction
+          end
+          if defined?(new_direction)
+            @direction = new_direction
+          end
+        end
+        @previous = val
+      end
+    end
+
+    # nil for unknown/undefined, otherwise 1 or -1
+    def direction
+      @direction
+    end
+  end
+
+  module EnsureMonotonicIncreasing
+    include EnsureMonotonic
+
+    def next
+      super.tap do |val|
+        raise NonMonotonicIncreasing, "at value #{val}" \
+          unless direction == MonotonicIncreasing
+      end
+    end
+  end
+
+  module EnsureMonotonicDecreasing
+    include EnsureMonotonic
+
+    def next
+      super.tap do |val|
+        raise NonMonotonicDecreasing, "at value #{val}" \
+          unless direction == MonotonicDecreasing
+      end
+    end
+  end
+
+end

data/lib/enumerator_traits_kit/version.rb

@@ -0,0 +1,3 @@
+module EnumeratorTraitsKit
+  VERSION = "0.0.1"
+end

data/spec/lib/enumerator_traits_kit_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+require 'enumerator_comparable'
+
+describe EnumeratorTraitsKit do
+
+  def seq(s)
+    s.each_char
+  end
+  def seq_up(s)
+    seq(s).declare_trait(EnumeratorTraitsKit::MonotonicIncreasing)
+  end
+
+  describe 'intersection' do
+    describe 'empty inputs' do
+      let(:a){seq_up('')}
+      let(:b){seq_up('')}
+      it 'should produce empty intersection' do
+        (a & b).should == seq_up('')
+      end
+    end
+    describe 'left empty input' do
+      let(:a){seq_up('')}
+      let(:b){seq_up('a')}
+      it 'should produce empty intersection' do
+        (a & b).should == seq_up('')
+      end
+    end
+    describe 'right empty input' do
+      let(:a){seq_up('a')}
+      let(:b){seq_up('')}
+      it 'should produce empty intersection' do
+        (a & b).should == seq_up('')
+      end
+    end
+    describe 'non-empty non-intersecting inputs' do
+      let(:a){seq_up('ab')}
+      let(:b){seq_up('cd')}
+      it 'should produce empty intersection' do
+        (a & b).should == seq_up('')
+      end
+    end
+    describe 'identical single' do
+      let(:a){seq_up('a')}
+      let(:b){seq_up('a')}
+      it 'should produce "a"' do
+        (a & b).should == seq_up('a')
+      end
+    end
+    describe 'identical double' do
+      let(:a){seq_up('ab')}
+      let(:b){seq_up('ab')}
+      it 'should produce "ab"' do
+        (a & b).should == seq_up("ab")
+      end
+    end
+    describe 'intersecting double' do
+      let(:a){seq_up('ab')}
+      let(:b){seq_up('bc')}
+      it 'should produce "b"' do
+        (a & b).should == seq_up('b')
+      end
+    end
+    describe 'intersecting double' do
+      let(:a){seq_up('ab')}
+      let(:b){seq_up('bc')}
+      it 'should produce "b"' do
+        (a & b).should == seq_up('b')
+      end
+    end
+    describe 'repeats' do
+      let(:a){seq_up('abb')}
+      let(:b){seq_up('aab')}
+      it 'should produce "ab"' do
+        (a & b).should == seq_up('ab')
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,44 @@
+require 'ruby-debug'
+
+# require 'simplecov'
+# SimpleCov.start do
+#   add_group "Calendrical", "lib/calendrical"
+# end
+
+$:.unshift(File.join( File.dirname(__FILE__), '../lib'))
+
+# http://anti-pattern.com/bundler-setup-vs-bundler-require
+require 'rubygems'
+require 'bundler/setup'
+
+# when we run via plain old "ruby" command instead of "rspec", this
+# line tells ruby to run the examples
+require 'rspec/autorun'
+
+# This is the present Ruby Gem: the one we are spec-ing/testing
+require 'enumerator_traits_kit'
+
+# Grab all the rspec support files: utility classes, custom matchers etc.
+$LOAD_PATH.unshift(*Dir[File.join( File.dirname(__FILE__), 'support/**')])
+
+require 'spec_helper_methods'
+
+RSpec.configure do |config|
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  config.tty = true
+
+  # Use the specified formatter
+  config.formatter = :progress # :documentation :progress, :html, :textmate
+
+  config.include SpecHelperMethods
+end

data/spec/spec_helper_methods.rb

@@ -0,0 +1,2 @@
+module SpecHelperMethods
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: enumerator-traits-kit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Bill
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: enumerator-traits
+  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'
+description: a collection of useful Ruby sequence traits and operations
+email:
+- bill.burcham@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- enumerator_traits_kit.gemspec
+- lib/enumerator_traits_kit.rb
+- lib/enumerator_traits_kit/initializers.rb
+- lib/enumerator_traits_kit/initializers/enumerator.rb
+- lib/enumerator_traits_kit/monotonic.rb
+- lib/enumerator_traits_kit/version.rb
+- spec/lib/enumerator_traits_kit_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helper_methods.rb
+homepage: ''
+licenses: []
+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: Leverages a family of monotonic traits to build an intersection operator
+  (&) on sequences
+test_files:
+- spec/lib/enumerator_traits_kit_spec.rb
+- spec/spec_helper.rb
+- spec/spec_helper_methods.rb