dm-predefined 0.1.1 → 0.2.0

data/History.txt

@@ -1,3 +1,12 @@
+=== 0.2.0 / 2009-09-21
+
+* Require Hoe >= 2.3.3.
+* Require YARD >= 0.2.3.5.
+* Require dm-core >= 0.10.0.
+* Moved to YARD based documentation.
+* Added YARD handlers for documenting +predefine+ method-calls.
+* Renamed Predefined.predefined to Predefined.predefine.
+
 === 0.1.1 / 2009-01-17
 
 * Fixed specs to work with RSpec 1.1.12.

data/Manifest.txt

@@ -5,9 +5,15 @@ README.txt
 Rakefile
 TODO.txt
 lib/dm-predefined.rb
+lib/dm-predefined/exceptions/unknown_resource.rb
 lib/dm-predefined/predefined.rb
 lib/dm-predefined/version.rb
-lib/dm-predefined/exceptions/unknown_resource.rb
-spec/integration/helpers/test_model.rb
+lib/dm-predefined/yard.rb
+lib/dm-predefined/yard/handlers.rb
+lib/dm-predefined/yard/handlers/ruby.rb
+lib/dm-predefined/yard/handlers/ruby/predefine_handler.rb
+lib/dm-predefined/yard/handlers/ruby/legacy.rb
+lib/dm-predefined/yard/handlers/ruby/legacy/predefine_handler.rb
+spec/integration/models/test_model.rb
 spec/integration/predefined_spec.rb
 spec/spec_helper.rb

data/README.txt

@@ -24,8 +24,11 @@ A DataMapper plugin for adding predefined resources to Models.
     # URL to the licence
     property :url, String
     
-    define :gpl2, :name => 'GPL-2', :url => 'http://www.gnu.org/copyleft/gpl.html'
-    define :mit, :name => 'MIT'
+    predefine :gpl2,
+              :name => 'GPL-2',
+              :url => 'http://www.gnu.org/copyleft/gpl.html'
+
+    predefine :mit, :name => 'MIT'
   
   end
   
@@ -35,13 +38,17 @@ A DataMapper plugin for adding predefined resources to Models.
   Licence[:mit]
   # => #<Licence: id: 2, name: "MIT">
 
+== REQUIREMENTS:
+
+* {YARD}[http://yard.soen.ca/] >= 0.2.3.5
+
 == INSTALL:
 
   $ sudo gem install dm-predefined
 
 == LICENSE:
 
-Copyright (c) 2008 Hal Brodigan
+Copyright (c) 2008-2009 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -2,14 +2,24 @@
 
 require 'rubygems'
 require 'hoe'
+require 'hoe/signing'
 require './tasks/spec.rb'
-require './lib/dm-predefined/version.rb'
+require './tasks/yard.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']]
+Hoe.spec('dm-predefined') do
+  self.rubyforge_name = 'dm-predefined'
+  self.developer('Postmodern','postmodern.mod3@gmail.com')
+  self.remote_rdoc_dir = ''
+  self.extra_deps = [
+    ['yard', '>=0.2.3.5'],
+    ['dm-core', '>=0.10.0']
+  ]
+
+  self.extra_dev_deps = [
+    ['rspec', '>=1.2.8']
+  ]
+
+  self.spec_extras = {:has_rdoc => 'yard'}
 end
 
 # vim: syntax=Ruby

data/lib/dm-predefined/predefined.rb

@@ -2,35 +2,64 @@ require 'dm-predefined/exceptions/unknown_resource'
 
 module DataMapper
   module Predefined
-    ##
-    # fired when your plugin gets included into Resource
+    #
+    # Fired when your plugin gets included into Resource.
     #
     def self.included(base)
       base.extend DataMapper::Predefined::ClassMethods
     end
 
     module ClassMethods
+      #
+      # Finds or auto-creates the pre-defined resource with the given name.
+      #
+      # @param [Symbol, String] name
+      #   The name of the pre-defined resource.
+      #
+      # @return [Object]
+      #   The pre-defined resource.
+      #
       def [](name)
         name = name.to_sym
-        attributes = predefined_attributes[name]
+        attributes = self.predefined_attributes[name]
 
         unless attributes
           raise(UnknownResource,"the resource '#{name}' was not predefined",caller)
         end
 
-        first_or_create(predefined_attributes[name.to_sym])
+        self.first_or_create(attributes)
       end
 
       protected
 
+      @@predefined_attributes = {}
+
+      #
+      # All pre-defined resources of the model.
+      #
+      # @return [Hash{Symbol => Hash}]
+      #   The Hash of pre-defined resources and their attributes.
+      #
       def predefined_attributes
