sdl 0.2.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 33252bd783b69ae9ac6fb9e579817a9392dcd3a7
-  data.tar.gz: aaf572106a7f32f494ea0e4d050e7e5894e70de8
+SHA256:
+  metadata.gz: c83558361e4cc4d117a79eeafb41bc88282ab58787bae3392b2a322c7f2725ee
+  data.tar.gz: d15a86beac0656606ebffd86a6b2e928f2218ce307ed576c381593f157b3f3e7
 SHA512:
-  metadata.gz: f4066429d325386c0c79b1b53443ae61f30530a81c87da81b1663ebf2fb4aacfd10132700c13791a0eba3573f1141916e36f588ae7073c41c7d127f5cb5804a7
-  data.tar.gz: 55bb962046a882e09bee9cb98eeb2ee3afb7c633a6148986f23d7671f638be91aa111b2b077b561b4486dd174b86137a8eb5d002911240e067fc8dc73284487f
+  metadata.gz: 607eb1f7253d0f6645d5076b7cfba2305a303ad11e35ee182fbcdea597609d9759bd4d7f673301f658b85e00baf5a31cf6923240fc48891a78c1076deb099a1f
+  data.tar.gz: 07b880a3864b82b939a96812ba670e691d2ea8964227839eb5632111cd7323675f3eac1f9349c310e4580145d901c56d225d608f7587b358629e56de1efd90c0

data/.github/workflows/build.yml

@@ -0,0 +1,22 @@
+name: Build
+on: [push]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7.x
+
+      - name: Install bundler
+        run: gem install bundler
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Test
+        run: bundle exec rspec

data/.github/workflows/publish.yml

@@ -0,0 +1,38 @@
+name: Publish
+on:
+  release:
+    types: [published]
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.7.x
+
+      - name: Install bundler
+        run: gem install bundler
+
+      - name: Install dependencies
+        run: bundle install
+
+      - name: Test
+        run: bundle exec rspec
+
+      - name: Set version
+        run: perl -pi -e "s/0\.0\.0/${GITHUB_REF:11}/" lib/sdl/version.rb
+
+      - name: Publish
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${RUBYGEMS_TOKEN}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          RUBYGEMS_TOKEN: ${{ secrets.RUBYGEMS_TOKEN }}

data/Gemfile

@@ -2,3 +2,5 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in sdl.gemspec
 gemspec
+
+gem "simplecov", require: false

data/README.md

@@ -1,9 +1,15 @@
-# SDL
+<h1 align="center">SDL</h1>
 
-SDL is generic schema definition language.
+<div align="center">
 
-Alone, it doesn't do anything useful. However, you might find it to be helpful
-for the purpose of code generation.
+![Build](https://github.com/rzane/sdl/workflows/Build/badge.svg)
+![Version](https://img.shields.io/gem/v/sdl)
+
+</div>
+
+SDL stands for *S*chema *D*efinition *L*anguage. It's a language for describing models in a system.
+
+Alone, it doesn't do a whole lot. However, you might find helpful for building [code generators](https://github.com/rzane/geny).
 
 ## Installation
 
@@ -28,15 +34,15 @@ Or install it yourself as:
 ```ruby
 SDL.define do
   model :user do
-    attribute :email, :string, required: true, unique: true
+    attribute :email, :string, 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]
+    attribute :title, :string, limit: 120
+    attribute :body, :text, nullable: true
+    enum :status, values: [:draft, :published], default: :draft
     belongs_to :user, foreign_key: true
     has_one_attached :image
     timestamps
@@ -46,6 +52,13 @@ end
 
 ### Load a schema from a file
 
+```ruby
+# schema.rb
+model :user do
+  attribute :name, :string
+end
+```
+
 ```ruby
 SDL.load_file "schema.rb"
 ```
@@ -54,13 +67,13 @@ SDL.load_file "schema.rb"
 
 ```ruby
 SDL.parse "user", %w[
-  email:required:unique
+  email:unique
   posts:has_many
 ]
 
 SDL.parse "post", %w[
-  title:string{120}:required
-  body:text
+  title:string{120}
+  body:text:nullable
   status:enum{draft,published}
   user:belongs_to:foreign_key
   image:has_one_attached

data/Rakefile

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

data/lib/sdl.rb

@@ -3,7 +3,6 @@ require "sdl/parser"
 require "sdl/schema"
 
 module SDL
-
   # A base class for all errors
   class Error < StandardError
   end

data/lib/sdl/association.rb

@@ -1,14 +1,14 @@
 require "sdl/field"
-require "active_support/core_ext/string/inflections"
+require "active_support/inflector"
 
 module SDL
   # Base class for all association types
   # @abstract
   class Association < Field
     # The name of the associated model
-    # @return [String]
+    # @return [Name]
     def model_name
-      options.fetch(:model_name, name).to_s
+      Name.new(options.fetch(:model_name, name).to_s)
     end
   end
 
@@ -30,9 +30,13 @@ module SDL
     end
 
     # The name of the associated model
-    # @return [String]
+    # @return [Name]
     def model_name
-      options.fetch(:model_name) { name.singularize }.to_s
+      model_name = options.fetch(:model_name) do
+        ActiveSupport::Inflector.singularize(name.to_s)
+      end
+
+      Name.new(model_name.to_s)
     end
   end
 
@@ -51,5 +55,11 @@ module SDL
     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/attribute.rb

@@ -11,8 +11,14 @@ module SDL
 
     # @api private
     def initialize(name, type, **options)
-      super(name, 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

@@ -1,4 +1,5 @@
 require "sdl/field"
+require "sdl/name"
 
 module SDL
   # A field of a {Model} that has a predefined list of possible values
@@ -12,15 +13,21 @@ module SDL
     end
 
     # A default value for this field
-    # @return [Object]
+    # @return [Name]
     def default
-      options[:default]&.to_s
+      Name.new(options[:default].to_s) if options[:default]
     end
 
     # The possible values for the enum
-    # @return [Array<String>]
+    # @return [Array<Name>]
     def values
-      options.fetch(:values, []).map(&:to_s)
+      options.fetch(:values, []).map { |value| Name.new(value.to_s) }
+    end
+
+    # The name of the column
+    # @return [Name]
+    def column_name
+      name
     end
   end
 end

data/lib/sdl/field.rb

@@ -1,3 +1,4 @@
+require "sdl/name"
 require "sdl/types"
 
 module SDL
@@ -5,7 +6,7 @@ module SDL
   # @abstract
   class Field
     # The name of the field
-    # @return [String]
+    # @return [Name]
     attr_reader :name
 
     # All options that were passed to the field
@@ -14,7 +15,7 @@ module SDL
 
     # @api private
     def initialize(name, **options)
-      @name = name.to_s
+      @name = Name.new(name.to_s)
       @options = options
     end
 
@@ -36,6 +37,32 @@ module SDL
       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]
@@ -91,12 +118,6 @@ module SDL
     end
 
     module ColumnOptions
-      # Is this field required?
-      # @return [Boolean]
-      def required?
-        options.fetch(:required, false)
-      end
-
       # A default value for this field
       # @return [Object]
       def default

data/lib/sdl/model.rb

@@ -1,34 +1,55 @@
-require "sdl/attribute"
-require "sdl/enum"
 require "sdl/association"
 require "sdl/attachment"
+require "sdl/attribute"
+require "sdl/enum"
+require "sdl/name"
 
 module SDL
   class Model
     # Name of the model
-    # @return [String]
+    # @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.to_s
+      @name = Name.new(name.to_s)
       @fields = fields
       @options = options
       instance_eval(&block) if block_given?
     end
 
+    # List or filter fields that have been registered
+    # @param types [Array<Symbol>] types to filter
+    # @return [Array<Field>]
+    # @example List all fields
+    #   model.fields.each { |field| puts field.name }
+    # @example Filter fields
+    #   model.fields(:integer).each { |field| puts field.name }
+    def fields(*types)
+      return @fields if types.empty?
+
+      types.flat_map { |type|
+        case type
+        when :attribute
+          @fields.grep Attribute
+        when :association
+          @fields.grep Association
+        when :attachment
+          @fields.grep Attachment
+        else
+          @fields.select { |field| field.type == type }
+        end
+      }
+    end
+
     # Adds an {Attribute} to the model
     # @param name [Symbol]
     # @param type [Symbol]
-    # @option options [Boolean] :required
+    # @option options [Boolean] :nullable
     # @option options [Boolean] :unique
     # @option options [Object] :default
     # @option options [Integer] :limit
@@ -46,7 +67,7 @@ module SDL
     # Adds an {Enum} to the model
     # @param name [Symbol]
     # @option options [Array<Symbol>] :values
-    # @option options [Boolean] :required
+    # @option options [Boolean] :nullable
     # @option options [Boolean] :unique
     # @option options [Object] :default
     #
@@ -61,7 +82,7 @@ module SDL
     # Adds an {Association::BelongsTo} to the model
     # @param name [Symbol]
     # @option options [Symbol] :model_name
-    # @option options [Boolean] :required
+    # @option options [Boolean] :nullable
     # @option options [Boolean] :unique
     # @option options [Boolean] :foreign_key
     #
@@ -76,6 +97,7 @@ module SDL
     # Adds an {Association::HasOne} to the model
     # @param name [Symbol]
     # @option options [Symbol] :model_name
+    # @option options [Boolean] :nullable
     #
     # @example
     #   model :user do
@@ -99,7 +121,7 @@ module SDL
 
     # Adds an {Attachment::HasOne} to the model
     # @param name [Symbol]
-    # @option options [Hash]
+    # @option options [Symbol] :nullable
     #
     # @example
     #   model :user do
@@ -133,75 +155,92 @@ module SDL
     end
 
     # Get all {Attribute} fields
+    # @deprecated Use {#fields} instead
     # @return [Array<Attribute>]
     def attribute_fields
-      fields.grep Attribute
+      fields(:attribute)
     end
 
     # Get all {Association} fields
+    # @deprecated Use {#fields} instead
     # @return [Array<Association>]
     def association_fields
-      fields.grep Association
+      fields(:association)
     end
 
     # Get all {Attachment} fields
+    # @deprecated Use {#fields} instead
     # @return [Array<Attachment>]
     def attachment_fields
-      fields.grep Attachment
+      fields(:attachment)
     end
 
     # @!method id_fields
     #   Get all {Attribute} fields whose type is `:id`
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Attribute>]
     # @!method string_fields
     #   Get all {Attribute} fields whose type is `:string`
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Attribute>]
     # @!method boolean_fields
     #   Get all {Attribute} fields whose type is `:boolean`
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Attribute>]
     # @!method integer_fields
     #   Get all {Attribute} fields whose type is `:integer`
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Attribute>]
     # @!method float_fields
     #   Get all {Attribute} fields whose type is `:float`
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Attribute>]
     # @!method decimal_fields
     #   Get all {Attribute} fields whose type is `:decimal`
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Attribute>]
     # @!method date_fields
     #   Get all {Attribute} fields whose type is `:date`
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Attribute>]
     # @!method datetime_fields
     #   Get all {Attribute} fields whose type is `:datetime`
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Attribute>]
     # @!method text_fields
     #   Get all {Attribute} fields whose type is `:text`
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Attribute>]
     # @!method binary_fields
     #   Get all {Attribute} fields whose type is `:binary`
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Attribute>]
     # @!method enum_fields
     #   Get all {Enum} fields
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Enum>]
     # @!method belongs_to_fields
     #   Get all {Association::BelongsTo} fields
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Association::BelongsTo>]
     # @!method has_one_fields
     #   Get all {Association::HasOne} fields
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Assocation::HasOne>]
     # @!method has_many_fields
     #   Get all {Association::HasMany} fields
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Association::HasMany>]
     # @!method has_one_attached_fields
     #   Get all {Attachment::HasOne} fields
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Attachment::HasOne>]
     # @!method has_many_attached_fields
     #   Get all {Attachment::HasMany} fields
+    #   @deprecated Use {#fields} instead
     #   @return [Array<Attachment::HasMany>]
-    TYPES.each do |meth|
-      define_method "#{meth}_fields" do
-        fields.select { |field| field.type == meth }
-      end
+    TYPES.each do |type|
+      define_method("#{type}_fields") { fields(type) }
     end
   end
 end

data/lib/sdl/name.rb

@@ -0,0 +1,48 @@
+require "active_support/inflector"
+
+module SDL
+  # An extension of a string that will format a name
+  class Name < String
+    class << self
+      private
+
+      # @!macro [attach] inflect
+      #   @return [String]
+      def 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
+    end
+
+    inflect :table, %i[tableize]
+    inflect :plural, %i[pluralize]
+    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

@@ -4,7 +4,7 @@ require "sdl/enum"
 require "sdl/attribute"
 require "sdl/association"
 require "sdl/attachment"
-require "active_support/core_ext/string/inflections"
+require "active_support/inflector"
 
 module SDL
   # The parser takes a string and converts it to a {Field}.
@@ -13,8 +13,8 @@ module SDL
   #
   # Examples:
   #
-  # * `title:string{120}:required`
-  # * `body:text`
+  # * `title:string{120}`
+  # * `body:text:nullable`
   # * `status:enum{draft,published}`
   # * `user:belongs_to:foreign_key`
   # * `image:has_one_attached`
@@ -46,7 +46,7 @@ module SDL
   # * `has_one_attached`
   # * `has_many_attached`
   # * `unique`
-  # * `required`
+  # * `nullable`
   # * `index`
   # * `foreign_key`
   # * `default{value}`
@@ -67,9 +67,9 @@ module SDL
       opts[:default] = coerce(opts[:default], type) if opts[:default]
 
       if type.is_a?(Symbol)
-        Attribute.new(name, type, opts)
+        Attribute.new(name, type, **opts)
       else
-        type.new(name, opts)
+        type.new(name, **opts)
       end
     end
 
@@ -86,7 +86,7 @@ module SDL
     ASSOCIATION_WITH_NAME = /^(belongs_to|has_one|has_many)\{(.*)\}$/
 
     DEFAULT = /^default\{(.*)\}$/
-    MODIFIERS = %w[required unique index foreign_key]
+    MODIFIERS = %w[nullable unique index foreign_key]
 
     def parse!(arg, opts)
       case arg
@@ -103,12 +103,12 @@ module SDL
         opts[:type] = Enum
         opts[:values] = $1.split(SEPARATOR)
       when ASSOCIATION
-        opts[:type] = Association.const_get($1.camelize)
+        opts[:type] = Association.const_get(camelize($1))
       when ASSOCIATION_WITH_NAME
-        opts[:type] = Association.const_get($1.camelize)
+        opts[:type] = Association.const_get(camelize($1))
         opts[:model_name] = $2.to_sym
       when ATTACHMENT
-        opts[:type] = Attachment.const_get($1.camelize)
+        opts[:type] = Attachment.const_get(camelize($1))
       when DEFAULT
         opts[:default] = $1
       when *MODIFIERS
@@ -118,6 +118,10 @@ module SDL
       end
     end
 
+    def camelize(value)
+      ActiveSupport::Inflector.camelize(value)
+    end
+
     def coerce(value, type)
       case type
       when :integer then value.to_i

data/lib/sdl/version.rb

@@ -1,3 +1,3 @@
 module SDL
-  VERSION = "0.2.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sdl
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Ray Zane
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-16 00:00:00.000000000 Z
+date: 2020-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -87,9 +87,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
+- ".github/workflows/publish.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -105,6 +106,7 @@ files:
 - 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
@@ -132,8 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A generic schema definition language.

data/.travis.yml

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