dm-gen 0.4.2 → 0.5.0

data/lib/dm-gen/templates/adapter/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 John Doe
+Copyright (c) <%= Time.now.year %> NAME
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/dm-gen/templates/adapter/README.rdoc

@@ -0,0 +1,3 @@
+= <%= gem_name %>
+
+A DataMapper adapter for <%= snake_name %>

data/lib/dm-gen/templates/adapter/Rakefile

@@ -1,30 +1,23 @@
-require 'pathname'
-require 'rubygems'
-require 'hoe'
+begin
+  require 'jeweler'
 
-ROOT    = Pathname(__FILE__).dirname.expand_path
-JRUBY   = RUBY_PLATFORM =~ /java/
-WINDOWS = Gem.win_platform?
-SUDO    = (WINDOWS || JRUBY) ? '' : ('sudo' unless ENV['SUDOLESS'])
+  Jeweler::Tasks.new do |gem|
+    gem.name        = '<%= gem_name %>'
+    gem.summary     = "SUMMARY"
+    gem.description = gem.summary
+    gem.authors     = ["NAME"]
+    gem.email       = %q{EMAIL}
+    gem.homepage    = 'http://github.com/USERNAME/<%= gem_name %>'
 
-require ROOT + 'lib/<%= adapter_file %>/version'
+    gem.add_dependency 'dm-core', '~> <%= DMGen::DM_VERSION %>'
 
-# define some constants to help with task files
-GEM_NAME    = '<%= gem_name %>'
-GEM_VERSION = DataMapper::<%= class_name %>::VERSION
+    gem.add_development_dependency 'rspec', '~> 1.3'
+    gem.add_development_dependency 'yard', '~> 0.5'
+  end
 
-Hoe.new(GEM_NAME, GEM_VERSION) do |p|
-  p.developer('John Doe', 'john [a] doe [d] com')
-
-  p.description = 'A DataMapper Adapter for ...'
-  p.summary = 'A DataMapper Adapter for ...'
-  p.url = 'http://github.com/USERNAME/<%= gem_name %>'
-
-  p.clean_globs |= %w[ log pkg coverage ]
-  p.spec_extras = { :has_rdoc => true, :extra_rdoc_files => %w[ README.txt LICENSE TODO History.txt ] }
-
-  p.extra_deps << ['dm-core', "<%= DMGen::DM_VERSION %>"]
+  Jeweler::GemcutterTasks.new
 
+  FileList['tasks/**/*.rake'].each { |task| import task }
+rescue LoadError
+  puts 'Jeweler (or a dependency) not available. Install it with: gem install jeweler'
 end
-
-Pathname.glob(ROOT.join('tasks/**/*.rb').to_s).each { |f| require f }

data/lib/dm-gen/templates/adapter/lib/%gem_name%.rb

@@ -0,0 +1 @@
+require '<%= gem_name %>/adapter'

data/lib/dm-gen/templates/adapter/lib/{%adapter_file%.rb → %gem_name%/adapter.rb}

@@ -2,16 +2,9 @@ require 'dm-core'
 
 module DataMapper
   module Adapters
-    # The documentation for this adapter was taken from
-    #
-    # lib/dm-core/adapters/in_memory_adapter.rb
-    #
-    # Which is intended as a general source of documentation for the
-    # implementation to be followed by all DataMapper adapters.  The implementor
-    # is well advised to read over the adapter before implementing their own.
-    #
+    # This documentation is taken from the in_memory adapter in dm-core.  It
+    # explains the expected behaviour of the core methods which make up the API.
     class <%= class_name %> < AbstractAdapter
-      ##
       # Used by DataMapper to put records into a data-store: "INSERT" in SQL-speak.
       # It takes an array of the resources (model instances) to be saved. Resources
       # each have a key that can be used to quickly look them up later without
@@ -25,7 +18,6 @@ module DataMapper
         raise NotImplementedError
       end
 
-      ##
       # Looks up one record or a collection of records from the data-store:
       # "SELECT" in SQL.
       #
@@ -41,7 +33,6 @@ module DataMapper
         raise NotImplementedError
       end
 
-      ##
       # Used by DataMapper to update the attributes on existing records in a
       # data-store: "UPDATE" in SQL-speak. It takes a hash of the attributes
       # to update with, as well as a collection object that specifies which resources
@@ -57,7 +48,6 @@ module DataMapper
         raise NotImplementedError
       end
 
-      ##
       # Destroys all the records matching the given query. "DELETE" in SQL.
       #
       # @param [DataMapper::Collection] resources
@@ -71,11 +61,15 @@ module DataMapper
         raise NotImplementedError
       end
 
+      # TODO consider proper automigrate functionality
+      def reset
+        raise NotImplementedError
+      end
+
       private
 
-      ##
       # Make a new instance of the adapter.
-      # 
+      #
       # @param [String, Symbol] name
       #   The name of the Repository using this adapter.
       # @param [String, Hash] uri_or_options
@@ -89,9 +83,6 @@ module DataMapper
 
     end # class <%= class_name %>
 
-    ##
-    #
-    # This can be used by plugins to trigger hooks for your adapter.
     const_added(:<%= class_name %>)
   end # module Adapters
 end # module DataMapper

data/lib/dm-gen/templates/adapter/lib/%gem_name%/spec/setup.rb

@@ -0,0 +1,21 @@
+require '<%= gem_name %>'
+require 'dm-core/spec/setup'
+
+
+module DataMapper
+  module Spec
+    module Adapters
+
+      # This class sets up the adapter for the spec framework DataMapper ships
+      # with
+      class <%= class_name %> < Adapter
+        def connection_uri
+          "<%= snake_name %>://..."
+        end
+      end
+
+      use <%= class_name %>
+
+    end
+  end
+end

data/lib/dm-gen/templates/adapter/spec/adapter_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+require 'dm-core'
+require 'dm-core/spec/shared/adapter_spec'
+
+require 'dm-migrations'
+require '<%= gem_name %>/spec/setup'
+
+ENV['ADAPTER']          = '<%= snake_name %>'
+ENV['ADAPTER_SUPPORTS'] = 'all'
+
+describe 'DataMapper::Adapters::<%= class_name %>' do
+
+  before :all do
+    @adapter    = DataMapper::Spec.adapter
+    @repository = DataMapper.repository(@adapter.name)
+  end
+
+  it_should_behave_like "An Adapter"
+
+end

data/lib/dm-gen/templates/adapter/spec/rcov.opts

@@ -0,0 +1,5 @@
+--exclude "spec"
+--sort coverage
+--callsites
+--xrefs
+--text-summary

data/lib/dm-gen/templates/adapter/spec/spec.opts

@@ -1 +1,3 @@
 --colour
+--loadby random
+--backtrace

data/lib/dm-gen/templates/adapter/spec/spec_helper.rb

@@ -1,10 +1,5 @@
-require 'pathname'
-require 'rubygems'
-
-gem 'rspec', '~>1.1.11'
-require 'spec'
-
-require Pathname(__FILE__).dirname.expand_path.parent + 'lib/<%= adapter_file %>'
-
-DataMapper.setup(:default, "<%= name %>://some/uri/here")
+require 'dm-core/spec/lib/pending_helpers'
 
+Spec::Runner.configure do |config|
+  config.include(DataMapper::Spec::PendingHelpers)
+end

data/lib/dm-gen/templates/adapter/tasks/local_gemfile.rake

@@ -0,0 +1,18 @@
+desc "Support bundling from local source code (allows BUNDLE_GEMFILE=Gemfile.local bundle foo)"
+task :local_gemfile do |t|
+
+  root              = Pathname(__FILE__).dirname.parent
+  datamapper        = root.parent
+
+  source_regex     = /DATAMAPPER = 'git:\/\/github.com\/datamapper'/
+  gem_source_regex = /:git => \"#\{DATAMAPPER\}\/(.+?)(?:\.git)?\"/
+
+  root.join('Gemfile.local').open('w') do |f|
+    root.join('Gemfile').open.each do |line|
+      line.sub!(source_regex,     "DATAMAPPER = '#{datamapper}'")
+      line.sub!(gem_source_regex, ':path => "#{DATAMAPPER}/\1"')
+      f.puts line
+    end
+  end
+
+end

data/lib/dm-gen/templates/adapter/tasks/spec.rake

@@ -0,0 +1,38 @@
+spec_defaults = lambda do |spec|
+  spec.pattern    = 'spec/**/*_spec.rb'
+  spec.libs      << 'lib' << 'spec'
+  spec.spec_opts << '--options' << 'spec/spec.opts'
+end
+
+begin
+  require 'spec/rake/spectask'
+
+  Spec::Rake::SpecTask.new(:spec, &spec_defaults)
+rescue LoadError
+  task :spec do
+    abort 'rspec is not available. In order to run spec, you must: gem install rspec'
+  end
+end
+
+begin
+  require 'rcov'
+  require 'spec/rake/verify_rcov'
+
+  Spec::Rake::SpecTask.new(:rcov) do |rcov|
+    spec_defaults.call(rcov)
+    rcov.rcov      = true
+    rcov.rcov_opts = File.read('spec/rcov.opts').split(/\s+/)
+  end
+
+  RCov::VerifyTask.new(:verify_rcov => :rcov) do |rcov|
+    rcov.threshold = 100
+  end
+rescue LoadError
+  %w[ rcov verify_rcov ].each do |name|
+    task name do
+      abort "rcov is not available. In order to run #{name}, you must: gem install rcov"
+    end
+  end
+end
+
+task :default => :spec

data/lib/dm-gen/templates/adapter/tasks/yard.rake

@@ -0,0 +1,9 @@
+begin
+  require 'yard'
+
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yard do
+    abort 'YARD is not available. In order to run yard, you must: gem install yard'
+  end
+end

data/lib/dm-gen/templates/adapter/tasks/yardstick.rake

@@ -0,0 +1,19 @@
+begin
+  require 'pathname'
+  require 'yardstick/rake/measurement'
+  require 'yardstick/rake/verify'
+
+  # yardstick_measure task
+  Yardstick::Rake::Measurement.new
+
+  # verify_measurements task
+  Yardstick::Rake::Verify.new do |verify|
+    verify.threshold = 100
+  end
+rescue LoadError
+  %w[ yardstick_measure verify_measurements ].each do |name|
+    task name.to_s do
+      abort "Yardstick is not available. In order to run #{name}, you must: gem install yardstick"
+    end
+  end
+end

data/lib/dm-gen/templates/is/.gitignore

@@ -0,0 +1,36 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## Rubinius
+*.rbc
+
+## PROJECT::GENERAL
+*.gem
+coverage
+rdoc
+pkg
+tmp
+doc
+log
+.yardoc
+measurements
+
+## BUNDLER
+.bundle
+Gemfile.local
+Gemfile.lock
+
+## PROJECT::SPECIFIC
+spec/db/

data/lib/dm-gen/templates/is/Gemfile

@@ -0,0 +1,143 @@
+# 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 and 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 and dm-validations
+#   PLUGINS=dm-validations,dm-types bundle foo # dm-migrations, dm-validations and 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 'http://rubygems.org'
+
+DATAMAPPER = 'git://github.com/datamapper'
+DM_VERSION = '~> <%= DMGen::DM_VERSION %>'
+
+group :runtime do # Runtime dependencies (as in the gemspec)
+
+  if ENV['EXTLIB']
+    gem 'extlib',        '~> 0.9.15',      :git => "#{DATAMAPPER}/extlib.git"
+  else
+    gem 'activesupport', '~> 3.0.0.beta3', :git => 'git://github.com/rails/rails.git', :require => nil
+  end
+
+  gem 'dm-core',         DM_VERSION, :git => "#{DATAMAPPER}/dm-core.git"
+  gem 'dm-adjust',       DM_VERSION, :git => "#{DATAMAPPER}/dm-adjust.git"
+  gem 'dm-transactions', DM_VERSION, :git => "#{DATAMAPPER}/dm-transactions.git"
+
+end
+
+group(:development) do # Development dependencies (as in the gemspec)
+
+  gem 'rake',           '~> 0.8.7'
+  gem 'rspec',          '~> 1.3'
+  gem 'jeweler',        '~> 1.4'
+
+end
+
+group :quality do # These gems contain rake tasks that check the quality of the source code
+
+  gem 'metric_fu',      '~> 1.3'
+  gem 'rcov',           '~> 0.9.8'
+  gem 'reek',           '~> 1.2.8'
+  gem 'roodi',          '~> 2.1'
+  gem 'yard',           '~> 0.5'
+  gem 'yardstick',      '~> 0.1'
+
+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.gsub(',',' ').split(' ') - ['in_memory']
+
+  unless adapters.empty?
+
+    DO_VERSION     = '~> 0.10.3'
+    DM_DO_ADAPTERS = %w[sqlite postgres mysql oracle sqlserver]
+
+    gem 'data_objects',  DO_VERSION, :git => "#{DATAMAPPER}/do.git"
+
+    adapters.each do |adapter|
+      if DM_DO_ADAPTERS.any? { |dm_do_adapter| dm_do_adapter =~ /#{adapter}/  }
+        adapter = 'sqlite3' if adapter == 'sqlite'
+        gem "do_#{adapter}", DO_VERSION, :git => "#{DATAMAPPER}/do.git"
+      end
+    end
+
+    gem 'dm-do-adapter', DM_VERSION, :git => "#{DATAMAPPER}/dm-do-adapter.git"
+
+    adapters.each do |adapter|
+      gem "dm-#{adapter}-adapter", DM_VERSION, :git => "#{DATAMAPPER}/dm-#{adapter}-adapter.git"
+    end
+
+  end
+
+  plugins = ENV['PLUGINS'] || ENV['PLUGIN']
+  plugins = (plugins.to_s.gsub(',',' ').split(' ') + ['dm-migrations']).uniq
+
+  plugins.each do |plugin|
+    gem plugin, DM_VERSION, :git => "#{DATAMAPPER}/#{plugin}.git"
+  end
+
+end