schemer 0.0.10

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Ben Alavi for Citrusbyte
+
+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,120 @@
+Schemer
+=======
+
+On-the-fly ActiveRecord schema changes for extremely rapid prototyping.
+
+Description
+-----------
+
+Loosely define your schema in your ActiveRecord model and have it created and
+updated for you without worrying about migrations. Useful for when you want to
+play around with real data handling during prototyping but you really don't 
+care about keeping the data or how it's defined.
+
+This isn't meant to be a replacement for migrations, it is simply a way to get
+started on a project quickly while you iron out your data definitions.
+
+**WARNING:** This will create and delete data definitions on the fly with no
+warning! Only use this with volatile data! Never attach it to an existing model
+you care about as it will start adding and dropping columns without your
+consent!
+
+Usage
+-----
+
+    class User < ActiveRecord::Base
+      schema :username, :password
+    end
+    
+Creates a `users` table if it doesn't exist, complete with `username` and 
+`password` columns the first time the User class is loaded.
+
+Need another column to play with?
+
+    class User < ActiveRecord::Base
+      schema :username, :password, :email
+    end
+    
+Adds an `email` column the next time `User` class is loaded.
+
+Want a relationship? (but fear commitment...)
+
+    class Widget < ActiveRecord::Base
+      schema :user_id, :name
+  
+      belongs_to :user
+    end
+
+Works just fine, and you can drop it at any time!
+
+    class Widget < ActiveRecord::Base
+      schema :name
+    end
+
+Removes the `user_id` column the next time the `Widget` class is loaded.
+
+Have a need for a particular type of column?
+
+    class Widget < ActiveRecord::Base
+      schema :name, { :size => :integer }, :description
+    end
+    
+Will create `size` as an `:integer` column so you can take advantage of Rails'
+casting.
+
+Feeling more confident and ready to make that big leap to migrations? Just run:
+
+    rake schemer:migration
+    
+To get:
+
+    Migration from schema declarations in User, Widget
+
+    create_table :users do |t|
+      t.string :username
+      t.string :password
+      t.string :email
+    end
+
+    create_table :widgets do |t|
+      t.string :name
+      t.integer :size
+      t.string :description
+    end
+
+Then you can paste the output into a migration file, setup your columns (don't
+forget your indexes!) and get rid of your `schema` calls in the listed classes
+and you're on your way to the big leagues!
+
+**NOTE:** All columns are created as string columns unless type is given.
+
+Installation
+------------
+
+    $ sudo gem install citrusbyte-schemer --source=http://gems.github.com
+
+License
+-------
+
+Copyright (c) 2009 Ben Alavi for Citrusbyte
+
+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/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/clean'
+
+gem_spec_file = 'schemer.gemspec'
+
+gem_spec = eval(File.read(gem_spec_file)) rescue nil
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+Rake::GemPackageTask.new(gem_spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+  rm_f FileList['pkg/**/*.*']
+end if gem_spec
+
+desc "Generate the gemspec file."
+task :gemspec do
+  require 'erb'
+
+  File.open(gem_spec_file, 'w') do |f|
+    f.write ERB.new(File.read("#{gem_spec_file}.erb")).result(binding)
+  end
+end
+
+desc "Builds and installs the gem."
+task :install => :repackage do
+  `sudo gem install pkg/#{gem_spec.name}-#{gem_spec.version}.gem`
+end

data/lib/schemer.rb

@@ -0,0 +1,58 @@
+require 'activerecord'
+
+module Schemer
+  def schema(*args)
+    extend ClassMethods
+    
+    class_inheritable_accessor :schema_columns
+    self.schema_columns = {}
+    args.collect{ |a| a.is_a?(Hash) ? a.stringify_keys : { a.to_s => :string } }.each do |column|
+      self.schema_columns.merge!(column)
+    end 
+
+    update_schema
+    update_methods
+  end
+
+  module ClassMethods
+    # Columns which we don't touch regardless of not being defined in schema
+    # (and are ignored if they are defined in schema)
+    def protected_columns
+      %w( id )
+    end
+    
+    # Create the underlying table for this class
+    def create_table
+      ActiveRecord::Migration.create_table(table_name) do |t|;end;
+    end
+    
+    # Update ActiveRecord's automatically generated methods so we don't have to
+    # reload for schema changes to take effect
+    def update_methods
+      generated_methods.each { |method| remove_method(method) }
+      @columns = @column_names = @columns_hash = @generated_methods = nil
+    end
+    
+    # Update the underlying schema as defined by schema call
+    def update_schema
+      create_table unless table_exists?
+
+      columns.reject{ |column| protected_columns.include?(column.name) }.each do |column|
+        if !schema_columns.has_key?(column.name)
+          # remove any extraneous columns
+          ActiveRecord::Migration.remove_column(table_name, column.name)
+        elsif column.type != schema_columns[column.name]
+          # change any columns w/ wrong type
+          ActiveRecord::Migration.change_column(table_name, column.name, schema_columns[column.name])
+        end
+      end
+
+      # add any missing columns
+      (schema_columns.keys - column_names).each do |column|
+        ActiveRecord::Migration.add_column(table_name, column, schema_columns[column])
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend(Schemer)

data/lib/schemer/migrator.rb

@@ -0,0 +1,18 @@
+module Schemer
+  class Migrator
+    class << self
+      # Outputs the Rails migration for the schema defined in the given class.
+      # 
+      # Outputs an empty string if no schema is defined on the class.
+      def migration(klass)
+        return nil unless klass.respond_to?(:schema_columns)
+        
+        "create_table :#{klass.table_name} do |t|\n" +
+        (klass.schema_columns.keys - klass.protected_columns).collect do |column| 
+          "  t.#{klass.schema_columns[column]} :#{column}"
+        end.join("\n") +
+        "\nend"
+      end
+    end
+  end
+end

data/lib/schemer/tasks/schemer.rake

@@ -0,0 +1,22 @@
+namespace :schemer do
+  desc "Outputs the basis of a Rails migration from your schema declarations"
+  task :migration => :environment do
+    klasses = []
+
+    Dir.glob(File.join(Rails.root, "app", "models", "**.rb")).each do |file|
+      lineno  = 0
+      result = File.readlines(file).each do |line|
+        lineno += 1
+        next unless line =~ /^class (.*) \<.*$/
+        klasses << $1.constantize
+      end
+    end
+    
+    migration = klasses.collect do |klass|
+      Schemer::Migrator.migration(klass)
+    end.join("\n\n")
+    
+    puts "\nMigration from schema declarations in #{klasses.join(', ')}"
+    puts "\n#{migration}\n\n"
+  end
+end

data/rails/init.rb

@@ -0,0 +1,3 @@
+raise "We highly suggest you only use Schemer in development or test mode (not in #{Rails.env})!" unless %w( development test ).include?(Rails.env.to_s)
+Rails.logger.warn "Loading Schemer which will consider all your data volatile!"
+require 'schemer'

data/test/schemer_test.rb

@@ -0,0 +1,94 @@
+require 'rubygems'
+require 'contest'
+require 'override'
+require 'ruby-debug'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'schemer')
+require File.join(File.dirname(__FILE__), '..', 'lib', 'schemer', 'migrator')
+
+ActiveRecord::Base.establish_connection :adapter => 'sqlite3', :database => 'test/schemer_test.db'
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+
+class Foo < ActiveRecord::Base;end;
+ActiveRecord::Migration.drop_table(Foo.table_name) if Foo.table_exists?
+class Bar < ActiveRecord::Base;end;
+ActiveRecord::Migration.drop_table(Bar.table_name) if Bar.table_exists?
+
+class FooTest < Test::Unit::TestCase  
+  context "defining the schema" do
+    setup do
+      Foo.schema :foo, :bar
+    end
+    
+    should "create the foos table" do
+      assert Foo.table_exists?
+    end
+    
+    context "with an instance" do
+      setup do
+        @foo = Foo.new
+      end
+      
+      should "create the foo column" do
+        assert @foo.respond_to?(:foo)
+      end
+
+      should "create the bar column" do
+        assert @foo.respond_to?(:bar)
+      end
+    end
+  end
+  
+  context "updating the schema" do
+    setup do
+      Foo.schema :foo, :bar
+      Foo.schema :foo
+      @foo = Foo.new
+    end
+    
+    should "remove the bar column" do
+      assert !@foo.respond_to?(:bar)
+    end
+  end
+  
+  context "with types" do
+    setup do
+      Foo.schema :foo, { :bar => :integer }, :baz
+      @foo = Foo.find(Foo.create!(:foo => '5', :bar => 5).id)
+    end
+    
+    should "create foo, bar and baz columns" do
+      assert @foo.respond_to?(:foo)
+      assert @foo.respond_to?(:bar)
+      assert @foo.respond_to?(:baz)
+    end
+    
+    should "create bar column using integer datatype" do
+      assert_equal 5, @foo.bar
+    end
+    
+    should "create foo column using string datatype" do
+      assert_equal '5', @foo.foo
+    end
+    
+    should "recreate foo column as integer" do
+      Foo.schema({ :foo => :integer }, { :bar => :integer }, :baz)
+      foo = Foo.find(Foo.create!(:foo => '5', :bar => '5').id)
+      assert_equal 5, foo.foo
+    end
+  end
+  
+  context "building a Rails migration" do
+    setup do
+      Foo.schema :foo, :bar
+    end
+    
+    should "output the migration for Foo" do
+      assert_equal(
+%Q{create_table :foos do |t|
+  t.string :foo
+  t.string :bar
+end}, Schemer::Migrator.migration(Foo)
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: schemer
+version: !ruby/object:Gem::Version 
+  version: 0.0.10
+platform: ruby
+authors: 
+- Ben Alavi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-05 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: ben.alavi@citrusbyte.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- LICENSE
+- Rakefile
+- lib/schemer/migrator.rb
+- lib/schemer.rb
+- lib/schemer/tasks/schemer.rake
+- rails/init.rb
+- test/schemer_test.rb
+has_rdoc: true
+homepage: http://github.com/citrusbyte/schemer
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: On-the-fly ActiveRecord schema changes for extremely rapid prototyping.
+test_files: []
+