ajimi 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f13196aaa42aa1ee9ffa66c1cb2d981301913299
-  data.tar.gz: edc36ca1ec66ad4ee23c3d0589c17e8b48aaef8e
+  metadata.gz: c20e66f0e522bdfea71dc7c47424c644ffb42269
+  data.tar.gz: 96dae09e80019ed4e77884d6a91dd5c10ea0157a
 SHA512:
-  metadata.gz: afb2e37b084b8ac498f5d0b2326d06b238f92d0912b09e6d8b811e1281e304d581fb6a4e578dbbf000d64e0139155d361aa902b0492266bcc97e2e96d9095b2a
-  data.tar.gz: e3d1c6e525954f974d5f382445aa1b26eece64c80ef63a6bf0dcecf3299d7262f88a683729b9099a2cddc41104217656ca88c34e409fbf3e9cbc47bf72a8e7ab
+  metadata.gz: a8512418e1ee00501b168639a3ac56bc78777632acc58447526af86395ab3d71f6dee53d4ccef47acb9fcb1d2664a7bb5fb875578edb7e3b74f772b22d5229d2
+  data.tar.gz: 91095049fc1566c3a931f6fd44b28b4b36b0647bcdd4dd94c0d65e329f26fb76a058236320008dafff33a22aae1e4ac68272f084a046739edcb77c244e631127

data/README.md

@@ -33,7 +33,7 @@ And then edit Ajimifile:
 
 A sample configuration looks like the following:
 
-```
+```ruby
 # Ajimi configuration file
 
 # source setting
@@ -94,25 +94,25 @@ The following arguments are supported in the Ajimifile:
       * `host` - String (Optional): SSH hostname, FQDN or IP address. Default is name of `source`.
       * `user` - String (Required): SSH username.
       * `key` - String (Required): Path to user's SSH secret key.
-    * `enable_nice` - Boolean (Optional): If true, the find process is wrapped by nice and ionice to lower load. Default is false. 
+  * `enable_nice` - Boolean (Optional): If true, the find process is wrapped by nice and ionice to lower load. Default is false.
 * `target` - String (Required): Target server's name and options. Options are the same as source.
 * `check_root_path` - String (Required): Root path to check. If "/", Ajimi checks in the whole filesystem.
-* `pruned_paths` - Array[String|Regexp] (Optional): List of the path which should be excluded in the find process. Note that `pruned_paths` is better performance than `ignored_paths`/`pending_paths`.
-* `ignored_paths` - Array[String|Regexp] (Optional): List of the path which should be ignored as known difference.
+* `pruned_paths` - Array\[String|Regexp\] (Optional): List of the path which should be excluded in the find process. Note that `pruned_paths` is better performance than `ignored_paths`/`pending_paths`.
+* `ignored_paths` - Array\[String|Regexp\] (Optional): List of the path which should be ignored as known difference.
 * `ignored_contents` - Hash{String => String|Regexp} (Optional): Hash of the path => pattern which should be ignored as known difference for each of the content.
-* `pending_paths`- Array[String|Regexp] (Optional): List of the path which should be resolved later but ignored temporarily as known difference.
+* `pending_paths`- Array\[String|Regexp\] (Optional): List of the path which should be resolved later but ignored temporarily as known difference.
 * `pending_contents` - Hash{String => String|Regexp} (Optional): Hash of the path => pattern which should be resolved later but ignored temporarily as known difference for each of the content.
 
 ## Usage
 
 Ajimi is a single command-line application: `ajimi`.
-It takes a subcommand such as `check` or `exec`.
-To view a list of the available commands , just run `ajimi` with no arguments:
+It takes a subcommand such as `dir` or `exec` (Default subcommnad is `check`).
+To view a list of the available commands , just run `ajimi help` with no arguments:
 
-```
-$ ajimi
+```bash
+$ ajimi help
 Commands:
-  ajimi check                         # Show differences between the source and the target server
+  ajimi [check]                         # (Default subcommand) Show differences between the source and the target server
   ajimi dir <path>                    # Show differences between the source and the target server in the specified directory
   ajimi exec source|target <command>  # Execute an arbitrary command on the source or the target server
   ajimi file <path>                   # Show differences between the source and the target server in the specified file
@@ -129,22 +129,22 @@ After setting your Ajimifle, Run the following command in order to verify the SS
 
     $ ajimi exec source hostname
     $ ajimi exec target hostname
-    
-And then, first ajimi check with `--find-max-depth` option:
 
-    $ ajimi check --find-max-depth=3 > ajimi.log
+And then, run `ajimi` command with `-d` (or `--find-max-depth`) option:
+
+    $ ajimi -d 3 > ajimi.log
 
 Check the diffs report in ajimi.log, and add roughly unnecessary paths to `pruned_paths` in Ajimifile.
 
-Next, gradually increasing `find-max-depth=4, 5, ...`,
+Next, gradually increasing the depth `4, 5, ...`,
 
-    $ ajimi check --find-max-depth=4 > ajimi.log
+    $ ajimi -d 4 > ajimi.log
 
 Add known differences to `ignored_paths` or `pending_paths`.
 
-After checking the difference of paths, then check the contents of files where the difference has been reported:
+After checking the difference of paths, then run `ajimi` command with `-c` (or `--enable-check-contents`) option to check the contents of files where the difference has been reported:
 
-    $ ajimi check --enable-check-contents > ajimi.log
+    $ ajimi -c > ajimi.log
 
 Add known differences to `ignored_contents` or `pending_contents`,
 and repeat until the number of lines of diffs report becomes human-readable.
@@ -153,10 +153,10 @@ Finally, resolve issues and remove `pending_paths` or `pending_contents`.
 
 ## Command reference
 
-```
-$ ajimi
+```bash
+$ ajimi help
 Commands:
-  ajimi check                         # Show differences between the source and the target server
+  ajimi [check]                         # (Default subcommand) Show differences between the source and the target server
   ajimi dir <path>                    # Show differences between the source and the target server in the specified directory
   ajimi exec source|target <command>  # Execute an arbitrary command on the source or the target server
   ajimi file <path>                   # Show differences between the source and the target server in the specified file
@@ -169,43 +169,43 @@ Options:
                                # Default: true
 ```
 
-```
+```bash
 $ ajimi help check
 Usage:
-  ajimi check
+  ajimi [check]
 
 Options:
-  [--check-root-path=CHECK_ROOT_PATH]
-  [--find-max-depth=N]
-  [--enable-check-contents], [--no-enable-check-contents]
-  [--limit-check-contents=N]
-                                                           # Default: 0
-  [--ajimifile=AJIMIFILE]                                  # Ajimifile path
-                                                           # Default: ./Ajimifile
-  [--verbose], [--no-verbose]
-                                                           # Default: true
-
-Show differences between the source and the target server
+  -r, [--check-root-path=CHECK_ROOT_PATH]
+  -d, [--find-max-depth=N]
+  -c, [--enable-check-contents], [--no-enable-check-contents]
+      [--limit-check-contents=N]
+                                                               # Default: 0
+      [--ajimifile=AJIMIFILE]                                  # Ajimifile path
+                                                               # Default: ./Ajimifile
+      [--verbose], [--no-verbose]
+                                                               # Default: true
+
+(Default subcommand) Show differences between the source and the target server
 ```
 
-```
+```bash
 $ ajimi help dir
 Usage:
   ajimi dir <path>
 
 Options:
-  [--find-max-depth=N]
-                                       # Default: 1
-  [--ignored-pattern=IGNORED_PATTERN]
-  [--ajimifile=AJIMIFILE]              # Ajimifile path
-                                       # Default: ./Ajimifile
-  [--verbose], [--no-verbose]
-                                       # Default: true
+  -d, [--find-max-depth=N]
+                                           # Default: 1
+      [--ignored-pattern=IGNORED_PATTERN]
+      [--ajimifile=AJIMIFILE]              # Ajimifile path
+                                           # Default: ./Ajimifile
+      [--verbose], [--no-verbose]
+                                           # Default: true
 
 Show differences between the source and the target server in the specified directory
 ```
 
-```
+```bash
 $ ajimi help file
 Usage:
   ajimi file <path>
@@ -220,7 +220,7 @@ Options:
 Show differences between the source and the target server in the specified file
 ```
 
-```
+```bash
 $ ajimi help exec
 Usage:
   ajimi exec source|target <command>
@@ -253,4 +253,3 @@ Execute an arbitrary command on the source or the target server
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/ajimi/checker.rb

@@ -2,7 +2,8 @@ require 'diff/lcs'
 
 module Ajimi
   class Checker
-    attr_accessor :diffs, :result, :source, :target, :diff_contents_cache, :enable_check_contents
+    attr_accessor :diffs, :result, :source, :target, :diff_contents_cache, :enable_check_contents,
+      :ignored_by_path, :pending_by_path, :ignored_by_content, :pending_by_content
 
     def initialize(config)
       @config = config

data/lib/ajimi/client.rb

@@ -4,6 +4,7 @@ module Ajimi
   class Client < Thor
     attr_accessor :checker, :reporter
 
+    default_command :check
     class_option :ajimifile, :default => './Ajimifile', :desc => "Ajimifile path"
     class_option :verbose, :type => :boolean, :default => true
 
@@ -13,10 +14,10 @@ module Ajimi
       @config[:verbose] = options[:verbose] unless options[:verbose].nil?
     end
 
-    desc "check", "Show differences between the source and the target server"
-    option :check_root_path, :type => :string
-    option :find_max_depth, :type => :numeric
-    option :enable_check_contents, :type => :boolean, :default => false
+    desc "[check]", "(Default subcommand) Show differences between the source and the target server"
+    option :check_root_path, :aliases => "-r", :type => :string
+    option :find_max_depth, :aliases => "-d", :type => :numeric
+    option :enable_check_contents, :aliases => "-c", :type => :boolean, :default => false
     option :limit_check_contents, :type => :numeric, :default => 0
     def check
       @config.merge!( {
@@ -29,7 +30,7 @@ module Ajimi
     end
 
     desc "dir <path>", "Show differences between the source and the target server in the specified directory"
-    option :find_max_depth, :type => :numeric, :default => 1
+    option :find_max_depth, :aliases => "-d", :type => :numeric, :default => 1
     option :ignored_pattern, :type => :string
     def dir(path)
       @config.merge!( {
@@ -53,10 +54,10 @@ module Ajimi
 
       _check
     end
-    
+
     desc "exec source|target <command>", "Execute an arbitrary command on the source or the target server"
     def exec(server, command)
-      raise ArgumentError, "server option must be source or target" unless %w(source target).include? server 
+      raise ArgumentError, "server option must be source or target" unless %w(source target).include? server
 
       @server = @config[server.to_sym]
       puts "Execute command at #{server}_host: #{@server.host}\n"
@@ -66,7 +67,7 @@ module Ajimi
     end
 
     private
-    
+
     def _check
       @checker ||= Checker.new(@config)
       result = @checker.check
@@ -75,7 +76,7 @@ module Ajimi
       @reporter.report
       result
     end
-    
+
   end
 
 end

data/lib/ajimi/version.rb

@@ -1,3 +1,3 @@
 module Ajimi
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ajimi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Masayuki Morita
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-29 00:00:00.000000000 Z
+date: 2015-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: server diff tool