sequel-mysql_generated_columns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cebd0e3d382ad56563cc96ab8f07ce0f4936455c
+  data.tar.gz: fa6d22d714976ed109e45a474936427141f6d06e
+SHA512:
+  metadata.gz: 00a490e3c86c400f023612c92e54b4927ade888017d7be3c5773d719405ec6424d9b33b6040901475f7acd723e49bae4af1c96ae8ca9b6cc615ca91eae8b0d43
+  data.tar.gz: a8ce7cf5f97015e61f92d6bf2b581c60eaee234a24b70b08d47677ca3c71f64d47d240b6cdb5bcd06ed775e6f221b1f9524a886f1aff0707296425cfd49b16f4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.swp
+*.swo

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/README.md

@@ -0,0 +1,128 @@
+# sequel-mysql_generated_columns [![Build Status](https://travis-ci.org/munshkr/sequel-mysql_generated_columns.svg?branch=master)](https://travis-ci.org/munshkr/sequel-mysql_generated_columns)
+
+Sequel extension that adds support for MySQL generated columns (added first on
+MySQL 5.7.5).
+
+When enabled, use `#generated_column` method on `DB#create_table` blocks, and
+`#add_generated_column` method on `DB#alter_table` blocks.
+
+## Example
+
+```ruby
+create_table(:triangles) do
+  Integer :a
+  Integer :b
+  generated_column :c, Integer, :sqrt.sql_function(:a*:a + :b*:b)
+end
+```
+
+```sql
+CREATE TABLE `triangles` (
+  `a` integer,
+  `b` integer,
+  `c` integer AS (sqrt(((`a` * `a`) + (`b` * `b`))))
+)
+```
+
+```ruby
+create_table(:docs) do
+  json :doc
+end
+
+alter_table(:docs) do
+  add_generated_column :id, Integer, :json_extract.sql_function(:doc, '$.id'), primary_key: true, stored: true
+end
+```
+
+```sql
+CREATE TABLE `documents` (`doc` json)
+ALTER TABLE `documents` ADD COLUMN `id` integer AS (json_extract(`doc`, '$.id')) STORED PRIMARY KEY
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sequel-mysql_generated_columns'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel-mysql_generated_columns
+
+
+## Usage
+
+To enable extension, call `DB.extension :mysql_generated_columns`.
+
+Use `#generated_column(name, type, expression, opts)` or
+`#add_generated_column(name, type, expression, opts)` on `create_table` and
+`alter_table` blocks respectively.
+
+Possible options:
+
+* `:stored`: Whether generated column will be STORED or VIRTUAL. By default it
+  omits the STORED keyword, so this means generated column will be a virtual
+  column.
+
+* `:unique`: Whether to add a unique constraint or not. By default it omits the
+  UNIQUE KEY keyword.
+
+* `:null`: Allow null values or not. By default it omits keyword, meaning it
+  falls back to database default.
+
+* `:primary_key`: If column has a primary key or not. By default it omits the
+  keyword PRIMARY KEY.
+
+* `:index`: Whether to create an index after adding column or not. Same
+  arguments as `:index` option in conventional `#add_column`.
+
+
+## Development
+
+After checking out the repo, install `bundler` with `gem install bundler`, and
+run `bundle install` to install dependencies. Then, run `rake test` to run the
+tests.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/munshkr/sequel-mysql_generated_columns.
+
+
+## License
+
+MIT License
+
+Copyright (c) 2016 Damián Silvani
+
+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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << "spec"
+  t.libs << "lib"
+  t.test_files = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec

data/lib/sequel/extensions/mysql_generated_columns.rb

@@ -0,0 +1,98 @@
+module Sequel
+  module Mysql
+    module GeneratedColumns
+      # The order of column modifiers to use when defining a column.
+      GENERATED_COLUMN_DEFINITION_ORDER = [:stored, :unique, :null, :primary_key]
+      STORED = ' STORED'.freeze
+      UNIQUE = ' UNIQUE'.freeze
+      NULL = ' NULL'.freeze
+      NOT_NULL = ' NOT NULL'.freeze
+      PRIMARY_KEY = ' PRIMARY KEY'.freeze
+
+      # Additional methods for the create_table generator to support constraint validations.
+      module CreateTableGeneratorMethods
+        def generated_column(name, type, expr, opts={})
+          index_opts = opts.delete(:index)
+          columns << {:name => name, :type => type, :expr => expr, :gen => true}.merge!(opts)
+          if index_opts
+            index(name, index_opts.is_a?(Hash) ? index_opts : {})
+          end
+        end
+      end
+
+      # Additional methods for the alter_table generator to support constraint validations,
+      # used to give it a more similar API to the create_table generator.
+      module AlterTableGeneratorMethods
+        include CreateTableGeneratorMethods
+
+        # Add a generated column with the given name, type, and opts to the DDL for the table.
+        #
+        #   add_generated_column(:name, String, Sequel.function(:sum, :a, :b)) # ADD COLUMN name varchar(255) AS (SUM(a, b))
+        def add_generated_column(name, type, expr, opts={})
+          @operations << {:op => :add_column, :name => name, :type => type, :expr => expr, :gen => true}.merge!(opts)
+        end
+      end
+
+      # Modify the default create_table generator to include
+      # the generated columns methods.
+      def create_table_generator(&block)
+        super do
+          extend CreateTableGeneratorMethods
+          @generated_columns = []
+          instance_eval(&block) if block
+        end
+      end
+
+      # Modify the default alter_table generator to include
+      # the generated columns methods.
+      def alter_table_generator(&block)
+        super do
+          extend AlterTableGeneratorMethods
+          instance_eval(&block) if block
+        end
+      end
+
+      # Modify column definition generator method to support generated columns
+      def column_definition_sql(column)
+        if column[:gen]
+          sql = String.new
+          sql << "#{quote_identifier(column[:name])} #{type_literal(column)}"
+          sql << " AS (#{literal(column[:expr])})"
+          generated_column_definition_order.each{|m| send(:"generated_column_definition_#{m}_sql", sql, column)}
+          sql
+        else
+          super
+        end
+      end
+
+      # The order of the generated column definition, as an array of symbols.
+      def generated_column_definition_order
+        GENERATED_COLUMN_DEFINITION_ORDER
+      end
+
+      # Add stored SQL fragment to column creation SQL.
+      def generated_column_definition_stored_sql(sql, column)
+        sql << STORED if column[:stored]
+      end
+
+      # Add unique SQL fragment to column creation SQL.
+      def generated_column_definition_unique_sql(sql, column)
+        sql << UNIQUE if column[:unique]
+      end
+
+      # Add null SQL fragment to column creation SQL.
+      def generated_column_definition_null_sql(sql, column)
+        null = column.fetch(:null, column[:allow_null])
+        sql << NOT_NULL if null == false
+        sql << NULL if null == true
+      end
+
+      # Add unique SQL fragment to column creation SQL.
+      def generated_column_definition_primary_key_sql(sql, column)
+        sql << PRIMARY_KEY if column[:primary_key]
+      end
+    end
+  end
+
+  Database.register_extension(:mysql_generated_columns, Mysql::GeneratedColumns)
+end

data/sequel-mysql_generated_columns.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "sequel-mysql_generated_columns"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Damián Silvani"]
+  spec.email         = ["munshkr@gmail.com"]
+
+  spec.summary       = %q{Sequel extension that adds support for MySQL generated columns.}
+  spec.homepage      = "https://github.com/munshkr/sequel-mysql_generated_columns"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_dependency "sequel", ">= 4"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: sequel-mysql_generated_columns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Damián Silvani
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+description: 
+email:
+- munshkr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/sequel/extensions/mysql_generated_columns.rb
+- sequel-mysql_generated_columns.gemspec
+homepage: https://github.com/munshkr/sequel-mysql_generated_columns
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Sequel extension that adds support for MySQL generated columns.
+test_files: []