svn_command_helper 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 34acdb9910cb150f794c4319621e038c37737388
-  data.tar.gz: b8a942e444e3bed3a7539abc71d23d1abc80f6e8
+  metadata.gz: d47ea36471b94fda56202e1c64b89d24b989ae98
+  data.tar.gz: 794513a1bc00aea3fdcb3e426e09e3a7732f56f2
 SHA512:
-  metadata.gz: e58f2996c63cc5b46ede2f51328596bfc9f7486fa332f8e2530699ec9e1ddc9a89bf570bd775f956358cfafe50bfe1ec504d7dc66d23ce6e81a1134e2d84c44b
-  data.tar.gz: 55b53a1d787037835765696baf6252ce5f8522f4c40f95505127630f7670c3113d17a02d000585e6d9dea350bd7f5191698a8210bc69b7616dcf9e4a18eafc87
+  metadata.gz: 45ca7ade456b31728cc8ba6737792f8a9fdff942f64442f398ee5f323d62168d0324d1321b03c6d9d573240317a21d71a9fcd283d99eb33d01cf6dd60b1dcfcd
+  data.tar.gz: 3c6af82ce304903f6710383f0eebc088a7d331078110b4b035a13d4a021e28edd38834b9f283ecc54525935e9a6173e0becc8f11baa9cba802738d76ac889b20

data/README.md

@@ -1,8 +1,12 @@
 # SvnCommandHelper
+# [SvnCommandHelper](https://github.com/SystemCommandHelperRB/svn_command_helper)
 
-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/svn_command_helper`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem](https://img.shields.io/gem/v/svn_command_helper.svg)](https://rubygems.org/gems/svn_command_helper)
+[![Gem](https://img.shields.io/gem/dtv/svn_command_helper.svg)](https://rubygems.org/gems/svn_command_helper)
+[![Gemnasium](https://gemnasium.com/github.com/SystemCommandHelperRB/svn_command_helper.svg)](https://gemnasium.com/github.com/SystemCommandHelperRB/svn_command_helper)
+[![Inch CI](http://inch-ci.org/github/SystemCommandHelperRB/svn_command_helper.svg)](http://inch-ci.org/github/SystemCommandHelperRB/svn_command_helper)
 
-TODO: Delete this and the text above, and describe your gem
+svn command helper
 
 ## Installation
 
@@ -20,10 +24,6 @@ Or install it yourself as:
 
     $ gem install svn_command_helper
 
-## Usage
-
-TODO: Write usage instructions here
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -32,10 +32,12 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/svn_command_helper.
+Bug reports and pull requests are welcome on GitHub at https://github.com/SystemCommandHelperRB/svn_command_helper.
 
+## API
 
-## License
+[API Document](http://www.rubydoc.info/github/SystemCommandHelperRB/svn_command_helper)
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+## License
 
+This is released under [MIT License](http://narazaka.net/license/MIT?2016).

data/lib/svn_command_helper.rb

@@ -3,11 +3,17 @@ require 'pathname'
 require 'yaml'
 require "system_command_helper"
 
+# Subversion command helper
 module SvnCommandHelper
+  # Subversion native command and some utilities
   module Svn
+    # module methods
     module ModuleMethods
       include ::SystemCommandHelper
 
+      # svn commit
+      # @param [String] message commit message
+      # @param [path string like] path target path
       def commit(message, path = ".")
         if cap("svn status #{path}").empty?
           sys "svn revert -R #{path}"
@@ -18,27 +24,61 @@ module SvnCommandHelper
         sys "svn update #{path}"
       end
 
+      # svn list
+      # @param [uri string like] uri target uri
+      # @param [Boolean] recursive --recursive
+      # @return [Array<String>] paths
       def list(uri, recursive = false)
         cap("svn list #{recursive ? '-R' : ''} #{uri}").split(/\n/).compact
           .reject {|path| path.empty?}
       end
 
+      # svn list --recursive
+      # @param [uri string like] uri target uri
+      # @return [Array<String>] paths
       def list_recursive(uri)
         list(uri, true)
       end
 
+      # svn list -> grep only files
+      # @param [uri string like] uri target uri
+      # @param [Boolean] recursive --recursive
+      # @return [Array<String>] file paths
       def list_files(uri, recursive = false)
         list(uri, recursive).reject {|path| path.end_with?("/")} # dir
       end
 
+      # svn list --recursive -> grep only files
+      # @param [uri string like] uri target uri
+      # @return [Array<String>] file paths
       def list_files_recursive(uri)
         list_files(uri, true)
       end
 
-      def update(path, depth = nil)
+      # check svn uri exists or not
+      # @param [uri string like] uri target uri
+      # @return [Boolean] true if exists
+      def exist?(uri)
+        list(File.dirname(uri)).find{|_file| File.fnmatch(@file, _file.sub(/\/$/, ''))}
+      end
+
+      # check svn uri file exists or not
+      # @param [uri string like] uri target uri
+      # @return [Boolean] true if exists
+      def exist_file?(uri)
+        list_files(File.dirname(uri)).find{|_file| File.fnmatch(@file, _file)}
+      end
+
+      # svn update
+      # @param [path string like] path target path
+      # @param [depth] depth --set-depth
+      def update(path = ".", depth = nil)
         sys "svn update #{depth ? "--set-depth #{depth}" : ""} #{path}"
       end
 
+      # svn update to deep path recursive
+      # @param [path string like] path target path
+      # @param [depth] depth --set-depth for only new updated dirs
       def update_deep(path, depth = nil)
         root = Pathname.new(Svn.working_copy_root_path(path)).realpath
         end_path = Pathname.new(path.to_s).expand_path.realpath
@@ -55,18 +95,30 @@ module SvnCommandHelper
         end
       end
 
+      # svn info -> yaml parse
+      # @param [path string like] path target path
+      # @return [Hash<String, String>] svn info contents
       def info(path = ".")
         YAML.load(cap("svn info #{path}"))
       end
 
+      # svn cat
+      # @param [path string like] path target path
+      # @return [String] file contents
       def cat(path)
         cap("svn cat #{path}")
       end
 
+      # Working Copy Root Path from svn info
+      # @param [path string like] path target path
+      # @return [String] Working Copy Root Path
       def working_copy_root_path(path = ".")
         info(path)["Working Copy Root Path"]
       end
 
+      # find common part of the given uris
+      # @param [Array<uri string like>] uris target uri
+      # @return [String] common part of the given uris
       def base_uri_of(uris)
         uris.reduce(Pathname.new(uris.first.to_s)) do |base_uri, uri|
           rel = Pathname.new(uri).relative_path_from(base_uri)
@@ -75,6 +127,9 @@ module SvnCommandHelper
         end.to_s
       end
 
+      # copy single transaction
+      # @param [SvnFileCopyTransaction] transaction from and to info
+      # @param [String] message commit message
       def copy_single(transaction, message)
         transactions = transaction.glob_transactions
         raise "copy_single: #{transaction.from} not exists" if transactions.empty?
@@ -97,6 +152,9 @@ module SvnCommandHelper
         end
       end
 
+      # copy multi transactions
+      # @param [Array<SvnFileCopyTransaction>] transactions from and to info list
+      # @param [String] message commit message
       def copy_multi(transactions, message)
         base_uri = base_uri_of(transactions.map(&:from_base) + trnsactions.map(&:to_base))
         transactions.each do |transaction|
@@ -118,16 +176,22 @@ module SvnCommandHelper
         end
       end
 
+      # check transaction from file exists
+      # @param [SvnFileCopyTransaction] transaction from and to info
+      # @param [Boolean] raise_if_from_not_found raise if from not found
+      # @return [Boolean] true if file exists
       def check_exists(transaction, raise_if_from_not_found = true)
         unless transaction.from_exist?
           if !raise_if_from_not_found
-            return
+            false
           elsif transaction.to_exist?
             puts "[WARNING] File:#{file}はコピー先のみにあります"
-            return
+            false
           else
             raise "[Error] File:#{file}が見つかりません！"
           end
+        else
+          true
         end
       end
     end
@@ -135,49 +199,76 @@ module SvnCommandHelper
     extend ModuleMethods
   end
 
+  # svn file copy transaction
+  # @attr [String] from_base from base uri
+  # @attr [String] to_base to base uri
+  # @attr [String] file file basename
   class SvnFileCopyTransaction
-    attr_reader :from_base, :to_base, :file
+    attr_reader :from_base
+    attr_reader :to_base
+    attr_reader :file
 
+    # @param [String] from_base from base uri
+    # @param [String] to_base to base uri
+    # @param [String] file file basename
     def initialize(from_base:, to_base:, file:)
       @from_base = from_base
       @to_base = to_base
       @file = file
     end
 
+    # from uri
+    # @return [String] from uri
     def from
       File.join(@from_base, @file)
     end
 
+    # to uri
+    # @return [String] to uri
     def to
       File.join(@to_base, @file)
     end
 
+    # filename glob (like "hoge*") to each single file transaction
+    # @return [Array<SvnFileCopyTransaction>] transactions
     def glob_transactions
       Svn.list_files(@from_base)
         .select{|_file| File.fnmatch(@file, _file)}
         .map{|_file| SvnFileCopyTransaction.new(from_base: @from_base, to_base: @to_base, file: _file)}
     end
 
+    # from uri exists?
+    # @return [Boolean]
     def from_exist?
-      Svn.list_files(@from_base).find{|_file| File.fnmatch(@file, _file)}
+      Svn.exist_file?(from)
     end
 
+    # to uri exists?
+    # @return [Boolean]
     def to_exist?
-      Svn.list_files(@to_base).find{|_file| File.fnmatch(@file, _file)}
+      Svn.exist_file?(to)
     end
 
+    # relative from base path from given base uri
+    # @return [String] relative from base path
     def relative_from_base(path)
       Pathname.new(@from_base).relative_path_from(Pathname.new(path)).to_s
     end
 
+    # relative to base path from given base uri
+    # @return [String] relative to base path
     def relative_to_base(path)
       Pathname.new(@to_base).relative_path_from(Pathname.new(path)).to_s
     end
 
+    # relative from path from given base uri
+    # @return [String] relative from path
     def relative_from(path)
       File.join(relative_from_base(path), @file)
     end
 
+    # relative to path from given base uri
+    # @return [String] relative to path
     def relative_to(path)
       File.join(relative_from_to(path), @file)
     end

data/lib/svn_command_helper/version.rb

@@ -1,3 +1,4 @@
 module SvnCommandHelper
-  VERSION = "0.1.0"
+  # version
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svn_command_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Narazaka