restricted_set 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e44fdc70b454bc1e49389fb77ec533615f656274
+  data.tar.gz: fdb4d797e39d26a108a5702ea7c8f5793b3c6c16
+SHA512:
+  metadata.gz: ec90d032291087b4199e2f516f1e71324a13cea604a439bc163d905442c04f2c7c3b1d5e707de863f0d12fef3f04fdbee5a1e5a81b2a5318a951f746e88e6fe0
+  data.tar.gz: 4981211757d0cd5232de1a28a395ccaa94f571a4b8cc0abdce042ba6531ff3c3ae3e35ed64c48d0a2c95f126222e529a7177f458495263c149d043f5e369add6

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/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - jruby-19mode
+  - rbx-2.1.1
+  - ruby-head
+  - jruby-head

data/BSDL

@@ -0,0 +1,22 @@
+Copyright (C) 1993-2013 Yukihiro Matsumoto. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGE.

data/COPYING

@@ -0,0 +1,56 @@
+Ruby is copyrighted free software by Yukihiro Matsumoto <matz@netlab.jp>.
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+	  modifications to Usenet or an equivalent medium, or by allowing
+	  the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+	  together with instructions (in the manual page or equivalent)
+	  on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+	  the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as 
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them, 
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/Gemfile

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

data/README.md

@@ -0,0 +1,79 @@
+# RestrictedSet [![Build Status](https://travis-ci.org/invisiblefunnel/restricted_set.png?branch=master)](https://travis-ci.org/invisiblefunnel/restricted_set)
+
+> RestricedSet implements a set with restrictions defined by a given block. If the block's arity is 2, it is called with the RestrictedSet itself and an object to see if the object is allowed to be put in the set. Otherwise, the block is called with an object to see if the object is allowed to be put in the set.
+
+> Credit: [lib/set.rb][ruby-restricted-set]
+
+This project is inspired by a data structure described in the Ruby codebase. The interface matches the described class and the implementation is complete, tested and avoids dynamically defining methods on each instance.
+
+**Compatible with Ruby 1.9+**
+
+The source is released under the same terms as [Ruby][ruby-license].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'restricted_set'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+Or install it yourself as:
+
+```console
+$ gem install restricted_set
+```
+
+## Usage
+
+```ruby
+set = RestrictedSet.new(-2..2) { |o| o > 0 }
+set.add(-1)
+set.add(42)
+set #=> #<RestrictedSet: {1, 2, 42}>
+```
+
+```ruby
+set = RestrictedSet.new { |o| Symbol === o }
+set.add("Hello!")
+set.add(:name)
+set.add(99)
+set.add(:location)
+set #=> #<RestrictedSet: {:name, :location}>
+```
+
+```ruby
+set = RestrictedSet.new do |current_set, _|
+  current_set.count + 1 <= 2 # Maximum of 2 objects
+end
+set << :a << :b << :c
+set #=> #<RestrictedSet: {:a, :b}>
+```
+
+```ruby
+require 'prime'
+class PrimeSet < RestrictedSet
+  def initialize(enum = nil)
+    super enum, &Prime.method(:prime?)
+  end
+end
+
+(1..100).to_set(PrimeSet) #=> #<PrimeSet: {2, 3, 5, 7, 11, 13, 17, 19, ...}>
+```
+
+## 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
+
+[ruby-restricted-set]: https://github.com/ruby/ruby/blob/v2_0_0_247/lib/set.rb#L640-L665
+[ruby-license]: https://www.ruby-lang.org/en/about/license.txt

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task default: :test
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end

data/lib/restricted_set.rb

@@ -0,0 +1,50 @@
+# The following copyright notice is included because parts of this
+# library are modified from code in Ruby's codebase.
+
+# Copyright (c) 2002-2013 Akinori MUSHA <knu@iDaemons.org>
+#
+# Documentation by Akinori MUSHA and Gavin Sinclair.
+#
+# All rights reserved.  You can redistribute and/or modify it under the same
+# terms as Ruby.
+
+require "set"
+
+class RestrictedSet < Set
+  def initialize(enum = nil, &block)
+    raise ArgumentError, "must provide a block" unless block_given?
+
+    @proc = if block.arity == 2
+              block.curry[self]
+            else
+              block
+            end
+
+    # Pass the identity proc to super to prevent
+    # passing the given block argument through
+    super(enum) { |o| o }
+  end
+
+  def add(o)
+    if @proc.call(o)
+      @hash[o] = true
+    end
+    self
+  end
+  alias << add
+
+  def add?(o)
+    if include?(o) || !@proc.call(o)
+      nil
+    else
+      @hash[o] = true
+      self
+    end
+  end
+
+  def restriction_proc
+    @proc
+  end
+
+  VERSION = "1.0.0"
+end

data/restricted_set.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "restricted_set"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Danny Whalen"]
+  spec.email         = ["daniel.r.whalen@gmail.com"]
+  spec.description   = %q{RestricedSet implements a set with restrictions defined by a given block.}
+  spec.summary       = <<-SUMMARY.gsub(/\n/, ' ').strip
+RestricedSet implements a set with restrictions defined by a given block.
+If the block's arity is 2, it is called with the RestrictedSet itself and
+an object to see if the object is allowed to be put in the set. Otherwise,
+the block is called with an object to see if the object is allowed to be
+put in the set.
+  SUMMARY
+  spec.homepage      = "https://github.com/invisiblefunnel/restricted_set"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^test/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/test/restricted_set_test.rb

@@ -0,0 +1,98 @@
+require File.expand_path("../../lib/restricted_set", __FILE__)
+require "minitest/autorun"
+
+class RestrictedSetTest < Minitest::Test
+  def setup
+    @enum = [-2, 3, -1, 1, -3, 2, 0]
+    @arity_1_proc = Proc.new { |o| o > 0 }
+    @arity_2_proc = Proc.new { |rs, o| rs.empty? ? true : o > rs.max }
+  end
+
+  def test_superclass
+    assert RestrictedSet < Set
+  end
+
+  def test_new
+    assert_raises(ArgumentError) { RestrictedSet.new }
+    assert_raises(ArgumentError) { RestrictedSet.new(@enum) }
+
+    s = RestrictedSet.new(@enum, &@arity_1_proc)
+    assert_equal [1,2,3], s.sort
+
+    s = RestrictedSet.new(@enum, &@arity_2_proc)
+    assert_equal [-2,3], s.sort
+  end
+
+  def test_add
+    s = RestrictedSet.new(&@arity_1_proc)
+    s.add(-1)
+    assert s.empty?
+
+    s = RestrictedSet.new(@enum, &@arity_2_proc)
+    s.add(4)
+    assert_equal [-2,3,4], s.sort
+
+    s = RestrictedSet.new(@enum, &@arity_1_proc)
+    assert_equal s, s.add(42)
+    assert_equal [1,2,3,42], s.sort
+
+    s = RestrictedSet.new(@enum, &@arity_2_proc)
+    assert_equal s, s.add(42)
+    assert_equal [-2,3,42], s.sort
+  end
+
+  def test_shovel
+    s = RestrictedSet.new(&@arity_1_proc)
+    s << 2 << 1 << -1
+    assert_equal [1, 2], s.sort
+  end
+
+  def test_add?
+    s = RestrictedSet.new(@enum, &@arity_1_proc)
+    assert_equal nil, s.add?(1)
+    assert_equal s, s.add?(42)
+    assert_equal [1,2,3,42], s.sort
+
+    s = RestrictedSet.new(@enum, &@arity_2_proc)
+    assert_equal nil, s.add?(1)
+    assert_equal s, s.add?(42)
+    assert_equal [-2,3,42], s.sort
+  end
+
+  def test_replace
+    other = [4,6,-4,5,3,-1]
+
+    s = RestrictedSet.new(@enum, &@arity_1_proc)
+    assert_equal [1,2,3], s.sort
+    s.replace(other)
+    assert_equal [3,4,5,6], s.sort
+
+    s = RestrictedSet.new(@enum, &@arity_2_proc)
+    assert_equal [-2,3], s.sort
+    s.replace(other)
+    assert_equal [4,6], s.sort
+  end
+
+  def test_merge
+    other = [4,6,-4,5,3,-1]
+
+    s = RestrictedSet.new(@enum, &@arity_1_proc)
+    assert_equal [1,2,3], s.sort
+    s.merge(other)
+    assert_equal [1,2,3,4,5,6], s.sort
+
+    s = RestrictedSet.new(@enum, &@arity_2_proc)
+    assert_equal [-2,3], s.sort
+    s.merge(other)
+    assert_equal [-2,3,4,6], s.sort
+  end
+
+  def test_restriction_proc
+    s = RestrictedSet.new(&@arity_1_proc)
+    f = s.restriction_proc
+
+    assert_instance_of Proc, f
+    assert f.call(1)
+    refute f.call(0)
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: restricted_set
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Danny Whalen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-20 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: 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: RestricedSet implements a set with restrictions defined by a given block.
+email:
+- daniel.r.whalen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- BSDL
+- COPYING
+- Gemfile
+- README.md
+- Rakefile
+- lib/restricted_set.rb
+- restricted_set.gemspec
+- test/restricted_set_test.rb
+homepage: https://github.com/invisiblefunnel/restricted_set
+licenses:
+- BSD
+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.14
+signing_key: 
+specification_version: 4
+summary: RestricedSet implements a set with restrictions defined by a given block.
+  If the block's arity is 2, it is called with the RestrictedSet itself and an object
+  to see if the object is allowed to be put in the set. Otherwise, the block is called
+  with an object to see if the object is allowed to be put in the set.
+test_files:
+- test/restricted_set_test.rb
+has_rdoc: