collection_of 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NWNjZGU2ZGE3YzAxYWI5MWMwZmFhYmJjMGU4ZTY3NjY2ZDFjNmQzMA==
+  data.tar.gz: !binary |-
+    MDg1NWUzMTljNDFmN2Y4Mjg0M2JhZGNkOWM3ZTdiZGQxZDUwNWE5Mg==
+SHA512:
+  metadata.gz: !binary |-
+    MDkzYmFlODg2NjQ3Y2VhNGY1MmMxNmE3MDEyYjRiNTlhOWU2MzE2NmM4YzJh
+    OTNjYzU0MTk0ZTc2NmY5ZjM2NjdjM2UyNzRhMzhhZWI2MjY0ZjFkNjIyOTFk
+    YTA5OGMwZjQxMTY4YjUzZjU1NGRlYWY0NDE3ZjA1OTYxMmE1MjM=
+  data.tar.gz: !binary |-
+    ZmQ0NjNhNzBiZThjNjI0NjRlMGI0MGY5NDQzZWJhM2IyNDRmYThiOGE3N2Mx
+    YTRhZTlkODBmMTc2MDczOTFiZTNkNmM2MjJkZmY4NjI2ODYzMzIyNDQ0ZThi
+    ZjY0ZGQ5ODBlNmMyNTRjODZhNGI2YTI0OWUzMzg1Y2UxMmU4N2M=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.idea
+.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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in collection_of.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Daniel Vandersluis
+
+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,42 @@
+# CollectionOf
+
+Provides an Enumerable which acts as a collection of a certain type of object (and its subclasses,
+unless `allow_subclasses` is set to `false` on initialization).
+
+## Usage
+
+    WidgetCollection = Collection[Widget]
+    # OR WidgetCollection = Collection.of(Widget)
+    # OR WidgetCollection = Collection.new(Widget)
+
+    wc = WidgetCollection.new
+    wc << Widget.new # all good!
+    wc << Wadget.new # => ArgumentError, "can only add Widget objects"
+
+When a `Collection` is cloned, any items contained within the collection are cloned as well.
+
+    wc << Widget.new(:one)
+    wc << Widget.new(:two)
+    wc[:one] == wc.clone[:one] # => false
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'collection_of'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install collection_of
+
+## 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,5 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/collection_of.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'collection_of/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'collection_of'
+  spec.version       = CollectionOf::VERSION
+  spec.authors       = ['Daniel Vandersluis']
+  spec.email         = ['dvandersluis@selfmgmt.com']
+  spec.description   = %q{Ruby object for ease of collecting a certain type}
+  spec.summary       = %q{Allows a collection of a given type of object to be worked with easily}
+  spec.homepage      = 'https://github.com/dvandersluis/collection_of'
+  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 = %w(lib)
+
+  spec.add_dependency 'active_support', '>= 3.0.0'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/collection_of.rb

@@ -0,0 +1,8 @@
+require 'collection_of/collection'
+require 'collection_of/version'
+
+module CollectionOf
+  def self.[](klass, *args)
+    Collection.of(klass, *args)
+  end
+end

data/lib/collection_of/collection.rb

@@ -0,0 +1,64 @@
+require 'active_support/core_ext/module/delegation'
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/object/duplicable'
+
+class Collection
+  include Enumerable
+
+  attr_reader :klass, :options
+
+  delegate :empty?, :size, :each, :last, to: :@collection, allow_nil: true
+
+  class << self
+    alias_method :of, :new
+    alias_method :[], :new
+  end
+
+  def initialize(klass, *args)
+    @options = args.extract_options!
+    @klass = klass.is_a?(Class) ? klass : klass.class
+    @collection = [args.first].compact.flatten
+  end
+
+  def initialize_clone(*)
+    super
+
+    # Clone each item in the collection
+    @collection = @collection.inject([]) do |ary, item|
+      ary << (item.duplicable? ? item.clone : item)
+      ary
+    end
+  end
+
+  def [](item)
+    return nil if empty?
+
+    if item.is_a?(Fixnum)
+      @collection[item]
+    else
+      item = item.to_sym
+      detect{ |i| i.name.to_sym == item }
+    end
+  end
+
+  def new(*args, &block)
+    @klass.new(*args, &block).tap{ |obj| @collection << obj }
+  end
+
+  def <<(obj)
+    checker = @options.fetch(:allow_subclasses, true) ? :is_a? : :instance_of?
+    raise ArgumentError, "can only add #{@klass.name} objects" unless obj.send(checker, @klass)
+    @collection << obj
+  end
+
+  def except(*items)
+    items.map!(&:to_sym)
+    self.class.new(klass, reject{ |i| items.include?(i.name.to_sym) })
+  end
+
+  def ==(other)
+    return other == @collection if other.is_a?(self.class)
+    return @collection == other if other.is_a?(Array)
+    super
+  end
+end

data/lib/collection_of/version.rb

@@ -0,0 +1,3 @@
+module CollectionOf
+  VERSION = "1.0.0"
+end

data/spec/collection_spec.rb

