sdl 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 439056885825969f584e56567236de2cda2e665b
+  data.tar.gz: dd4d702e74641a85dbbfb5819e89275bbd50c5bc
+SHA512:
+  metadata.gz: bb929bd4fd891001eb5c37ba99ae9429f803488c4fca67791eafaf00c44af41d687675ea6475e9bb2554d0fa39b91f9f2cb30eb42c754700cd0067a77b9b85a2
+  data.tar.gz: 3551c896ee004cb6e07ed52b5cf488c1222d2fca8c00438bf030ac4af02f85bf84cf345de9950977610a5f87737942b7f0759140fa08359c34e427774e521cd3

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.2

data/.yardopts

@@ -0,0 +1,6 @@
+--output-dir=doc/api
+--embed-mixins
+--protected
+--no-private
+--markup-provider=redcarpet
+--markup=markdown

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 raymondzane@gmail.com. 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 sdl.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ray Zane
+
+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,80 @@
+# SDL
+
+SDL is generic schema definition language.
+
+Alone, it doesn't do anything useful. However, you might find it to be helpful
+for the purpose of code generation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sdl'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sdl
+
+## Examples
+
+### Define a schema
+
+```ruby
+SDL.define do
+  model :user do
+    attribute :email, :string, required: true, unique: true
+    has_many :posts
+    timestamps
+  end
+
+  model :post do
+    attribute :title, :string, limit: 120, required: true
+    attribute :body, :text
+    enum :status, values: [:draft, :published]
+    belongs_to :user, foreign_key: true
+    has_one_attached :image
+    timestamps
+  end
+end
+```
+
+### Load a schema from a file
+
+```ruby
+SDL.load_file "schema.rb"
+```
+
+### Parse command-line arguments
+
+```ruby
+SDL.parse "user", %w[
+  email:required:unique
+  posts:has_many
+]
+
+SDL.parse "post", %w[
+  title:string{120}:required
+  body:text
+  status:enum{draft,published}
+  user:belongs_to:foreign_key
+  image:has_one_attached
+]
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rzane/sdl. 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 SDL project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rzane/sdl/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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sdl"
+
+# 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(__FILE__)

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/sdl.rb

@@ -0,0 +1,57 @@
+require "sdl/version"
+require "sdl/parser"
+require "sdl/schema"
+
+module SDL
+
+  # A base class for all errors
+  class Error < StandardError
+  end
+
+  # Raised when the parser encounters an unrecognized directive
+  class ParseError < Error
+  end
+
+  # Raised when models can't be sorted by their dependencies
+  class CircularDependencyError < Error
+  end
+
+  # Defines a new schema. The block will be evaluated in the
+  # context of a {Schema}
+  # @return [Schema]
+  #
+  # @example
+  #   SDL.define do
+  #     model :user do
+  #       attribute :name, :string
+  #     end
+  #   end
+  def self.define(&block)
+    Schema.new(&block)
+  end
+
+  # Loads a schema from a file. The contents of the file
+  # will be evaluated in the context of a {Schema}
+  # @return [Schema]
+  #
+  # @example
+  #   SDL.load_file("schema.rb")
+  def self.load_file(file)
+    schema = Schema.new
+    schema.instance_eval(File.read(file), file)
+    schema
+  end
+
+  # Constructs a model from command-line arguments
+  # @raise [ParseError]
+  # @return [Model]
+  # @see Parser
+  #
+  # @example
+  #   SDL.parse("user", ["name", "email:required:unique"])
+  def self.parse(name, fields)
+    parser = Parser.new
+    fields = fields.map { |field| parser.parse(field) }
+    Model.new(name, fields: fields)
+  end
+end

data/lib/sdl/association.rb

@@ -0,0 +1,65 @@
+require "sdl/field"
+require "active_support/inflector/methods"
+
+module SDL
+  # Base class for all association types
+  # @abstract
+  class Association < Field
+    # The name of the associated model
+    # @return [Name]
+    def model_name
+      Name.new(options.fetch(:model_name, name).to_s)
+    end
+  end
+
+  # Indicates a one-to-one connection with another {Model}
+  class Association::HasOne < Association
+    # The type of field
+    # @return [Symbol]
+    def type
+      :has_one
+    end
+  end
+
+  # Indicates a one-to-many connection with another {Model}
+  class Association::HasMany < Association
+    # The type of field
+    # @return [Symbol]
+    def type
+      :has_many
+    end
+
+    # The name of the associated model
+    # @return [Name]
+    def model_name
+      model_name = options.fetch(:model_name) do
+        ActiveSupport::Inflector.singularize(name.to_s)
+      end
+
+      Name.new(model_name.to_s)
+    end
+  end
+
+  # Indicates a one-to-one connection with another {Model}
+  class Association::BelongsTo < Association
+    include Field::ColumnOptions
+
+    # The type of field
+    # @return [Symbol]
+    def type
+      :belongs_to
+    end
+
+    # Should this field have a foreign key?
+    # @return [Boolean]
+    def foreign_key?
+      options.fetch(:foreign_key, false)
+    end
+
+    # The name of the column
+    # @return [Name]
+    def column_name
+      Name.new("#{name}_id")
+    end
+  end
+end

data/lib/sdl/attachment.rb

@@ -0,0 +1,26 @@
+require "sdl/field"
+
+module SDL
+  # Base class for all attachment types
+  # @abstract
+  class Attachment < Field
+  end
+
+  # A file that is attached to a {Model}
+  class Attachment::HasOne < Attachment
+    # The type of field
+    # @return [Symbol]
+    def type
+      :has_one_attached
+    end
+  end
+
+  # A list of files that are attached to a {Model}
+  class Attachment::HasMany < Attachment
+    # The type of field
+    # @return [Symbol]
+    def type
+      :has_many_attached
+    end
+  end
+end

data/lib/sdl/attribute.rb

@@ -0,0 +1,24 @@
+require "sdl/field"
+
+module SDL
+  # An attribute of a {Model}
+  class Attribute < Field
+    include Field::ColumnOptions
+
+    # The type of field
+    # @return [Symbol]
+    attr_reader :type
+
+    # @api private
+    def initialize(name, type, **options)
+      super(name, options)
+      @type = type
+    end
+
+    # The name of the column
+    # @return [Name]
+    def column_name
+      name
+    end
+  end
+end

data/lib/sdl/enum.rb

@@ -0,0 +1,33 @@
+require "sdl/field"
+require "sdl/name"
+
+module SDL
+  # A field of a {Model} that has a predefined list of possible values
+  class Enum < Field
+    include Field::ColumnOptions
+
+    # The type of field
+    # @return [Symbol]
+    def type
+      :enum
+    end
+
+    # A default value for this field
+    # @return [Name]
+    def default
+      Name.new(options[:default].to_s) if options[:default]
+    end
+
+    # The possible values for the enum
+    # @return [Array<String>]
+    def values
+      options.fetch(:values, []).map(&:to_s)
+    end
+
+    # The name of the column
+    # @return [Name]
+    def column_name
+      name
+    end
+  end
+end

data/lib/sdl/field.rb

@@ -0,0 +1,158 @@
+require "sdl/name"
+require "sdl/types"
+
+module SDL
+  # A base class for all fields of a model
+  # @abstract
+  class Field
+    # The name of the field
+    # @return [Name]
+    attr_reader :name
+
+    # All options that were passed to the field
+    # @return [Hash]
+    attr_reader :options
+
+    # @api private
+    def initialize(name, **options)
+      @name = Name.new(name.to_s)
+      @options = options
+    end
+
+    # Indicates that this is an {Attribute}
+    # @return [Boolean]
+    def attribute?
+      !enum? && !association? && !attachment?
+    end
+
+    # Indicates that this is an {Attachment}
+    # @return [Boolean]
+    def attachment?
+      has_one_attached? || has_many_attached?
+    end
+
+    # Indicates that this is an {Association}
+    # @return [Boolean]
+    def association?
+      has_one? || has_many? || belongs_to?
+    end
+
+    # Can this field be null? By default, this is `false`. But, it can
+    # be overridden by passing `nullable: true` to a field.
+    # @return [Boolean]
+    def nullable?
+      options.fetch(:nullable, false)
+    end
+
+    # The opposite of {#nullable?}. All fields are required by default
+    # @return [Boolean]
+    def required?
+      !nullable?
+    end
+
+    # The type of the field
+    # @abstract
+    # @return [Symbol]
+    def type
+      raise NotImplementedError, __method__
+    end
+
+    # The name of the type
+    # @return [Name]
+    def type_name
+      Name.new(type.to_s)
+    end
+
+    # @!method id?
+    #   Indicates that this is an {Attribute} whose type is `:id`
+    #   @return [Boolean]
+    # @!method string?
+    #   Indicates that this is an {Attribute} whose type is `:string`
+    #   @return [Boolean]
+    # @!method boolean?
+    #   Indicates that this is an {Attribute} whose type is `:boolean`
+    #   @return [Boolean]
+    # @!method integer?
+    #   Indicates that this is an {Attribute} whose type is `:integer`
+    #   @return [Boolean]
+    # @!method float?
+    #   Indicates that this is an {Attribute} whose type is `:float`
+    #   @return [Boolean]
+    # @!method decimal?
+    #   Indicates that this is an {Attribute} whose type is `:decimal`
+    #   @return [Boolean]
+    # @!method date?
+    #   Indicates that this is an {Attribute} whose type is `:date`
+    #   @return [Boolean]
+    # @!method datetime?
+    #   Indicates that this is an {Attribute} whose type is `:datetime`
+    #   @return [Boolean]
+    # @!method text?
+    #   Indicates that this is an {Attribute} whose type is `:text`
+    #   @return [Boolean]
+    # @!method binary?
+    #   Indicates that this is an {Attribute} whose type is `:binary`
+    #   @return [Boolean]
+    # @!method enum?
+    #   Indicates that this is an {Enum}
+    #   @return [Boolean]
+    # @!method belongs_to?
+    #   Indicates that this is an {Association::BelongsTo}
+    #   @return [Boolean]
+    # @!method has_one?
+    #   Indicates that this is an {Association::HasOne}
+    #   @return [Boolean]
+    # @!method has_many?
+    #   Indicates that this is an {Association::HasMany}
+    #   @return [Boolean]
+    # @!method has_one_attached?
+    #   Indicates that this is an {Attachment::HasOne}
+    #   @return [Boolean]
+    # @!method has_many_attached?
+    #   Indicates that this is an {Attachment::HasMany}
+    #   @return [Boolean]
+    TYPES.each do |meth|
+      define_method "#{meth}?" do
+        type == meth
+      end
+    end
+
+    module ColumnOptions
+      # A default value for this field
+      # @return [Object]
+      def default
+        options[:default]
+      end
+
+      # A limit for the field
+      # @return [Integer]
+      def limit
+        options[:limit]
+      end
+
+      # A precision for the field
+      # @return [Integer]
+      def precision
+        options[:precision]
+      end
+
+      # A scale for the field
+      # @return [Integer]
+      def scale
+        options[:scale]
+      end
+
+      # Is this field unique?
+      # @return [Boolean]
+      def unique?
+        options.fetch(:unique, false)
+      end
+
+      # Should this field have an index?
+      # @return [Boolean]
+      def index?
+        options.fetch(:index, false)
+      end
+    end
+  end
+end

data/lib/sdl/model.rb

@@ -0,0 +1,209 @@
+require "sdl/association"
+require "sdl/attachment"
+require "sdl/attribute"
+require "sdl/enum"
+require "sdl/name"
+
+module SDL
+  class Model
+    # Name of the model
+    # @return [Name]
+    attr_reader :name
+
+    # All of the fields that have been registered
+    # @return [Array<Field>]
+    attr_reader :fields
+
+    # Any additional options
+    # @return [Hash]
+    attr_reader :options
+
+    # @api private
+    def initialize(name, fields: [], **options, &block)
+      @name = Name.new(name.to_s)
+      @fields = fields
+      @options = options
+      instance_eval(&block) if block_given?
+    end
+
+    # Adds an {Attribute} to the model
+    # @param name [Symbol]
+    # @param type [Symbol]
+    # @option options [Boolean] :nullable
+    # @option options [Boolean] :unique
+    # @option options [Object] :default
+    # @option options [Integer] :limit
+    # @option options [Integer] :precision
+    # @option options [Integer] :scale
+    #
+    # @example
+    #   model :user do
+    #     attribute :name, :string, required: true
+    #   end
+    def attribute(name, type, **options)
+      @fields << Attribute.new(*name, type, **options)
+    end
+
+    # Adds an {Enum} to the model
+    # @param name [Symbol]
+    # @option options [Array<Symbol>] :values
+    # @option options [Boolean] :nullable
+    # @option options [Boolean] :unique
+    # @option options [Object] :default
+    #
+    # @example
+    #   model :user do
+    #     enum :status, values: [:accepted, :rejected], required: true
+    #   end
+    def enum(name, **options)
+      @fields << Enum.new(name, **options)
+    end
+
+    # Adds an {Association::BelongsTo} to the model
+    # @param name [Symbol]
+    # @option options [Symbol] :model_name
+    # @option options [Boolean] :nullable
+    # @option options [Boolean] :unique
+    # @option options [Boolean] :foreign_key
+    #
+    # @example
+    #   model :user do
+    #     belongs_to :organization, required: true
+    #   end
+    def belongs_to(name, **options)
+      @fields << Association::BelongsTo.new(name, **options)
+    end
+
+    # Adds an {Association::HasOne} to the model
+    # @param name [Symbol]
+    # @option options [Symbol] :model_name
+    # @option options [Boolean] :nullable
+    #
+    # @example
+    #   model :user do
+    #     has_one :profile
+    #   end
+    def has_one(name, **options)
+      @fields << Association::HasOne.new(name, **options)
+    end
+
+    # Adds an {Association::HasMany} to the model
+    # @param name [Symbol]
+    # @option options [Symbol] :model_name
+    #
+    # @example
+    #   model :user do
+    #     has_many :devices
+    #   end
+    def has_many(name, **options)
+      @fields << Association::HasMany.new(name, **options)
+    end
+
+    # Adds an {Attachment::HasOne} to the model
+    # @param name [Symbol]
+    # @option options [Symbol] :nullable
+    #
+    # @example
+    #   model :user do
+    #     has_one_attached :avatar
+    #   end
+    def has_one_attached(name, **options)
+      @fields << Attachment::HasOne.new(name, **options)
+    end
+
+    # Adds an {Attachment::HasMany} to the model
+    # @param name [Symbol]
+    # @param options [Hash]
+    #
+    # @example
+    #   model :product do
+    #     has_many_attached :images
+    #   end
+    def has_many_attached(name, **options)
+      @fields << Attachment::HasMany.new(name, **options)
+    end
+
+    # Adds attributes for +:created_at+ and +:updated_at+ to the model
+    #
+    # @example
+    #   model :user do
+    #     timestamps
+    #   end
+    def timestamps
+      attribute :created_at, :datetime, required: true
+      attribute :updated_at, :datetime, required: true
+    end
+
+    # Get all {Attribute} fields
+    # @return [Array<Attribute>]
+    def attribute_fields
+      fields.grep Attribute
+    end
+
+    # Get all {Association} fields
+    # @return [Array<Association>]
+    def association_fields
+      fields.grep Association
+    end
+
+    # Get all {Attachment} fields
+    # @return [Array<Attachment>]
+    def attachment_fields
+      fields.grep Attachment
+    end
+
+    # @!method id_fields
+    #   Get all {Attribute} fields whose type is `:id`
+    #   @return [Array<Attribute>]
+    # @!method string_fields
+    #   Get all {Attribute} fields whose type is `:string`
+    #   @return [Array<Attribute>]
+    # @!method boolean_fields
+    #   Get all {Attribute} fields whose type is `:boolean`
+    #   @return [Array<Attribute>]
+    # @!method integer_fields
+    #   Get all {Attribute} fields whose type is `:integer`
+    #   @return [Array<Attribute>]
+    # @!method float_fields
+    #   Get all {Attribute} fields whose type is `:float`
+    #   @return [Array<Attribute>]
+    # @!method decimal_fields
+    #   Get all {Attribute} fields whose type is `:decimal`
+    #   @return [Array<Attribute>]
+    # @!method date_fields
+    #   Get all {Attribute} fields whose type is `:date`
+    #   @return [Array<Attribute>]
+    # @!method datetime_fields
+    #   Get all {Attribute} fields whose type is `:datetime`
+    #   @return [Array<Attribute>]
+    # @!method text_fields
+    #   Get all {Attribute} fields whose type is `:text`
+    #   @return [Array<Attribute>]
+    # @!method binary_fields
+    #   Get all {Attribute} fields whose type is `:binary`
+    #   @return [Array<Attribute>]
+    # @!method enum_fields
+    #   Get all {Enum} fields
+    #   @return [Array<Enum>]
+    # @!method belongs_to_fields
+    #   Get all {Association::BelongsTo} fields
+    #   @return [Array<Association::BelongsTo>]
+    # @!method has_one_fields
+    #   Get all {Association::HasOne} fields
+    #   @return [Array<Assocation::HasOne>]
+    # @!method has_many_fields
+    #   Get all {Association::HasMany} fields
+    #   @return [Array<Association::HasMany>]
+    # @!method has_one_attached_fields
+    #   Get all {Attachment::HasOne} fields
+    #   @return [Array<Attachment::HasOne>]
+    # @!method has_many_attached_fields
+    #   Get all {Attachment::HasMany} fields
+    #   @return [Array<Attachment::HasMany>]
+    TYPES.each do |meth|
+      define_method "#{meth}_fields" do
+        fields.select { |field| field.type == meth }
+      end
+    end
+  end
+end

data/lib/sdl/name.rb

@@ -0,0 +1,43 @@
+require "active_support/inflector/methods"
+
+module SDL
+  # An extension of a string that will format a name
+  # This is especially useful for code generation
+  class Name < String
+    # @api private
+    def self.inflect(name, transforms)
+      define_method(name) do
+        transforms.reduce(self) do |acc, arg|
+          case arg
+          when :upcase
+            acc.upcase
+          when :lower_camelize
+            ActiveSupport::Inflector.camelize(acc, false)
+          when :lower_humanize
+            ActiveSupport::Inflector.humanize(acc, capitalize: false)
+          else
+            ActiveSupport::Inflector.send(arg, acc)
+          end
+        end
+      end
+    end
+
+    inflect :table, %i[tableize]
+    inflect :snake, %i[underscore]
+    inflect :snakes, %i[underscore pluralize]
+    inflect :scream, %i[underscore upcase]
+    inflect :screams, %i[pluralize underscore upcase]
+    inflect :camel, %i[lower_camelize]
+    inflect :camels, %i[pluralize lower_camelize]
+    inflect :param, %i[dasherize]
+    inflect :params, %i[pluralize dasherize]
+    inflect :entity, %i[camelize]
+    inflect :entities, %i[pluralize camelize]
+    inflect :title, %i[titleize]
+    inflect :titles, %i[pluralize titleize]
+    inflect :label, %i[humanize]
+    inflect :labels, %i[pluralize humanize]
+    inflect :description, %i[lower_humanize]
+    inflect :descriptions, %i[pluralize lower_humanize]
+  end
+end

data/lib/sdl/parser.rb

@@ -0,0 +1,135 @@
+require "sdl/types"
+require "sdl/field"
+require "sdl/enum"
+require "sdl/attribute"
+require "sdl/association"
+require "sdl/attachment"
+require "active_support/inflector/methods"
+
+module SDL
+  # The parser takes a string and converts it to a {Field}.
+  # A field is described using a series of directives separated
+  # by a colon.
+  #
+  # Examples:
+  #
+  # * `title:string{120}:required`
+  # * `body:text`
+  # * `status:enum{draft,published}`
+  # * `user:belongs_to:foreign_key`
+  # * `image:has_one_attached`
+  #
+  # Available directives:
+  #
+  # * `id`
+  # * `string`
+  # * `string{limit}`
+  # * `boolean`
+  # * `integer`
+  # * `integer{limit}`
+  # * `float`
+  # * `decimal`
+  # * `decimal{precision,scale}`
+  # * `date`
+  # * `datetime`
+  # * `text`
+  # * `text{limit}`
+  # * `binary`
+  # * `binary{limit}`
+  # * `enum{value,...}`
+  # * `belongs_to`
+  # * `belongs_to{model}`
+  # * `has_one`
+  # * `has_one{model}`
+  # * `has_many`
+  # * `has_many{model}`
+  # * `has_one_attached`
+  # * `has_many_attached`
+  # * `unique`
+  # * `nullable`
+  # * `index`
+  # * `foreign_key`
+  # * `default{value}`
+  class Parser
+    # Parses a string into a {Field}
+    # @param value [String]
+    # @raise [ParseError] when a directive is not recognized
+    # @return [Field]
+    def parse(value)
+      name, *args = value.split(":")
+      name = name.to_sym
+
+      opts = {type: :string}
+      args.each { |arg| parse!(arg, opts) }
+      type = opts.delete(:type)
+
+      # Attempt to coerce the default
+      opts[:default] = coerce(opts[:default], type) if opts[:default]
+
+      if type.is_a?(Symbol)
+        Attribute.new(name, type, opts)
+      else
+        type.new(name, opts)
+      end
+    end
+
+    private
+
+    SEPARATOR = /[,.-]/
+    TYPES = /^(#{SCALAR_TYPES.join("|")})$/
+    TYPES_WITH_LIMIT = /^(string|text|binary|integer)\{(\d+)\}$/
+    TYPES_WITH_PRECISION = /^(decimal)\{(\d+)#{SEPARATOR}(\d+)\}$/
+
+    ENUM = /^enum\{(.*)\}$/
+    ATTACHMENT = /^(has_one|has_many)_attached$/
+    ASSOCIATION = /^(belongs_to|has_one|has_many)$/
+    ASSOCIATION_WITH_NAME = /^(belongs_to|has_one|has_many)\{(.*)\}$/
+
+    DEFAULT = /^default\{(.*)\}$/
+    MODIFIERS = %w[nullable unique index foreign_key]
+
+    def parse!(arg, opts)
+      case arg
+      when TYPES
+        opts[:type] = $1.to_sym
+      when TYPES_WITH_LIMIT
+        opts[:type] = $1.to_sym
+        opts[:limit] = $2.to_i
+      when TYPES_WITH_PRECISION
+        opts[:type] = $1.to_sym
+        opts[:precision] = $2.to_i
+        opts[:scale] = $3.to_i
+      when ENUM
+        opts[:type] = Enum
+        opts[:values] = $1.split(SEPARATOR)
+      when ASSOCIATION
+        opts[:type] = Association.const_get(camelize($1))
+      when ASSOCIATION_WITH_NAME
+        opts[:type] = Association.const_get(camelize($1))
+        opts[:model_name] = $2.to_sym
+      when ATTACHMENT
+        opts[:type] = Attachment.const_get(camelize($1))
+      when DEFAULT
+        opts[:default] = $1
+      when *MODIFIERS
+        opts[arg.to_sym] = true
+      else
+        raise ParseError, "Unrecognized parameter: #{arg}"
+      end
+    end
+
+    def camelize(value)
+      ActiveSupport::Inflector.camelize(value)
+    end
+
+    def coerce(value, type)
+      case type
+      when :integer then value.to_i
+      when :float then value.to_f
+      when :boolean then value.match?(/^true$/)
+      else
+        value
+      end
+    end
+  end
+end

data/lib/sdl/schema.rb

@@ -0,0 +1,51 @@
+require "tsort"
+require "sdl/model"
+
+module SDL
+  class Schema
+    # All models that have been defined
+    # @return [Array<Model>]
+    attr_reader :models
+
+    # @api private
+    def initialize(&block)
+      @models = []
+      instance_eval(&block) if block_given?
+    end
+
+    # Find a model by name
+    # @param name [Symbol,String] name of the model to find
+    # @return [Model,nil]
+    def find_model(name)
+      models.find { |m| m.name == name.to_s }
+    end
+
+    # Adds a new {Model} to the schema
+    # @param name [Symbol]
+    # @param options [Hash]
+    #
+    # @example
+    #   model :user do
+    #     attribute :name, :string
+    #   end
+    def model(name, **options, &block)
+      @models << Model.new(name, **options, &block)
+    end
+
+    # Sort all {Model} instances in order of dependency
+    # @raise [CircularDependencyError]
+    def depsort!
+      each_node = models.method(:each)
+      each_child = lambda do |model, &block|
+        belongs_to = model.belongs_to_fields.map(&:model_name)
+        children = models.select { |m| belongs_to.include?(m.name) }
+        children.each(&block)
+      end
+
+      @models = TSort.tsort(each_node, each_child)
+      @models
+    rescue TSort::Cyclic
+      raise CircularDependencyError, "The schema contains a circular dependency."
+    end
+  end
+end

data/lib/sdl/types.rb

@@ -0,0 +1,23 @@
+module SDL
+  SCALAR_TYPES = %i[
+    id
+    string
+    boolean
+    integer
+    float
+    decimal
+    date
+    datetime
+    text
+    binary
+  ]
+
+  TYPES = SCALAR_TYPES + %i[
+    enum
+    belongs_to
+    has_one
+    has_many
+    has_one_attached
+    has_many_attached
+  ]
+end

data/lib/sdl/version.rb

@@ -0,0 +1,3 @@
+module SDL
+  VERSION = "0.4.0"
+end

data/sdl.gemspec

@@ -0,0 +1,34 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sdl/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sdl"
+  spec.version       = SDL::VERSION
+  spec.authors       = ["Ray Zane"]
+  spec.email         = ["raymondzane@gmail.com"]
+
+  spec.summary       = %q{A generic schema definition language.}
+  spec.homepage      = "https://github.com/rzane/sdl"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/rzane/sdl"
+  spec.metadata["documentation_uri"] = "https://rubydoc.info/github/rzane/sdl"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", "~> 6.0"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.17.1"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: sdl
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Ray Zane
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+description: 
+email:
+- raymondzane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sdl.rb
+- lib/sdl/association.rb
+- lib/sdl/attachment.rb
+- lib/sdl/attribute.rb
+- lib/sdl/enum.rb
+- lib/sdl/field.rb
+- lib/sdl/model.rb
+- lib/sdl/name.rb
+- lib/sdl/parser.rb
+- lib/sdl/schema.rb
+- lib/sdl/types.rb
+- lib/sdl/version.rb
+- sdl.gemspec
+homepage: https://github.com/rzane/sdl
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rzane/sdl
+  source_code_uri: https://github.com/rzane/sdl
+  documentation_uri: https://rubydoc.info/github/rzane/sdl
+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.14
+signing_key: 
+specification_version: 4
+summary: A generic schema definition language.
+test_files: []