motion-set 0.1.0

data/README.md

@@ -0,0 +1,90 @@
+# Implementation of Ruby `set` module
+
+This gems implements `Set` class from `set` standard library
+of Ruby 1.9.3. See [Ruby 1.9.3 `Set` API documentation](
+http://ruby-doc.org/stdlib-1.9.3/libdoc/set/rdoc/Set.html#method-i-flatten-21)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'motion-set'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install motion-set
+
+## Implementation details
+
+### No `require`
+
+RubyMotion does not support `require`. Instead, when you
+install this gem, `Set` class will be globally available.
+
+### `Set` is `NSMutableSet`
+
+`Set` is implemented as an alias to `NSMutableSet`, which
+it turn is extended to accomodate all Ruby set methods.
+This is similar to how other RubyMotion data types
+(like `Array`) are implemented.
+
+Advantages of this approach are:
+
+1. Interoperability with native APIs:
+   * You can pass `Set` objects to APIs expecting `NSSet`
+     or `NSMutableSet`.
+   * Whenever a native API returns an `NSMutableSet` you
+     can treat it as Ruby set.
+2. There's no performance penalty, because there is no
+   unnecessary indirection.
+
+However, there are some things you need to note:
+
+### No `nil` in sets
+
+`NSMutableSet` does not support adding `nil` object,
+which applies to your Ruby sets.
+
+This could fail in subtle ways, for example if you try
+to call `#map!` with a block which returns `nil`.
+
+> This could have been avoided if the implementation
+> checked when `nil` is added, and instead stored a
+> private singelton sentinel fake nil object, which would
+> be converted back to `nil` when necessary. However,
+> this would create a challenge for interoperability
+> with native APIs: what should this object represent
+> in Objective-C world?
+>
+> If you have opinion on this, you are welcom to
+> [comment on this issue](
+> https://github.com/robocat/motion-set/issues/1).
+
+### No `#divide` method
+
+[`#divide`](
+http://ruby-doc.org/stdlib-1.9.3/libdoc/set/rdoc/Set.html#method-i-divide)
+method is not implemented. You are welcome to contribute.
+
+### No `SortedSet`
+
+[`SortedSet`](
+http://ruby-doc.org/stdlib-1.9.3/libdoc/set/rdoc/SortedSet.html)
+is not implemented. You are welcome to contribute.
+
+### No Android support
+
+There is no Android support, but you are welcome to
+contribute.
+
+## 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/lib/motion-set.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+
+unless defined?(Motion::Project::Config)
+  raise "This file must be required within a RubyMotion project Rakefile."
+end
+
+lib_dir_path = File.dirname(File.expand_path(__FILE__))
+Motion::Project::App.setup do |app|
+  app.files.unshift(Dir.glob(File.join(lib_dir_path, "project/**/*.rb")))
+end

data/lib/project/motion-set.rb

@@ -0,0 +1,173 @@
+Set = NSMutableSet
+
+class NSMutableSet
+  include Enumerable
+
+  def self.new(enum=nil)
+    if enum
+      enum.to_set
+    else
+      alloc.init
+    end
+  end
+
+  def self.[](*ary)
+    new.tap { |set| ary.each { |item| set.add item } }
+  end
+
+  def inspect
+    "#<Set: {#{self.to_a.join ', '}}>"
+  end
+
+  def intersection(enum); send_to_copy(:'intersectSet', enum) end
+  alias_method :&, :intersection
+
+  def union(enum); send_to_copy(:'unionSet:', enum) end
+  alias_method :|, :union
+  alias_method :+, :union
+
+  def difference(enum); send_to_copy(:'minusSet:', enum) end
+  alias_method :-, :difference
+
+  # Why can't you just: alias_method :add, :'addObject:'
+  def add(o); addObject o end
+  alias_method :<<, :add
+
+  def ^(enum)
+    ((self | enum) - (self & enum))
+  end
+
+  def add?(o)
+    (include? o) ? nil : (add o)
+  end
+
+  def classify(&block)
+    return to_enum(__method__) unless block_given?
+    reduce({}) do |hash, item|
+      classifier = block.call item
+      hash[classifier] ||= Set[]
+      hash[classifier].add item
+      hash
+    end
+  end
+
+  alias_method :clear, :removeAllObjects
+
+  def collect!(&block)
+    return to_enum(__method__) unless block_given?
+    replace collect(&block)
+  end
+  alias_method :map!, :collect!
+
+  # Why can't you just: alias_method :delete, :'removeObject:'
+  def delete(o); removeObject o end
+
+  def delete?(o)
+    (include? o) ? (delete o) : nil
+  end
+
+  def keep_if(&block)
+    return to_enum(__method__) unless block_given?
+    each { |item| delete item unless block.call item }
+    self
+  end
+
+  def delete_if(&block)
+    return to_enum(__method__) unless block_given?
+    each { |item| delete item if block.call item }
+    self
+  end
+
+  # Why can't you just: alias_method :length, :count
+  def length; count end
+  alias_method :size, :length
+
+  def empty?; count == 0 end
+
+  def flatten
+    self.to_enum(:flat_each).to_set
+  end
+
+  def flatten!
+    copy = self.to_set
+    # Not sure why self.to_enum does not work in this case:
+    replace copy.to_enum :flat_each
+    (copy == self) ? nil : self
+  end
+
+  alias_method :include?, :containsObject
+  alias_method :member?, :containsObject
+
+  def merge(enum)
+    enum.each { |item| add item }
+    self
+  end
+
+  def replace(enum)
+    clear
+    merge(enum)
+  end
+
+  def subtract(enum)
+    enum.each { |item| delete item }
+    self
+  end
+
+  def subset?(set)
+    enforce_set(set) && isSubsetOfSet(set)
+  end
+
+  def superset?(set)
+    enforce_set(set) && set.isSubsetOfSet(self)
+  end
+
+  def proper_subset?(set)
+    (subset? set) && (self != set)
+  end
+
+  def proper_superset?(set)
+    (superset? set) && (self != set)
+  end
+
+  def reject!(&block)
+    return to_enum(__method__) unless block_given?
+    each_returning_self_or_nil { |item| delete item if block.call item }
+  end
+
+  def select!(&block)
+    return to_enum(__method__) unless block_given?
+    each_returning_self_or_nil { |item| delete item unless block.call item }
+  end
+
+protected
+
+  def flat_each(&block)
+    each do |item|
+      (item.instance_of? self.class) ? item.flat_each(&block) : block.(item)
+    end
+  end
+
+private
+
+  def each_returning_self_or_nil(&block)
+    old_size = self.size
+    each(&block)
+    (old_size != size) ? self : nil
+  end
+
+  def enforce_set(set)
+    raise ArgumentError, 'value must be a set' unless set.is_a? self.class
+    true
+  end
+
+  def send_to_copy(symbol, enum)
+    self.to_set.tap { |set| set.send(symbol, enum.to_set) }
+  end
+
+end
+
+class Enumerable
+  def to_set
+    Set[*self]
+  end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: motion-set
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Vladimir Keleshev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Set implementation for RubyMotion
+email:
+- vladimir@keleshev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/motion-set.rb
+- lib/project/motion-set.rb
+homepage: ''
+licenses:
+- ''
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Set implementation for RubyMotion
+test_files: []