active_wrapper 0.2.0

data/MIT-LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2009 Winton Welsh
+
+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.markdown

@@ -0,0 +1,91 @@
+ActiveWrapper
+=============
+
+Wraps ActiveRecord and Logger for use in non-Rails environments.
+
+Setup
+-----
+
+<pre>
+sudo gem install active_wrapper
+</pre>
+
+Usage
+-----
+
+<pre>
+require 'rubygems'
+require 'active_wrapper'
+
+$db, $log, $mail = ActiveWrapper.setup(
+  :base => File.dirname(__FILE__),
+  :env => 'development',
+  :log => 'custom',
+  :stdout => true
+)
+
+$db.drop_db
+$db.create_db
+$db.establish_connection
+$db.generate_migration('my_migration')
+$db.migrate('001')
+$db.migrate_reset
+$log.info('log this')
+$log.clear
+$mail.deliver(:from => 'me@me.com', :to => 'you@you.com', :subject => 'subject', :body => 'body')
+</pre>
+
+<code>ActiveWrapper</code> looks for the following files within the <code>:base</code> directory:
+
+* <b>config/database.yml</b>
+* <b>config/mail.yml</b>
+* <b>db/migrate/*.rb</b>
+
+The <code>:env</code> option is <code>"development"</code> by default.
+
+Logger
+------
+
+In the previous example, the log is stored in <b>log/custom.log</b>.
+
+If no <code>:log</code> name is specified, the <code>:env</code> option is used for the log name.
+
+You may also set <code>:log</code> to false to disable logging entirely.
+
+Setting <code>:stdout</code> to true causes stdout and stderr to redirect to the logger. It is false by default.
+
+Mailer
+------
+
+Your <b>mail.yml</b> should look something like this:
+
+<pre>
+development:
+  smtp:
+    address: smtp.gmail.com
+    authentication: :plain
+    domain: gmail.com
+    password: password
+    port: 587
+    enable_starttls_auto: true
+    user_name: user@gmail.com
+</pre>
+
+This file is optional.
+
+Rakefile
+--------
+
+Add this to your project's <b>Rakefile</b> for database migration and log tasks:
+
+<pre>
+require 'rubygems'
+require 'rake'
+require 'active_wrapper/tasks'
+
+ActiveWrapper::Tasks.new(:log => 'custom') do
+  # Put stuff you would normally put in the environment task here
+end
+</pre>
+
+Pass the same options to <code>ActiveWrapper::Tasks.new</code> as you would <code>ActiveWrapper.new</code>.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'gemspec'
+
+desc "Generate gemspec"
+task :gemspec do
+  File.open("#{Dir.pwd}/#{GEM_NAME}.gemspec", 'w') do |f|
+    f.write(GEM_SPEC.to_ruby)
+  end
+end
+
+desc "Install gem"
+task :install do
+  Rake::Task['gem'].invoke
+  `sudo gem uninstall #{GEM_NAME} -x`
+  `sudo gem install pkg/#{GEM_NAME}*.gem`
+  `rm -Rf pkg`
+end
+
+desc "Package gem"
+Rake::GemPackageTask.new(GEM_SPEC) do |pkg|
+  pkg.gem_spec = GEM_SPEC
+end
+
+desc "Setup project"
+task :setup do
+  name = File.basename(Dir.pwd)
+  `rm -Rf .git`
+  begin
+    dir = Dir['**/gem_template*']
+    from = dir.pop
+    if from
+      rb = from.include?('.rb')
+      to = File.dirname(from) + "/#{name}#{'.rb' if rb}"
+      FileUtils.mv(from, to)
+    end
+  end while dir.length > 0
+  Dir["**/*"].each do |path|
+    next if path.include?('Rakefile')
+    if File.file?(path)
+      `sed -i "" 's/gem_template/#{name}/g' #{path}`
+    end
+  end
+  `git init`
+end
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.rcov = true
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = FileList["spec/**/*_spec.rb"]
+end

data/active_wrapper.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{active_wrapper}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Winton Welsh"]
+  s.date = %q{2009-08-13}
+  s.email = %q{mail@wintoni.us}
+  s.extra_rdoc_files = ["README.markdown"]
+  s.files = ["active_wrapper.gemspec", "gemspec.rb", "lib", "lib/active_wrapper", "lib/active_wrapper/db.rb", "lib/active_wrapper/log.rb", "lib/active_wrapper/mail.rb", "lib/active_wrapper/tasks.rb", "lib/active_wrapper.rb", "MIT-LICENSE", "Rakefile", "README.markdown", "resources", "resources/migration.template", "spec", "spec/active_wrapper", "spec/active_wrapper/db_spec.rb", "spec/active_wrapper/log_spec.rb", "spec/example_project", "spec/example_project/config", "spec/example_project/config/database.yml", "spec/example_project/db", "spec/example_project/db/migrate", "spec/example_project/db/migrate/001_test.rb", "spec/example_project/Rakefile", "spec/spec.opts", "spec/spec_helper.rb"]
+  s.homepage = %q{http://github.com/winton/active_wrapper}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Wraps ActiveRecord and Logger for use in non-Rails environments}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, ["= 2.3.2"])
+      s.add_runtime_dependency(%q<actionmailer>, ["= 2.3.2"])
+    else
+      s.add_dependency(%q<activerecord>, ["= 2.3.2"])
+      s.add_dependency(%q<actionmailer>, ["= 2.3.2"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, ["= 2.3.2"])
+    s.add_dependency(%q<actionmailer>, ["= 2.3.2"])
+  end
+end

data/gemspec.rb

@@ -0,0 +1,23 @@
+GEM_NAME = 'active_wrapper'
+GEM_FILES = FileList['**/*'] - FileList[
+  'coverage', 'coverage/**/*',
+  'pkg', 'pkg/**/*',
+  'spec/example_project/log', 'spec/example_project/log/*'
+]
+GEM_SPEC = Gem::Specification.new do |s|
+  # == CONFIGURE ==
+  s.author = "Winton Welsh"
+  s.email = "mail@wintoni.us"
+  s.homepage = "http://github.com/winton/#{GEM_NAME}"
+  s.summary = "Wraps ActiveRecord and Logger for use in non-Rails environments"
+  # == CONFIGURE ==
+  s.add_dependency('activerecord', '=2.3.2')
+  s.add_dependency('actionmailer', '=2.3.2')
+  s.extra_rdoc_files = [ "README.markdown" ]
+  s.files = GEM_FILES.to_a
+  s.has_rdoc = false
+  s.name = GEM_NAME
+  s.platform = Gem::Platform::RUBY
+  s.require_path = "lib"
+  s.version = "0.2.0"
+end

data/lib/active_wrapper/db.rb

@@ -0,0 +1,101 @@
+module ActiveWrapper
+  class Db
+    
+    attr_reader :base, :config, :env
+    
+    def initialize(options)
+      @base = options[:base]
+      if File.exists?(path = "#{base}/config/database.yml")
+        @config = YAML::load(File.open(path))
+      end
+      @env = options[:env].to_s
+    end
+    
+    def connected?
+      ActiveRecord::Base.connected?
+    end
+    
+    def create_db
+      establish_connection('database' => nil)
+      ActiveRecord::Base.connection.create_database config[env]['database']
+      establish_connection({})
+    end
+    
+    def drop_db
+      establish_connection('database' => nil)
+      ActiveRecord::Base.connection.drop_database config[env]['database']
+    end
+    
+    def establish_connection(options=nil)
+      if !connected? || options
+        config_clone = Marshal.load(Marshal.dump(config))
+        config_clone[env].merge!(options || {})
+        ActiveRecord::Base.configurations = config_clone
+        ActiveRecord::Base.establish_connection(env)
+      end
+    end
+
+    def migrate(version=nil)
+      redirect_stdout do
+        ActiveRecord::Migrator.migrate("#{base}/db/migrate", version)
+      end
+    end
+
+    def migrate_reset
+      redirect_stdout do
+        migrate(0)
+        migrate
+      end
+    end
+
+    def generate_migration(name=nil)
+      redirect_stdout do
+        raise "Please specify desired migration name with NAME=my_migration_name" unless name
+  
+        migration_name = name.strip.chomp
+        migrations_path = "#{base}/db/migrate"
+        migrations_template = File.expand_path("#{File.dirname(__FILE__)}/../../resources/migration.template")
+  
+        # Find the highest existing migration version or set to 1
+        if (existing_migrations = Dir[File.join(migrations_path, '*.rb')]).length > 0
+          version = File.basename(existing_migrations.sort.reverse.first)[/^(\d+)_/,1].to_i + 1
+        else
+          version = 1
+        end
+  
+        # Read the contents of the migration template into string
+        migrations_template = File.read(migrations_template)
+  
+        # Replace the migration name in template with the acutal one
+        migration_content = migrations_template.gsub('__migration_name__', migration_name.camelize)
+        migration_content = migration_content.gsub('__migration_table__', migration_name)
+  
+        # Generate migration filename
+        migration_filename = "#{"%03d" % version}_#{migration_name}.rb"
+  
+        # Write the migration
+        File.open(File.join(migrations_path, migration_filename), "w+") do |migration|
+          migration.puts migration_content
+        end
+  
+        # Done!
+        puts "Successfully created migration #{migration_filename}"
+      end
+    end
+    
+    def method_missing(method, *args)
+      ActiveRecord::Base.connection.send(method, *args)
+    end
+    
+    def redirect_stdout(&block)
+      if env == 'test'
+        stdout = $stdout
+        $stdout = File.new('/dev/null', 'w')
+      end
+      yield
+      if env == 'test'
+        $stdout = stdout
+      end
+    end
+  end
+end

data/lib/active_wrapper/log.rb

@@ -0,0 +1,39 @@
+module ActiveWrapper
+  class Log
+    
+    attr_reader :base, :log, :logger, :stdout
+    
+    def initialize(options)
+      @base = options[:base]
+      @log = options[:log]
+      @stdout = options[:stdout]
+      
+      return if @log == false
+      
+      FileUtils.mkdir_p("#{base}/log")
+      file = File.open("#{base}/log/#{log}.log", 'a')
+      file.sync = true
+      
+      if stdout
+        @logger = Logger.new($stdout)
+        $stdout.reopen(file)
+        $stderr.reopen(file)
+      else
+        @logger = Logger.new(file)
+      end
+      
+      ActiveRecord::Base.logger = @logger
+    end
+    
+    def clear
+      Dir["#{base}/log/*.log"].each do |file|
+        f = File.open(file, "w")
+        f.close
+      end
+    end
+    
+    def method_missing(method, *args)
+      logger.send(method, *args)
+    end
+  end
+end

data/lib/active_wrapper/mail.rb

@@ -0,0 +1,47 @@
+module ActiveWrapper
+  class Mail
+    
+    attr_reader :base, :env, :config
+    
+    def initialize(options)
+      @base = options[:base]
+      @config = {
+        :smtp => options[:smtp] || {},
+        :imap => options[:imap] || {}
+      }
+      @env = options[:env].to_s
+      
+      path = "#{base}/config/mail.yml"
+      
+      if @env == 'test'
+        ActionMailer::Base.delivery_method = :test
+        @config = nil
+      else
+        if File.exists?(path)
+          yaml = YAML::load(File.open(path))
+          if yaml && yaml = yaml[@env].to_options
+            @config[:imap] = yaml[:imap].to_options unless @config[:imap]
+            @config[:smtp] = yaml[:smtp].to_options unless @config[:smtp]
+          end
+        end
+        if @config[:smtp]
+          ActionMailer::Base.delivery_method = :smtp
+          ActionMailer::Base.smtp_settings = @config[:smtp]
+        end
+      end
+    end
+    
+    def deliver(options)
+      Mailer.deliver_email(options)
+    end
+    
+    class Mailer < ActionMailer::Base
+      def email(options)
+        from        options[:from]
+        recipients  options[:to]
+        subject     options[:subject]
+        body        options[:body]
+      end
+    end
+  end
+end

data/lib/active_wrapper/tasks.rb

@@ -0,0 +1,43 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../active_wrapper")
+
+module ActiveWrapper
+  class Tasks
+    
+    def initialize(options={}, &block)
+      
+      task :environment do
+        $db, $log = ActiveWrapper.setup(options)
+        yield if block
+      end
+      
+      namespace :db do
+        desc "Create the database"
+        task :create => :environment do
+          $db.create_db
+        end
+        
+        desc "Drop the database"
+        task :drop => :environment do
+          $db.drop_db
+        end
+        
+        desc "Migrate the database with optional VERSION"
+        task :migrate => :environment do
+          $db.migrate(ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+        end
+        
+        desc "Generate a migration with given NAME"
+        task :migration => :environment do
+          $db.generate_migration(ENV['NAME'])
+        end
+      end
+      
+      namespace :log do
+        desc "Clear all logs"
+        task :clear => :environment do
+          $log.clear
+        end
+      end
+    end
+  end
+end

data/lib/active_wrapper.rb

@@ -0,0 +1,39 @@
+Dir["#{File.dirname(__FILE__)}/../vendor/*/lib"].each do |path|
+  $:.unshift path
+end
+
+require 'rubygems'
+gem 'activerecord', '=2.3.2'
+gem 'actionmailer', '=2.3.2'
+require 'activerecord'
+require 'actionmailer'
+require 'logger'
+require 'yaml'
+
+require File.dirname(__FILE__) + "/active_wrapper/db"
+require File.dirname(__FILE__) + "/active_wrapper/log"
+require File.dirname(__FILE__) + "/active_wrapper/mail"
+
+module ActiveWrapper
+  class <<self
+    
+    def setup(options={})
+      
+      options = {
+        :base => File.dirname($0),
+        :env => 'development',
+        :log => options[:env] || 'development'
+      }.merge(options.reject { |k, v| v.nil? })
+      
+      db = Db.new(options)
+      log = Log.new(options)
+      mail = Mail.new(options)
+      
+      ActionMailer::Base.logger = log
+    
+      [ db, log, mail ]
+    end
+  end
+end
+
+ActiveRecord::Base.default_timezone = :utc

data/resources/migration.template

@@ -0,0 +1,11 @@
+class __migration_name__ < ActiveRecord::Migration
+  def self.up
+    create_table :__migration_table__ do |t|
+      
+    end
+  end
+
+  def self.down
+    drop_table :__migration_table__
+  end
+end

data/spec/active_wrapper/db_spec.rb

@@ -0,0 +1,48 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe ActiveWrapper::Db do
+  
+  before(:each) do
+    $db, $log, $mail = ActiveWrapper.setup(
+      :base => SPEC + '/example_project',
+      :env => 'test'
+    )
+    $db.drop_db
+    $db.create_db
+  end
+  
+  it "should establish a connection" do
+    $db.disconnect!
+    $db.establish_connection
+    $db.connected?.should == true
+  end
+
+  it "should create a database" do
+    $db.current_database.should == 'active_wrapper_test'
+  end
+
+  it "should drop a database" do
+    $db.drop_db
+    $db.current_database.should == nil
+  end
+  
+  it "should migrate a database" do
+    $db.migrate
+    $db.execute('insert into tests () values ()')
+    $db.execute('select * from tests').num_rows.should == 1
+  end
+  
+  it "should migrate reset a database" do
+    $db.migrate
+    $db.execute('insert into tests () values ()')
+    $db.migrate_reset
+    $db.execute('select * from tests').num_rows.should == 0
+  end
+  
+  it "should generate a migration" do
+    $db.generate_migration 'another_test'
+    path = SPEC + "/example_project/db/migrate/002_another_test.rb"
+    File.exists?(path).should == true
+    FileUtils.rm_f path
+  end
+end

data/spec/active_wrapper/log_spec.rb

@@ -0,0 +1,28 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../spec_helper")
+
+describe ActiveWrapper::Log do
+  
+  before(:each) do
+    FileUtils.rm_f(@path = SPEC + "/example_project/log/test.log")
+    $db, $log, $mail = ActiveWrapper.setup(
+      :base => SPEC + '/example_project',
+      :env => 'test'
+    )
+  end
+  
+  it "should create a log file" do
+    File.exists?(@path).should == true
+  end
+  
+  it "should log to the log file" do
+    $log.info "test"
+    File.read(@path).include?('test').should == true
+  end
+  
+  it "should clear the log file while keeping the logger intact" do
+    $log.clear
+    File.read(@path).include?('test').should == false
+    $log.info "test"
+    File.read(@path).include?('test').should == true
+  end
+end

data/spec/example_project/Rakefile

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'rake'
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/active_wrapper/tasks")
+
+ActiveWrapper::Tasks.new(
+  :base => File.dirname(__FILE__),
+  :env => 'test'
+)

data/spec/example_project/config/database.yml

@@ -0,0 +1,7 @@
+test:
+ database: active_wrapper_test
+ adapter: mysql
+ username: root
+ password: 
+ host: localhost
+ socket: /tmp/mysql.sock

data/spec/example_project/db/migrate/001_test.rb

@@ -0,0 +1,10 @@
+class Test < ActiveRecord::Migration
+  def self.up
+    create_table :tests do |t|
+    end
+  end
+
+  def self.down
+    drop_table :tests
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+$TESTING=true
+SPEC = File.dirname(__FILE__)
+$:.unshift File.expand_path("#{SPEC}/../lib")
+
+require 'active_wrapper'
+require 'pp'
+
+Spec::Runner.configure do |config|
+end
+
+# For use with rspec textmate bundle
+def debug(object)
+  puts "<pre>"
+  puts object.pretty_inspect.gsub('<', '&lt;').gsub('>', '&gt;')
+  puts "</pre>"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: active_wrapper
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+platform: ruby
+authors: 
+- Winton Welsh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-06 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: actionmailer
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: 
+email: mail@wintoni.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- active_wrapper.gemspec
+- gemspec.rb
+- lib/active_wrapper/db.rb
+- lib/active_wrapper/log.rb
+- lib/active_wrapper/mail.rb
+- lib/active_wrapper/tasks.rb
+- lib/active_wrapper.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+- resources/migration.template
+- spec/active_wrapper/db_spec.rb
+- spec/active_wrapper/log_spec.rb
+- spec/example_project/config/database.yml
+- spec/example_project/db/migrate/001_test.rb
+- spec/example_project/Rakefile
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/winton/active_wrapper
+licenses: []
+
+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.5
+signing_key: 
+specification_version: 3
+summary: Wraps ActiveRecord and Logger for use in non-Rails environments
+test_files: []
+