sorted_array 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rspec

data/.yardopts

@@ -0,0 +1 @@
+-m markdown --protected lib/**/*rb - README.md TODO.md LICENSE.txt

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sorted_array.gemspec
+gemspec
+

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andi Altendorfer
+
+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,103 @@
+# SortedArray
+
+The gem provides a class SortedArray which keeps sorted
+with a given Sorter-class after adding new items.
+
+The included DefaultSorter sorts a list of Objects by a
+given method-name.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sorted_array'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sorted_array
+    
+Run Tests
+
+    $ rake
+
+    # using Guard
+    $ guard
+    
+    # with rspec
+    $ rspec spec/
+    
+Build Documentation
+
+    $ yard
+    $ open doc/index.html
+
+## Usage
+
+    data = [
+      OpenStruct.new( foo: 1 ),
+      OpenStruct.new( foo: 3 ),
+      OpenStruct.new( foo: 2 )
+    ]
+    keep_sorted = SortedArray.new( DefaultSorter.new(:foo), data )
+    keep_sorted << OpenStruct.new( foo: 0 )
+    
+    # data.map(&:foo) => [1,3,2]
+    # keep_sorted.map(&:foo) => [0,1,2,3]
+    
+## Persistent
+
+_SortedArray_ defines a marshal_load and marshal_dump method and
+is safe to be used with PStore.
+
+Example:
+
+    store=PStore.new('example.pstore')
+    store.transaction do |w|
+      w[:data] = keep_sorted
+    end
+    
+    from_disk = []
+    store.trasaction(true) do |r|
+      from_disk = r[:data]
+    end
+    
+    # from_disk.map(&:foo) => [0,1,2,3]
+
+
+## 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
+
+
+## License
+
+Copyright (c) 2013 Andi Altendorfer
+
+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/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+#
+require "bundler/gem_tasks"
+options = ENV['TERM'] == 'dumb' ? '--no-color' : '--color'
+
+# Enable ask when needed ...
+#def ask prompt, allow
+  #loop do
+    #printf( "%s (%s):" % [prompt, "[#{allow.first}]#{allow[1..-1].join('/')}"])
+    #answer = $stdin.gets
+    #break answer.strip if allow.include?(answer.strip)
+    #break allow.first if answer == "\n"
+    #puts "Please answer #{allow.join('/')} or press Ctrl+C to abort"
+  #end
+#end
+
+
+# Application Tasks
+task :default => 'test'
+
+desc 'Run all specs'
+task :test do
+  system "rspec -f p #{options} spec "
+end
+
+desc 'Build documentation'
+task :doc do
+  system 'yard'
+end

data/TODO.md

@@ -0,0 +1,4 @@
+# TODO
+
+* TODO: Implement for ActiveRecord
+* TODO: Implement for MongoId

data/lib/sorted_array/default_sorter.rb

@@ -0,0 +1,50 @@
+module SortedArray
+
+  # Sorts by comparing of :field  a <=> b.
+  #
+  # Descend your Sorter from this class. It must at least define a
+  # method 'sort'.
+  # @example
+  #   class Foo
+  #     def initialize(_bar)
+  #       @bar = _bar
+  #     end
+  #     def bar
+  #       @bar
+  #     end
+  #   end
+  #   s = DefaultSorter.new(:bar)
+  #   a = SortedArray(s, Foo.new(1), Foo.new(3), Foo.new(2))
+  #   # => Foo(1), Foo(2), Foo(3)
+  # @see SortedArray
+  class DefaultSorter
+
+    attr_reader :method
+
+    # @param [String] _method - the method to be used while sorting.
+    def initialize(_method)
+      @method = _method
+    end
+
+    # Sort the given object.
+    # @abstract Overwrite this method in descendants
+    # to sort your objects for your needs
+    # @param [Object] what - what must provice a method sort! and :method
+    # @return [Object]
+    def sort(object)
+      object.sort! { |a,b| a.send(@method) <=> b.send(@method) }
+    end
+
+    # @return [Array] - Classname, methodname
+    def marshal_dump
+      [ self.class, @method ]
+    end
+
+    # @param [Array] array - _classname,[..entries..]
+    def marshal_load array
+      @method = array.last
+    end
+
+  end
+
+end

data/lib/sorted_array/version.rb

@@ -0,0 +1,4 @@
+module SortedArray
+  # Used by gemspec.
+  VERSION = "0.0.1"
+end

data/lib/sorted_array.rb

@@ -0,0 +1,71 @@
+require 'sorted_array/version'
+require 'sorted_array/default_sorter'
+
+# The gem/module provides a class SortedArray which keeps sorted
+# with a given Sorter-class after adding new items.
+module SortedArray
+
+  # A SortedArray takes a Sorter-object as a parameter.
+  # The array gets sorted after each push,<<,unsift.
+  # It defines marshal-methods and can be used with PStore
+  # @see DefaultSorter
+  class SortedArray < Array
+
+    # @params [Array] args the first argument is a Sorter-object
+    # @example
+    #     my_array = SortedArray.new( DefaultSorter.new(:foo) )
+    #     my_array << AnyClassWhichSupportsFoo.new(1)
+    #     my_array << AnyClassWhichSupportsFoo.new(3)
+    #     my_array << AnyClassWhichSupportsFoo.new(2)
+    #     # my_array.map(&:foo) => 1,2,3
+    # @see DefaultSorter
+    # @see Array
+    def initialize *args
+      @sorter = args.shift
+      super
+    end
+
+    # @see Array
+    def push *other
+      super
+      @sorter.sort(self)
+    end
+
+    # @see Array
+    def unshift other
+      super
+      @sorter.sort(self)
+    end
+
+    # @see Array
+    def << other
+      push *other
+      @sorter.sort(self)
+    end
+
+    protected
+
+    # @return [Array] - Sorter-object or nil, [...values...]
+    def marshal_dump
+      [@sorter ? @sorter.marshal_dump : nil, to_a]
+    end
+
+    # Initialize sorter and read in data
+    # @param [Array] array - _sorter, [..entries..]
+    def marshal_load array
+      _sorter, _data = *array
+      if _sorter
+        initialize_sorter _sorter
+        push *_data if _data
+      end
+    end
+
+    private
+
+    def initialize_sorter args
+      @sorter = args.shift.new *args
+    end
+
+  end
+
+end

data/sorted_array.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sorted_array/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sorted_array"
+  spec.version       = SortedArray::VERSION
+  spec.authors       = ["Andi Altendorfer"]
+  spec.email         = ["andi@iboard.cc"]
+  spec.description   = %q{Provides class SortedArray which you can initialize with a block used to sort the Array after each push-action.}
+  spec.summary       = 'SortedArray.new { |a,b| a.foo <=> b.foo }'
+  spec.homepage      = "https://github.com/iboard/sorted_array"
+  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 = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-expectations"
+  spec.add_development_dependency "rspec-mocks"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "redcarpet"
+  spec.add_development_dependency "simplecov"
+end

data/spec/default_sorter_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe SortedArray::DefaultSorter do
+
+  let(:sorter) { SortedArray::DefaultSorter.new(:foo) }
+  let(:items) { [
+    OpenStruct.new(foo: 1),
+    OpenStruct.new(foo: 3),
+    OpenStruct.new(foo: 2)
+  ] }
+  let(:sorted) { items.sort{|a,b|a.foo <=> b.foo} }
+
+  it 'initialize with a sort-method' do
+    expect(sorter.method).to eq(:foo)
+  end
+
+  it 'sorts an array by a given sort-method' do
+    expect(sorter.sort(items)).to eq(sorted)
+  end
+
+  it 'stores the method-name to a PStore' do
+    sorter.should_receive(:marshal_dump)
+    PStore.new(SORTER_TEST_STORE).transaction do |s|
+      s[:sorter] = sorter
+    end
+  end
+
+  it 'loads the method-name from a PStore' do
+    sorter.should_receive(:marshal_load)
+    PStore.new(SORTER_TEST_STORE).transaction do |s|
+      s[:sorter]
+    end
+  end
+end

data/spec/sorted_array_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'ostruct'
+require 'pstore'
+
+describe SortedArray::SortedArray do
+
+  context 'with two objects and the DefaultSorter' do
+
+    let(:items) { [ OpenStruct.new(foo: 'baz'), OpenStruct.new(foo: 'bar') ] }
+    let(:sorted) { items.reverse }
+    let(:sorter) { SortedArray::DefaultSorter.new( :foo ) }
+    let(:array)  { SortedArray::SortedArray.new(sorter)   }
+
+    it 'sorts objects after push' do
+      expect(array.push *items).to eq(sorted)
+    end
+
+    it 'sorts objects after <<' do
+      expect(array << items).to eq(sorted)
+    end
+
+    it 'sorts objects after unshift' do
+      items.each { |item| array.unshift(item) }
+      expect(array).to eq(sorted)
+    end
+
+
+    describe 'Persists to a PStore' do
+
+      let(:store) { PStore.new(ARRAY_TEST_STORE) }
+
+      it 'stores to a PStore' do
+        expect{ store.transaction { |ps| ps[:array] = array } }.not_to raise_error
+      end
+
+      it 'reads from a PStore' do
+        loaded_array = nil
+        array.push *items
+        store.transaction do |ps|
+          ps[:array] = array
+        end
+        store.transaction(true) do |ps| 
+          loaded_array = ps[:array] 
+        end
+        expect(loaded_array).to eq(sorted)
+      end
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec/expectations'
+require 'rspec/mocks'
+require 'sorted_array' # and any other gems you need
+
+SORTER_TEST_STORE = '/tmp/sorter_spec.pstore'
+ARRAY_TEST_STORE  = '/tmp/sorted_array_spec.pstore'
+
+RSpec.configure do |c|
+  c.include SortedArray
+  File.unlink(SORTER_TEST_STORE) if File.exists?(SORTER_TEST_STORE)
+  File.unlink(ARRAY_TEST_STORE) if File.exists?(ARRAY_TEST_STORE)
+end
+

metadata

@@ -0,0 +1,232 @@
+--- !ruby/object:Gem::Specification
+name: sorted_array
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andi Altendorfer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: Provides class SortedArray which you can initialize with a block used
+  to sort the Array after each push-action.
+email:
+- andi@iboard.cc
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .yardopts
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- lib/sorted_array.rb
+- lib/sorted_array/default_sorter.rb
+- lib/sorted_array/version.rb
+- sorted_array.gemspec
+- spec/default_sorter_spec.rb
+- spec/sorted_array_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/iboard/sorted_array
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3563326067175133732
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3563326067175133732
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: SortedArray.new { |a,b| a.foo <=> b.foo }
+test_files:
+- spec/default_sorter_spec.rb
+- spec/sorted_array_spec.rb
+- spec/spec_helper.rb
+has_rdoc: