docker-porcelain 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae92c062667eac697e5f18d3d950afb557b21130
-  data.tar.gz: 9967f41c870b65dd7f0b04af016bb2b939ebf654
+  metadata.gz: 9abf4d5591b1dc167a974d44a7b585ee079775a3
+  data.tar.gz: a8e2a32ad64087d40f19be336350c26652662ccc
 SHA512:
-  metadata.gz: 76b59a8f1c8a423833fbc651a654cdc714ee6c96b7260e2cffa23ab4d124a92917dc42301c002d82a982a2514655b001d99a74126b5296a93f8098030910316b
-  data.tar.gz: 5239179b59df5a826dfa776348826aa4ce6afbff5a2257f3624309083a9749362ff1253c64c6a57beb41928dcb50d0f540ce65697e4d2dc9b1b765a0d9279370
+  metadata.gz: 50f831bddf3502bf4e9684245d24e6c9437122aff4cc318b18d514dd3765fc04fbf05a32a39f937355f56ee2950b648ee89046005719770f09a7bf8cd8777ba7
+  data.tar.gz: e32d4a549030bee551c600aaf0118dcd6cc005158fe20d9333628758b26a4674c7f84b6c87dffc23180815f1de1e2b19623c2d8ac48ebcc5fb2f0c82a2515c60

data/.overcommit.yml

@@ -1,32 +1,4 @@
-# Use this file to configure the Overcommit hooks you wish to use. This will
-# extend the default configuration defined in:
-# https://github.com/brigade/overcommit/blob/master/config/default.yml
-#
-# At the topmost level of this YAML file is a key representing type of hook
-# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
-# customize each hook, such as whether to only run it on certain files (via
-# `include`), whether to only display output if it fails (via `quiet`), etc.
-#
-# For a complete list of hooks, see:
-# https://github.com/brigade/overcommit/tree/master/lib/overcommit/hook
-#
-# For a complete list of options that you can use to customize hooks, see:
-# https://github.com/brigade/overcommit#configuration
-#
-# Uncomment the following lines to make the configuration take effect.
-
-#PreCommit:
-#  RuboCop:
-#    enabled: true
-#    on_warn: fail # Treat all warnings as failures
-#
-#  TrailingWhitespace:
-#    exclude:
-#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
-#
-#PostCheckout:
-#  ALL: # Special hook name that customizes all hooks of this type
-#    quiet: true # Change all post-checkout hooks to only display output on failure
-#
-#  IndexTags:
-#    enabled: true # Generate a tags file with `ctags` each time HEAD changes
+PreCommit:
+  RuboCop:
+    enabled: true
+    problem_on_unmodified_line: warn

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/MethodDefParentheses:
+  EnforcedStyle: require_no_parentheses
+
+Style/MultilineOperationIndentation:
+  # it insists on two spaces, I like four
+  Enabled: false
+
+Style/AndOr:
+  # I use them for good reason
+  Enabled: false

data/README.md

@@ -67,9 +67,15 @@ container.write '/tmp/foo', 'This is the foo file!'
 ```ruby
 container.write '/tmp/foo', 'This is the foo file!'
 container.system 'true' or fail "there's no truth in the container!"
+uptime = container.` 'uptime'
+container.delete! # force destroy
+
 img = Docker::Image['image:tag'] # => #<Docker::Image:...>
 img.tags # => ['image:tag', 'other:tag']
-Docker::Image.repository 'image' # => #<Docker::Image:...>
+img.parent # => #<Docker::Image:...>
+img.tag 'repo', 'tag'
+
+Docker::Image.repository 'image' # => [#<Docker::Image:...>, ...]
 ```
 
 ## Development

data/lib/docker/porcelain/container.rb

@@ -1,10 +1,15 @@
 require 'docker/porcelain/error'
 
+# rubocop:disable Style/OpMethod
+# rubocop:disable Style/RedundantSelf
+# rubocop:disable Style/Alias
+
 module Docker
   module Porcelain
     module Container
-      # Writes to a file in the container
-      # @note Executes `tee` internally, which has to be available inside the container.
+      # Write to a file in the container
+      # @note Executes +tee+ internally, which has to be available inside the
+      #   container.
       # @param path [String] full path of the file to write
       # @param content [String] data to be written
       # @return [Fixnum] number of bytes written
@@ -20,13 +25,39 @@ module Docker
         end
       end
 
+      # Execute a command in the container, returning the output
+      # @param [String] command the command line to execute,
+      #   passed to +/bin/sh -c+
+      # @return [String] the standard output
+      # @raise (Docker::Porcelain::CommandError) if there's a problem executing
+      #   the command (ie. the shell returns 127)
+      # @note The exit code is available in {#last_exitstatus}.
+      # @see #system
+      def ` command
+        # unweird syntax highlighters: `
+        stdout, stderr, status = self.exec ['/bin/sh', '-c', command]
+        case @last_exitstatus = status
+        when 127
+          fail CommandError, stderr.join
+        else
+          stdout.join
+        end
+      end
+
+      alias backtick ` # `
+
+      # Execute a command in the container, discarding the output
       # @overload system(command...)
