merb_datamapper 0.4.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 YOUR NAME
+
+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/README

@@ -0,0 +1,8 @@
+merb_data_mapper
+=================
+
+A plugin for the Merb framework that provides DataMapper access
+
+To use sessions:
+set the session store to data_mapper in merb.yml
+add the dependency in dependencies.rb: dependency "merb_data_mapper"

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+PLUGIN = "merb_datamapper"
+NAME = "merb_datamapper"
+VERSION = "0.4.2"
+AUTHOR = "Jason Toy"
+EMAIL = "jtoy@rubynow.com"
+HOMEPAGE = "http://merbivore.com"
+SUMMARY = "Merb plugin that provides DataMapper support for Merb"
+
+spec = Gem::Specification.new do |s|
+  s.name = NAME
+  s.version = VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb', '>= 0.4.0')
+  s.add_dependency('datamapper')
+  s.require_path = 'lib'
+  s.autorequire = PLUGIN
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs,datamapper_generators}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+task :install do
+  sh %{rake package}
+  sh %{sudo gem install pkg/#{NAME}-#{VERSION}}
+end

data/TODO

@@ -0,0 +1,4 @@
+TODO:
+Add proper migration support as soon as its released
+Fix session support
+finish rake tasks

data/datamapper_generators/migration/USAGE

@@ -0,0 +1,5 @@
+Description:
+  
+  
+Usage:
+  

data/datamapper_generators/migration/migration_generator.rb

@@ -0,0 +1,64 @@
+require 'merb'
+class MigrationGenerator < RubiGen::Base
+  
+  default_options :author => nil
+  
+  attr_reader :name
+  
+  def initialize(runtime_args, runtime_options = {})
+    super
+    usage if args.empty?
+    @name = args.shift
+    extract_options
+  end
+
+  def manifest
+    unless @name
+      puts banner
+      exit 1
+    end
+    record do |m|
+      # Ensure appropriate folder(s) exists
+      m.directory 'schema/migrations'
+
+      # Create stubs
+      highest_migration = Dir[Dir.pwd+'/schema/migrations/*'].map{|f| File.basename(f) =~ /^(\d+)/; $1}.max
+      filename = format("%03d_%s", (highest_migration.to_i+1), @name.snake_case)
+      m.template "new_migration.erb", "schema/migrations/#{filename}.rb", :assigns => { :class_name => @name }
+
+    end
+  end
+
+  protected
+    def banner
+      <<-EOS
+Creates a new migration for merb using DataMapper
+
+USAGE: #{$0} #{spec.name} NameOfMigration
+
+Example:
+  #{$0} #{spec.name} AddPeople
+
+  If you already have 3 migrations, this will create the AddPeople migration in
+  schema/migration/004_add_people.rb
+EOS
+    end
+
+    def add_options!(opts)
+      # opts.separator ''
+      # opts.separator 'Options:'
+      # For each option below, place the default
+      # at the top of the file next to "default_options"
+      # opts.on("-a", "--author=\"Your Name\"", String,
+      #         "Some comment about this option",
+      #         "Default: none") { |options[:author]| }
+      # opts.on("-v", "--version", "Show the #{File.basename($0)} version number and quit.")
+    end
+    
+    def extract_options
+      # for each option, extract it into a local variable (and create an "attr_reader :author" at the top)
+      # Templates can access these value via the attr_reader-generated methods, but not the
+      # raw instance variable value.
+      # @author = options[:author]
+    end
+end

data/datamapper_generators/migration/templates/new_migration.erb

@@ -0,0 +1,7 @@
+class <%= class_name.snake_case.camel_case %> < DataMapper::Migration
+  def self.up
+  end
+
+  def self.down
+  end
+end

data/datamapper_generators/model/model_generator.rb

@@ -0,0 +1,17 @@
+require 'merb/generators/merb_generator_helpers'
+
+class ModelGenerator < Merb::GeneratorHelpers::ModelGeneratorBase
+  
+  def initialize( *args )
+    super( *args )
+    options[:skip_migration] = true
+    @model_template_name = "new_model_template.erb"
+    # @migration_generator_name = "dm_migration"
+    @model_test_generator_name = "merb_model_test"
+  end
+  
+  def self.superclass
+    RubiGen::Base
+  end
+    
+end

data/datamapper_generators/model/templates/new_model_template.erb

@@ -0,0 +1,6 @@
+class <%= class_name %> < DataMapper::Base
+<% table_attributes.each do |attr| -%>
+  <%= "property :#{attr.name}, :#{attr.type}" %>
+<% end -%>
+end
+

data/datamapper_generators/resource_controller/resource_controller_generator.rb

@@ -0,0 +1,27 @@
+require 'merb/generators/merb_generator_helpers'
+
+class ResourceControllerGenerator < Merb::GeneratorHelpers::ControllerGeneratorBase
+
+
+  def initialize(*args)
+    runtime_options = args.last.is_a?(Hash) ? args.pop : {}
+    name, *actions = args.flatten
+    runtime_options[:actions] = %w[index show new edit]
+    runtime_options[:test_stub_generator] = "merb_controller_test"
+    super( [name], runtime_options )
+  end
+
+  def self.superclass
+    RubiGen::Base
+  end
+  
+  protected
+  def banner
+        <<-EOS
+  Creates a Merb controller, views and specs using Datamapper Models
+
+  USAGE: #{$0} #{spec.name} resource_name"
+  EOS
+  end
+  
+end

data/datamapper_generators/resource_controller/templates/controller.rb

@@ -0,0 +1,54 @@
+<% klass = class_name.singularize -%>
+<% ivar = class_name.snake_case.singularize -%>
+class <%= class_name %> < Application
+  provides :xml, :js, :yaml
+  
+  def index
+    @<%= ivar %>s = <%= klass %>.all
+    render @<%= ivar %>s
+  end
+  
+  def show(id)
+    @<%= ivar %> = <%= klass %>[id]
+    render @<%= ivar %>
+  end
+  
+  def new(<%= ivar %>)
+    only_provides :html
+    @<%= ivar %> = <%= klass %>.new(<%= ivar %>)
+    render @<%= ivar %>
+  end
+  
+  def create(<%= ivar %>)
+    @<%= ivar %> = <%= klass %>.new()
+    if @<%= ivar %>.save
+      redirect url(:<%= ivar %>, @<%= ivar %>)
+    else
+      render :action => :new
+    end
+  end
+  
+  def edit
+    only_provides :html
+    @<%= ivar %> = <%= klass %>.find(params[:id])
+    render
+  end
+  
+  def update(id, <%= ivar %>)
+    @<%= ivar %> = <%= klass %>[id]
+    if @<%= ivar %>.update_attributes(<%= ivar %>)
+      redirect url(:<%= ivar %>, @<%= ivar %>)
+    else
+      raise BadRequest
+    end
+  end
+  
+  def destroy(id)
+    @<%= ivar %> = <%= klass %>[id]
+    if @<%= ivar %>.destroy!
+      redirect url(:<%= ivar %>s)
+    else
+      raise BadRequest
+    end
+  end
+end

data/datamapper_generators/resource_controller/templates/edit.html.erb

@@ -0,0 +1 @@
+Edit for <%= class_name %>

data/datamapper_generators/resource_controller/templates/helper.rb

@@ -0,0 +1,5 @@
+module Merb
+module <%= class_name %>Helper
+  
+  end
+end

data/datamapper_generators/resource_controller/templates/index.html.erb

@@ -0,0 +1 @@
+Index for <%= class_name %>

data/datamapper_generators/resource_controller/templates/new.html.erb

@@ -0,0 +1 @@
+New for <%= class_name %>

data/datamapper_generators/resource_controller/templates/show.html.erb

@@ -0,0 +1 @@
+Show for <%= class_name %>

data/lib/merb/orms/data_mapper/connection.rb

@@ -0,0 +1,50 @@
+require 'fileutils'
+require 'data_mapper'
+
+module Merb
+  module Orms
+    module DataMapper
+      class << self
+        def config_file() MERB_ROOT / "config" / "database.yml" end
+        def sample_dest() MERB_ROOT / "config" / "database.sample.yml" end
+        def sample_source() File.dirname(__FILE__) / "database.sample.yml" end
+      
+        def copy_sample_config
+          FileUtils.cp sample_source, sample_dest unless File.exists?(sample_dest)
+        end
+      
+        def config
+          @config ||=
+            begin
+              # Convert string keys to symbols
+              full_config = Erubis.load_yaml_file(config_file)
+              config = (Merb::Plugins.config[:merb_data_mapper] = {})
+              (full_config[MERB_ENV.to_sym] || full_config[MERB_ENV]).each { |k, v| config[k.to_sym] = v }
+              config
+            end
+        end
+      
+        # Database connects as soon as the gem is loaded
+        def connect
+          if File.exists?(config_file)
+            puts "Connecting to database..."
+            ::DataMapper::Database.setup(config)
+          else
+            copy_sample_config
+            puts "No database.yml file found in #{MERB_ROOT}/config."
+            puts "A sample file was created called database.sample.yml for you to copy and edit."
+            exit(1)
+          end
+        end
+        
+        # Registering this ORM lets the user choose DataMapper as a session store
+        # in merb.yml's session_store: option.
+        def register_session_type
+          Merb::Server.register_session_type("data_mapper",
+            "merb/session/data_mapper_session",
+            "Using DataMapper database sessions")
+        end
+      end
+    end
+  end
+end

data/lib/merb/orms/data_mapper/database.sample.yml

@@ -0,0 +1,16 @@
+---
+# This is a sample database file for the DataMapper ORM
+:development: &defaults
+  :adapter: postgresql
+  :database: sample_development
+  :username: the_user
+  :password: secrets
+  :host: localhost
+
+:test:
+  <<: *defaults
+  :database: sample_test
+
+:production:
+  <<: *defaults
+  :database: sample_production

data/lib/merb/orms/data_mapper/tasks/databases.rb

@@ -0,0 +1,25 @@
+require 'fileutils'
+
+namespace :dm do
+  namespace :db do
+    desc "Perform migration using migrations in schema/migrations"
+    task :migrate => :merb_env do
+      #Sequel::Migrator.apply(Merb::Orms::Sequel.connect, "schema/migrations", ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+    end
+  end
+  
+  namespace :sessions do
+    desc "Creates session migration"
+    task :create => :merb_env do
+      dest = File.join(MERB_ROOT, "schema", "migrations","001_add_sessions_table.rb")
+      source = File.join(File.dirname(__FILE__), "merb", "session","001_add_sessions_table.rb")
+      #FileUtils.cp source, dest unless File.exists?(dest)
+    end
+    
+    desc "Clears sessions"
+    task :clear => :merb_env do
+      table_name = (Merb::Plugins.config[:data_mapper][:session_table_name] || "sessions")
+      #Merb::Orms::DataMapper.connect.execute("DELETE FROM #{table_name}")
+    end
+  end
+end

data/lib/merb/session/data_mapper_session.rb

@@ -0,0 +1,98 @@
+require 'data_mapper'
+require 'base64'
+module Merb
+  module SessionMixin
+    def setup_session
+      MERB_LOGGER.info("Setting up session")
+      before = cookies[_session_id_key]
+      @_session, cookies[_session_id_key] = Merb::DataMapperSession.persist(cookies[_session_id_key])
+      @_fingerprint = Marshal.dump(@_session.data).hash
+      @_new_cookie = cookies[_session_id_key] != before
+    end
+  
+    def finalize_session
+      MERB_LOGGER.info("Finalize session")
+      @_session.save if @_fingerprint != Marshal.dump(@_session.data).hash
+      set_cookie(_session_id_key, @_session.session_id, _session_expiry) if (@_new_cookie || @_session.needs_new_cookie)
+    end
+  end
+
+  table_name = (Merb::Plugins.config[:merb_data_mapper][:session_table_name] || "sessions")
+  
+  class DataMapperSession < DataMapper::Base
+    
+    set_table_name "sessions"
+    property :session_id, :text
+    property :data, :text
+  
+    attr_accessor :needs_new_cookie
+  
+    class << self
+      # Generates a new session ID and creates a row for the new session in the database.
+      def generate
+        create(:session_id => Merb::SessionMixin::rand_uuid, :data =>{})
+      end
+    
+      # Gets the existing session based on the <tt>session_id</tt> available in cookies.
+      # If none is found, generates a new session.
+      def persist(session_id)
+        if session_id
+          session = self[:session_id => session_id]
+        end
+        unless session
+          session = generate
+        end
+        [session, session.session_id]
+      end
+
+      def marshal(data) Base64.encode64(Marshal.dump(data)) if data end
+      def unmarshal(data) Marshal.load(Base64.decode64(data)) if data end
+    end
+  
+    # Regenerate the Session ID
+    def regenerate
+      self.session_id = Merb::SessionMixin::rand_uuid
+      self.needs_new_cookie = true
+      self.save
+    end 
+  
+    # Recreates the cookie with the default expiration time 
+    # Useful during log in for pushing back the expiration date 
+    def refresh_expiration
+      self.needs_new_cookie = true
+    end
+  
+    # Lazy-delete of session data 
+    def delete
+      data = {}
+    end
+  
+    def [](key)
+      data[key]
+    end
+  
+    def []=(key, val)
+      data[key] = val
+    end
+  
+    def data
+      @unmarshalled_data || @unmarshalled_data = self.class.unmarshal(@data)
+    end
+
+  
+  private
+    
+    before_save :serialize_data
+    
+    def serialize_data
+      @data = self.class.marshal(self.data)
+    end
+  end
+
+  
+  unless DataMapper.database.table_exists?(table_name)
+    puts "Warning: The database did not contain a '#{table_name}' table for sessions."
+    DataMapperSession.auto_migrate!
+    puts "Created sessions table."
+  end
+end

data/lib/merb_datamapper.rb

@@ -0,0 +1,11 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+  if Merb::Server.app_loaded?
+    puts "Warning: The merb_data_mapper gem must be loaded before the application"
+  else
+    require "merb/orms/data_mapper/connection"
+    Merb::Orms::DataMapper.connect
+    Merb::Orms::DataMapper.register_session_type
+  end
+  Merb::Plugins.add_rakefiles "merb/orms/data_mapper/tasks/databases"
+end

data/specs/spec_helper.rb

@@ -0,0 +1,2 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: merb_datamapper
+version: !ruby/object:Gem::Version 
+  version: 0.4.2
+date: 2007-11-06 00:00:00 -06:00
+summary: Merb plugin that provides DataMapper support for Merb
+require_paths: 
+- lib
+email: jtoy@rubynow.com
+homepage: http://merbivore.com
+rubyforge_project: 
+description: Merb plugin that provides DataMapper support for Merb
+autorequire: merb_datamapper
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Jason Toy
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/merb
+- lib/merb_datamapper.rb
+- lib/merbtasks.rb
+- lib/merb/orms
+- lib/merb/session
+- lib/merb/orms/data_mapper
+- lib/merb/orms/data_mapper/connection.rb
+- lib/merb/orms/data_mapper/database.sample.yml
+- lib/merb/orms/data_mapper/tasks
+- lib/merb/orms/data_mapper/tasks/databases.rb
+- lib/merb/session/data_mapper_session.rb
+- specs/merb_sequel_spec.rb
+- specs/spec_helper.rb
+- datamapper_generators/migration
+- datamapper_generators/model
+- datamapper_generators/resource_controller
+- datamapper_generators/migration/migration_generator.rb
+- datamapper_generators/migration/templates
+- datamapper_generators/migration/USAGE
+- datamapper_generators/migration/templates/new_migration.erb
+- datamapper_generators/model/model_generator.rb
+- datamapper_generators/model/templates
+- datamapper_generators/model/USAGE
+- datamapper_generators/model/templates/new_model_template.erb
+- datamapper_generators/resource_controller/resource_controller_generator.rb
+- datamapper_generators/resource_controller/templates
+- datamapper_generators/resource_controller/USAGE
+- datamapper_generators/resource_controller/templates/controller.rb
+- datamapper_generators/resource_controller/templates/edit.html.erb
+- datamapper_generators/resource_controller/templates/helper.rb
+- datamapper_generators/resource_controller/templates/index.html.erb
+- datamapper_generators/resource_controller/templates/new.html.erb
+- datamapper_generators/resource_controller/templates/show.html.erb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: datamapper
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: