docker_compose_ruby 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a5aa7efb88888fb71c440c24735b690bb6abc2a
-  data.tar.gz: 773637b89e5bbd43aba2c4a9ec33357536ad95f0
+  metadata.gz: bdc079e7c3844e1cd2ae057f63e32a50aa435897
+  data.tar.gz: e63b53363102127136f982252db24c632f56a5a9
 SHA512:
-  metadata.gz: d84097612293674ff6b76a2862a7710f2aac538a584934109849e840618d95fdbab1891e0eecfcb85fe742e318fc1314e6ad53f4d71925133994944a2d0a610a
-  data.tar.gz: de68eee54ba569cc39220e07fbc9ccc83c28e3252b9d6b695ee1f2208ce2f7347cacb6eee447f62400546af6f54e43be2d9f242aeeb4bd270d98f27e03ba7027
+  metadata.gz: 125f9a63063488d2ab8d14052bb544eca6b072e64dc33929e37117297dc71e5128bdcef9d0dcf28dfb3bece9d3210f3ff1c4fe0e74aa2f9bbf2e50680f7f6ce3
+  data.tar.gz: f955e5aa40920c714cd59dc3c098de6490fe287673b874a6cc5be03130b6f7f2e10c58896fcb1f822870e4f33e237d1525d41550d488f6145029f93924a0cdbb

data/README.md

@@ -1,11 +1,13 @@
 # DockerComposeRuby
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/docker_compose_ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+Simple Ruby wrapper for the docker compose cli
 
 TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
+You need to have the docker compose cli installed. 
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -22,13 +24,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Set the path to your docker file. 
 
-## Development
+    $ DockerCompose.set_yaml_path('/path/to/docker-compose.yml')
+
+Set the project name (if no name is set it will be tthe name of the compose file's directory). 
+
+    $ DockerCompose.set_project_name('test_project')
+
+Up the compose project containers. 
+
+    $ DockerCompose.up
+
+Delete the compose project containers. 
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake false` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    $ DockerCompose.delete
+
+Stop the compose project containers. 
+
+    $ DockerCompose.stop
+
+Start the compose project containers. 
+
+    $ DockerCompose.start
+
+## Development
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+I wanted something to use in a project I'm building, and there really wasn't anything out there that gives me the simplicity of the cli, but without having to repeat myself. 
 
 ## Contributing
 

data/lib/docker_compose_ruby/version.rb

@@ -1,3 +1,3 @@
 module DockerComposeRuby
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/docker_compose_ruby.rb

@@ -7,36 +7,91 @@ module DockerCompose
   class << self
     attr_accessor :project_name, :yaml_path, :yaml
 
+
+    # Set Path to Docker Compose Yaml File.
+    #
+    # @param path [String]
+    # @return [String]
+    #
+    # @example
+    #   DockerCompose.set_yaml_path('/Users/test/projects/docker-compose.yml')
     def set_yaml_path(path)
       @yaml_path = "-f #{path}"
       @yaml = YAML.load_file(path)
     end
 
+    # Set Specific compose project name.
+    #
+    # @param name [String]
+    # @return [String]
+    #
+    # @example
+    #   DockerCompose.set_project_name('test_project')
     def set_project_name(name)
       @project_name = "-p #{name}"
       name
     end
 
+    # Ups the set of containers listed in your compose file.
+    #
+    # @param options [Hash]
+    # @return [String]
+    #
+    # @example
+    #   DockerCompose.up
     def up(options = {})
       options = nil if options.empty?
       compose('up',options)
     end
 
+    # Deletes the set of containers listed in your compose file.
+    #
+    # @param options [Hash]
+    # @return [String]
+    #
+    # @example
+    #   DockerCompose.delete
     def delete(options = {})
       options = nil if options.empty?
       compose('delete',options)
     end
 
+    # Stops the set of containers listed in your compose file.
+    #
+    # @param options [Hash]
+    # @return [String]
+    #
+    # @example
+    #   DockerCompose.stop
     def stop(options = {})
       options = nil if options.empty?
       compose('stop', options)
     end
 
+    # Starts the set of containers listed in your compose file.
+    #
+    # @param options [Hash]
+    # @return [String]
+    #
+    # @example
+    #   DockerCompose.up
     def start(options = {})
       options = nil if options.empty?
       compose('start', options)
     end
 
+    # Displays the current version of Docker compose
+    #
+    # @param options [Hash]
+    # @return [String]
+    #
+    # @example
+    #   DockerCompose.version
+    def version
+      compose('-v')
+    end
+
+    private
     def compose(command, options)
       case command
       when 'up'
@@ -44,13 +99,9 @@ module DockerCompose
       when 'delete'
         `docker-compose #{options} #{@yaml_path} #{@project_name} kill`
         `docker-compose #{options} #{@yaml_path} #{@project_name} rm -f`
-      when 'stop', 'start'
+      when 'stop', 'start', 'version'
         `docker-compose #{options} #{@yaml_path} #{@project_name} #{command}`
       end
     end
-
-    def version
-      compose('-v')
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docker_compose_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Mitch Eaton