activerecord-column_metadata 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013-onwards Tutuf Ltd.
+
+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,73 @@
+# ActiveRecord::ColumnMetadata
+
+Store metadata about columns in the database, as comments on columns (advanced PostgreSQL feature)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-column_metadata'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-column_metadata
+
+## Usage
+
+In a migration:
+
+    create_table(:cars) do |t|
+      t.string :name
+      t.string :manufacturer
+      t.string :model
+    
+      t.boolean :4wd
+      t.boolean :abs
+      t.boolean :airbag
+      t.boolean :gps
+      t.boolean :music_player
+    
+      [:4wd, :abs, :airbag, :gps, :music_player].each do |extra|
+        t.column_metadata(extra, {extra: true})
+      end
+    end
+
+or
+
+    add_column :cars, :aircondition, :boolean, metadata: {extra: true}
+
+And then you can say in the model:
+
+    class Car < ActiveRecord::Base
+      def self.extras
+        ActiveRecord::JsonMetadata.to_a("cars").select do |arr|
+          column_name, metadata = arr
+          column_name if metadata["extra"] == true
+        end
+      end
+    end
+
+## Rationale
+
+In the above example you could hardcode extras in the model:
+
+    class Car < ActiveRecord::Base
+      def self.extras
+        [:4wd, :abs, :airbag, :gps, :music_player]
+      end
+    end
+
+But what will happen when you have to add or remove an extra? You have to edit two files: migration and the corresponding ActiveRecord model. Unnecessary repetition
+causes brain injury.
+
+## 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,23 @@
+require "bundler/gem_tasks"
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+task :default => :spec
+
+desc "Run all specs in spec directory"
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :test do
+  desc 'Build the test database'
+  task :create_database do
+    %x( createdb -U postgres activerecord-column_metadata_test )
+  end
+
+  desc 'Drop the test database'
+  task :drop_database do
+    %x( dropdb -U postgres activerecord-column_metadata_test )
+  end
+
+  desc 'Rebuild the test database'
+  task :rebuild_database => [:drop_database, :create_database]
+end

data/activerecord-column_metadata.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record/column_metadata/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-column_metadata"
+  spec.version       = ActiveRecord::ColumnMetadata::VERSION
+  spec.authors       = ["Sava Chankov", "Tsanka Encheva"]
+  spec.email         = ["sava@tutuf.com", "tsanka@tutuf.com"]
+  spec.description   = %q{ActiveRecord extension to store column metadata in database as comments on columns}
+  spec.summary       = %q{ActiveRecord extension to store column metadata in database}
+  spec.homepage      = "http://github.com/tutuf/activerecord-column_metadata"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "activerecord", "~>3.0.3"
+  spec.add_dependency "pg"
+  
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "database_cleaner"
+end

data/lib/active_record/column_metadata.rb

@@ -0,0 +1,4 @@
+require "active_record"
+require "active_record/column_metadata/version"
+require "active_record/column_metadata/read"
+require "active_record/column_metadata/write"

data/lib/active_record/column_metadata/read.rb

@@ -0,0 +1,20 @@
+require 'json'
+
+module ActiveRecord
+  class ColumnMetadata
+    # Retrieves metadata stored in the database for +table_name+ as
+    # [["col_name", {"key" => "val"}], ...]
+    def self.to_a(table_name)
+      res = ActiveRecord::Base.connection.query(<<-END_SQL, 'Get comments')
+        SELECT a.attname,
+               pg_catalog.col_description(a.attrelid, a.attnum)
+          FROM pg_catalog.pg_attribute a
+         WHERE a.attrelid = '#{table_name}'::regclass
+           AND a.attnum > 0
+           AND NOT a.attisdropped
+      ORDER BY a.attname
+      END_SQL
+      res.map{ |tupple| [tupple.first, JSON.parse(tupple.last)] unless tupple.last.nil? }.compact
+    end
+  end
+end

data/lib/active_record/column_metadata/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  class ColumnMetadata
+    VERSION = "0.0.1"
+  end
+end

data/lib/active_record/column_metadata/write.rb

@@ -0,0 +1,60 @@
+require 'active_record/connection_adapters/abstract/schema_definitions'
+require 'active_record/connection_adapters/abstract/schema_statements'
+require 'active_record/connection_adapters/postgresql_adapter'
+
+module ActiveRecord
+  module ConnectionAdapters
+    class TableDefinition
+      module ColumnMetadata
+        def column_metadata(column, hash)
+          add_comment(column, hash)
+        end
+      
+        def add_comment(column, comment)
+          @comments ||= []
+          @comments << [column, comment]
+        end
+    
+        def comments
+          @comments
+        end
+      end
+      
+      include ColumnMetadata
+    end
+    
+    module SchemaStatements
+      # works only with databases that support comments on columns
+      def create_table(table_name,options={},&block)
+        table_definition = TableDefinition.new(self)
+        table_definition.primary_key(options[:primary_key] || Base.get_primary_key(table_name)) unless options[:id] == false
+
+        yield table_definition if block_given?
+
+        if options[:force] && table_exists?(table_name)
+          drop_table(table_name, options)
+        end
+
+        create_sql = "CREATE#{' TEMPORARY' if options[:temporary]} TABLE "
+        create_sql << "#{quote_table_name(table_name)} ("
+        create_sql << table_definition.to_sql
+        create_sql << ") #{options[:options]}"
+        execute create_sql
+        table_definition.comments.each{ |c| write_json_comment(table_name, c.to_a.first, c.to_a.last) } if table_definition.comments
+      end
+    end
+    
+    class PostgreSQLAdapter < AbstractAdapter
+      def add_column_with_metadata(*args)
+        add_column_without_metadata(*args)
+        options = args.extract_options!
+        write_json_comment(args[0], args[1], options[:metadata])
+      end
+      alias_method_chain :add_column, :metadata
+      
+      def write_json_comment(table_name, column_name, comment)
+        execute "COMMENT ON COLUMN #{quote_table_name(table_name)}.#{quote_column_name(column_name)} IS #{quote(comment.to_json)}"
+      end
+    end
+  end
+end

data/spec/activerecord_column_metadata_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+describe ActiveRecord::ColumnMetadata do
+  it 'should have a version number' do
+    ActiveRecord::ColumnMetadata::VERSION.should_not be_nil
+  end
+
+  def get_comments(table_name)
+    ActiveRecord::Base.connection.query(<<-END_SQL, 'Get comments')
+      SELECT a.attname,
+             pg_catalog.col_description(a.attrelid, a.attnum)
+        FROM pg_catalog.pg_attribute a
+       WHERE a.attrelid = '#{table_name}'::regclass
+         AND a.attnum > 0
+         AND NOT a.attisdropped
+    ORDER BY a.attname
+    END_SQL
+  end
+
+  class CreateTableMigration < ActiveRecord::Migration
+    def self.up
+      create_table(:people) do |t|
+        t.string :name
+        t.column_metadata(:name, {:something => true})
+      end
+    end
+  end
+  
+  class AddColumnMigration < ActiveRecord::Migration
+    def self.up
+      add_column :people, :surname, :string, :metadata => {full_text_search: "double_metaphone"}
+    end
+  end
+
+  describe 'write should add JSON in comment' do
+    it 'with create_table' do
+      CreateTableMigration.up
+      res = get_comments("people")
+      expect(res).to include( ["name",'{"something":true}'])
+    end
+  
+    it 'with add_collumn' do
+      CreateTableMigration.up
+      AddColumnMigration.up
+      res = get_comments("people")
+      expect(res).to include( ['surname', '{"full_text_search":"double_metaphone"}'])
+    end
+  end
+  
+  describe 'read' do
+    it '#to_a should return a column comments as an array of arrays' do
+      CreateTableMigration.up
+      res = ActiveRecord::ColumnMetadata.to_a(:people)
+      res.should == [["name", {"something" => true}]]
+    end
+  end 
+end

data/spec/database.yml

@@ -0,0 +1,6 @@
+postgresql:
+  adapter: postgresql
+  username: postgres
+  password: postgres
+  database: activerecord-column_metadata_test
+  min_messages: ERROR

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'logger'
+require 'rspec'
+require 'database_cleaner'
+require 'active_record'
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'active_record/column_metadata'
+
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + '/debug.log')
+ActiveRecord::Base.configurations = YAML::load_file(File.dirname(__FILE__) + '/database.yml')
+ActiveRecord::Base.establish_connection(ENV['DB'] || 'postgresql')
+
+ActiveRecord::Base.silence do
+  ActiveRecord::Migration.verbose = false
+end
+
+RSpec.configure do |config|
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-column_metadata
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Sava Chankov
+- Tsanka Encheva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActiveRecord extension to store column metadata in database as comments
+  on columns
+email:
+- sava@tutuf.com
+- tsanka@tutuf.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-column_metadata.gemspec
+- lib/active_record/column_metadata.rb
+- lib/active_record/column_metadata/read.rb
+- lib/active_record/column_metadata/version.rb
+- lib/active_record/column_metadata/write.rb
+- spec/activerecord_column_metadata_spec.rb
+- spec/database.yml
+- spec/spec_helper.rb
+homepage: http://github.com/tutuf/activerecord-column_metadata
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ActiveRecord extension to store column metadata in database
+test_files:
+- spec/activerecord_column_metadata_spec.rb
+- spec/database.yml
+- spec/spec_helper.rb
+has_rdoc: