pgkingdom 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14b601f2b536cb9b79140ae57e0e359b2d36e9ba
+  data.tar.gz: 93e4c06372a96740ebfcdf2d6af496c894b42d95
+SHA512:
+  metadata.gz: 509a03dae64798fe32f624f0a6ca5d83833f311051b55836c1966aaa203b5b3d5d90fd8c6b8d402e4f28aa2236f003af618244ee74e26beef50583ac6d253870
+  data.tar.gz: 37e2a58503299b8e620c8345c63173e2702d607836943698ff0ab6f14e75129c85db5192029c07a57445cf9e50646fb293d5afba3ca3118d22fd29528a702bb0

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/.yardopts

@@ -0,0 +1,2 @@
+--markup-provider=redcarpet
+--markup=markdown

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 indiesoft.ru
+
+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,145 @@
+# PgKingdom
+
+Generally, `PgKingdom` is a set of tools to generate SQL queries for PostgreSQL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pgkingdom'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pgkingdom
+
+## Docs
+
+We used `yard` gem to handle code documentation. Just do:
+
+    $ git clone git://github.com/indiesoft/pgkingdom.git
+    $ cd pgkingdom
+    $ bundle install
+    $ yard docs
+
+And then you can view it by opening `path_to_pgkingdom_source/docs/index.html`.
+
+## Usage stories
+
+### Ancient Scrolls
+
+Currently this Gem has WIP status. To get all supported datatypes do:
+```ruby
+PgKingdom.available_data_types
+# => [:uuid, :boolean, :money, ... ]
+```
+
+If you ever need all PostgreSQL data types, sorted and grouped do:
+```ruby
+PgKingdom.data_types
+# => {
+#  "uuid": [ :uuid ],
+#  "boolean": [ :boolean ],
+#  "numeric": [
+#    [ :smallint, :integer, :bigint ],
+#    [ :smallserial, :serial, ...],
+#    [ ... ],
+#  ],
+#  ...
+# }
+```
+
+Far far ago in a fairy SQL Kingdom powerful mages written magic scrolls.
+One day Princess found one and started to read...
+
+### Spells - containers (de)materialization
+
+`Scroll`: The first spell you will learn is `Table` spell. It used to (de)materialize containers for any type of essence of matter. First, define a table:
+```ruby
+@frog_cage = PgKingdom::Table.new :abra_cadabra do
+  serial :id, :primary_key
+  varchar :name, 50, :not_null
+  boolean :prince, :default => 'FALSE'
+end
+# => #<PgKingdom::Table:...>
+
+@frog_cage.schema # => :public
+
+@frog_cage.name # => :abra_cadabra
+```
+
+Princess: But I don't want to create this frog cage at a festive fair!
+
+(continued to read):
+```ruby
+@frog_cage = PgKingdom::Table.new [:abra, :cadabra] do
+  # ...
+end
+
+# Ensure that cage will be created at your secret depot
+@frog_cage.schema # => :abra
+
+@frog_cage.name # => :cadabra
+```
+
+`Princess`: Fine!
+
+`Scroll`: ...let's prepare materialization spell for frog cage, do:
+```ruby
+@frog_cage.create
+```
+
+`Scroll`: It will make fairy pen to write a new scroll with following spell:
+```SQL
+CREATE TABLE IF NOT EXISTS public.abra_cadabra (
+  id SERIAL PRIMARY KEY,
+  name VARCHAR(50) NOT NULL,
+  prince BOOLEAN DEFAULT FALSE
+);
+```
+
+`Scroll`: If you're sure, that there is no frog cages near you, you can do:
+```ruby
+@frog_cage.create! # => "CREATE TABLE public.abra_cadabra ( ... );\n"
+```
+
+`Scroll`: In case, when you're not sure that princess from a neighboring fairy kingdom have her own frog cage, you can do:
+```ruby
+@frog_cage = PgKingdom::Table.new [:neighborhood, :abra_cadabra] do 
+  # ...
+end
+
+@frog_cage.table_exists?
+# => "SELECT to_regclass('neighborhood.abra_cadabra') IS NOT NULL AS table_exists;"
+```
+
+`Scroll`: Remember, if any container will make you tired, just do:
+```ruby
+@frog_cage.drop # => "DROP TABLE IF EXISTS public.abra_cadabra;\n"
+```
+
+#### TODO: INSERT, DELETE
+
+### After some time of kissing different frogs...
+
+`Princess`: I don't want to kiss frogs!....
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/indiesoft/pgkingdom.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pgkingdom"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/pgkingdom.rb

@@ -0,0 +1,65 @@
+require "pgkingdom/version"
+require "pgkingdom/table"
+
+# Provides global namespace and methods.
+module PgKingdom
+  class << self
+    # Filters :todo, :unsupported, etc from {.data_types} and returns flattened.
+    # @return [Array<Symbol>] all supported data types
+    def available_data_types
+      @_available_data_types ||= data_types.select do |key, val|
+        ![:TODO, :DONT_USE_ARRAYS_EXPLICITLY, :NOT_SUPPORTED, []].include? val
+      end.map { |key, val| val }.flatten
+    end
+
+    # Returns a Hash of PostgreSQL data types.
+    # @return [Hash{String=>(Symbol|Array<Symbol>|Array<Array<Symbol>>)})] contains all available PostgreSQL data types
+    # @see https://www.postgresql.org/docs/9.6/static/datatype.html
+    def data_types
+      @_data_types ||= {
+        arrays: [ :DONT_USE_ARRAYS_EXPLICITLY ], # Included as option :array => true into primitive types
+        uuid: [ :uuid ], # REQUIRES: CREATE EXTENSION "uuid-ossp";
+        binary: [ :bytea ],
+        boolean: [ :boolean ],
+        monetary: [ :money ],
+        bit_string: [ :bit_verying, :bit ],
+        network_address: [ :cidr, :inet, :macaddr ],
+        numeric: [
+          [:smallint, :integer, :bigint], #integer
+          [:decimal, :numeric, :real, :double_precision], # floating point
+          [:smallserial, :serial, :bigserial] # serials
+        ],
+        character: [
+          [:varchar, :character_varying],
+          [:char, :character],
+          [:text]
+        ],
+        datetime: [
+          [:timestamp, :timestamp_without_tz, :timestamp_with_tz],
+          [:date],
+          [:time, :time_without_tz, :time_with_tz],
+          [:interval]
+        ],
+        range: [
+          [:int4range, :int8range, :numrange],
+          [:tsrange, :tstzrange, :daterange]
+        ],
+        enumerated: [
+          :TODO
+        ],
+        text_search: [
+          :TODO
+        ],
+        json: [
+          :TODO
+        ],
+        oid: [ :NOT_SUPPORTED ],
+        xml: [ :NOT_SUPPORTED ],
+        pg_lsn: [ :NOT_SUPPORTED ],
+        pseudo: [ :NOT_SUPPORTED ],
+        geometric: [ :NOT_SUPPORTED ],
+        composite: [ :NOT_SUPPORTED ],
+      }
+    end
+  end
+end

data/lib/pgkingdom/columns_helper.rb

@@ -0,0 +1,36 @@
+require 'pgkingdom/options_helper'
+
+module PgKingdom
+  # Internally used to extend Arrays of columns in tables.
+  module ColumnsHelper
+    # Joins columns for a statement.
+    # @return [String] columns definition with options.
+    def join
+      map do |col|
+        opt_string = ""
+
+        # Flags
+        options = col[:options]
+        options.extend OptionsHelper
+
+        "#{col[:name]} #{col[:type].upcase}#{options.join}"
+      end.join(",\n\s\s")
+    end
+
+    # Checks if provided type is valid PostgreSQL data type.
+    def available?(type)
+      PgKingdom.available_data_types.include? type
+    end
+
+    # Adds column definition hash to array.
+    # @return [Array<Hash{Symbol=>(Numeric|Symbol|String|Hash)}>] Array with Hashes describing table columns.
+    def add(name, type, opts)
+      self << { :name => name, :type => type, :options => opts }
+    end
+
+    # Checks if column defined in table.
+    def defined?(name)
+      select { |a| a[:name] == name }.any?
+    end
+  end
+end

data/lib/pgkingdom/options_helper.rb

@@ -0,0 +1,35 @@
+module PgKingdom
+  # Internally used to extend Arrays of column options in tables.
+  module OptionsHelper
+    # Joins options for a column.
+    # @return [String] column options.
+    def join
+      options = clone
+      numerics = []
+      result = options.map do |option|
+        case option
+        when Numeric
+          numerics << option
+          nil
+        when Hash
+          option
+            .map { |opt, value| option_to_sql opt, value }
+            .join ' '
+        else
+          option_to_sql option
+        end
+      end
+
+      result.reject! { |opt| opt.nil? }
+      result = result.join(' ')
+      numerics.any? ? "(#{numerics.join(', ')}) #{result.lstrip}" : result
+    end
+
+    private
+
+    def option_to_sql(option, value=nil)
+      str = " #{option}".upcase.split('_').join(' ')
+      value.nil? ? str : str.lstrip + " #{value}"
+    end
+  end
+end

data/lib/pgkingdom/table.rb

@@ -0,0 +1,109 @@
+require "pgkingdom/columns_helper"
+
+module PgKingdom
+  # Class, which represents table in database. Contains information
+  # about table schema, name, columns (with types and options), constraints,
+  # primary and foreign keys. Also provides methods to generate {#create}({#create!}),
+  # {#drop}({#drop!}) SQL statements.
+  class Table
+    # Returns schema name.
+    # @return [String|Symbol]
+    attr_reader :schema
+
+    # Returns table name.
+    # @return [String|Symbol]
+    attr_reader :name
+
+    # Defines new Table with a given block.
+    # @raise [SyntaxError] when block was not given of block is empty.
+    # @return [Postruby::Table] table instance.
+    def initialize(name, &attr_block)
+      if attr_block.nil?
+        raise SyntaxError.new "Table columns should be given within a block."
+      end
+
+      if name.is_a? Array
+        @schema = name.first
+        @name = name.last
+      else
+        @schema = :public
+        @name = name
+      end
+
+      @columns = []
+      @columns.extend ColumnsHelper
+
+      instance_eval &attr_block
+
+      unless @columns.any?
+        raise SyntaxError.new "Given block should not be empty."
+      end
+    end
+
+    # Acts as DSL to define table columns.
+    # @raise [RuntimeError] when column type is not supported or column was redeclared for current table.
+    def method_missing(type, *opts)
+      unless @columns.available? type
+        raise "Unsupported column datatype #{type} for table #{@name}."
+      end
+
+      col_name = opts.shift
+      if @columns.defined? col_name
+        raise "Column #{col_name} with type #{type} has been redeclared for table #{@name}."
+      end
+
+      @columns.add col_name, type, opts
+    end
+
+    # Helper, which returns table path <schema>.<table_name>.
+    # @return [String] path including schema name and table name.
+    def table_path; "#{@schema}.#{@name}" end
+
+    # Generates SQL to create table in the database.
+    # When safe is true and table already exists it allows to
+    # skip this action.
+    # @return [String] SQL statement.
+    def create(safe=true)
+      allow_skip = safe ? " IF NOT EXISTS" : ""
+      <<~SQL
+      CREATE TABLE#{allow_skip} #{table_path} (
+        #{@columns.join}
+      );
+      SQL
+    end
+
+    # Generates SQL to drop table in the database.
+    # When safe is true and table doesn't exist it allows to skip this
+    # action.
+    # @return [String] SQL statement.
+    def drop(safe=true)
+      <<~SQL
+      DROP TABLE#{safe ? " IF EXISTS" : ""} #{table_path};
+      SQL
+    end
+
+    # Helper, which calls create with safe=false.
+    # @return [String] SQL statement.
+    def create!; create(false) end
+
+    # Helper, which calls drop with safe=false.
+    # @return [String] SQL statement.
+    def drop!; drop(false) end
+
+    # Helper, checks if column was defined in Table.
+    # @return [Boolean]
+    def column_defined?(name) @columns.defined? name end
+
+    # Generates SQL query to check if column exists in table.
+    # @return [String] SQL statement.
+    def column_exists?(name, type=nil)
+      # TODO: write pgSQL query
+    end
+
+    # Generates SQL to check if table exists in the database.
+    # @return [String] SQL statement.
+    def table_exists?
+      "SELECT to_regclass('#{table_path}') IS NOT NULL AS table_exists;"
+    end
+  end
+end

data/lib/pgkingdom/version.rb

@@ -0,0 +1,4 @@
+module PgKingdom
+  # Watch this, to have every story update in our SQL Kingdom.
+  VERSION = "0.1.0"
+end

data/pgkingdom.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pgkingdom/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pgkingdom"
+  spec.version       = PgKingdom::VERSION
+  spec.authors       = ["Nuqz"]
+  spec.email         = ["nuqz@indiesoft.ru"]
+
+  spec.summary       = %q{SQL statements generator for PostgreSQL >= 9.6 for Ruby >= 2.4.}
+  spec.description   = %q{A set of classes and micro-DSLs to generate SQL queries special for PostgreSQL backends.}
+  spec.homepage      = "https://github.com/indiesoft/postruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "yard", "~> 0.9", ">= 0.9.5"
+  spec.add_development_dependency "redcarpet", "~> 3.4"
+  spec.add_development_dependency "github-markup", "~> 1.4"
+  spec.add_development_dependency "simplecov", "~> 0.12"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its", "~> 1.2"
+  spec.add_development_dependency "pg", "~> 0.19"
+  spec.add_development_dependency "byebug", "9.0"
+end

metadata

@@ -0,0 +1,209 @@
+--- !ruby/object:Gem::Specification
+name: pgkingdom
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nuqz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: A set of classes and micro-DSLs to generate SQL queries special for PostgreSQL
+  backends.
+email:
+- nuqz@indiesoft.ru
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pgkingdom.rb
+- lib/pgkingdom/columns_helper.rb
+- lib/pgkingdom/options_helper.rb
+- lib/pgkingdom/table.rb
+- lib/pgkingdom/version.rb
+- pgkingdom.gemspec
+homepage: https://github.com/indiesoft/postruby
+licenses:
+- MIT
+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.6.8
+signing_key: 
+specification_version: 4
+summary: SQL statements generator for PostgreSQL >= 9.6 for Ruby >= 2.4.
+test_files: []