-        @@predefined_attributes ||= {}
+        @@predefined_attributes
       end
 
-      def define(name,attributes={})
+      #
+      # Defines a new pre-defined resource for the model.
+      #
+      # @param [Symbol, String] name
+      #   The name of the pre-defined resource.
+      #
+      # @param [Hash] attributes
+      #   The attributes for the pre-defined resource.
+      #
+      # @return [Hash]
+      #   The attributes that will be assigned to the pre-defined resource.
+      #
+      def predefine(name,attributes={})
         name = name.to_s
 
-        predefined_attributes[name.to_sym] = attributes
+        self.predefined_attributes[name.to_sym] = attributes
 
         class_eval %{
           class << self

data/lib/dm-predefined/version.rb

@@ -1,5 +1,6 @@
 module DataMapper
   module Predefined
-    VERSION = '0.1.1'
+    # The version of dm-predefined
+    VERSION = '0.2.0'
   end
 end

data/lib/dm-predefined/yard/handlers/ruby/legacy/predefine_handler.rb

@@ -0,0 +1,26 @@
+require 'yard'
+
+module YARD
+  module Handlers
+    module Ruby
+      module Legacy
+        class PredefineHandler < Base
+
+          handles /\Apredefine\s/
+
+          def process
+            nobj = namespace
+            name = statement.tokens[2,1].to_s[1..-1]
+
+            register MethodObject.new(nobj, name, :class) do |o|
+              o.visibility = :public
+              o.source = statement.source
+              o.signature = "def #{nobj}.#{name}"
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/dm-predefined/yard/handlers/ruby/legacy.rb

@@ -0,0 +1 @@
+require 'dm-predefined/yard/handlers/ruby/legacy/predefine_handler'

data/lib/dm-predefined/yard/handlers/ruby/predefine_handler.rb

@@ -0,0 +1,35 @@
+require 'yard'
+
+module YARD
+  module Handlers
+    module Ruby
+      class PredefineHandler < Base
+
+        handles method_call(:predefine)
+
+        def process
+          nobj = namespace
+          name = if statement.type == :predefine
+                   statement.jump(:ident, :op, :kw, :const).source
+                 elsif statement.call?
+                   obj = statement.parameters(false).first
+
+                   case obj.type
+                   when :symbol_literal
+                     obj.jump(:ident, :op, :kw, :const).source
+                   when :string_literal
+                     obj.jump(:string_content).source
+                   end
+                 end
+
+          register MethodObject.new(nobj, name, :class) do |o|
+            o.visibility = :public
+            o.source = statement.source
+            o.signature = "def #{nobj}.#{name}"
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/dm-predefined/yard/handlers/ruby.rb

@@ -0,0 +1,2 @@
+require 'dm-predefined/yard/handlers/ruby/predefine_handler'
+require 'dm-predefined/yard/handlers/ruby/legacy'

data/lib/dm-predefined/yard/handlers.rb

@@ -0,0 +1 @@
+require 'dm-predefined/yard/handlers/ruby'

data/lib/dm-predefined/yard.rb

@@ -0,0 +1 @@
+require 'dm-predefined/yard/handlers'

data/lib/dm-predefined.rb

@@ -3,7 +3,7 @@ require 'rubygems'
 require 'pathname'
 
 # Add all external dependencies for the plugin here
-gem 'dm-core', '~>0.9.8'
+gem 'dm-core', '~>0.10.0'
 require 'dm-core'
 
 # Require plugin-files

data/spec/integration/{helpers → models}/test_model.rb

@@ -3,6 +3,9 @@ class TestModel
   include DataMapper::Resource
   include DataMapper::Predefined
 
+  # Primary key of the test model
+  property :id, Serial
+
   # Name property to test String values
   property :name, String
 
@@ -15,11 +18,11 @@ class TestModel
   # Body property to test Text values
   property :body, Text
 
-  define :test1, :name => 'test1',
-    :number => 1,
-    :optional => 'yo',
-    :body => %{This is a test.}
+  predefine :test1, :name => 'test1',
+                    :number => 1,
+                    :optional => 'yo',
+                    :body => %{This is a test.}
 
-  define :test2, :name => 'test2', :number => 2
+  predefine :test2, :name => 'test2', :number => 2
 
 end

data/spec/integration/predefined_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'integration/helpers/test_model'
+require 'integration/models/test_model'
 
 if (HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES)
   describe DataMapper::Predefined do

data/spec/spec_helper.rb

@@ -1,7 +1,7 @@
 require 'pathname'
 require 'rubygems'
 
-gem 'rspec', '~>1.1.11'
+gem 'rspec', '~>1.2.6'
 require 'spec'
 
 require Pathname(__FILE__).dirname.expand_path.parent + 'lib/dm-predefined'

metadata

@@ -1,17 +1,48 @@
 --- !ruby/object:Gem::Specification 
 name: dm-predefined
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Postmodern
 autorequire: 
 bindir: bin
-cert_chain: []
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDQDCCAiigAwIBAgIBADANBgkqhkiG9w0BAQUFADBGMRgwFgYDVQQDDA9wb3N0
+  bW9kZXJuLm1vZDMxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixk
+  ARkWA2NvbTAeFw0wOTA2MDMwNDU5MDNaFw0xMDA2MDMwNDU5MDNaMEYxGDAWBgNV
+  BAMMD3Bvc3Rtb2Rlcm4ubW9kMzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYK
+  CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
+  1wvANkTDHFgVih5XLjuTwTZjgBq1lBGybXJiH6Id1lY2JOMqM5FB1DDHVvvij94i
+  mJabN0zkzu6VKWC70y0IwOxY7CPokr0eFdK/D0y7mCq1P8QITv76i2YqAl0eYqIt
+  W+IhIkANQ7E6uMZIZcdnfadC6lPAtlKkqtd9crvRbFgr6e3kyflmohbRnTEJHoRd
+  7SHHsybE6DSn7oTDs6XBTNrNIn5VfZA0z01eeos/+zBm1zKJOK2+/7xtLLDuDU9G
+  +Rd+ltUBbvxUrMNZmDG29pnmN2xTRH+Q8HxD2AxlvM5SRpK6OeZaHV7PaCCAVZ4L
+  T9BFl1sfMvRlABeGEkSyuQIDAQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIE
+  sDAdBgNVHQ4EFgQUKwsd+PqEYmBvyaTyoL+uRuk+PhEwDQYJKoZIhvcNAQEFBQAD
+  ggEBAB4TvHsrlbcXcKg6gX5BIb9tI+zGkpzo0Z7jnxMEcNO7NGGwmzafDBI/xZYv
+  xkRH3/HXbGGYDOi6Q6gWt5GujSx0bOImDtYTJTH8jnzN92HzEK5WdScm1QpZKF1e
+  cezArMbxbSPaosxTCtG6LQTkE28lFQsmFZ5xzouugS4h5+LVJiVMmiP+l3EfkjFa
+  GOURU+rNEMPWo8MCWivGW7jes6BMzWHcW7DQ0scNVmIcCIgdyMmpscuAEOSeghy9
+  /fFs57Ey2OXBL55nDOyvN/ZQ2Vab05UH4t+GCxjAPeirzL/29FBtePT6VD44c38j
+  pDj+ws7QjtH/Qcrr1l9jfN0ehDs=
+  -----END CERTIFICATE-----
 
-date: 2009-01-17 00:00:00 -08:00
+date: 2009-09-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.3.5
+    version: 
 - !ruby/object:Gem::Dependency 
   name: dm-core
   type: :runtime
@@ -20,7 +51,17 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.9.8
+        version: 0.10.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.8
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -30,7 +71,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 2.3.3
     version: 
 description: A DataMapper plugin for adding predefined resources to Models.
 email: 
@@ -53,14 +94,22 @@ files:
 - Rakefile
 - TODO.txt
 - lib/dm-predefined.rb
+- lib/dm-predefined/exceptions/unknown_resource.rb
 - lib/dm-predefined/predefined.rb
 - lib/dm-predefined/version.rb
-- lib/dm-predefined/exceptions/unknown_resource.rb
-- spec/integration/helpers/test_model.rb
+- lib/dm-predefined/yard.rb
+- lib/dm-predefined/yard/handlers.rb
+- lib/dm-predefined/yard/handlers/ruby.rb
+- lib/dm-predefined/yard/handlers/ruby/predefine_handler.rb
+- lib/dm-predefined/yard/handlers/ruby/legacy.rb
+- lib/dm-predefined/yard/handlers/ruby/legacy/predefine_handler.rb
+- spec/integration/models/test_model.rb
 - spec/integration/predefined_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
+has_rdoc: yard
 homepage: http://dm-predefined.rubyforge.org/
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -82,9 +131,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: dm-predefined
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: A DataMapper plugin for adding predefined resources to Models.
 test_files: []