dm-predefined 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 / 2008-12-21
+
+* Initial release.
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 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/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+LICENSE.txt
+Manifest.txt
+README.txt
+Rakefile
+TODO.txt
+lib/dm-predefined.rb
+lib/dm-predefined/predefined.rb
+lib/dm-predefined/version.rb
+lib/dm-predefined/exceptions/unknown_resource.rb
+spec/integration/predefined_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,63 @@
+= dm-predefined
+
+* http://dm-predefined.rubyforge.org/
+* https://github.com/postmodern/dm-predefined
+* Postmodern (postmodern.mod3 at gmail.com)
+
+== DESCRIPTION:
+
+A DataMapper plugin for adding predefined resources to Models.
+
+== EXAMPLES:
+
+  require 'dm-core'
+  require 'dm-predefined'
+  
+  class Licence
+  
+    include DataMapper::Resource
+    include DataMapper::Predefined
+    
+    # Name of the Licence
+    property :name, String
+    
+    # URL to the licence
+    property :url, String
+    
+    define :gpl2, :name => 'GPL-2', :url => 'http://www.gnu.org/copyleft/gpl.html'
+    define :mit, :name => 'MIT'
+  
+  end
+  
+  Licence.gpl2
+  # => #<Licence: id: 1, name: "GPL-2", url: "http://www.gnu.org/copyleft/gpl.html">
+  
+  Licence[:mit]
+  # => #<Licence: id: 2, name: "MIT">
+
+== INSTALL:
+
+  $ sudo gem install dm-predefined
+
+== LICENSE:
+
+Copyright (c) 2008 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/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './tasks/spec.rb'
+require './lib/dm-predefined/version.rb'
+
+Hoe.new('dm-predefined', DataMapper::Predefined::VERSION) do |p|
+  p.rubyforge_name = 'dm-predefined'
+  p.developer('Postmodern','postmodern.mod3@gmail.com')
+  p.remote_rdoc_dir = ''
+  p.extra_deps = [['dm-core', '>=0.9.8']]
+end
+
+# vim: syntax=Ruby

data/lib/dm-predefined.rb

@@ -0,0 +1,20 @@
+# Needed to import datamapper and other gems
+require 'rubygems'
+require 'pathname'
+
+# Add all external dependencies for the plugin here
+gem 'dm-core', '~>0.9.8'
+require 'dm-core'
+
+# Require plugin-files
+require Pathname(__FILE__).dirname.expand_path / 'dm-predefined' / 'predefined.rb'
+
+
+# Include the plugin in Resource
+module DataMapper
+  module Resource
+    module ClassMethods
+      include DataMapper::Predefined
+    end # module ClassMethods
+  end # module Resource
+end # module DataMapper

data/lib/dm-predefined/exceptions/unknown_resource.rb

@@ -0,0 +1,6 @@
+module DataMapper
+  module Predefined
+    class UnknownResource < RuntimeError
+    end
+  end
+end

data/lib/dm-predefined/predefined.rb

@@ -0,0 +1,47 @@
+require 'dm-predefined/exceptions/unknown_resource'
+
+module DataMapper
+  module Predefined
+    ##
+    # fired when your plugin gets included into Resource
+    #
+    def self.included(base)
+      base.extend DataMapper::Predefined::ClassMethods
+    end
+
+    module ClassMethods
+      def [](name)
+        name = name.to_sym
+        attributes = predefined_attributes[name]
+
+        unless attributes
+          raise(UnknownResource,"the resource '#{name}' was not predefined",caller)
+        end
+
+        first_or_create(predefined_attributes[name.to_sym])
+      end
+
+      protected
+
+      def predefined_attributes
+        @@predefined_attributes ||= {}
+      end
+
+      def define(name,attributes={})
+        name = name.to_s
+
+        predefined_attributes[name.to_sym] = attributes
+
+        class_eval %{
+          class << self
+            define_method(#{name.dump}) do
+              self[#{name.dump}]
+            end
+          end
+        }
+
+        attributes
+      end
+    end # ClassMethods
+  end # Predefined
+end # DataMapper

data/lib/dm-predefined/version.rb

@@ -0,0 +1,5 @@
+module DataMapper
+  module Predefined
+    VERSION = '0.0.1'
+  end
+end

data/spec/integration/predefined_spec.rb

@@ -0,0 +1,75 @@
+require 'pathname'
+require Pathname(__FILE__).dirname.expand_path.parent + 'spec_helper'
+
+if (HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES)
+  describe 'DataMapper::Predefined' do
+    before(:all) do
+      class TestModel
+
+        include DataMapper::Resource
+        include DataMapper::Predefined
+
+        # Name property to test String values
+        property :name, String
+
+        # Number property to test Integer values
+        property :number, Integer
+
+        # Optional property to test default values
+        property :optional, String, :default => 'hello'
+
+        # Body property to test Text values
+        property :body, Text
+
+        define :test1, :name => 'test1',
+                       :number => 1,
+                       :optional => 'yo',
+                       :body => %{This is a test.}
+
+        define :test2, :name => 'test2', :number => 2
+      end
+
+      TestModel.auto_migrate!
+    end
+
+    it "should be able to define resources of a Model" do
+      test1 = TestModel.test1
+
+      test1.should_not be_nil
+      test1.name.should == 'test1'
+      test1.number.should == 1
+      test1.optional.should == 'yo'
+      test1.body.should == %{This is a test.}
+    end
+
+    it "should be able to define resources with empty attributes" do
+      test2 = TestModel.test2
+
+      test2.should_not be_nil
+      test2.name.should == 'test2'
+      test2.number.should == 2
+      test2.optional.should == 'hello'
+      test2.body.should be_nil
+    end
+
+    it "should return existing resources" do
+      first_test1 = TestModel.test1
+      second_test1 = TestModel.test1
+
+      first_test1.id.should == second_test1.id
+    end
+
+    it "should provide a generic interface for accessing resources" do
+      test1 = TestModel[:test1]
+
+      test1.name.should == 'test1'
+      test1.number.should == 1
+    end
+
+    it "should raise an UnknownResource exception when accessing undefined resources" do
+      lambda {
+        TestModel[:test3]
+      }.should raise_error(DataMapper::Predefined::UnknownResource)
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'pathname'
+require 'rubygems'
+
+gem 'rspec', '~>1.1.11'
+require 'spec'
+
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/dm-predefined'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  begin
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue LoadError => e
+    warn "Could not load do_#{name}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: dm-predefined
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-21 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: A DataMapper plugin for adding predefined resources to Models.
+email: 
+- postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
+- TODO.txt
+files: 
+- History.txt
+- LICENSE.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- TODO.txt
+- lib/dm-predefined.rb
+- lib/dm-predefined/predefined.rb
+- lib/dm-predefined/version.rb
+- lib/dm-predefined/exceptions/unknown_resource.rb
+- spec/integration/predefined_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://dm-predefined.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: dm-predefined
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: A DataMapper plugin for adding predefined resources to Models.
+test_files: []
+