sdl 0.2.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3c0c72e2ceb5b542143447458c5428edf813ae3
-  data.tar.gz: 74287f31894980163d4f623578f72ded367dc480
+  metadata.gz: a883a3fe7f9d06a141c189ec28b1f67e6c523b37
+  data.tar.gz: c22ea329243286c14df082b7db23190c4d0223a9
 SHA512:
-  metadata.gz: 9fb06fcea7e7cb5c7eaa711d3c57269508257246afbb7e9eee6c73bfdfb1159c4d30bb3858ced2c50bd3f6fd0ecfbd2fb5d4016c0d9829cbdc28c3709c875b32
-  data.tar.gz: 83bec3ca9b3c0d44aaf4cd82b3fafb1425e18c04637463deb0645b476729570f9deee94d338a97a892023041fb0f30fffa738aef4e4cbcc911fb67546e206224
+  metadata.gz: 7ab655cb02458de96d51682ce9c529da31660f46679190b967a66017a36990e3c003d5ade0fe1bb03ffda435e3c3db67d18419479078ec4fab14924f535c6e91
+  data.tar.gz: 95fa9a930d1e683900bd236aca56f3aa299d6908651ac233144d3965e6efac594052878be0cf1ab28a5eb9391ae2b5d25cc34a89075094b3ed91f58325fc7eea

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

@@ -14,5 +14,11 @@ module SDL
       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
@@ -11,10 +12,22 @@ module SDL
       :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)
+      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,12 +1,13 @@
-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
@@ -19,7 +20,7 @@ module SDL
 
     # @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?
@@ -28,7 +29,7 @@ module SDL
     # 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 +47,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 +62,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 +77,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 +101,7 @@ module SDL
 
     # Adds an {Attachment::HasOne} to the model
     # @param name [Symbol]
-    # @option options [Hash]
+    # @option options [Symbol] :nullable
     #
     # @example
     #   model :user do

data/lib/sdl/name.rb

@@ -0,0 +1,44 @@
+require "active_support/inflector"
+
+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 :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}.
@@ -46,7 +46,7 @@ module SDL
   # * `has_one_attached`
   # * `has_many_attached`
   # * `unique`
-  # * `required`
+  # * `nullable`
   # * `index`
   # * `foreign_key`
   # * `default{value}`
@@ -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.0"
+  VERSION = "0.4.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sdl
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Ray Zane
@@ -105,6 +105,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