datamapper4rails 0.3.0

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2009-03-18
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,37 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+datamapper_rails_templates.rb
+generators/datamapper_install/datamapper_install_generator.rb
+generators/datamapper_install/templates/datamapper.rake
+generators/datamapper_model/datamapper_model_generator.rb
+generators/datamapper_model/templates/migration.rb
+generators/datamapper_model/templates/model.rb
+generators/datamapper_rspec_model/datamapper_rspec_model_generator.rb
+generators/datamapper_rspec_model/templates/model_spec.rb
+generators/datamapper_rspec_scaffold/datamapper_rspec_scaffold_generator.rb
+generators/datamapper_rspec_scaffold/templates/controller_spec.rb
+generators/datamapper_rspec_scaffold/templates/edit_erb_spec.rb
+generators/datamapper_scaffold/datamapper_scaffold_generator.rb
+generators/datamapper_scaffold/templates/controller.rb
+generators/datamapper_scaffold/templates/functional_test.rb
+generators/datamapper_scaffold/templates/view_edit.html.erb
+generators/datamapper_scaffold/templates/view_index.html.erb
+generators/datamapper_scaffold/templates/view_new.html.erb
+generators/datamapper_scaffold/templates/view_show.html.erb
+lib/datamapper4rails.rb
+lib/datamapper4rails/adapters/base_adapter.rb
+lib/datamapper4rails/adapters/restful_adapter.rb
+lib/datamapper4rails/datamapper_store.rb
+lib/datamapper4rails/integration_test.rb
+lib/datamapper4rails/identity_maps.rb
+lib/datamapper4rails/overlay.rb
+lib/datamapper4rails/preload_models.rb
+lib/datamapper4rails/restful_transactions.rb
+lib/datamapper4rails/rspec_default_values.rb
+lib/datamapper4rails/rspec.rb
+lib/datamapper4rails/version.rb
+spec/datamapper_store_spec.rb
+spec/spec.opts
+spec/spec_helper.rb

data/README.txt

@@ -0,0 +1,151 @@
+= datamapper4rails
+
+* http://datamapper4rail.rubyforge.org
+* http://github.org/mkristian/datamapper4rails
+
+== DESCRIPTION:
+
+collection of datamapper related extensions. mostly needed to run within rails. the restful transactions is around filter for rails actions if needed to control such transaction on per action base otherwise use the rack extension from rack-datamapper. datamapper store is a session store for rails which uses datamapper as persistent layer and is just a wrapper around the datamapper session store from rack-datamapper. the generators produces datamapper models for your rails application.
+
+== FEATURES/PROBLEMS:
+
+* the generators introduce an "overlay" of templates. with that a generator can reuse the generator code and just replace one or more templates. i.e. datamapper_model just replaces the model.rb template to produce model using datamapper.
+
+== SYNOPSIS:
+
+=== restful transaction
+
+wraps all modifying requests (POST, PUT, DELETE) into a transaction. any error/exception as well render of a page will rollback the transaction. typically if a POST, PUT or DELETE succeeds then a redirect gets send back to browser.
+
+credits of the main idea goes to http://www.redhillonrails.org
+
+is implemented as around filter in rails and gets prepend to the filters of the action_controller of rails
+
+  require 'datamapper4rails/restful_transations'
+
+=== restful transactions, transactions or identity_maps from rack-datamapper
+
+inside rails add something like this to your config
+
+config.middleware.use 'DataMapper::IdentityMaps'
+config.middleware.use 'DataMapper::RestfulTransactions'
+
+or add the repository name to it if you want something else then :default
+
+config.middleware.use 'DataMapper::IdentityMaps', :ldap
+config.middleware.use 'DataMapper::RestfulTransactions', :users
+
+
+=== datamapper session store
+
+add in your config/initializers/session.rb
+
+    ActionController::Base.session_store = :datamapper_store
+
+in case you need a memory cache for your sessions on top of it add the following. but be aware that there is no cleanup of the memory session.
+
+  ActionController::Base.session = { :cache => true }
+
+=== generators for datamapper models
+
+IMPORTANT: datamapper_scaffold generate valid application code but the test do NOT run due to missing fixtures with datamapper. the rspec version works well though.
+
+* datamapper-install: rake task for datamapper with automigrate, autoupgrade and migrate
+* datamapper_model
+* datamapper_rspec_model
+* datamapper_scaffold
+* datamapper_rspec_scaffold
+
+the last  four generators follow the parameters of  the underlying generator:
+generator_name model_name [[attribute_name:attribute_type] ...]
+
+to use the overlay write the generator like this
+
+class MyModelGenerator < ModelGenerator
+  def manifest
+    overlay_dirs.add_generator("model")
+    super
+  end
+end
+
+and put whatever templates you want to overwrite in your templates directory, i.e. all your models need to have nice to_s methods.
+
+=== patch for the rspec-rails gem
+
+add a file like spec/support/datamapper with
+
+require 'datamapper4rails/rspec'
+
+this allows rspec to stub_model with datamapper
+
+=== restful adapter
+
+DEPRECATED
+this comes partly from dm-ldap-adapter and partly from dm-more/adapter/rest_adapter. the restful adapter allows to Create, Retrieve, Update and Delete resources via a restful service.
+
+== rails template
+
+there is a rails template 'datamapper_rails_templates.rb' in root of the gem - do not know where and how to pack it. the latest I keep on 'github.org/jeremy/rails-templates'
+
+=== to test the template there is helper class
+
+task :integration_tests => [:install] do
+  require 'datamapper4rails/integration_test'
+  Datamapper4Rails::IntegrationTest.new do |t|
+    t.rails_template = 'my_template.rb'
+    t.directory = 'tmp' # defaults to tmp and is also the generated application name
+    t.generate "datamapper_model role name:string"
+    t.generate "datamapper_scaffold domain name:string"
+    t.generate "datamapper_rspec_model user name:string"
+    t.generate "datamapper_rspec_scaffold group name:string"
+  end
+end
+
+== more examples 
+
+just run 'rake integration' and have a look at the sample rails application in 'tmp'
+
+== jruby
+
+at the time of writing there is a bug/restriction in rails which prevents unpacked gems with java extension or version number postfixed with '-java' to work.
+
+if you are familiar with maven (maven.apache.org) you can use the maven plugin from github.org/mkristian/rails-maven-plugin to freeze rails gems and patch it in place
+
+mvn de.saumya.mojo:rails-maven-plugin:rails-freeze-gems
+
+the 'rake integration_tests' does not work due to the fact that generating rails with a template falls back to native ruby for certain tasks which will fail due to missing (java) gems.
+
+same is true for using the rails template. in case you want to use a rails template directly with jruby consider the rails-maven-plugin which can setup a mavenized rails application with the help of rails templates.
+
+== REQUIREMENTS:
+
+* rails_datamapper, rack-datamapper
+
+== INSTALL:
+
+* sudo gem install datamapper4rails
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Kristian Meier
+
+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,48 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+require 'spec'
+require 'spec/rake/spectask'
+require 'pathname'
+
+require './lib/datamapper4rails/version.rb'
+
+Hoe.new('datamapper4rails', Datamapper4rails::VERSION) do |p|
+  p.rubyforge_name = 'datamapper4rail'
+  p.developer('mkristian', 'm.kristian@web.de')
+  p.extra_deps = [['rack-datamapper', '~>0.2'], 'rails_datamapper']
+  p.remote_rdoc_dir = '' # Release to root
+end
+
+desc 'Install the package as a gem.'
+task :install => [:clean, :package] do
+  gem = Dir['pkg/*.gem'].first
+  sh "gem install --local #{gem} --no-ri --no-rdoc"
+end
+
+desc 'Run specifications'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  if File.exists?('spec/spec.opts')
+    t.spec_opts << '--options' << 'spec/spec.opts'
+  end
+  t.spec_files = Pathname.glob('./spec/**/*_spec.rb')
+end
+
+desc 'generate rails using all generators and run the specs'
+task :integration_tests => [:spec, :install] do
+  require 'datamapper4rails/integration_test'
+  Datamapper4Rails::IntegrationTest.new do |t|
+    t.generate "datamapper_model role name:string"
+    t.generate "datamapper_scaffold domain name:string"
+    t.generate "datamapper_rspec_model user name:string"
+    t.generate "datamapper_rspec_scaffold group name:string"
+  end
+end
+
+require 'yard'
+
+YARD::Rake::YardocTask.new
+
+# vim: syntax=Ruby

data/datamapper_rails_templates.rb

@@ -0,0 +1,114 @@
+# inspired by http://www.rowtheboat.com/archives/32
+###################################################
+
+# get all datamapper related gems
+gem "addressable", :lib => "addressable/uri"
+
+# assume sqlite3 to be database
+gem "do_sqlite3"
+
+# assume you want to have validations and timestamps in your models
+gem 'dm-validations'
+gem 'dm-timestamps'
+gem 'dm-migrations'
+gem 'dm-serializer' # to allow xml interface to work
+
+# assume you prefer rspec over unit tests
+gem "rspec", :lib => false
+gem "rspec-rails", :lib => false
+
+# this pulls in rails_datamapper and rack_datamapper
+gem "datamapper4rails"
+
+# install all gems
+rake "gems:install"
+
+# install specs rake tasks
+generate("rspec", "-f")
+
+# install datamapper rake tasks
+generate("datamapper_install")
+
+# fix config files to work with datamapper instead of active_record
+environment "" 
+environment "config.frameworks -= [ :active_record ]"
+environment "# deactive active_record"
+gsub_file 'spec/spec_helper.rb', /^\s*config[.]/, '  #\0'
+gsub_file 'test/test_helper.rb', /^[^#]*fixtures/, '  #\0'
+
+file 'spec/support/datamapper.rb', <<-CODE
+require 'datamapper4rails/rspec'
+CODE
+
+# add middleware
+def middleware(name)
+  log "middleware", name
+  environment "config.middleware.use '#{name}'"
+end
+
+environment ""
+middleware "DataMapper::RestfulTransactions"
+middleware "DataMapper::IdentityMaps"
+middleware "Rack::Deflater"
+environment "# add middleware"
+
+
+# init a session store
+initializer 'datamapper_store.rb', <<-CODE
+# init a session store which uses a memory cache and a persistent store
+# cleanup can be a problem. jruby uses soft-references for the cache so
+# memory cleanup with jruby is not a problem.
+require 'ixtlan/session'
+ActionController::Base.session_store = :datamapper_store
+ActionController::Base.session = {
+  :cache       => true,
+}
+CODE
+
+# gzip fix for jruby
+initializer 'monkey_patches.rb', <<-CODE
+if RUBY_PLATFORM =~ /java/
+  require 'zlib'
+  class Zlib::GzipWriter
+    def <<(arg)
+      write(arg)
+    end
+  end
+end
+CODE
+
+file 'prepare_jruby.sh', <<-CODE
+#!/bin/bash
+
+echo
+echo "shall freeze rails and fix a bug which prevents rails to use certain"
+echo "java gems like the dataobjects drivers !!"
+echo
+
+mvn --version
+if [ $? -ne 0 ] ; then
+
+        echo "please install maven >= 2.0.9 from maven.apache.org"
+        exit -1
+fi
+
+mvn de.saumya.mojo:rails-maven-plugin:rails-freeze-gems de.saumya.mojo:rails-maven-plugin:gems-install
+
+echo
+echo "you can run rails with (no need to install jruby !!)"
+echo
+echo "\tmvn de.saumya.mojo:rails-maven-plugin:server"
+echo
+echo "more info on"
+echo "\thttp://github.org/mkristian/rails-maven-plugin"
+echo
+CODE
+
+rake 'db:sessions:create'
+
+logger.info 
+logger.info 
+logger.info "info mavenized rails application"
+logger.info "\thttp://github.org/mkristian/rails-maven-plugin"
+logger.info 
+logger.info 

data/generators/datamapper_install/datamapper_install_generator.rb

@@ -0,0 +1,12 @@
+require 'rails_generator/base'
+
+class DatamapperInstallGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.directory 'lib/tasks'
+      m.template 'datamapper.rake', 'lib/tasks/datamapper.rake'
+    end
+  end
+
+end

data/generators/datamapper_install/templates/datamapper.rake

@@ -0,0 +1,88 @@
+# this file is from dm-more/rails_datamapper
+# add adjusted to use the rack_datamapper session store
+
+# Monkey patch to allow overriding defined rake tasks (instead of
+# adding to them, which is the default behaviour when specifying tasks
+# >1 times).
+
+Rake::TaskManager.class_eval do
+  def remove_task(task_name)
+    @tasks.delete(task_name.to_s)
+  end
+end
+
+def remove_task(task_name)
+  returning Rake.application do |app|
+    app.remove_task(app[task_name].name)
+  end
+end
+
+# Until AR/DM co-existence becomes practically possible, presume
+# mutual exclusivity between the two.  Thus we wipe all pre-existing
+# db tasks which we assume to be ActiveRecord-based and thus won't
+# work).
+
+Rake.application.tasks.select do |t|
+  t.class == Rake::Task && t.name.starts_with?("db")
+end.each { |t| remove_task(t.name) }
+
+namespace :db do
+
+  desc 'Perform automigration'
+  task :automigrate => :environment do
+    FileList["app/models/**/*.rb"].each do |model|
+      load model
+    end
+    ::DataMapper.auto_migrate!
+  end
+
+  desc 'Perform non destructive automigration'
+  task :autoupgrade => :environment do
+    FileList["app/models/**/*.rb"].each do |model|
+      load model
+    end
+    ::DataMapper.auto_upgrade!
+  end
+
+  # this is needed for rspec and test tasks  
+  namespace :test do
+    RAILS_ENV = 'test'
+    task :prepare => :automigrate
+  end
+
+  namespace :migrate do
+    task :load => :environment do
+      require 'dm-migrations/migration_runner'
+      FileList['db/migrate/*.rb'].each do |migration|
+        load migration
+      end
+    end
+
+    desc 'Migrate up using migrations'
+    task :up, :version, :needs => :load do |t, args|
+      version = args[:version]
+      migrate_up!(version)
+    end
+
+    desc 'Migrate down using migrations'
+    task :down, :version, :needs => :load do |t, args|
+      version = args[:version]
+      migrate_down!(version)
+    end
+  end
+
+  desc 'Migrate the database to the latest version'
+  task :migrate => 'db:migrate:up'
+
+  namespace :sessions do
+    desc "Creates the sessions table for rack DataMapperStore (works only with the default session class)"
+    task :create => :environment do
+      ::DataMapper::Session::Abstract::Session.auto_migrate!
+    end
+
+    desc "Clear the sessions table for rack DataMapperStore (works only with the default session class)"
+    task :clear => :environment do
+      ::DataMapper::Session::Abstract::Session.all.destroy!
+    end
+  end
+end