dm-is-indexed 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-is-indexed Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2011-03-21
+
+* Initial release.
+

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,65 @@
+# dm-is-indexed
+
+* [Homepage](http://github.com/postmodern/dm-is-indexed#readme)
+* [Issues](http://github.com/postmodern/dm-is-indexed/issues)
+* [Documentation](http://rubydoc.info/gems/dm-is-indexed/frames)
+* [Email](mailto:postmodern.mod3 at gmail.com)
+
+## Description
+
+dm-is-indexed overloads the `Model[]` method, and allows querying Resources
+using their indexed properties.
+
+## Examples
+
+    require 'dm-is-indexed'
+
+    class Atom
+
+      include DataMapper::Resource
+
+      is :indexed
+
+      property :id, Serial
+
+      property :symbol, String, :unique => true
+
+      property :name, String, :unique => true
+
+      property :atomic_weight, Float, :index => true
+
+    end
+
+Traditional Array style access is preserved:
+
+    Atom[0]
+    # => #<Atom: @id=1 @symbol="He" @name="Helium" @atomic_weight=4.002602>
+
+    Atom[0,1]
+    # => [#<Atom: @id=1 @symbol="He" @name="Helium" @atomic_weight=4.002602>,
+          #<Atom: @id=2 @symbol="Ne" @name="Neon" @atomic_weight=20.1797>]
+
+Query Resources based on their unique indexed properties:
+
+    Atom["Kr"]
+    # => #<Atom: @id=4 @symbol="Kr" @name="Krpton" @atomic_weight=83.798>
+
+    Atom["Krpton"]
+    # => #<Atom: @id=4 @symbol="Kr" @name="Krpton" @atomic_weight=83.798>
+
+    Atom[83.798]
+    # => #<Atom: @id=4 @symbol="Kr" @name="Krpton" @atomic_weight=83.798>
+
+## Requirements
+
+* [dm-core](http://github.com/datamapper/dm-core#readme) ~> 1.0
+
+## Install
+
+    $ gem install dm-is-indexed
+
+## Copyright
+
+Copyright (c) 2011 Hal Brodigan
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,33 @@
+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 :test => :spec
+task :default => :spec
+
+
+require 'yard'
+YARD::Rake::YardocTask.new  
+task :doc => :yard

data/dm-is-indexed.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,19 @@
+name: dm-is-indexed
+version: 0.1.0
+summary: Query DataMapper Resources via their indexed properties.
+description:
+  dm-is-indexed overloads the Model[] method, and allows querying Resources
+  using their indexed properties.
+
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/dm-is-indexed
+has_yard: true
+
+dependencies:
+  dm-core: ~> 1.0
+
+development_dependencies:
+  bundler: ~> 1.0.0
+  yard: ~> 0.6.0

data/lib/dm-is-indexed/is/indexed.rb

@@ -0,0 +1,51 @@
+module DataMapper
+  module Is
+    module Indexed
+      #
+      # Fired when your plugin gets included into a Model.
+      #
+      def is_indexed
+        extend DataMapper::Is::Indexed::ClassMethods
+      end
+
+      module ClassMethods
+        #
+        # Allows querying the indexed properties of a Model.
+        #
+        # @param [Array, Range, Integer, Object] keys
+        #   The key to use when querying the Model. If the key is an Integer
+        #   or a Range, it will select multiple Resources of the Model.
+        #
+        # @return [DataMapper::Collection, DataMapper::Resource, nil]
+        #   The selected Resource or Resources.
+        #
+        def [](*keys)
+          if keys.length > 1
+            super(*keys)
+          else
+            key = keys[0]
+            
+            case key
+            when Integer, Range
+              super(*keys)
+            else
+              resource = nil
+
+              properties.each do |field|
+                if (field.index || field.unique?)
+                  if field.primitive?(key)
+                    resource = first(field => key)
+
+                    break if resource
+                  end
+                end
+              end
+
+              return resource
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/dm-is-indexed.rb

@@ -0,0 +1,4 @@
+require 'dm-core'
+require 'dm-is-indexed/is/indexed'
+
+DataMapper::Model.append_extensions DataMapper::Is::Indexed

data/spec/integration/indexed_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+require 'integration/models/atom'
+
+describe DataMapper::Is::Indexed do
+  before(:all) do
+    Atom.auto_migrate!
+
+    Atom.create(
+      :symbol => 'He',
+      :name => 'Helium',
+      :atomic_weight => 4.002602
+    )
+
+    Atom.create(
+      :symbol => 'Ne',
+      :name => 'Neon',
+      :atomic_weight => 20.1797
+    )
+
+    Atom.create(
+      :symbol => 'Ar',
+      :name => 'Argon',
+      :atomic_weight => 39.948
+    )
+
+    Atom.create(
+      :symbol => 'Kr',
+      :name => 'Krypton',
+      :atomic_weight => 83.798
+    )
+
+    Atom.create(
+      :symbol => 'Xe',
+      :name => 'Xeon',
+      :atomic_weight => 131.293
+    )
+
+    Atom.create(
+      :symbol => 'Rn',
+      :name => 'Radon',
+      :atomic_weight => 222.0
+    )
+
+    Atom.create(
+      :symbol => 'Uuo',
+      :name => 'Ununoctium',
+      :atomic_weight => 294.0
+    )
+  end
+
+  describe "Model.[]" do
+    subject { Atom }
+
+    it "should still allow selecting the nth resource" do
+      subject[0].symbol.should == 'He'
+    end
+
+    it "should still allowing selecting multiple resources" do
+      resources = subject[0,1]
+
+      resources[0].symbol.should == 'He'
+      resources[1].symbol.should == 'Ne'
+    end
+
+    it "should still allowing selecting ranges of resources" do
+      resources = subject[0..1]
+
+      resources[0].symbol.should == 'He'
+      resources[1].symbol.should == 'Ne'
+    end
+
+    it "should allow querying properties with unique indexes" do
+      subject['Ne'].name.should == 'Neon'
+    end
+
+    it "should query every property with an index" do
+      subject['Neon'].symbol.should == 'Ne'
+    end
+
+    it "should query properties with a non-unique index" do
+      subject[83.798].symbol.should == 'Kr'
+    end
+
+    it "should select the properties to query based on the key type" do
+      subject[83.798].symbol.should == 'Kr'
+    end
+  end
+end

data/spec/integration/models/atom.rb

@@ -0,0 +1,18 @@
+require 'dm-core'
+require 'dm-is-indexed'
+
+class Atom
+
+  include DataMapper::Resource
+
+  is :indexed
+
+  property :id, Serial
+
+  property :symbol, String, :unique => true
+
+  property :name, String, :unique => true
+
+  property :atomic_weight, Float, :index => true
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+require 'dm-core/spec/setup'
+require 'dm-core/spec/lib/adapter_helpers'
+
+require 'dm-is-indexed'
+
+DataMapper::Logger.new(STDERR, :debug) if ENV['DEBUG']
+DataMapper::Spec.setup
+
+RSpec.configure do |config|
+  config.extend(DataMapper::Spec::Adapters::Helpers)
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification 
+name: dm-is-indexed
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-21 00:00:00 -04: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: bundler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+description: dm-is-indexed overloads the Model[] method, and allows querying Resources using their indexed properties.
+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-is-indexed.gemspec
+- gemspec.yml
+- lib/dm-is-indexed.rb
+- lib/dm-is-indexed/is/indexed.rb
+- spec/integration/indexed_spec.rb
+- spec/integration/models/atom.rb
+- spec/spec_helper.rb
+has_rdoc: yard
+homepage: http://github.com/postmodern/dm-is-indexed
+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-is-indexed
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Query DataMapper Resources via their indexed properties.
+test_files: 
+- spec/integration/indexed_spec.rb