@@ -0,0 +1,189 @@
+require 'collection_of'
+
+class Widget
+  attr_accessor :name
+
+  def initialize(name = nil)
+    @name = name
+  end
+end
+
+class Wadget
+  attr_accessor :name
+
+  def initialize
+    @name = yield if block_given?
+  end
+end
+
+class SubWidget < Widget; end
+
+describe Collection do
+  let(:w) { Widget.new }
+
+  describe "#initialize" do
+    context "when using #new" do
+      subject { Collection.new(Widget, [w], allow_subclasses: true) }
+      it { should be_a Collection }
+      it { should == [w] }
+      its(:klass) { should == Widget }
+      its(:options) { should == { allow_subclasses: true } }
+    end
+
+    context "when using the CollectionOf[] shorthand" do
+      subject { CollectionOf[Widget, [w], allow_subclasses: true] }
+      it { should be_a Collection }
+      it { should == [w] }
+      its(:klass) { should == Widget }
+      its(:options) { should == { allow_subclasses: true } }
+    end
+
+    context "when using the Collection[] shorthand" do
+      subject { Collection[Widget, [w], allow_subclasses: true] }
+      it { should be_a Collection }
+      it { should == [w] }
+      its(:klass) { should == Widget }
+      its(:options) { should == { allow_subclasses: true } }
+    end
+
+    context "when using Collection.of" do
+      subject { Collection.of(Widget, [w], allow_subclasses: true) }
+      it { should be_a Collection }
+      it { should == [w] }
+      its(:klass) { should == Widget }
+      its(:options) { should == { allow_subclasses: true } }
+    end
+  end
+
+  describe "#clone" do
+    let(:c) { described_class[Widget] }
+    let(:w1) { Widget.new(:one) }
+    let(:w2) { Widget.new(:two) }
+
+    before { c << w1 << w2 }
+
+    subject { c.clone }
+
+    it { should_not == c }
+    its(:first) { should_not == c.first }
+    its([1]) { should_not == c.first }
+
+    its('first.name') { should == :one }
+  end
+
+  describe "#[]" do
+    let(:w) { Widget.new("widgey") }
+    subject{ described_class.new(Widget) }
+
+    context "when the collection is empty" do
+      its([:foo]) { should be_nil }
+    end
+
+    context "when the collection is not empty" do
+      before { subject << w }
+
+      its([0]) { should == w }
+      its(['widgey']) { should == w }
+      its([:widgey]) { should == w }
+      its([1]) { should be_nil }
+      its([:fake]) { should be_nil }
+    end
+  end
+
+  describe "#new" do
+    subject { described_class[Widget] }
+
+    it "should create a new Widget" do
+      subject.new.should be_a Widget
+    end
+
+    it "should add it to the collection" do
+      subject.new
+      subject.count.should == 1
+    end
+
+    it "should add the new item to the end of the collection" do
+      3.times { subject.new }
+      w = subject.new
+      subject[3].should == w
+    end
+
+    it "should pass on any arguments" do
+      w = subject.new('Smith')
+      w.name.should == 'Smith'
+    end
+
+    it "should pass on a given block" do
+      c = described_class[Wadget]
+      w = c.new { :test }
+      w.name.should == :test
+    end
+  end
+
+  describe "#<<" do
+    subject { described_class[Widget] }
+
+    it "should add like types to the collection" do
+      expect { subject << w }.to_not raise_error
+      subject.first.should == w
+    end
+
+    it "should not add unlike types to the collection" do
+      w = Wadget.new
+      expect { subject << w }.to raise_error(ArgumentError, "can only add Widget objects")
+    end
+
+    it "should add subclasses" do
+      expect { subject << SubWidget.new }.to_not raise_error
+    end
+
+    it "should not allow subclasses if allow_subclasses is false" do
+      c = described_class[Widget, allow_subclasses: false]
+      expect { c << SubWidget.new }.to raise_error(ArgumentError, "can only add Widget objects")
+    end
+  end
+
+  describe "#except" do
+    let(:c) { described_class[Widget] }
+    let(:w1) { Widget.new(:one) }
+    let(:w2) { Widget.new(:two) }
+
+    before { c << w1 << w2 }
+
+    context "when an include item is specified" do
+      subject { c.except(:one) }
+      it { should be_a described_class }
+      it { should == [w2] }
+    end
+
+    context "when all included items are specified" do
+      subject { c.except(:one, :two) }
+      it { should be_a described_class }
+      it { should be_empty }
+    end
+
+    context "when no included items are specified" do
+      subject { c.except(:three) }
+      it { should be_a described_class }
+      it { should == [w1, w2] }
+    end
+  end
+
+  describe "#==" do
+    let(:w1) { Widget.new(:one) }
+    let(:w2) { Widget.new(:two) }
+
+    subject { described_class[Widget] }
+    before { subject << w1 << w2 }
+
+    it { should == [w1, w2] }
+    it { should_not == [w1] }
+    it { should_not == [w2] }
+    it { should_not == [] }
+
+    it { should == described_class[Widget, [w1, w2]] }
+    it { should_not == described_class[Widget, [w1]] }
+    it { should_not == described_class[Widget, [w2]] }
+    it { should_not == described_class[Widget] }
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: collection_of
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel Vandersluis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  type: :runtime
+  prerelease: false
+  name: active_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  type: :development
+  prerelease: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby object for ease of collecting a certain type
+email:
+- dvandersluis@selfmgmt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- collection_of.gemspec
+- lib/collection_of.rb
+- lib/collection_of/collection.rb
+- lib/collection_of/version.rb
+- spec/collection_spec.rb
+homepage: https://github.com/dvandersluis/collection_of
+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.1.5
+signing_key: 
+specification_version: 4
+summary: Allows a collection of a given type of object to be worked with easily
+test_files:
+- spec/collection_spec.rb
+has_rdoc: