dao 5.5.1 → 8.0.1

data/tasks/this.rb

@@ -0,0 +1,207 @@
+require 'pathname'
+
+# Public: A Class containing all the metadata and utilities needed to manage a
+# ruby project.
+class ThisProject
+  # The name of this project
+  attr_accessor :name
+
+  # The author's name
+  attr_accessor :author
+
+  # The email address of the author(s)
+  attr_accessor :email
+
+  # The homepage of this project
+  attr_accessor :homepage
+
+  # The regex of files to exclude from the manifest
+  attr_accessor :exclude_from_manifest
+
+  # The hash of Gem::Specifications keyed' by platform
+  attr_accessor :gemspecs
+
+  # Public: Initialize ThisProject
+  #
+  # Yields self
+  def initialize(&block)
+    @exclude_from_manifest = Regexp.union(/\.(git|DS_Store)/,
+                                          /^(doc|coverage|pkg|tmp|Gemfile(\.lock)?)/,
+                                          /^[^\/]+\.gemspec/,
+                                          /\.(swp|jar|bundle|so|rvmrc|travis.yml)$/,
+                                          /~$/)
+    @gemspecs              = Hash.new
+    yield self if block_given?
+  end
+
+  # Public: return the version of ThisProject
+  #
+  # Search the ruby files in the project looking for the one that has the
+  # version string in it. This does not eval any code in the project, it parses
+  # the source code looking for the string.
+  #
+  # Returns a String version
+  def version
+    [ "lib/#{ name }.rb", "lib/#{ name }/version.rb" ].each do |v|
+      path = project_path( v )
+      next unless path.exist?
+      line = path.read[/^\s*VERSION\s*=\s*.*/i]
+      if line then
+        return line.match(/.*VERSION\s*=\s*['"](.*)['"]/i)[1]
+      end
+    end
+  end
+
+  # Internal: Return a section of an RDoc file with the given section name
+  #
+  # path         - the relative path in the project of the file to parse
+  # section_name - the section out of the file from which to parse data
+  #
+  # Retuns the text of the section as an array of paragrphs.
+  def section_of( file, section_name )
+    re    = /^[=#]+ (.*)$/
+    sectional = project_path( file )
+    parts = sectional.read.split( re )[1..-1]
+    parts.map! { |p| p.strip }
+
+    sections = Hash.new
+    Hash[*parts].each do |k,v|
+      sections[k] = v.split("\n\n")
+    end
+    return sections[section_name]
+  end
+
+  # Internal: print out a warning about the give task
+  def task_warning( task )
+    warn "WARNING: '#{task}' tasks are not defined. Please run 'rake develop'"
+  end
+
+  # Internal: Return the full path to the file that is relative to the project
+  # root.
+  #
+  # path - the relative path of the file from the project root
+  #
+  # Returns the Pathname of the file
+  def project_path( *relative_path )
+    project_root.join( *relative_path )
+  end
+
+  # Internal: The absolute path of this file
+  #
+  # Returns the Pathname of this file.
+  def this_file_path
+    Pathname.new( __FILE__ ).expand_path
+  end
+
+  # Internal: The root directory of this project
+  #
+  # This is defined as being the directory that is in the path of this project
+  # that has the first Rakefile
+  #
+  # Returns the Pathname of the directory
+  def project_root
+    this_file_path.ascend do |p|
+      rakefile = p.join( 'Rakefile' )
+      return p if rakefile.exist?
+    end
+  end
+
+  # Internal: Returns the contents of the Manifest.txt file as an array
+  #
+  # Returns an Array of strings
+  def manifest
+    manifest_file = project_path( "Manifest.txt" )
+    abort "You need a Manifest.txt" unless manifest_file.readable?
+    manifest_file.readlines.map { |l| l.strip }
+  end
+
+  # Internal: Return the files that define the extensions
+  #
+  # Returns an Array
+  def extension_conf_files
+    manifest.grep( /extconf.rb\Z/ )
+  end
+
+  # Internal: Returns the gemspace associated with the current ruby platform
+  def platform_gemspec
+    gemspecs.fetch(platform) { This.ruby_gemspec }
+  end
+
+  def core_gemspec
+    Gem::Specification.new do |spec|
+      spec.name        = name
+      spec.version     = version
+      spec.author      = author
+      spec.email       = email
+      spec.homepage    = homepage
+
+      spec.summary     = summary
+      spec.description = description
+      spec.license     = license
+
+      spec.files       = manifest
+      spec.executables = spec.files.grep(/^bin/) { |f| File.basename(f) }
+      spec.test_files  = spec.files.grep(/^spec/)
+
+      spec.extra_rdoc_files += spec.files.grep(/(txt|rdoc|md)$/)
+      spec.rdoc_options = [ "--main"  , 'README.md',
+                            "--markup", "tomdoc" ]
+
+      spec.required_ruby_version = '>= 2.2.0'
+    end
+  end
+
+  # Internal: Return the gemspec for the ruby platform
+  def ruby_gemspec( core = core_gemspec, &block )
+    yielding_gemspec( 'ruby', core, &block )
+  end
+
+  # Internal: Return the gemspec for the jruby platform
+  def java_gemspec( core = core_gemspec, &block )
+    yielding_gemspec( 'java', core, &block )
+  end
+
+  # Internal: give an initial spec and a key, create a new gemspec based off of
+  # it.
+  #
+  # This will force the new gemspecs 'platform' to be that of the key, since the
+  # only reason you would have multiple gemspecs at this point is to deal with
+  # different platforms.
+  def yielding_gemspec( key, core )
+    spec = gemspecs[key] ||= core.dup
+    spec.platform = key
+    yield spec if block_given?
+    return spec
+  end
+
+  # Internal: Return the platform of ThisProject at the current moment in time.
+  def platform
+    (RUBY_PLATFORM == "java") ? 'java' : Gem::Platform::RUBY
+  end
+
+  # Internal: Return the DESCRIPTION section of the README.rdoc file
+  def description_section
+    section_of( 'README.md', 'DESCRIPTION')
+  end
+
+  # Internal: Return the summary text from the README
+  def summary
+    description_section.first
+  end
+
+  # Internal: Return the full description text from the README
+  def description
+    description_section.join(" ").tr("\n", ' ').gsub(/[{}]/,'').gsub(/\[[^\]]+\]/,'') # strip rdoc
+  end
+
+  def license
+    "ISC"
+  end
+
+  # Internal: The path to the gemspec file
+  def gemspec_file
+    project_path( "#{ name }.gemspec" )
+  end
+end
+
+This = ThisProject.new

data/test/active_model_conducer_lint_test.rb

@@ -1,20 +1,12 @@
 # -*- encoding : utf-8 -*-
-class LintTest < ActiveModel::TestCase
+require './test/test_helper'
+class LintTest < Dao::TestCase
   include ActiveModel::Lint::Tests
 
   class LintConducer < Dao::Conducer; end
-        
+
   def setup
     @model = LintConducer.new
   end
 end
 
-
-BEGIN {
-  testdir = File.dirname(File.expand_path(__FILE__))
-  rootdir = File.dirname(testdir)
-  libdir = File.join(rootdir, 'lib')
-
-  require File.join(libdir, 'dao')
-  require File.join(testdir, 'testing')
-}

data/test/api_test.rb

@@ -1,19 +1,18 @@
 # -*- encoding : utf-8 -*-
+require_relative 'test_helper'
 
-
-Testing Dao do
+class DaoTest < ::Dao::TestCase
 ## api
 #
-  testing 'that an api class for your application can be built using a simple dsl' do
+  test 'that an api class for your application can be built using a simple dsl' do
     assert{
-      api_class =
-        Dao.api do
-          ### dsl
-        end
+      Dao.api do
+        ### dsl
+      end
     }
   end
 
-  testing 'that apis can have callable endpoints added to them which accept params and return results' do
+  test 'that apis can have callable endpoints added to them which accept params and return results' do
     captured = []
 
     api_class =
@@ -29,7 +28,7 @@ Testing Dao do
     assert{ result.is_a?(Hash) }
   end
 
-  testing 'that endpoints are automatically called according to arity' do
+  test 'that endpoints are automatically called according to arity' do
     api = assert{ Class.new(Dao.api) }
     assert{ api.class_eval{ endpoint(:zero){|| result.update :args => [] } } }
     assert{ api.class_eval{ endpoint(:one){|a| result.update :args => [a]} } }
@@ -40,14 +39,14 @@ Testing Dao do
     assert{ api.new.call(:two).args.size == 2 }
   end
 
-  testing 'that endpoints have an auto-vivifying params/result' do
+  test 'that endpoints have an auto-vivifying params/result' do
     api = assert{ Class.new(Dao.api) }
     assert{ api.class_eval{ endpoint(:foo){ params; result; } } }
     result = assert{ api.new.call(:foo) }
     assert{ result.path.to_s =~ /foo/ }
   end
 
-  testing 'that an api can be called with different modes' do
+  test 'that an api can be called with different modes' do
     Dao::Mode.list.each do |mode|
       api_class =
         assert{
@@ -63,7 +62,7 @@ Testing Dao do
     end
   end
 
-  testing 'that read==get' do
+  test 'that read==get' do
     api_class =
       assert{
         Dao.api do
@@ -85,7 +84,7 @@ Testing Dao do
     assert{ api.get.call(:bar).data.answer == 42.0 }
   end
 
-  testing 'that write==post' do
+  test 'that write==post' do
     api_class =
       assert{
         Dao.api do
@@ -107,7 +106,7 @@ Testing Dao do
     assert{ api.post.call(:bar).data.answer == 42.0 }
   end
 
-  testing 'that aliases are re-defined in scope' do
+  test 'that aliases are re-defined in scope' do
     api_class =
       assert{
         Dao.api do
@@ -149,7 +148,7 @@ Testing Dao do
 
 ## context
 #
-  testing 'that calls have a shortcut to status' do
+  test 'that calls have a shortcut to status' do
     api_class =
       assert{
         Dao.api do
@@ -163,7 +162,7 @@ Testing Dao do
 
 ## results
 #
-  testing 'that results can be created' do
+  test 'that results can be created' do
     result = assert{ Dao::Result.new }
     assert{ result.path }
     assert{ result.status }
@@ -172,14 +171,14 @@ Testing Dao do
     assert{ result.data }
   end
 
-  testing 'that results can be created with a path' do
+  test 'that results can be created with a path' do
     result = assert{ Dao::Result.new('/api/foo/bar') }
     assert{ result.path == '/api/foo/bar' }
   end
 
 ## paths
 #
-  testing 'that simple paths can be contstructed/compiled' do
+  test 'that simple paths can be contstructed/compiled' do
     path = assert{ Dao::Path.for('./api/../foo/bar')  }
     assert{ path =~ %r|^/| }
     assert{ path !~ %r|[.]| }
@@ -190,7 +189,7 @@ Testing Dao do
 
 ## routes
 #
-  testing 'that an api has a list of routes' do
+  test 'that an api has a list of routes' do
     api_class =
       assert{
         Dao.api do
@@ -199,7 +198,7 @@ Testing Dao do
     assert{ api_class.routes.is_a?(Array) }
   end
 
-  testing 'that routed endpoints call be declared' do
+  test 'that routed endpoints call be declared' do
     api_class =
       assert{
         Dao.api do
@@ -208,10 +207,10 @@ Testing Dao do
           end
         end
       }
-    api = api_class.new
+    api_class.new
   end
 
-  testing 'that routed methods can be called with embedded params' do
+  test 'that routed methods can be called with embedded params' do
     api_class =
       assert{
         Dao.api do
@@ -236,7 +235,7 @@ Testing Dao do
 
 ## doc
 #
-  testing 'that apis can be documented via the api' do
+  test 'that apis can be documented via the api' do
     api_class =
       assert {
         Dao.api {
@@ -253,7 +252,7 @@ Testing Dao do
 
 # aliases
 #
-  testing 'that apis can alias methods' do
+  test 'that apis can alias methods' do
     api_class =
       assert {
         Dao.api {
@@ -274,17 +273,7 @@ protected
 
   def api(&block)
     api_class = assert{ Dao.api(&block) }
-    api = assert{ api_class.new }
+    assert{ api_class.new }
   end
 end
 
-
-BEGIN {
-  testdir = File.dirname(File.expand_path(__FILE__))
-  rootdir = File.dirname(testdir)
-  libdir = File.join(rootdir, 'lib')
-
-  require File.join(libdir, 'dao')
-  require File.join(testdir, 'testing')
-  require File.join(testdir, 'helper')
-}

data/test/conducer_test.rb

@@ -1,12 +1,12 @@
 # -*- encoding : utf-8 -*-
+require_relative 'test_helper'
 
-
-Testing Dao::Conducer do
+class Dao::ConducerTest < Dao::TestCase
 ##
 #
   context :teh_ctor do
   #
-    testing 'conducers have a POLS .new method' do
+    test 'conducers have a POLS .new method' do
       [
         {:key => :val, :array => [0,1,2]},
         {}
@@ -17,7 +17,7 @@ Testing Dao::Conducer do
     end
 
   #
-    testing 'models passed to .new are automatically tracked' do
+    test 'models passed to .new are automatically tracked' do
       user = User.new
       post = Post.new
       comment = Comment.new
@@ -33,7 +33,7 @@ Testing Dao::Conducer do
     end
 
   #
-    testing 'that the conduced model can be declared at the class level' do
+    test 'that the conduced model can be declared at the class level' do
       user = User.new
       post = Post.new
       comment = Comment.new
@@ -49,7 +49,7 @@ Testing Dao::Conducer do
     end
 
   #
-    testing 'that the conduced model can be declared at the instance level' do
+    test 'that the conduced model can be declared at the instance level' do
       user = User.new
       post = Post.new
       comment = Comment.new
@@ -71,7 +71,7 @@ Testing Dao::Conducer do
 #
   context :teh_default_initialize do
   #
-    testing 'that the last mode determines the lifecycle state when a models are passed in' do
+    test 'that the last mode determines the lifecycle state when a models are passed in' do
       user = User.new
       post = Post.new
       comment = Comment.new
@@ -92,7 +92,7 @@ Testing Dao::Conducer do
     end
 
   #
-    testing 'that passed in models/params are sanely ker-sploded onto the attributes' do
+    test 'that passed in models/params are sanely ker-sploded onto the attributes' do
       user    = User.new :k => 1
       post    = Post.new :k => 2
       comment = Comment.new :k => 3, :x => 4
@@ -119,7 +119,7 @@ Testing Dao::Conducer do
     end
 
   #
-    testing 'that .new specialises based on current action' do
+    test 'that .new specialises based on current action' do
       conducer_class =
         new_conducer_class do
           def initialize_for_new
@@ -145,7 +145,7 @@ Testing Dao::Conducer do
     end
 
   #
-    testing 'that conducers can build a highly specialized .new method based on action' do
+    test 'that conducers can build a highly specialized .new method based on action' do
       c =
         new_conducer_class do
           def initialize(a, b, c, params)
@@ -181,7 +181,7 @@ Testing Dao::Conducer do
   end
 
  #
-    testing 'that conducers *fold* in attributes' do
+    test 'that conducers *fold* in attributes' do
       c = new_conducer
 
       assert{ c.update_attributes :key => {:a => :b} }
@@ -193,7 +193,7 @@ Testing Dao::Conducer do
 #
   context :teh_default_save do
   #
-    testing 'is sane and based solely on the last model' do
+    test 'is sane and based solely on the last model' do
       user = User.new
       post = Post.new
       comment = Comment.new
@@ -211,7 +211,7 @@ Testing Dao::Conducer do
     end
 
   #
-    testing 'halts when the conducer is invalid with errors' do
+    test 'halts when the conducer is invalid with errors' do
       conducer_class =
         new_conducer_class do
           validates_presence_of(:foo)
@@ -225,7 +225,7 @@ Testing Dao::Conducer do
     end
 
   #
-    testing 'halts when the model is invalid and relays errors' do
+    test 'halts when the model is invalid and relays errors' do
       post = Post.new
       post.errors[:foo] = 'is fucked'
       c = new_conducer(post)
@@ -234,7 +234,7 @@ Testing Dao::Conducer do
     end
 
   #
-    testing 'raises a validation error on #save!' do
+    test 'raises a validation error on #save!' do
       post = Post.new
       post.errors[:foo] = 'is fucked'
       c = new_conducer(post)
@@ -251,7 +251,7 @@ Testing Dao::Conducer do
 #
   context :validations do  
   #
-    testing 'that simple validations/errors work' do
+    test 'that simple validations/errors work' do
       c =
         assert{
           new_foo_conducer_class do
@@ -276,7 +276,7 @@ Testing Dao::Conducer do
     end
 
   #
-    testing 'that validations are evaluated in the context of the object' do
+    test 'that validations are evaluated in the context of the object' do
       c =
         assert{
           new_foo_conducer_class do
@@ -296,7 +296,7 @@ Testing Dao::Conducer do
     end
 
   #
-    testing 'that validates_each werks at the class and instance level' do
+    test 'that validates_each werks at the class and instance level' do
       conducer_class =
         new_conducer_class do
           validates_each :a do |item|
@@ -335,7 +335,7 @@ Testing Dao::Conducer do
 #
   context :forms do
   #
-    testing 'that basic form helpers work' do
+    test 'that basic form helpers work' do
       c =
         assert{
           new_foo_conducer_class do
@@ -357,12 +357,12 @@ Testing Dao::Conducer do
 #
   context :class_methods do
   #
-    testing 'that base classes can be constructed and named' do
+    test 'that base classes can be constructed and named' do
       new_foo_conducer_class()
     end
 
   #
-    testing '.new' do
+    test '.new' do
       c = assert{ new_foo_conducer_class }
       controller = assert{ Dao.mock_controller }
 
@@ -386,7 +386,7 @@ Testing Dao::Conducer do
     end
 
   #
-    testing '.model_name' do
+    test '.model_name' do
       c = assert{ new_foo_conducer_class }
       assert{ c.model_name }
       o = assert{ c.new } 
@@ -397,7 +397,7 @@ Testing Dao::Conducer do
 ##
 #
   context :instance_methods do
-    testing '#id' do
+    test '#id' do
       [:_id, :id].each do |id_key|
         o = assert{ new_foo_conducer() }
         assert{ o.id.nil? }
@@ -410,20 +410,20 @@ Testing Dao::Conducer do
       end
     end
 
-    testing '#to_param' do
+    test '#to_param' do
       o = assert{ new_foo_conducer() }
       assert{ o.to_param.nil? }
       o.id = 42
       assert{ o.to_param }
     end
 
-    testing '#errors' do
+    test '#errors' do
       o = assert{ new_foo_conducer() }
       assert{ o.errors.respond_to?(:[]) }
     end
 
 =begin
-    testing 'that conducers can register handlers for setting deeply nested attributes' do
+    test 'that conducers can register handlers for setting deeply nested attributes' do
       c =
         new_conducer_class do
           def _update_attributes(attributes = {})
@@ -454,7 +454,7 @@ Testing Dao::Conducer do
 #
   context :teh_mount do
   #
-    testing 'that mounted objects can be declared at the class level' do
+    test 'that mounted objects can be declared at the class level' do
       conducer_class =
         new_conducer_class do
           mount Dao::Upload, :a, :b, :placeholder => '/images/foo.jpg'
@@ -470,7 +470,7 @@ Testing Dao::Conducer do
     end
 
   #
-    testing 'that mounted objects replace their location in attributes' do
+    test 'that mounted objects replace their location in attributes' do
       conducer_class =
         new_conducer_class do
           mount Dao::Upload, :a, :b, :placeholder => '/images/foo.jpg'
@@ -488,7 +488,7 @@ Testing Dao::Conducer do
     end
 
   #
-    testing 'that the default save uses the mounted _value and _clears it' do
+    test 'that the default save uses the mounted _value and _clears it' do
 begin
 $pry=true
       conducer_class =
@@ -498,7 +498,7 @@ $pry=true
 
       path = File.join(File.dirname(__FILE__), 'data/han-solo.jpg') 
       assert{ test(?s, path) }
-      up = Upload.new(path)
+      _up = Upload.new(path)
       comment = Comment.new
 
       c = conducer_class.new( comment, :up => {:file => Upload.new(path)} ) 
@@ -512,8 +512,8 @@ $pry=true
 
       assert{ c.save }
 
-      value_was_relayed = assert{ comment.attributes[:up] == upload._value }
-      value_was_cleared = assert{ !test(?f, upload.path) }
+      _value_was_relayed = assert{ comment.attributes[:up] == upload._value }
+      _value_was_cleared = assert{ !test(?f, upload.path) }
 
       assert{ test(?s, path) }
 ensure
@@ -525,7 +525,7 @@ end
 ##
 #
   context :collections do
-    testing 'can be created from page-y blessed arrays' do
+    test 'can be created from page-y blessed arrays' do
       paginated = Paginated[Post.new, Post.new, Post.new]
       paginated.limit = 42
       paginated.offset = 42.0
@@ -551,7 +551,7 @@ end
 ##
 #
   context :callbacks do
-    testing 'can be added lazily in an ad-hoc fashion' do
+    test 'can be added lazily in an ad-hoc fashion' do
       callbacks = []
 
       conducer_class =
@@ -602,7 +602,7 @@ protected
   end
   alias_method :new_conducer, :new_foo_conducer
 
-  prepare do
+  def setup
     $db = Dao::Db.new(:path => 'test/db.yml')
     Dao::Db.instance = $db
     collection = $db['foos']
@@ -613,7 +613,7 @@ protected
     end
   end
 
-  cleanup do
+  def teardown
     $db = Dao::Db.new(:path => 'test/db.yml')
     $db.rm_f
   end
@@ -705,7 +705,7 @@ protected
 
     def method_missing(method, *args, &block)
       re = /^([^=!?]+)([=!?])?$/imox
-      matched, key, suffix = re.match(method.to_s).to_a
+      _matched, key, suffix = re.match(method.to_s).to_a
       
       case suffix
         when '=' then attributes.set(key, args.first)
@@ -758,13 +758,3 @@ protected
   class Comment < Model
   end
 end
-
-
-BEGIN {
-  testdir = File.dirname(File.expand_path(__FILE__))
-  rootdir = File.dirname(testdir)
-  libdir = File.join(rootdir, 'lib')
-  require File.join(libdir, 'dao')
-  require File.join(testdir, 'testing')
-  require 'stringio'
-}