gomon 0.0.3 → 0.0.4

data/.travis.yml

@@ -1,4 +1,9 @@
 language: ruby
 rvm:
-  - 1.8.7
   - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-18mode
+  - rbx-19mode

data/README.md

@@ -6,7 +6,7 @@ Ruby wrappers around mongodb cli tools.
 
 [![Build Status](https://travis-ci.org/novelys/gomon.png?branch=master)](https://travis-ci.org/novelys/gomon)
 
-This gem depends on no other gems. Ruby 1.8 & 1.9.
+This gem depends on no other gems. It is tested agains many rubies: 1.8.7, 1.9.2, 1.9.3, jruby-18, jruby-19, rubinius-18, rubinius-19.
 
 It assumes the presence of `mongorestore` and `mongodump` commands.
 It was built around the latest mongodb tools at the moment of this writing, meaning version 2.2.2.
@@ -27,7 +27,7 @@ These two classes are used in the same way: first, instantiate the object, then,
 
 ### Example
 
-    > gd = Gomon::Dump.new uri: "mongodb://user:pass@host:12345/database", other: '--journal'
+    > gd = Gomon::Dump.new uri: "mongodb://user:pass@host:12345/database", other: 'journal'
     > gd.cmd_string
     => "mongodump --host 'host' --port '12345' --username 'user' --password 'pass' --db 'database' --journal"
     > gd.call
@@ -39,19 +39,21 @@ These two classes are used in the same way: first, instantiate the object, then,
 
 ### Options
 
-The two classes accepts a hash of options when initializing, as in `gd = Gomon::Dumper.new(db: 'gem_test')`. This hash can contain:
+The two classes accepts a hash of options when initializing, as in `gd = Gomon::Dumper.new(db: 'gem_test')`. You can also supply this hash later by calling `gd.handle_options(opts)`, both have the same effect. When you add options this way, some specific rules apply :
 
-* Any option accepted by `mongodump` or `mongorestore`. You should refer to the [MongoDB Manual](http://docs.mongodb.org/manual/reference/mongorestore/) for more on them;
-* Singular options that have no value, as '--drop', can be supplied with the key `:other`;
 * If the key `:uri` is present, its value will be parsed and split to retrieve the username, password, host, port, and database;
 * Specific to `Gomon::Restore`: the option value for the key `:path` will be used as its last argument, as is.
 
-If you want to set options once the object is already created, you can use `add_option(key, value)` or `add_options({key: value, ...})`. However, there will be no special treatment for options: even if you supply `:uri`, or `:other`, they won't be handled the way they are when creating the object.
+Adding options using the following methods will **not** trigger the specific behaviours listed above.
 
+* `add_option(key, value)`: adds the option. It will override previous ones.
+* `add_options(hash)`: adds the options. It will override previous ones.
+* `add_singular_option(string): adds the singular option. Duplicates will be removed.
+* `add_singular_options(string_or_array): adds the singular options. Duplicates will be removed.
 
-## What's next
+Options keys will always be casted as symbols, while values will always be casted as string.
 
-* Better support for manipulating options once the object is created.
+No validation of options is done, so you should be careful about supplying only options accepted by `mongodump` or `mongorestore`. Refer to the [MongoDB Manual](http://docs.mongodb.org/manual/reference/mongorestore/) for more on the topic.
 
 ## Contributions
 
@@ -62,6 +64,7 @@ If you want to set options once the object is already created, you can use `add_
 
 ## Changelog
 
+* `0.4`: Better options handling. Many ruby versions are now supported.
 * `0.3`: Ruby 1.8 support
 * `0.2`: Test coverage.
 * `0.1`: First version. Provices basic functionnality for `Gomon::Dump` & `Gomon::Restore`

data/lib/gomon/base.rb

@@ -1,4 +1,3 @@
-require 'active_support/ordered_hash'
 require 'gomon/options'
 require 'gomon/uri'
 
@@ -7,20 +6,21 @@ module Gomon
     include Options
     include Uri
 
+    attr_reader :options, :singular_options
+
     def initialize(opts = {})
-      @tool = 'mongodump'
+      init_options :host => 'localhost', :port => '27017'
 
-      # Default options
-      @options = ActiveSupport::OrderedHash.new 
-      @options[:host] = 'localhost'
-      @options[:port] = '27017'
+      handle_options opts
+    end
 
-      @singular_options = opts.delete(:other)
+    # Handle options addition, with special cases
+    def handle_options(opts = {})
+      # Extract singular options
+      add_singular_options opts.delete(:other)
 
       # Extract uri into options
-      if (uri = opts.delete(:uri))
-        add_options parse_uri(uri)
-      end
+      add_options parse_uri(opts.delete(:uri)) if opts[:uri]
 
       # Keep track of other options
       add_options opts

data/lib/gomon/dump.rb

@@ -11,7 +11,7 @@ module Gomon
     end
 
     def before_cmd
-      puts "Dumping `#{@options[:db]}` from #{@options[:host]}..."
+      puts "Dumping `#{options[:db]}` from #{options[:host]}..."
       puts "Executing: #{cmd_string}"
     end
 

data/lib/gomon/options.rb

@@ -2,14 +2,37 @@ require 'active_support/core_ext/enumerable'
 
 module Gomon
   module Options
+    # Initialize options ivars
+    def init_options(defaults = {})
+      @options = {}
+      @singular_options = []
+
+      add_options defaults
+    end
+
+    # Add a singular option
+    def add_singular_option(option)
+      @singular_options << option.to_s
+      @singular_options.uniq!
+    end
+
+    # Add many singular options
+    def add_singular_options(options)
+      return unless options
+      options = options.split(' ') if options.is_a?(String)
+
+      @singular_options += options.map(&:to_s)
+      @singular_options.uniq!
+    end
+
     # Add a single options
     def add_option(key, value)
-      add_options({key => value})
+      @options[key.to_sym] = value.to_s
     end
 
     # Add many options
     def add_options(opts = {})
-      @options.merge! opts
+      opts.each { |key, value| add_option key, value }
     end
 
     # Returns the options string
@@ -19,11 +42,15 @@ module Gomon
 
     # Returns options as an array
     def options_as_array
+      # Valued options
       ary = @options.each_with_object([]) do |(key, value), memo|
-        memo << "--#{key} '#{value}'"
+        memo << "--#{key.to_s} '#{value.to_s}'"
       end
 
-      ary << @singular_options if @singular_options
+      # Singular options
+      ary = @singular_options.each_with_object(ary) do |opt, memo|
+        memo << "--#{opt.to_s}"
+      end
 
       ary
     end

data/lib/gomon/restore.rb

@@ -2,7 +2,7 @@ require 'gomon/base'
 
 module Gomon
   class Restore < Base
-    attr_reader :tool
+    attr_reader :tool, :path
 
     def initialize(opts = {})
       @path = opts.delete(:path) || 'dump/*'
@@ -12,12 +12,12 @@ module Gomon
 
     # String to execute
     def cmd_string
-      "#{super} '#{@path}'"
+      "#{super} '#{path}'"
     end
 
     # Hook to execute before restoring
     def before_cmd
-      puts "Restoring from dir `#{@path}` into `#{@options[:db]}` at #{@options[:host]}..."
+      puts "Restoring from dir `#{path}` into `#{options[:db]}` at #{options[:host]}..."
       puts "Executing: #{cmd_string}"
     end
 

data/lib/gomon/version.rb

@@ -1,3 +1,3 @@
 module Gomon
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/base_spec.rb

@@ -44,11 +44,12 @@ describe "Base" do
   end
 
   context 'initialized with other' do
-    subject { Gomon::Base.new :other => "--first --third" }
+    subject { Gomon::Base.new :other => "first third" }
     let(:options) { subject.instance_variable_get :@singular_options }
 
     it 'should have singular options' do
-      expect(options).to eq '--first --third'
+      expect(options).to include 'first'
+      expect(options).to include 'third'
     end
   end
 

data/spec/dump_spec.rb

@@ -5,6 +5,7 @@ describe "Dump" do
   subject { Gomon::Dump.new :username => 'john', :password => 'mcclane', :db => 'die_hard'}
   let(:tool) { subject.instance_variable_get :@tool }
   let(:options) { subject.instance_variable_get :@options }
+  let(:singular) { subject.instance_variable_get :@singular_options }
 
   it 'should have a toolname' do
     expect(tool).to eq 'mongodump'
@@ -12,7 +13,7 @@ describe "Dump" do
 
   it 'should have a command string' do
     cmd = "mongodump"
-    options.each { |k, v| cmd += " --#{k} '#{v}'" }
-    expect(subject.cmd_string).to eq cmd
+    options.each { |k, v| expect(subject.cmd_string).to include "--#{k} '#{v}'" }
+    singular.each { |k| expect(subject.cmd_string).to include "--#{k}" }
   end
 end

data/spec/options_spec.rb

@@ -5,7 +5,7 @@ describe "Options" do
     class TestObject
       include Gomon::Options
 
-      def initialize; @options = {}; @singular_options = '--first --second'; end
+      def initialize; init_options; end
     end
   end
 
@@ -24,8 +24,24 @@ describe "Options" do
     expect(options[:key2]).to eq 'value2'
   end
 
-  it 'should have singular options' do
-    expect(singular).to eq '--first --second'
+  it 'should add options with symbols as keys' do
+    subject.add_options 'key' => 'value'
+    expect(options[:key]).to eq 'value'
+  end
+
+  it 'should add one singular option' do
+    subject.add_singular_option 'hank'
+    expect(singular).to include 'hank'
+  end
+
+  it 'should add several singular options given as string' do
+    subject.add_singular_options 'rocky balboa'
+    expect(singular).to include 'rocky', 'balboa'
+  end
+
+  it 'should add several singular options given as array' do
+    subject.add_singular_options ['rocky', 'balboa']
+    expect(singular).to include 'rocky', 'balboa'
   end
 
   it 'can override previous keys' do
@@ -35,8 +51,20 @@ describe "Options" do
     expect(options[:key]).to eq 'new_value'
   end
 
+  it 'should not add many times the same singular option' do
+    subject.add_singular_options ['rocky', 'rocky']
+    expect(singular).to include 'rocky'
+    expect(singular.size).to eq 1
+  end
+
   it 'can merge options into a string' do
     subject.add_options :key1 => 'value1', :key2 => 'value2'
-    expect(subject.cli_options).to eq "--key1 'value1' --key2 'value2' --first --second"
+    subject.add_singular_options %w(john jim jones)
+    
+    expect(subject.cli_options).to include "--key1 'value1'"
+    expect(subject.cli_options).to include "--key2 'value2'"
+    expect(subject.cli_options).to include "--john"
+    expect(subject.cli_options).to include "--jim"
+    expect(subject.cli_options).to include "--jones"
   end
 end

data/spec/restore_spec.rb

@@ -6,6 +6,7 @@ describe "Restore" do
   let(:tool) { subject.instance_variable_get :@tool }
   let(:path) { subject.instance_variable_get :@path }
   let(:options) { subject.instance_variable_get :@options }
+  let(:singular) { subject.instance_variable_get :@singular_options }
 
   it 'should have a toolname' do
     expect(tool).to eq 'mongorestore'
@@ -21,8 +22,8 @@ describe "Restore" do
 
   it 'should have a command string' do
     cmd = "mongorestore"
-    options.each { |k, v| cmd += " --#{k} '#{v}'" }
-    cmd << " '#{path}'"
-    expect(subject.cmd_string).to eq cmd
+    options.each { |k, v| expect(subject.cmd_string).to include "--#{k} '#{v}'" }
+    singular.each { |k| expect(subject.cmd_string).to include "--#{k}" }
+    expect(subject.cmd_string).to satisfy { |str| str.end_with? "'#{path}'" }
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gomon
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors: