magic_array 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f35afb97d04e18fce3239d92699335d9467d7b07
+  data.tar.gz: 70ccfd6a4153e812419a9eada4957e775c9153d4
+SHA512:
+  metadata.gz: 104b44209b802b7679e85ff47ff115463c979faa8a029743e1578a9668dbbf6ace2ee0bfccca54fdd80c269699623a2dd92171962549e3b4b5fca4fc0668cb48
+  data.tar.gz: 4e032900659eb9fb6f61445cbd302975de33990bc2c0c80d75f4e59918b0cca121cc05b9d17c05834d1561f72f050af7b31e152a90f313a6199a6863036dd33f

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
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alexander Panasyuk
+
+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,142 @@
+# MagicArray
+
+MagicArray is class that performs lazy loading of data. The only thing that you have to do is to define data source methods inside the MagicArray descendant. And then you can simply load data by accessing array elements.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'magic_array'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install magic_array
+
+## Usage
+
+Say you want to load some posts from vk.com. You can simply create the MagicArray descendant in order to load them.  
+You should always remember that you have to define **element_source(index)** and **elements_source(range_start, count)** using MagicArray.  
+  
+**MagicArray descendant example:**
+```ruby
+class PostArray < MagicArray
+
+  load_limit 100
+
+  def initialize group_id
+    @group_id = "-#{group_id}"
+    self.count = vk.wall.get(owner_id: @group_id, offset: 0, count: 1).first
+    super
+  end
+
+  def element_source index
+    vk.wall.get(owner_id: @group_id, offset: index, count: 1).last
+  end
+
+  def elements_source range_start, range_count
+    result = vk.wall.get(owner_id: @group_id, offset: range_start, count: range_count)
+    result.shift
+    result
+  end
+
+  def vk
+    vk_source = -> {VK::Client.new}
+    @vk ||= vk_source.call
+  end
+
+  def search from, till
+    from_index = (bsearch{ |post| post.date <= from }) - 1
+    till_index = bsearch{ |post| post.date <= till }
+    self[till_index..from_index]
+  end
+  
+  private
+
+      def bsearch &block
+        first = 0
+        last = count-1
+        mid = first + (last - first) / 2
+        while first<last
+          if yield(self[mid])
+            last = mid
+          else
+            first = mid + 1
+          end
+          mid = first + (last - first) / 2
+        end
+        if yield(self[last])
+          last
+        else
+          nil
+        end
+      end
+
+end
+```
+  
+###Initializing object
+```ruby
+post_array = PostArray.new 1234567 
+=> #<PostArray:0x000000028d3568 @group_id="-17076618", @vk=#<VkontakteApi::Client:0x000000028d2d48 ...
+```
+this code prints:
+```
+POST https://api.vk.com/method/wall.get
+body: "owner_id=-17076618&offset=0&count=1"
+```
+it means that PostArray loaded first element in order to find out total count of elements. So:
+```ruby
+post_array.count
+ => 901
+```
+
+###Loading elements with index number
+The code
+```ruby
+post_array[0] => #<Hashie::Mash comments=#<Hashie::Mash count=0> date=1385007153 from_id=79826777 id...
+```
+prints
+```
+POST https://api.vk.com/method/wall.get
+body: "owner_id=-17076618&offset=0&count=1"
+```
+and returns one post object.
+
+###Loading elements with range
+The code
+```ruby
+post_array[10..20]  => [#<Hashie::Mash comments=#<Hashie::Mash count=7> date=1384009402 from_id=6355...
+```
+prints
+```
+POST https://api.vk.com/method/wall.get
+body: "owner_id=-17076618&offset=10&count=11"
+```
+and returns an array that contains 11 post objects.
+
+###Accessing elements
+Once you loaded element or elements they are saved within PostArray. So you can simply access them without loading. Another words the are cached within your MagicArray descendant instance.
+If you want to see original Array of loaded elements:
+
+```ruby
+post_array.elements => [#<Hashie::Mash comments=#<Hashie::Mash count=0> date=1385007153 from_id=7982...
+
+```
+And now you have got the Array. Lets check it:
+
+```ruby
+post_array[0] => #<Hashie::Mash comments=#<Hashie::Mash count=0> date=1385007153 from_id=79826777 id...
+post_array[1] => nil
+```
+
+## 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 @@
+require "bundler/gem_tasks"

data/lib/magic_array.rb

@@ -0,0 +1,71 @@
+require "magic_array/version"
+
+class MagicArray
+
+  attr_accessor :elements, :count
+
+  def initialize *attrs
+    @elements = []
+    @count = 0 unless @count
+    self
+  end
+
+  def method_missing m, *args, &block
+    @elements.public_send m, args
+  end
+
+  def [] index
+    case index
+      when Range then
+        if elements[index].empty? || elements[index].include?(nil)
+          load_elements(index)
+        else
+          elements[index]
+        end
+      else
+        elements[index] || load_element(index)
+    end
+  end
+
+  def all
+    self[0..(count-1)]
+  end
+
+  def load_element index
+    elements[index] = element_source index
+  end
+
+  def load_elements range
+    iterative_range = if range.end < count || count == 0
+                        range.dup
+                      else
+                        Range.new range.begin, count-1
+                      end
+
+    while iterative_range.count > 0
+      limited_range = iterative_range.first(@@load_limit)
+      iterative_range = Range.new(
+          (
+          limited_range.count < @@load_limit ?
+              iterative_range.end+1 :
+              iterative_range.begin+@@load_limit
+          ),
+          iterative_range.end
+      )
+      array = elements_source limited_range.first, limited_range.count
+      limited_range.each_with_index do |element, index|
+        elements[element] = array[index]
+      end
+    end
+    elements[range]
+  end
+
+  class << self
+
+    def load_limit attr=nil
+      @@load_limit = attr || 100
+    end
+
+  end
+
+end

data/lib/magic_array/version.rb

@@ -0,0 +1 @@
+MAGIC_ARRAY_VERSION = "0.1.1"

data/magic_array.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'magic_array/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "magic_array"
+  spec.version       = MAGIC_ARRAY_VERSION
+  spec.authors       = ["Alexander Panasyuk"]
+  spec.email         = ["panasmeister@gmail.com"]
+  spec.description   = %q{Array that allows you to load data from specified source idly}
+  spec.summary       = %q{Lasy loading array}
+  spec.homepage      = "https://github.com/panasyuk/magic_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 "rspec"
+  spec.add_development_dependency "rake"
+end

data/spec/random_array.rb

@@ -0,0 +1,23 @@
+require 'magic_array'
+
+class RandomArray < MagicArray
+
+  load_limit 100
+
+  def initialize
+    super
+  end
+
+  def element_source index
+    rand index
+  end
+
+  def elements_source range_start, range_count
+    result = []
+    range_count.times do |index|
+      result << rand(range_start+index)
+    end
+    result
+  end
+
+end

data/spec/random_array_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'random_array'
+
+describe RandomArray do
+
+  let(:random_array){ RandomArray.new }
+
+  it 'should be descendant of MagicArray' do
+    RandomArray.ancestors.should include(MagicArray)
+  end
+
+  context 'on init' do
+    it 'should not contain elements' do
+      random_array.count.should == 0
+    end
+  end
+
+  it 'should generate element in range of its index when it is requested' do
+    random_array[0].should < 1
+    random_array[1].should == 0
+    random_array[2].should < 2
+    random_array[10].should < 10
+  end
+
+  it 'should generate array in requested range' do
+    result_array = random_array[50..60]
+    result_array.class.should be Array
+    result_array.each_with_index do |element, index|
+      element.should < 50+index
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'magic_array'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: magic_array
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Alexander Panasyuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 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'
+description: Array that allows you to load data from specified source idly
+email:
+- panasmeister@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/magic_array.rb
+- lib/magic_array/version.rb
+- magic_array.gemspec
+- spec/random_array.rb
+- spec/random_array_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/panasyuk/magic_array
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Lasy loading array
+test_files:
+- spec/random_array.rb
+- spec/random_array_spec.rb
+- spec/spec_helper.rb