skiima 0.1.000 → 0.2.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Yjc2YmJlOTIwMzY2YWM2MjQ0OGU2OTFhNTllNzMxMDA2Y2I4YmM5OA==
+  data.tar.gz: !binary |-
+    NGQ3M2RhMWM5YTUxYjRmNGI0NjFhNDY4NDUyNWNjYjQzZjVjYzQzNg==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YzY1NTIyNzcwZTczZTQwMjZiYzkxYTcyMjQ1M2E1Mzk4MGU3OTcyOTk4MzZi
+    YTZhNWM4NzRiOGQzZmNjMWJmZjI5MzQ4YjZiZGM1MWY1Y2RjM2Q1NTlmMzY5
+    MjdmOTE5Yzc1NzkyMGU5MDZkNTU5ZGRlYTM5MzdlMDJlZjY5NGY=
+  data.tar.gz: !binary |-
+    NDMzZjgzMmIxMjk1NTExODE5Y2E0MzhmZDYyNDU2ZGFlOWU4ZWRkNGE2Yjcy
+    OThhNzMyMDdhZDI2MWVhNWVkODc2Mzk2NWZhZGQ1YzkxNjIwNGM4ZjJhMzBm
+    YjljNmMyNjNhMDQwODU0YjM0NWRhNGI0M2IzNjNjMzMzMDJlZjQ=

data/.gitignore

@@ -1,8 +1,11 @@
+## Ruby
 *.gem
 .rvmrc
 .bundle
 Gemfile.lock
 pkg/*
+.guard_history
+Procfile
 
 ## Rubymine
 .idea/*
@@ -18,3 +21,9 @@ Desktop DF
 
 ## Spec Logging
 spec/test.log
+
+## Config
+spec/config/database.yml
+
+## Notes
+NOTES.md

data/.travis.yml

@@ -2,7 +2,15 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
-  - jruby
+  - 2.0.0
   - rbx-19mode
-# uncomment this line if your project needs to run something other than `rake`:
-# script: bundle exec rspec spec
+#  - jruby
+services:
+ - mysql
+ - postgresql
+before_script:
+  - cp spec/config/database.yml.travis spec/config/database.yml
+  - mysql -e "create user 'skiima'@'localhost'"
+  - rake skiima:setup:db:postgresql
+  - rake skiima:setup:db:mysql
+#script: rake

data/Gemfile

@@ -5,14 +5,20 @@ source "http://rubygems.org"
 gemspec
 
 group :development do
-  gem 'guard'
-  gem 'guard-minitest'
+  gem 'guard', '~> 1.6.2'
+  gem 'guard-minitest', '~> 0.5.0'
   gem 'pry'
   gem 'rake'
 
-  gem 'pg'
-  gem 'mysql'
-  gem 'mysql2'
+  gem 'foreman', '~> 0.62.0'
+  gem 'pg', '~> 0.14.1'
+  gem 'mysql', '~> 2.9.1'
+  gem 'mysql2', '~> 0.3.11'
+end
+
+group :active_record do
+  gem 'activerecord', '>= 3.2', '< 4.1'
+  gem 'activesupport', '>= 3.2', '< 4.1'
 end
 
 if Config::CONFIG['target_os'] =~ /darwin/i
@@ -23,7 +29,7 @@ if Config::CONFIG['target_os'] =~ /linux/i
   gem 'rb-inotify', '>= 0.5.1'
   gem 'libnotify',  '~> 0.1.3'
 end
-if RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
+if Config::CONFIG['target_os'] =~ /mswin|mingw/i
   gem 'win32console',             :require => false
   gem 'rb-fchange',   '~> 0.0.2', :require => false
   gem 'rb-notifu',    '~> 0.0.4', :require => false

data/Guardfile

@@ -1,14 +1,16 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
+interactor guard_rc: '~/.my_guard-rc', history_file: '.guard_history'
+scope groups: [:minitest]
 
-guard 'minitest', :notify => true do
-  # with Minitest::Unit
-  # watch(%r|^test/test_(.*)\.rb|)
-  # watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
-  # watch(%r|^test/test_helper\.rb|)    { "test" }
+group :minitest do
+  guard :minitest, :notify => true do
+    # with Minitest::Unit
+    # watch(%r|^test/test_(.*)\.rb|)
+    # watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+    # watch(%r|^test/test_helper\.rb|)    { "test" }
 
-  # with Minitest::Spec
-  watch(%r|^spec/(.*)_spec\.rb|)
-  watch(%r|^lib/(.*)\.rb|)            { |m| "spec/#{m[1]}_spec.rb" }
-  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+    # with Minitest::Spec
+    watch(%r|^spec/(.*)_spec\.rb|)
+    watch(%r|^lib/(.*)\.rb|)            { |m| "spec/#{m[1]}_spec.rb" }
+    watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+  end
 end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 David Conner
+
+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/Procfile.example

@@ -0,0 +1,2 @@
+postgres: postgres -D /usr/local/var/postgres
+mysql: /usr/local/bin/mysqld

data/README.md

@@ -1,21 +1,133 @@
 Skiima: an ORM-Agnostic, Rails-Independent alternative to migrations.
-------------------------
 
-#### Goals:
-Skiima is a work in progress with the following goals:
+[![Build Status](https://travis-ci.org/dcunited001/skiima.png?branch=master)](https://travis-ci.org/dcunited001/skiima)
+
+------------------------
 
+## Using Skiima with ActiveRecord:
+
+> Adding generators soon
+
+#### Installing
+1. Add skiima to your Gemfile
+1. Bundle Install
+1. Configure your database.yml
+  - Ensure that users have the appropriate DDL permissions
+1. `mkdir db/skiima`
+1. `touch db/skiima/dependencies.yml`
+  - Refer to the example below or $SKIIMA_GEM/spec/db/skiima/dependencies
+1. Set up a :test dependency group
+  - include the groups of scripts you want to run after a fresh db clone
+  - add `bundle exec rake skiima:test:up` to your CI setup script, after calling db:test:prepare
+  - or add a rake task to your project that calls both db:test:prepare and skima:test:up
+  - specify environment/groups with `bundle exec rake skiima:test:up[development,group_name]
+1. Set up a :default dependency group
+  - include the groups of scripts you want to run during every deploy
+  - because the scripts are run on each deploy, this rake task should only be used in certain instances
+  - you should usually call Skiima.up & Skiima.down from a migration
+
+#### Adding a new Skiima Script Group to your project
+
+> Again, generators coming soon to help automate this.
+
+1. Add a new migration to your Rails project.  Refer to the sample below.
+1. `mkdir db/skiima/$group_name`
+1. `touch db/skiima/$group_name/$type.$object_name.$db_type.$db_version.sql`
+  - $type => view/proc/function/etc
+  - $object_name => identifies the script across multiple db providers & versions
+  - $db_type => provider name (mysql/postgres)
+  - $db_version => usually just 'current'
+    - using $db_version, you can write scripts to support multiple versions of mysql, for example
+    - Skiima compares the connected database's version to pull the correct script
+    - or you can just configure skiima to prefer to load specific version of sql scripts
+    - pass :version => 'version_name' to Skiima.up & Skiima.down
+1. Also add a corresponding drop script to run if:
+  - either the up script is not reversible with a single drop statement
+  - or if Skiima can not automatically drop that type object
+  - see below for supported objects
+1. Now update db/skiima/dependencies.yml
+  - Refer to the example below or $SKIIMA_GEM/spec/db/skiima/dependencies
+1. The script should be ready to use with Skiima.up & Skiima.down
+
+Sample Skiima Migration:
+
+```ruby
+
+class AddViewBackedModel < ActiveRecord::Migration
+  def up
+    Skiima.up(Rails.env, :group_name)
+  end
+
+  def down
+    Skiima.down(Rails.env, :group_name)
+  end
+end
+
+```
+
+Sample Dependencies.yml:
+
+```yml
+
+script_group_name:
+  postgresql:
+    current:
+      - view.script_name
+  mysql:
+    current:
+      - view.script_name
+default:
+test:
+  - script_group_name
+dependency_group_name:
+  - script_group_name
+
+```
+
+#### Running tests with your new Skiima Script Group
+
+1. `bundle exec rake db:migrate`
+1. `bundle exec rake db:test:prepare`
+1. `bundle exec rake skiima:test:up`
+1. `bundle exec rake`
+
+#### Adding a view-backed model
+
+```ruby
+# add a view named 'view_foo_report_on_bar'
+class FooReportOnBar < ActiveRecord::Base
+  set_table_name :view_foo_report_on_bar
+
+  belongs_to :baz
+end
+```
+
+## Using Skiima with another ORM:
+
+> Support for Datamapper, Sequal, & JRuby providers coming soon.
+
+## Running Tests
+
+1. Setup Mysql & Postgres.  Copy database.yml.example & set up users/passwords for your system
+1. Bundle Install
+1. Run test setup tasks
+  - bundle exec rake skiima:setup:db:postgresql
+  - bundle exec rake skiima:setup:db:mysql
+1. `rake`
+
+## Skiima Goals:
 * Provide a better way to integrate views and functions into Ruby applications.
 * Embeddable in gems to create DB independent extensions.
 * Avoid any unnecessary dependencies or complexity.
 
-I was working on another project and added some cool features that relied on postgres views, rules, etc.  And basically, I needed a place to put these scripts and a way to execute them in a specified order.  
+I was working on another project and added some cool features that relied on postgres views, rules, etc.  And basically, I needed a place to put these scripts and a way to execute them in a specified order.
 
 There are alot of cool tricks to use in ActiveRecord with sql objects other than tables.  Not to mention there are performance benefits with the right schema.  Not everything needs to happen at the application layer.
 
 If you have any questions about how things work, look at the tests.  If you have any suggestions, don't hesitate to contact me.
 
-#### Supported Databases:
-##### Postgres
+## Supported Databases:
+#### Postgres
 
 - Schemas
 - Tables
@@ -25,7 +137,7 @@ If you have any questions about how things work, look at the tests.  If you have
 - Triggers(soon)
 - Functions(soon)
 
-##### Mysql/Mysql2
+#### Mysql/Mysql2
 
 - Tables
 - Views
@@ -34,36 +146,36 @@ If you have any questions about how things work, look at the tests.  If you have
 - Functions(soon)
 - Procs(soon)
 
-#### Interface:
-##### Config Files
-Skiima reads two yaml files: database.yml and depends.yml.  
+## Interface:
+#### Config Files
+Skiima reads two yaml files: database.yml and dependencies.yml.
 
 - By default, `database.yml` goes in your `APP_ROOT/config directory`.
-- And similarly, `depends.yml` goes in `APP_ROOT/db/skiima`.
+- And similarly, `dependencies.yml` goes in `APP_ROOT/db/skiima`.
 
-##### Groups
+#### Groups
 Skiima allows you to create groups of sql scripts to be executed during migrations.  Each group of sql scripts requires its own folder inside `db/skiima`.
 
-##### Adapter and Version
+#### Adapter and Version
 Since different databases have different capabilities and object types, you can trigger different scripts to run per adapter.  Furthermore, you can execute different scripts for different versions of a database.  You can also use this version tag if you want to package different sets of functionality.
 
-##### Depends.yml Format
-In the `depends.yml` configuration, add lines for each script in the format.
+#### Dependencies.yml Format
+In the `dependencies.yml` configuration, add lines for each script in the format.
 
 * `type.name.attr1.attr2`
 
 `attr1` and `attr2` allow you to define the target SQL object and other attributes that need to be passed on a per type basis.  This is only used when Skiima drops your objects without a matching 'drop' script.
 
-##### Filename Format
-Inside each group folder, create sql files with the following format.  These need to match the `depends.yml` configuration.  
+#### Filename Format
+Inside each group folder, create sql files with the following format.  These need to match the `dependencies.yml` configuration.
 
 * `type.name.adapter.version.sql`
 * `type.name.adapter.version.drop.sql` to override the default drop behavior.
 
-##### Interpolation in Scripts
+#### Interpolation in Scripts
 You can interpolate variables in your SQL Scripts and then pass in values at runtime with the `:vars` hash.  The default character to use for interpolation is `&`, but this can be changed in the Module initialization.  There are default vars that are substituted, such as `&database`.
 
-##### Module Initialization
+#### Module Initialization
 If you're using Rails, you can add a Skiima.setup block in an intializer file to set defaults.  There are other ways to integrate Skiima into your project as well.
 
     Skiima.setup do |config|
@@ -73,15 +185,50 @@ If you're using Rails, you can add a Skiima.setup block in an intializer file to
       config.locale = :en
     end
 
-##### Finally, in your Migrations
-Skiima reads the specified groups from depends.yml and compiles a list of scripts to run.  If you're using Rails, substitute `:development` with `Rails.env`
+#### Finally, in your Migrations
+Skiima reads the specified groups from dependencies.yml and compiles a list of scripts to run.  If you're using Rails, substitute `:development` with `Rails.env`
 
     def up
       Skiima.up(:development, :group_one, :group_n, :vars => {:var_one => 'db_name'})
     end
-    
+
     def down
       Skiima.down(:development, :group_one, :group_n, :vars => {:var_one => 'db_name'})
     end
 
-#### yes, i know i am shamelessly biting activerecord code.  
+## 0.2.000 Updates:
+
+- Added a modified OpenStruct to manage configuration
+- Moved most classes to separate files
+
+## 0.2.010 Updates:
+
+- Add Skiima::Db::Connector
+- Update Skiima::Db::Resolver
+- Add ActiveRecord::BaseConnector
+- Add PosgresqlConnector
+- Add Postresql Helpers
+- Add MysqlConnector
+- Add Mysql2Connector
+- Add Mysql Helpers
+
+## 0.2.011 Updates:
+
+- Add Travis CI Config
+- Add Railties tasks
+- Updated dependencies.yml to allow for dependency groups
+- Updated Readme with examples
+
+## 0.2.100 Planned:
+
+- Add JRuby Support
+- Add Appraisal to test Skiima with separate bundles
+- Add Coveralls?
+- Add Gemnasium?
+
+## 0.3 Planned:
+
+- DataMapper Support
+- Sequel Support
+- Mongo Support?
+- Manage config's for other data providers? (Redis/etc)

data/Rakefile

@@ -6,7 +6,6 @@ require 'skiima'
 
 SPEC_ROOT = File.join(File.dirname(__FILE__), 'spec')
 
-
 Rake::TestTask.new do |t|
   t.libs << "spec"
   t.test_files = FileList['spec/**/*_spec.rb']
@@ -15,34 +14,39 @@ end
 
 task :default => :test
 
-namespace :test do
-  namespace :prepare do
+namespace :skiima do
+
+  task :setup do
+    Skiima.setup do |config|
+      config.root_path = SPEC_ROOT
+      config.config_path = 'config'
+      config.scripts_path = 'db/skiima'
+      config.locale = :en
+    end
+  end
+
+  namespace :setup do
+    namespace :db do
+
+      task :postgresql => :'skiima:setup' do
+        env = :postgresql_root
+        test_env = :postgresql_test
+        db = Skiima.read_db_yml(Skiima.full_database_path)
+        vars = { database: db[test_env]['database'], testuser: 'skiima', testpass: 'test'}
 
-    task :postgresql do
-      Skiima.setup do |config|
-        config.root_path = SPEC_ROOT
-        config.config_path = 'config'
-        config.scripts_path = 'db/skiima'
-        config.locale = :en
+        Skiima.up(env, :init_test_db, vars: vars)
       end
 
-      db_config = Skiima.read_db_yaml(Skiima.full_database_path)[:development]
-      Skiima.new(:development)
-      Skiima.read_sql_file('init_test_db', 'database.skiima_test.postgresql.current.sql')
-    end
+      task :mysql => :'skiima:setup' do
+        env = :mysql_root
+        test_env = :mysql_test
+        db = Skiima.read_db_yml(Skiima.full_database_path)
+        vars = { database: db[test_env]['database'], testuser: 'skiima', testpass: 'test'}
 
-    task :mysql do
-      Skiima.setup do |config|
-        config.root_path = SPEC_ROOT
-        config.config_path = 'config'
-        config.scripts_path = 'db/skiima'
-        config.locale = :en
+        Skiima.up(env, :init_test_db, vars: vars)
       end
 
-      db_config = Skiima.read_db_yaml(Skiima.full_database_path)
-      Skiima.read_sql_file('init_test_db', 'database.skiima_test.mysql.current.sql')
     end
-
   end
 end