db_schema-definitions 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5602f6cb4adde5c72fc904806b89d00104307a11
+  data.tar.gz: b6e99dd29c5a3eea58c8fb780c408c0025d7ea62
+SHA512:
+  metadata.gz: eec9c2347e6af8edc27b1835db12332e055dcf57246e702fa70114dec64f7a23b3048ac900bf3f8bc12f45a789f06b2e9adffdf1243be0e964cff53084f88e67
+  data.tar.gz: 2b90e7080db55ecafa6c75cb47673ed518b88864d4676a1ba6a6f7484be9d06124e2594b27f108084acaa2c7dbdf7f7a05514978cced37a6d5caf83fd0fc126f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.8
+  - 2.3.5
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at 7@7vn.ru. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,15 @@
+guard :rspec, cmd: 'bundle exec rspec', all_on_start: true do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper)  { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+  watch('lib/db_schema/definitions/table.rb') { 'spec/db_schema/definitions/null_table_spec.rb' }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Vsevolod Romashov
+
+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,56 @@
+# DbSchema::Definitions
+
+This gem contains definition classes
+[describing database structure](https://github.com/db-schema/core/wiki/Schema-analysis-DSL)
+for [DbSchema](https://github.com/db-schema/core).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'db_schema-definitions'
+```
+
+And then execute:
+
+``` sh
+$ bundle
+```
+
+## Usage
+
+DbSchema::Definitions is not intended to be used separately;
+it's sole purpose is to provide definition classes for DbSchema
+and it's supporting libraries.
+
+## 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 [db-schema/definitions](https://github.com/db-schema/definitions).
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the
+[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of
+the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the DbSchema::Definitions project’s codebases,
+issue trackers, chat rooms and mailing lists is expected to follow
+the [code of conduct](https://github.com/db-schema/definitions/blob/master/CODE_OF_CONDUCT.md).

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,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'db_schema/definitions'
+
+require 'pry'
+require 'awesome_print'
+AwesomePrint.pry!
+
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/db_schema-definitions.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'db_schema/definitions/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'db_schema-definitions'
+  spec.version       = DbSchema::Definitions::VERSION
+  spec.authors       = ['Vsevolod Romashov']
+  spec.email         = ['7@7vn.ru']
+
+  spec.summary       = 'Database object definitions for DbSchema'
+  spec.homepage      = 'https://github.com/db-schema/definitions'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r(^spec/)) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r(^exe/)) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'dry-equalizer', '~> 0.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'awesome_print', '~> 1.7'
+
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'terminal-notifier'
+  spec.add_development_dependency 'terminal-notifier-guard'
+end

data/lib/db_schema/definitions.rb

@@ -0,0 +1,11 @@
+require 'dry/equalizer'
+
+require_relative 'definitions/schema'
+require_relative 'definitions/table'
+require_relative 'definitions/field'
+require_relative 'definitions/index'
+require_relative 'definitions/foreign_key'
+require_relative 'definitions/check_constraint'
+require_relative 'definitions/enum'
+require_relative 'definitions/extension'
+require_relative 'definitions/version'

data/lib/db_schema/definitions/check_constraint.rb

@@ -0,0 +1,17 @@
+module DbSchema
+  module Definitions
+    class CheckConstraint
+      include Dry::Equalizer(:name, :condition)
+      attr_reader :name, :condition
+
+      def initialize(name:, condition:)
+        @name      = name.to_sym
+        @condition = condition
+      end
+    end
+
+    class NullCheckConstraint < CheckConstraint
+      def initialize; end
+    end
+  end
+end

data/lib/db_schema/definitions/enum.rb

@@ -0,0 +1,23 @@
+module DbSchema
+  module Definitions
+    class Enum
+      include Dry::Equalizer(:name, :values)
+      attr_reader :name, :values
+
+      def initialize(name, values)
+        @name   = name
+        @values = values
+      end
+
+      def with_name(new_name)
+        Enum.new(new_name, values)
+      end
+    end
+
+    class NullEnum < Enum
+      def initialize
+        @values = []
+      end
+    end
+  end
+end

data/lib/db_schema/definitions/extension.rb

@@ -0,0 +1,12 @@
+module DbSchema
+  module Definitions
+    class Extension
+      include Dry::Equalizer(:name)
+      attr_reader :name
+
+      def initialize(name)
+        @name = name
+      end
+    end
+  end
+end

data/lib/db_schema/definitions/field.rb

@@ -0,0 +1,47 @@
+module DbSchema
+  module Definitions
+    module Field
+      class << self
+        def build(name, type, **options)
+          type_class_for(type).new(name, **options)
+        end
+
+        def type_class_for(type)
+          registry.fetch(type) do |type|
+            Custom.class_for(type)
+          end
+        end
+
+        def registry
+          @registry ||= {}
+        end
+      end
+    end
+  end
+end
+
+require_relative 'field/base'
+require_relative 'field/numeric'
+require_relative 'field/monetary'
+require_relative 'field/character'
+require_relative 'field/binary'
+require_relative 'field/datetime'
+require_relative 'field/boolean'
+require_relative 'field/geometric'
+require_relative 'field/network'
+require_relative 'field/bit_string'
+require_relative 'field/text_search'
+require_relative 'field/uuid'
+require_relative 'field/json'
+require_relative 'field/array'
+require_relative 'field/range'
+
+require_relative 'field/extensions/chkpass'
+require_relative 'field/extensions/citext'
+require_relative 'field/extensions/cube'
+require_relative 'field/extensions/hstore'
+require_relative 'field/extensions/isn'
+require_relative 'field/extensions/ltree'
+require_relative 'field/extensions/seg'
+
+require_relative 'field/custom'

data/lib/db_schema/definitions/field/array.rb

@@ -0,0 +1,30 @@
+module DbSchema
+  module Definitions
+    module Field
+      class Array < Base
+        register :array
+
+        def initialize(name, **options)
+          type_class = Field.type_class_for(options[:element_type])
+          super(name, **options.merge(element_type: type_class))
+        end
+
+        def attributes
+          super.merge(element_type: element_type.type)
+        end
+
+        def array?
+          true
+        end
+
+        def element_type
+          @attributes[:element_type]
+        end
+
+        def custom_element_type?
+          element_type.superclass == Custom
+        end
+      end
+    end
+  end
+end

data/lib/db_schema/definitions/field/base.rb

@@ -0,0 +1,104 @@
+module DbSchema
+  module Definitions
+    module Field
+      class Base
+        include Dry::Equalizer(:name, :type, :primary_key?, :options)
+        attr_reader :name, :default
+
+        def initialize(name, primary_key: false, null: true, default: nil, **attributes)
+          @name        = name
+          @primary_key = primary_key
+          @null        = null
+          @default     = default
+          @attributes  = attributes
+        end
+
+        def primary_key?
+          @primary_key
+        end
+
+        def null?
+          !primary_key? && @null
+        end
+
+        def default_is_expression?
+          default.is_a?(Symbol)
+        end
+
+        def array?
+          false
+        end
+
+        def custom?
+          false
+        end
+
+        def options
+          attributes.tap do |options|
+            options[:null] = false unless null?
+            options[:default] = default unless default.nil?
+          end
+        end
+
+        def attributes
+          self.class.valid_attributes.reduce({}) do |hash, attr_name|
+            if attr_value = @attributes[attr_name]
+              hash.merge(attr_name => attr_value)
+            elsif default_value = self.class.default_attribute_values[attr_name]
+              hash.merge(attr_name => default_value)
+            else
+              hash
+            end
+          end
+        end
+
+        def type
+          self.class.type
+        end
+
+        def with_type(new_type)
+          Field.build(name, new_type, **options, primary_key: primary_key?)
+        end
+
+        def with_attribute(attr_name, attr_value)
+          Field.build(name, type, **options, primary_key: primary_key?, attr_name => attr_value)
+        end
+
+        class << self
+          def register(*types)
+            types.each do |type|
+              Field.registry[type] = self
+            end
+          end
+
+          def attributes(*attr_names, **attributes_with_defaults)
+            valid_attributes.push(*attr_names)
+
+            attributes_with_defaults.each do |attr_name, default_value|
+              valid_attributes.push(attr_name)
+              default_attribute_values[attr_name] = default_value
+            end
+          end
+
+          def valid_attributes
+            @valid_attributes ||= []
+          end
+
+          def default_attribute_values
+            @default_attribute_values ||= {}
+          end
+
+          def type
+            Field.registry.key(self)
+          end
+        end
+      end
+    end
+
+    class NullField < Field::Base
+      def initialize
+        super(nil)
+      end
+    end
+  end
+end