exodus 1.0.4 → 1.0.5

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.0.5
+
+* Added helpers folder + module to do cleaner and prettier prints
+
 ## v1.0.4
 
 * Custom migrations now runs in the given order

data/README.md

@@ -64,10 +64,6 @@ Exodus - a migration framework for MongoDb
 ## To Do when writting your own
 
 * Give it a migration_number
-    class MyMigration < Exodus::Migration
-      self.migration_number = 1
-    end
-
 * Initialize it and define status_complete and description
 * Write the UP method that will be call when migrating the migration
 * Write the DOWN method that will be call when rolling back the migration

data/lib/exodus.rb

@@ -1,4 +1,5 @@
 require 'mongo_mapper'
+require File.dirname(__FILE__) + '/exodus/helpers/text_formatter'
 require File.dirname(__FILE__) + '/exodus/config/migration_info'
 require File.dirname(__FILE__) + '/exodus/migrations/migration'
 require File.dirname(__FILE__) + '/exodus/migrations/migration_error'

data/lib/exodus/helpers/text_formatter.rb

@@ -0,0 +1,75 @@
+module Exodus
+  module TextFormatter
+
+    # Prints a paragraphes 
+    def super_print(paragraphes, space_number = 50, title = true)
+      puts format_paragraph(space_number, title, *paragraphes)
+    end
+
+    private 
+
+    # Transforms an array of paragraphes to a String using lines and columns
+    # Each paragraph is actually an Array of string, where each string is a sentence of a given column
+    # if the sentence contains to much caractere the sentence will be splitted (using whitespaces) and written on several lines 
+    # e,g considering paragraphes = [["id", "type"]["id_1", "test"]] 
+    # format_paragraph will print:
+    # id      type
+    # id_1    test
+    def format_paragraph(space_number, title, *paragraphes)
+      column_size = paragraphes.max_by{|paragraph| paragraph.size}.size
+      @full_text = Hash[*column_size.times.map {|i| [i,[]]}.flatten(1)]
+
+      paragraphes.each_with_index do |sentences, paragraph_number|
+        sentences.each_with_index do |sentence, column|
+          if sentence.size > space_number && (words = sentence.gsub('=>', ' => ').split(' ')).size > 1
+            new_sentence = ""
+            words.each_with_index do |word, nb_word| 
+              if new_sentence.size + word.size  < space_number
+                new_sentence << word << ' '
+              else
+                insert_line(column, new_sentence) unless new_sentence.empty?
+                new_sentence = word << ' '
+              end
+            end
+
+            insert_line(column, new_sentence) unless new_sentence == @full_text[column].last
+          else 
+            insert_line(column, sentence) 
+          end
+        end
+
+        @full_text.each {|column, lines| (@max_lines - lines.size).times { lines << '' }}
+        space = paragraph_number == 0 && title ? "/nbspace" : ""
+        @full_text.each {|column, lines| lines << space}
+      end
+
+      stringify_paragraph
+    end
+
+    # Creates a String from a Hash of the following format {column_number => [lines]}
+    # "/nbspace" is used to define a border
+    def stringify_paragraph
+      ordered_lines = {}
+
+      spaces = @full_text.map {|column, lines| lines.max_by {|sentence| sentence.size}.size}
+      @full_text.each_with_index do |(column, lines), i| 
+        lines.each_with_index do |line, line_number|
+          if line == "/nbspace"
+            (ordered_lines[line_number] ||= "") << line.gsub("/nbspace", "-" * (spaces[i] + 4))
+          else
+            (ordered_lines[line_number] ||= "") << line.to_s.ljust(spaces[i] + 4)
+          end
+        end
+      end
+
+      ordered_lines.values.join("\n")
+    end
+
+    # Inserts a line at the correcponding column and re-sets the number of maximum line if the maximum has been increased 
+    def insert_line(column, line)
+      @max_lines ||= 0
+      @full_text[column] << line
+      @max_lines = @full_text[column].size if @max_lines < @full_text[column].size
+    end
+  end
+end

data/lib/exodus/migrations/migration.rb

@@ -1,6 +1,7 @@
 module Exodus
   class Migration
     include MongoMapper::Document
+    extend Exodus::TextFormatter
     set_collection_name 'migrations'
 
     UP = 'up'
@@ -69,27 +70,24 @@ module Exodus
 
       # Prints in the console all migrations class with their name and description  
       def list
-        puts "\n Migration n#:  \t\t   Name: \t\t\t\t Description:"
-        puts '-' * 100, "\n"
+        last_info = [["Migration n#:", "Name:", "Description:"]]
 
-        Migration.sort_all.map do|migration, args|
-          m = migration.new
-          puts "\t#{migration.migration_number} \t\t #{migration.name} \t\t #{m.description}"
+        last_info |= Migration.sort_all.map do|migration, args|
+          [migration.migration_number, migration.name, migration.new.description]
         end
 
-        puts "\n\n"
+        super_print(last_info, 70)
       end 
 
       # Prints in the console all migrations that has been ran at least once with their name and description  
       def db_status
-        puts "\n Migration n#:  \t   Name: \t\t     Direction:     Arguments:      Current Status: \t Last completion Date: \t\t Current Message:"
-        puts '-' * 175, "\n"
+        status_info = [["Migration n#:", "Name:", "Direction:", "Current Status:", "Arguments:", "Last completion Date:", "Current Message:"]]
 
-        Migration.all.each do|migration|
-          puts "\t#{migration.class.migration_number} \t #{migration.class.name} \t #{migration.status.to_string}"
+        status_info |= Migration.all.map do|migration|
+          [migration.class.migration_number, migration.class.name, *migration.status.to_a_string]
         end
 
-        puts "\n\n"
+        super_print(status_info)
       end 
     end
 

data/lib/exodus/migrations/migration_status.rb

@@ -25,7 +25,15 @@ module Exodus
     end
 
     def to_string
-      "\t#{direction}\t\t #{arguments}\t\t #{current_status} \t\t #{last_succesful_completion} \t\t #{message}"
+      "\t#{direction}\t\t #{current_status} \t\t #{arguments}\t\t #{last_succesful_completion} \t\t #{message}"
+    end
+
+    def to_a
+      [direction, current_status, arguments, last_succesful_completion, message]
+    end
+
+    def to_a_string
+      self.to_a.map(&:to_s)
     end
 
     # Resets a status

data/lib/exodus/version.rb

@@ -1,3 +1,3 @@
 module Exodus
-  VERSION = "1.0.4"
+  VERSION = "1.0.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exodus
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-08 00:00:00.000000000 Z
+date: 2013-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mongo_mapper
@@ -95,6 +95,7 @@ files:
 - exodus.gemspec
 - lib/exodus.rb
 - lib/exodus/config/migration_info.rb
+- lib/exodus/helpers/text_formatter.rb
 - lib/exodus/migrations/migration.rb
 - lib/exodus/migrations/migration_error.rb
 - lib/exodus/migrations/migration_status.rb