diff_resource 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ad6f41ec3ad9423f89448b5333f72916e2e27e0
-  data.tar.gz: f9ad3f44844d83f1095acfb24c203ccf18222a56
+  metadata.gz: f83a8b303a0e68fe400890c01806943b3e859e8c
+  data.tar.gz: 6c46fc4c27851bf2995a2a6914f43d0f99494562
 SHA512:
-  metadata.gz: 74e7bec7cfd0aacc680d27636cdf55c5b8751fdc33da706a5afa45a3c025ae55e99b6a167f526a5ff615c01d60f74addc226763e300a72616f4d8a58ea1fc205
-  data.tar.gz: daf3b517b903c5a03341b6748639085c318cfa05f2ac720a5a64f6fe8610efbab419592f51e7717bc629bfc2aee1c2ce12a248992c1b261ed0bde141f838202a
+  metadata.gz: d3bd3ef70dc9d71bbe7c0ea28b7a43d7c782ad32b65ba570a4c287e9965ecad6e1ccd6d7078659169d318c4f91d07678c85259a02ffaffa54b9d513d728889c1
+  data.tar.gz: a006e492731f9f5456ebf03b86a9db5fe77c82a3b98a9a0309c15254cc5328230e59e66f36388954ad0e4f7491a6d76f8129a7332248d7805932bfe8358df06f

data/README.md

@@ -23,32 +23,106 @@ Or install it yourself as:
 
 ## Usage
 
-output your resource file's diff list, you execute under command
+To output your resource file's diff list, you run under command.
 
 Usage:
   ```bash
-diff_resource create <directory> <comparison> <file> [<options>] -t, --type=TYPE
+diff_resource create <directory> <comparison> <file> <type> [<options>]
   ```
 
 Options:
-- -t, --type=TYPE          : resource file type
 - -o, [--output=OUTPUT]    : output file path.
 - -c, [--compare=COMPARE]  : comparison target type. other directory or git object
+- -s, [--setting=SETTING]  : setting file path
 
 Arguments:
 - directory:		resource file root path
 - comparison:		compare directory path or git hash
 - file:			resource file name format ex) test.resource, \*.resource, \*-en.resource
+- type:			resource file type. you can set custom type in .diffresource.yml
 
+You should run on git root directory when using git mode.
 
-Show detail, you execute under command
+To show detail, you run under command.
 ```bash
 diff_resource help create
 ```
 
-## Development
+## Settings File Format
 
-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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To create custom resource type and set custom default option value, you create ".diffresource.yml" as the following.
+```yaml
+types:
+  custom-resource : # custom resource type name
+    format: "xml"  # file format. xml, json, yaml are enable value
+    root : "data"   # resources object name. if object is nested, you set path split "."
+    key : "key"     # resource name. * means resources object is hash
+    value : "value" # resource value
+
+comparison: "dir"   # custom comparison value
+
+output: "./dir"     # custom output value
+```
+
+It is enable to parse like these format resources.
+
+```xml
+<?xml version="1.0" encoding="utf-8"?>
+<root>
+	<data key="string1">
+		<value>hello</value>
+	</data>
+	<data key="string2">
+		<value>hello hello</value>
+	</data>
+</root>
+```
+
+Case resources object is nested, you should set path split "." as the following.
+
+```yaml
+types:
+  custom-resource :
+    format: "json"
+    root : "root.data"
+    key : "key"
+    value : "value"
+```
+
+It is enable to parse like these format resources.
+```json
+{
+	"root" :{
+		"data" : [
+			{
+				"key" : "string1",
+				"value" : "hello"
+			},
+			{
+				"key" : "string2",
+				"value" : "hello hello"
+			}
+		]
+	}
+}
+```
+
+Case resources object is hash, you should set "\*" to key as the following.
+```yaml
+types:
+  custom-resource :
+    format: "yaml"
+    root : "root.data"
+    key : "*"
+```
+
+It is enable to parse like these format resources.
+```yaml
+root:
+  data:
+    string1: "hello"
+    string2: "hello hello"
+```
 
 ## Contributing
 

data/diff_resource.gemspec

@@ -10,18 +10,10 @@ Gem::Specification.new do |spec|
   spec.email         = ["katsu.generation.888@gmail.com"]
 
   spec.summary       = "Output resource file diffs"
-  spec.description   = "Output resource file diffs.You can set resource directory, resource type, output file path, etc..."
+  spec.description   = "Output resource file diffs.You can output original format resource file diff"
   spec.homepage      = "https://github.com/katsugeneration/diff-resource"
   spec.license       = "MIT"
 
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-  if spec.respond_to?(:metadata)
-    # spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  end
-
   spec.files = `git ls-files -z`.split("\x0").reject do |file|
     file =~ %r{^(?:
     spec/.*
@@ -35,9 +27,12 @@ Gem::Specification.new do |spec|
   spec.bindir        = "bin"
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.required_ruby_version = "~> 2.0"
 
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+
   spec.add_runtime_dependency "thor"
+  spec.add_runtime_dependency "xml-simple"
 end

data/lib/diff_resource.rb

@@ -1,5 +1,6 @@
 require "diff_resource/version"
 
+require "diff_resource/inputer/inputer"
 require "diff_resource/inputer/directory_inputer"
 require "diff_resource/inputer/git_inputer"
 
@@ -8,7 +9,12 @@ require "diff_resource/outputer"
 require "diff_resource/comparer"
 
 require "diff_resource/parser/parser"
+require "diff_resource/parser/xml_parser"
 require "diff_resource/parser/resx_parser"
+require "diff_resource/parser/json_parser"
+require "diff_resource/parser/yaml_parser"
+
+require "diff_resource/settings.rb"
 
 require "diff_resource/factory/parser_factory"
 require "diff_resource/factory/inputer_factory"

data/lib/diff_resource/cli.rb

@@ -2,34 +2,67 @@ require 'thor'
 
 module DiffResource
 	class Cli < Thor
-		desc "create <directory> <comparison> <file> [<options>]", <<-EOS
+		desc "create <directory> <comparison> <file> <type> [<options>]", <<-EOS
 create resource diff file
 - directory:		resource file root path
 - comparison:		compare directory path or git object
 - file:			resource file name format
 			ex) test.resource, *.resource, *-en.resource
+- type:			resource file type
+			you set custom type in .diffresource.yml
 
 EOS
-		method_option :type, :aliases => "-t", :enum => %w(resx), :required => true, :desc => "resource file type"
-		method_option :output, :aliases => "-o", :type => :string, :default => "./diffs.csv", :desc => "output file path."
-		method_option :compare, :aliases => "-c", :enum => %w(dir git), :default => "dir", :desc => "comparison target type. other directory or git hash"
-		def create target_dir = nil, comparison_target = nil, target_file = nil
-			parser = DiffResource::ParserFactory.create options[:type]
+		method_option :output, :aliases => "-o", :type => :string, :desc => "output file path."
+		method_option :comparison, :aliases => "-c", :enum => %w(dir git), :desc => "comparison target type. other directory or git hash"
+		method_option :setting, :aliases => "-s", :default => "./.diffresource.yml", :desc => "setting file path"
+		def create target_dir = nil, comparison_target = nil, target_file = nil, target_type = nil
+			p target_type
+			option = DiffResource::Cli.make_options options, target_type
+
+			parser = DiffResource::ParserFactory.create option[:type]
 			inputer = DiffResource::InputerFactory.create "dir"
-			comparison_inputer = DiffResource::InputerFactory.create options[:compare]
+			comparison_inputer = DiffResource::InputerFactory.create option[:comparison]
 
-			# when git pattern, comparison target is same to new resources and comprison_target is git object
-			if options[:compare] == "git"
+			# in git mode, comparison dir is same to new resources and comprison_target is git object
+			if option[:comparison] == "git"
 				comparison_inputer.reference = comparison_target
 				comparison_target = target_dir
 			end
 
 			new_resources = inputer.parse_files target_dir, target_file, parser
 			old_resources = comparison_inputer.parse_files comparison_target, target_file, parser
-
 			comparer = DiffResource::Comparer.new new_resources, old_resources
+
 			outputer = DiffResource::Outputer.new
-			outputer.output comparer.diffs, options[:output]
+			outputer.output comparer.diffs, option[:output]
+		end
+
+		def self.load_settings file_name
+			begin
+				open file_name do |file|
+					return DiffResource::Settings.new file
+				end
+			rescue
+				return DiffResource::Settings.new ""
+			end
+		end
+
+		def self.add_resx_format settings
+			settings.types["resx"] = { "format" => "resx", "root" => "data", "key" => "name", "value" => "value" }
+			return settings
+		end
+
+		def self.make_options options, type
+			ret = {}
+
+			settings = DiffResource::Cli.load_settings options[:setting]
+			settings = DiffResource::Cli.add_resx_format settings
+
+			ret[:type] = settings.types[type]
+			ret[:comparison] = options[:comparison] || settings.comparison || "dir"
+			ret[:output] = options[:output] || settings.output || "./diffs.csv"
+
+			return ret
 		end
 	end
 end

data/lib/diff_resource/factory/parser_factory.rb

@@ -2,9 +2,15 @@
 module DiffResource
 	class ParserFactory
 		def self.create type
-			return case type
+			return case type["format"]
 			when "resx"
 				DiffResource::ResxParser.new
+			when "xml"
+				DiffResource::XmlParser.new
+			when "json"
+				DiffResource::JsonParser.new type
+			when "yaml"
+				DiffResource::YamlParser.new type
 			else
 				fail ArgumentError.new, 'undefined parser type'
 			end

data/lib/diff_resource/inputer/directory_inputer.rb

@@ -1,6 +1,6 @@
 
 module DiffResource
-	class DirectoryInputer
+	class DirectoryInputer < Inputer
 		def parse_file file_name, parser
 			ret = []
 			begin
@@ -8,7 +8,7 @@ module DiffResource
 					ret = parser.parse file.read
 				end
 			rescue => e
-				p e.message
+				puts e.message
 			end
 
 			return ret
@@ -23,7 +23,7 @@ module DiffResource
 					resources += parse_files File.absolute_path(file, path), extension, parser
 				end
 			elsif FileTest.file? path
-				resources += parse_file path, parser if %r{^.*\/#{extension}$} =~ path
+				resources += parse_file path, parser if match? extension, path
 			end
 
 			return resources

data/lib/diff_resource/inputer/git_inputer.rb

@@ -1,6 +1,6 @@
-
+require 'pathname'
 module DiffResource
-	class GitInputer
+	class GitInputer < Inputer
 		attr_accessor :reference
 
 		def parse_file file_name, parser
@@ -13,14 +13,16 @@ module DiffResource
 
 		def parse_files path, extension, parser
 			resources = []
+			base = Pathname.getwd
 
 			if directory? path
-				contents = `git ls-tree --name-only #{reference}:#{path}`
+				contents = `git ls-tree --name-only #{reference}:#{path}` # ls-tree command bad work on non root dir
 				contents.split("\n").each do |file|
-					resources += parse_files (path + "/" + file), extension, parser
+					relative_file_path = Pathname(File.expand_path(file, path)).relative_path_from(base).to_s
+					resources += parse_files relative_file_path, extension, parser
 				end
 			elsif file? path
-				resources += parse_file path, parser if %r{^.*\/#{extension}$} =~ path
+				resources += parse_file path, parser if match? extension, path
 			end
 
 			return resources

data/lib/diff_resource/inputer/inputer.rb

@@ -0,0 +1,8 @@
+
+module DiffResource
+	class Inputer
+		def match? extension, path
+			return %r{^.*\/#{extension}$} =~ path
+		end
+	end
+end

data/lib/diff_resource/outputer.rb

@@ -9,7 +9,7 @@ module DiffResource
 				end
 			end
 		rescue => e
-			p e.message
+			puts e.message
 		end
 	end
 end

data/lib/diff_resource/parser/json_parser.rb

@@ -0,0 +1,9 @@
+require 'json'
+
+module DiffResource
+	class JsonParser < Parser
+		def parse_string str
+			return JSON.parse str
+		end
+	end
+end

data/lib/diff_resource/parser/parser.rb

@@ -3,7 +3,64 @@ module DiffResource
 	class Parser
 		@@resource = Struct.new "Resource", :key, :value
 
+		def initialize options = {}
+			@root = options["root"] || ""
+			@key = options["key"] || ""
+			@value = options["value"] || ""
+		end
+
+		def nested_hash_access hash, path
+			ret = hash
+			path.split(".").each do |symbol|
+				ret = ret[symbol]
+			end
+
+			return ret
+		end
+
 		def parse str
+			ret = []
+			begin
+				obj = parse_string str
+				root = nested_hash_access obj, @root
+
+				ret = if @key == "*"
+					parse_hash root
+				else
+					parse_array root
+				end
+			rescue => e
+				puts e.message
+			end
+
+			return ret
+		end
+
+		def parse_array root
+			ret = []
+			root.each do |item|
+				next unless parsre_target? item
+				key = nested_hash_access item, @key
+				value = nested_hash_access item, @value
+				ret << @@resource.new(key, value)
+			end
+			return ret
+		end
+
+		def parse_hash root
+			ret = []
+			root.each do |key, value|
+				next unless parsre_target? key
+				ret << @@resource.new(key, value)
+			end
+			return ret
+		end
+
+		def parse_string str
+		end
+
+		def parsre_target? item
+			return true
 		end
 	end
 end

data/lib/diff_resource/parser/resx_parser.rb

@@ -1,27 +1,12 @@
-require 'rexml/document'
 
 module DiffResource
-	class ResxParser < Parser
-		def parse str
-			ret = []
-			begin
-				resx = REXML::Document.new str
-
-				REXML::XPath.match(resx, "/root/data").map do |data|
-					type = data.attribute("type")
-					next unless type.nil?
-
-					key = data.attribute("name").value
-					value_element = data.elements["value"]
-					value = value_element ? value_element.text : nil
-
-					ret << @@resource.new(key, value)
-				end
-			rescue => e
-				p e.message
-			end
+	class ResxParser < XmlParser
+		def initialize
+			super({ "root" => "data", "key" => "name", "value" => "value" })
+		end
 
-			return ret
+		def parsre_target? item
+			return nested_hash_access(item, "type").nil?
 		end
 	end
 end

data/lib/diff_resource/parser/xml_parser.rb

@@ -0,0 +1,17 @@
+require 'xmlsimple'
+
+module DiffResource
+	class XmlParser < Parser
+		def parse str
+			ret = super str
+			ret.each do |item|
+				item.value = item.value[0]
+			end
+			return ret
+		end
+
+		def parse_string str
+			return XmlSimple.xml_in str
+		end
+	end
+end

data/lib/diff_resource/parser/yaml_parser.rb

@@ -0,0 +1,9 @@
+require 'yaml'
+
+module DiffResource
+	class YamlParser < Parser
+		def parse_string str
+			return YAML.load str
+		end
+	end
+end

data/lib/diff_resource/settings.rb

@@ -0,0 +1,27 @@
+require 'yaml'
+
+module DiffResource
+	class Settings
+		def initialize str
+			@options = YAML.load(str)
+			@options = {} unless @options.class == Hash # @options is Hash object
+			@options["types"] = {} unless @options["types"].class == Hash # @options["types"] is Hash Object
+		end
+
+		def types
+			return self["types"]
+		end
+
+		def comparison
+			return self["comparison"]
+		end
+
+		def output
+			return self["output"]
+		end
+
+		def [] key
+			return @options[key]
+		end
+	end
+end

data/lib/diff_resource/version.rb

@@ -1,3 +1,3 @@
 module DiffResource
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: diff_resource
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Katsuya SHIMABUKURO
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-17 00:00:00.000000000 Z
+date: 2016-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,8 +66,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Output resource file diffs.You can set resource directory, resource type,
-  output file path, etc...
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Output resource file diffs.You can output original format resource file
+  diff
 email:
 - katsu.generation.888@gmail.com
 executables:
@@ -87,9 +101,14 @@ files:
 - lib/diff_resource/factory/parser_factory.rb
 - lib/diff_resource/inputer/directory_inputer.rb
 - lib/diff_resource/inputer/git_inputer.rb
+- lib/diff_resource/inputer/inputer.rb
 - lib/diff_resource/outputer.rb
+- lib/diff_resource/parser/json_parser.rb
 - lib/diff_resource/parser/parser.rb
 - lib/diff_resource/parser/resx_parser.rb
+- lib/diff_resource/parser/xml_parser.rb
+- lib/diff_resource/parser/yaml_parser.rb
+- lib/diff_resource/settings.rb
 - lib/diff_resource/version.rb
 homepage: https://github.com/katsugeneration/diff-resource
 licenses:
@@ -101,9 +120,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="