sorted_array 0.0.1 → 0.0.2

data/README.md

@@ -1,16 +1,21 @@
 # SortedArray
 
-The gem provides a class SortedArray which keeps sorted
-with a given Sorter-class after adding new items.
+The gem is providing a class `SortedArray` which keeps sorted
+after adding new items. When initializing a `SortedArray` you chose
+a Sorter which must have a method `:sort`
 
-The included DefaultSorter sorts a list of Objects by a
-given method-name.
+A class `DefaultSorter` is included.
+
+The included `DefaultSorter` sorts a list of Objects by a given method-name.
 
 ## Installation
 
+  * see [RubyGems](http://rubygems.org/gems/sorted_array)
+  * see [Github](https://github.com/iboard/sorted_array#readme)
+
 Add this line to your application's Gemfile:
 
-    gem 'sorted_array'
+    gem 'sorted_array' 
 
 And then execute:
 
@@ -22,20 +27,28 @@ Or install it yourself as:
     
 Run Tests
 
-    $ rake
+_If you clone from github you can run the following tasks:_
 
-    # using Guard
-    $ guard
-    
-    # with rspec
-    $ rspec spec/
-    
-Build Documentation
+
+    $ git clone git://github.com/iboard/sorted_array.git
+    $ cd sorted_array
+    $ bundle               # update/install the bundle
+    $ rake                 # run all tests
+    $ rspec spec/          # run all specs manually
+    $ guard                # start guard
+
+## Documentation
 
     $ yard
-    $ open doc/index.html
+    $ open doc/index.html  # on Mac OS X
+
+A copy of the YARDocumentation can be found at
+[iboard.cc - yardoc](http://dav.iboard.cc/container/sorted_array_doc/)
+
+And a copy of the last coverage-report is at
+[iboard.cc - coverage](http://dav.iboard.cc/container/sorted_array_coverage/)
 
-## Usage
+## Usage-example
 
     data = [
       OpenStruct.new( foo: 1 ),
@@ -50,11 +63,13 @@ Build Documentation
     
 ## Persistent
 
-_SortedArray_ defines a marshal_load and marshal_dump method and
-is safe to be used with PStore.
+_SortedArray_ defines a `marshal_load` and `marshal_dump` method and
+can be used in a `PStore`
 
 Example:
 
+    # assumes the previous example was executed before
+     
     store=PStore.new('example.pstore')
     store.transaction do |w|
       w[:data] = keep_sorted

data/Rakefile

@@ -27,3 +27,10 @@ desc 'Build documentation'
 task :doc do
   system 'yard'
 end
+
+desc 'Deploy documentation'
+task :deploy_doc do
+    Rake::Task['doc'].execute
+    system 'rsync','-avze','ssh', '--delete', 'doc/', 'root@dav.iboard.cc:/var/www/dav/container/sorted_array_doc/'
+    system 'rsync','-avze','ssh', '--delete', 'coverage/', 'root@dav.iboard.cc:/var/www/dav/container/sorted_array_coverage/'
+end

data/TODO.md

@@ -1,4 +1,6 @@
 # TODO
 
+* DONE: _Implement for PStore_ 
 * TODO: Implement for ActiveRecord
 * TODO: Implement for MongoId
+* TODO: Written with Ruby 2.0 - make sure it works with 1.9.3 too.

data/lib/sorted_array/default_sorter.rb

@@ -42,7 +42,7 @@ module SortedArray
 
     # @param [Array] array - _classname,[..entries..]
     def marshal_load array
-      @method = array.last
+      @method = array ? array.last : :to_s
     end
 
   end

data/lib/sorted_array/version.rb

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

data/spec/default_sorter_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'pstore'
 
 describe SortedArray::DefaultSorter do
 
@@ -9,6 +10,7 @@ describe SortedArray::DefaultSorter do
     OpenStruct.new(foo: 2)
   ] }
   let(:sorted) { items.sort{|a,b|a.foo <=> b.foo} }
+  let(:store)  { PStore.new(SORTER_TEST_STORE) }
 
   it 'initialize with a sort-method' do
     expect(sorter.method).to eq(:foo)
@@ -20,15 +22,15 @@ describe SortedArray::DefaultSorter do
 
   it 'stores the method-name to a PStore' do
     sorter.should_receive(:marshal_dump)
-    PStore.new(SORTER_TEST_STORE).transaction do |s|
+    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
+    _s = nil
+    store.transaction(true) { |r| _s = r[:sorter] }
+    expect(_s).to be_a SortedArray::DefaultSorter
+    expect(_s.method).to eq(:to_s)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sorted_array
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -209,7 +209,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3563326067175133732
+      hash: -1794077783631359981
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -218,7 +218,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3563326067175133732
+      hash: -1794077783631359981
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25