gorm 0.0.1

data/lib/gorm.rb

@@ -0,0 +1,30 @@
+require 'gorm/schema'
+
+module Gorm
+  
+  # Creates a Schema under the given package +path+ and makes it available to a
+  # block that can then define it using the Schema::SchemaDefinitionMethods.
+  # ==== Arguments
+  # * +path+ - A / separated path where the source files should be generated.
+  #   Do not include any file extension, they will be added automatically
+  #   depending on the target language.
+  # ==== Options
+  # * <tt>:namespace</tt> - If provided, all generated classes will be placed
+  #   inside this namespace.
+  def self.schema(path, opt={}, &block) # :yields: s
+    s = Schema.new path, opt
+    block.call s unless s.nil?
+    s.generate!
+    nil
+  end
+
+  def self.template_path(subpath) # :nodoc:
+    spec = Gem.loaded_specs['gorm']
+    prefix = if spec.nil?
+      File.expand_path File.join(File.dirname(__FILE__), '..')
+    else
+      spec.gem_dir
+    end
+    File.join prefix, 'templates', subpath
+  end
+end

data/lib/gorm/column.rb

@@ -0,0 +1,24 @@
+module Gorm
+  
+  # Represents a column in a Table.
+  class Column
+    
+    # The name of this column, both in the database and the ORM class.
+    attr_reader :name
+
+    # The type of this column. For example, <tt>:string</tt> or <tt>:integer</tt> or ...
+    attr_reader :type
+    
+    def initialize(name, type, opt={}) # :nodoc:
+      @name = name
+      @type = type
+      # TODO: process opts
+    end
+    
+    def <=>(other) # :nodoc:
+      @name <=> other.name
+    end
+    
+  end
+  
+end

data/lib/gorm/migration.rb

@@ -0,0 +1,48 @@
+module Gorm
+  
+  # A migration within a Schema
+  class Migration
+
+    # Defines the ordering of migrations.
+    attr_reader :index
+    
+    def initialize(schema, opt={}) # :nodoc:
+      @schema = schema
+      @index = opt[:index]
+    end
+    
+    # A special migration which is always the first in any schema.
+    # Introduces a meta table that is used to keep track of the current
+    # database schema version.
+    def self.new_meta(schema)
+      Migration.new schema, :index => 0
+    end
+    
+    # Generate a stub for the migration method.
+    # ==== Options
+    # * <tt>:qualify</tt> - Should the stub be qualified with a class name?
+    def method_stub(opt={})
+      prefix = opt[:qualify] ? "#{@schema.class_name}::" : ""
+      "bool #{prefix}applyMigration#{@index}()"
+    end
+
+    # Generate a call to the migration method.
+    def method_call
+      "applyMigration#{@index}()"
+    end
+
+    # An interface for defining a Migration.
+    module MigrationDefinitionMethods
+      # Creates a Table called +name+ and makes it available to a block that
+      # can then define it using the Table::TableDefinitionMethods.
+      def create_table(name, &block) # :yields: t
+        t = @schema.register_table name
+        block.call t unless block.nil?
+        nil
+      end
+    end
+        
+    include MigrationDefinitionMethods
+    
+  end
+end

data/lib/gorm/schema.rb

@@ -0,0 +1,70 @@
+require 'gorm/migration'
+require 'gorm/table'
+# $LOAD_PATH << File.join(File.dirname(__FILE__), '../../../cog/lib')
+require 'cog/mixins/uses_templates'
+
+module Gorm
+
+  # A collection of migrations which cumulatively defines a database schema.
+  class Schema
+    
+    include Cog::Mixins::UsesTemplates
+    
+    # Where to place the generated code.
+    attr_reader :output_path
+    
+    # Namespace to place generated class into.
+    attr_reader :namespace
+    
+    # The class name to use for the generated schema class.
+    attr_reader :class_name
+    
+    # List of migrations ordered as there were defined.
+    attr_reader :migrations
+    
+    # The include guard name to use in the header file.
+    attr_reader :include_guard_name
+    
+    def initialize(path, opt={}) # :nodoc:
+      @output_path = path.to_s
+      @include_guard_name = @output_path.gsub(/[^A-Za-z0-9]/, '_').upcase
+      @namespace = opt[:namespace]
+      @class_name = @output_path.split('/').last
+      @migrations = [Migration.new_meta self]
+      @tables = {}
+    end
+    
+    # Register or retrieve a registered model
+    def register_table(name)
+      @tables[name] = @tables[name] || Table.new(self, name)
+    end
+        
+    # Generate the ORM source code
+    def generate!
+      [:cpp, :h].each do |ext|
+        stamp Gorm::template_path("schema.#{ext}"),
+          :use_absolute_path => true,
+          :target => "#{@output_path}.#{ext}"
+      end
+    end
+    
+    # Index of the last migration
+    def app_schema_version
+      @migrations.last.index
+    end
+    
+    # An interface for defining a Schema
+    module SchemaDefinitionMethods
+      # Adds a new Migration to this schema and makes it available to a block
+      # that can then define it using the Migration::MigrationDefinitionMethods.
+      def migration(&block)
+        @migrations << Migration.new(self, :index => @migrations.last.index + 1)
+        block.call @migrations.last unless block.nil?
+        nil
+      end
+    end
+
+    include SchemaDefinitionMethods
+    
+  end
+end

data/lib/gorm/table.rb

@@ -0,0 +1,58 @@
+require 'gorm/column'
+require 'active_support/core_ext'
+
+module Gorm
+  
+  # Represents a table in a Schema.
+  class Table
+    
+    # The name of the table in the database
+    attr_reader :table_name
+    
+    # The name of the ORM class for this table
+    attr_reader :class_name
+        
+    def initialize(schema, name) # :nodoc:
+      @schema = schema
+      @table_name = name.to_s.pluralize.dasherize
+      @class_name = name.to_s.singularize.camelize
+      @columns = {}
+    end
+    
+    # A sorted list of columns in the table
+    def columns
+      @columns.values.sort
+    end
+
+    # An interface for defining a Table
+    module TableDefinitionMethods
+      # Define a Column in this table.
+      # ==== Arguments
+      # * +name+ - The name of the field. Use lowercase.
+      # * +type+ - One of <tt>:string</tt>, <tt>:text</tt>, <tt>:integer</tt>
+      # ==== Options
+      # * <tt>:limit</tt> - A maximum size when using <tt>:string</tt> type.
+      def column(name, type, opt={})
+        col = @columns[name] || Column.new(name, type, opt)
+      end
+
+      # Shortcut for a call to #column with +type+ set to <tt>:integer</tt>.
+      def integer(name, opt={})
+        column name, :integer, opt
+      end
+
+      # Shortcut for a call to #column with +type+ set to <tt>:string</tt>.
+      def string(name, opt={})
+        column name, :string, opt
+      end
+
+      # Shortcut for a call to #column with +type+ set to <tt>:text</tt>.
+      def text(name, opt={})
+        column name, :text, opt
+      end
+    end
+    
+    include TableDefinitionMethods
+    
+  end
+end

data/lib/gorm_version.rb

@@ -0,0 +1,3 @@
+module Gorm
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification 
+name: gorm
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kevin Tonon
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-27 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: 
+email: kevin@betweenconcepts.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/gorm/column.rb
+- lib/gorm/migration.rb
+- lib/gorm/schema.rb
+- lib/gorm/table.rb
+- lib/gorm.rb
+- lib/gorm_version.rb
+homepage: https://github.com/ktonon/gorm
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --title
+- gorm
+- -ri
+require_paths: 
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A code-Generating Object Relational Mapper.
+test_files: []
+