multi_ar 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3754772cf591a147943b8cfb7b83c85254872110
-  data.tar.gz: 620350cf731cc914a5620248dbe1d632406bd34b
+  metadata.gz: c01f5dbedaf04057f1edbf8402963aa6500ef0d3
+  data.tar.gz: f97e3417a9cdfe73af3549008cc47df54055e472
 SHA512:
-  metadata.gz: 5af7a1f88b87c54891429d9f47cff6a4c198c5c50f85c7a47cae606417080fd1f5dc78adafd37ef3fe4515aa035657f5895c5e92fa6f59178f1986d18b327898
-  data.tar.gz: f89187f075e2ad595d6d6ea60e12c98888ef0119ef6481427d100998e5a7635ad706a29b54616f9415bee763715498ed448f6ab7053640d944c94709e2bf3d31
+  metadata.gz: 38d0da40c514cdd74d850d0b2b7116b9707f6cf7f66d507e112848592cd5ecc3f83d495036aa09e518045471608a31a5b6934ade11dd584360fcfd4bfe11f6da
+  data.tar.gz: 663af5abc03f337a16ad458817ceb2fbe8cdf12b9514d5ef008861e6a668c85c959ad58bbe7d7ac9a840511afbb88fa6b176df65b3fba1478522a92397808fc1

data/lib/multi_ar/database.rb

@@ -11,6 +11,9 @@ require "erb"
 require "yaml"
 
 module MultiAR
+
+  # @api private
+  # Database functionality class.
   class Database
 
     # @todo test if this @@initialized thingy actually works, I’m not sure how it in practice works

data/lib/multi_ar/interface.rb

@@ -9,24 +9,21 @@ module MultiAR
 
   # An utility to ease creation of executable using multi database ActiveRecord
   # through command line interface.
-  #
-  # Usage:
-  #
-  # TODO: write usage
-  # TODO: mention this usage in README.md too
   class Interface
 
     # Options that will be enabled.
     #
     # Options supported by this system are:
-    # - config
-    # - db_config
-    # - dry
-    # - environment
-    # - verbose
-    # - databases
+    # - config      # `true` or `String`
+    # - db_config   # `true` or `String`
+    # - dry         # boolean
+    # - environment # `true` or `String`
+    # - verbose     # boolean
+    # - databases   # `true` or `Array`
     #
-    # environment is enabled by default, rest are disabled.
+    # If value is `true`, an option will be added to CLI interface. If the value is something else, the option will be populated by this value instead.
+    #
+    # `environment` option is enabled by default, rest are disabled.
     attr_accessor :options
 
     # Version shown with --version flag on CLI
@@ -35,9 +32,6 @@ module MultiAR
     # Description of the application show in usage texts on CLI
     attr_accessor :description
 
-    # Array of databases that will be used insted if none have not been passed through CLI.
-    attr_accessor :databases
-
     # If set to true, migration framework and other Rake related functionality will be enabled.
     attr_accessor :migration_framework
 
@@ -51,7 +45,7 @@ module MultiAR
     #
     # This is used in --init.
     #
-    # TODO: what for this actually is? Write an example or just tell what for this should be used.
+    # @todo what for this actually is? Write an example or just tell what for this should be used.
     attr_accessor :dependencies
 
     def initialize
@@ -61,19 +55,19 @@ module MultiAR
     end
 
     # @note Consumes ARGV, create copy of it if you need it for something.
-    # TODO: hardcode shorthands
+    # @todo hardcode shorthands
     def cli
       p = Trollop::Parser.new
       p.version @version if @version
       p.banner @description if @description
       p.opt "init",         "Create stub environment with configuration and database.yaml",           type: :string
-      p.opt "databases",    "List of databases to perform operations",                                type: :strings if @options["databases"]
-      p.opt "db_config",    "Path to database config file",                                           type: :string, default: "config/database.yaml" if @options["db_config"]
-      p.opt "config",       "Path to MultiAR framework config file",                                  type: :string, default: "config/settings.yaml" if @options["config"]
-      p.opt "dry",          "Run the program without doing anything. Useful for debugging with -v",   type: :flag if @options["dry"]
+      p.opt "databases",    "List of databases to perform operations",                                type: :strings if @options["databases"] == true
+      p.opt "db_config",    "Path to database config file",                                           type: :string, default: "config/database.yaml" if @options["db_config"] == true
+      p.opt "config",       "Path to MultiAR framework config file",                                  type: :string, default: "config/settings.yaml" if @options["config"] == true
+      p.opt "dry",          "Run the program without doing anything. Useful for debugging with -v",   type: :flag if @options["dry"] == true
       p.opt "environment",  "The environment to use. Corresponds to database config name " +
             "(environment for foo_development is “development”).",                                    type: :string, default: "development"
-      p.opt "verbose",      "Be verbose",                                                             type: :flag if @options["verbose"]
+      p.opt "verbose",      "Be verbose",                                                             type: :flag if @options["verbose"] == true
 
       if @migration_framework == true
         p.opt "all_rake_tasks",     "List all Rake tasks, not only commented ones",                 short: "A", type: :flag
@@ -99,10 +93,16 @@ module MultiAR
         result
       end
 
+      @options.each do |key, value|
+        next if value == true
+        # Not bothering to do checks as we just take the intended values, and not looping the array otherwise
+        opts[key] = value
+      end
+
       bootstrap opts if opts["init"] # Bootstrap will exit after execution; in that case nothing after this will be run.
 
       raise "--config must be path to valid file" if @options["config"] and not File.exist? opts["config"]
-      raise "config/database.yaml seems to be missing" if @options["db_config"] and not File.exist? opts["db_config"]
+      raise "Database config #{opts["db_config"]} seems to be missing" if @options["db_config"] and not File.exist? opts["db_config"]
 
       @opts = opts
 
@@ -110,7 +110,7 @@ module MultiAR
 
       # Then run Rake tasks as requested
 
-      return if not @migration_framework # TODO: I think there should be much more fine grained control for this
+      return opts if not @migration_framework # TODO: I think there should be much more fine grained control for this
 
       if opts["tasks"] || opts["all_rake_tasks"]
         @multi_ar.list_tasks all_rake_tasks: opts["all_rake_tasks"]
@@ -132,14 +132,12 @@ module MultiAR
       @multi_ar = MultiAR.new config: @opts["config"],
           databases: @opts["databases"],
           db_config: @opts["db_config"],
-          environment: @opts["environment"]
-
-      MultiAR.add_migration_dir @opts["migration_dir"]
+          environment: @opts["environment"],
+          migration_dirs: [ @opts["migration_dir"] ]
     end
 
     # @note This method will always quit the application or raise another exception for errors. Catch SystemExit if that’s not good for you.
     def bootstrap opts
-      opts["databases"] ||= @databases
       raise "--databases must be given when bootstrapping." unless opts["databases"]
       raise "#{opts["init"]} already exists" if File.exist? opts["init"]
 

data/lib/multi_ar/rake/ext.rb

@@ -1,6 +1,7 @@
 
 require "rake"
 
+# @api private
 # Extension to Rake to provide rename task.
 module Rake
   # Extension to Rake to provide rename task.

data/lib/multi_ar/rake/migration_generator.rb

@@ -2,6 +2,8 @@
 require "rails/generators/active_record/migration/migration_generator"
 require "active_record/tasks/database_tasks"
 
+
+# @api private
 module ActiveRecordMigrations
   module Generators
     class MigrationGenerator < ::ActiveRecord::Generators::MigrationGenerator

data/lib/multi_ar/rake/tasks.rb

@@ -9,6 +9,7 @@ require "active_record/tasks/database_tasks"
 
 require_relative "migration_generator"
 
+# @api private
 module Rake
 
   # Utility that defines Rake tasks of MultiAR

data/lib/multi_ar/version.rb

@@ -1,4 +1,4 @@
 
 module MultiAR
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/multi_ar.rb

@@ -5,6 +5,7 @@ require_relative "multi_ar/rake/tasks"
 
 require_relative "multi_ar/database"
 
+# Main module.
 module MultiAR
 
   # Base of MultiAR gem.
@@ -16,6 +17,8 @@ module MultiAR
     attr_reader :db_config
     attr_reader :environment
 
+    # @api private
+    # This will always be overridden, when MultiAR is initialized. Don’t try to do any funny logic with this.
     @@migration_dirs = []
 
     class << self
@@ -26,7 +29,7 @@ module MultiAR
 
     # @param databases array of available databases
     # @todo config file is overriding parameters passed here... I think it should be other way around, but need more custom logic for that :/
-    def initialize databases:, environment: "development", config: "config/multi_ar.yaml", db_config: "config/database.yaml"
+    def initialize databases:, environment: "development", config: "config/multi_ar.yaml", db_config: "config/database.yaml", migration_dirs: []
 
       # first load config
       if not config.nil? and File.exist? config
@@ -45,6 +48,7 @@ module MultiAR
       @databases = databases
       @db_config = db_config
       @environment = environment
+      @@migration_dirs = migration_dirs unless migration_dirs.empty? # This takes care of that it will only be overridden if there is any given values, making default configs work
 
       Database.initialize db_config: db_config
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multi_ar
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Samu Voutilainen
@@ -29,7 +29,7 @@ cert_chain:
   Ws73WZ+F+DOnfopIMUaeYUzKyUG+59p17ls//xzTouiLjcC9ee5ZaC9e+TzYsp4t
   ofnwRrqEHVW+zRWs/VIwm70F2Jnl5eSc3MjyhpWIC0eGFXtBY1XYCrHeCdQ=
   -----END CERTIFICATE-----
-date: 2015-10-06 00:00:00.000000000 Z
+date: 2015-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop