graph2relational 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffd5eda800a15b74f1843d5e5e32c9063d8b2646
-  data.tar.gz: a10dc8539499cb64bbcbd88355bfa2a064ce5970
+  metadata.gz: 4707cb31fae3fc71e5cfa92a2a98378c1637347d
+  data.tar.gz: 3ea233af867720ecc8a4e11a6213da93b8ec82e1
 SHA512:
-  metadata.gz: aa6904f22f311b822dad0cfa1575b155cf1b3e03b58a1316eea3f026e4f69a7fc34984f242044c8ed2ebbf75dee188181a82c0f03d97dbb973a18d6cfb2bb6ea
-  data.tar.gz: 656a7e830a82e14f0fece65483f6efe32b9c82ba8af15f225839c04037623784ba6e9a09b3455fdbd5a97ec98365116837aab9d1c63366c609ebed3acc1c2fb1
+  metadata.gz: 1451c83f93957bd2d5a14534cfdc3974f9c61ed4890688c6f653200cb2df5591fc9c0ef320193b57ca0453aed467cdaba0c8714d0c4a7d378fbd93b9df36b6c3
+  data.tar.gz: 101e107513aa533ff66bf4f130406883de8962016f106c054864ed5cb655fb660f24242bef7057bc4d9cf689d8d9a601402809c1f08d2b5ed202c597a0448c0c

data/lib/graph2relational.rb

@@ -15,8 +15,12 @@ require 'graph2relational/neo4j-database'
 require 'graph2relational/neo4j-connection'
 
 # RDBMS require
+require 'graph2relational/rdbms'
 require 'graph2relational/rdbms-database'
 require 'graph2relational/rdbms-connection'
 require 'graph2relational/rdbms-table'
 require 'graph2relational/rdbms-join-table'
 require 'graph2relational/rdbms-column'
+
+# Sequel extensions
+Sequel.extension :inflector

data/lib/graph2relational/neo4j-connection.rb

@@ -5,10 +5,6 @@ module G2R
         @conn = Neography::Rest.new(options)
       end
 
-      def query_data(cypher)
-        query(cypher)['data']
-      end
-
       def query_columns(cypher)
         columns = Set.new
         query(cypher)['data'].each do |row|
@@ -18,6 +14,15 @@ module G2R
         columns.to_a
       end
 
+      def query_data(cypher)
+        query(cypher)['data']
+      end
+
+      def query_hash(cypher)
+        results = query(cypher)
+        results["data"].map {|row| Hash[*results["columns"].zip(row).flatten] }
+      end
+
       def query(cypher)        
         @conn.execute_query(cypher)
       end

data/lib/graph2relational/neo4j-database.rb

@@ -46,8 +46,8 @@ module G2R
       end
 
       def label_data(label)
-        return_clause = label_attributes(label).map {|column| "n.#{column}"}.join(", ")
-        @conn.query_data("MATCH (n:#{label}) RETURN id(n), #{return_clause}")
+        return_clause = label_attributes(label).map {|column| "n.#{column} as #{column}"}.join(", ")
+        @conn.query_hash("MATCH (n:#{label}) RETURN id(n) as id, #{return_clause}")
       end
 
       # ==========================================================================

data/lib/graph2relational/rdbms-column.rb

@@ -4,32 +4,48 @@ module G2R
       attr_accessor :name
 
       def initialize(name)
-        @name = name.downcase.to_sym
+        @name = RDBMS.transform_name(name)
         @primary_key = false
         @foreign_key = false
       end
 
+      def ==(other_column)
+        @name == other_column.name
+      end
+
+      # ========================================================================
+      # PRIMARY KEY
+      # ========================================================================
       # Define the column as a primary key
       def primary_key
         @primary_key = true
         self
       end
 
-      # Define the column as a foreign key
-      def foreign_key
-        @foreign_key = true
-        self
-      end
-
       # Checks if the column is a primary key
       def primary_key?
         @primary_key
       end
 
+      # ========================================================================
+      # FOREIGN KEY
+      # ========================================================================
+      # Define the column as a foreign key
+      def foreign_key(target_table)
+        @foreign_key = true
+        @target_table = RDBMS.transform_name(target_table)
+        self
+      end
+
       # Check if the column is a foreign key
       def foreign_key?
         @foreign_key
       end
+
+      # Table the foreign key is targeting
+      def target_table
+        @target_table
+      end
     end
   end
 end

data/lib/graph2relational/rdbms-connection.rb

@@ -8,18 +8,19 @@ module G2R
       end
 
       def create_table(table)
-        @db.create_table! table.name do
+        @db.create_table! table.name.to_sym do
 
           table.columns.each do |column|
             # primary key
             if column.primary_key?
-              primary_key column.name
+              primary_key column.name.to_sym
             # foreign key
             elsif column.foreign_key?
-              Integer column.name
+              foreign_key column.name.to_sym, column.target_table.to_sym
+              index column.name.to_sym
             # common column
             else
-              String column.name
+              String column.name.to_sym
             end
           end
         end

data/lib/graph2relational/rdbms-database.rb

@@ -33,12 +33,12 @@ module G2R
         reset_data()
 
         # create tables
-        puts "Creating base tables"
+        puts "Creating base tables schema"
         base_tables.each do |table|
           @conn.create_table(table)
         end
 
-        puts "Creating relationship tables"
+        puts "Creating relationship tables schema"
         relationship_tables.each do |table|
           @conn.create_table(table)
         end
@@ -72,18 +72,24 @@ module G2R
           @base_tables = @source.labels.map do |label|
 
             # if excluding label, do not transform into base table
-            next if exclude? label
+            next if exclude_label? label
 
             # generate table
             table = Table.new(label)
 
             # generate primary key
-            table.add_columns(Column.new(:id).primary_key)
+            table.add_columns(Column.new('id').primary_key)
 
-            # generate columns
+            # generate schema columns
             columns = @source.label_attributes(label).map {|attribute| Column.new(attribute)}
             table.add_columns(columns)
 
+            # add forced columns
+            if @options.has_key? :additional_base_columns
+              forced_columns = @options[:additional_base_columns].map {|name| Column.new(name)}
+              table.add_columns(forced_columns)
+            end
+
             # generate data
             label_data = @source.label_data(label)
             table.add_data(label_data)
@@ -104,26 +110,28 @@ module G2R
           @relationship_tables = @source.labels.flat_map do |label|
 
             # if excluding label, do not transform into relationship table
-            next if exclude? label
+            next if exclude_label? label
 
             @source.label_relationships(label).map do |relationship|
               relationship, target_label = relationship
 
               # if excluding label, do not transform into relationship table
-              next if exclude? target_label
+              next if exclude_relationship? relationship
+              next if exclude_label? target_label
 
               # gerarate table
-              table_name = "#{label}_#{relationship}_#{target_label}"
-              table = JoinTable.new(table_name)
-
-              # generate keys
-              table.source = label
-              table.target = target_label
+              table = JoinTable.new(label, relationship, target_label)
 
               # generate columns
               columns = @source.relationship_attributes(label, relationship, target_label).map {|attribute| Column.new(attribute)}
               table.add_columns(columns)
 
+              # add forced columns
+              if @options.has_key? :additional_relationship_columns
+                forced_columns = @options[:additional_relationship_columns].map {|name| Column.new(name)}
+                table.add_columns(forced_columns)
+              end
+
               # generate data
               relationship_data = @source.relationship_data(label, relationship, target_label)
               table.add_data(relationship_data)
@@ -137,9 +145,18 @@ module G2R
         @relationship_tables
       end
 
+      # ========================================================================
+      # CHECKS
+      # ========================================================================
+
       # Check if a label should be excluded and not be transformed into a table
-      def exclude?(label)
-        @options.has_key? :exclude and @options[:exclude].include? label
+      def exclude_label?(label)
+        @options.has_key? :exclude_labels and @options[:exclude_labels].include? label
+      end
+
+      # Check if a relationship should be excluded and not be transformed into a relationship table
+      def exclude_relationship?(relationship)
+        @options.has_key? :exclude_relationships and @options[:exclude_relationships].include? relationship
       end
     end
   end

data/lib/graph2relational/rdbms-join-table.rb

@@ -3,40 +3,44 @@ module G2R
 
     class JoinTable < Table
 
+      def initialize(source_table, relationship, target_table)
+        # parent initialization
+        super("")
+
+        # additiional initialization
+        table_name = "#{source_table}_#{relationship}_#{target_table}"
+        @name = RDBMS.transform_name(table_name)
+
+        @source_table = RDBMS.transform_name(source_table)
+        @target_table = RDBMS.transform_name(target_table)
+      end
+
       # Additionally return the source and target column ids plus all defined columns
       def columns
         [source_column, target_column] + super
       end
 
       def source_column
-        Column.new(source + "_id").foreign_key
+        Column.new(source_table + "_id").foreign_key(source_table)
       end
 
       def target_column
-        if source != target
-          Column.new(target + "_id").foreign_key
+        if source_table != target_table
+          Column.new(target_table + "_id").foreign_key(target_table)
         else
-          Column.new(target + "_id_2").foreign_key
+          Column.new(target_table + "_id_2").foreign_key(target_table)
         end
       end
 
       # ==========================================================================
       # ACESSORS
       # ==========================================================================
-      def source=(source)
-        @source = source
-      end
-
-      def source
-        @source
-      end
-
-      def target=(target)
-        @target = target
+      def source_table
+        @source_table
       end
 
-      def target
-        @target
+      def target_table
+        @target_table
       end
     end
   end

data/lib/graph2relational/rdbms-table.rb

@@ -3,21 +3,36 @@ module G2R
     class Table
 
       def initialize(name)
-        @name = name.downcase.to_sym
+        @name = RDBMS.transform_name(name)
         @columns = []
         @data = []
       end
 
+      def ==(other_table)
+        @name == other_table.name
+      end
+
       def name
         @name
       end
 
       def add_columns(columns)
-        if columns.class == Array
-          @columns += columns
-        else
-          @columns << columns
+        # transform string into array
+        if columns.class != Array
+          columns = [columns]
         end
+
+        # filter out columns that already exists
+        columns = columns.map do |column|
+          if @columns.include? column
+            nil
+          else
+            column
+          end
+        end.compact
+
+        # append columns
+        @columns += columns
       end
 
       def columns

data/lib/graph2relational/rdbms.rb

@@ -0,0 +1,16 @@
+module G2R
+  module RDBMS
+
+    def self.transform_name(name)
+      name = name.to_s if name.class == Symbol
+
+      # sequel underscore (handles CamelCase)
+      name = name.underscore
+
+      # space to underscore
+      name = name.gsub(/\s/, '_')
+
+      name
+    end
+  end
+end

data/lib/graph2relational/util-commandline-parser.rb

@@ -9,7 +9,11 @@ module G2R
 
       def parse()
         # default values
-        options = {:input => nil, :output => nil, :exclude => []}
+        options = {
+          :input => nil, :output => nil,
+          :additional_base_columns => [], :additional_relationship_columns => [],
+          :exclude_labels => [], :exclude_relationships => []
+        }
 
         # display help if no args
         ARGV << '-h' if ARGV.empty?
@@ -28,9 +32,22 @@ module G2R
               options[:output] = output_connection
             end
 
+            # base columns to always be created
+            opts.on("--additional-base-columns COLUMNS", "Base table columns (separated by comma) that should always be created, even if they are not found in Neo4J schema") do |columns|
+              options[:additional_base_columns] = columns.split(",").map{|column| column.strip}
+            end
+
+            opts.on("--additional-relationships-columns COLUMNS", "Relationship table columns (separated by comma) that should always be created, even if they are not found in Neo4J schema") do |columns|
+              options[:additional_relationship_columns] = columns.split(",").map{|column| column.strip}
+            end
+
             # exclusion
-            opts.on("-x EXCLUSION", "--exclude EXCLUSION", "Neo4J labels (separated by comma) to exclude from the conversion") do |exclude|
-              options[:exclude] = exclude.split(",").map{|exclude| exclude.strip}
+            opts.on("--exclude-labels EXCLUSION", "Neo4J labels (separated by comma) to exclude from the conversion") do |exclude|
+              options[:exclude_labels] = exclude.split(",").map{|exclude| exclude.strip}
+            end
+
+            opts.on("--exclude-relationships EXCLUSION", "Neo4J relationships (separated by comma) to exclude from the conversion") do |exclude|
+              options[:exclude_relationships] = exclude.split(",").map{|exclude| exclude.strip}
             end
 
             # help

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: graph2relational
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Renato Dinhani Conceição
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-25 00:00:00.000000000 Z
+date: 2016-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: neography
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.32'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Converts a Neo4J graph database to a supported RDBMS database automatically
   generating tables from its labels, relationships and attributes
 email: renatodinhani@gmail.com
@@ -55,6 +83,7 @@ files:
 - lib/graph2relational/rdbms-database.rb
 - lib/graph2relational/rdbms-join-table.rb
 - lib/graph2relational/rdbms-table.rb
+- lib/graph2relational/rdbms.rb
 - lib/graph2relational/util-commandline-parser.rb
 homepage: https://github.com/renatodinhani/graph2relational
 licenses: