dm-is-predefined 0.3.1 → 0.4.0

data/ChangeLog.md

@@ -1,3 +1,18 @@
+### 0.4.0 / 2011-07-28
+
+* Added {DataMapper::Is::Predefined::MigrationMethods}.
+  * Overrides `auto_migrate!` and `auto_upgrade!` to auto-predefine
+    the resources after auto-migrations.
+* Added {DataMapper::Is::Predefined::ClassMethods#predefine!}.
+* Added {DataMapper::Is::Predefined::ClassMethods#predefined}.
+* Added {DataMapper::Is::Predefined::ClassMethods#predefined?}.
+* Added {DataMapper::Is::Predefined::ClassMethods#first_or_predefined}.
+* Made {DataMapper::Is::Predefined::ClassMethods#predefined_attributes} public.
+* Deprecated {DataMapper::Is::Predefined::ClassMethods#predefined_resource_with}
+  in favor of {DataMapper::Is::Predefined::ClassMethods#first_or_predefined}.
+* Deprecated {DataMapper::Is::Predefined::ClassMethods#predefined_names}
+  in favor of {DataMapper::Is::Predefined::ClassMethods#predefined}.
+
 ### 0.3.1 / 2011-02-28
 
 * Require dm-core ~> 1.0.

data/Gemfile

@@ -99,7 +99,7 @@ end
 gem 'dm-core',	DM_VERSION, :git => "#{DATAMAPPER}/dm-core.git"
 
 group :development do
-  gem 'rake',		    '~> 0.8.7'
+  gem 'rake',		    '~> 0.8'
 
   gem 'ore-tasks',	'~> 0.4'
   gem 'rspec',      '~> 2.4'

data/README.md

@@ -34,25 +34,29 @@ A DataMapper plugin for adding predefined resources to Models.
   
     end
   
+ 
+    License.predefined
+    # => [:gpl2, :mit]
+
+    License.predefined?(:gpl2)
+    # => true
+
     Licence.gpl2
     # => #<Licence: id: 1, name: "GPL-2", url: "http://www.gnu.org/copyleft/gpl.html">
-  
+
     Licence.predefined_resource(:mit)
     # => #<Licence: id: 2, name: "MIT">
 
-    License.predefined_resource_with(:name => 'GPL-2')
+    License.first_or_predefined(:name => 'GPL-2')
     # => #<License: id: 1, name: "GPL-2", url: "http://www.gnu.org/copyleft/gpl.html">
 
-    License.predefined_names
-    # => [:gpl2, :mit]
-
 ## Requirements
 
 * [dm-core](http://github.com/datamapper/dm-core/) ~> 1.0
 
 ## Install
 
-    $ sudo gem install dm-is-predefined
+    $ gem install dm-is-predefined
 
 ## License
 

data/Rakefile

@@ -3,16 +3,16 @@ require 'rubygems'
 begin
   require 'bundler'
 rescue LoadError => e
-  STDERR.puts e.message
-  STDERR.puts "Run `gem install bundler` to install Bundler."
+  warn e.message
+  warn "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"
+  warn e.message
+  warn "Run `bundle install` to install missing gems"
   exit e.status_code
 end
 

data/dm-is-predefined.gemspec

@@ -1,15 +1,127 @@
-# -*- 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."
+# encoding: utf-8
+
+require 'yaml'
+
+Gem::Specification.new do |gemspec|
+  files = if File.directory?('.git')
+            `git ls-files`.split($/)
+          elsif File.directory?('.hg')
+            `hg manifest`.split($/)
+          elsif File.directory?('.svn')
+            `svn ls -R`.split($/).select { |path| File.file?(path) }
+          else
+            Dir['{**/}{.*,*}'].select { |path| File.file?(path) }
+          end
+
+  filter_files = lambda { |paths|
+    case paths
+    when Array
+      (files & paths)
+    when String
+      (files & Dir[paths])
+    end
+  }
+
+  version = {
+    :file => 'lib/dm-is-predefined/version.rb',
+    :constant => 'DataMapper::Is::Predefined::VERSION'
+  }
+
+  defaults = {
+    'name' => File.basename(File.dirname(__FILE__)),
+    'files' => files,
+    'executables' => filter_files['bin/*'].map { |path| File.basename(path) },
+    'test_files' => filter_files['{test/{**/}*_test.rb,spec/{**/}*_spec.rb}'],
+    'extra_doc_files' => filter_files['*.{txt,rdoc,md,markdown,tt,textile}'],
+  }
+
+  metadata = defaults.merge(YAML.load_file('gemspec.yml'))
+
+  gemspec.name = metadata.fetch('name',defaults[:name])
+  gemspec.version = if metadata['version']
+                      metadata['version']
+                    elsif File.file?(version[:file])
+                      require File.join('.',version[:file])
+                      eval(version[:constant])
+                    end
+
+  gemspec.summary = metadata.fetch('summary',metadata['description'])
+  gemspec.description = metadata.fetch('description',metadata['summary'])
+
+  case metadata['license']
+  when Array
+    gemspec.licenses = metadata['license']
+  when String
+    gemspec.license = metadata['license']
+  end
+
+  case metadata['authors']
+  when Array
+    gemspec.authors = metadata['authors']
+  when String
+    gemspec.author = metadata['authors']
+  end
+
+  gemspec.email = metadata['email']
+  gemspec.homepage = metadata['homepage']
+
+  case metadata['require_paths']
+  when Array
+    gemspec.require_paths = metadata['require_paths']
+  when String
+    gemspec.require_path = metadata['require_paths']
+  end
+
+  gemspec.files = filter_files[metadata['files']]
+
+  gemspec.executables = metadata['executables']
+  gemspec.extensions = metadata['extensions']
+
+  if Gem::VERSION < '1.7.'
+    gemspec.default_executable = gemspec.executables.first
+  end
+
+  gemspec.test_files = filter_files[metadata['test_files']]
+
+  unless gemspec.files.include?('.document')
+    gemspec.extra_rdoc_files = metadata['extra_doc_files']
+  end
+
+  gemspec.post_install_message = metadata['post_install_message']
+  gemspec.requirements = metadata['requirements']
+
+  if gemspec.respond_to?(:required_ruby_version=)
+    gemspec.required_ruby_version = metadata['required_ruby_version']
+  end
+
+  if gemspec.respond_to?(:required_rubygems_version=)
+    gemspec.required_rubygems_version = metadata['required_ruby_version']
+  end
+
+  parse_versions = lambda { |versions|
+    case versions
+    when Array
+      versions.map { |v| v.to_s }
+    when String
+      versions.split(/,\s*/)
+    end
+  }
+
+  if metadata['dependencies']
+    metadata['dependencies'].each do |name,versions|
+      gemspec.add_dependency(name,parse_versions[versions])  
+    end
+  end
+
+  if metadata['runtime_dependencies']
+    metadata['runtime_dependencies'].each do |name,versions|
+      gemspec.add_runtime_dependency(name,parse_versions[versions])  
+    end
+  end
+
+  if metadata['development_dependencies']
+    metadata['development_dependencies'].each do |name,versions|
+      gemspec.add_development_dependency(name,parse_versions[versions])  
+    end
   end
 end

data/gemspec.yml

@@ -1,5 +1,5 @@
 name: dm-is-predefined
-version: 0.3.1
+version: 0.4.0
 summary: DataMapper plugin for adding predefined resources to models.
 description:
   A DataMapper plugin for adding predefined resources to Models.
@@ -15,4 +15,4 @@ dependencies:
 
 development_dependencies:
   bundler: ~> 1.0.0
-  yard: ~> 0.6.0
+  yard: ~> 0.7.0

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

@@ -4,94 +4,225 @@ module DataMapper
   module Is
     module Predefined
       #
-      # Fired when your plugin gets included into Resource.
+      # Fired when your plugin gets included into a Model.
+      #
+      # @note
+      #   If the model already includes `DataMapper::Migrations`, then
+      #   {MigrationMethods} will be extended into the Model.
+      #
+      # @api private
       #
       def is_predefined
         extend DataMapper::Is::Predefined::ClassMethods
+
+        if defined?(DataMapper::Migrations) &&
+           included_modules.include?(DataMapper::Migrations)
+          extend MigrationMethods
+        end
+      end
+
+      #
+      # @since 0.4.0
+      #
+      module MigrationMethods
+        #
+        # Auto-migrates the model, then creates all predefined resources.
+        #
+        # @param [Symbol] repository_name
+        #   The repository to perform the migrations within.
+        #
+        # @return [true]
+        #
+        # @api public
+        #
+        def auto_migrate!(repository_name=self.repository_name)
+          result = super(repository_name)
+
+          predefine!(repository_name)
+          return result
+        end
+
+        #
+        # Auto-upgrades the model, then creates any missing predefined
+        # resources.
+        #
+        # @param [Symbol] repository_name
+        #   The repository to perform the upgrade within.
+        #
+        # @return [true]
+        #
+        # @api public
+        #
+        def auto_upgrade!(repository_name=self.repository_name)
+          result = super(repository_name)
+
+          predefine!(repository_name)
+          return result
+        end
       end
 
       module ClassMethods
+        #
+        # All pre-defined resources of the model.
+        #
+        # @return [Hash{Symbol => Hash}]
+        #   The Hash of pre-defined resources and their attributes.
+        #
+        # @api semipublic
+        #
+        def predefined_attributes
+          @predefined_attributes ||= {}
+        end
+
         #
         # Returns the names of the predefined resources.
         #
         # @return [Array<Symbol>]
         #   The names of the predefined resources.
         #
+        # @since 0.4.0
+        #
+        # @api public
+        #
+        def predefined
+          predefined_attributes.keys
+        end
+
+        #
+        # @see #predefined
+        #
+        # @deprecated Will be removed in 1.0.0.
+        #
         # @since 0.2.1
         #
         def predefined_names
-          predefined_attributes.keys
+          predefined
         end
 
         #
-        # Finds or auto-creates the pre-defined resource with the given name.
+        # Determines if a resource was predefined.
+        #
+        # @param [Symbol, String] name
+        #   The name of the predefined resource to search for.
+        #
+        # @return [Boolean]
+        #   Specifies whether the resource was predefined.
+        #
+        # @since 0.4.0
+        #
+        # @api public
+        #
+        def predefined?(name)
+          predefined_attributes.has_key?(name.to_sym)
+        end
+
+        #
+        # Finds or auto-creates the pre-defined resource with the given
+        # name.
         #
         # @param [Symbol, String] name
         #   The name of the pre-defined resource.
         #
+        # @param [Hash{Symbol => Object}] extra_attributes
+        #   Additional attributes to add to the predefined resource.
+        #
         # @return [DataMapper::Resource]
         #   The pre-defined resource.
         #
         # @raise [UnknownResource]
-        #   Indicates that there are no predefined attributes for the resource
-        #   with the given name.
+        #   Indicates that there are no predefined attributes for the
+        #   resource with the given name.
         #
         # @since 0.2.1
         #
+        # @api public
+        #
         def predefined_resource(name)
           name = name.to_sym
-          attributes = self.predefined_attributes[name]
 
-          unless attributes
-            raise(UnknownResource,"The resource '#{name}' was not predefined",caller)
+          unless predefined?(name)
+            raise(UnknownResource,"The resource '#{name}' was not predefined")
           end
 
-          self.first_or_create(attributes)
+          return first_or_create(predefined_attributes[name])
         end
 
         #
         # Finds or auto-creates the predefined resource which shares the
         # given attributes.
         #
-        # @param [Hash{Symbol => Object}] desired_attributes
+        # @param [Hash{Symbol => Object}] conditions
+        #   Query conditions.
+        #
+        # @param [Hash{Symbol => Object}] attributes
         #   The attribute names and values that the predefined resource
         #   should shared.
         #
-        # @return [DataMapper::Resource]
+        # @return [DataMapper::Resource, nil]
         #   The predefined resource.
+        #
+        # @since 0.4.0
+        #
+        # @api public
+        #
+        def first_or_predefined(conditions={},attributes=conditions)
+          if (resource = first(conditions))
+            return resource
+          end
+
+          # if the resource wasn't found, search for matching
+          # predefined attributes
+          attributes = predefined_attributes.values.find do |attrs|
+            attrs.all? do |name,value|
+              attributes.has_key?(name) && (attributes[name] == value)
+            end
+          end
+
+          # create the resource using the predefined attributes
+          create(attributes) if attributes
+        end
+
         #
         # @raise [UnknownResource]
         #   Could not find a predefined resource that shared all of the
         #   desired attributes.
         #
+        # @deprecated
+        #   Will be removed in 1.0.0. Use {#first_or_predefined} instead.
+        #
         # @since 0.2.1
         #
-        def predefined_resource_with(desired_attributes={})
-          self.predefined_attributes.each do |name,attributes|
-            shares_attributes = desired_attributes.all? do |key,value|
-              key = key.to_sym
-
-              attributes.has_key?(key) && (attributes[key] == value)
-            end
-
-            return predefined_resource(name) if shares_attributes
+        # @api public
+        #
+        def predefined_resource_with(query={})
+          unless (resource = first_or_predefined(query))
+            # no pre-existing or predefined resource matching the query
+            raise(UnknownResource,"Could not find a predefined resource which shared the given attributes")
           end
 
-          raise(UnknownResource,"Could not find a predefined resource which shared the given attributes",caller)
+          return resource
         end
 
-        protected
-
         #
-        # All pre-defined resources of the model.
+        # Creates the predefined resources.
         #
-        # @return [Hash{Symbol => Hash}]
-        #   The Hash of pre-defined resources and their attributes.
+        # @param [Symbol] repository_name
+        #   The repository to perform the upgrade within.
         #
-        def predefined_attributes
-          @predefined_attributes ||= {}
+        # @since 0.4.0
+        #
+        # @api public
+        #
+        def predefine!(repository_name=self.repository_name)
+          DataMapper.repository(repository_name) do
+            predefined_attributes.each_value do |attributes|
+              first_or_create(attributes)
+            end
+          end
         end
 
+        protected
+
         #
         # Defines a new pre-defined resource for the model.
         #
@@ -102,26 +233,29 @@ module DataMapper
         #   The attributes for the pre-defined resource.
         #
         # @return [Hash]
-        #   The attributes that will be assigned to the pre-defined resource.
+        #   The attributes that will be assigned to the pre-defined
+        #   resource.
+        #
+        # @api public
         #
         def predefine(name,attributes={})
-          name = name.to_s
+          name = name.to_sym
 
           if attributes.empty?
-            raise(ArgumentError,"Cannot predefine a resource with no attributes",caller)
+            raise(ArgumentError,"Cannot predefine a resource with no attributes")
           end
 
-          self.predefined_attributes[name.to_sym] = attributes
+          predefined_attributes[name] = attributes
 
           class_eval %{
             class << self
-              define_method(#{name.dump}) do
-                predefined_resource(#{name.dump})
+              define_method(#{name.inspect}) do
+                predefined_resource(#{name.inspect})
               end
             end
           }
 
-          attributes
+          return attributes
         end
       end # ClassMethods
     end # Predefined

data/spec/integration/models/migrated_model.rb

@@ -0,0 +1,19 @@
+require 'dm-is-predefined'
+
+class MigratedModel
+
+  include DataMapper::Resource
+  include DataMapper::Migrations
+
+  is :predefined
+
+  # Primary key of the test model
+  property :id, Serial
+
+  # Name property to test String values
+  property :name, String
+
+  predefine :test1, :name => 'test1'
+  predefine :test2, :name => 'test2'
+
+end

data/spec/integration/predefined_spec.rb

@@ -1,17 +1,56 @@
 require 'spec_helper'
 require 'integration/models/test_model'
+require 'integration/models/migrated_model'
 
 describe DataMapper::Is::Predefined do
   before(:all) do
     TestModel.auto_migrate!
   end
 
+  context "migrations" do
+    it "should extend MigrationMethods, if Migrations are included" do
+      TestModel.should_not be_kind_of(DataMapper::Is::Predefined::MigrationMethods)
+      MigratedModel.should be_kind_of(DataMapper::Is::Predefined::MigrationMethods)
+    end
+
+    it "should create all predefined resources after auto_migrate!" do
+      MigratedModel.auto_migrate!
+
+      resources = MigratedModel.all
+
+      resources[0].id.should == 1
+      resources[0].name.should == 'test1'
+
+      resources[1].id.should == 2
+      resources[1].name.should == 'test2'
+    end
+
+    it "should create missing predefined resources after auto_upgrade!" do
+      MigratedModel.first(:name => 'test2').destroy!
+
+      MigratedModel.property :extra, String
+      MigratedModel.auto_upgrade!
+
+      resources = MigratedModel.all
+
+      resources[0].id.should == 1
+      resources[0].name.should == 'test1'
+
+      resources[1].id.should == 3
+      resources[1].name.should == 'test2'
+    end
+  end
+
   it "should define the @predefined_attributes instance variable" do
     TestModel.should be_instance_variable_defined(:@predefined_attributes)
   end
 
   it "should provide the names of all predefined resources of a Model" do
-    TestModel.predefined_names.should =~ [:test1, :test2]
+    TestModel.predefined.should =~ [:test1, :test2]
+  end
+
+  it "should determine if a predefined resource was defined" do
+    TestModel.should be_predefined(:test2)
   end
 
   it "should be able to define resources of a Model" do
@@ -56,34 +95,33 @@ describe DataMapper::Is::Predefined do
     end
   end
 
-  describe "predefined_resource_with" do
+  describe "first_or_predefined" do
     it "should find resources based on attributes they share" do
-      test2 = TestModel.predefined_resource_with(:name => 'test2', :number => 2)
+      test2 = TestModel.first_or_predefined(:name => 'test2', :number => 2)
 
       test2.name.should == 'test2'
     end
 
-    it "should raise UnknownResource if no resource shares all attribute names" do
-      lambda {
-        TestModel.predefined_resource_with(:number => 1, :missing => 'yo')
-      }.should raise_error(DataMapper::Is::Predefined::UnknownResource)
-    end
+    it "should allow specifying different query and predefined attributes" do
+      test2 = TestModel.first_or_predefined(
+        {:name.like => '%test2%'},
+        {:name => 'test2', :number => 2}
+      )
 
-    it "should raise UnknownResource if no resource shares any attribute names" do
-      lambda {
-        TestModel.predefined_resource_with(:missing => 1, :typo => 'yo')
-      }.should raise_error(DataMapper::Is::Predefined::UnknownResource)
+      test2.name.should == 'test2'
     end
 
-    it "should raise UnknownResource if no resource shares all attribute values" do
-      lambda {
-        TestModel.predefined_resource_with(:number => 2, :optional => 'yo')
-      }.should raise_error(DataMapper::Is::Predefined::UnknownResource)
+    it "should return nil if no resource shares any attribute values" do
+      resource = TestModel.first_or_predefined(:number => 100, :optional => 'bla')
+      
+      resource.should be_nil
     end
+  end
 
+  describe "predefined_resource_with" do
     it "should raise UnknownResource if no resource shares any attribute values" do
       lambda {
-        TestModel.predefined_resource_with(:number => 3, :optional => 'bla')
+        TestModel.predefined_resource_with(:number => 100, :optional => 'bla')
       }.should raise_error(DataMapper::Is::Predefined::UnknownResource)
     end
   end

metadata

@@ -1,63 +1,60 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: dm-is-predefined
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.4.0
   prerelease: 
-  version: 0.3.1
 platform: ruby
-authors: 
+authors:
 - Postmodern
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-28 00:00:00 -08:00
+date: 2011-07-28 00:00:00.000000000 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: dm-core
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &11760400 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: "1.0"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
+  version_requirements: *11760400
+- !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &11758740 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
+      - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
+  version_requirements: *11758740
+- !ruby/object:Gem::Dependency
   name: yard
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &11757200 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        version: 0.6.0
+      - !ruby/object:Gem::Version
+        version: 0.7.0
   type: :development
   prerelease: false
-  version_requirements: *id003
+  version_requirements: *11757200
 description: A DataMapper plugin for adding predefined resources to Models.
-email: 
+email:
 - postmodern.mod3@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
 - ChangeLog.md
 - LICENSE.txt
-files: 
+files:
 - .document
 - .rspec
 - .yardopts
@@ -71,36 +68,35 @@ files:
 - lib/dm-is-predefined.rb
 - lib/dm-is-predefined/is/exceptions/unknown_resource.rb
 - lib/dm-is-predefined/is/predefined.rb
+- spec/integration/models/migrated_model.rb
 - spec/integration/models/test_model.rb
 - spec/integration/predefined_spec.rb
 - spec/spec_helper.rb
 has_rdoc: yard
 homepage: http://github.com/postmodern/dm-is-predefined
-licenses: 
+licenses:
 - MIT
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
-
 rubyforge_project: dm-is-predefined
-rubygems_version: 1.5.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: DataMapper plugin for adding predefined resources to models.
-test_files: 
+test_files:
 - spec/integration/predefined_spec.rb