sdl 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6e61a1d5604a66b42b6fb6c1d9ef23cafe16f82
-  data.tar.gz: 9c0aed1be31e2fd105bdf4797aae965a2470c9cf
+  metadata.gz: 293494599d3e932dc85f8057791b79341dcdd0fd
+  data.tar.gz: 88bda3e50d8d5ddd4bc1f64785ce41a7cd11f725
 SHA512:
-  metadata.gz: c507bebf2605c7dd156219e5ec791660279daf1de15d05cdffcbe5ed2142888c62b657033d6c2b7015565a4824cf5d5282df8919f63169559e9d9d5965c7ddbc
-  data.tar.gz: 3f0982e9b1785c24a7a5f619bdaa7910f9559310a31008157a9043b2a4dce68172c21b01f4da11992e4022bbb3f711c9feac54ef4ad584cc8cf42bddc9e46375
+  metadata.gz: 2b1cfa3f72d1affce168674a9ac1ff081dd8bd69b2bd32ea2ddf510ad40863466a36611887348ac3c8839c7f6a48e1ef055432c55a370e3984f1392851cf84a7
+  data.tar.gz: fbab5b8bd7d1976f3ff2af5a55bd5918323afb82d9b230e516fd36b15dbed77e9d19432221156af0e48085d63209a042b7f3ce2b87d31a4acf7b4a90ddd5743f

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)
     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,10 +15,54 @@ module SDL
 
     # @api private
     def initialize(name, **options)
-      @name = name.to_s
+      @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]
@@ -73,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,37 +1,35 @@
-require "sdl/fields"
-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
 
-    # All of the fields that have been registered
-    # @return [Fields]
-    def fields
-      Fields.new(@fields)
-    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
@@ -49,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
     #
@@ -64,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
     #
@@ -79,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
@@ -102,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
@@ -134,5 +133,77 @@ module SDL
       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,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/schema.rb

@@ -37,7 +37,7 @@ module SDL
     def depsort!
       each_node = models.method(:each)
       each_child = lambda do |model, &block|
-        belongs_to = model.fields.belongs_to.map(&:model_name)
+        belongs_to = model.belongs_to_fields.map(&:model_name)
         children = models.select { |m| belongs_to.include?(m.name) }
         children.each(&block)
       end

data/lib/sdl/version.rb

@@ -1,3 +1,3 @@
 module SDL
-  VERSION = "0.1.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sdl
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Ray Zane
@@ -104,8 +104,8 @@ files:
 - lib/sdl/attribute.rb
 - lib/sdl/enum.rb
 - lib/sdl/field.rb
-- lib/sdl/fields.rb
 - lib/sdl/model.rb
+- lib/sdl/name.rb
 - lib/sdl/parser.rb
 - lib/sdl/schema.rb
 - lib/sdl/types.rb

data/lib/sdl/fields.rb

@@ -1,103 +0,0 @@
-require "sdl/types"
-require "sdl/field"
-require "sdl/attribute"
-require "sdl/enum"
-require "sdl/association"
-require "sdl/attachment"
-
-module SDL
-  # All fields of a {Model}
-  class Fields
-    include Enumerable
-
-    # @api private
-    def initialize(fields)
-      @fields = fields
-    end
-
-    # Get a field by index
-    # @param index [Integer]
-    # @return [Field,nil]
-    def [](index)
-      @fields[index]
-    end
-
-    # Iterate over all fields
-    # @yield [Field]
-    def each(&block)
-      @fields.each(&block)
-    end
-
-    # Get all instances of {Attribute}
-    # @return [Array<Attribute>]
-    def attributes
-      grep Attribute
-    end
-
-    # Get all instances of {Association}
-    # @return [Array<Association>]
-    def associations
-      grep Association
-    end
-
-    # Get all instances of {Attachment}
-    # @return [Array<Attachment>]
-    def attachments
-      grep Attachment
-    end
-
-    # @!method id
-    #   Get all instances of {Attribute} whose type is `:id`
-    #   @return [Array<Attribute>]
-    # @!method string
-    #   Get all instances of {Attribute} whose type is `:string`
-    #   @return [Array<Attribute>]
-    # @!method boolean
-    #   Get all instances of {Attribute} whose type is `:boolean`
-    #   @return [Array<Attribute>]
-    # @!method integer
-    #   Get all instances of {Attribute} whose type is `:integer`
-    #   @return [Array<Attribute>]
-    # @!method float
-    #   Get all instances of {Attribute} whose type is `:float`
-    #   @return [Array<Attribute>]
-    # @!method decimal
-    #   Get all instances of {Attribute} whose type is `:decimal`
-    #   @return [Array<Attribute>]
-    # @!method date
-    #   Get all instances of {Attribute} whose type is `:date`
-    #   @return [Array<Attribute>]
-    # @!method datetime
-    #   Get all instances of {Attribute} whose type is `:datetime`
-    #   @return [Array<Attribute>]
-    # @!method text
-    #   Get all instances of {Attribute} whose type is `:text`
-    #   @return [Array<Attribute>]
-    # @!method binary
-    #   Get all instances of {Attribute} whose type is `:binary`
-    #   @return [Array<Attribute>]
-    # @!method enum
-    #   Get all instances of {Enum}
-    #   @return [Array<Enum>]
-    # @!method belongs_to
-    #   Get all instances of {Association::BelongsTo}
-    #   @return [Array<Association::BelongsTo>]
-    # @!method has_one
-    #   Get all instances of {Association::HasOne}
-    #   @return [Array<Assocation::HasOne>]
-    # @!method has_many
-    #   Get all instances of {Association::HasMany}
-    #   @return [Array<Association::HasMany>]
-    # @!method has_one_attached
-    #   Indicates that this is an {Attachment::HasOne}
-    #   @return [Array<Attachment::HasOne>]
-    # @!method has_many_attached
-    #   Indicates that this is an {Attachment::HasMany}
-    #   @return [Array<Attachment::HasMany>]
-    TYPES.each do |meth|
-      define_method meth do
-        select { |field| field.type == meth }
-      end
-    end
-  end
-end