mongify 0.0.9 → 0.1.0

data/CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+== 0.1.0 / 21 Jan 2011
+* Moved from Alpha to Beta! :)
+* Improved internal RDocs
+* Improved specs
+* Refactored
+* Renamed 'translate' command to 'translation'
+* Added :auto_detect option to columns
+* Added ability to do a before_save on the table.
 == 0.0.9 / 19 Jan 2011
 * Added ability to rename tables
 * Fixed bug 'pre_mogified_id' not being removed in all records

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mongify (0.0.9)
+    mongify (0.1.0)
       activerecord (>= 2.3.10)
       activesupport (>= 2.3.10)
       bson_ext (>= 1.1.5)

data/README.rdoc

@@ -7,12 +7,10 @@ However, I've only tested it with MySql and SQLite
 
 Supports any version of MongoDB
 
-Learn more about mongoDB at: http://www.mongodb.org
+Learn more about MongoDB at: http://www.mongodb.org
 
 == Install
 
-<b>WARNING: This gem is still in alpha</b>
-
   gem install mongify
 
 == Usage
@@ -33,7 +31,7 @@ Building a config file is as simple as this:
 
   mongodb_connection do
     host      "localhost"
-    database  "my_collection"
+    database  "my_database"
   end
   
 You can check your configuration by running
@@ -46,9 +44,9 @@ You can check your configuration by running
 
 ==== Generating a translation
 If you're database is large and complex, it might be a bit too much to hand write the translation file, Mongify can help by running the translate command:
-  mongify transalte -c database.config
+  mongify translation -c database.config
 Or pipe it right into a file by running
-  mongify transalte -c database.config > translation_file.rb
+  mongify translation -c database.config > translation_file.rb
 
 ==== Creating a translation
 Creating a translation is pretty straight forward. It looks something like this:
@@ -89,6 +87,27 @@ Creating a translation is pretty straight forward. It looks something like this:
 Save the file as <tt>"translation_file.rb"</tt> and run the command:
 
   mongify process translation_file.rb -c database.config
+  
+=== Commands
+
+  Usage: mongify command [database_translation.rb] [-c database.config]
+
+  Commands:
+    "check" or "ck"           >> Checks connection for sql and no_sql databases [configuration_file]
+    "process" or "pr"         >> Takes a translation and process it to mongodb [configuration_file, translation_file]
+    "translation" or "tr"     >> Outputs a translation file from a sql connection [configuration_file]
+
+  Examples:
+
+    mongify translation -c datbase.config
+    mongify tr -c database.config
+    mongify check -c database.config
+    mongify process database_translation.rb -c database.config
+
+  Common options:
+      -h, --help                       Show this message
+      -v, --version                    Show version
+      -c, --config FILE                Configuration File to use
 
 == Translation Layout and Options
 
@@ -115,12 +134,20 @@ Table Options are as follow:
                                                             # This also assumes you have a user_id present in table_name
 <em>You can also specify both <b>:on</b> and <b>:as</b> options when embedding</em>
 
+<b>NOTE: If you rename the owner_id column, make sure you update the :on to the new column name</b>
+
   table "table_name", :rename_to => 'my_table'              # This will allow you to rename the table as it's getting process
                                                             # Just remember that columns that use :reference need to
                                                             # reference the new name.
 
   table "table_name", :ignore => true                       # This will ignore the whole table (like it doesn't exist)
                                                             # This option is good for tables like: schema_migrations
+                                                            
+  table "table_name" do                                     # A table can take a before_save block that will be called just
+    before_save do |row|                                    # before the row is saved to the no sql database.
+      row.admin = row.delete('permission').to_i > 50        # This gives you the ability to do very powerful things like:
+    end                                                     # Moving records around, renaming records, changing values in row based on
+  end                                                       # some values! Checkout {Mongify::Database::DataRow} to learn more
 
 === Columns
 
@@ -142,9 +169,13 @@ Before we cover the options, you need to know what types of columns are supporte
   :decimal              # Will be converted to a BigDecimal
   :string               # Will be converted to a string
   :text                 # Will be converted to a string
-  :datetime             # Specifying a field as :datetime will convert it to Time format as it gets imported into MongoDB
+  :datetime             # Will be converted to a Time format (DateTime is not currently supported in the Mongo ruby driver)
+  :date                 # Will be converted to a Time format (Date is not currently supported in the Mongo ruby driver)
+  :timestamps           # Will be converted to a Time format
+  :time                 # Will be converted to a Time format (the date portion of the Time object will be 2000-01-01)
   :binary               # Will be converted to a string
-  
+  :boolean              # Will be converted to a true or false values
+
 ==== Options
 
   column "post_id", :integer, :referneces => :posts   # Referenced columns need to be marked as such, this will mean that they will be updated
@@ -155,9 +186,6 @@ Before we cover the options, you need to know what types of columns are supporte
   
   column "surname", :string, :rename_to => 'last_name'# Rename_to allows you to rename the column                                                      
 
-<em>**this is subject to change during the alpha (0.0.x release)**</em>
-
-
 == Notes
 
 I have currently only tested this in Ruby 1.8.7-p330
@@ -168,13 +196,9 @@ More testing will be done once the basic functionality is done
 == TODO
 
 * Allow you to set a :force => true for mongodb_connection, so that it drops existing database before importing
-
-=== while processing
-
 * Work with polymorphic tables
-* Allow running a proc on column value
 * Update user on what is being processed
-
+* Improve RDoc
 
 == Development
 

data/features/options.feature

@@ -24,13 +24,12 @@ Feature: Mongify can be controlled using command-line options
 			Commands:
 			"check" or "ck"           >> Checks connection for sql and no_sql databases [configuration_file]
 			"process" or "pr"         >> Takes a translation and process it to mongodb [configuration_file, translation_file]
-			"translate" or "tr"       >> Spits out translation from a sql connection [configuration_file]
+			"translation" or "tr"     >> Outputs a translation file from a sql connection [configuration_file]
 			
       Examples:
 			
-			mongify translate -c datbase.config
-			mongify tr -c database.config
-		 	mongify check -c database.config
+			mongify check -c database.config
+		 	mongify translation -c datbase.config > database_translation.rb
 		 	mongify process database_translation.rb -c database.config
       
       See http://github.com/anlek/mongify for more details
@@ -40,7 +39,4 @@ Feature: Mongify can be controlled using command-line options
           -v, --version                    Show version
           -c, --config FILE                Configuration File to use
 
-      Report formatting:
-          -q, --[no-]quiet                 Suppress extra output
-
       """

data/features/print.feature

@@ -5,6 +5,6 @@ Feature: Database Translation Output
   
   Scenario: Translation Output request
     Given a database exists
-    When I run mongify translate -c spec/files/base_configuration.rb
+    When I run mongify translation -c spec/files/base_configuration.rb
     Then it succeeds
     And it should print out the database schema

data/features/process.feature

@@ -3,7 +3,6 @@ Feature: Processing a translation
   As a user
   I want to be able to process a translation and move my data to mongodb!
 
-  @wip
   Scenario: Process
   Given a database exists
   And a blank mongodb

data/features/support/env.rb

@@ -11,7 +11,9 @@ require 'spec/support/config_reader'
 ::CONNECTION_CONFIG = ConfigReader.new(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))) + '/spec/support/database.yml')
 ::DATABASE_PRINT = File.read(File.dirname(File.dirname(File.dirname(File.expand_path(__FILE__)))) + '/spec/support/database_output.txt')
 
+# Used to run mongify command
 module MongifyWorld
+  # Executes command and tracks results
   def run(cmd)
     stderr_file = Tempfile.new('mongify-world')
     stderr_file.close
@@ -19,7 +21,8 @@ module MongifyWorld
     @last_exit_status = $?.exitstatus
     @last_stderr = IO.read(stderr_file.path)
   end
-
+   
+  # Executes mongify command with arguments
   def mongify(args)
     run("ruby -Ilib -rubygems bin/mongify #{args}")
   end

data/lib/mongify.rb

@@ -10,11 +10,13 @@ require 'mongify/translation'
 require 'mongify/configuration'
 require 'mongify/database'
 
-module Mongify
+module Mongify # Namespace for Mongify
   class << self
+    # Handles setting root for the application
     def root=(value)
       @root = value
     end
+    #Raises RootMissing if you attempt to call root without setting it
     def root
       raise RootMissing, "Root not configured" if @root.nil?
       @root

data/lib/mongify/cli.rb

@@ -1,7 +1,6 @@
 require 'mongify'
 
 require 'mongify/cli/options'
-require 'mongify/cli/report'
 require 'mongify/cli/version_command'
 require 'mongify/cli/help_command'
 require 'mongify/cli/worker_command'

data/lib/mongify/cli/application.rb

@@ -1,4 +1,5 @@
 module Mongify
+  # The Command Line Interface module
   module CLI
     #
     # Represents an instance of a Mongify application.
@@ -7,16 +8,20 @@ module Mongify
     #
     class Application
       
+      # Successful execution exit code
       STATUS_SUCCESS = 0
+      # Failed execution exit code 
       STATUS_ERROR   = 1
       
-      def initialize(arguments=["--help"], stdin=$stdin, stdout=$stdout)
+      def initialize(arguments=[], stdin=$stdin, stdout=$stdout)
+        arguments = ['-h'] if arguments.empty?
         @options = Options.new(arguments)
         @status = STATUS_SUCCESS
         Mongify::Configuration.in_stream = stdin
         Mongify::Configuration.out_stream = stdout
       end
       
+      # Runs the application
       def execute!
         begin
           cmd = @options.parse
@@ -28,13 +33,17 @@ module Mongify
         return @status
       end
       
+      # Sends output to the UI
       def output(message)
         UI.puts(message)
       end
       
+      # Sets status code as successful
       def report_success
         @status = STATUS_SUCCESS
       end
+      
+      # Sets status code as failure (or error)
       def report_error
         @status = STATUS_ERROR
       end

data/lib/mongify/cli/help_command.rb

@@ -7,6 +7,7 @@ module Mongify
       def initialize(parser)
         @parser = parser
       end
+      #Executes the help command
       def execute(view)
         view.output(@parser.to_s)
         view.report_success

data/lib/mongify/cli/options.rb

@@ -9,12 +9,12 @@ module Mongify
         @parsed = false
         @argv = argv
         @parser = OptionParser.new
-        @report_class = VerboseReport
         #@command_class = ReekCommand
         set_options
         
       end
       
+      # Banner for help output
       def banner
         progname = @parser.program_name
         return <<EOB
@@ -25,9 +25,8 @@ Commands:
 
 Examples:
 
-#{progname} translate -c datbase.config
-#{progname} tr -c database.config
 #{progname} check -c database.config
+#{progname} translation -c datbase.config > database_translation.rb
 #{progname} process database_translation.rb -c database.config
 
 See http://github.com/anlek/mongify for more details
@@ -35,7 +34,8 @@ See http://github.com/anlek/mongify for more details
 EOB
       end
       
-      
+      # Sets the options for CLI
+      # Also used for help output
       def set_options
         @parser.banner = banner
         @parser.separator "Common options:"
@@ -48,13 +48,9 @@ EOB
         @parser.on('-c', '--config FILE', "Configuration File to use") do |file|
           @config_file = file
         end
-
-        @parser.separator "\nReport formatting:"
-        @parser.on("-q", "--[no-]quiet", "Suppress extra output") do |opt|
-          @report_class = opt ? QuietReport : VerboseReport
-        end
       end
-
+      
+      # Parses CLI passed attributes and figures out what command user is trying to run
       def parse
         parse_options
         
@@ -71,24 +67,27 @@ EOB
         end
       end
       
+      #######
       private
+      #######
       
+      # Returns the translation_file or nil
       def translation_file(argv=@argv)
         parse_options
         return nil if argv.length < 2
         argv[1]
       end
       
+      # Returns action (command) user is calling or ''
       def action(argv=@argv)
         parse_options
         @argv.try(:[],0) || ''
       end
-            
+       
+      # option parser, ensuring parse_options is only called once     
       def parse_options
         @parsed = true && @parser.parse!(@argv) unless @parsed
-      end      
-      
-      
+      end
     end
   end
 end

data/lib/mongify/cli/version_command.rb

@@ -9,6 +9,7 @@ module Mongify
       def initialize(progname)
         @progname = progname
       end
+      #Executes version command
       def execute(view)
         view.output("#{@progname} #{Mongify::VERSION}\n")
         view.report_success

data/lib/mongify/cli/worker_command.rb

@@ -7,11 +7,15 @@ module Mongify
     class WorkerCommand
       attr_accessor :view
       
+      # A hash of available commands
+      # Including description, additional shortcuts to run the commands and requirements to run the command
       AVAILABLE_COMMANDS = {
                                 :check => {:commands => ['check', 'ck'], :description => "Checks connection for sql and no_sql databases", :required => [:configuration_file]},
-                                :translate => {:commands => ['translate', 'tr'], :description => "Spits out translation from a sql connection", :required => [:configuration_file]},
+                                :translation => {:commands => ['translation', 'tr'], :description => "Outputs a translation file from a sql connection", :required => [:configuration_file]},
                                 :process => {:commands => ['process', 'pr'], :description => "Takes a translation and process it to mongodb", :required => [:configuration_file, :translation_file]}
                               }
+      
+      # Prints out a nice display of the list of commands
       def self.list_commands
         [].tap do |commands|
           AVAILABLE_COMMANDS.each do |key, obj|
@@ -19,7 +23,8 @@ module Mongify
           end
         end.sort
       end
-                              
+                            
+      # Finds a command array by any of the shortcut commands
       def self.find_command(command)
         AVAILABLE_COMMANDS.each do |key, options|
           return [key, options] if(options[:commands].include?(command.to_s.downcase))
@@ -34,6 +39,7 @@ module Mongify
         @parser = parser
       end
       
+      #Executes the worked based on a given command
       def execute(view)
         self.view = view
         
@@ -50,7 +56,7 @@ module Mongify
         end
         
         case current_command
-        when :translate
+        when :translation
           check_connections
           view.output(Mongify::Translation.load(@config.sql_connection).print)
         when :check
@@ -67,6 +73,7 @@ module Mongify
         view.report_success
       end
       
+      # Passes find command to parent class
       def find_command(command=@command)
         self.class.find_command(command)
       end
@@ -75,19 +82,20 @@ module Mongify
       private
       #######
 
-      def check_connections(sql_only = false)
-        check_sql_connection && (sql_only || check_nosql_connection)
+      # Checks both sql and no sql connection
+      def check_connections
+        check_sql_connection && check_nosql_connection
       end
       
+      # Checks sql connection if it's valid and has_connection?
       def check_sql_connection
         @config.sql_connection.valid? && @config.sql_connection.has_connection?
       end
       
+      # Checks no sql connection if it's valid and has_connection?
       def check_nosql_connection
         @config.no_sql_connection.valid? && @config.no_sql_connection.has_connection?        
       end
-      
-      
     end
   end
 end