communard 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93fe86a1450877912e94bf0d8d6c61d6994d0731
+  data.tar.gz: 8b41d0725025b0901e1c574f3be1196c7441219c
+SHA512:
+  metadata.gz: 3725a5b59c63946c9532e4f189719590404faad6e2df3584f66c6d5673ae9d8e1f75fa895dc4c39f5c970f9628f3cb72af0fecae98284ade648f6ba965b1dd87
+  data.tar.gz: 300f1d6b8033c35ab87101581d499ba93102e090fcda8774c7817e01b4e3908b9d186332a054009bd0b9c49a0a71f9a2aa20b170392d1fb34592d27da447d6d7

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+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,97 @@
+# Communard
+
+Communard adds some conventions from [ActiveRecord][ar] to [Sequel][sq].
+
+This means you can use `config/database.yml` and `db/migrate` again, so you
+don't have to change deployment scripts that are made for ActiveRecord.
+
+Sequel doesn't provide the exact same functionality as ActiveRecord. Communard
+doesn't try to make Sequel quack like ActiveRecord, it just tries to help with
+some (not all) setup.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'communard'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install communard
+```
+
+## Usage
+
+### Connecting to the database
+
+To get a database connection:
+
+``` ruby
+DB = Communard.connect
+```
+
+The `DB` object will be familiar to you if you've ever read the Sequel documentation.
+
+Note: Communard doesn't remember your connection.
+
+### Rake integration
+
+To add most Rake tasks, add this to your `Rakefile` or to `lib/tasks/communard.rake`:
+
+``` ruby
+require "communard/rake"
+Communard::Rake.add_tasks
+```
+
+This will add the most used rake tasks, like `db:create`, `db:migrate`, and `db:setup`.
+
+To see them all:
+
+```
+$ rake -T db
+```
+
+### Migrations
+
+To generate a migration:
+
+```
+$ bundle exec communard --generate-migration create_posts
+```
+
+Communard doesn't support more arguments, like the Rails generator does. You'll
+have to edit the generated migration file yourself.
+
+### Configuration
+
+There are a couple of configuration options available. They can be set by giving
+a block to `connect` or `add_tasks`. Under normal circumstances you don't need
+to set them.
+
+``` ruby
+DB = Communard.connect { |config|
+  config.root        = Rails.root
+  config.logger      = Rails.logger
+  config.environment = Rails.env.to_s
+}
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/yourkarma/communard/fork )
+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 a new Pull Request
+
+[ar]: http://rubyonrails.org
+[sq]: http://sequel.jeremyevans.net

data/Rakefile

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

data/bin/communard

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require "communard"
+require "optparse"
+
+parser = OptionParser.new do |opts|
+
+  opts.on "-m", "--generate-migration NAME", "Generates a migration" do |name|
+    Communard.context.generate_migration(name: name)
+    exit
+  end
+
+  opts.on_tail "-v", "--version" do
+    puts "Communard version #{Communard::VERSION}"
+    exit
+  end
+
+  opts.on_tail "-h", "--help" do
+    puts parser
+    exit
+  end
+
+end
+parser.parse!
+
+puts parser

data/communard.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'communard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "communard"
+  spec.version       = Communard::VERSION
+  spec.authors       = ["iain"]
+  spec.email         = ["iain@iain.nl"]
+  spec.summary       = %q{Adds some conventions from ActiveRecord to Sequel.}
+  spec.description   = %q{Adds some conventions from ActiveRecord to Sequel.}
+  spec.homepage      = "https://github.com/yourkarma/communard"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sequel", "~> 4.13"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/communard/configuration.rb

@@ -0,0 +1,29 @@
+require "logger"
+require "pathname"
+
+module Communard
+  class Configuration
+
+    attr_accessor :environment, :root, :logger
+
+    def initialize
+      self.environment = ENV["RACK_ENV"] || ENV["RUBY_ENV"] || ENV["RACK_ENV"] || "development"
+      self.root        = Pathname(Dir.pwd)
+      self.logger      = default_logger
+      yield self if block_given?
+    end
+
+    private
+
+    def default_logger
+      ::Logger.new($stdout).tap { |l|
+        alternate = 0
+        l.formatter = proc { |sev, _, _, msg|
+          color = sev == "INFO" ? 35 + ((alternate += 1) % 2) : 31
+          "\e[#{color}m[#{sev}]\e[0m #{msg}\n"
+        }
+      }
+    end
+
+  end
+end

data/lib/communard/context.rb

@@ -0,0 +1,95 @@
+require "sequel"
+
+module Communard
+  class Context
+
+    attr_reader :configuration
+
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def connect(opts = options)
+      connection = ::Sequel.connect(opts)
+      connection.loggers = [logger]
+      connection
+    end
+
+    def generate_migration(name: nil)
+      fail ArgumentError, "Name is required" if name.to_s == ""
+      require "fileutils"
+      underscore = name.
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').
+        tr("-", "_").
+        downcase
+      filename = root.join("db/migrate/#{Time.now.strftime("%Y%m%d%H%M%S")}_#{underscore}.rb")
+      FileUtils.mkdir_p(File.dirname(filename))
+      File.open(filename, "w") { |f| f << "Sequel.migration do\n  change do\n  end\nend" }
+      puts "#{filename} created"
+    end
+
+    def create_database(env: environment)
+      run_without_database("CREATE DATABASE IF NOT EXISTS %{database_name}", env: env)
+    end
+
+    def drop_database(env: environment)
+      fail ArgumentError, "Don't drop the production database, you monkey!" if env.to_s == "production"
+      run_without_database("DROP DATABASE IF EXISTS %{database_name}", env: env)
+    end
+
+    def migrate(target: nil, env: environment)
+      maintenance(env: env).migrate(target: target)
+    end
+
+    def seed(env: environment)
+      maintenance(env: env).seed
+    end
+
+    def rollback(step: 1, env: environment)
+      maintenance(env: env).rollback(step: step)
+    end
+
+    def load_schema(env: environment)
+      maintenance(env: env).load_schema
+    end
+
+    def dump_schema(env: environment)
+      maintenance(env: env).dump_schema
+    end
+
+    def status(env: environment)
+      maintenance(env: env).status
+    end
+
+    def run_without_database(cmd, env: environment)
+      opts = options(env: env).dup
+      database_name = opts.delete("database")
+      connection = connect(opts)
+      connection.run(cmd % { database_name: database_name })
+    end
+
+    def options(env: environment)
+      YAML.load_file(root.join("config/database.yml")).fetch(env.to_s)
+    end
+
+    private
+
+    def maintenance(env: env)
+      Maintenance.new(connection: connect(options(env: env)), root: root)
+    end
+
+    def environment
+      configuration.environment
+    end
+
+    def root
+      configuration.root
+    end
+
+    def logger
+      configuration.logger
+    end
+
+  end
+end

data/lib/communard/maintenance.rb

@@ -0,0 +1,102 @@
+module Communard
+  class Maintenance
+
+    attr_reader :connection, :root
+
+    def initialize(connection: nil, root: nil)
+      ::Sequel.extension :migration, :core_extensions
+      @connection = connection
+      @root       = root
+    end
+
+    def migrate(target: nil)
+      target = Integer(target) if target
+      ::Sequel::Migrator.run(connection, migrations, target: target, allow_missing_migration_files: true)
+      dump_schema
+    end
+
+    def seed
+      load seeds_file if seeds_file.exist?
+    end
+
+    def rollback(step: 1)
+      target = applied_migrations[-step - 1]
+      if target
+        migrate(target: target.split(/_/, 2).first)
+      else
+        fail ArgumentError, "Cannot roll back that far"
+      end
+    end
+
+    def load_schema
+      migration = instance_eval(schema_file.read, schema_file.expand_path.to_s, 1)
+      migration.apply(connection, :up)
+    end
+
+    def dump_schema
+      connection.extension :schema_dumper
+      schema = connection.dump_schema_migration(same_db: false)
+      schema_file.open("w") { |f| f << schema.gsub(/\s+$/m, "") }
+    end
+
+    def status
+      results = Hash.new { |h,k| h[k] = Status.new(k, false, false) }
+      available = Pathname.glob(migrations.join("*.rb")).map(&:basename).map(&:to_s).reverse
+      available.each { |migration| results[migration].available = true }
+      applied_migrations.each { |migration| results[migration].applied = true }
+
+      puts
+      puts "database: #{connection.opts.fetch(:database)}"
+      puts
+      puts " Status   Migration ID    Migration Name"
+      puts "--------------------------------------------------"
+      results.values.sort.each do |result|
+        puts "  #{result.status}    #{result.id}  #{result.name}"
+      end
+      puts
+    end
+
+    private
+
+    def applied_migrations
+      ::Sequel::Migrator.migrator_class(migrations).new(connection, migrations, allow_missing_migration_files: true).applied_migrations
+    end
+
+    def schema_file
+      root.join("db/schema.rb")
+    end
+
+    def seeds_file
+      root.join("db/seeds.rb")
+    end
+
+    def migrations
+      root.join("db/migrate")
+    end
+
+    Status = Struct.new(:file, :applied, :available) do
+
+      def <=>(other)
+        id <=> other.id
+      end
+
+      def status
+        available ? applied ? " up " : "down" : "????"
+      end
+
+      def id
+        splitted.first
+      end
+
+      def name
+        splitted.last.capitalize.gsub("_", " ").sub(/\.rb$/, "")
+      end
+
+      def splitted
+        file.split(/_/, 2)
+      end
+
+    end
+
+  end
+end

data/lib/communard/rake.rb

@@ -0,0 +1,87 @@
+require "communard"
+
+module Communard
+  class Rake
+
+    extend ::Rake::DSL if defined?(::Rake::DSL)
+
+    def self.add_tasks(ns = :db, &block)
+
+      namespace ns do
+        desc "Creates the database, migrate the schema, and loads seed data"
+        task :setup => [:create, :migrate, :seed, "db:test:prepare"]
+
+        desc "Creates the database"
+        task :create do
+          Communard.context(&block).create_database
+        end
+
+        desc "Drops the database"
+        task :drop do
+          Communard.context(&block).drop_database
+        end
+
+        desc "Drops and creates the database"
+        task :reset => [:drop, :setup]
+
+        desc "Migrate the database"
+        task :migrate do
+          target = ENV["VERSION"] || ENV["TARGET"]
+          Communard.context(&block).migrate(target: target)
+        end
+
+        desc "Load the seed data from db/seeds.rb"
+        task :seed do
+          Communard.context(&block).seed
+        end
+
+        desc "Rolls the schema back to the previous version"
+        task :rollback do
+          step = Integer(ENV["STEP"] || 1)
+          Communard.context(&block).rollback(step: step)
+        end
+
+        namespace :test do
+          desc "Cleans the test database"
+          task :prepare do
+            context = Communard.context(&block)
+            context.drop_database(env: "test")
+            context.create_database(env: "test")
+            context.migrate(env: "test")
+          end
+        end
+
+        namespace :migrate do
+
+          desc "Redo the last migration"
+          task :redo do
+            context = Communard.context(&block)
+            context.rollback
+            context.migrate
+          end
+
+          desc "Display status of migrations"
+          task :status do
+            Communard.context(&block).status
+          end
+        end
+
+        namespace :schema do
+
+          desc "Load the schema from db/schema.rb"
+          task :load do
+            Communard.context(&block).load_schema
+          end
+
+          desc "Dumps the schema to db/schema.rb"
+          task :dump do
+            Communard.context(&block).dump_schema
+          end
+
+        end
+
+      end
+    end
+
+  end
+end

data/lib/communard/version.rb

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

data/lib/communard.rb

@@ -0,0 +1,20 @@
+require "communard/version"
+require "communard/maintenance"
+require "communard/configuration"
+require "communard/context"
+
+module Communard
+
+  def self.connect(&block)
+    context(&block).connect
+  end
+
+  def self.context(&block)
+    Context.new(configuration(&block))
+  end
+
+  def self.configuration(&block)
+    Configuration.new(&block)
+  end
+
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: communard
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- iain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.13'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+description: Adds some conventions from ActiveRecord to Sequel.
+email:
+- iain@iain.nl
+executables:
+- communard
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/communard
+- communard.gemspec
+- lib/communard.rb
+- lib/communard/configuration.rb
+- lib/communard/context.rb
+- lib/communard/maintenance.rb
+- lib/communard/rake.rb
+- lib/communard/version.rb
+homepage: https://github.com/yourkarma/communard
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Adds some conventions from ActiveRecord to Sequel.
+test_files: []
+has_rdoc: