dm-chunked_query 0.1.0

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.*
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "dm-chunked_query Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,6 @@
+### 0.1.0 / 2011-03-02
+
+* Initial release:
+  * Allows random-access to chunks within a query.
+  * Can iterate through all chunks within a query.
+

data/Gemfile

@@ -0,0 +1,142 @@
+# If you're working on more than one datamapper gem at a time, then it's
+# recommended to create a local Gemfile and use this instead of the git
+# sources. This will make sure that you are  developing against your
+# other local datamapper sources that you currently work on. Gemfile.local
+# will behave identically to the standard Gemfile apart from the fact that
+# it fetches the datamapper gems from local paths. This means that you can
+# use the same environment variables, like ADAPTER(S) or PLUGIN(S) when
+# running
+# bundle commands. Gemfile.local is added to .gitignore, so you don't need
+# to worry about accidentally checking local development paths into git.
+# In order to create a local Gemfile, all you need to do is run:
+#
+#   bundle exec rake local_gemfile
+#
+# This will give you a Gemfile.local file that points to your local clones
+# of the various datamapper gems. It's assumed that all datamapper repo
+# clones reside in the same directory. You can use the Gemfile.local like
+# so for running any bundle command:
+#
+#   BUNDLE_GEMFILE=Gemfile.local bundle foo
+#
+# You can also specify which adapter(s) should be part of the bundle by
+# setting an environment variable. This of course also works when using the
+# Gemfile.local
+#
+#   bundle foo                        # dm-sqlite-adapter
+#
+#   ADAPTER=mysql bundle foo          # dm-mysql-adapter
+#
+#   ADAPTERS=sqlite,mysql bundle foo  # dm-sqlite-adapter, dm-mysql-adapter
+#
+# Of course you can also use the ADAPTER(S) variable when using the
+# Gemfile.local and running specs against selected adapters.
+#
+# For easily working with adapters supported on your machine, it's
+# recommended that you first install all adapters that you are planning to
+# use or work on by doing something like
+#
+#   ADAPTERS=sqlite,mysql,postgres bundle install
+#
+# This will clone the various repositories and make them available to
+# bundler. Once you have them installed you can easily switch between
+# adapters for the various development tasks. Running something like
+#
+#   ADAPTER=mysql bundle exec rake spec
+#
+# will make sure that the dm-mysql-adapter is part of the bundle, and will
+# be used when running the specs.
+#
+# You can also specify which plugin(s) should be part of the bundle by
+# setting an environment variable. This also works when using the
+# Gemfile.local
+#
+#   bundle foo                                 # dm-migrations
+#
+#   PLUGINS=dm-validations bundle foo          # dm-migrations,
+#                                              # dm-validations
+#
+#   PLUGINS=dm-validations,dm-types bundle foo # dm-migrations,
+#                                              # dm-validations,
+#                                              # dm-types
+#
+# Of course you can combine the PLUGIN(S) and ADAPTER(S) env vars to run
+# specs for certain adapter/plugin combinations.
+#
+# Finally, to speed up running specs and other tasks, it's recommended to
+# run
+#
+#   bundle lock
+#
+# after running 'bundle install' for the first time. This will make
+# 'bundle exec' run a lot faster compared to the unlocked version. With an
+# unlocked bundle you would typically just run 'bundle install' from time
+# to time to fetch the latest sources from upstream. When you locked your
+# bundle, you need to run
+#
+#   bundle install --relock
+#
+# to make sure to fetch the latest updates and then lock the bundle again.
+# Gemfile.lock is added to the .gitignore file, so you don't need to worry
+# about accidentally checking it into version control.
+
+source :rubygems
+
+DATAMAPPER = 'http://github.com/datamapper'
+DM_VERSION = '~> 1.0'
+DO_VERSION = '~> 0.10.2'
+DM_DO_ADAPTERS = %w[sqlite postgres mysql oracle sqlserver]
+RAILS = 'http://github.com/rails/rails.git'
+
+if ENV['EXTLIB']
+  gem 'extlib',         '~> 0.9.15', :git => "#{DATAMAPPER}/extlib.git",
+                                     :require => nil
+else
+  gem 'activesupport',  '~> 3.0.4', :require => nil
+  gem 'i18n',           '~> 0.5.0'
+end
+
+gem 'dm-core',	DM_VERSION, :git => "#{DATAMAPPER}/dm-core.git"
+
+group :development do
+  gem 'rake',		    '~> 0.8.7'
+
+  gem 'ore-tasks',	'~> 0.4'
+  gem 'rspec',      '~> 2.4'
+
+  gem 'kramdown',   '~> 0.12.0'
+  gem 'yard',		    '~> 0.6.0'
+end
+
+group :datamapper do
+  # We need this because we want to pin these dependencies to their git
+  # master sources
+
+  adapters = ENV['ADAPTER'] || ENV['ADAPTERS']
+  adapters = adapters.to_s.tr(',', ' ').split.uniq - %w[ in_memory ]
+
+  if (do_adapters = DM_DO_ADAPTERS & adapters).any?
+    options = {}
+    options[:git] = "#{DATAMAPPER}/do.git" if ENV['DO_GIT'] == 'true'
+
+    gem 'data_objects',  DO_VERSION, options.dup
+
+    do_adapters.each do |adapter|
+      adapter = 'sqlite3' if adapter == 'sqlite'
+      gem "do_#{adapter}", DO_VERSION, options.dup
+    end
+
+    gem 'dm-do-adapter', DM_VERSION, :git => "#{DATAMAPPER}/dm-do-adapter.git"
+  end
+
+  adapters.each do |adapter|
+    gem "dm-#{adapter}-adapter", DM_VERSION, :git => "#{DATAMAPPER}/dm-#{adapter}-adapter.git"
+  end
+
+  plugins = ENV['PLUGINS'] || ENV['PLUGIN']
+  plugins = plugins.to_s.tr(',', ' ').split.push('dm-migrations').uniq
+
+  plugins.each do |plugin|
+    gem plugin, DM_VERSION, :git => "#{DATAMAPPER}/#{plugin}.git"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Hal Brodigan
+
+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,48 @@
+# dm-chunked_query
+
+* [Source](http://github.com/postmodern/dm-chunked_query)
+* [Issues](http://github.com/postmodern/dm-chunked_query/issues)
+* [Documentation](http://rubydoc.info/gems/dm-chunked_query/frames)
+* [Email](mailto:postmodern.mod3 at gmail.com)
+
+## Description
+
+Allows performing chunked queries on DataMapper Models or Collections.
+
+## Features
+
+* Allows random-access to chunks within a query.
+* Can iterate through all chunks within a query.
+* Can be used for bulk-processing of resources.
+* Can also be used for pagination of resources.
+
+## Examples
+
+Enumerate over all chunks, 20 resources per-chunk:
+
+    require 'dm-chunked_query'
+
+    MyModel.chunks(20).each do |chunk|
+      chunk.each do |resource|
+        # ...
+      end
+    end
+
+Get the 5th chunk, containing 10 resources:
+
+    MyModel.all(:foo => 'bar').chunks(10)[5]
+
+## Requirements
+
+* [dm-core](http://github.com/datamapper/dm-core#readme) ~> 1.0
+* [dm-aggregates](http://github.com/datamapper/dm-aggregates#readme) ~> 1.0
+
+## Install
+
+    $ gem install dm-chunked_query
+
+## Copyright
+
+Copyright (c) 2011 Hal Brodigan
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'
+
+begin
+  require 'bundler'
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install bundler` to install Bundler."
+  exit e.status_code
+end
+
+begin
+  Bundler.setup(:development)
+rescue Bundler::BundlerError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'rake'
+
+require 'ore/tasks'
+Ore::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/dm-chunked_query.gemspec

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  begin
+    require 'ore/specification'
+    retry
+  rescue LoadError
+    STDERR.puts "The '#{__FILE__}' file requires Ore."
+    STDERR.puts "Run `gem install ore-core` to install Ore."
+  end
+end

data/gemspec.yml

@@ -0,0 +1,20 @@
+name: dm-chunked_query
+version: 0.1.0
+summary: Allows performing chunked queries with DataMapper.
+description:
+  Allows performing chunked queries on DataMapper Models or Collections.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/dm-chunked_query
+has_yard: true
+
+dependencies:
+  dm-core: ~> 1.0
+  dm-aggregates: ~> 1.0
+
+development_dependencies:
+  ore-tasks: ~> 0.4
+  rspec: ~> 2.4
+  yard: ~> 0.6.0

data/lib/dm-chunked_query/chunks.rb

@@ -0,0 +1,116 @@
+module DataMapper
+  module ChunkedQuery
+    #
+    # Represents the abstract collection of Chunks.
+    #
+    class Chunks
+
+      include Enumerable
+
+      # The number of resources per chunk
+      attr_reader :per_chunk
+
+      #
+      # Creates a new collection of Chunks.
+      #
+      # @param [DataMapper::Model, DataMapper::Collection] query
+      #   The model or collection to access via chunks.
+      #
+      # @param [Integer] per_chunk
+      #   The number of records per-chunk.
+      #
+      def initialize(query,per_chunk)
+        @query = query
+        @per_chunk = per_chunk
+      end
+
+      #
+      # Provides random access to chunks.
+      #
+      # @param [Integer, Range<Integer>] key
+      #   The index or range of indices to access.
+      #
+      # @return [DataMapper::Collection, Array<DataMapper::Resource>]
+      #   A collection of resources at the given index or indices.
+      #
+      def [](key)
+        case key
+        when Range
+          index = key.first
+          span = key.to_a.size
+
+          chunk_at(index,span)
+        when Integer
+          chunk_at(key)
+        end
+      end
+
+      alias at []
+
+      #
+      # Enumerates over each chunk in the collection of Chunks.
+      #
+      # @yield [chunk]
+      #   The given block will be passed each chunk.
+      #
+      # @yieldparam [DataMapper::Collection] chunk
+      #   The collection of resources that makes up a chunk.
+      #
+      # @return [Enumerator]
+      #   If no block is given, an Enumerator object will be returned.
+      #
+      def each
+        return enum_for(:each) unless block_given?
+
+        (0...length).each do |index|
+          yield chunk_at(index)
+        end
+
+        return self
+      end
+
+      #
+      # Counts how many underlying resources are available.
+      #
+      # @return [Integer]
+      #   The total number of resources.
+      #
+      def count
+        @count ||= @query.count
+      end
+
+      #
+      # Calculate the number of Chunks.
+      #
+      # @return [Integer]
+      #   The number of available Chunks.
+      #
+      def length
+        @length ||= (count.to_f / @per_chunk).ceil
+      end
+
+      alias size length
+
+      protected
+
+      #
+      # Creates a chunk of resources.
+      #
+      # @param [Integer] index
+      #   The index of the chunk.
+      #
+      # @param [Integer] span
+      #   The number of chunks the chunk should span.
+      #
+      # @return [DataMapper::Collection]
+      #   The collection of resources that makes up the chunk.
+      #
+      def chunk_at(index,span=1)
+        if (index >= 0 && index < length)
+          @query[(index * @per_chunk), (span * @per_chunk)]
+        end
+      end
+
+    end
+  end
+end

data/lib/dm-chunked_query/mixin.rb

@@ -0,0 +1,20 @@
+require 'dm-chunked_query/chunks'
+
+module DataMapper
+  module ChunkedQuery
+    module Mixin
+      #
+      # Allows chunked access to the resources from a query.
+      #
+      # @param [Integer] per_chunk
+      #   The number of resources per-chunk.
+      #
+      # @return [Chunks]
+      #   The abstract collection of chunks from the query.
+      #
+      def chunks(per_chunk)
+        Chunks.new(self,per_chunk)
+      end
+    end
+  end
+end

data/lib/dm-chunked_query.rb

@@ -0,0 +1,6 @@
+require 'dm-chunked_query/mixin'
+
+require 'dm-core'
+
+DataMapper::Model.send :include, DataMapper::ChunkedQuery::Mixin
+DataMapper::Collection.send :include, DataMapper::ChunkedQuery::Mixin

data/spec/chunked_query_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe DataMapper::ChunkedQuery do
+  it "should allow chunked queries directly from Models" do
+    TestModel.chunks(1).length.should == 100
+  end
+
+  it "should allow chunked queries from other queries" do
+    TestModel.all(:number.lte => 50).chunks(1).length.should == 50
+  end
+end

data/spec/chunks_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe DataMapper::ChunkedQuery::Chunks do
+  let(:per_chunk) { 10 }
+
+  subject { TestModel.chunks(per_chunk) }
+
+  it "should count the number of total resources" do
+    subject.count.should == TestModel.count
+  end
+
+  it "should calculate how many chunks are available" do
+    subject.length.should == (TestModel.count / per_chunk)
+  end
+
+  it "should round-up when calculate the number of available chunks" do
+    TestModel.chunks(TestModel.count * 0.75).length.should == 2
+  end
+
+  it "should allow direct access to individual chunks" do
+    resources = subject[1]
+    numbers = resources.map { |resource| resource.number }
+
+    numbers.should == (11..20).to_a
+  end
+
+  it "should allow direct access to a range of chunks" do
+    resources = subject[1..2]
+    numbers = resources.map { |resource| resource.number }
+
+    numbers.should == (11..30).to_a
+  end
+
+  it "should allow enumerating through every chunk" do
+    resources = []
+    subject.each { |chunk| resources += chunk }
+
+    TestModel.all.should == resources
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+require 'rspec'
+require 'dm-core/spec/setup'
+require 'dm-core/spec/lib/adapter_helpers'
+
+require 'dm-chunked_query'
+
+class TestModel
+
+  include DataMapper::Resource
+
+  property :id, Serial
+
+  property :number, Integer
+
+end
+
+DataMapper::Spec.setup
+
+RSpec.configure do |config|
+  config.extend(DataMapper::Spec::Adapters::Helpers)
+
+  config.before(:suite) do
+    TestModel.auto_migrate!
+
+    (1..100).each { |i| TestModel.create(:number => i) }
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: dm-chunked_query
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-02 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: dm-aggregates
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: ore-tasks
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.4"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+description: Allows performing chunked queries on DataMapper Models or Collections.
+email: 
+- postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- ChangeLog.md
+- LICENSE.txt
+files: 
+- .document
+- .rspec
+- .yardopts
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dm-chunked_query.gemspec
+- gemspec.yml
+- lib/dm-chunked_query.rb
+- lib/dm-chunked_query/chunks.rb
+- lib/dm-chunked_query/mixin.rb
+- spec/chunked_query_spec.rb
+- spec/chunks_spec.rb
+- spec/spec_helper.rb
+has_rdoc: yard
+homepage: http://github.com/postmodern/dm-chunked_query
+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"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: dm-chunked_query
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Allows performing chunked queries with DataMapper.
+test_files: 
+- spec/chunks_spec.rb
+- spec/chunked_query_spec.rb