winton-active_wrapper 0.1.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,68 @@
+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 = ActiveWrapper.new(
+  :base => File.dirname('__FILE__'),
+  :env => 'development',
+  :log => 'custom',
+  :stdout => true
+)
+
+$db.establish_connection
+$db.generate_migration('my_migration')
+$db.migrate('001')
+$db.migrate_reset
+$log.info('log this')
+$log.clear
+</pre>
+
+<code>ActiveWrapper</code> looks for the following files within the <code>:base</code> directory:
+
+* <b>config/database.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.
+
+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,27 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{active_wrapper}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Winton Welsh"]
+  s.date = %q{2009-06-14}
+  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/tasks.rb", "lib/active_wrapper.rb", "MIT-LICENSE", "Rakefile", "README.markdown", "resources", "resources/migration.template", "spec", "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
+    else
+    end
+  else
+  end
+end

data/gemspec.rb

@@ -0,0 +1,17 @@
+GEM_NAME = 'active_wrapper'
+GEM_FILES = FileList['**/*'] - FileList['coverage', 'coverage/**/*', 'pkg', 'pkg/**/*']
+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.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.1.0"
+end

data/lib/active_wrapper/db.rb

@@ -0,0 +1,61 @@
+module ActiveWrapper
+  class Db
+    
+    attr_reader :base, :env
+    
+    def initialize(options)
+      @base = options[:base]
+      @env = options[:env]
+    end
+    
+    def establish_connection
+      unless ActiveRecord::Base.connected?
+        config = YAML::load(File.open("#{base}/config/database.yml"))
+        ActiveRecord::Base.configurations = config
+        ActiveRecord::Base.establish_connection(env)
+      end
+    end
+
+    def migrate(version=nil)
+      ActiveRecord::Migrator.migrate("#{base}/db/migrate", version)
+    end
+
+    def migrate_reset
+      db_migrate(0)
+      db_migrate
+    end
+
+    def generate_migration(name=nil)
+      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
+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/tasks.rb

@@ -0,0 +1,35 @@
+require File.expand_path("#{File.dirname(__FILE__)}/../active_wrapper")
+
+module ActiveWrapper
+  class Tasks
+    
+    def initialize(options={}, &block)
+      
+      task :environment do
+        $db, $log = ActiveWrapper.new(options)
+        yield
+      end
+      
+      namespace :db do
+        desc "Migrate the database with optional VERSION"
+        task :migrate => :environment do
+          $db.migrate(ENV["VERSION"] ? ENV["VERSION"].to_i : nil)
+        end
+      end
+      
+      namespace :generate do
+        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,16 @@
+require File.dirname(__FILE__) + "/active_wrapper/db"
+require File.dirname(__FILE__) + "/active_wrapper/log"
+
+class ActiveWrapper
+  
+  def initialize(options={})
+    
+    options = {
+      :base => File.dirname($0),
+      :env => 'development',
+      :log => 'development'
+    }.merge(options)
+    
+    [ Db.new(options), Log.new(options) ]
+  end
+end

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/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,68 @@
+--- !ruby/object:Gem::Specification 
+name: winton-active_wrapper
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Winton Welsh
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-14 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: mail@wintoni.us
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- active_wrapper.gemspec
+- gemspec.rb
+- lib
+- lib/active_wrapper
+- lib/active_wrapper/db.rb
+- lib/active_wrapper/log.rb
+- lib/active_wrapper/tasks.rb
+- lib/active_wrapper.rb
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+- resources
+- resources/migration.template
+- spec
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/winton/active_wrapper
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Wraps ActiveRecord and Logger for use in non-Rails environments
+test_files: []
+