wd_sinatra_sequel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a11c4dd4ad6e090b7e973a75aed1b3291ee5f4c
+  data.tar.gz: f2fbd979e35b83085d760ab34d06421212444261
+SHA512:
+  metadata.gz: 53f9af3faa63a46792624b7020268e206759022330893dbc4d072d6ee7f89f909931c89eb3b3b4914f32581a282c2398c29b30bd52ad867da2cdc78e8fc01bad
+  data.tar.gz: 05d1475184bed030bb6279c221689862bc74a6b2ab36133c61dc0a65edab02328ed315ee503a8001236f03dffa959390dab9f89e2fdc7fe2597ec666945cc238

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wd_sinatra_sequel.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jack Chu
+
+MIT License
+
+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.md

@@ -0,0 +1,65 @@
+# WdSinatraSequel
+
+A Ruby gem to avoid reinventing the wheel every time you want to use
+[Sequel](https://github.com/jeremyevans/sequel) in a
+[WeaselDiesel](https://github.com/mattetti/Weasel-Diesel) app backed by
+Sinatra ([wd_sinatra](https://github.com/mattetti/wd-sinatra)).
+
+Use this gem to easily get connected to one or multiple databases and to
+enjoy some of the common Sequel Rake tasks similar to those in Rails.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wd_sinatra_sequel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wd_sinatra_sequel
+
+
+Don't forget to set a gem dependency for the DB adapter you need.
+For instance:
+
+    mysql2
+
+
+## Usage
+
+Add an Sequel `database.yml` file in your config folder and then require this
+gem in your `app.rb` file and connect to the DB:
+
+    require 'wd_sinatra_sequel'
+    DB = WdSinatraSequel::DBConnector.set_db_connection
+
+
+The DB settings can be accessed via:
+
+    DBConnector::DB_CONFIG[RACK_ENV]
+
+## Rake tasks
+
+A Rake task file is also provided so you can load Sequel specific
+tasks. To do that, create a new rake file in your `lib/tasks` folder, load
+`WDSinatra` and the rake task file:
+
+```
+$ echo "require 'wd_sinatra_sequel'
+load WdSinatraSequel.task_path" > lib/tasks/db.rake
+```
+
+The tasks are very basic, feel free to send patches and improvements.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/wd_sinatra_sequel/db.rake

@@ -0,0 +1,260 @@
+require 'wd_sinatra_sequel'
+require 'pry'
+
+db_namespace = namespace :db do
+
+  task :load_config => :setup_app do
+    require 'sequel'
+    @config = WdSinatraSequel::DBConnector.db_configuration
+    if @config['uri']
+      opts = Sequel.connect(@config['uri'], @config).opts
+      %w{adapter host port user password database}.each do |k|
+        @config[k] = opts[k.to_sym]
+      end
+    end
+    @migrations_path = File.join(WDSinatra::AppLoader.root_path, 'db/migrate')
+  end
+
+  desc 'Create the database from config/database.yml for the current RACK_ENV (use db:create:all to create all dbs in the config)'
+  task :create do
+    old_connect_env = ENV['DONT_CONNECT'] ? 'true' : nil
+    ENV['DONT_CONNECT'] = 'true'
+    Rake::Task["db:load_config"].invoke
+    create_database(@config)
+    ENV['DONT_CONNECT'] = old_connect_env
+  end
+
+  def create_database(config)
+    begin
+      if config['adapter'] =~ /sqlite/
+        if File.exist?(config['database'])
+          $stderr.puts "#{config['database']} already exists"
+        else
+          begin
+            # Create the SQLite database
+            Sequel.connect(config)
+          rescue Exception => e
+            $stderr.puts e, *(e.backtrace)
+            $stderr.puts "Couldn't create database for #{config.inspect}"
+          end
+        end
+        return # Skip the else clause of begin/rescue
+      else
+        Sequel.connect(config, test: true)
+
+      end
+    rescue
+      case config['adapter']
+      when /mysql/
+        if config['adapter'] =~ /jdbc/
+          error_class = Sequel::DatabaseConnectionError
+        else
+          error_class = config['adapter'] =~ /mysql2/ ? Mysql2::Error : Mysql::Error
+        end
+        access_denied_error = 1045
+
+        charset   = ENV['CHARSET']   || 'utf8'
+        collation = ENV['COLLATION'] || 'utf8_unicode_ci'
+
+        begin
+          arguments = mysql_cli_args(config)
+          arguments << '-e'
+          arguments << "CREATE DATABASE #{config['database']} DEFAULT CHARACTER SET #{charset} DEFAULT COLLATE #{collation}"
+
+          system('mysql',*arguments)
+          Sequel.connect(config)
+        rescue error_class => sqlerr
+          if sqlerr.errno == access_denied_error
+            print "#{sqlerr.error}. \nPlease provide the root password for your mysql installation\n>"
+            root_password = $stdin.gets.strip
+            grant_statement = "GRANT ALL PRIVILEGES ON #{config['database']}.* " \
+              "TO '#{config['user']}'@'localhost' " \
+              "IDENTIFIED BY '#{config['password']}' WITH GRANT OPTION;"
+            system('mysql', '-u', 'root', '--password', root_password, '-h', config['host'], '-e', grant_statement)
+            system('mysql',*arguments)
+            Sequel.connect(config)
+          else
+            $stderr.puts sqlerr.error
+            $stderr.puts "Couldn't create database for #{config.inspect}, charset: #{config['charset'] || charset}, collation: #{config['collation'] || collation}"
+            $stderr.puts "(if you set the charset manually, make sure you have a matching collation)" if config['charset']
+          end
+        end
+      when /postgres/
+        encoding = config['encoding'] || ENV['CHARSET'] || 'utf8'
+        begin
+          system("createdb", "-E", encoding, "-h", config['host'], "-U", config['user'], config['database'])
+          Sequel.connect(config)
+        rescue Exception => e
+          $stderr.puts e, *(e.backtrace)
+          $stderr.puts "Couldn't create database for #{config.inspect}"
+        end
+      end
+    else
+      # Bug with 1.9.2 Calling return within begin still executes else
+      $stderr.puts "#{config['database']} already exists" unless config['adapter'] =~ /sqlite/
+    end
+  end
+
+  desc 'Drops the database for the current RACK_ENV (use db:drop:all to drop all databases)'
+  task :drop do
+    Rake::Task["db:load_config"].invoke
+    begin
+      drop_database(@config)
+    rescue Exception => e
+      $stderr.puts "Couldn't drop #{@config['database']} : #{e.inspect}"
+    end
+  end
+
+  def local_database?(config, &block)
+    if config['host'].in?(['127.0.0.1', 'localhost']) || config['host'].blank?
+      yield
+    else
+      $stderr.puts "This task only modifies local databases. #{config['database']} is on a remote host."
+    end
+  end
+
+  desc "Migrate the database"
+  task :migrate do
+    Rake::Task[:environment].invoke
+    Rake::Task["db:load_config"].invoke
+    Sequel.extension :migration
+    db = Sequel.connect(@config)
+    Sequel::Migrator.run(db, @migrations_path)
+    db_namespace["schema:dump"].invoke
+  end
+
+  namespace :migrate do
+    # desc  'Rollbacks the database one migration and re migrate up (options: VERSION=x).'
+    task :redo => [:environment, :load_config] do
+      if ENV['VERSION']
+        db_namespace['migrate:to'].invoke
+      else
+        db_namespace['rollback'].invoke
+      end
+      db_namespace['migrate'].invoke
+    end
+
+    # desc 'Resets your database using your migrations for the current environment'
+    task :reset => ['db:drop', 'db:create', 'db:migrate']
+
+    # desc 'Runs the "to" for a given migration VERSION.'
+    task :to, [:version] => [:environment, :load_config] do |t, args|
+      version = (args[:version] || ENV['VERSION']).to_s.strip
+      raise 'VERSION is required' unless version
+      Sequel.extension :migration
+      db = Sequel.connect(@config)
+      Sequel::Migrator.run(db, @migrations_path, :target => version)
+      db_namespace['schema:dump'].invoke
+    end
+  end
+
+  desc 'Rolls the schema back (erase all data).'
+  task :rollback => [:environment, :load_config] do
+    Sequel.extension :migration
+    db = Sequel.connect(@config)
+    Sequel::Migrator.run(db, @migrations_path, :target => 0)
+    db_namespace['schema:dump'].invoke
+  end
+
+  # desc 'Drops and recreates the database from db/schema.rb for the current environment and loads the seeds.'
+  task :reset => [ 'db:drop', 'db:setup' ]
+
+  # desc "Raises an error if there are pending migrations"
+  task :abort_if_pending_migrations => [:environment, :setup_app, :load_config] do
+    if defined? Sequel
+      Sequel.extension :migration
+      db = Sequel.connect(@config)
+
+      if Sequel::Migrator.is_current?(db, @migrations_path)
+        puts "You have pending migrations."
+        abort %{Run "rake db:migrate" to update your database then try again.}
+      end
+    end
+  end
+
+  desc 'Create the database, and initialize with the seed data (use db:reset to also drop the db first)'
+  task :setup => [ 'db:create', 'db:seed' ]
+
+  desc 'Load the seed data from db/seeds.rb'
+  task :seed do
+    old_no_redis = ENV['NO_REDIS'] ? 'true' : nil
+    ENV['NO_REDIS'] = 'true'
+    Rake::Task[:environment].invoke
+    Rake::Task["db:abort_if_pending_migrations"].invoke
+    seed = File.join(WDSinatra::AppLoader.root_path, "db", "seed.rb")
+    if File.exist?(seed)
+      puts "seeding #{seed}"
+      load seed
+    else
+      puts "Seed file: #{seed} is missing"
+    end
+    ENV['NO_REDIS'] = old_no_redis
+  end
+
+  namespace :schema do
+    desc 'Create a db/schema.rb file that can be portably used against any DB supported by AR'
+    task :dump => :load_config do
+      Sequel.extension :schema_dumper
+      db = Sequel.connect(@config)
+      filename = ENV['SCHEMA'] || "#{WDSinatra::AppLoader.root_path}/db/schema.rb"
+      File.open(filename, "w:utf-8") do |file|
+        file.write(db.dump_schema_migration)
+      end
+      db_namespace['schema:dump'].reenable
+    end
+
+    desc 'Load a schema.rb file into the database'
+    task :load => [:environment, :load_config] do
+      Sequel.extension :schema_dumper
+      Sequel.extension :migration
+      db = Sequel.connect(@config)
+      file = ENV['SCHEMA'] || "#{WDSinatra::AppLoader.root_path}/db/schema.rb"
+      if File.exists?(file)
+        load(file)
+      else
+        abort %{#{file} doesn't exist yet. Run "rake db:migrate" to create it then try again. If you do not intend to use a database, you should instead alter #{WDSinatra::AppLoader.root_path}/config/application.rb to limit the frameworks that will be loaded}
+      end
+    end
+  end
+
+  namespace :test do
+    # desc "Empty the test database"
+    task :purge => :setup_app do
+      ENV['RACK_ENV'] = 'test'
+      Rake::Task["db:load_config"].invoke
+      drop_database(@config)
+      create_database(@config)
+    end
+  end
+end
+
+def  mysql_cli_args(config)
+    arguments = ["--user=#{config['user']}"]
+    arguments << "--password=#{config['password']}" if config['password']
+
+    unless %w[127.0.0.1 localhost].include?(config['host'])
+      arguments << "--host=#{config['host']}"
+    end
+    arguments
+end
+
+def drop_database(config)
+  case config['adapter']
+  when /mysql/
+    arguments = mysql_cli_args(config)
+    arguments << '-e'
+    arguments << "DROP DATABASE IF EXISTS #{config['database']}"
+
+    system('mysql',*arguments)
+  when /sqlite/
+    require 'pathname'
+    path = Pathname.new(config['database'])
+    file = path.absolute? ? path.to_s : File.join(WDSinatra::AppLoader.root_path, path)
+
+    FileUtils.rm(file) if File.exist?(file)
+  when /postgres/
+    system("dropdb", "-h", config['host'], "-U", config['user'], config['database'])
+  else
+    raise "Task not supported by '#{config['adapter']}'"
+  end
+end

data/lib/wd_sinatra_sequel/version.rb

@@ -0,0 +1,3 @@
+module WdSinatraSequel
+  VERSION = "0.0.1"
+end

data/lib/wd_sinatra_sequel.rb

@@ -0,0 +1,85 @@
+require "wd_sinatra_sequel/version"
+require 'sequel'
+
+# Set the default value, feel free to overwrite
+Sequel.default_timezone = :utc
+
+
+module WdSinatraSequel
+
+  # Path to the rake task file so it can be loaded as such:
+  #     load WdSinatraSequel.task_path
+  # (Note that the app loaded should have been started using something like:
+  #   WDSinatra::AppLoader.console(RAKE_APP_ROOT)
+  # before loading this rake task.)
+  def self.task_path
+    File.join(File.expand_path(File.dirname(__FILE__), ".."), "wd_sinatra_sequel", "db.rake")
+  end
+
+  ##### DB Connection ########
+  module DBConnector
+    DB_CONFIG = YAML.load_file(File.join(WDSinatra::AppLoader.root_path, "config", "database.yml"))
+
+    module_function
+
+    def set_db_connection(env=RACK_ENV)
+      # Set the Sequel logger
+      loggers = []
+      if Object.const_defined?(:LOGGER)
+        loggers << LOGGER
+      else
+        loggers << Logger.new($stdout)
+      end
+
+      # Establish the DB connection
+      db_file = File.join(WDSinatra::AppLoader.root_path, "config", "database.yml")
+      if File.exist?(db_file)
+        hash_settings = YAML.load_file(db_file)
+        if hash_settings && hash_settings[env]
+          @db_configurations = hash_settings
+          @db_configuration = @db_configurations[env]
+          # add loggers
+          @db_configuration['loggers'] ||= []
+          @db_configuration['loggers'].concat(loggers)
+          # overwrite DB name by using an ENV variable
+          if ENV['FORCED_DB_NAME']
+            print "Database name overwritten to be #{ENV['FORCED_DB_NAME']}\n"
+            @db_configurations[env]['database'] = @db_configuration['database'] = ENV['FORCED_DB_NAME']
+          end
+          connect_to_db unless ENV['DONT_CONNECT']
+        else
+          raise "#{db_file} doesn't have an entry for the #{env} environment"
+        end
+      else
+        raise "#{db_file} file missing, can't connect to the DB"
+      end
+    end
+
+    def db_configuration(env=RACK_ENV)
+      old_connect_status = ENV['DONT_CONNECT']
+      set_db_connection(env)
+      ENV['DONT_CONNECT'] = old_connect_status
+      @db_configuration
+    end
+
+    def db_configurations
+      db_configuration unless @db_configurations
+      @db_configurations
+    end
+
+    def connect_to_db
+      if @db_configuration
+        if @db_configuration.has_key?('uri')
+          uri = @db_configuration['uri']
+          config_without_uri = @db_configuration.clone
+          config_without_uri.delete('uri')
+          connection = Sequel.connect(uri, config_without_uri)
+        else
+          connection = Sequel.connect(@db_configuration)
+        end
+      else
+        raise "Can't connect without the config previously set"
+      end
+    end
+  end
+end

data/wd_sinatra_sequel.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wd_sinatra_sequel/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "wd_sinatra_sequel"
+  gem.version       = WdSinatraSequel::VERSION
+  gem.authors       = ["Jack Chu"]
+  gem.email         = ["kamuigt@gmail.com"]
+  gem.description   = %q{Basics to use Sequel with WD Sinatra.}
+  gem.summary       = %q{Provides a way to get started with Sequel and WeaselDiesel on Sinatra.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "pry"
+
+  gem.add_dependency "sequel"
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: wd_sinatra_sequel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jack Chu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Basics to use Sequel with WD Sinatra.
+email:
+- kamuigt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wd_sinatra_sequel.rb
+- lib/wd_sinatra_sequel/db.rake
+- lib/wd_sinatra_sequel/version.rb
+- wd_sinatra_sequel.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Provides a way to get started with Sequel and WeaselDiesel on Sinatra.
+test_files: []
+has_rdoc: