multi_ar 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6157c0dec341f35edadb6c5e12b406f0e73c5016
-  data.tar.gz: e0085db67def7b4e394f95521b69d54e663a4397
+  metadata.gz: 8a68d8b3b4fdd989b89ab5aa655fd6ac2fec91c5
+  data.tar.gz: 29520a7ac32bf608d7c358f16c9a20708c672dd2
 SHA512:
-  metadata.gz: 24b8d210c4258b08a521ce16aa4b1666be48b5620d17f2a35b10b9483e5aeab53afee6f7341c435e56160f8631c65885e37710d620c7a3a9467b2bac11eb3fb7
-  data.tar.gz: 5a07c1661eeb796dc45ebe52d243b1757f5067c0f3b409b2e45f11ec398b93a830ad4c89c23d947bda830bebde5133737bfeba7726e3868b491ad091cc108dd5
+  metadata.gz: 5a61a6393a304c3686985ff31371489437a7b17115eb16e1b9661e7f13281487399a6e2c8ea06ef992b027ba65ce93a7e896f563079ac1d89707b6befd75e7bf
+  data.tar.gz: 563de82ff9c3661a85ca339c177edb8ed1028d042cc111f68e4f955aee4a431e77ab6a64f1926ad5d45ad796608ede7b2da0d431974b2a14b8ab83cee09588a1

data/lib/multi_ar/database.rb

@@ -1,8 +1,8 @@
 
 # TODO: we don’t want to unconditionally load Rails as that gives too many unnecessary dependencies,
 # but if we need it for something, it should be conditional dep through dep-gem or just used if present
-require "rails"
-require "rails/application"
+#require "rails"
+#require "rails/application"
 
 require "active_record"
 require "active_record/tasks/database_tasks"
@@ -20,13 +20,12 @@ module MultiAR
     def self.initialize db_config: "config/database.yaml", migration_dir: "db/migrate"
       @@initialized ||= false
       return if @@initialized == true
-      Class.new(Rails::Application) unless Rails.application
+      #Class.new(Rails::Application) unless Rails.application
       raise "The database configuration file was not found. You can be pass path to it with db_config attribute. Current path: #{db_config}" unless File.exist? db_config
       db_config_data = YAML.load(ERB.new(File.read db_config).result)
       include ActiveRecord::Tasks
 
       ActiveRecord::Base.configurations = ::ActiveRecord::Tasks::DatabaseTasks.database_configuration = db_config_data
-      ActiveRecord::Tasks::DatabaseTasks.migrations_paths = [ migration_dir ] # this is only used by db:new_migration rake task. # TODO: because of that, maybe we want to handle this differently?
       @@initialized = true
     end
 

data/lib/multi_ar/interface.rb

@@ -1,5 +1,6 @@
 
 require "fileutils"
+require "pathname"
 require "trollop"
 
 require_relative "../multi_ar"
@@ -19,7 +20,7 @@ module MultiAR
     # - dry           # boolean
     # - environment   # `true` or `String`
     # - verbose       # boolean
-    # - databases     # `true` or `Array`
+    # - databases     # `false` or `Array`, by default asks for databases
     # - migration_dir # String
     #
     # 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.
@@ -55,15 +56,18 @@ module MultiAR
       @run_by_default = false
     end
 
+    DEFAULT_DB_CONFIG = "config/database.yaml"
+
     # @note Consumes ARGV, create copy of it if you need it for something.
     # @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"] == true
-      p.opt "db_config",    "Path to database config file",                                           type: :string, default: "config/database.yaml" if @options["db_config"] == true
+      p.opt "init",         "Create stub environment with configuration and database.yaml. " +
+                            "For current dir, use “.”.",                                              type: :string
+      p.opt "databases",    "List of databases to perform operations",                                type: :strings if(@options["databases"] != false && !@options["databases"].respond_to?(:each))
+      p.opt "db_config",    "Path to database config file",                                           type: :string, default: DEFAULT_DB_CONFIG 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 " +
@@ -130,35 +134,37 @@ module MultiAR
     private
 
     def init_multi_ar
-      @multi_ar = MultiAR.new config: @opts["config"],
-          databases: @opts["databases"],
-          db_config: @opts["db_config"],
-          environment: @opts["environment"],
-          migration_dirs: [ @opts["migration_dir"] ]
+      opts = {}
+      opts[:db_config] = @opts["db_config"] unless opts["db_config"].nil?
+      opts[:migration_dirs] = [ @opts["migration_dir"] ]
+      opts[:config] = @opts["config"] unless @opts["config"].nil?
+      opts[:databases] = @opts["databases"]
+      opts[:environment] = @opts["environment"]
+      @multi_ar = MultiAR.new opts
     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
       raise "--databases must be given when bootstrapping." unless opts["databases"]
-      raise "#{opts["init"]} already exists" if File.exist? opts["init"]
+      #raise "#{opts["init"]} already exists" if File.exist? opts["init"] # We don’t want to actually check it, init is more like “add missing configuration”.
 
       config_dir = "config"
       database_config = "database.yaml"
 
-      FileUtils.mkdir opts["init"]
+      FileUtils.mkdir opts["init"] unless Dir.exist? opts["init"]
       Dir.chdir opts["init"] do
-        File.write "README", bootstrap_readme(opts)
-        File.write "Gemfile", bootstrap_gemfile
+        File.write "README.md", bootstrap_readme(opts) unless File.exist?("README.md")
+        bootstrap_gemfile
 
-        FileUtils.mkdir config_dir
+        FileUtils.mkdir config_dir unless Dir.exist? config_dir
         Dir.chdir config_dir do
-          File.write database_config, bootstrap_db_config(opts)
+          File.write database_config, bootstrap_db_config(opts) unless File.exist?(database_config)
         end
 
-        run_bundler
+        bootstrap_config opts
       end
 
-      puts "#{opts["init"]} has been initialized. You can now run your program at the directory."
+      puts "Project at dir #{opts["init"]} has been initialized. You can now run your program at the directory."
       exit 0
     end
 
@@ -170,7 +176,7 @@ module MultiAR
           str << <<-EOS.gsub(/^ {10}/, "")
           #{full_name}:
             adapter: sqlite3
-            database: db/#{full_name}_.sqlite3
+            database: db/#{full_name}.sqlite3
             pool: 5
             timeout: 5000
 
@@ -182,10 +188,11 @@ module MultiAR
     end
 
     def bootstrap_gemfile
+
       str = <<-EOS.gsub(/^ {6}/, "")
       source "https://rubygems.org/"
 
-      gem "#{script_name}"
+      gem "multi_ar"
       EOS
 
       @dependencies.each do |dep, version|
@@ -195,14 +202,24 @@ module MultiAR
         str << line
       end
 
-      str
+      if File.exist?("Gemfile")
+        puts "NOTE: you should add following to your Gemfile:"
+        puts
+        puts str
+        return
+      end
+
+      File.write "Gemfile", str
+
+      # For convenience, we’ll run the bundler for the user in case we created the Gemfile.
+      run_bundler
     end
 
     def bootstrap_readme opts
       str = <<-EOS.gsub(/^ {6}/, "")
       ## #{script_name}
 
-      This is scaffolded runtime directory for project #{script_name}, created by cimmgnd #{script_name} --init #{opts["init"]}.
+      This is scaffolded runtime directory for project #{project_name}, created by command #{script_name} --init #{opts["init"]}.
 
       Purpose of this scaffold is to ease usage of this #{script_name}, by providing sample configuration and ready
       bundle just ready for running. Default configuration is for SQLite3, but any databases supported
@@ -212,17 +229,39 @@ module MultiAR
 
           bundle exec #{script_name}
 
-      #{script_name} is powered by ActiveRecord migration framework MultiAR-#{VERSION}. More information bundler can be found
-      at its homepage: http://bundler.io
+      #{script_name} is powered by ActiveRecord migration framework MultiAR-#{VERSION}. More information about MultiAR
+      can be found at [its home page](https://github.com/Smarre/multi_ar)
+
+      More information bundler can be found [at its homepage](http://bundler.io)
       EOS
     end
 
+    # Writes simple config file for some defaults we can assume from input
+    def bootstrap_config opts
+      settings_file = "config/settings.yaml"
+      return if File.exist? settings_file
+      str = <<-EOF
+databases:
+      EOF
+      opts["databases"].each do |database|
+        str << "    - #{database}"
+      end
+
+      File.open settings_file, "w" do |f|
+        f.write str
+      end
+    end
+
     def run_bundler
       puts `bundle install`
     end
 
     def script_name
-      @script_name ||= File.basename($0)
+      @script_name ||= File.basename($0).gsub("_", "\\_")
+    end
+
+    def project_name
+      Pathname.new(Dir.pwd).basename
     end
   end
 end

data/lib/multi_ar/rake/migration_generator.rb

@@ -12,7 +12,7 @@ module ActiveRecordMigrations
       def create_migration_file
         set_local_assigns!
         validate_file_name!
-        dir = ::ActiveRecord::Tasks::DatabaseTasks.migrations_paths.first
+        dir = ::ActiveRecord::Tasks::DatabaseTasks.migration_dir
         db_dir = ::ActiveRecord::Tasks::DatabaseTasks.sub_db_dir
         migration_template @migration_template, "#{dir}/#{db_dir}/#{file_name}.rb"
       end

data/lib/multi_ar/rake/tasks.rb

@@ -1,20 +1,24 @@
 
-# TODO: we don’t want to unconditionally load Rails as that gives too many unnecessary dependencies,
-# but if we need it for something, it should be conditional dep through dep-gem or just used if present
-require "rails"
-require "rails/generators"
-
 require "active_record"
 require "active_record/tasks/database_tasks"
 
-require_relative "migration_generator"
-
 # Optionally support migration_comments
 begin
   require "migration_comments"
 rescue LoadError
 end
 
+# In case there is no Rails available, let’s do simple class
+begin
+  require "rails"
+rescue LoadError
+  class Rails
+    def self.root
+      nil # TODO, we want MultiAR::root like thing somewhere
+    end
+  end
+end
+
 # @api private
 module Rake
 
@@ -65,6 +69,11 @@ module Rake
 
         DSL.desc "Creates a new migration file with the specified name"
         DSL.task :new_migration, :name, :options do |t, args|
+          # Only migration generator requires Rails generators
+          require "rails"
+          require "rails/generators"
+          require_relative "migration_generator"
+
           name = args[:name] || ENV["name"]
           options = args[:options] || ENV["options"]
 

data/lib/multi_ar/version.rb

@@ -1,4 +1,4 @@
 
 module MultiAR
-  VERSION = "1.1.2"
+  VERSION = "2.0.0"
 end

data/lib/multi_ar.rb

@@ -29,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", migration_dirs: []
+    def initialize databases:, environment: "development", config: "config/settings.yaml", db_config: "config/database.yaml", migration_dirs: []
 
       # first load config
       if not config.nil? and File.exist? config
@@ -52,8 +52,9 @@ module MultiAR
 
       Database.initialize db_config: db_config
 
-      ActiveRecord::Tasks::DatabaseTasks.class_eval { attr_accessor :sub_db_dir }
+      ActiveRecord::Tasks::DatabaseTasks.class_eval { attr_accessor :sub_db_dir, :migration_dir }
       ActiveRecord::Tasks::DatabaseTasks.sub_db_dir = databases.first # TODO: I don’t think this is how it should work
+      ActiveRecord::Tasks::DatabaseTasks.migration_dir = migration_dirs.first # TODO: I don’t think this is how it should work
 
       @rake = ::Rake::Application.new
       ::Rake.application = @rake

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multi_ar
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.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-11-23 00:00:00.000000000 Z
+date: 2016-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trollop
@@ -60,98 +60,112 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: safe_attributes
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 10.4.2
-  type: :runtime
+        version: '3.3'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.4'
-    - - ">="
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.4.2
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: safe_attributes
+  name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
+        version: '2.1'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
-  name: redcarpet
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.3'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: github-markdown
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '3.4'
 description: |-
-  Migration support and some other relevant utilities implemented using ActiveRecord
-  4.
+  Core library for multi database support in any Ruby project for ActiveRecord 4.
+    Migrations are supported by optional gem multi_ar_migrations.
 email: smar@smar.fi
 executables:
 - multi_ar
@@ -190,6 +204,6 @@ rubyforge_project:
 rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Multi database migrations and utilities for ActiveRecord
+summary: Multi database feature set for ActiveRecord
 test_files: []
 has_rdoc: