gomon 0.0.4 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 13c1f6fc23957b2744e0f9c44afa4ef1773bfe47
+  data.tar.gz: 4650d0201660a9486950dfc7bc9335f607209cd0
+SHA512:
+  metadata.gz: e50aa4ed12ac8cf6e7c6047555071bb116e409a8fce93a063b8def90d7d90b73ac11594ed2e0985487bded3df4656f593563fc057f15d594781175928202ec7f
+  data.tar.gz: 77a7b11c9b6443cbbe77ee23cd619fb2762b31dec6fdd81ac814d4fae5fbba08d7e81c57d86877fced24fb3169cba4572868e3332970694087ba645893092506

data/.travis.yml

@@ -1,9 +1,11 @@
 language: ruby
 rvm:
+  - 2.0.0
   - 1.9.3
-  - 1.9.2
   - 1.8.7
   - jruby-18mode
   - jruby-19mode
   - rbx-18mode
   - rbx-19mode
+notifications:
+  email: false

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,18 +1,21 @@
 PATH
   remote: .
   specs:
-    gomon (0.0.3)
+    gomon (1.0.0)
       activesupport
+      clue (~> 1.0.0)
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    activesupport (3.2.11)
-      i18n (~> 0.6)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
       multi_json (~> 1.0)
+    clue (1.0.0)
+      activesupport
     diff-lcs (1.1.3)
     i18n (0.6.1)
-    multi_json (1.5.0)
+    multi_json (1.7.2)
     rake (10.0.3)
     rspec (2.12.0)
       rspec-core (~> 2.12.0)

data/LICENCE.md

@@ -0,0 +1,18 @@
+Copyright (c) 2012 Novelys
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom
+the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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. It is tested agains many rubies: 1.8.7, 1.9.2, 1.9.3, jruby-18, jruby-19, rubinius-18, rubinius-19.
+This gem is built upon [novelys/clue](https://github.com/novelys/clue/). It is tested agains many rubies: 1.8.7, 1.9.3, 2.0.0, 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.
@@ -23,35 +23,22 @@ Gemfile : `gem 'gomon'`
 The tools currently supported are `mongodump` and `mongorestore`.  
 They are wrapped in `Gomon::Dump` and `Gomon::Restore` respectively.
 
-These two classes are used in the same way: first, instantiate the object, then, invoke `call` without arguments on it. In most cases, the only difference of usage will be the options passed to the constructor.
+They are used in the same way as any instance of [clue](https://github.com/novelys/clue/) is used,
+so you should refer to clue's documentation. What makes `gomon` different is its support fort parsing mongodb uris.
 
 ### Example
 
-    > 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
-    # Dumping `database` from host...
-    # Executing: mongodump --host 'host' --port '12345' --username 'user' --password 'pass' --db 'database' --journal
-    # ....
-    # Done dumping.
-    => nil
-
-### Options
-
-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 :
-
-* 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.
-
-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.
-
-Options keys will always be casted as symbols, while values will always be casted as string.
+```ruby
+> gd = Gomon::Dump.new options: ['journal', uri: "mongodb://user:pass@host:12345/database"]
+> gd.cli_command
+=> "mongodump --username 'user' --password 'pass' --host 'host' --port '12345' --db 'database' --journal"
+> gd.call
+# Dumping `database` from host...
+# Executing: mongodump --host 'host' --port '12345' --username 'user' --password 'pass' --db 'database' --journal
+# ....
+# Done dumping.
+=> nil
+```
 
 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.
 
@@ -64,6 +51,7 @@ No validation of options is done, so you should be careful about supplying only
 
 ## Changelog
 
+* `1.0.0`: Tagged '1.0.0'. Uses [novelys/clue](https://github.com/novelys/clue/) as foundation.
 * `0.4`: Better options handling. Many ruby versions are now supported.
 * `0.3`: Ruby 1.8 support
 * `0.2`: Test coverage.

data/gomon.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |s|
   s.require_path              = 'lib'
 
   s.add_dependency('activesupport')
+  s.add_dependency('clue', '~> 1.0.0')
   s.add_development_dependency("rspec")
   s.add_development_dependency("rake")
 end

data/lib/gomon/base.rb

@@ -1,41 +1,12 @@
-require 'gomon/options'
+require 'clue'
 require 'gomon/uri'
 
 module Gomon
-  class Base
-    include Options
+  class Base < Clue
     include Uri
 
-    attr_reader :options, :singular_options
-
-    def initialize(opts = {})
-      init_options :host => 'localhost', :port => '27017'
-
-      handle_options opts
-    end
-
-    # Handle options addition, with special cases
-    def handle_options(opts = {})
-      # Extract singular options
-      add_singular_options opts.delete(:other)
-
-      # Extract uri into options
-      add_options parse_uri(opts.delete(:uri)) if opts[:uri]
-
-      # Keep track of other options
-      add_options opts
-    end
-
-    # String to execute
-    def cmd_string
-      "#{tool} #{cli_options}"
-    end
-
-    # Execute before/after hookes if any, execute command
-    def call
-      before_cmd
-      system(cmd_string)
-      after_cmd
+    def after_initialize(*args)
+      add_options parse_uri(options.delete(:uri)) if options[:uri]
     end
   end
 end

data/lib/gomon/dump.rb

@@ -2,20 +2,18 @@ require 'gomon/base'
 
 module Gomon
   class Dump < Base
-    attr_reader :tool
-
-    def initialize(opts = {})
+    def initialize(*args)
       super
 
-      @tool = 'mongodump'
+      @command = 'mongodump'
     end
 
-    def before_cmd
+    def before_call
       puts "Dumping `#{options[:db]}` from #{options[:host]}..."
-      puts "Executing: #{cmd_string}"
+      puts "Executing: #{cli_command}"
     end
 
-    def after_cmd
+    def after_call
       puts "Done dumping."
     end
   end

data/lib/gomon/restore.rb

@@ -2,27 +2,18 @@ require 'gomon/base'
 
 module Gomon
   class Restore < Base
-    attr_reader :tool, :path
+    def initialize(*args)
+      super
 
-    def initialize(opts = {})
-      @path = opts.delete(:path) || 'dump/*'
-      super(opts)
-      @tool = 'mongorestore'
+      @command = 'mongorestore'
     end
 
-    # String to execute
-    def cmd_string
-      "#{super} '#{path}'"
+    def before_call
+      puts "Restoring from dir `#{arguments.first}` into `#{options[:db]}` at #{options[:host]}..."
+      puts "Executing: #{cli_command}"
     end
 
-    # Hook to execute before restoring
-    def before_cmd
-      puts "Restoring from dir `#{path}` into `#{options[:db]}` at #{options[:host]}..."
-      puts "Executing: #{cmd_string}"
-    end
-
-    # Hook to execute after restoring
-    def after_cmd
+    def after_call
       puts "Done restoring."
     end
   end

data/lib/gomon/version.rb

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

data/spec/dump_spec.rb

@@ -1,19 +1,9 @@
 require 'gomon/dump'
 
 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 }
+  subject { Gomon::Dump.new :options => {:username => 'john', :password => 'mcclane', :db => 'die_hard'} }
 
   it 'should have a toolname' do
-    expect(tool).to eq 'mongodump'
-  end
-
-  it 'should have a command string' do
-    cmd = "mongodump"
-    options.each { |k, v| expect(subject.cmd_string).to include "--#{k} '#{v}'" }
-    singular.each { |k| expect(subject.cmd_string).to include "--#{k}" }
+    expect(subject.command).to eq 'mongodump'
   end
 end

data/spec/restore_spec.rb

@@ -1,29 +1,9 @@
 require 'gomon/restore'
 
 describe "Restore" do
-
-  subject { Gomon::Restore.new :path => 'dump/dir', :db => 'die_hard', :username => 'john' }
-  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 }
+  subject { Gomon::Restore.new :options => [:db => 'die_hard', :username => 'john'], :arguments => 'dump/dir' }
 
   it 'should have a toolname' do
-    expect(tool).to eq 'mongorestore'
-  end
-
-  it 'should not have a path option' do
-    expect(options.has_key?(:path)).to be false
-  end
-
-  it 'should have a path' do
-    expect(path).to eq 'dump/dir'
-  end
-
-  it 'should have a command string' do
-    cmd = "mongorestore"
-    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}'" }
+    expect(subject.command).to eq 'mongorestore'
   end
 end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gomon
 version: !ruby/object:Gem::Version
-  version: 0.0.4
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Novelys
@@ -10,54 +9,62 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-14 00:00:00.000000000 Z
+date: 2013-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: clue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A set of ruby classing wrapping mongodb cli tools, making them pleasant
@@ -72,44 +79,41 @@ files:
 - .travis.yml
 - Gemfile
 - Gemfile.lock
+- LICENCE.md
 - README.md
 - Rakefile
 - gomon.gemspec
 - lib/gomon.rb
 - lib/gomon/base.rb
 - lib/gomon/dump.rb
-- lib/gomon/options.rb
 - lib/gomon/restore.rb
 - lib/gomon/uri.rb
 - lib/gomon/version.rb
-- spec/base_spec.rb
 - spec/dump_spec.rb
-- spec/options_spec.rb
 - spec/restore_spec.rb
 - spec/spec_helper.rb
 - spec/uri_spec.rb
 homepage: http://github.com/novelys/gomon
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: gomon
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ruby wrappers around mongo utilities.
 test_files: []

data/lib/gomon/options.rb

@@ -1,58 +0,0 @@
-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)
-      @options[key.to_sym] = value.to_s
-    end
-
-    # Add many options
-    def add_options(opts = {})
-      opts.each { |key, value| add_option key, value }
-    end
-
-    # Returns the options string
-    def cli_options
-      options_as_array.join(' ')
-    end
-
-    # Returns options as an array
-    def options_as_array
-      # Valued options
-      ary = @options.each_with_object([]) do |(key, value), memo|
-        memo << "--#{key.to_s} '#{value.to_s}'"
-      end
-
-      # Singular options
-      ary = @singular_options.each_with_object(ary) do |opt, memo|
-        memo << "--#{opt.to_s}"
-      end
-
-      ary
-    end
-  end
-end

data/spec/base_spec.rb

@@ -1,66 +0,0 @@
-require 'gomon/base'
-
-describe "Base" do
-  context 'default options' do
-    subject { Gomon::Base.new }
-    let(:options) { subject.instance_variable_get :@options }
-
-    it 'host should be localhost' do
-      expect(options[:host]).to eq 'localhost'
-    end
-
-    it 'port should be 27017' do
-      expect(options[:port]).to eq '27017'
-    end
-  end
-
-  context 'initialized with uri' do
-    subject { Gomon::Base.new :uri => "mongodb://john:wayne@marlon.bran.do:23042/dark_side_of_the_moon" }
-    let(:options) { subject.instance_variable_get :@options }
-
-    it 'should not have uri' do
-      expect(options.has_key?(:uri)).not_to be_true
-    end
-
-    it 'should have username' do
-      expect(options[:username]).to be
-    end
-
-    it 'should have password' do
-      expect(options[:password]).to be
-    end
-
-    it 'should have host' do
-      expect(options[:host]).to be
-    end
-
-    it 'should have port' do
-      expect(options[:port]).to be
-    end
-
-    it 'should have database' do
-      expect(options[:db]).to be
-    end
-  end
-
-  context 'initialized with other' do
-    subject { Gomon::Base.new :other => "first third" }
-    let(:options) { subject.instance_variable_get :@singular_options }
-
-    it 'should have singular options' do
-      expect(options).to include 'first'
-      expect(options).to include 'third'
-    end
-  end
-
-  context 'initialized with options' do
-    subject { Gomon::Base.new :host => 'john', :username => 'wayne', :out => 'side' }
-    let(:options) { subject.instance_variable_get :@options }
-
-    it 'should have options set' do
-      expect(options[:host]).to eq 'john'
-      expect(options[:username]).to eq 'wayne'
-      expect(options[:out]).to eq 'side'
-    end
-  end
-end

data/spec/options_spec.rb

@@ -1,70 +0,0 @@
-require 'gomon/options'
-
-describe "Options" do
-  before :all do
-    class TestObject
-      include Gomon::Options
-
-      def initialize; init_options; end
-    end
-  end
-
-  subject { TestObject.new }
-  let(:options) { subject.instance_variable_get :@options }
-  let(:singular) { subject.instance_variable_get :@singular_options }
-
-  it 'should add one option' do
-    subject.add_option :key, 'value'
-    expect(options[:key]).to eq 'value'
-  end
-
-  it 'should add several options' do
-    subject.add_options :key1 => 'value1', :key2 => 'value2'
-    expect(options[:key1]).to eq 'value1'
-    expect(options[:key2]).to eq 'value2'
-  end
-
-  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
-    subject.add_option :key, 'value'
-    expect(options[:key]).to eq 'value'
-    subject.add_option :key, 'new_value'
-    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'
-    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