mongify 0.3.1 → 0.9

data/.rspec

@@ -0,0 +1 @@
+--color

data/CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+== 0.9 / 08 Feb 2013
+* Changed Mongify Syntax (thanks to tanema)
+* Improved error handling
+* Improved Test output
+* Refactored Commands
+* Updated Gem Requirements
+* Removed depricated calls (from Mongo insert statement)
+* Removed MySql2 dependency (ActiveRecord takes care of that)
 == 0.3.1 / 21 Jan 2013
 * README examples updated
 * README typos fixed.

data/Gemfile.lock

@@ -1,30 +1,30 @@
 PATH
   remote: .
   specs:
-    mongify (0.3.1)
+    mongify (0.9)
       activerecord (>= 3.0.3)
       activesupport (>= 3.0.3)
-      bson_ext (>= 1.1.5)
+      bson_ext (~> 1.8.2)
       highline (>= 1.6.1)
-      mongo (>= 1.1.5)
-      mysql2
+      mongo (~> 1.8.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.0.7)
-      activesupport (= 3.0.7)
+    activemodel (3.0.20)
+      activesupport (= 3.0.20)
       builder (~> 2.1.2)
       i18n (~> 0.5.0)
-    activerecord (3.0.7)
-      activemodel (= 3.0.7)
-      activesupport (= 3.0.7)
-      arel (~> 2.0.2)
+    activerecord (3.0.20)
+      activemodel (= 3.0.20)
+      activesupport (= 3.0.20)
+      arel (~> 2.0.10)
       tzinfo (~> 0.3.23)
-    activesupport (3.0.7)
-    arel (2.0.9)
-    bson (1.3.0)
-    bson_ext (1.3.0)
+    activesupport (3.0.20)
+    arel (2.0.10)
+    bson (1.8.2)
+    bson_ext (1.8.2)
+      bson (~> 1.8.2)
     builder (2.1.2)
     cucumber (1.2.1)
       builder (>= 2.1.2)
@@ -34,13 +34,12 @@ GEM
     diff-lcs (1.1.3)
     gherkin (2.11.2)
       json (>= 1.4.6)
-    highline (1.6.1)
+    highline (1.6.15)
     i18n (0.5.0)
     json (1.7.5)
     mocha (0.9.12)
-    mongo (1.3.0)
-      bson (>= 1.3.0)
-    mysql (2.8.1)
+    mongo (1.8.2)
+      bson (~> 1.8.2)
     mysql2 (0.2.7)
     rake (0.9.2.2)
     rcov (0.9.9)
@@ -52,10 +51,10 @@ GEM
     rspec-expectations (2.5.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.5.0)
-    sqlite3 (1.3.3)
+    sqlite3 (1.3.7)
     sqlite3-ruby (1.3.3)
       sqlite3 (>= 1.3.3)
-    tzinfo (0.3.26)
+    tzinfo (0.3.35)
     watchr (0.7)
     yard (0.6.4)
 
@@ -66,7 +65,7 @@ DEPENDENCIES
   cucumber (>= 0.10)
   mocha (>= 0.9.8)
   mongify!
-  mysql (>= 2.8.1)
+  mysql2 (~> 0.2.7)
   rake
   rcov (>= 0.9.9)
   rspec (>= 2.0)

data/README.rdoc

@@ -35,10 +35,10 @@ Building a config file is as simple as this:
     host      "localhost"
     database  "my_database"
   end
-  
+
 You can check your configuration by running
-  mongify check -c database.config
-  
+  mongify check database.config
+
 ==== Options
 Currently the only supported option is for the mongodb_connection.
 
@@ -53,9 +53,9 @@ Currently the only supported option is for the mongodb_connection.
 
 ==== Generating a translation
 If your database is large and complex, it might be a bit too much work to write the translation file by hand. Mongify's translate command can help with this:
-  mongify translation -c database.config
+  mongify translation database.config
 Or pipe it right into a file by running
-  mongify translation -c database.config > translation_file.rb
+  mongify translation database.config > translation_file.rb
 
 ==== Creating a translation
 Creating a translation is pretty straightforward. It looks something like this:
@@ -86,13 +86,13 @@ Creating a translation is pretty straightforward. It looks something like this:
     column "created_at", :datetime
     column "updated_at", :datetime
   end
-  
+
   table "preferences", :embed_in => :users, :as => :object do
     column "id", :key, :as => :string
     column "user_id", :integer, :references => "users"
     column "notify_by_email", :boolean
   end
-  
+
   table "notes", :embed_in => true, :polymorphic => 'notable' do
     column "id", :key
     column "user_id", :integer, :references => "users"
@@ -102,14 +102,14 @@ Creating a translation is pretty straightforward. It looks something like this:
     column "created_at", :datetime
     column "updated_at", :datetime
   end
-  
+
 Save the file as <tt>"translation_file.rb"</tt> and run the command:
 
-  mongify process translation_file.rb -c database.config
-  
+  mongify process database.config translation_file.rb
+
 === Commands
 
-  Usage: mongify command [database_translation.rb] [-c database.config]
+  Usage: mongify command database_config [database_translation.rb]
 
   Commands:
     "check" or "ck"           >> Checks connection for sql and no_sql databases [configuration_file]
@@ -118,15 +118,14 @@ Save the file as <tt>"translation_file.rb"</tt> and run the command:
 
   Examples:
 
-    mongify translation -c datbase.config
-    mongify tr -c database.config
-    mongify check -c database.config
-    mongify process database_translation.rb -c database.config
+    mongify translation datbase.config
+    mongify tr database.config
+    mongify check database.config
+    mongify process database.config database_translation.rb
 
   Common options:
       -h, --help                       Show this message
       -v, --version                    Show version
-      -c, --config FILE                Configuration File to use
 
 == Translation Layout and Options
 
@@ -147,17 +146,17 @@ Table Options are as follow:
   table "table_name"                                        # Does a straight copy of the table
   table "table_name", :embed_in => 'users'                  # Embeds table_name into users, assuming a user_id is present in table_name.
                                                             # This will also assume you want the table embedded as an array.
-                                                            
+
   table "table_name",                                       # Embeds table_name into users, linking it via a owner_id
         :embed_in => 'users',                               # This will also assume you want the table embedded as an array.
-        :on => 'owner_id'                                   
-                                                            
+        :on => 'owner_id'
+
   table "table_name",                                       # Embeds table_name into users as a one to one relationship
         :embed_in => 'users',                               # This also assumes you have a user_id present in table_name
         :on => 'owner_id',                                  # You can also specify both :on and :as options when embedding
-        :as => 'object'                                     # NOTE: If you rename the owner_id column, make sure you 
+        :as => 'object'                                     # NOTE: If you rename the owner_id column, make sure you
                                                             # update the :on to the new column name
-                                                            
+
 
   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
@@ -165,14 +164,14 @@ Table Options are as follow:
 
   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",                                       # This allows you to specify the table as being polymorphic
         :polymorphic => 'notable',                          # and provide the name of the polymorphic relationship.
         :embed_in => true                                   # Setting embed_in => true allows the relationship to be
                                                             # embedded directly into the parent class.
                                                             # If you do not embed it, the polymorphic table will be copied in to
                                                             # MongoDB and the notable_id will be updated to the new BSON::ObjectID
-                                                            
+
   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:
@@ -180,9 +179,9 @@ Table Options are as follow:
   end                                                       # some values! Checkout Mongify::Database::DataRow to learn more
 
   table "users" do                                          # Here is how to set new ID using the old id
-    before_save do |row|                     
-      row._id = row.delete('pre_mongified_id')     
-    end                                                     
+    before_save do |row|
+      row._id = row.delete('pre_mongified_id')
+    end
   end
 
   table "preferences", :embed_in => "users" do              # As of version 0.2, embedded tables with a before_save will take an
@@ -203,7 +202,7 @@ Structure for defining a column is as follows:
 
 ==== Notes
 
-<em>as of version 0.2:</em> 
+<em>as of version 0.2:</em>
 Leaving a column out when defining a table will result in the column being *ignored*
 
 ==== Types
@@ -229,20 +228,20 @@ Before we cover the options, you need to know what types of columns are supporte
                                                       # NOTE: if you rename the table 'posts', you should set the :references to the new name
 
   column "name", :string, :ignore => true             # Ignoring a column will make the column NOT copy over to the new database
-  
-  column "surname", 
-         :string, 
-         :rename_to => 'last_name'                    # Rename_to allows you to rename the column                                                      
-  
+
+  column "surname",
+         :string,
+         :rename_to => 'last_name'                    # Rename_to allows you to rename the column
+
   <em>For decimal columns you can specify a few options:</em>
   column "total",                                     # This is a default conversion setting.
          :decimal,
-         :as => 'string'                              
-         
+         :as => 'string'
+
   column "total",                                     # You can specify to convert your decimal to integer
           :decimal,                                   # specifying scale will define how many decimal places to keep
           :as => 'integer',                           # Example: :scale => 2 will convert 123.4567 to 12346 before saving
-          :scale => 2                                 
+          :scale => 2
 
 More documentation can be found at {Mongify::Database::Column}
 

data/bin/mongify

@@ -11,4 +11,9 @@ require 'mongify/cli'
 
 Mongify.root = Dir.pwd
 
-exit Mongify::CLI::Application.new(ARGV).execute!
+begin
+  exit Mongify::CLI::Application.new(ARGV).execute!
+rescue Mongify::MongifyError => error
+  $stderr.puts "Error: #{error}"
+  exit Mongify::CLI::Application.execution_error_status
+end

data/features/options.feature

@@ -5,8 +5,8 @@ Feature: Mongify can be controlled using command-line options
 
   Scenario: returns non-zero status on bad options
     When I run mongify --no-such-option
-    Then the exit status indicates an error
-    And it reports the error "Error: invalid option: --no-such-option"
+    Then it reports the error "Error: invalid option: --no-such-option"
+    And the exit status indicates an error
     And stdout equals ""
 
   Scenario: display the current version number
@@ -19,24 +19,22 @@ Feature: Mongify can be controlled using command-line options
     Then it succeeds
     And it reports:
       """
-      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]
-			
+      Usage: mongify command database.config [database_translation.rb]
+
+      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 check -c database.config
-		 	mongify translation -c datbase.config > database_translation.rb
-		 	mongify process database_translation.rb -c database.config
-      
+
+      mongify check database.config
+      mongify translation datbase.config > database_translation.rb
+      mongify process database.config database_translation.rb
+
       See http://github.com/anlek/mongify for more details
 
       Common options:
           -h, --help                       Show this message
           -v, --version                    Show version
-          -c, --config FILE                Configuration File to use
-
       """

data/features/print.feature

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

data/features/process.feature

@@ -6,7 +6,7 @@ Feature: Processing a translation
   Scenario: Process
   Given a database exists
   And a blank mongodb
-  When I run mongify process spec/files/translation.rb -c spec/files/base_configuration.rb
+  When I run mongify process spec/files/base_configuration.rb spec/files/translation.rb
   Then it succeeds
   And there should be 3 users in mongodb
   And there should be 3 posts in mongodb
@@ -18,7 +18,7 @@ Feature: Processing a translation
   Scenario: Processing while modifying embedding parent.
   Given a database exists
   And a blank mongodb
-  When I run mongify process spec/files/embedded_parent_translation.rb -c spec/files/base_configuration.rb
+  When I run mongify process spec/files/base_configuration.rb spec/files/embedded_parent_translation.rb
   Then it succeeds
   And there should be 3 users in mongodb
   And the first user's notify_by_email attribute should be true

data/features/step_definitions/mongify_steps.rb

@@ -7,7 +7,7 @@ Then /^stdout equals "([^\"]*)"$/ do |report|
 end
 
 Then /^it reports:$/ do |report|
-  @last_stdout.should == report
+  @last_stdout.gsub(/\s+/, ' ').strip.should == report.gsub(/\s+/, ' ').strip
 end
 
 Then /^stderr reports:$/ do |report|

data/lib/mongify/cli.rb

@@ -1,7 +1,9 @@
 require 'mongify'
 
+require 'mongify/cli/command/version'
+require 'mongify/cli/command/help'
+require 'mongify/cli/command/worker'
+
+
 require 'mongify/cli/options'
-require 'mongify/cli/version_command'
-require 'mongify/cli/help_command'
-require 'mongify/cli/worker_command'
 require 'mongify/cli/application'

data/lib/mongify/cli/application.rb

@@ -25,7 +25,7 @@ module Mongify
       def execute!
         begin
           cmd = @options.parse
-          cmd.execute(self)
+          return cmd.execute(self)
         rescue MongifyError => error
           $stderr.puts "Error: #{error}"
           report_error
@@ -33,7 +33,6 @@ module Mongify
           report_error
           raise error
         end
-        return @status
       end
       
       # Sends output to the UI

data/lib/mongify/cli/command/help.rb

@@ -0,0 +1,19 @@
+module Mongify
+  module CLI
+    module Command
+      #
+      # A command to display usage information for this application.
+      #
+      class Help
+        def initialize(parser)
+          @parser = parser
+        end
+        #Executes the help command
+        def execute(view)
+          view.output(@parser.to_s)
+          view.report_success
+        end
+      end
+    end
+  end
+end

data/lib/mongify/cli/command/version.rb

@@ -0,0 +1,20 @@
+require 'mongify/version'
+module Mongify
+  module CLI
+    module Command
+      #
+      # A command to report the application's current version number.
+      #
+      class Version
+        def initialize(progname)
+          @progname = progname
+        end
+        #Executes version command
+        def execute(view)
+          view.output("#{@progname} #{Mongify::VERSION}\n")
+          view.report_success
+        end
+      end
+    end
+  end
+end

data/lib/mongify/cli/command/worker.rb

@@ -0,0 +1,101 @@
+module Mongify
+  module CLI
+    module Command
+      #
+      # A command to run the different commands in the application (related to Mongifying).
+      #
+      class Worker
+        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]},
+                                  :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|
+              commands << "#{obj[:commands].map{|w| %["#{w}"]}.to_sentence(:two_words_connector => ' or ', :last_word_connector => ', or ').ljust(25)} >> #{obj[:description]}#{ " [#{obj[:required].join(', ')}]" if obj[:required]}"
+            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))
+          end
+          'unknown'
+        end
+        
+        def initialize(command, config=nil, translation_file=nil, parser="")
+          @command = command.to_s.downcase
+          @config = config
+          @translation_file = translation_file
+          @parser = parser
+        end
+        
+        #Executes the worked based on a given command
+        def execute(view)
+          self.view = view
+          
+          current_command, command_options = find_command
+          
+          if command_options
+            #FIXME: Should parse configuration file in this action, (when I know it's required)
+            raise ConfigurationFileNotFound, "Database Configuration file is missing or cannot be found" if command_options[:required] && command_options[:required].include?(:configuration_file) && @config.nil?
+            if command_options[:required] && command_options[:required].include?(:translation_file)
+              raise TranslationFileNotFound, "Translation file is required for command '#{current_command}'" unless @translation_file
+              raise TranslationFileNotFound, "Unable to find Translation File at #{@translation_file}" unless File.exists?(@translation_file)
+              @translation = Translation.parse(@translation_file)
+            end
+          end
+          
+          case current_command
+          when :translation
+            check_connections
+            view.output(Mongify::Translation.load(@config.sql_connection).print)
+          when :check
+            view.output("SQL connection works") if check_sql_connection
+            view.output("NoSQL connection works") if check_nosql_connection
+          when :process
+            check_connections
+            @translation.process(@config.sql_connection, @config.no_sql_connection)
+          else
+            view.output("Unknown action #{@command}\n\n#{@parser}")
+            return view.report_error
+          end
+          view.report_success
+        end
+        
+        # Passes find command to parent class
+        def find_command(command=@command)
+          self.class.find_command(command)
+        end
+        
+        #######
+        private
+        #######
+
+        # 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
+end