schema_dev 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7390fc8e1c5cff8d04697e1110ee58bc6a11eaa
-  data.tar.gz: 8f573ecb8ee744283534ba12dca609325985d449
+  metadata.gz: 32da67245032f4e8dda3169be236b050bcbfa230
+  data.tar.gz: 5c4863f4241688f83166c82d7e3357e06b80f8b6
 SHA512:
-  metadata.gz: b770a4fd5e143dc40b8e619281c595e44bb047cd96f0e7cec4f38eb3b51a827136328a03fa703a0816876844579574f53003c4048fca977e5f3089ebccdd72bd
-  data.tar.gz: 0a2686a017ae65bf1746187a796ebb99e4f10ea6951a82e34117a379388fd87ee63ee8c3cd10c89d565c7bfd3fece000740890174c48ca4eca75a6aace558276
+  metadata.gz: ee070648972f48f9ecea215559dd141d81d1d88a5b6b0ff14c29cf27a3bad69e660af2493296c518f5cd50547e207ca072ef3a794fbb3db345f6ecaced996a77
+  data.tar.gz: 5b6566b814e841dc3e1321c74a05ce77c9df92634cdc5e26c92936d70a97a9232666af72f0fadc72d5d0101681ba53edba95aaad1af852ea75ee8609b67c37b9

data/README.md

@@ -1,15 +1,93 @@
 # SchemaDev
 
-Development tools for the SchemaPlus family of gems
+[![Gem Version](https://badge.fury.io/rb/schema_dev.png)](http://badge.fury.io/rb/schema_dev)
+
+Development tools for the SchemaPlus family of gems.
+
+Provides support for working with multiple ruby versions, rails adapaters, and db versions.  In particular provides a command `schema_dev` for running rspec (or whatever) on the matrix or  a slice or element of it.  It also auto-generates the `.travis.yml` file for [travis-ci](https://travis-ci.org) testing.
 
 ## Installation
 
-Include this as a development dependency in a .gemfile:
+Include this as a development dependency in the client gem's `<ame>.gemfile`:
+
+    s.add_development_dependency "schema_dev"
+
+## Setup
+
+#### `schema_dev.yml`
+
+The client gem needs a file `schema_dev.yml` in it's root, which specifies the testing matrix, among other things.
+
+* `ruby`:  A single version of ruby, or a list of ruby versions.
+* `rails`: A single version of rails, or a list of rails versions
+* `db`: (Optional) The list of db adapters to test.  Leave this out if the gem will hardwire its tests for a single adapter.
+* `quick`: (Optional) Hash listing the version of ruby, rails, and db to use with `--quick` option.  If not specified, the default is to use the last entry in each list.
+
+#### Gemfiles
+
+The client gem must organize its Gemfiles along the lines of:
+
+	gemfiles/rails-4.0/Gemfile.postgresql  # if testing against multiple db adapter
+	
+    gemfiles/Gemfile-rails.4.0             # if hardwired to a single db adapter
+    
+#### Rspec
+
+The client gem should include this in its `spec/spec_helper`
+
+    require 'schema_dev/rspec'
+    SchemaDev::Rspec.setup_db     		 # if testing against multiple dbs, the db will be filled in automatically
+    SchemaDev::Rspec.setup_db 'sqlite3' # to hardwire a single database
+    
+This will take care of connecting to the test database appropriately, and will set up logging to a file specific to the test matrix cell.
+
+#### Rake
+
+The client gem should include this in its `Rakefile`:
+
+    require 'schema_dev/tasks'
+
+### Ruby selection
+
+You must have one of [chruby](https://github.com/postmodern/chruby), [rbenv](https://github.com/sstephenson/rbenv) or [rvm](http://rvm.io) installed and working.  Within it, have available whichever ruby versions you want to test.  
+
+### Database 
+
+Of course you must have installed whichever database(s) you want to test. 
+
+For PostgreSQL and MySQL the tests need a db user with permissions to create and access databases: The default username used by the specs is 'schema_plus' for both PostgreSQL and MySQL; you can change them via:
+
+        $ export POSTGRESQL_DB_USER = pgusername
+        $ export MYSQL_DB_USER = mysqlusername
+
+For PostgreSQL and MySQL you must explicitly create the databases used by the tests:
+
+        $ rake create_databases  # creates postgresql and/or mysql as needed
+
+## Running The Tests
+
+In the root directory, you can run, e.g.,
+
+    $ schema_dev bundle install
+    $ schema_dev rspec
+
+Which will run those commands over the whole matrix.  You can also specify slices, via any combination of `--ruby`, `--rails` and (if the gem tests multiple dbs) `--db`
+
+    $ schema_dev rspec --ruby 2.1.3 --rails 4.0
+
+For convenience you can also use `--quick` to run just one as specified in `schema_dev.yml`
+
+If you want to pass extra arguments to a command, make sure to use `--` to avoid them being processed by `schema_dev`.  e.g.
+
+	$ schema_dev rspec --quick -- -e 'select which spec'
+	
+For more info, see
 
-```ruby
-s.add_development_dependency "schema_dev"
-```
+    $ schema_dev help
+    $ schema_dev help rspec   # etc.
 
-## Usage
+## Generating `.travis.yml`
 
+To keep things in sync `.travis.yml` gets automatically updated whenever you run `schema_dev matrix` or any of its shorthands.  There's also a command to just explicitly update `.travis.yml`
 
+    $ schema_dev travis

data/bin/schema_dev

@@ -2,8 +2,8 @@
 
 require 'active_support/core_ext/hash'
 require 'thor'
-require 'schema_dev/config'
-require 'schema_dev/runner'
+require_relative '../lib/schema_dev/config'
+require_relative '../lib/schema_dev/runner'
 
 $config = SchemaDev::Config.load
 $runner = SchemaDev::Runner.new($config)
@@ -18,6 +18,11 @@ class CLI < Thor
     method_option :db, type: :string, desc: "Only execute for the specified database" if $config.db?
   end
 
+  desc "update .travis.yml", "create .travis.yml based on schema_dev.yml values"
+  def travis
+    $runner.travis
+  end
+
   desc "run command", "run a command over the matrix"
   matrix_options
   def matrix(*args)

data/lib/schema_dev/config.rb

@@ -12,7 +12,7 @@ module SchemaDev
 
   class Config
 
-    attr_accessor :quick, :db
+    attr_accessor :quick, :db, :ruby, :rails, :notify, :exclude
 
     def self._reset ; @@config = nil end  # for use by rspec
 
@@ -20,23 +20,6 @@ module SchemaDev
       @@config ||= new((YAML.load Pathname.new(CONFIG_FILE).read).symbolize_keys)
     end
 
-    class Tuple < KeyStruct[:ruby, :rails, :db]
-      def match?(other)
-        return false if self.ruby and other.ruby and self.ruby != other.ruby
-        return false if self.rails and other.rails and self.rails != other.rails
-        return false if self.db and other.db and self.db != other.db
-        true
-      end
-
-      def match_any?(others)
-        others.any?{|other| self.match? other}
-      end
-
-      def to_hash
-        super.reject{ |k, val| val.nil? }
-      end
-    end
-
     def initialize(opts={}) # once we no longer support ruby 1.9.3, can switch to native keyword args
       opts = opts.keyword_args(ruby: :required, rails: :required, db: nil, exclude: nil, notify: nil, quick: nil)
       @ruby = Array.wrap(opts.ruby)
@@ -51,8 +34,12 @@ module SchemaDev
       @db.any?
     end
 
+    def dbms
+      @dbms ||= [:postgresql, :mysql].select{|dbm| @db.grep(/^#{dbm}/).any?}
+    end
+
     def matrix(opts={}) # once we no longer support ruby 1.9.3, can switch to native keyword args
-      opts = opts.keyword_args(quick: false, ruby: nil, rails: nil, db: nil)
+      opts = opts.keyword_args(quick: false, ruby: nil, rails: nil, db: nil, excluded: nil)
       use_ruby = @ruby
       use_rails = @rails
       use_db = @db
@@ -65,12 +52,37 @@ module SchemaDev
       use_rails = Array.wrap(opts.rails) if opts.rails
       use_db = Array.wrap(opts.db) if opts.db
 
-      @matrix ||= begin
-                    m = use_ruby.product(use_rails)
-                    m = m.product(use_db).map(&:flatten) if db?
-                    m = m.map { |_ruby, _rails, _db| Tuple.new(ruby: _ruby, rails: _rails, db: _db) }
-                    m.reject(&it.match_any?(@exclude)).map(&:to_hash)
-                  end
+      use_ruby = [nil] unless use_ruby.any?
+      use_rails = [nil] unless use_rails.any?
+
+      m = use_ruby.product(use_rails)
+      m = m.product(use_db).map(&:flatten) if use_db.any?
+      m = m.map { |_ruby, _rails, _db| Tuple.new(ruby: _ruby, rails: _rails, db: _db) }.compact
+      m = m.reject(&it.match_any?(@exclude)) unless opts.excluded == :none
+      m = m.map(&:to_hash)
+
+      if opts.excluded == :only
+        return matrix(opts.merge(excluded: :none)) - m
+      else
+        return m
+      end
+    end
+
+    class Tuple < KeyStruct[:ruby, :rails, :db]
+      def match?(other)
+        return false if self.ruby and other.ruby and self.ruby != other.ruby
+        return false if self.rails and other.rails and self.rails != other.rails
+        return false if self.db and other.db and self.db != other.db
+        true
+      end
+
+      def match_any?(others)
+        others.any?{|other| self.match? other}
+      end
+
+      def to_hash
+        super.reject{ |k, val| val.nil? }
+      end
     end
 
   end

data/lib/schema_dev/gemfile_selector.rb

@@ -4,7 +4,9 @@ module SchemaDev
   GEMFILES_DIR = "gemfiles"
 
   module GemfileSelector
-    def self.gemfile(opts = {})
+    extend self
+
+    def gemfile(opts = {})
       opts = opts.keyword_args(rails: :required, db: nil)
       root = Pathname.new(GEMFILES_DIR)
       if opts.db
@@ -14,12 +16,12 @@ module SchemaDev
       end
     end
 
-    def self.command(opts={})
+    def command(opts={})
       opts = opts.keyword_args(rails: :required, db: nil)
       "BUNDLE_GEMFILE=#{gemfile(rails: opts.rails, db: opts.db)}"
     end
 
-    def self.infer_db
+    def infer_db
       (env = ENV['BUNDLE_GEMFILE']) =~ %r{rails.*/Gemfile[.](.*)}
       $1 or raise "Can't infer db: Env BUNDLE_GEMFILE=#{env.inspect}) isn't a schema_dev Gemfile path with db"
     end

data/lib/schema_dev/rspec/db.rb

@@ -7,8 +7,8 @@ module SchemaDev
     module Db
       extend self
 
-      def setup(db = nil)
-        @db = db || GemfileSelector.infer_db
+      def setup(_db = nil)
+        @db = _db || GemfileSelector.infer_db
         set_logger
         connect
         RSpec.configure do |config|
@@ -19,7 +19,7 @@ module SchemaDev
           config.filter_run_excluding :mysql => :skip if Helpers.mysql?
           config.filter_run_excluding :sqlite3 => :only unless Helpers.sqlite3?
           config.filter_run_excluding :sqlite3 => :skip if Helpers.sqlite3?
-        end
+        end unless _db
       end
 
       def tmproot

data/lib/schema_dev/runner.rb

@@ -1,6 +1,7 @@
 require 'shellwords'
 
 require_relative 'matrix_executor'
+require_relative 'travis'
 
 module SchemaDev
   class Runner
@@ -8,7 +9,13 @@ module SchemaDev
       @config = config
     end
 
-    def run(*args, dry_run: false, quick: false, ruby: nil, rails: nil, db: nil)
+    def travis
+      Travis.update(@config)
+    end
+
+    def run(*args, dry_run: false, quick: false, ruby: nil, rails: nil, db: nil, freshen: true)
+      self.travis if freshen
+
       matrix = MatrixExecutor.new @config.matrix(quick: quick, ruby: ruby, rails: rails, db: db)
 
       return true if matrix.run(Shellwords.join(args.flatten), dry_run: dry_run)

data/lib/schema_dev/tasks.rb

@@ -1,11 +1,9 @@
 require_relative 'config'
 
-config = SchemaDev::Config.load
+dbms = SchemaDev::Config.load.dbms
 
 DATABASES = %w[schema_plus_test]
 
-dbms = [:postgresql, :mysql].select{|dbm| config.db.grep(/^#{dbm}/).any?}
-
 if dbms.any?
   {
     postgresql: { uservar: 'POSTGRESQL_DB_USER', defaultuser: 'schema_plus', create: "createdb -U '%{user}' %{dbname}", drop: "dropdb -U '%{user}' %{dbname}" },

data/lib/schema_dev/travis.rb

@@ -0,0 +1,48 @@
+require 'pathname'
+require 'yaml'
+
+module SchemaDev
+  TRAVIS_FILE = ".travis.yml"
+
+  module Travis
+    extend self
+
+    def build(config)
+      env = 'POSTGRESQL_DB_USER=postgres MYSQL_DB_USER="travis"'
+      gemfiles = config.matrix.map{|entry| GemfileSelector.gemfile(entry.slice(:rails, :db)).to_s}.uniq
+      exclude = config.matrix(excluded: :only).map { |entry| {}.tap {|ex|
+        ex["rvm"] = entry[:ruby]
+        ex["gemfile"] = GemfileSelector.gemfile(entry.slice(:rails, :db)).to_s
+        ex["env"] = env if config.dbms.any?
+      }}.reject{|ex| not gemfiles.include? ex["gemfile"]}
+
+      {}.tap { |travis|
+        travis["rvm"] = config.ruby.sort
+        travis["gemfile"] = gemfiles.sort
+        if config.dbms.any?
+          travis["before_script"] = 'bundle exec rake create_databases'
+          travis["after_script"] = 'bundle exec rake drop_databases'
+          travis["env"] = env
+        end
+        travis["notifications"] = { "email" => config.notify } if config.notify.any?
+        travis["matrix"] = { "exclude" => exclude.sort_by{|ex| [ex["rvm"], ex["gemfile"]]} } if exclude.any?
+      }
+    end
+
+    def update(config)
+      filepath = Pathname.new(TRAVIS_FILE)
+      newtravis = build(config)
+      oldtravis = YAML.load(filepath.read) rescue nil
+      if oldtravis != newtravis
+        header = <<-ENDYAML
+# This file was auto-generated by the schema_dev tool, based on the data in
+#                 ./schema_dev.yml 
+# Please do not edit this file; any changes will be overwritten next time
+# schema_dev gets run.
+ENDYAML
+        filepath.write header + newtravis.to_yaml
+        puts "* Updated #{filepath}"
+      end
+    end
+  end
+end

data/lib/schema_dev/version.rb

@@ -1,3 +1,3 @@
 module SchemaDev
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: schema_dev
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - ronen barzel
@@ -161,6 +161,7 @@ files:
 - lib/schema_dev/ruby_selector.rb
 - lib/schema_dev/runner.rb
 - lib/schema_dev/tasks.rb
+- lib/schema_dev/travis.rb
 - lib/schema_dev/version.rb
 - schema_dev.gemspec
 - schema_dev.yml