-      #   Executes a command in a container
-      #   @param [String, Array<String>] command to execute.
-      #     A single string is passed to '/bin/sh -c' for execution.
-      #   @return [true, false, nil] true if the command gives zero exit status,
-      #     false for non zero exit status, nil if command execution fails.
-      #   @note The exit code is available in {.last_exitstatus}.
+      #   @param [String] command the command line to execute;
+      #     passed to +/bin/sh -c+
+      #   @param [String...] command... the command to execute and its arguments
+      # @return [true] if the command exits with zero exit status.
+      # @return [false] if the command exits with a nonzero status.
+      # @return [nil] if the command execution fails.
+      # @note The exit code is available in {#last_exitstatus}.
+      # @see #`
+      # @raise [NotImplementedError] if the argument list contains options
+      #   or environments (as allowed by {Kernel#system}).
       def system *args
         env = args.shift if args.first.is_a? Hash
         opts = args.pop if args.last.is_a? Hash
@@ -36,7 +67,7 @@ module Docker
         raise NotImplementedError, "setting env or opts is not implemented" \
             if [env, opts].any?
 
-        raise NotImplementedError, "overringing argv0 is not implemented" \
+        fail NotImplementedError, 'overriding argv0 is not implemented' \
             if cmdline.first.is_a? Array
 
         if cmdline.length == 1
@@ -45,7 +76,6 @@ module Docker
 
         _stdout, _stderr, status = self.exec cmdline
 
-        # 'simulate' exit status in $?
         @last_exitstatus = status
 
         case status
@@ -56,7 +86,14 @@ module Docker
         end
       end
 
-      # Exit status of the last command ran with {#system}
+      # Force delete a container (even if it is running)
+      # @return [void]
+      def delete!
+        delete force: true
+      end
+
+      # @return [Fixnum] exit status of the last command ran with {#system}
+      #   or {#`}
       attr_reader :last_exitstatus
     end
   end

data/lib/docker/porcelain/extensions.rb

@@ -10,7 +10,8 @@ module Docker
   end
 
   class Image
-    include Docker::Porcelain::Image
+    prepend Docker::Porcelain::Image
+    extend Docker::Porcelain::Image::ClassMethods
   end
 end
 

data/lib/docker/porcelain/image.rb

@@ -21,14 +21,55 @@ module Docker
 
       # @return [Array<String>] repository tags of the image
       def tags
+        # Image can have incomplete info, refresh then
+        refresh! unless info['RepoTags']
+
         # docker returns '<none>:<none>' for an untagged repo
         info['RepoTags'] - ['<none>:<none>']
       end
 
+      # @return [Docker::Image] the parent image
+      # @return [nil] if the image is +FROM scratch+
+      def parent
+        return nil if (parent = info['Parent']).empty?
+        Docker::Porcelain::Image[parent]
+      end
+
+      # Tag the image
+      # @overload tag(repo, tag, opts)
+      #   @param [String] repo the repository to tag in
+      #   @param [String] tag the new tag
+      #   @option opts [Boolean] force whether to replace the tag if it
+      #     already exists
+      # @overload tag(repo_tag, opts)
+      #   @param [String] repo_tag the repository to tag in with optional tag;
+      #     in 'repo:tag' or 'repo' format
+      #   @option opts [Boolean] force whether to replace the tag if it
+      #     already exists
+      # @overload tag(opts)
+      #   @option opts [String] repo the repository to tag in
+      #   @option opts [String] tag the new tag
+      #   @option opts [Boolean] force whether to replace the tag if it
+      #     already exists
+      # @return [void]
+      def tag *args
+        strargs, rest = args.partition { |arg| arg.respond_to? :to_str }
+
+        # rest should be [opts] or empty
+        rest.length < 2 or
+            fail ArgumentError, 'expected args: [repo [tag]] [options]'
+        opts = rest.first || {}
+
+        super opts.merge Image.repo_tag_to_hash *strargs
+      end
+
       extend ClassMethods
 
-      def self.included other
-        other.extend ClassMethods
+      private
+
+      def self.repo_tag_to_hash repo = nil, tag = nil
+        repo, tag = repo.split ':' unless tag
+        { 'repo' => repo, 'tag' => tag }
       end
     end
   end

data/lib/docker/porcelain/version.rb

@@ -1,5 +1,5 @@
 module Docker
   module Porcelain
-    VERSION = "0.2.0"
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: docker-porcelain
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rafał Rzepecki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2015-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: docker-api
@@ -76,6 +76,7 @@ files:
 - ".gitignore"
 - ".overcommit.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt