merb_relaxdb 1.0

data/Generators

@@ -0,0 +1,3 @@
+scope 'merb-gen' do
+  Merb.add_generators File.join(File.dirname(__FILE__), 'lib', 'generators', 'model')
+end  

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Paul Carey
+
+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.textile

@@ -0,0 +1,79 @@
+h2. Overview
+
+merb_relaxdb is a merb plugin that provides integration with CouchDB via the RelaxDB gem. Version numbers indicate compatibility with Merb. Revision numbers are excluded e.g. merb_relaxdb 1.0 should be compatible with Merb 1.0.x
+
+The current release includes integration with merb-auth, but this should not yet be considered stable. A sample integration file is included below.
+
+merb_relaxdb expects your merb app to augment the standard layout as described in the following tree.
+couchdb.yml is mandatory. Reference data, sample data and views are optional.
+merb-gen model my_model will create a sample couchdb.yml.
+
+To use merb_relaxdb, list @dependency "merb_relaxdb", "1.0"@ in @config/dependencies.rb@ and @use_orm :relaxdb@ in @config/init.rb@
+
+For more details on using RelaxDB, see the "RelaxDB wiki":http://github.com/paulcarey/relaxdb/wikis 
+<pre>
+<code>
+
+  my_merb_app $ tree
+  .
+  |-- Rakefile
+  |-- app
+  |-- autotest
+  |-- config
+  |   |-- couchdb.yml
+  |-- couchdb
+  |   |-- data
+  |   |   |-- reference
+  |   |   |   `-- reference_data.rb
+  |   |   `-- sample
+  |   |       `-- sample_data.rb
+  |   `-- views
+  |       `-- views.js
+  |-- lib
+  |-- log
+  |-- public
+  |-- scratch
+  `-- spec
+  
+</code>
+</pre>
+
+h3. Sample merb/merb-auth/setup.rb
+
+<pre>
+<code>
+begin
+  Merb::Authentication.user_class = User 
+  
+  # Mixin the salted user mixin  
+  require 'merb-auth-more/mixins/salted_user'
+  require 'merb_relaxdb/rdb_salted_user'
+  
+  Merb::Authentication.user_class.class_eval{ include Merb::Authentication::Mixins::SaltedUser }
+      
+  # Setup the session serialization
+  class Merb::Authentication
+
+    def fetch_user(session_user_id)
+      RelaxDB.load(session_user_id) rescue nil
+    end
+
+    def store_user(user)
+      user.nil? ? user : user._id
+    end
+  end
+  
+rescue => e
+  Merb.logger.error <<-TEXT
+  
+    You need to setup some kind of user class with merb-auth.  
+    Merb::Authentication.user_class = User
+    
+    If you want to fully customize your authentication you should use merb-core directly.  
+    
+    See lib/authentication/setup.rb and strategies.rb to customize your setup
+
+    TEXT
+end
+</code>
+</pre>

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'merb-core/tasks/merb_rake_helper'
+
+PLUGIN = "merb_relaxdb"
+GEM_NAME = "merb_relaxdb"
+GEM_VERSION = "1.0"
+AUTHOR = "Paul Carey"
+EMAIL = "paul.p.carey@gmail.com"
+HOMEPAGE = "http://github.com/paulcarey/merb_relaxdb/"
+SUMMARY = "Merb plugin that provides integration with CouchDB"
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.textile", "LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+
+  # s.add_dependency('relaxdb', '>= 0.1.0') # causes rake install to fail
+  # s.add_dependency('paulcarey-relaxdb', '>= 0.1.0') # allows rake install to succeed
+  
+  s.require_path = 'lib'
+  s.autorequire = PLUGIN
+  s.files = %w(LICENSE README.textile Rakefile Generators) + Dir.glob("{lib,spec}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install the gem"
+task :install => [:package] do
+  sh %{sudo gem install --local pkg/#{GEM_NAME}-#{GEM_VERSION} --no-update-sources}
+end
+# task :install do
+#   Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION, :local => true)
+# end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/lib/generators/model.rb

@@ -0,0 +1,4 @@
+Merb::Generators::ModelGenerator.template :model_relaxdb, :orm => :relaxdb do |template|
+  template.source = File.dirname(__FILE__) / "templates/model/app/models/%file_name%.rb"
+  template.destination = "app/models" / base_path / "#{file_name}.rb"
+end

data/lib/generators/templates/model/app/models/%file_name%.rb

@@ -0,0 +1,4 @@
+<% with_modules(modules) do -%>
+class <%= class_name %> < RelaxDB::Document
+end
+<% end -%>

data/lib/merb_relaxdb/connection.rb

@@ -0,0 +1,43 @@
+module Merb
+  module RelaxDB
+    
+    class << self
+      
+      def config_file() Merb.dir_for(:config) / "couchdb.yml" end
+      def sample_dest() Merb.dir_for(:config) / "couchdb.yml.sample" end
+      def sample_source() File.dirname(__FILE__) / "couchdb.yml.sample" end
+      
+      def connect
+        begin
+          configure_db
+          Merb.logger.info "RelaxDB connected to CouchDB #{::RelaxDB.db.uri}"
+        rescue => e
+          uri = ::RelaxDB.db ? ::RelaxDB.db.uri : "<initialisation error>"
+          Merb.logger.fatal "RelaxDB could not connect to CouchDB at #{uri} \n\tRoot cause:#{e}\n#{e.backtrace.join("\n")}"
+          exit(1)
+        end
+      end
+      
+      def configure_db
+        if File.exists?(config_file)        
+          full_config = Erubis.load_yaml_file(config_file)
+          config = full_config[Merb.environment.to_sym]
+          config[:logger] = Merb.logger
+          ::RelaxDB.configure(config)
+          ::RelaxDB.use_db(config[:db])
+        else
+          copy_sample_config
+          Merb.logger.error! "No couchdb.yml file found in #{Merb.root}/config."
+          Merb.logger.error! "A sample file was created called couchdb.yml.sample for you to copy and edit."
+          exit(1)
+        end          
+      end
+
+      def copy_sample_config
+        FileUtils.cp sample_source, sample_dest unless File.exists?(sample_dest)
+      end
+                  
+    end
+    
+  end
+end

data/lib/merb_relaxdb/couchdb.yml.sample

@@ -0,0 +1,12 @@
+:development:
+  :host: localhost
+  :port: 5984
+  :db: mydb_dev
+  :design_doc: my_design_doc
+  
+:test:
+  :host: localhost
+  :port: 5984
+  :db: mydb_test
+  :design_doc: my_design_doc
+  

data/lib/merb_relaxdb/merbtasks.rb

@@ -0,0 +1,74 @@
+desc "Create CouchDB environment from scratch"
+task :relaxdb => ["relaxdb:db", "relaxdb:views", "relaxdb:data", "relaxdb:sample"]
+
+namespace :relaxdb do
+
+  desc "Create CouchDB database"
+  task :db => [:check_env] do
+    puts "Creating db #{RelaxDB.db.name}"
+    
+    RelaxDB.delete_db(RelaxDB.db.name) rescue "ok"
+    RelaxDB.use_db(RelaxDB.db.name)
+  end
+
+  desc "Create CouchDB views auto generated on model load"
+  task :autoviews => [:check_env] do
+    puts "Creating auto generated views"
+    RelaxDB.use_db RelaxDB.db.name    
+    RelaxDB.enable_view_creation
+    Rake::Task["merb_env"].invoke
+  end
+  
+  desc "Create CouchDB views from hand coded JavaScript"
+  task :hand_coded_views => [:check_env] do
+    puts "Creating hand coded views"
+    
+    Dir['couchdb/views/**/*.js'].each do |filename|
+      RelaxDB::ViewUploader.upload(filename)
+    end
+  end
+  
+  desc "Create hand coded and auto generated views"
+  task :views => [:autoviews, :hand_coded_views]
+  
+  desc "Create CouchDB reference data"
+  task :data => [:check_env, :merb_env] do
+    puts "Creating ref data"
+    
+    Dir['couchdb/data/reference/**/*.rb'].each do |filename|
+      require filename
+    end
+  end
+
+  desc "Create CouchDB sample data"
+  task :sample => [:check_env, :merb_env] do
+    create_sample_data
+  end
+  
+  desc "Create minimal CouchDB environment from scratch"
+  task :mindb => ["relaxdb:db", "relaxdb:views"] do
+    Dir['couchdb/data/min/**/*.rb'].each { |f| require f }
+  end
+  
+  desc "Create base CouchDB environment from scratch (no sample data)"
+  task :basedb => ["relaxdb:db", "relaxdb:views", "relaxdb:data"]  
+  
+  desc "Apply all outstanding migrations"
+  task :migrate => [:check_env, :merb_env] do
+    RelaxDB::Migration.run_all Dir["couchdb/migrations/**/*.rb"]
+  end
+
+  task :check_env do
+    unless ENV['MERB_ENV']
+      puts "MERB_ENV must be specified. Example: rake relaxdb MERB_ENV=development"
+      exit(1)
+    end
+  end
+
+  def create_sample_data
+    Dir['couchdb/data/sample/**/*.rb'].each do |filename|
+      require filename
+    end
+  end
+
+end

data/lib/merb_relaxdb/rdb_salted_user.rb

@@ -0,0 +1,53 @@
+class Merb::Authentication
+  module Mixins
+    module SaltedUser
+      module RDBClassMethods
+        
+        def self.extended(base)
+          base.class_eval do
+
+            property :crypted_password
+            property :salt
+
+            before_save :password_checks
+            
+            def password_checks
+              if password_required?
+                return false unless !password.blank? && password == password_confirmation
+              end
+              encrypt_password
+              true
+            end
+            
+          end
+        end
+
+        def authenticate(login, password)
+          login_param = Merb::Authentication::Strategies::Basic::Base.login_param
+          @u = all.sorted_by(login_param) { |q| q.key(login) }.first
+          @u && @u.authenticated?(password) ? @u : nil
+        end 
+                 
+      end
+    end
+  end
+end
+
+class Merb::Authentication
+  module Mixins
+    module SaltedUser
+      
+      def self.included(base)
+        base.class_eval do 
+          attr_accessor :password, :password_confirmation
+          
+          include Merb::Authentication::Mixins::SaltedUser::InstanceMethods
+          extend  Merb::Authentication::Mixins::SaltedUser::ClassMethods
+          extend  Merb::Authentication::Mixins::SaltedUser::RDBClassMethods          
+      
+        end
+      end
+            
+    end
+  end
+end

data/lib/merb_relaxdb.rb

@@ -0,0 +1,21 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+  dependency "relaxdb"
+
+  # Merb gives you a Merb::Plugins.config hash...feel free to put your stuff in your piece of it
+  Merb::Plugins.config[:merb_relaxdb] = {
+    :chickens => false
+  }
+  
+  Merb::BootLoader.before_app_loads do
+    require "yaml"
+    require "merb_relaxdb/connection.rb"  
+    Merb::RelaxDB.connect
+  end
+  
+  Merb::BootLoader.after_app_loads do
+  end
+  
+  Merb::Plugins.add_rakefiles "merb_relaxdb/merbtasks"
+      
+end

data/spec/merb_relaxdb_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "merb_relaxdb" do
+  it "should do nothing" do
+    true.should == true
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: merb_relaxdb
+version: !ruby/object:Gem::Version 
+  version: "1.0"
+platform: ruby
+authors: 
+- Paul Carey
+autorequire: merb_relaxdb
+bindir: bin
+cert_chain: []
+
+date: 2009-05-27 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Merb plugin that provides integration with CouchDB
+email: paul.p.carey@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.textile
+- LICENSE
+files: 
+- LICENSE
+- README.textile
+- Rakefile
+- Generators
+- lib/generators
+- lib/generators/model.rb
+- lib/generators/templates
+- lib/generators/templates/model
+- lib/generators/templates/model/app
+- lib/generators/templates/model/app/models
+- lib/generators/templates/model/app/models/%file_name%.rb
+- lib/merb_relaxdb
+- lib/merb_relaxdb/connection.rb
+- lib/merb_relaxdb/couchdb.yml.sample
+- lib/merb_relaxdb/merbtasks.rb
+- lib/merb_relaxdb/rdb_salted_user.rb
+- lib/merb_relaxdb.rb
+- spec/merb_relaxdb_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/paulcarey/merb_relaxdb/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Merb plugin that provides integration with CouchDB
+test_files: []
+